1 /******************************************************************************/
2 /* pfixtools: a collection of postfix related tools */
4 /* ________________________________________________________________________ */
6 /* Redistribution and use in source and binary forms, with or without */
7 /* modification, are permitted provided that the following conditions */
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 */
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 /******************************************************************************/
33 * Copyright © 2007 Pierre Habouzit
34 * Copyright © 2008 Florent Bruneau
37 #ifndef PFIXTOOLS_COMMON_H
38 #define PFIXTOOLS_COMMON_H
43 #include <netinet/in.h>
52 #include <sys/socket.h>
54 #include <sys/types.h>
61 #define STR(x) __tostr(x)
63 typedef int (*initcall_t)(void);
64 typedef void (*exitcall_t)(void);
66 #define __init __attribute__((__used__,__section__("MAD_INIT,__text,regular")))
67 #define __exit __attribute__((__used__,__section__("MAD_EXIT,__text,regular")))
69 #define module_init(fn) static __init initcall_t __init_##fn = fn;
70 #define module_exit(fn) static __exit exitcall_t __exit_##fn = fn;
72 #define likely(expr) __builtin_expect((expr) != 0, 1)
73 #define unlikely(expr) __builtin_expect((expr) != 0, 0)
75 #define __level_name(L) \
76 ( (L) == LOG_DEBUG ? "debug " \
77 : (L) == LOG_NOTICE ? "notice" \
78 : (L) == LOG_INFO ? "info " \
79 : (L) == LOG_WARNING ? "warn " \
80 : (L) == LOG_ERR ? "error " \
81 : (L) == LOG_CRIT ? "crit " \
82 : (L) == LOG_ALERT ? "alert " \
85 #define __log(Level, Fmt, ...) \
86 if (log_level >= Level) { \
88 syslog(Level, Fmt, ##__VA_ARGS__); \
90 fprintf(stderr, "[%s] " Fmt "\n", \
91 __level_name(Level), ##__VA_ARGS__); \
95 #define debug(Fmt, ...) __log(LOG_DEBUG, Fmt, ##__VA_ARGS__)
96 #define notice(Fmt, ...) __log(LOG_NOTICE, Fmt, ##__VA_ARGS__)
97 #define info(Fmt, ...) __log(LOG_INFO, Fmt, ##__VA_ARGS__)
98 #define warn(Fmt, ...) __log(LOG_WARNING, Fmt, ##__VA_ARGS__)
99 #define err(Fmt, ...) __log(LOG_ERR, Fmt, ##__VA_ARGS__)
100 #define crit(Fmt, ...) __log(LOG_CRIT, Fmt, ##__VA_ARGS__)
101 #define alert(Fmt, ...) __log(LOG_ALERT, Fmt, ##__VA_ARGS__)
102 #define emerg(Fmt, ...) __log(LOG_ALERT, Fmt, ##__VA_ARGS__)
104 #define UNIXERR(fun) err("%s:%d:%s %s: %m", \
105 __FILE__, __LINE__, __func__, fun)
107 extern int log_level;
108 extern bool log_syslog;
110 void common_sighandler(int sig);
112 int setnonblock(int sock);
113 int tcp_bind(const struct sockaddr *addr, socklen_t len);
114 int tcp_listen(const struct sockaddr *addr, socklen_t len);
115 int tcp_listen_nonblock(const struct sockaddr *addr, socklen_t len);
116 int accept_nonblock(int fd);
117 int xwrite(int fd, const char *s, size_t l);
119 int daemon_detach(void);
120 int drop_privileges(const char *user, const char *group);
122 int pidfile_open(const char *name);
123 int pidfile_refresh(void);
125 int common_setup(const char* pidfile, bool unsafe, const char* runas_user,
126 const char* runas_group, bool daemonize);
128 static inline void common_startup(void)
130 signal(SIGPIPE, SIG_IGN);
131 signal(SIGSEGV, &common_sighandler);
135 #define DECLARE_MAIN \
136 static int main_initialize(void) \
139 openlog(DAEMON_NAME, LOG_PID, LOG_MAIL); \
144 static void main_shutdown(void) \
149 module_init(main_initialize); \
150 module_exit(main_shutdown);