]> granicus.if.org Git - strace/blob - tests/tests.h
tests: add print_quoted_memory function to libtests
[strace] / 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 /* Check whether given uid matches kernel overflowuid. */
88 void check_overflowuid(const int);
89
90 /* Check whether given gid matches kernel overflowgid. */
91 void check_overflowgid(const int);
92
93 /* Translate errno to its name. */
94 const char *errno2name(void);
95
96 struct xlat;
97
98 /* Print flags in symbolic form according to xlat table. */
99 int printflags(const struct xlat *, const unsigned long long, const char *);
100
101 /* Print constant in symbolic form according to xlat table. */
102 int printxval(const struct xlat *, const unsigned long long, const char *);
103
104 # define ARRAY_SIZE(arg) ((unsigned int) (sizeof(arg) / sizeof((arg)[0])))
105 # define LENGTH_OF(arg) ((unsigned int) sizeof(arg) - 1)
106
107 # define SKIP_MAIN_UNDEFINED(arg) \
108         int main(void) { error_msg_and_skip("undefined: %s", arg); }
109
110 #endif