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

   1 /*
   2  * Copyright (c) 2016 Dmitry V. Levin <ldv@altlinux.org>
   3  * Copyright (c) 2016-2017 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 # include <sys/types.h>
  37 # include "kernel_types.h"
  38 # include "gcc_compat.h"
  39
  40 /* Tests of "strace -v" are expected to define VERBOSE to 1. */
  41 #ifndef VERBOSE
  42 # define VERBOSE 0
  43 #endif
  44
  45 /* Cached sysconf(_SC_PAGESIZE). */
  46 size_t get_page_size(void);
  47
  48 /* The size of kernel's sigset_t. */
  49 unsigned int get_sigset_size(void);
  50
  51 /* Print message and strerror(errno) to stderr, then exit(1). */
  52 void perror_msg_and_fail(const char *, ...)
  53         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  54 /* Print message to stderr, then exit(1). */
  55 void error_msg_and_fail(const char *, ...)
  56         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  57 /* Print message to stderr, then exit(77). */
  58 void error_msg_and_skip(const char *, ...)
  59         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  60 /* Print message and strerror(errno) to stderr, then exit(77). */
  61 void perror_msg_and_skip(const char *, ...)
  62         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  63
  64 /* Stat the specified file and skip the test if the stat call failed. */
  65 void skip_if_unavailable(const char *);
  66
  67 /*
  68  * Allocate memory that ends on the page boundary.
  69  * Pages allocated by this call are preceded by an unmapped page
  70  * and followed also by an unmapped page.
  71  */
  72 void *tail_alloc(const size_t)
  73         ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1));
  74 /* Allocate memory using tail_alloc, then memcpy. */
  75 void *tail_memdup(const void *, const size_t)
  76         ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((2));
  77
  78 /*
  79  * Allocate an object of the specified type at the end
  80  * of a mapped memory region.
  81  * Assign its address to the specified constant pointer.
  82  */
  83 #define TAIL_ALLOC_OBJECT_CONST_PTR(type_name, type_ptr)        \
  84         type_name *const type_ptr = tail_alloc(sizeof(*type_ptr))
  85
  86 /*
  87  * Allocate an object of the specified type at the end
  88  * of a mapped memory region.
  89  * Assign its address to the specified variable pointer.
  90  */
  91 #define TAIL_ALLOC_OBJECT_VAR_PTR(type_name, type_ptr)          \
  92         type_name *type_ptr = tail_alloc(sizeof(*type_ptr))
  93
  94 /*
  95  * Fill memory (pointed by ptr, having size bytes) with different bytes (with
  96  * values starting with start and resetting every period) in order to catch
  97  * sign, byte order and/or alignment errors.
  98  */
  99 void fill_memory_ex(void *ptr, size_t size, unsigned char start,
 100                     unsigned char period);
 101 /* Shortcut for fill_memory_ex(ptr, size, 0x80, 0x80) */
 102 void fill_memory(void *ptr, size_t size);
 103
 104 /* Close stdin, move stdout to a non-standard descriptor, and print. */
 105 void tprintf(const char *, ...)
 106         ATTRIBUTE_FORMAT((printf, 1, 2));
 107
 108 /* Make a hexdump copy of C string */
 109 const char *hexdump_strdup(const char *);
 110
 111 /* Make a hexdump copy of memory */
 112 const char *hexdump_memdup(const char *, size_t);
 113
 114 /* Make a hexquoted copy of a string */
 115 const char *hexquote_strndup(const char *, size_t);
 116
 117 /* Return inode number of socket descriptor. */
 118 unsigned long inode_of_sockfd(int);
 119
 120 /* Print string in a quoted form. */
 121 void print_quoted_string(const char *);
 122
 123 /* Print memory in a quoted form. */
 124 void print_quoted_memory(const char *, size_t);
 125
 126 /* Print time_t and nanoseconds in symbolic format. */
 127 void print_time_t_nsec(time_t, unsigned long long, int);
 128
 129 /* Print time_t and microseconds in symbolic format. */
 130 void print_time_t_usec(time_t, unsigned long long, int);
 131
 132 /* Read an int from the file. */
 133 int read_int_from_file(const char *, int *);
 134
 135 /* Check whether given uid matches kernel overflowuid. */
 136 void check_overflowuid(const int);
 137
 138 /* Check whether given gid matches kernel overflowgid. */
 139 void check_overflowgid(const int);
 140
 141 /* Translate errno to its name. */
 142 const char *errno2name(void);
 143
 144 /* Translate signal number to its name. */
 145 const char *signal2name(int);
 146
 147 /* Print return code and, in case return code is -1, errno information. */
 148 const char *sprintrc(long rc);
 149 /* sprintrc variant suitable for usage as part of grep pattern. */
 150 const char *sprintrc_grep(long rc);
 151
 152 struct xlat;
 153
 154 /* Print flags in symbolic form according to xlat table. */
 155 int printflags(const struct xlat *, const unsigned long long, const char *);
 156
 157 /* Print constant in symbolic form according to xlat table. */
 158 int printxval(const struct xlat *, const unsigned long long, const char *);
 159
 160 /* Invoke a socket syscall, either directly or via __NR_socketcall. */
 161 int socketcall(const int nr, const int call,
 162                long a1, long a2, long a3, long a4, long a5);
 163
 164 /* Wrappers for recvmmsg and sendmmsg syscalls. */
 165 struct mmsghdr;
 166 struct timespec;
 167 int recv_mmsg(int, struct mmsghdr *, unsigned int, unsigned int, struct timespec *);
 168 int send_mmsg(int, struct mmsghdr *, unsigned int, unsigned int);
 169
 170 /* Create a netlink socket. */
 171 int create_nl_socket_ext(int proto, const char *name);
 172 #define create_nl_socket(proto) create_nl_socket_ext((proto), #proto)
 173
 174 /* Create a pipe with maximized descriptor numbers. */
 175 void pipe_maxfd(int pipefd[2]);
 176
 177 #define F8ILL_KULONG_SUPPORTED  (sizeof(void *) < sizeof(kernel_ulong_t))
 178 #define F8ILL_KULONG_MASK       ((kernel_ulong_t) 0xffffffff00000000ULL)
 179
 180 /*
 181  * For 64-bit kernel_ulong_t and 32-bit pointer,
 182  * return a kernel_ulong_t value by filling higher bits.
 183  * For other architertures, return the original pointer.
 184  */
 185 static inline kernel_ulong_t
 186 f8ill_ptr_to_kulong(const void *const ptr)
 187 {
 188         const unsigned long uptr = (unsigned long) ptr;
 189         return F8ILL_KULONG_SUPPORTED
 190                ? F8ILL_KULONG_MASK | uptr : (kernel_ulong_t) uptr;
 191 }
 192
 193 # define ARRAY_SIZE(arg) ((unsigned int) (sizeof(arg) / sizeof((arg)[0])))
 194 # define LENGTH_OF(arg) ((unsigned int) sizeof(arg) - 1)
 195
 196 /* Zero-extend a signed integer type to unsigned long long. */
 197 #define zero_extend_signed_to_ull(v) \
 198         (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
 199          sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
 200          sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
 201          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
 202          (unsigned long long) (v))
 203
 204 /* Sign-extend an unsigned integer type to long long. */
 205 #define sign_extend_unsigned_to_ll(v) \
 206         (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
 207          sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
 208          sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
 209          sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
 210          (long long) (v))
 211
 212 # define SKIP_MAIN_UNDEFINED(arg) \
 213         int main(void) { error_msg_and_skip("undefined: %s", arg); }
 214
 215 /*
 216  * The kernel used to define 64-bit types on 64-bit systems on a per-arch
 217  * basis.  Some architectures would use unsigned long and others would use
 218  * unsigned long long.  These types were exported as part of the
 219  * kernel-userspace ABI and now must be maintained forever.  This matches
 220  * what the kernel exports for each architecture so we don't need to cast
 221  * every printing of __u64 or __s64 to stdint types.
 222  */
 223 # if SIZEOF_LONG == 4
 224 #  define PRI__64 "ll"
 225 # elif defined ALPHA || defined IA64 || defined MIPS || defined POWERPC
 226 #  define PRI__64 "l"
 227 # else
 228 #  define PRI__64 "ll"
 229 # endif
 230
 231 # define PRI__d64 PRI__64"d"
 232 # define PRI__u64 PRI__64"u"
 233 # define PRI__x64 PRI__64"x"
 234
 235 # if WORDS_BIGENDIAN
 236 #  define LL_PAIR(HI, LO) (HI), (LO)
 237 # else
 238 #  define LL_PAIR(HI, LO) (LO), (HI)
 239 # endif
 240 # define LL_VAL_TO_PAIR(llval) LL_PAIR((long) ((llval) >> 32), (long) (llval))
 241
 242 # define _STR(_arg) #_arg
 243 # define ARG_STR(_arg) (_arg), #_arg
 244 # define ARG_ULL_STR(_arg) _arg##ULL, #_arg
 245
 246 #endif /* !STRACE_TESTS_H */