common/common.h

   1 /******************************************************************************/
   2 /*          pfixtools: a collection of postfix related tools                  */
   3 /*          ~~~~~~~~~                                                         */
   4 /*  ________________________________________________________________________  */
   5 /*                                                                            */
   6 /*  Redistribution and use in source and binary forms, with or without        */
   7 /*  modification, are permitted provided that the following conditions        */
   8 /*  are met:                                                                  */
   9 /*                                                                            */
  10 /*  1. Redistributions of source code must retain the above copyright         */
  11 /*     notice, this list of conditions and the following disclaimer.          */
  12 /*  2. Redistributions in binary form must reproduce the above copyright      */
  13 /*     notice, this list of conditions and the following disclaimer in the    */
  14 /*     documentation and/or other materials provided with the distribution.   */
  15 /*  3. The names of its contributors may not be used to endorse or promote    */
  16 /*     products derived from this software without specific prior written     */
  17 /*     permission.                                                            */
  18 /*                                                                            */
  19 /*  THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND   */
  20 /*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE     */
  21 /*  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR        */
  22 /*  PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS    */
  23 /*  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR    */
  24 /*  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF      */
  25 /*  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS  */
  26 /*  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN   */
  27 /*  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)   */
  28 /*  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF    */
  29 /*  THE POSSIBILITY OF SUCH DAMAGE.                                           */
  30 /******************************************************************************/
  31
  32 /*
  33  * Copyright © 2007 Pierre Habouzit
  34  * Copyright © 2008 Florent Bruneau
  35  */
  36
  37 #ifndef PFIXTOOLS_COMMON_H
  38 #define PFIXTOOLS_COMMON_H
  39
  40 #include <errno.h>
  41 #include <fcntl.h>
  42 #include <limits.h>
  43 #include <netinet/in.h>
  44 #include <signal.h>
  45 #include <stdbool.h>
  46 #include <stdbool.h>
  47 #include <stddef.h>
  48 #include <stdint.h>
  49 #include <stdio.h>
  50 #include <stdlib.h>
  51 #include <syslog.h>
  52 #include <sys/socket.h>
  53 #include <sys/stat.h>
  54 #include <sys/types.h>
  55 #include <time.h>
  56 #include <unistd.h>
  57
  58 #include "mem.h"
  59
  60 #define __tostr(x)  #x
  61 #define STR(x)      __tostr(x)
  62
  63 typedef int  (*initcall_t)(void);
  64 typedef void (*exitcall_t)(void);
  65
  66 void common_register_exit(exitcall_t _exit);
  67 void common_init(void);
  68
  69 #define module_init(fn)                                                        \
  70     __attribute__((constructor,used))                                          \
  71     static void __init_wrapper__ ## fn (void) {                                \
  72         common_init();                                                         \
  73         if (fn() != 0) {                                                       \
  74             exit(-1);                                                          \
  75         }                                                                      \
  76     }
  77 #define module_exit(fn)                                                        \
  78     __attribute__((constructor,used))                                          \
  79     static void __exit_wrapper ## fn(void) {                                   \
  80         common_init();                                                         \
  81         common_register_exit(fn);                                              \
  82     }
  83
  84 #define likely(expr)    __builtin_expect((expr) != 0, 1)
  85 #define unlikely(expr)  __builtin_expect((expr) != 0, 0)
  86
  87 #define __level_name(L)                                            \
  88   ( (L) == LOG_DEBUG   ? "debug "                                  \
  89   : (L) == LOG_NOTICE  ? "notice"                                  \
  90   : (L) == LOG_INFO    ? "info  "                                  \
  91   : (L) == LOG_WARNING ? "warn  "                                  \
  92   : (L) == LOG_ERR     ? "error "                                  \
  93   : (L) == LOG_CRIT    ? "crit  "                                  \
  94   : (L) == LOG_ALERT   ? "alert "                                  \
  95   : "???   " )
  96
  97 #define __log(Level, Fmt, ...)                                    \
  98     if (log_level >= Level) {                                     \
  99         if (log_syslog) {                                         \
 100             syslog(Level, Fmt, ##__VA_ARGS__);                    \
 101         } else {                                                  \
 102             fprintf(stderr, "[%s] " Fmt "\n",                     \
 103                     __level_name(Level), ##__VA_ARGS__);          \
 104         }                                                         \
 105     }
 106
 107 #define debug(Fmt, ...)  __log(LOG_DEBUG,   Fmt, ##__VA_ARGS__)
 108 #define notice(Fmt, ...) __log(LOG_NOTICE,  Fmt, ##__VA_ARGS__)
 109 #define info(Fmt, ...)   __log(LOG_INFO,    Fmt, ##__VA_ARGS__)
 110 #define warn(Fmt, ...)   __log(LOG_WARNING, Fmt, ##__VA_ARGS__)
 111 #define err(Fmt, ...)    __log(LOG_ERR,     Fmt, ##__VA_ARGS__)
 112 #define crit(Fmt, ...)   __log(LOG_CRIT,    Fmt, ##__VA_ARGS__)
 113 #define alert(Fmt, ...)  __log(LOG_ALERT,   Fmt, ##__VA_ARGS__)
 114 #define emerg(Fmt, ...)  __log(LOG_ALERT,   Fmt, ##__VA_ARGS__)
 115
 116 #define UNIXERR(fun)     err("%s:%d:%s %s: %m",                      \
 117                              __FILE__, __LINE__, __func__, fun)
 118
 119 extern int          log_level;
 120 extern bool         log_syslog;
 121
 122 void common_sighandler(int sig);
 123
 124 int setnonblock(int sock);
 125 int tcp_bind(const struct sockaddr *addr, socklen_t len);
 126 int tcp_listen(const struct sockaddr *addr, socklen_t len);
 127 int tcp_listen_nonblock(const struct sockaddr *addr, socklen_t len);
 128 int accept_nonblock(int fd);
 129 int xwrite(int fd, const char *s, size_t l);
 130
 131 int daemon_detach(void);
 132 int drop_privileges(const char *user, const char *group);
 133
 134 int pidfile_open(const char *name);
 135 int pidfile_refresh(void);
 136
 137 int common_setup(const char* pidfile, bool unsafe, const char* runas_user,
 138                  const char* runas_group, bool daemonize);
 139
 140 static inline void common_startup(void)
 141 {
 142     signal(SIGPIPE, SIG_IGN);
 143     signal(SIGSEGV, &common_sighandler);
 144 }
 145
 146
 147 #define DECLARE_MAIN                                              \
 148     static int main_initialize(void)                              \
 149     {                                                             \
 150         log_syslog = true;                                        \
 151         openlog(DAEMON_NAME, LOG_PID, LOG_MAIL);                  \
 152         common_startup();                                         \
 153         return 0;                                                 \
 154     }                                                             \
 155                                                                   \
 156     static void main_shutdown(void)                               \
 157     {                                                             \
 158         closelog();                                               \
 159     }                                                             \
 160                                                                   \
 161     module_init(main_initialize);                                 \
 162     module_exit(main_shutdown);
 163
 164 #endif