libatalk/util/server_child.c

   1 /*
   2  * Copyright (c) 1997 Adrian Sun (asun@zoology.washington.edu)
   3  * All rights reserved. See COPYRIGHT.
   4  *
   5  *
   6  * handle inserting, removing, and freeing of children.
   7  * this does it via a hash table. it incurs some overhead over
   8  * a linear append/remove in total removal and kills, but it makes
   9  * single-entry removals a fast operation. as total removals occur during
  10  * child initialization and kills during server shutdown, this is
  11  * probably a win for a lot of connections and unimportant for a small
  12  * number of connections.
  13  */
  14
  15 #ifdef HAVE_CONFIG_H
  16 #include "config.h"
  17 #endif /* HAVE_CONFIG_H */
  18
  19 #include <stdlib.h>
  20 #include <string.h>
  21 #ifdef HAVE_UNISTD_H
  22 #include <unistd.h>
  23 #endif /* HAVE_UNISTD_H */
  24 #include <signal.h>
  25 #include <errno.h>
  26
  27 /* POSIX.1 sys/wait.h check */
  28 #include <sys/types.h>
  29 #ifdef HAVE_SYS_WAIT_H
  30 #include <sys/wait.h>
  31 #endif /* HAVE_SYS_WAIT_H */
  32 #include <sys/time.h>
  33
  34 #include <atalk/logger.h>
  35 #include <atalk/errchk.h>
  36 #include <atalk/util.h>
  37 #include <atalk/server_child.h>
  38
  39 #ifndef WEXITSTATUS
  40 #define WEXITSTATUS(stat_val) ((unsigned)(stat_val) >> 8)
  41 #endif /* ! WEXITSTATUS */
  42 #ifndef WIFEXITED
  43 #define WIFEXITED(stat_val) (((stat_val) & 255) == 0)
  44 #endif /* ! WIFEXITED */
  45 #ifndef WIFSTOPPED
  46 #define WIFSTOPPED(status) (((status) & 0xff) == 0x7f)
  47 #endif
  48 #ifndef WIFSIGNALED
  49 #define WIFSIGNALED(status) (!WIFSTOPPED(status) && !WIFEXITED(status))
  50 #endif
  51 #ifndef WTERMSIG
  52 #define WTERMSIG(status)      ((status) & 0x7f)
  53 #endif
  54
  55 /* hash/child functions: hash OR's pid */
  56 #define CHILD_HASHSIZE 32
  57 #define HASH(i) ((((i) >> 8) ^ (i)) & (CHILD_HASHSIZE - 1))
  58
  59 typedef struct server_child_fork {
  60     struct server_child_data *table[CHILD_HASHSIZE];
  61     void (*cleanup)(const pid_t);
  62 } server_child_fork;
  63
  64 int parent_or_child; /* 0: parent, 1: child */
  65
  66 static inline void hash_child(struct server_child_data **htable,
  67                               struct server_child_data *child)
  68 {
  69     struct server_child_data **table;
  70
  71     table = &htable[HASH(child->pid)];
  72     if ((child->next = *table) != NULL)
  73         (*table)->prevp = &child->next;
  74     *table = child;
  75     child->prevp = table;
  76 }
  77
  78 static inline void unhash_child(struct server_child_data *child)
  79 {
  80     if (child->prevp) {
  81         if (child->next)
  82             child->next->prevp = child->prevp;
  83         *(child->prevp) = child->next;
  84     }
  85 }
  86
  87 static struct server_child_data *resolve_child(struct server_child_data **table, pid_t pid)
  88 {
  89     struct server_child_data *child;
  90
  91     for (child = table[HASH(pid)]; child; child = child->next) {
  92         if (child->pid == pid)
  93             break;
  94     }
  95
  96     return child;
  97 }
  98
  99 /* initialize server_child structure */
 100 server_child *server_child_alloc(const int connections, const int nforks)
 101 {
 102     server_child *children;
 103
 104     children = (server_child *) calloc(1, sizeof(server_child));
 105     if (!children)
 106         return NULL;
 107
 108     children->nsessions = connections;
 109     children->nforks = nforks;
 110     children->fork = (void *) calloc(nforks, sizeof(server_child_fork));
 111
 112     if (!children->fork) {
 113         free(children);
 114         return NULL;
 115     }
 116
 117     return children;
 118 }
 119
 120 /*!
 121  * add a child
 122  * @return pointer to struct server_child_data on success, NULL on error
 123  */
 124 afp_child_t *server_child_add(server_child *children, int forkid, pid_t pid, uint ipc_fds[2])
 125 {
 126     server_child_fork *fork;
 127     afp_child_t *child = NULL;
 128     sigset_t sig, oldsig;
 129
 130     /* we need to prevent deletions from occuring before we get a
 131      * chance to add the child in. */
 132     sigemptyset(&sig);
 133     sigaddset(&sig, SIGCHLD);
 134     pthread_sigmask(SIG_BLOCK, &sig, &oldsig);
 135
 136     /* it's possible that the child could have already died before the
 137      * pthread_sigmask. we need to check for this. */
 138     if (kill(pid, 0) < 0) {
 139         LOG(log_error, logtype_default, "server_child_add: no such process pid [%d]", pid);
 140         goto exit;
 141     }
 142
 143     fork = (server_child_fork *) children->fork + forkid;
 144
 145     /* if we already have an entry. just return. */
 146     if (child = resolve_child(fork->table, pid))
 147         goto exit;
 148
 149     if ((child = calloc(1, sizeof(afp_child_t))) == NULL)
 150         goto exit;
 151
 152     child->pid = pid;
 153     child->valid = 0;
 154     child->killed = 0;
 155     child->ipc_fds[0] = ipc_fds[0];
 156     child->ipc_fds[1] = ipc_fds[1];
 157
 158     hash_child(fork->table, child);
 159     children->count++;
 160
 161 exit:
 162     pthread_sigmask(SIG_SETMASK, &oldsig, NULL);
 163     return child;
 164 }
 165
 166 /* remove a child and free it */
 167 int server_child_remove(server_child *children, const int forkid, pid_t pid)
 168 {
 169     int fd;
 170     server_child_fork *fork;
 171     struct server_child_data *child;
 172
 173     fork = (server_child_fork *) children->fork + forkid;
 174     if (!(child = resolve_child(fork->table, pid)))
 175         return -1;
 176
 177     unhash_child(child);
 178     if (child->clientid) {
 179         free(child->clientid);
 180         child->clientid = NULL;
 181     }
 182
 183     /* In main:child_handler() we need the fd in order to remove it from the pollfd set */
 184     fd = child->ipc_fds[0];
 185     if (child->ipc_fds[0] != -1) {
 186         close(child->ipc_fds[0]);
 187         child->ipc_fds[0] = -1;
 188     }
 189     if (child->ipc_fds[1] != -1) {
 190         close(child->ipc_fds[1]);
 191         child->ipc_fds[1] = -1;
 192     }
 193
 194     free(child);
 195     children->count--;
 196
 197     if (fork->cleanup)
 198         fork->cleanup(pid);
 199
 200     return fd;
 201 }
 202
 203 /* free everything: by using a hash table, this increases the cost of
 204  * this part over a linked list by the size of the hash table */
 205 void server_child_free(server_child *children)
 206 {
 207     server_child_fork *fork;
 208     struct server_child_data *child, *tmp;
 209     int i, j;
 210
 211     for (i = 0; i < children->nforks; i++) {
 212         fork = (server_child_fork *) children->fork + i;
 213         for (j = 0; j < CHILD_HASHSIZE; j++) {
 214             child = fork->table[j]; /* start at the beginning */
 215             while (child) {
 216                 tmp = child->next;
 217                 if (child->clientid) {
 218                     free(child->clientid);
 219                 }
 220                 free(child);
 221                 child = tmp;
 222             }
 223         }
 224     }
 225     free(children->fork);
 226     free(children);
 227 }
 228
 229 /* send signal to all child processes */
 230 void server_child_kill(server_child *children, int forkid, int sig)
 231 {
 232     server_child_fork *fork;
 233     struct server_child_data *child, *tmp;
 234     int i;
 235
 236     fork = (server_child_fork *) children->fork + forkid;
 237     for (i = 0; i < CHILD_HASHSIZE; i++) {
 238         child = fork->table[i];
 239         while (child) {
 240             tmp = child->next;
 241             kill(child->pid, sig);
 242             child = tmp;
 243         }
 244     }
 245 }
 246
 247 /* send kill to a child processes.
 248  * a plain-old linked list
 249  * FIXME use resolve_child ?
 250  */
 251 static int kill_child(struct server_child_data *child)
 252 {
 253     if (!child->killed) {
 254         kill(child->pid, SIGTERM);
 255         /* we don't wait because there's no guarantee that we can really kill it */
 256         child->killed = 1;
 257         return 1;
 258     } else {
 259         LOG(log_info, logtype_default, "Unresponsive child[%d], sending SIGKILL", child->pid);
 260         kill(child->pid, SIGKILL);
 261     }
 262     return 1;
 263 }
 264
 265 /*!
 266  * Try to find an old session and pass socket
 267  * @returns -1 on error, 0 if no matching session was found, 1 if session was found and socket passed
 268  */
 269 int server_child_transfer_session(server_child *children,
 270                                   int forkid,
 271                                   pid_t pid,
 272                                   uid_t uid,
 273                                   int afp_socket,
 274                                   uint16_t DSI_requestID)
 275 {
 276     EC_INIT;
 277     server_child_fork *fork;
 278     struct server_child_data *child;
 279     int i;
 280
 281     fork = (server_child_fork *) children->fork + forkid;
 282     if ((child = resolve_child(fork->table, pid)) == NULL) {
 283         LOG(log_note, logtype_default, "Reconnect: no child[%u]", pid);
 284         if (kill(pid, 0) == 0) {
 285             LOG(log_note, logtype_default, "Reconnect: terminating old session[%u]", pid);
 286             kill(pid, SIGTERM);
 287             sleep(2);
 288             if (kill(pid, 0) == 0) {
 289                 LOG(log_error, logtype_default, "Reconnect: killing old session[%u]", pid);
 290                 kill(pid, SIGKILL);
 291                 sleep(2);
 292             }
 293         }
 294         return 0;
 295     }
 296
 297     if (!child->valid) {
 298         /* hmm, client 'guess' the pid, rogue? */
 299         LOG(log_error, logtype_default, "Reconnect: invalidated child[%u]", pid);
 300         return 0;
 301     } else if (child->uid != uid) {
 302         LOG(log_error, logtype_default, "Reconnect: child[%u] not the same user", pid);
 303         return 0;
 304     }
 305
 306     LOG(log_note, logtype_default, "Reconnect: transfering session to child[%u]", pid);
 307
 308     if (writet(child->ipc_fds[0], &DSI_requestID, 2, 0, 2) != 2) {
 309         LOG(log_error, logtype_default, "Reconnect: error sending DSI id to child[%u]", pid);
 310         EC_STATUS(-1);
 311         goto EC_CLEANUP;
 312     }
 313     EC_ZERO_LOG(send_fd(child->ipc_fds[0], afp_socket));
 314     EC_ZERO_LOG(kill(pid, SIGURG));
 315
 316     EC_STATUS(1);
 317
 318 EC_CLEANUP:
 319     EC_EXIT;
 320 }
 321
 322
 323 /* see if there is a process for the same mac     */
 324 /* if the times don't match mac has been rebooted */
 325 void server_child_kill_one_by_id(server_child *children, int forkid, pid_t pid,
 326                                  uid_t uid, uint32_t idlen, char *id, uint32_t boottime)
 327 {
 328     server_child_fork *fork;
 329     struct server_child_data *child, *tmp;
 330     int i;
 331
 332     fork = (server_child_fork *)children->fork + forkid;
 333
 334     for (i = 0; i < CHILD_HASHSIZE; i++) {
 335         child = fork->table[i];
 336         while (child) {
 337             tmp = child->next;
 338             if ( child->pid != pid) {
 339                 if (child->idlen == idlen && memcmp(child->clientid, id, idlen) == 0) {
 340                     if ( child->time != boottime ) {
 341                         /* Client rebooted */
 342                         if (uid == child->uid) {
 343                             kill_child(child);
 344                             LOG(log_warning, logtype_default,
 345                                 "Terminated disconnected child[%u], client rebooted.",
 346                                 child->pid);
 347                         } else {
 348                             LOG(log_warning, logtype_default,
 349                                 "Session with different pid[%u]", child->pid);
 350                         }
 351                     } else {
 352                         /* One client with multiple sessions */
 353                         LOG(log_debug, logtype_default,
 354                             "Found another session[%u] for client[%u]", child->pid, pid);
 355                     }
 356                 }
 357             } else {
 358                 /* update childs own slot */
 359                 child->time = boottime;
 360                 if (child->clientid)
 361                     free(child->clientid);
 362                 LOG(log_debug, logtype_default, "Setting client ID for %u", child->pid);
 363                 child->uid = uid;
 364                 child->valid = 1;
 365                 child->idlen = idlen;
 366                 child->clientid = id;
 367             }
 368             child = tmp;
 369         }
 370     }
 371 }
 372
 373 /* for extra cleanup if necessary */
 374 void server_child_setup(server_child *children, const int forkid,
 375                         void (*fcn)(const pid_t))
 376 {
 377     server_child_fork *fork;
 378
 379     fork = (server_child_fork *) children->fork + forkid;
 380     fork->cleanup = fcn;
 381 }
 382
 383
 384 /* ---------------------------
 385  * reset children signals
 386  */
 387 void server_reset_signal(void)
 388 {
 389     struct sigaction    sv;
 390     sigset_t            sigs;
 391     const struct itimerval none = {{0, 0}, {0, 0}};
 392
 393     setitimer(ITIMER_REAL, &none, NULL);
 394     memset(&sv, 0, sizeof(sv));
 395     sv.sa_handler =  SIG_DFL;
 396     sigemptyset( &sv.sa_mask );
 397
 398     sigaction(SIGALRM, &sv, NULL );
 399     sigaction(SIGHUP,  &sv, NULL );
 400     sigaction(SIGTERM, &sv, NULL );
 401     sigaction(SIGUSR1, &sv, NULL );
 402     sigaction(SIGCHLD, &sv, NULL );
 403
 404     sigemptyset(&sigs);
 405     sigaddset(&sigs, SIGALRM);
 406     sigaddset(&sigs, SIGHUP);
 407     sigaddset(&sigs, SIGUSR1);
 408     sigaddset(&sigs, SIGCHLD);
 409     pthread_sigmask(SIG_UNBLOCK, &sigs, NULL);
 410
 411 }