1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
/* $Id$
*
* Utility functions.
*
* This is a variety of utility functions that are used internally by pieces
* of remctl. Many of them came originally from INN.
*
* Written by Russ Allbery <rra@stanford.edu>
* Copyright 2005, 2006, 2007, 2008
* Board of Trustees, Leland Stanford Jr. University
* Copyright 2004, 2005, 2006, 2007
* by Internet Systems Consortium, Inc. ("ISC")
* Copyright 1991, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
* 2003 by The Internet Software Consortium and Rich Salz
*
* See LICENSE for licensing terms.
*/
#ifndef UTIL_UTIL_H
#define UTIL_UTIL_H 1
#include <config.h>
#include <portable/macros.h>
#include <krb5.h>
#include <stdarg.h>
#include <sys/types.h>
/* Used for unused parameters to silence gcc warnings. */
#define UNUSED __attribute__((__unused__))
BEGIN_DECLS
/* Concatenate NULL-terminated strings into a newly allocated string. */
extern char *concat(const char *first, ...);
/*
* Given a base path and a file name, create a newly allocated path string.
* The name will be appended to base with a / between them. Exceptionally, if
* name begins with a slash, it will be strdup'd and returned as-is.
*/
extern char *concatpath(const char *base, const char *name);
/*
* The reporting functions. The ones prefaced by "sys" add a colon, a space,
* and the results of strerror(errno) to the output and are intended for
* reporting failures of system calls.
*/
extern void debug(const char *, ...)
__attribute__((__format__(printf, 1, 2)));
extern void notice(const char *, ...)
__attribute__((__format__(printf, 1, 2)));
extern void sysnotice(const char *, ...)
__attribute__((__format__(printf, 1, 2)));
extern void warn(const char *, ...)
__attribute__((__format__(printf, 1, 2)));
extern void syswarn(const char *, ...)
__attribute__((__format__(printf, 1, 2)));
extern void die(const char *, ...)
__attribute__((__noreturn__, __format__(printf, 1, 2)));
extern void sysdie(const char *, ...)
__attribute__((__noreturn__, __format__(printf, 1, 2)));
/*
* The Kerberos versions of the reporting functions. These take a context and
* an error code to get the Kerberos error.
*/
void die_krb5(krb5_context, krb5_error_code, const char *, ...)
__attribute__((__noreturn__, __format__(printf, 3, 4)));
void warn_krb5(krb5_context, krb5_error_code, const char *, ...)
__attribute__((__format__(printf, 3, 4)));
/*
* Set the handlers for various message functions. All of these functions
* take a count of the number of handlers and then function pointers for each
* of those handlers. These functions are not thread-safe; they set global
* variables.
*/
extern void message_handlers_debug(int count, ...);
extern void message_handlers_notice(int count, ...);
extern void message_handlers_warn(int count, ...);
extern void message_handlers_die(int count, ...);
/*
* Some useful handlers, intended to be passed to message_handlers_*. All
* handlers take the length of the formatted message, the format, a variadic
* argument list, and the errno setting if any.
*/
extern void message_log_stdout(int, const char *, va_list, int);
extern void message_log_stderr(int, const char *, va_list, int);
extern void message_log_syslog_debug(int, const char *, va_list, int);
extern void message_log_syslog_info(int, const char *, va_list, int);
extern void message_log_syslog_notice(int, const char *, va_list, int);
extern void message_log_syslog_warning(int, const char *, va_list, int);
extern void message_log_syslog_err(int, const char *, va_list, int);
extern void message_log_syslog_crit(int, const char *, va_list, int);
/* The type of a message handler. */
typedef void (*message_handler_func)(int, const char *, va_list, int);
/* If non-NULL, called before exit and its return value passed to exit. */
extern int (*message_fatal_cleanup)(void);
/*
* If non-NULL, prepended (followed by ": ") to all messages printed by either
* message_log_stdout or message_log_stderr.
*/
extern const char *message_program_name;
/*
* The functions are actually macros so that we can pick up the file and line
* number information for debugging error messages without the user having to
* pass those in every time.
*/
#define xcalloc(n, size) x_calloc((n), (size), __FILE__, __LINE__)
#define xmalloc(size) x_malloc((size), __FILE__, __LINE__)
#define xrealloc(p, size) x_realloc((p), (size), __FILE__, __LINE__)
#define xstrdup(p) x_strdup((p), __FILE__, __LINE__)
#define xstrndup(p, size) x_strndup((p), (size), __FILE__, __LINE__)
#define xvasprintf(p, f, a) x_vasprintf((p), (f), (a), __FILE__, __LINE__)
/*
* asprintf is a special case since it takes variable arguments. If we have
* support for variadic macros, we can still pass in the file and line and
* just need to put them somewhere else in the argument list than last.
* Otherwise, just call x_asprintf directly. This means that the number of
* arguments x_asprintf takes must vary depending on whether variadic macros
* are supported.
*/
#ifdef HAVE_C99_VAMACROS
# define xasprintf(p, f, ...) \
x_asprintf((p), __FILE__, __LINE__, (f), __VA_ARGS__)
#elif HAVE_GNU_VAMACROS
# define xasprintf(p, f, args...) \
x_asprintf((p), __FILE__, __LINE__, (f), args)
#else
# define xasprintf x_asprintf
#endif
/*
* Last two arguments are always file and line number. These are internal
* implementations that should not be called directly.
*/
extern void *x_calloc(size_t, size_t, const char *, int);
extern void *x_malloc(size_t, const char *, int);
extern void *x_realloc(void *, size_t, const char *, int);
extern char *x_strdup(const char *, const char *, int);
extern char *x_strndup(const char *, size_t, const char *, int);
extern int x_vasprintf(char **, const char *, va_list, const char *, int);
/* asprintf special case. */
#if HAVE_C99_VAMACROS || HAVE_GNU_VAMACROS
extern int x_asprintf(char **, const char *, int, const char *, ...);
#else
extern int x_asprintf(char **, const char *, ...);
#endif
/* Failure handler takes the function, the size, the file, and the line. */
typedef void (*xmalloc_handler_type)(const char *, size_t, const char *, int);
/* The default error handler. */
void xmalloc_fail(const char *, size_t, const char *, int);
/*
* Assign to this variable to choose a handler other than the default, which
* just calls sysdie.
*/
extern xmalloc_handler_type xmalloc_error_handler;
END_DECLS
#endif /* UTIL_UTIL_H */
|
