From 3969cb2a85d798cd029043566d97aad66dcee8e5 Mon Sep 17 00:00:00 2001 From: Mike Frysinger Date: Sat, 5 May 2012 20:25:53 -0400 Subject: split out librc-independent helpers into a dedicated header file Many of these helpers are not special to librc, so split them out so they can be used in all source trees (including libeinfo). Signed-off-by: Mike Frysinger --- src/includes/helpers.h | 137 ++++++++++++++++++++++++++++++++++++++++++++++++ src/includes/rc-misc.h | 105 +------------------------------------ src/libeinfo/libeinfo.c | 22 +------- src/test/runtests.sh | 2 +- 4 files changed, 141 insertions(+), 125 deletions(-) create mode 100644 src/includes/helpers.h diff --git a/src/includes/helpers.h b/src/includes/helpers.h new file mode 100644 index 00000000..39b192a3 --- /dev/null +++ b/src/includes/helpers.h @@ -0,0 +1,137 @@ +/* + helpers.h + This is private to us and not for user consumption +*/ + +/* + * Copyright (c) 2007-2009 Roy Marples + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +#ifndef __HELPERS_H__ +#define __HELPERS_H__ + +#define ERRX fprintf (stderr, "out of memory\n"); exit (1) + +#define UNCONST(a) ((void *)(unsigned long)(const void *)(a)) + +#ifdef lint +# define _unused +#endif +#if __GNUC__ > 2 || defined(__INTEL_COMPILER) +# define _dead __attribute__((__noreturn__)) +# define _unused __attribute__((__unused__)) +#else +# define _dead +# define _unused +#endif + +/* Some libc implemntations don't have these */ +#ifndef TAILQ_CONCAT +#define TAILQ_CONCAT(head1, head2, field) do { \ + if (!TAILQ_EMPTY(head2)) { \ + *(head1)->tqh_last = (head2)->tqh_first; \ + (head2)->tqh_first->field.tqe_prev = (head1)->tqh_last; \ + (head1)->tqh_last = (head2)->tqh_last; \ + TAILQ_INIT((head2)); \ + } \ + } while (0) +#endif + +#ifndef TAILQ_FOREACH_SAFE +#define TAILQ_FOREACH_SAFE(var, head, field, tvar) \ + for ((var) = TAILQ_FIRST((head)); \ + (var) && ((tvar) = TAILQ_NEXT((var), field), 1); \ + (var) = (tvar)) +#endif + +#ifdef __GLIBC__ +# if ! defined (__UCLIBC__) && ! defined (__dietlibc__) +# define strlcpy(dst, src, size) snprintf(dst, size, "%s", src) +# endif +#endif + +#ifndef timespecsub +#define timespecsub(tsp, usp, vsp) \ + do { \ + (vsp)->tv_sec = (tsp)->tv_sec - (usp)->tv_sec; \ + (vsp)->tv_nsec = (tsp)->tv_nsec - (usp)->tv_nsec; \ + if ((vsp)->tv_nsec < 0) { \ + (vsp)->tv_sec--; \ + (vsp)->tv_nsec += 1000000000L; \ + } \ + } while (/* CONSTCOND */ 0) +#endif + +_unused static void *xmalloc (size_t size) +{ + void *value = malloc(size); + + if (value) + return (value); + + ERRX; + /* NOTREACHED */ +} + +_unused static void *xrealloc(void *ptr, size_t size) +{ + void *value = realloc(ptr, size); + + if (value) + return (value); + + ERRX; + /* NOTREACHED */ +} + +_unused static char *xstrdup(const char *str) +{ + char *value; + + if (! str) + return (NULL); + + value = strdup(str); + + if (value) + return (value); + + ERRX; + /* NOTREACHED */ +} + +#undef ERRX + +/* basename_c never modifies the argument. As such, if there is a trailing + * slash then an empty string is returned. */ +_unused static const char *basename_c(const char *path) +{ + const char *slash = strrchr(path, '/'); + + if (slash) + return (++slash); + return (path); +} + +#endif diff --git a/src/includes/rc-misc.h b/src/includes/rc-misc.h index 18ed5b9f..3cce8d02 100644 --- a/src/includes/rc-misc.h +++ b/src/includes/rc-misc.h @@ -38,6 +38,8 @@ #include #include +#include "helpers.h" + #define RC_LEVEL_BOOT "boot" #define RC_LEVEL_DEFAULT "default" @@ -52,98 +54,6 @@ #define RC_SVCDIR_STARTED RC_SVCDIR "/started" #define RC_SVCDIR_COLDPLUGGED RC_SVCDIR "/coldplugged" -#define ERRX fprintf (stderr, "out of memory\n"); exit (1) - -#define UNCONST(a) ((void *)(unsigned long)(const void *)(a)) - -#ifdef lint -# define _unused -#endif -#if __GNUC__ > 2 || defined(__INTEL_COMPILER) -# define _dead __attribute__((__noreturn__)) -# define _unused __attribute__((__unused__)) -#else -# define _dead -# define _unused -#endif - -/* Some libc implemntations don't have these */ -#ifndef TAILQ_CONCAT -#define TAILQ_CONCAT(head1, head2, field) do { \ - if (!TAILQ_EMPTY(head2)) { \ - *(head1)->tqh_last = (head2)->tqh_first; \ - (head2)->tqh_first->field.tqe_prev = (head1)->tqh_last; \ - (head1)->tqh_last = (head2)->tqh_last; \ - TAILQ_INIT((head2)); \ - } \ - } while (0) -#endif - -#ifndef TAILQ_FOREACH_SAFE -#define TAILQ_FOREACH_SAFE(var, head, field, tvar) \ - for ((var) = TAILQ_FIRST((head)); \ - (var) && ((tvar) = TAILQ_NEXT((var), field), 1); \ - (var) = (tvar)) -#endif - -#ifdef __GLIBC__ -# if ! defined (__UCLIBC__) && ! defined (__dietlibc__) -# define strlcpy(dst, src, size) snprintf(dst, size, "%s", src) -# endif -#endif - -#ifndef timespecsub -#define timespecsub(tsp, usp, vsp) \ - do { \ - (vsp)->tv_sec = (tsp)->tv_sec - (usp)->tv_sec; \ - (vsp)->tv_nsec = (tsp)->tv_nsec - (usp)->tv_nsec; \ - if ((vsp)->tv_nsec < 0) { \ - (vsp)->tv_sec--; \ - (vsp)->tv_nsec += 1000000000L; \ - } \ - } while (/* CONSTCOND */ 0) -#endif - -_unused static void *xmalloc (size_t size) -{ - void *value = malloc(size); - - if (value) - return (value); - - ERRX; - /* NOTREACHED */ -} - -_unused static void *xrealloc(void *ptr, size_t size) -{ - void *value = realloc(ptr, size); - - if (value) - return (value); - - ERRX; - /* NOTREACHED */ -} - -_unused static char *xstrdup(const char *str) -{ - char *value; - - if (! str) - return (NULL); - - value = strdup(str); - - if (value) - return (value); - - ERRX; - /* NOTREACHED */ -} - -#undef ERRX - _unused static bool exists(const char *pathname) { struct stat buf; @@ -176,16 +86,5 @@ int is_writable(const char *); #define service_start(service) exec_service(service, "start"); #define service_stop(service) exec_service(service, "stop"); -/* basename_c never modifies the argument. As such, if there is a trailing - * slash then an empty string is returned. */ -_unused static const char *basename_c(const char *path) -{ - const char *slash = strrchr(path, '/'); - - if (slash) - return (++slash); - return (path); -} - int parse_mode(mode_t *, char *); #endif diff --git a/src/libeinfo/libeinfo.c b/src/libeinfo/libeinfo.c index 44d4c90f..eb331930 100644 --- a/src/libeinfo/libeinfo.c +++ b/src/libeinfo/libeinfo.c @@ -51,6 +51,7 @@ const char libeinfo_copyright[] = "Copyright (c) 2007-2008 Roy Marples"; #include #include "einfo.h" +#include "helpers.h" #include "hidden-visibility.h" hidden_proto(ecolor) @@ -225,27 +226,6 @@ strlcat(char *dst, const char *src, size_t size) return dst_n + (s - src); } - -static size_t -strlcpy(char *dst, const char *src, size_t size) -{ - const char *s = src; - size_t n = size; - - if (n && --n) - do { - if (!(*dst++ = *src++)) - break; - } while (--n); - - if (!n) { - if (size) - *dst = '\0'; - while (*src++); - } - - return src - s - 1; -} # endif #endif diff --git a/src/test/runtests.sh b/src/test/runtests.sh index a4b3f189..5a87c847 100755 --- a/src/test/runtests.sh +++ b/src/test/runtests.sh @@ -93,7 +93,7 @@ ebegin "Checking for x* func usage" out=$(cd ${top_srcdir}; find src -name '*.[ch]' \ -exec grep -n -E '\<(malloc|strdup)[[:space:]]*\(' {} + \ | grep -v \ - -e src/includes/rc-misc.h \ + -e src/includes/helpers.h \ -e src/libeinfo/libeinfo.c) [ -z "${out}" ] eend $? "These need to be using the x* variant:"$'\n'"${out}" -- cgit v1.2.3