udevd.c

   1 /*
   2  * udevd.c - hotplug event serializer
   3  *
   4  * Copyright (C) 2004 Kay Sievers <kay.sievers@vrfy.org>
   5  * Copyright (C) 2004 Chris Friesen <chris_friesen@sympatico.ca>
   6  *
   7  *
   8  *      This program is free software; you can redistribute it and/or modify it
   9  *      under the terms of the GNU General Public License as published by the
  10  *      Free Software Foundation version 2 of the License.
  11  *
  12  *      This program is distributed in the hope that it will be useful, but
  13  *      WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  *      General Public License for more details.
  16  *
  17  *      You should have received a copy of the GNU General Public License along
  18  *      with this program; if not, write to the Free Software Foundation, Inc.,
  19  *      675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  */
  22
  23 #include <stddef.h>
  24 #include <sys/wait.h>
  25 #include <signal.h>
  26 #include <unistd.h>
  27 #include <errno.h>
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <sys/time.h>
  32 #include <sys/types.h>
  33 #include <sys/socket.h>
  34 #include <sys/un.h>
  35 #include <fcntl.h>
  36 #include <sys/sysinfo.h>
  37 #include <sys/stat.h>
  38
  39 #include "list.h"
  40 #include "udev.h"
  41 #include "udev_lib.h"
  42 #include "udev_version.h"
  43 #include "udevd.h"
  44 #include "logging.h"
  45
  46 /* global variables*/
  47 static int udevsendsock;
  48
  49 static int pipefds[2];
  50 static unsigned long long expected_seqnum = 0;
  51 static volatile int sigchilds_waiting;
  52 static volatile int run_msg_q;
  53 static volatile int sig_flag;
  54 static int run_exec_q;
  55
  56 static LIST_HEAD(msg_list);
  57 static LIST_HEAD(exec_list);
  58 static LIST_HEAD(running_list);
  59
  60 static void exec_queue_manager(void);
  61 static void msg_queue_manager(void);
  62 static void user_sighandler(void);
  63 static void reap_sigchilds(void);
  64 char *udev_bin;
  65
  66 #ifdef LOG
  67 unsigned char logname[LOGNAME_SIZE];
  68 void log_message (int level, const char *format, ...)
  69 {
  70         va_list args;
  71
  72         va_start(args, format);
  73         vsyslog(level, format, args);
  74         va_end(args);
  75 }
  76 #endif
  77
  78 #define msg_dump(msg) \
  79         dbg("msg_dump: sequence %llu, '%s', '%s', '%s'", \
  80         msg->seqnum, msg->action, msg->devpath, msg->subsystem);
  81
  82 static void msg_dump_queue(void)
  83 {
  84 #ifdef DEBUG
  85         struct hotplug_msg *msg;
  86
  87         list_for_each_entry(msg, &msg_list, list)
  88                 dbg("sequence %llu in queue", msg->seqnum);
  89 #endif
  90 }
  91
  92 static void run_queue_delete(struct hotplug_msg *msg)
  93 {
  94         list_del(&msg->list);
  95         free(msg);
  96 }
  97
  98 /* orders the message in the queue by sequence number */
  99 static void msg_queue_insert(struct hotplug_msg *msg)
 100 {
 101         struct hotplug_msg *loop_msg;
 102         struct sysinfo info;
 103
 104         /* sort message by sequence number into list. events
 105          * will tend to come in order, so scan the list backwards
 106          */
 107         list_for_each_entry_reverse(loop_msg, &msg_list, list)
 108                 if (loop_msg->seqnum < msg->seqnum)
 109                         break;
 110
 111         /* store timestamp of queuing */
 112         sysinfo(&info);
 113         msg->queue_time = info.uptime;
 114
 115         list_add(&msg->list, &loop_msg->list);
 116         dbg("queued message seq %llu", msg->seqnum);
 117
 118         /* run msg queue manager */
 119         run_msg_q = 1;
 120
 121         return ;
 122 }
 123
 124 /* forks event and removes event from run queue when finished */
 125 static void udev_run(struct hotplug_msg *msg)
 126 {
 127         pid_t pid;
 128
 129         pid = fork();
 130         switch (pid) {
 131         case 0:
 132                 /* child */
 133                 close(udevsendsock);
 134                 execle(udev_bin, "udev", msg->subsystem, NULL, msg->envp);
 135                 dbg("exec of child failed");
 136                 _exit(1);
 137                 break;
 138         case -1:
 139                 dbg("fork of child failed");
 140                 run_queue_delete(msg);
 141                 /* note: we never managed to run, so we had no impact on
 142                  * running_with_devpath(), so don't bother setting run_exec_q
 143                  */
 144                 break;
 145         default:
 146                 /* get SIGCHLD in main loop */
 147                 dbg("==> exec seq %llu [%d] working at '%s'", msg->seqnum, pid, msg->devpath);
 148                 msg->pid = pid;
 149         }
 150 }
 151
 152 /* returns already running task with devpath */
 153 static struct hotplug_msg *running_with_devpath(struct hotplug_msg *msg)
 154 {
 155         struct hotplug_msg *loop_msg;
 156         list_for_each_entry(loop_msg, &running_list, list) {
 157                 if (loop_msg->devpath == NULL || msg->devpath == NULL)
 158                         continue;
 159
 160                 if (strcmp(loop_msg->devpath, msg->devpath) == 0)
 161                         return loop_msg;
 162         }
 163
 164         return NULL;
 165 }
 166
 167 /* exec queue management routine executes the events and delays events for the same devpath */
 168 static void exec_queue_manager(void)
 169 {
 170         struct hotplug_msg *loop_msg;
 171         struct hotplug_msg *tmp_msg;
 172         struct hotplug_msg *msg;
 173
 174         list_for_each_entry_safe(loop_msg, tmp_msg, &exec_list, list) {
 175                 msg = running_with_devpath(loop_msg);
 176                 if (!msg) {
 177                         /* move event to run list */
 178                         list_move_tail(&loop_msg->list, &running_list);
 179                         udev_run(loop_msg);
 180                         dbg("moved seq %llu to running list", loop_msg->seqnum);
 181                 } else {
 182                         dbg("delay seq %llu, cause seq %llu already working on '%s'",
 183                                 loop_msg->seqnum, msg->seqnum, msg->devpath);
 184                 }
 185         }
 186 }
 187
 188 static void msg_move_exec(struct hotplug_msg *msg)
 189 {
 190         list_move_tail(&msg->list, &exec_list);
 191         run_exec_q = 1;
 192         expected_seqnum = msg->seqnum+1;
 193         dbg("moved seq %llu to exec, next expected is %llu",
 194                 msg->seqnum, expected_seqnum);
 195 }
 196
 197 /* msg queue management routine handles the timeouts and dispatches the events */
 198 static void msg_queue_manager(void)
 199 {
 200         struct hotplug_msg *loop_msg;
 201         struct hotplug_msg *tmp_msg;
 202         struct sysinfo info;
 203         long msg_age = 0;
 204
 205         dbg("msg queue manager, next expected is %llu", expected_seqnum);
 206 recheck:
 207         list_for_each_entry_safe(loop_msg, tmp_msg, &msg_list, list) {
 208                 /* move event with expected sequence to the exec list */
 209                 if (loop_msg->seqnum == expected_seqnum) {
 210                         msg_move_exec(loop_msg);
 211                         continue;
 212                 }
 213
 214                 /* move event with expired timeout to the exec list */
 215                 sysinfo(&info);
 216                 msg_age = info.uptime - loop_msg->queue_time;
 217                 dbg("seq %llu is %li seconds old", loop_msg->seqnum, msg_age);
 218                 if (msg_age > EVENT_TIMEOUT_SEC-1) {
 219                         msg_move_exec(loop_msg);
 220                         goto recheck;
 221                 } else {
 222                         break;
 223                 }
 224         }
 225
 226         msg_dump_queue();
 227
 228         /* set timeout for remaining queued events */
 229         if (list_empty(&msg_list) == 0) {
 230                 struct itimerval itv = {{0, 0}, {EVENT_TIMEOUT_SEC - msg_age, 0}};
 231                 dbg("next event expires in %li seconds", EVENT_TIMEOUT_SEC - msg_age);
 232                 setitimer(ITIMER_REAL, &itv, NULL);
 233         }
 234 }
 235
 236 /* receive the msg, do some basic sanity checks, and queue it */
 237 static void handle_udevsend_msg(int sock)
 238 {
 239         static struct udevsend_msg usend_msg;
 240         struct hotplug_msg *msg;
 241         int bufpos;
 242         int i;
 243         ssize_t size;
 244         struct msghdr smsg;
 245         struct cmsghdr *cmsg;
 246         struct iovec iov;
 247         struct ucred *cred;
 248         char cred_msg[CMSG_SPACE(sizeof(struct ucred))];
 249         int envbuf_size;
 250
 251         memset(&usend_msg, 0x00, sizeof(struct udevsend_msg));
 252         iov.iov_base = &usend_msg;
 253         iov.iov_len = sizeof(struct udevsend_msg);
 254
 255         memset(&smsg, 0x00, sizeof(struct msghdr));
 256         smsg.msg_iov = &iov;
 257         smsg.msg_iovlen = 1;
 258         smsg.msg_control = cred_msg;
 259         smsg.msg_controllen = sizeof(cred_msg);
 260
 261         size = recvmsg(sock, &smsg, 0);
 262         if (size <  0) {
 263                 if (errno != EINTR)
 264                         dbg("unable to receive message");
 265                 return;
 266         }
 267         cmsg = CMSG_FIRSTHDR(&smsg);
 268         cred = (struct ucred *) CMSG_DATA(cmsg);
 269
 270         if (cmsg == NULL || cmsg->cmsg_type != SCM_CREDENTIALS) {
 271                 dbg("no sender credentials received, message ignored");
 272                 goto exit;
 273         }
 274
 275         if (cred->uid != 0) {
 276                 dbg("sender uid=%i, message ignored", cred->uid);
 277                 goto exit;
 278         }
 279
 280         if (strncmp(usend_msg.magic, UDEV_MAGIC, sizeof(UDEV_MAGIC)) != 0 ) {
 281                 dbg("message magic '%s' doesn't match, ignore it", usend_msg.magic);
 282                 goto exit;
 283         }
 284
 285         envbuf_size = size - offsetof(struct udevsend_msg, envbuf);
 286         dbg("envbuf_size=%i", envbuf_size);
 287         msg = malloc(sizeof(struct hotplug_msg) + envbuf_size);
 288         memset(msg, 0x00, sizeof(struct hotplug_msg) + envbuf_size);
 289
 290         /* copy environment buffer and reconstruct envp */
 291         memcpy(msg->envbuf, usend_msg.envbuf, envbuf_size);
 292         bufpos = 0;
 293         for (i = 0; (bufpos < envbuf_size) && (i < HOTPLUG_NUM_ENVP-1); i++) {
 294                 int keylen;
 295                 char *key;
 296
 297                 key = &msg->envbuf[bufpos];
 298                 keylen = strlen(key);
 299                 msg->envp[i] = key;
 300                 bufpos += keylen + 1;
 301                 dbg("add '%s' to msg.envp[%i]", msg->envp[i], i);
 302
 303                 /* remember some keys for further processing */
 304                 if (strncmp(key, "ACTION=", 7) == 0)
 305                         msg->action = &key[7];
 306
 307                 if (strncmp(key, "DEVPATH=", 8) == 0)
 308                         msg->devpath = &key[8];
 309
 310                 if (strncmp(key, "SUBSYSTEM=", 10) == 0)
 311                         msg->subsystem = &key[10];
 312
 313                 if (strncmp(key, "SEQNUM=", 7) == 0)
 314                         msg->seqnum = strtoull(&key[7], NULL, 10);
 315         }
 316         msg->envp[i] = NULL;
 317
 318         /* if no seqnum is given, we move straight to exec queue */
 319         if (msg->seqnum == 0) {
 320                 list_add(&msg->list, &exec_list);
 321                 run_exec_q = 1;
 322         } else {
 323                 msg_queue_insert(msg);
 324         }
 325
 326 exit:
 327         return;
 328 }
 329
 330 static void asmlinkage sig_handler(int signum)
 331 {
 332         int rc;
 333
 334         switch (signum) {
 335                 case SIGINT:
 336                 case SIGTERM:
 337                         exit(20 + signum);
 338                         break;
 339                 case SIGALRM:
 340                         /* set flag, then write to pipe if needed */
 341                         run_msg_q = 1;
 342                         goto do_write;
 343                         break;
 344                 case SIGCHLD:
 345                         /* set flag, then write to pipe if needed */
 346                         sigchilds_waiting = 1;
 347                         goto do_write;
 348                         break;
 349         }
 350
 351 do_write:
 352         /* if pipe is empty, write to pipe to force select to return
 353          * immediately when it gets called
 354          */
 355         if (!sig_flag) {
 356                 rc = write(pipefds[1],&signum,sizeof(signum));
 357                 if (rc >= 0)
 358                         sig_flag = 1;
 359         }
 360 }
 361
 362 static void udev_done(int pid)
 363 {
 364         /* find msg associated with pid and delete it */
 365         struct hotplug_msg *msg;
 366
 367         list_for_each_entry(msg, &running_list, list) {
 368                 if (msg->pid == pid) {
 369                         dbg("<== exec seq %llu came back", msg->seqnum);
 370                         run_queue_delete(msg);
 371
 372                         /* we want to run the exec queue manager since there may
 373                          * be events waiting with the devpath of the one that
 374                          * just finished
 375                          */
 376                         run_exec_q = 1;
 377                         return;
 378                 }
 379         }
 380 }
 381
 382 static void reap_sigchilds(void)
 383 {
 384         while(1) {
 385                 int pid = waitpid(-1, NULL, WNOHANG);
 386                 if ((pid == -1) || (pid == 0))
 387                         break;
 388                 udev_done(pid);
 389         }
 390 }
 391
 392 /* just read everything from the pipe and clear the flag,
 393  * the flags was set in the signal handler
 394  */
 395 static void user_sighandler(void)
 396 {
 397         int sig;
 398         while(1) {
 399                 int rc = read(pipefds[0], &sig, sizeof(sig));
 400                 if (rc < 0)
 401                         break;
 402
 403                 sig_flag = 0;
 404         }
 405 }
 406
 407 int main(int argc, char *argv[], char *envp[])
 408 {
 409         int maxsockplus;
 410         struct sockaddr_un saddr;
 411         socklen_t addrlen;
 412         int retval, fd;
 413         const int feature_on = 1;
 414         struct sigaction act;
 415         fd_set readfds;
 416
 417         logging_init("udevd");
 418         dbg("version %s", UDEV_VERSION);
 419
 420         if (getuid() != 0) {
 421                 dbg("need to be root, exit");
 422                 _exit(1);
 423         }
 424
 425         /* make sure we don't lock any path */
 426         chdir("/");
 427         umask(umask(077) | 022);
 428
 429         /* Set fds to dev/null */
 430         fd = open( "/dev/null", O_RDWR );
 431         if ( fd < 0 ) {
 432                 dbg("error opening /dev/null %s", strerror(errno));
 433                 exit(1);
 434         }
 435         dup2(fd, 0);
 436         dup2(fd, 1);
 437         dup2(fd, 2);
 438         if (fd > 2)
 439                 close(fd);
 440
 441         /* become session leader */
 442         setsid();
 443
 444         /* setup signal handler pipe */
 445         retval = pipe(pipefds);
 446         if (retval < 0) {
 447                 dbg("error getting pipes: %s", strerror(errno));
 448                 exit(1);
 449         }
 450
 451         retval = fcntl(pipefds[0], F_SETFL, O_NONBLOCK);
 452         if (retval < 0) {
 453                 dbg("error fcntl on read pipe: %s", strerror(errno));
 454                 exit(1);
 455         }
 456         retval = fcntl(pipefds[0], F_SETFD, FD_CLOEXEC);
 457         if (retval < 0) {
 458                 dbg("error fcntl on read pipe: %s", strerror(errno));
 459                 exit(1);
 460         }
 461
 462         retval = fcntl(pipefds[1], F_SETFL, O_NONBLOCK);
 463         if (retval < 0) {
 464                 dbg("error fcntl on write pipe: %s", strerror(errno));
 465                 exit(1);
 466         }
 467         retval = fcntl(pipefds[1], F_SETFD, FD_CLOEXEC);
 468         if (retval < 0) {
 469                 dbg("error fcntl on write pipe: %s", strerror(errno));
 470                 exit(1);
 471         }
 472
 473         /* set signal handlers */
 474         act.sa_handler = (void (*) (int))sig_handler;
 475         sigemptyset(&act.sa_mask);
 476         act.sa_flags = SA_RESTART;
 477         sigaction(SIGINT, &act, NULL);
 478         sigaction(SIGTERM, &act, NULL);
 479         sigaction(SIGALRM, &act, NULL);
 480         sigaction(SIGCHLD, &act, NULL);
 481
 482         memset(&saddr, 0x00, sizeof(saddr));
 483         saddr.sun_family = AF_LOCAL;
 484         /* use abstract namespace for socket path */
 485         strcpy(&saddr.sun_path[1], UDEVD_SOCK_PATH);
 486         addrlen = offsetof(struct sockaddr_un, sun_path) + strlen(saddr.sun_path+1) + 1;
 487
 488         udevsendsock = socket(AF_LOCAL, SOCK_DGRAM, 0);
 489         if (udevsendsock == -1) {
 490                 dbg("error getting socket, exit");
 491                 exit(1);
 492         }
 493
 494         /* the bind takes care of ensuring only one copy running */
 495         retval = bind(udevsendsock, (struct sockaddr *) &saddr, addrlen);
 496         if (retval < 0) {
 497                 dbg("bind failed, exit");
 498                 goto exit;
 499         }
 500
 501         /* enable receiving of the sender credentials */
 502         setsockopt(udevsendsock, SOL_SOCKET, SO_PASSCRED, &feature_on, sizeof(feature_on));
 503
 504         /* possible override of udev binary, used for testing */
 505         udev_bin = getenv("UDEV_BIN");
 506         if (udev_bin != NULL)
 507                 dbg("udev binary is set to '%s'", udev_bin);
 508         else
 509                 udev_bin = UDEV_BIN;
 510
 511         FD_ZERO(&readfds);
 512         FD_SET(udevsendsock, &readfds);
 513         FD_SET(pipefds[0], &readfds);
 514         maxsockplus = udevsendsock+1;
 515         while (1) {
 516                 fd_set workreadfds = readfds;
 517                 retval = select(maxsockplus, &workreadfds, NULL, NULL, NULL);
 518
 519                 if (retval < 0) {
 520                         if (errno != EINTR)
 521                                 dbg("error in select: %s", strerror(errno));
 522                         continue;
 523                 }
 524
 525                 if (FD_ISSET(udevsendsock, &workreadfds))
 526                         handle_udevsend_msg(udevsendsock);
 527
 528                 if (FD_ISSET(pipefds[0], &workreadfds))
 529                         user_sighandler();
 530
 531                 if (sigchilds_waiting) {
 532                         sigchilds_waiting = 0;
 533                         reap_sigchilds();
 534                 }
 535
 536                 if (run_msg_q) {
 537                         run_msg_q = 0;
 538                         msg_queue_manager();
 539                 }
 540
 541                 if (run_exec_q) {
 542                          /* clean up running_list before calling exec_queue_manager() */
 543                         if (sigchilds_waiting) {
 544                                 sigchilds_waiting = 0;
 545                                 reap_sigchilds();
 546                         }
 547
 548                         run_exec_q = 0;
 549                         exec_queue_manager();
 550                 }
 551         }
 552 exit:
 553         close(udevsendsock);
 554         logging_close();
 555         return 1;
 556 }