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 /* xlat verbosity defaults */
  66 #ifndef XLAT_RAW
  67 # define XLAT_RAW 0
  68 #endif
  69 #ifndef XLAT_VERBOSE
  70 # define XLAT_VERBOSE 0
  71 #endif
  72
  73 #ifndef DEFAULT_STRLEN
  74 /* Default maximum # of bytes printed in printstr et al. */
  75 # define DEFAULT_STRLEN 32
  76 #endif
  77
  78 /* Cached sysconf(_SC_PAGESIZE). */
  79 size_t get_page_size(void);
  80
  81 /* The size of kernel's sigset_t. */
  82 unsigned int get_sigset_size(void);
  83
  84 /* Print message and strerror(errno) to stderr, then exit(1). */
  85 void perror_msg_and_fail(const char *, ...)
  86         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  87 /* Print message to stderr, then exit(1). */
  88 void error_msg_and_fail(const char *, ...)
  89         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  90 /* Print message to stderr, then exit(77). */
  91 void error_msg_and_skip(const char *, ...)
  92         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  93 /* Print message and strerror(errno) to stderr, then exit(77). */
  94 void perror_msg_and_skip(const char *, ...)
  95         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  96
  97 #ifndef perror_msg_and_fail
  98 # define perror_msg_and_fail(fmt_, ...) \
  99         perror_msg_and_fail("%s:%d: " fmt_, __FILE__, __LINE__, ##__VA_ARGS__)
 100 #endif
 101 #ifndef perror_msg_and_fail
 102 # define error_msg_and_fail(fmt_, ...) \
 103         error_msg_and_fail("%s:%d: " fmt_, __FILE__, __LINE__, ##__VA_ARGS__)
 104 #endif
 105
 106 /* Stat the specified file and skip the test if the stat call failed. */
 107 void skip_if_unavailable(const char *);
 108
 109 /*
 110  * Allocate memory that ends on the page boundary.
 111  * Pages allocated by this call are preceded by an unmapped page
 112  * and followed also by an unmapped page.
 113  */
 114 void *tail_alloc(const size_t)
 115         ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1));
 116 /* Allocate memory using tail_alloc, then memcpy. */
 117 void *tail_memdup(const void *, const size_t)
 118         ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((2));
 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 constant pointer.
 124  */
 125 #define TAIL_ALLOC_OBJECT_CONST_PTR(type_name, type_ptr)        \
 126         type_name *const type_ptr = tail_alloc(sizeof(*type_ptr))
 127
 128 /*
 129  * Allocate an object of the specified type at the end
 130  * of a mapped memory region.
 131  * Assign its address to the specified variable pointer.
 132  */
 133 #define TAIL_ALLOC_OBJECT_VAR_PTR(type_name, type_ptr)          \
 134         type_name *type_ptr = tail_alloc(sizeof(*type_ptr))
 135
 136 /*
 137  * Fill memory (pointed by ptr, having size bytes) with different bytes (with
 138  * values starting with start and resetting every period) in order to catch
 139  * sign, byte order and/or alignment errors.
 140  */
 141 void fill_memory_ex(void *ptr, size_t size, unsigned char start,
 142                     unsigned char period);
 143 /* Shortcut for fill_memory_ex(ptr, size, 0x80, 0x80) */
 144 void fill_memory(void *ptr, size_t size);
 145
 146 /* Close stdin, move stdout to a non-standard descriptor, and print. */
 147 void tprintf(const char *, ...)
 148         ATTRIBUTE_FORMAT((printf, 1, 2));
 149
 150 /* Make a hexdump copy of C string */
 151 const char *hexdump_strdup(const char *);
 152
 153 /* Make a hexdump copy of memory */
 154 const char *hexdump_memdup(const char *, size_t);
 155
 156 /* Make a hexquoted copy of a string */
 157 const char *hexquote_strndup(const char *, size_t);
 158
 159 /* Return inode number of socket descriptor. */
 160 unsigned long inode_of_sockfd(int);
 161
 162 /* Print string in a quoted form with optional escape characters. */
 163 void print_quoted_string_ex(const char *, bool quote, const char *escape_str);
 164
 165 /* Print string in a quoted form. */
 166 void print_quoted_string(const char *);
 167
 168 /*
 169  * Print a NUL-terminated string `str' of length up to `size' - 1
 170  * in a quoted form.
 171  */
 172 void print_quoted_cstring(const char *str, size_t size);
 173
 174 /* Print memory in a quoted form with optional escape characters. */
 175 void print_quoted_memory_ex(const void *, size_t, bool quote,
 176                             const char *escape_chars);
 177
 178 /* Print memory in a quoted form. */
 179 void print_quoted_memory(const void *, size_t);
 180
 181 /* Print memory in a hexquoted form. */
 182 void print_quoted_hex(const void *, size_t);
 183
 184 /* Print time_t and nanoseconds in symbolic format. */
 185 void print_time_t_nsec(time_t, unsigned long long, int);
 186
 187 /* Print time_t and microseconds in symbolic format. */
 188 void print_time_t_usec(time_t, unsigned long long, int);
 189
 190 /* Read an int from the file. */
 191 int read_int_from_file(const char *, int *);
 192
 193 /* Check whether given uid matches kernel overflowuid. */
 194 void check_overflowuid(const int);
 195
 196 /* Check whether given gid matches kernel overflowgid. */
 197 void check_overflowgid(const int);
 198
 199 /* Translate errno to its name. */
 200 const char *errno2name(void);
 201
 202 /* Translate signal number to its name. */
 203 const char *signal2name(int);
 204
 205 /* Print return code and, in case return code is -1, errno information. */
 206 const char *sprintrc(long rc);
 207 /* sprintrc variant suitable for usage as part of grep pattern. */
 208 const char *sprintrc_grep(long rc);
 209
 210 struct xlat;
 211
 212 /* Print flags in symbolic form according to xlat table. */
 213 int printflags(const struct xlat *, const unsigned long long, const char *);
 214
 215 /* Print constant in symbolic form according to xlat table. */
 216 int printxval(const struct xlat *, const unsigned long long, const char *);
 217
 218 /* Invoke a socket syscall, either directly or via __NR_socketcall. */
 219 int socketcall(const int nr, const int call,
 220                long a1, long a2, long a3, long a4, long a5);
 221
 222 /* Wrappers for recvmmsg and sendmmsg syscalls. */
 223 struct mmsghdr;
 224 struct timespec;
 225 int recv_mmsg(int, struct mmsghdr *, unsigned int, unsigned int, struct timespec *);
 226 int send_mmsg(int, struct mmsghdr *, unsigned int, unsigned int);
 227
 228 /* Create a netlink socket. */
 229 int create_nl_socket_ext(int proto, const char *name);
 230 #define create_nl_socket(proto) create_nl_socket_ext((proto), #proto)
 231
 232 /* Create a pipe with maximized descriptor numbers. */
 233 void pipe_maxfd(int pipefd[2]);
 234
 235 /* if_nametoindex("lo") */
 236 unsigned int ifindex_lo(void);
 237
 238 #ifdef HAVE_IF_INDEXTONAME
 239 # define IFINDEX_LO_STR "if_nametoindex(\"lo\")"
 240 #else
 241 # define IFINDEX_LO_STR "1"
 242 #endif
 243
 244 #define F8ILL_KULONG_SUPPORTED  (sizeof(void *) < sizeof(kernel_ulong_t))
 245 #define F8ILL_KULONG_MASK       ((kernel_ulong_t) 0xffffffff00000000ULL)
 246
 247 /*
 248  * For 64-bit kernel_ulong_t and 32-bit pointer,
 249  * return a kernel_ulong_t value by filling higher bits.
 250  * For other architertures, return the original pointer.
 251  */
 252 static inline kernel_ulong_t
 253 f8ill_ptr_to_kulong(const void *const ptr)
 254 {
 255         const unsigned long uptr = (unsigned long) ptr;
 256         return F8ILL_KULONG_SUPPORTED
 257                ? F8ILL_KULONG_MASK | uptr : (kernel_ulong_t) uptr;
 258 }
 259
 260 # define LENGTH_OF(arg) ((unsigned int) sizeof(arg) - 1)
 261
 262 /* Zero-extend a signed integer type to unsigned long long. */
 263 #define zero_extend_signed_to_ull(v) \
 264         (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
 265          sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
 266          sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
 267          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
 268          (unsigned long long) (v))
 269
 270 /* Sign-extend an unsigned integer type to long long. */
 271 #define sign_extend_unsigned_to_ll(v) \
 272         (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
 273          sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
 274          sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
 275          sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
 276          (long long) (v))
 277
 278 #define SKIP_MAIN_UNDEFINED(arg) \
 279         int main(void) { error_msg_and_skip("undefined: %s", arg); }
 280
 281 #if WORDS_BIGENDIAN
 282 # define LL_PAIR(HI, LO) (HI), (LO)
 283 #else
 284 # define LL_PAIR(HI, LO) (LO), (HI)
 285 #endif
 286 #define LL_VAL_TO_PAIR(llval) LL_PAIR((long) ((llval) >> 32), (long) (llval))
 287
 288 #define _STR(_arg) #_arg
 289 #define ARG_STR(_arg) (_arg), #_arg
 290 #define ARG_ULL_STR(_arg) _arg##ULL, #_arg
 291
 292 /*
 293  * Assign an object of type DEST_TYPE at address DEST_ADDR
 294  * using memcpy to avoid potential unaligned access.
 295  */
 296 #define SET_STRUCT(DEST_TYPE, DEST_ADDR, ...)                                           \
 297         do {                                                                            \
 298                 DEST_TYPE dest_type_tmp_var = { __VA_ARGS__ };                          \
 299                 memcpy(DEST_ADDR, &dest_type_tmp_var, sizeof(dest_type_tmp_var));       \
 300         } while (0)
 301
 302 #define NLMSG_ATTR(nlh, hdrlen) ((void *)(nlh) + NLMSG_SPACE(hdrlen))
 303
 304 #endif /* !STRACE_TESTS_H */