start-stop-daemon.c File Reference

#include "gw-config.h"
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
#include <signal.h>
#include <sys/stat.h>
#include <dirent.h>
#include <unistd.h>
#include <pwd.h>
#include <grp.h>
#include <sys/ioctl.h>
#include <sys/types.h>
#include <sys/termios.h>
#include <fcntl.h>

Go to the source code of this file.

Data Structures
struct	pid_list
struct	sigpair

Macros
#define	_STRUCTURED_PROC   1

Functions
static void *	xmalloc (int size)
static void	push (struct pid_list **list, int pid)
static void	do_help (void)
static void	parse_options (int argc, char *const *argv)
static void	check (int pid)
static void	do_pidfile (const char *name)
static int	do_stop (void)
static void	fatal (const char *format,...)
static void	badusage (const char *msg)
static int	parse_signal (const char *signal_str, int *signal_nr)
int	main (int argc, char **argv)

Variables
static int	testmode = 0
static int	quietmode = 0
static int	exitnodo = 1
static int	start = 0
static int	stop = 0
static int	background = 0
static int	mpidfile = 0
static int	signal_nr = 15
static const char *	signal_str = NULL
static int	user_id = -1
static int	runas_uid = -1
static int	runas_gid = -1
static const char *	userspec = NULL
static char *	changeuser = NULL
static char *	changegroup = NULL
static char *	changeroot = NULL
static const char *	cmdname = NULL
static char *	execname = NULL
static char *	startas = NULL
static const char *	pidfile = NULL
static const char *	progname = ""
static struct stat	exec_stat
static struct pid_list *	found = NULL
static struct pid_list *	killed = NULL
static const struct sigpair	siglist []
static int	sigcount = sizeof (siglist) / sizeof (siglist[0])

Macro Definition Documentation

_STRUCTURED_PROC

#define _STRUCTURED_PROC   1

Definition at line 126 of file start-stop-daemon.c.

Function Documentation

badusage()

static void badusage ( const char *  msg )

static

Definition at line 314 of file start-stop-daemon.c.

References msg, and progname.

Referenced by parse_options().

{
    if (msg)
        fprintf(stderr, "%s: %s\n", progname, msg);

    #ifndef SunOS
    fprintf(stderr, "Try `%s --help' for more information.\n", progname);
    #else
    fprintf(stderr, "Try `%s -H' for more information.\n", progname);
    #endif

    exit(2);
}

check()

static void check ( int  pid )

static

Definition at line 668 of file start-stop-daemon.c.

References cmdname, exec_stat, execname, found, push(), user_id, and userspec.

Referenced by do_pidfile().

{
#if defined(OSLinux)
    if (execname && !pid_is_exec(pid, &exec_stat))
        return;
#elif defined(OSHURD)
    /* I will try this to see if it works */
    if (execname && !pid_is_cmd(pid, execname))
        return;
#endif
    if (userspec && !pid_is_user(pid, user_id))
        return;
    if (cmdname && !pid_is_cmd(pid, cmdname))
        return;
    push(&found, pid);
}

do_help()

static void do_help ( void  )

static

Definition at line 244 of file start-stop-daemon.c.

Referenced by parse_options().

{

/*Print the help for systems that have getopt long*/

#ifndef SunOS     /*Solaris doesn't*/

    printf("\
start-stop-daemon for Debian GNU/Linux - small and fast C version written by\n\
Marek Michalkiewicz <marekm@i17linuxb.ists.pwr.wroc.pl>, public domain.\n"
GW_VERSION "\n\
\n\
Usage:\n\
  start-stop-daemon -S|--start options ... -- arguments ...\n\
  start-stop-daemon -K|--stop options ...\n\
  start-stop-daemon -H|--help\n\
  start-stop-daemon -V|--version\n\
\n\
Options (at least one of --exec|--pidfile|--user is required):\n\
  -x|--exec <executable>        program to start/check if it is running\n\
  -p|--pidfile <pid-file>       pid file to check\n\
  -c|--chuid <name|uid[:group|gid]>\n\
        change to this user/group before starting process\n\
  -u|--user <username>|<uid>    stop processes owned by this user\n\
  -n|--name <process-name>      stop processes with this name\n\
  -s|--signal <signal>          signal to send (default TERM)\n\
  -a|--startas <pathname>       program to start (default is <executable>)\n\
  -b|--background               force the process to detach\n\
  -m|--make-pidfile             create the pidfile before starting\n\
  -t|--test                     test mode, don't do anything\n\
  -o|--oknodo                   exit status 0 (not 1) if nothing done\n\
  -q|--quiet                    be more quiet\n\
  -v|--verbose                  be more verbose\n\
\n\
Exit status:  0 = done  1 = nothing done (=> 0 if --oknodo)  2 = trouble\n");

#else /* Deal with systems that don't have getopt long, like Solaris*/

    printf("\
start-stop-daemon for Debian GNU/Linux - small and fast C version written by\n\
Marek Michalkiewicz <marekm@i17linuxb.ists.pwr.wroc.pl>, public domain.\n"
GW_VERSION "\n\
\n\
Usage:\n\
  start-stop-daemon -S options ... -- arguments ...\n\
  start-stop-daemon -K options ...\n\
  start-stop-daemon -H\n\
  start-stop-daemon -V\n\
\n\
Options (at least one of --exec|--pidfile|--user is required):\n\
  -x <executable>               program to start/check if it is running\n\
  -p <pid-file>                 pid file to check\n\
  -c <name|uid[:group|gid]>     change to this user/group before starting process\n\
  -u <username>|<uid>           stop processes owned by this user\n\
  -n <process-name>             stop processes with this name\n\
  -s <signal>                   signal to send (default TERM)\n\
  -a <pathname>                 program to start (default is <executable>)\n\
  -b                            force the process to detach\n\
  -m                            create the pidfile before starting\n\
  -t                            test mode, don't do anything\n\
  -o                            exit status 0 (not 1) if nothing done\n\
  -q                            be more quiet\n\
  -v                            be more verbose\n\
\n\
Exit status:  0 = done  1 = nothing done (=> 0 if -o)  2 = trouble\n");
#endif   /*No more OS ( getopt ) specific stuff this function... */
}

do_pidfile()

static void do_pidfile ( const char *  name )

static

Definition at line 687 of file start-stop-daemon.c.

References check(), and name.

Referenced by main().

{
    FILE *f;
    int pid;

    f = fopen(name, "r");
    if (f) {
        if (fscanf(f, "%d", &pid) == 1)
            check(pid);
        fclose(f);
    }
}

do_stop()

static int do_stop ( void  )

static

Definition at line 761 of file start-stop-daemon.c.

References cmdname, execname, exitnodo, fatal(), found, killed, pid_list::next, pid_list::pid, pidfile, progname, push(), quietmode, signal_nr, testmode, and userspec.

Referenced by main().

{
    char what[1024];
    struct pid_list *p;
    int retval = 0;

    if (cmdname)
        strcpy(what, cmdname);
    else if (execname)
        strcpy(what, execname);
    else if (pidfile)
        sprintf(what, "process in pidfile `%s'", pidfile);
    else if (userspec)
        sprintf(what, "process(es) owned by `%s'", userspec);
    else
        fatal("internal error, please report");

    if (!found) {
        if (quietmode <= 0)
            printf("No %s found running; none killed.\n", what);
        exit(exitnodo);
    }
    for (p = found; p; p = p->next) {
        if (testmode)
            printf("Would send signal %d to %d.\n",
                   signal_nr, p->pid);
        else if (kill(p->pid, signal_nr) == 0)
            push(&killed, p->pid);
        else {
            printf("%s: warning: failed to kill %d: %s\n",
                   progname, p->pid, strerror(errno));
            retval += exitnodo;
        }
    }
    if (quietmode < 0 && killed) {
        printf("Stopped %s (pid", what);
        for (p = killed; p; p = p->next)
            printf(" %d", p->pid);
        printf(").\n");
    }
    return retval;
}

fatal()

static void fatal ( const char *  format,   ...  )

static

Definition at line 206 of file start-stop-daemon.c.

References progname.

Referenced by do_stop(), main(), and xmalloc().

{
    va_list arglist;

    fprintf(stderr, "%s: ", progname);
    va_start(arglist, format);
    vfprintf(stderr, format, arglist);
    va_end(arglist);
    putc('\n', stderr);
    exit(2);
}

main()

int main	(	int	argc,
		char **	argv
	)

Definition at line 806 of file start-stop-daemon.c.

References background, changegroup, changeroot, changeuser, do_pidfile(), do_stop(), exec_stat, execname, exitnodo, fatal(), found, mpidfile, optind, parse_options(), pidfile, progname, quietmode, runas_gid, runas_uid, startas, stop, testmode, user_id, and userspec.

{
    progname = argv[0];

    parse_options(argc, argv);
    argc -= optind;
    argv += optind;

    if (execname && stat(execname, &exec_stat))
        fatal("stat %s: %s", execname, strerror(errno));

    if (userspec && sscanf(userspec, "%d", &user_id) != 1) {
        struct passwd *pw;

        pw = getpwnam(userspec);
        if (!pw)
            fatal("user `%s' not found\n", userspec);

        user_id = pw->pw_uid;
    }
    
    if (changegroup && sscanf(changegroup, "%d", &runas_gid) != 1) {
        struct group *gr = getgrnam(changegroup);
        if (!gr)
            fatal("group `%s' not found\n", changegroup);
        runas_gid = gr->gr_gid;
    }
    if (changeuser && sscanf(changeuser, "%d", &runas_uid) != 1) {
        struct passwd *pw = getpwnam(changeuser);
        if (!pw)
            fatal("user `%s' not found\n", changeuser);
        runas_uid = pw->pw_uid;
        if (changegroup == NULL) { /* pass the default group of this user */
            changegroup = ""; /* just empty */
            runas_gid = pw->pw_gid;
        }
    }

    if (pidfile)
        do_pidfile(pidfile);
    else
        do_procinit();

    if (stop) {
        int i = do_stop();
        if (i) {
            if (quietmode <= 0)
                printf("%d pids were not killed\n", i);
            exit(1);
        }
        exit(0);
    }

    if (found) {
        if (quietmode <= 0)
            printf("%s already running.\n", execname);
        exit(exitnodo);
    }
    if (testmode) {
        printf("Would start %s ", startas);
        while (argc-- > 0)
            printf("%s ", *argv++);
        if (changeuser != NULL) {
            printf(" (as user %s[%d]", changeuser, runas_uid);
            if (changegroup != NULL)
                printf(", and group %s[%d])", changegroup, runas_gid);
            else
                printf(")");
        }
        if (changeroot != NULL)
            printf(" in directory %s", changeroot);
        printf(".\n");
        exit(0);
    }
    if (quietmode < 0)
        printf("Starting %s...\n", startas);
    *--argv = startas;
    if (changeroot != NULL) {
        if (chdir(changeroot) < 0)
            fatal("Unable to chdir() to %s", changeroot);
        if (chroot(changeroot) < 0)
            fatal("Unable to chroot() to %s", changeroot);
    }
    if (changeuser != NULL) {
        if (setgid(runas_gid))
            fatal("Unable to set gid to %d", runas_gid);
        if (initgroups(changeuser, runas_gid))
            fatal("Unable to set initgroups() with gid %d", runas_gid);
        if (setuid(runas_uid))
            fatal("Unable to set uid to %s", changeuser);
    }
    
    if (background) { /* ok, we need to detach this process */
        int i, fd;
        if (quietmode < 0)
            printf("Detatching to start %s...", startas);
        i = fork();
        if (i<0) {
            fatal("Unable to fork.\n");
        }
        if (i) { /* parent */
            if (quietmode < 0)
                printf("done.\n");
            exit(0);
        }
         /* child continues here */
         /* now close all extra fds */
        for (i=getdtablesize()-1; i>=0; --i) close(i);
         /* change tty */
        fd = open("/dev/tty", O_RDWR);
        ioctl(fd, TIOCNOTTY, 0);
        close(fd);
        chdir("/");
        umask(022); /* set a default for dumb programs */
#ifdef DARWIN
                setpgrp();  /* set the process group */
#else
#ifndef FreeBSD
                setpgrp();  /* set the process group */
#else
        setpgrp(0, runas_gid);  /* set the process group */
#endif
#endif

        fd=open("/dev/null", O_RDWR); /* stdin */
        dup(fd); /* stdout */
        dup(fd); /* stderr */
    }
    if (mpidfile && pidfile != NULL) { /* user wants _us_ to make the pidfile :) */
        FILE *pidf = fopen(pidfile, "w");
        pid_t pidt = getpid();
        if (pidf == NULL)
            fatal("Unable to open pidfile `%s' for writing: %s", pidfile,
                strerror(errno));
        fprintf(pidf, "%d\n", (int)pidt);
        fclose(pidf);
    }
    execv(startas, argv);
    fatal("Unable to start %s: %s", startas, strerror(errno));
}

parse_options()

static void parse_options ( int  argc, char *const *  argv  )

static

Definition at line 369 of file start-stop-daemon.c.

References background, badusage(), changegroup, changeroot, changeuser, cmdname, do_help(), execname, exitnodo, getopt(), mpidfile, optarg, option, parse_signal(), pidfile, quietmode, signal_nr, signal_str, start, startas, stop, strdup, testmode, and userspec.

Referenced by main().

{

#if HAVE_GETOPT_LONG
    static struct option longopts[] = {
        { "help",     0, NULL, 'H'},
        { "stop",     0, NULL, 'K'},
        { "start",    0, NULL, 'S'},
        { "version",      0, NULL, 'V'},
        { "startas",      1, NULL, 'a'},
        { "name",     1, NULL, 'n'},
        { "oknodo",   0, NULL, 'o'},
        { "pidfile",      1, NULL, 'p'},
        { "quiet",    0, NULL, 'q'},
        { "signal",   1, NULL, 's'},
        { "test",     0, NULL, 't'},
        { "user",     1, NULL, 'u'},
        { "chroot",   1, NULL, 'r'},
        { "verbose",      0, NULL, 'v'},
        { "exec",     1, NULL, 'x'},
        { "chuid",    1, NULL, 'c'},
        { "background",   0, NULL, 'b'},
        { "make-pidfile", 0, NULL, 'm'},
        { NULL,     0, NULL, 0}
    };
#endif
    int c;

    for (;;) {
#if HAVE_GETOPT_LONG
        c = getopt_long(argc, argv, "HKSVa:n:op:qr:s:tu:vx:c:bm",
                longopts, (int *) 0);
#else
        c = getopt(argc, argv, "HKSVa:n:op:qr:s:tu:vx:c:bm");
#endif
        if (c == -1)
            break;
        switch (c) {
        case 'H':  /* --help */
            do_help();
            exit(0);
        case 'K':  /* --stop */
            stop = 1;
            break;
        case 'S':  /* --start */
            start = 1;
            break;
        case 'V':  /* --version */
            printf("start-stop-daemon " GW_VERSION "\n");
            exit(0);
        case 'a':  /* --startas <pathname> */
            startas = optarg;
            break;
        case 'n':  /* --name <process-name> */
            cmdname = optarg;
            break;
        case 'o':  /* --oknodo */
            exitnodo = 0;
            break;
        case 'p':  /* --pidfile <pid-file> */
            pidfile = optarg;
            break;
        case 'q':  /* --quiet */
            quietmode = 1;
            break;
        case 's':  /* --signal <signal> */
            signal_str = optarg;
            break;
        case 't':  /* --test */
            testmode = 1;
            break;
        case 'u':  /* --user <username>|<uid> */
            userspec = optarg;
            break;
        case 'v':  /* --verbose */
            quietmode = -1;
            break;
        case 'x':  /* --exec <executable> */
            execname = optarg;
            break;
        case 'c':  /* --chuid <username>|<uid> */
            /* we copy the string just in case we need the
             * argument later. */
            changeuser = strdup(optarg);
            changeuser = strtok(changeuser, ":");
            changegroup = strtok(NULL, ":");
            break;
        case 'r':  /* --chroot /new/root */
            changeroot = optarg;
            break;
        case 'b':  /* --background */
            background = 1;
            break;
        case 'm':  /* --make-pidfile */
            mpidfile = 1;
            break;
        default:
            badusage(NULL);  /* message printed by getopt */
        }
    }

    if (signal_str != NULL) {
        if (sscanf (signal_str, "%d", &signal_nr) != 1) {
            if (parse_signal (signal_str, &signal_nr) != 0) {
                badusage ("--signal takes a numeric argument or name of signal (KILL, INTR, ...)");
            }
        }   
    }

    if (start == stop)
        #ifndef SunOS
        badusage("need one of --start or --stop");
        #else
        badusage("need one of -S (start) or -K (stop)");
        #endif

    if (!execname && !pidfile && !userspec)
        badusage("need at least one of --exec, --pidfile or --user");

    if (!startas)
        startas = execname;

    if (start && !startas)
        badusage("--start needs --exec or --startas");

    if (mpidfile && pidfile == NULL)
        badusage("--make-pidfile is only relevant with --pidfile");

    if (background && !start)
        badusage("--background is only relevant with --start");

}

parse_signal()

static int parse_signal ( const char *  signal_str, int *  signal_nr  )

static

Definition at line 356 of file start-stop-daemon.c.

References name, sigcount, siglist, sigpair::signal, signal_nr, and signal_str.

Referenced by parse_options().

{
    int i;
    for (i = 0; i < sigcount; i++) {
        if (strcmp (signal_str, siglist[i].name) == 0) {
            *signal_nr = siglist[i].signal;
            return 0;
        }
    }
    return -1;
}

push()

static void push ( struct pid_list **  list, int  pid  )

static

Definition at line 232 of file start-stop-daemon.c.

References pid_list::next, pid_list::pid, and xmalloc().

Referenced by check(), and do_stop().

{
    struct pid_list *p;

    p = xmalloc(sizeof(*p));
    p->next = *list;
    p->pid = pid;
    *list = p;
}

xmalloc()

static void * xmalloc ( int  size )

static

Definition at line 220 of file start-stop-daemon.c.

References fatal(), malloc(), and size.

Referenced by push().

{
    void *ptr;

    ptr = malloc(size);
    if (ptr)
        return ptr;
    fatal("malloc(%d) failed", size);
}

Variable Documentation

background

int background = 0

static

Definition at line 144 of file start-stop-daemon.c.

Referenced by main(), and parse_options().

changegroup

char* changegroup = NULL

static

Definition at line 153 of file start-stop-daemon.c.

Referenced by main(), and parse_options().

changeroot

char* changeroot = NULL

static

Definition at line 154 of file start-stop-daemon.c.

Referenced by main(), and parse_options().

changeuser

char* changeuser = NULL

static

Definition at line 152 of file start-stop-daemon.c.

Referenced by main(), and parse_options().

cmdname

const char* cmdname = NULL

static

Definition at line 155 of file start-stop-daemon.c.

Referenced by check(), do_stop(), and parse_options().

exec_stat

struct stat exec_stat

static

Definition at line 161 of file start-stop-daemon.c.

Referenced by check(), and main().

execname

char* execname = NULL

static

Definition at line 156 of file start-stop-daemon.c.

Referenced by check(), do_stop(), main(), and parse_options().

exitnodo

int exitnodo = 1

static

Definition at line 141 of file start-stop-daemon.c.

Referenced by do_stop(), main(), and parse_options().

found

struct pid_list* found = NULL

static

Definition at line 173 of file start-stop-daemon.c.

Referenced by check(), do_stop(), get_msg_filename(), http_get_header_parameter(), http_something_accepted(), log_reopen(), main(), smsbox_req_sendota(), soap_fetch_xml_data(), soap_map_xml_data(), wait_for_ack(), wap_push_ppg_pushuser_search_ip_from_wildcarded_list(), wsp_cap_get_client_sdu(), wsp_cap_get_data(), wsp_cap_get_method_mor(), wsp_cap_get_push_mor(), and wsp_cap_get_server_sdu().

killed

struct pid_list* killed = NULL

static

Definition at line 174 of file start-stop-daemon.c.

Referenced by do_stop().

mpidfile

int mpidfile = 0

static

Definition at line 145 of file start-stop-daemon.c.

Referenced by main(), and parse_options().

pidfile

const char* pidfile = NULL

static

Definition at line 158 of file start-stop-daemon.c.

Referenced by do_stop(), main(), and parse_options().

progname

const char* progname = ""

static

Definition at line 159 of file start-stop-daemon.c.

Referenced by badusage(), do_stop(), fatal(), and main().

quietmode

int quietmode = 0

static

Definition at line 140 of file start-stop-daemon.c.

Referenced by do_stop(), main(), and parse_options().

runas_gid

int runas_gid = -1

static

Definition at line 150 of file start-stop-daemon.c.

Referenced by main().

runas_uid

int runas_uid = -1

static

Definition at line 149 of file start-stop-daemon.c.

Referenced by main().

sigcount

int sigcount = sizeof (siglist) / sizeof (siglist[0])

static

Definition at line 354 of file start-stop-daemon.c.

Referenced by parse_signal().

siglist

const struct sigpair siglist[]

static

Initial value:

= {
    { "ABRT", SIGABRT },
    { "ALRM", SIGALRM },
    { "FPE", SIGFPE },
    { "HUP", SIGHUP },
    { "ILL", SIGILL },
    { "INT", SIGINT },
    { "KILL", SIGKILL },
    { "PIPE", SIGPIPE },
    { "QUIT", SIGQUIT },
    { "SEGV", SIGSEGV },
    { "TERM", SIGTERM },
    { "USR1", SIGUSR1 },
    { "USR2", SIGUSR2 },
    { "CHLD", SIGCHLD },
    { "CONT", SIGCONT },
    { "STOP", SIGSTOP },
    { "TSTP", SIGTSTP },
    { "TTIN", SIGTTIN },
    { "TTOU", SIGTTOU }
}

Definition at line 333 of file start-stop-daemon.c.

Referenced by parse_signal().

signal_nr

int signal_nr = 15

static

Definition at line 146 of file start-stop-daemon.c.

Referenced by do_stop(), parse_options(), and parse_signal().

signal_str

const char* signal_str = NULL

static

Definition at line 147 of file start-stop-daemon.c.

Referenced by parse_options(), and parse_signal().

start

int start = 0

static

Definition at line 142 of file start-stop-daemon.c.

Referenced by at2_scan_for_telnet_escapes(), cid_matches(), compare_octstr_sequence(), eat_string_parm(), get_start_param(), get_variable(), http_header_add_element(), http_header_quoted_string_len(), http_header_split_value(), main(), meta_data_unpack(), mime_multipart_start_elem(), mime_something_to_entity(), normalize_number(), octstr_append_uintvar(), octstr_isnum(), octstr_split_words(), octstr_strip_blanks(), octstr_strip_char(), octstr_strip_crlfs(), octstr_strip_nonalphanums(), pack_parameter(), pack_warning(), parse_cgivars(), parse_options(), parse_st_octet_string(), parse_variable(), pass_field_name(), pass_field_value(), read_messages_from_bearerbox(), smsc2_find(), soap_format_xml(), split_headers(), string_table_sort_list(), wait_for_ack(), and ws_vfprintf().

startas

char* startas = NULL

static

Definition at line 157 of file start-stop-daemon.c.

Referenced by main(), and parse_options().

stop

int stop = 0

static

Definition at line 143 of file start-stop-daemon.c.

Referenced by main(), and parse_options().

testmode

int testmode = 0

static

Definition at line 139 of file start-stop-daemon.c.

Referenced by do_stop(), main(), and parse_options().

user_id

int user_id = -1

static

Definition at line 148 of file start-stop-daemon.c.

Referenced by check(), and main().

userspec

const char* userspec = NULL

static

Definition at line 151 of file start-stop-daemon.c.

Referenced by check(), do_stop(), main(), and parse_options().