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

   1 /*
   2  * Copyright (c) 2016 Dmitry V. Levin <ldv@altlinux.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef TESTS_H_
  29 # define TESTS_H_
  30
  31 # ifdef HAVE_CONFIG_H
  32 #  include "config.h"
  33 # endif
  34
  35 # include <sys/types.h>
  36 # include "gcc_compat.h"
  37
  38 /* Cached sysconf(_SC_PAGESIZE). */
  39 size_t get_page_size(void);
  40
  41 /* Print message and strerror(errno) to stderr, then exit(1). */
  42 void perror_msg_and_fail(const char *, ...)
  43         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  44 /* Print message to stderr, then exit(1). */
  45 void error_msg_and_fail(const char *, ...)
  46         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  47 /* Print message to stderr, then exit(77). */
  48 void error_msg_and_skip(const char *, ...)
  49         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  50 /* Print message and strerror(errno) to stderr, then exit(77). */
  51 void perror_msg_and_skip(const char *, ...)
  52         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
  53
  54 /*
  55  * Allocate memory that ends on the page boundary.
  56  * Pages allocated by this call are preceeded by an unmapped page
  57  * and followed also by an unmapped page.
  58  */
  59 void *tail_alloc(const size_t)
  60         ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1));
  61 /* Allocate memory using tail_alloc, then memcpy. */
  62 void *tail_memdup(const void *, const size_t)
  63         ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((2));
  64
  65 /* Close stdin, move stdout to a non-standard descriptor, and print. */
  66 void tprintf(const char *, ...)
  67         ATTRIBUTE_FORMAT((printf, 1, 2));
  68
  69 /* Make a hexdump copy of C string */
  70 const char *hexdump_strdup(const char *);
  71
  72 /* Make a hexdump copy of memory */
  73 const char *hexdump_memdup(const char *, size_t);
  74
  75 /* Make a hexquoted copy of a string */
  76 const char *hexquote_strndup(const char *, size_t);
  77
  78 /* Return inode number of socket descriptor. */
  79 unsigned long inode_of_sockfd(int);
  80
  81 /* Print string in a quoted form. */
  82 void print_quoted_string(const char *);
  83
  84 /* Print memory in a quoted form. */
  85 void print_quoted_memory(const char *, size_t);
  86
  87 /* Read an int from the file. */
  88 int read_int_from_file(const char *, int *);
  89
  90 /* Check whether given uid matches kernel overflowuid. */
  91 void check_overflowuid(const int);
  92
  93 /* Check whether given gid matches kernel overflowgid. */
  94 void check_overflowgid(const int);
  95
  96 /* Translate errno to its name. */
  97 const char *errno2name(void);
  98
  99 /* Translate signal number to its name. */
 100 const char *signal2name(int);
 101
 102 struct xlat;
 103
 104 /* Print flags in symbolic form according to xlat table. */
 105 int printflags(const struct xlat *, const unsigned long long, const char *);
 106
 107 /* Print constant in symbolic form according to xlat table. */
 108 int printxval(const struct xlat *, const unsigned long long, const char *);
 109
 110 /* Invoke a socket syscall, either directly or via __NR_socketcall. */
 111 int socketcall(const int nr, const int call,
 112                long a1, long a2, long a3, long a4, long a5);
 113
 114 /* Wrappers for recvmmsg and sendmmsg syscalls. */
 115 struct mmsghdr;
 116 struct timespec;
 117 int recv_mmsg(int, struct mmsghdr *, unsigned int, unsigned int, struct timespec *);
 118 int send_mmsg(int, struct mmsghdr *, unsigned int, unsigned int);
 119
 120 # define ARRAY_SIZE(arg) ((unsigned int) (sizeof(arg) / sizeof((arg)[0])))
 121 # define LENGTH_OF(arg) ((unsigned int) sizeof(arg) - 1)
 122
 123 /*
 124  * Widen without sign-extension a signed integer type to unsigned long long.
 125  */
 126 #define widen_to_ull(v) \
 127         (sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
 128          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
 129          (unsigned long long) (v))
 130
 131 # define SKIP_MAIN_UNDEFINED(arg) \
 132         int main(void) { error_msg_and_skip("undefined: %s", arg); }
 133
 134 /*
 135  * The kernel used to define 64-bit types on 64-bit systems on a per-arch
 136  * basis.  Some architectures would use unsigned long and others would use
 137  * unsigned long long.  These types were exported as part of the
 138  * kernel-userspace ABI and now must be maintained forever.  This matches
 139  * what the kernel exports for each architecture so we don't need to cast
 140  * every printing of __u64 or __s64 to stdint types.
 141  */
 142 # if SIZEOF_LONG == 4
 143 #  define PRI__64 "ll"
 144 # elif defined ALPHA || defined IA64 || defined MIPS || defined POWERPC
 145 #  define PRI__64 "l"
 146 # else
 147 #  define PRI__64 "ll"
 148 # endif
 149
 150 # define PRI__d64 PRI__64"d"
 151 # define PRI__u64 PRI__64"u"
 152 # define PRI__x64 PRI__64"x"
 153
 154 #endif