systemd/src/sd-daemon.h

/*-*- Mode: C; c-basic-offset: 8 -*-*/

#ifndef foosddaemonhfoo
#define foosddaemonhfoo

/***
  Copyright 2010 Lennart Poettering

  Permission is hereby granted, free of charge, to any person
  obtaining a copy of this software and associated documentation files
  (the "Software"), to deal in the Software without restriction,
  including without limitation the rights to use, copy, modify, merge,
  publish, distribute, sublicense, and/or sell copies of the Software,
  and to permit persons to whom the Software is furnished to do so,
  subject to the following conditions:

  The above copyright notice and this permission notice shall be
  included in all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
***/

#include <inttypes.h>

/* Reference implementation of a few systemd related interfaces for
 * writing daemons. These interfaces are trivial to implement, however
 * to simplify porting we provide this reference
 * implementation. Applications are free to reimplement the algorithms
 * described here. */

/*
  Log levels for usage on stderr:

          fprintf(stderr, SD_NOTICE "Hello World!");

  This is similar to printk() usage in the kernel.
*/

#define SD_EMERG   "<0>"  /* system is unusable */
#define SD_ALERT   "<1>"  /* action must be taken immediately */
#define SD_CRIT    "<2>"  /* critical conditions */
#define SD_ERR     "<3>"  /* error conditions */
#define SD_WARNING "<4>"  /* warning conditions */
#define SD_NOTICE  "<5>"  /* normal but significant condition */
#define SD_INFO    "<6>"  /* informational */
#define SD_DEBUG   "<7>"  /* debug-level messages */

/* The first passed file descriptor is fd 3 */
#define SD_LISTEN_FDS_START 3

/* Returns how many file descriptors have been passed, or a negative
 * errno code on failure. Optionally removes the $LISTEN_FDS and
 * $LISTEN_PID file descriptors from the environment
 * (recommended). You'll find the file descriptors passed as fds
 * SD_LISTEN_FDS_START to SD_LISTEN_FDS_START+r-1 if r is the return
 * value of this functioin. Returns a negative errno style error code
 * on failure. */
int sd_listen_fds(int unset_environment);

/* Helper call for identifying a passed file descriptor. Returns 1 if
 * the file descriptor is a FIFO in the file system stored under the
 * specified path, 0 otherwise. If path is NULL a path name check will
 * not be done and the call only verifies if the file descriptor
 * refers to a FIFO. Returns a negative errno style error code on
 * failure. */
int sd_is_fifo(int fd, const char *path);

/* Helper call for identifying a passed file descriptor. Returns 1 if
 * the file descriptor is a socket of the specified type (SOCK_DGRAM,
 * SOCK_STREAM, ...), 0 otherwise. If type is 0 a socket type check
 * will not be done and the call only verifies if the file descriptor
 * refers to a socket. If listening is > 0 it is verified that the
 * socket is in listening mode. (i.e. listen() has been called) If
 * listening is == 0 it is verified that the socket is not in
 * listening mode. If listening is < 0 no listening mode check is
 * done. Returns a negative errno style error code on failure. */
int sd_is_socket(int fd, int type, int listening);

/* Helper call for identifying a passed file descriptor. Returns 1 if
 * the file descriptor is an Internet socket (either AF_INET or
 * AF_INET6) of the specified type (SOCK_DGRAM, SOCK_STREAM, ...), 0
 * otherwise. If type is 0 a socket type check will not be done. If
 * port is 0 a socket port check will not be done. The listening flag
 * is used the same way as in sd_is_socket(). Returns a negative errno
 * style error code on failure. */
int sd_is_socket_inet(int fd, int type, int listening, uint16_t port);

/* Helper call for identifying a passed file descriptor. Returns 1 if
 * the file descriptor is an AF_UNIX socket of the specified type
 * (SOCK_DGRAM, SOCK_STREAM, ...) and path, 0 otherwise. If type is 0
 * a socket type check will not be done. If path is NULL a socket path
 * check will not be done. For normal AF_UNIX sockets set length to
 * 0. For abstract namespace sockets set length to the length of the
 * socket name (including the initial 0 byte), and pass the full
 * socket path in path (including the initial 0 byte). The listening
 * flag is used the same way as in sd_is_socket(). Returns a negative
 * errno style error code on failure. */
int sd_is_socket_unix(int fd, int type, int listening, const char *path, size_t length);

#endif