X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=src%2Fsystemd%2Fsd-daemon.h;h=cd9e30e9ee46767e8fec5be58f7ad2d2768fdca7;hp=43deb8cc7dfadf8b21cd9e717051279b9a5bdc86;hb=HEAD;hpb=09812eb764b440651f3ff4cb5d37bd343f800560 diff --git a/src/systemd/sd-daemon.h b/src/systemd/sd-daemon.h index 43deb8cc7..cd9e30e9e 100644 --- a/src/systemd/sd-daemon.h +++ b/src/systemd/sd-daemon.h @@ -1,46 +1,33 @@ -/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ - #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. + This file is part of systemd. + + Copyright 2013 Lennart Poettering + + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. + + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see . ***/ -#include #include +#include -#ifdef __cplusplus -extern "C" { -#endif +#include "_sd-common.h" -/* - Reference implementation of a few systemd related interfaces for - writing daemons. These interfaces are trivial to implement. To - simplify porting we provide this reference implementation. - Applications are welcome to reimplement the algorithms described - here if they do not want to include these two source files. +_SD_BEGIN_DECLARATIONS; +/* The following functionality is provided: - Support for logging with log levels on stderr @@ -48,33 +35,9 @@ extern "C" { - Daemon startup and status notification - Detection of systemd boots - You may compile this with -DDISABLE_SYSTEMD to disable systemd - support. This makes all those calls NOPs that are directly related to - systemd (i.e. only sd_is_xxx() will stay useful). - - Since this is drop-in code we don't want any of our symbols to be - exported in any case. Hence we declare hidden visibility for all of - them. - - You may find an up-to-date version of these source files online: - - http://cgit.freedesktop.org/systemd/systemd/plain/src/systemd/sd-daemon.h - http://cgit.freedesktop.org/systemd/systemd/plain/src/libsystemd-daemon/sd-daemon.c - - This should compile on non-Linux systems, too, but with the - exception of the sd_is_xxx() calls all functions will become NOPs. - See sd-daemon(3) for more information. */ -#ifndef _sd_printf_attr_ -# if __GNUC__ >= 4 -# define _sd_printf_attr_(a,b) __attribute__ ((format (printf, a, b))) -# else -# define _sd_printf_attr_(a,b) -# endif -#endif - /* Log levels for usage on stderr: @@ -111,6 +74,8 @@ extern "C" { */ int sd_listen_fds(int unset_environment); +int sd_listen_fds_with_names(int unset_environment, char ***names); + /* Helper call for identifying a passed file descriptor. Returns 1 if the file descriptor is a FIFO in the file system stored under the @@ -165,6 +130,20 @@ int sd_is_socket(int fd, int family, int type, int listening); */ int sd_is_socket_inet(int fd, int family, int type, int listening, uint16_t port); +#if 0 /// unsupported by elogind +/* + Helper call for identifying a passed file descriptor. Returns 1 if the + file descriptor is an Internet socket of the specified type + (SOCK_DGRAM, SOCK_STREAM, ...), and if the address of the socket is + the same as the address specified by addr. The listening flag is used + the same way as in sd_is_socket(). Returns a negative errno style + error code on failure. + + See sd_is_socket_sockaddr(3) for more information. +*/ +int sd_is_socket_sockaddr(int fd, int type, const struct sockaddr* addr, unsigned addr_len, int listening); +#endif // 0 + /* Helper call for identifying a passed file descriptor. Returns 1 if the file descriptor is an AF_UNIX socket of the specified type @@ -181,6 +160,7 @@ int sd_is_socket_inet(int fd, int family, int type, int listening, uint16_t port */ int sd_is_socket_unix(int fd, int type, int listening, const char *path, size_t length); +#if 0 /// UNNEEDED by elogind /* Helper call for identifying a passed file descriptor. Returns 1 if the file descriptor is a POSIX Message Queue of the specified name, @@ -190,6 +170,7 @@ int sd_is_socket_unix(int fd, int type, int listening, const char *path, size_t See sd_is_mq(3) for more information. */ int sd_is_mq(int fd, const char *path); +#endif // 0 /* Informs systemd about changed daemon state. This takes a number of @@ -203,7 +184,7 @@ int sd_is_mq(int fd, const char *path); value daemons should send is "READY=1". STATUS=... Passes a single-line status string back to systemd - that describes the daemon state. This is free-from + that describes the daemon state. This is free-form and can be used for various purposes: general state feedback, fsck-like programs could pass completion percentages and failing programs could pass a human @@ -225,6 +206,17 @@ int sd_is_mq(int fd, const char *path); timestamps to detect failed services. Also see sd_watchdog_enabled() below. + FDSTORE=1 Store the file descriptors passed along with the + message in the per-service file descriptor store, + and pass them to the main process again on next + invocation. This variable is only supported with + sd_pid_notify_with_fds(). + + WATCHDOG_USEC=... + Reset watchdog_usec value during runtime. + To reset watchdog_usec value, start the service again. + Example: "WATCHDOG_USEC=20000000" + Daemons can choose to send additional variables. However, it is recommended to prefix variable names not listed above with X_. @@ -263,7 +255,26 @@ int sd_notify(int unset_environment, const char *state); See sd_notifyf(3) for more information. */ -int sd_notifyf(int unset_environment, const char *format, ...) _sd_printf_attr_(2,3); +int sd_notifyf(int unset_environment, const char *format, ...) _sd_printf_(2,3); + +/* + Similar to sd_notify(), but send the message on behalf of another + process, if the appropriate permissions are available. +*/ +int sd_pid_notify(pid_t pid, int unset_environment, const char *state); + +/* + Similar to sd_notifyf(), but send the message on behalf of another + process, if the appropriate permissions are available. +*/ +int sd_pid_notifyf(pid_t pid, int unset_environment, const char *format, ...) _sd_printf_(3,4); + +/* + Similar to sd_pid_notify(), but also passes the specified fd array + to the service manager for storage. This is particularly useful for + FDSTORE=1 messages. +*/ +int sd_pid_notify_with_fds(pid_t pid, int unset_environment, const char *state, const int *fds, unsigned n_fds); /* Returns > 0 if the system was booted with systemd. Returns < 0 on @@ -294,8 +305,6 @@ int sd_booted(void); */ int sd_watchdog_enabled(int unset_environment, uint64_t *usec); -#ifdef __cplusplus -} -#endif +_SD_END_DECLARATIONS; #endif