granicus.if.org Git - strace/blob - tests/tests.h

   1 /*
   2  * Copyright (c) 2016 Dmitry V. Levin <ldv@altlinux.org>
   3  * Copyright (c) 2016-2018 The strace developers.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef STRACE_TESTS_H
  30 #define STRACE_TESTS_H
  31
  32 #ifdef HAVE_CONFIG_H
  33 # include "config.h"
  34 #endif
  35
  36 #ifdef TESTS_SIZEOF_KERNEL_LONG_T
  37 # undef SIZEOF_KERNEL_LONG_T
  38 # define SIZEOF_KERNEL_LONG_T TESTS_SIZEOF_KERNEL_LONG_T
  39 #endif
  40
  41 #ifdef TESTS_SIZEOF_LONG
  42 # undef SIZEOF_LONG
  43 # define SIZEOF_LONG TESTS_SIZEOF_LONG
  44 #endif
  45
  46 #include <stdbool.h>
  47 #include <sys/types.h>
  48 #include "kernel_types.h"
  49 #include "gcc_compat.h"
  50 #include "macros.h"
  51
  52 /*
  53  * The printf-like function to use in header files
  54  * shared between strace and its tests.
  55  */
  56 #ifndef STRACE_PRINTF
  57 # define STRACE_PRINTF printf
  58 #endif
  59
  60 /* Tests of "strace -v" are expected to define VERBOSE to 1. */
  61 #ifndef VERBOSE
  62 # define VERBOSE 0
  63 #endif
  64
  65 #ifndef DEFAULT_STRLEN
  66 /* Default maximum # of bytes printed in printstr et al. */
  67 # define DEFAULT_STRLEN 32
  68 #endif
  69
  70 /* Cached sysconf(_SC_PAGESIZE). */
  71 size_t get_page_size(void);
  72
  73 /* The size of kernel's sigset_t. */
  74 unsigned int get_sigset_size(void);
  75
  76 /* Print message and strerror(errno) to stderr, then exit(1). */
  77 void perror_msg_and_fail(const char *, ...)
  78         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  79 /* Print message to stderr, then exit(1). */
  80 void error_msg_and_fail(const char *, ...)
  81         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  82 /* Print message to stderr, then exit(77). */
  83 void error_msg_and_skip(const char *, ...)
  84         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  85 /* Print message and strerror(errno) to stderr, then exit(77). */
  86 void perror_msg_and_skip(const char *, ...)
  87         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  88
  89 #ifndef perror_msg_and_fail
  90 # define perror_msg_and_fail(fmt_, ...) \
  91         perror_msg_and_fail("%s:%d: " fmt_, __FILE__, __LINE__, ##__VA_ARGS__)
  92 #endif
  93 #ifndef perror_msg_and_fail
  94 # define error_msg_and_fail(fmt_, ...) \
  95         error_msg_and_fail("%s:%d: " fmt_, __FILE__, __LINE__, ##__VA_ARGS__)
  96 #endif
  97
  98 /* Stat the specified file and skip the test if the stat call failed. */
  99 void skip_if_unavailable(const char *);
 100
 101 /*
 102  * Allocate memory that ends on the page boundary.
 103  * Pages allocated by this call are preceded by an unmapped page
 104  * and followed also by an unmapped page.
 105  */
 106 void *tail_alloc(const size_t)
 107         ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1));
 108 /* Allocate memory using tail_alloc, then memcpy. */
 109 void *tail_memdup(const void *, const size_t)
 110         ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((2));
 111
 112 /*
 113  * Allocate an object of the specified type at the end
 114  * of a mapped memory region.
 115  * Assign its address to the specified constant pointer.
 116  */
 117 #define TAIL_ALLOC_OBJECT_CONST_PTR(type_name, type_ptr)        \
 118         type_name *const type_ptr = tail_alloc(sizeof(*type_ptr))
 119
 120 /*
 121  * Allocate an object of the specified type at the end
 122  * of a mapped memory region.
 123  * Assign its address to the specified variable pointer.
 124  */
 125 #define TAIL_ALLOC_OBJECT_VAR_PTR(type_name, type_ptr)          \
 126         type_name *type_ptr = tail_alloc(sizeof(*type_ptr))
 127
 128 /*
 129  * Fill memory (pointed by ptr, having size bytes) with different bytes (with
 130  * values starting with start and resetting every period) in order to catch
 131  * sign, byte order and/or alignment errors.
 132  */
 133 void fill_memory_ex(void *ptr, size_t size, unsigned char start,
 134                     unsigned char period);
 135 /* Shortcut for fill_memory_ex(ptr, size, 0x80, 0x80) */
 136 void fill_memory(void *ptr, size_t size);
 137
 138 /* Close stdin, move stdout to a non-standard descriptor, and print. */
 139 void tprintf(const char *, ...)
 140         ATTRIBUTE_FORMAT((printf, 1, 2));
 141
 142 /* Make a hexdump copy of C string */
 143 const char *hexdump_strdup(const char *);
 144
 145 /* Make a hexdump copy of memory */
 146 const char *hexdump_memdup(const char *, size_t);
 147
 148 /* Make a hexquoted copy of a string */
 149 const char *hexquote_strndup(const char *, size_t);
 150
 151 /* Return inode number of socket descriptor. */
 152 unsigned long inode_of_sockfd(int);
 153
 154 /* Print string in a quoted form with optional escape characters. */
 155 void print_quoted_string_ex(const char *, bool quote, const char *escape_str);
 156
 157 /* Print string in a quoted form. */
 158 void print_quoted_string(const char *);
 159
 160 /*
 161  * Print a NUL-terminated string `str' of length up to `size' - 1
 162  * in a quoted form.
 163  */
 164 void print_quoted_cstring(const char *str, size_t size);
 165
 166 /* Print memory in a quoted form with optional escape characters. */
 167 void print_quoted_memory_ex(const void *, size_t, bool quote,
 168                             const char *escape_chars);
 169
 170 /* Print memory in a quoted form. */
 171 void print_quoted_memory(const void *, size_t);
 172
 173 /* Print memory in a hexquoted form. */
 174 void print_quoted_hex(const void *, size_t);
 175
 176 /* Print time_t and nanoseconds in symbolic format. */
 177 void print_time_t_nsec(time_t, unsigned long long, int);
 178
 179 /* Print time_t and microseconds in symbolic format. */
 180 void print_time_t_usec(time_t, unsigned long long, int);
 181
 182 /* Read an int from the file. */
 183 int read_int_from_file(const char *, int *);
 184
 185 /* Check whether given uid matches kernel overflowuid. */
 186 void check_overflowuid(const int);
 187
 188 /* Check whether given gid matches kernel overflowgid. */
 189 void check_overflowgid(const int);
 190
 191 /* Translate errno to its name. */
 192 const char *errno2name(void);
 193
 194 /* Translate signal number to its name. */
 195 const char *signal2name(int);
 196
 197 /* Print return code and, in case return code is -1, errno information. */
 198 const char *sprintrc(long rc);
 199 /* sprintrc variant suitable for usage as part of grep pattern. */
 200 const char *sprintrc_grep(long rc);
 201
 202 struct xlat;
 203
 204 /* Print flags in symbolic form according to xlat table. */
 205 int printflags(const struct xlat *, const unsigned long long, const char *);
 206
 207 /* Print constant in symbolic form according to xlat table. */
 208 int printxval(const struct xlat *, const unsigned long long, const char *);
 209
 210 /* Invoke a socket syscall, either directly or via __NR_socketcall. */
 211 int socketcall(const int nr, const int call,
 212                long a1, long a2, long a3, long a4, long a5);
 213
 214 /* Wrappers for recvmmsg and sendmmsg syscalls. */
 215 struct mmsghdr;
 216 struct timespec;
 217 int recv_mmsg(int, struct mmsghdr *, unsigned int, unsigned int, struct timespec *);
 218 int send_mmsg(int, struct mmsghdr *, unsigned int, unsigned int);
 219
 220 /* Create a netlink socket. */
 221 int create_nl_socket_ext(int proto, const char *name);
 222 #define create_nl_socket(proto) create_nl_socket_ext((proto), #proto)
 223
 224 /* Create a pipe with maximized descriptor numbers. */
 225 void pipe_maxfd(int pipefd[2]);
 226
 227 /* if_nametoindex("lo") */
 228 unsigned int ifindex_lo(void);
 229
 230 #ifdef HAVE_IF_INDEXTONAME
 231 # define IFINDEX_LO_STR "if_nametoindex(\"lo\")"
 232 #else
 233 # define IFINDEX_LO_STR "1"
 234 #endif
 235
 236 #define F8ILL_KULONG_SUPPORTED  (sizeof(void *) < sizeof(kernel_ulong_t))
 237 #define F8ILL_KULONG_MASK       ((kernel_ulong_t) 0xffffffff00000000ULL)
 238
 239 /*
 240  * For 64-bit kernel_ulong_t and 32-bit pointer,
 241  * return a kernel_ulong_t value by filling higher bits.
 242  * For other architertures, return the original pointer.
 243  */
 244 static inline kernel_ulong_t
 245 f8ill_ptr_to_kulong(const void *const ptr)
 246 {
 247         const unsigned long uptr = (unsigned long) ptr;
 248         return F8ILL_KULONG_SUPPORTED
 249                ? F8ILL_KULONG_MASK | uptr : (kernel_ulong_t) uptr;
 250 }
 251
 252 # define LENGTH_OF(arg) ((unsigned int) sizeof(arg) - 1)
 253
 254 /* Zero-extend a signed integer type to unsigned long long. */
 255 #define zero_extend_signed_to_ull(v) \
 256         (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
 257          sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
 258          sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
 259          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
 260          (unsigned long long) (v))
 261
 262 /* Sign-extend an unsigned integer type to long long. */
 263 #define sign_extend_unsigned_to_ll(v) \
 264         (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
 265          sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
 266          sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
 267          sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
 268          (long long) (v))
 269
 270 #define SKIP_MAIN_UNDEFINED(arg) \
 271         int main(void) { error_msg_and_skip("undefined: %s", arg); }
 272
 273 #if WORDS_BIGENDIAN
 274 # define LL_PAIR(HI, LO) (HI), (LO)
 275 #else
 276 # define LL_PAIR(HI, LO) (LO), (HI)
 277 #endif
 278 #define LL_VAL_TO_PAIR(llval) LL_PAIR((long) ((llval) >> 32), (long) (llval))
 279
 280 #define _STR(_arg) #_arg
 281 #define ARG_STR(_arg) (_arg), #_arg
 282 #define ARG_ULL_STR(_arg) _arg##ULL, #_arg
 283
 284 /*
 285  * Assign an object of type DEST_TYPE at address DEST_ADDR
 286  * using memcpy to avoid potential unaligned access.
 287  */
 288 #define SET_STRUCT(DEST_TYPE, DEST_ADDR, ...)                                           \
 289         do {                                                                            \
 290                 DEST_TYPE dest_type_tmp_var = { __VA_ARGS__ };                          \
 291                 memcpy(DEST_ADDR, &dest_type_tmp_var, sizeof(dest_type_tmp_var));       \
 292         } while (0)
 293
 294 #define NLMSG_ATTR(nlh, hdrlen) ((void *)(nlh) + NLMSG_SPACE(hdrlen))
 295
 296 #endif /* !STRACE_TESTS_H */