xref: /aosp_15_r20/external/strace/error_prints.h (revision cf84ac9a129d8ea9952db616b4e9b904c4bdde56)
1*cf84ac9aSAndroid Build Coastguard Worker /*
2*cf84ac9aSAndroid Build Coastguard Worker  * This file contains error printing functions.
3*cf84ac9aSAndroid Build Coastguard Worker  * These functions can be used by various binaries included in the strace
4*cf84ac9aSAndroid Build Coastguard Worker  * package.  Variable 'program_invocation_name' and function 'die()'
5*cf84ac9aSAndroid Build Coastguard Worker  * have to be defined globally.
6*cf84ac9aSAndroid Build Coastguard Worker  *
7*cf84ac9aSAndroid Build Coastguard Worker  * Copyright (c) 2001-2017 The strace developers.
8*cf84ac9aSAndroid Build Coastguard Worker  * All rights reserved.
9*cf84ac9aSAndroid Build Coastguard Worker  *
10*cf84ac9aSAndroid Build Coastguard Worker  * Redistribution and use in source and binary forms, with or without
11*cf84ac9aSAndroid Build Coastguard Worker  * modification, are permitted provided that the following conditions
12*cf84ac9aSAndroid Build Coastguard Worker  * are met:
13*cf84ac9aSAndroid Build Coastguard Worker  * 1. Redistributions of source code must retain the above copyright
14*cf84ac9aSAndroid Build Coastguard Worker  *    notice, this list of conditions and the following disclaimer.
15*cf84ac9aSAndroid Build Coastguard Worker  * 2. Redistributions in binary form must reproduce the above copyright
16*cf84ac9aSAndroid Build Coastguard Worker  *    notice, this list of conditions and the following disclaimer in the
17*cf84ac9aSAndroid Build Coastguard Worker  *    documentation and/or other materials provided with the distribution.
18*cf84ac9aSAndroid Build Coastguard Worker  * 3. The name of the author may not be used to endorse or promote products
19*cf84ac9aSAndroid Build Coastguard Worker  *    derived from this software without specific prior written permission.
20*cf84ac9aSAndroid Build Coastguard Worker  *
21*cf84ac9aSAndroid Build Coastguard Worker  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22*cf84ac9aSAndroid Build Coastguard Worker  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23*cf84ac9aSAndroid Build Coastguard Worker  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24*cf84ac9aSAndroid Build Coastguard Worker  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25*cf84ac9aSAndroid Build Coastguard Worker  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26*cf84ac9aSAndroid Build Coastguard Worker  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27*cf84ac9aSAndroid Build Coastguard Worker  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28*cf84ac9aSAndroid Build Coastguard Worker  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29*cf84ac9aSAndroid Build Coastguard Worker  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30*cf84ac9aSAndroid Build Coastguard Worker  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31*cf84ac9aSAndroid Build Coastguard Worker  */
32*cf84ac9aSAndroid Build Coastguard Worker 
33*cf84ac9aSAndroid Build Coastguard Worker #ifndef STRACE_ERROR_PRINTS_H
34*cf84ac9aSAndroid Build Coastguard Worker #define STRACE_ERROR_PRINTS_H
35*cf84ac9aSAndroid Build Coastguard Worker 
36*cf84ac9aSAndroid Build Coastguard Worker #include <stdbool.h>
37*cf84ac9aSAndroid Build Coastguard Worker 
38*cf84ac9aSAndroid Build Coastguard Worker #include "gcc_compat.h"
39*cf84ac9aSAndroid Build Coastguard Worker 
40*cf84ac9aSAndroid Build Coastguard Worker extern bool debug_flag;
41*cf84ac9aSAndroid Build Coastguard Worker 
42*cf84ac9aSAndroid Build Coastguard Worker void die(void) ATTRIBUTE_NORETURN;
43*cf84ac9aSAndroid Build Coastguard Worker 
44*cf84ac9aSAndroid Build Coastguard Worker void error_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
45*cf84ac9aSAndroid Build Coastguard Worker void perror_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
46*cf84ac9aSAndroid Build Coastguard Worker void perror_msg_and_die(const char *fmt, ...)
47*cf84ac9aSAndroid Build Coastguard Worker 	ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
48*cf84ac9aSAndroid Build Coastguard Worker void error_msg_and_help(const char *fmt, ...)
49*cf84ac9aSAndroid Build Coastguard Worker 	ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
50*cf84ac9aSAndroid Build Coastguard Worker void error_msg_and_die(const char *fmt, ...)
51*cf84ac9aSAndroid Build Coastguard Worker 	ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
52*cf84ac9aSAndroid Build Coastguard Worker 
53*cf84ac9aSAndroid Build Coastguard Worker /* Wrappers for if (debug_flag) error_msg(...) */
54*cf84ac9aSAndroid Build Coastguard Worker #define debug_msg(...) \
55*cf84ac9aSAndroid Build Coastguard Worker 	do { \
56*cf84ac9aSAndroid Build Coastguard Worker 		if (debug_flag) \
57*cf84ac9aSAndroid Build Coastguard Worker 			error_msg(__VA_ARGS__); \
58*cf84ac9aSAndroid Build Coastguard Worker 	} while (0)
59*cf84ac9aSAndroid Build Coastguard Worker #define debug_perror_msg(...) \
60*cf84ac9aSAndroid Build Coastguard Worker 	do { \
61*cf84ac9aSAndroid Build Coastguard Worker 		if (debug_flag) \
62*cf84ac9aSAndroid Build Coastguard Worker 			perror_msg(__VA_ARGS__); \
63*cf84ac9aSAndroid Build Coastguard Worker 	} while (0)
64*cf84ac9aSAndroid Build Coastguard Worker 
65*cf84ac9aSAndroid Build Coastguard Worker /* Simple wrappers for providing function name in error messages */
66*cf84ac9aSAndroid Build Coastguard Worker #define error_func_msg(fmt_, ...) \
67*cf84ac9aSAndroid Build Coastguard Worker 	error_msg("%s: " fmt_,  __func__, ##__VA_ARGS__)
68*cf84ac9aSAndroid Build Coastguard Worker #define perror_func_msg(fmt_, ...) \
69*cf84ac9aSAndroid Build Coastguard Worker 	perror_msg("%s: " fmt_, __func__, ##__VA_ARGS__)
70*cf84ac9aSAndroid Build Coastguard Worker #define debug_func_msg(fmt_, ...) \
71*cf84ac9aSAndroid Build Coastguard Worker 	debug_msg("%s: " fmt_, __func__, ##__VA_ARGS__)
72*cf84ac9aSAndroid Build Coastguard Worker #define debug_func_perror_msg(fmt_, ...) \
73*cf84ac9aSAndroid Build Coastguard Worker 	debug_perror_msg("%s: " fmt_, __func__, ##__VA_ARGS__)
74*cf84ac9aSAndroid Build Coastguard Worker #define error_func_msg_and_die(fmt_, ...) \
75*cf84ac9aSAndroid Build Coastguard Worker 	error_msg_and_die("%s: " fmt_, __func__, ##__VA_ARGS__)
76*cf84ac9aSAndroid Build Coastguard Worker #define perror_func_msg_and_die(fmt_, ...) \
77*cf84ac9aSAndroid Build Coastguard Worker 	perror_msg_and_die("%s: " fmt_, __func__, ##__VA_ARGS__)
78*cf84ac9aSAndroid Build Coastguard Worker 
79*cf84ac9aSAndroid Build Coastguard Worker #endif /* !STRACE_ERROR_PRINTS_H */
80