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