2 * Copyright (c) 2016 Dmitry V. Levin <ldv@altlinux.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
28 #ifndef STRACE_TESTS_H
29 #define STRACE_TESTS_H
35 # include <sys/types.h>
36 # include "kernel_types.h"
37 # include "gcc_compat.h"
39 /* Tests of "strace -v" are expected to define VERBOSE to 1. */
44 /* Cached sysconf(_SC_PAGESIZE). */
45 size_t get_page_size(void);
47 /* The size of kernel's sigset_t. */
48 unsigned int get_sigset_size(void);
50 /* Print message and strerror(errno) to stderr, then exit(1). */
51 void perror_msg_and_fail(const char *, ...)
52 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
53 /* Print message to stderr, then exit(1). */
54 void error_msg_and_fail(const char *, ...)
55 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
56 /* Print message to stderr, then exit(77). */
57 void error_msg_and_skip(const char *, ...)
58 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
59 /* Print message and strerror(errno) to stderr, then exit(77). */
60 void perror_msg_and_skip(const char *, ...)
61 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
64 * Allocate memory that ends on the page boundary.
65 * Pages allocated by this call are preceeded by an unmapped page
66 * and followed also by an unmapped page.
68 void *tail_alloc(const size_t)
69 ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1));
70 /* Allocate memory using tail_alloc, then memcpy. */
71 void *tail_memdup(const void *, const size_t)
72 ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((2));
75 * Fill memory (pointed by ptr, having size bytes) with different bytes (with
76 * values starting with start and resetting every period) in order to catch
77 * sign, byte order and/or alignment errors.
79 void fill_memory_ex(void *ptr, size_t size, unsigned char start,
80 unsigned char period);
81 /* Shortcut for fill_memory_ex(ptr, size, 0x80, 0x80) */
82 void fill_memory(void *ptr, size_t size);
84 /* Close stdin, move stdout to a non-standard descriptor, and print. */
85 void tprintf(const char *, ...)
86 ATTRIBUTE_FORMAT((printf, 1, 2));
88 /* Make a hexdump copy of C string */
89 const char *hexdump_strdup(const char *);
91 /* Make a hexdump copy of memory */
92 const char *hexdump_memdup(const char *, size_t);
94 /* Make a hexquoted copy of a string */
95 const char *hexquote_strndup(const char *, size_t);
97 /* Return inode number of socket descriptor. */
98 unsigned long inode_of_sockfd(int);
100 /* Print string in a quoted form. */
101 void print_quoted_string(const char *);
103 /* Print memory in a quoted form. */
104 void print_quoted_memory(const char *, size_t);
106 /* Read an int from the file. */
107 int read_int_from_file(const char *, int *);
109 /* Check whether given uid matches kernel overflowuid. */
110 void check_overflowuid(const int);
112 /* Check whether given gid matches kernel overflowgid. */
113 void check_overflowgid(const int);
115 /* Translate errno to its name. */
116 const char *errno2name(void);
118 /* Translate signal number to its name. */
119 const char *signal2name(int);
121 /* Print return code and, in case return code is -1, errno information. */
122 const char *sprintrc(long rc);
123 /* sprintrc variant suitable for usage as part of grep pattern. */
124 const char *sprintrc_grep(long rc);
128 /* Print flags in symbolic form according to xlat table. */
129 int printflags(const struct xlat *, const unsigned long long, const char *);
131 /* Print constant in symbolic form according to xlat table. */
132 int printxval(const struct xlat *, const unsigned long long, const char *);
134 /* Invoke a socket syscall, either directly or via __NR_socketcall. */
135 int socketcall(const int nr, const int call,
136 long a1, long a2, long a3, long a4, long a5);
138 /* Wrappers for recvmmsg and sendmmsg syscalls. */
141 int recv_mmsg(int, struct mmsghdr *, unsigned int, unsigned int, struct timespec *);
142 int send_mmsg(int, struct mmsghdr *, unsigned int, unsigned int);
144 /* Create a pipe with maximized descriptor numbers. */
145 void pipe_maxfd(int pipefd[2]);
147 #define F8ILL_KULONG_SUPPORTED (sizeof(void *) < sizeof(kernel_ulong_t))
148 #define F8ILL_KULONG_MASK ((kernel_ulong_t) 0xffffffff00000000ULL)
151 * For 64-bit kernel_ulong_t and 32-bit pointer,
152 * return a kernel_ulong_t value by filling higher bits.
153 * For other architertures, return the original pointer.
155 static inline kernel_ulong_t
156 f8ill_ptr_to_kulong(const void *const ptr)
158 const unsigned long uptr = (unsigned long) ptr;
159 return F8ILL_KULONG_SUPPORTED
160 ? F8ILL_KULONG_MASK | uptr : (kernel_ulong_t) uptr;
163 # define ARRAY_SIZE(arg) ((unsigned int) (sizeof(arg) / sizeof((arg)[0])))
164 # define LENGTH_OF(arg) ((unsigned int) sizeof(arg) - 1)
166 /* Zero-extend a signed integer type to unsigned long long. */
167 #define zero_extend_signed_to_ull(v) \
168 (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
169 sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
170 sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
171 sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
172 (unsigned long long) (v))
174 /* Sign-extend an unsigned integer type to long long. */
175 #define sign_extend_unsigned_to_ll(v) \
176 (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
177 sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
178 sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
179 sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
182 # define SKIP_MAIN_UNDEFINED(arg) \
183 int main(void) { error_msg_and_skip("undefined: %s", arg); }
186 * The kernel used to define 64-bit types on 64-bit systems on a per-arch
187 * basis. Some architectures would use unsigned long and others would use
188 * unsigned long long. These types were exported as part of the
189 * kernel-userspace ABI and now must be maintained forever. This matches
190 * what the kernel exports for each architecture so we don't need to cast
191 * every printing of __u64 or __s64 to stdint types.
193 # if SIZEOF_LONG == 4
194 # define PRI__64 "ll"
195 # elif defined ALPHA || defined IA64 || defined MIPS || defined POWERPC
198 # define PRI__64 "ll"
201 # define PRI__d64 PRI__64"d"
202 # define PRI__u64 PRI__64"u"
203 # define PRI__x64 PRI__64"x"
206 # define LL_PAIR(HI, LO) (HI), (LO)
208 # define LL_PAIR(HI, LO) (LO), (HI)
210 # define LL_VAL_TO_PAIR(llval) LL_PAIR((long) ((llval) >> 32), (long) (llval))
212 # define _STR(_arg) #_arg
213 # define ARG_STR(_arg) (_arg), #_arg
214 # define ARG_ULL_STR(_arg) _arg##ULL, #_arg
216 #endif /* !STRACE_TESTS_H */