/* $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 * 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 #include #include #include #include /* 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 */