]> git.ipfire.org Git - thirdparty/cups.git/blob - scheduler/main.c
Set QoS priority class for the main thread when running from launchd.
[thirdparty/cups.git] / scheduler / main.c
1 /*
2 * Main loop for the CUPS scheduler.
3 *
4 * Copyright 2007-2018 by Apple Inc.
5 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
6 *
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more
8 * information.
9 */
10
11 /*
12 * Include necessary headers...
13 */
14
15 #define _MAIN_C_
16 #include "cupsd.h"
17 #include <sys/resource.h>
18 #ifdef __APPLE__
19 # include <xpc/xpc.h>
20 # include <pthread/qos.h>
21 #endif /* __APPLE__ */
22 #ifdef HAVE_ASL_H
23 # include <asl.h>
24 #elif defined(HAVE_SYSTEMD_SD_JOURNAL_H)
25 # define SD_JOURNAL_SUPPRESS_LOCATION
26 # include <systemd/sd-journal.h>
27 #endif /* HAVE_ASL_H */
28 #include <syslog.h>
29 #include <grp.h>
30
31 #ifdef HAVE_LAUNCH_H
32 # include <launch.h>
33 #endif /* HAVE_LAUNCH_H */
34
35 #ifdef HAVE_SYSTEMD
36 # include <systemd/sd-daemon.h>
37 #endif /* HAVE_SYSTEMD */
38
39 #ifdef HAVE_ONDEMAND
40 # define CUPS_KEEPALIVE CUPS_CACHEDIR "/org.cups.cupsd"
41 /* Name of the KeepAlive file */
42 #endif /* HAVE_ONDEMAND */
43
44 #if defined(HAVE_MALLOC_H) && defined(HAVE_MALLINFO)
45 # include <malloc.h>
46 #endif /* HAVE_MALLOC_H && HAVE_MALLINFO */
47
48 #ifdef HAVE_NOTIFY_H
49 # include <notify.h>
50 #endif /* HAVE_NOTIFY_H */
51
52 #ifdef HAVE_DBUS
53 # include <dbus/dbus.h>
54 #endif /* HAVE_DBUS */
55
56 #ifdef HAVE_SYS_PARAM_H
57 # include <sys/param.h>
58 #endif /* HAVE_SYS_PARAM_H */
59
60
61 /*
62 * Local functions...
63 */
64
65 static void parent_handler(int sig);
66 static void process_children(void);
67 static void sigchld_handler(int sig);
68 static void sighup_handler(int sig);
69 static void sigterm_handler(int sig);
70 static long select_timeout(int fds);
71 static void service_checkin(void);
72 static void service_checkout(int shutdown);
73 static void usage(int status) _CUPS_NORETURN;
74
75
76 /*
77 * Local globals...
78 */
79
80 static int parent_signal = 0;
81 /* Set to signal number from child */
82 static int holdcount = 0; /* Number of times "hold" was called */
83 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
84 static sigset_t holdmask; /* Old POSIX signal mask */
85 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
86 static int dead_children = 0;
87 /* Dead children? */
88 static int stop_scheduler = 0;
89 /* Should the scheduler stop? */
90 static time_t local_timeout = 0;
91 /* Next local printer timeout */
92
93
94 /*
95 * 'main()' - Main entry for the CUPS scheduler.
96 */
97
98 int /* O - Exit status */
99 main(int argc, /* I - Number of command-line args */
100 char *argv[]) /* I - Command-line arguments */
101 {
102 int i; /* Looping var */
103 char *opt; /* Option character */
104 int close_all = 1, /* Close all file descriptors? */
105 disconnect = 1, /* Disconnect from controlling terminal? */
106 fg = 0, /* Run in foreground? */
107 run_as_child = 0,
108 /* Running as child process? */
109 print_profile = 0;
110 /* Print the sandbox profile to stdout? */
111 int fds; /* Number of ready descriptors */
112 cupsd_client_t *con; /* Current client */
113 cupsd_job_t *job; /* Current job */
114 cupsd_listener_t *lis; /* Current listener */
115 time_t current_time, /* Current time */
116 activity, /* Client activity timer */
117 senddoc_time, /* Send-Document time */
118 expire_time, /* Subscription expire time */
119 report_time, /* Malloc/client/job report time */
120 event_time; /* Last event notification time */
121 long timeout; /* Timeout for cupsdDoSelect() */
122 struct rlimit limit; /* Runtime limit */
123 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
124 struct sigaction action; /* Actions for POSIX signals */
125 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
126 #ifdef __APPLE__
127 int use_sysman = 1; /* Use system management functions? */
128 #else
129 time_t netif_time = 0; /* Time since last network update */
130 #endif /* __APPLE__ */
131 #if defined(HAVE_ONDEMAND)
132 int service_idle_exit;
133 /* Idle exit on select timeout? */
134 #endif /* HAVE_ONDEMAND */
135
136
137 #ifdef HAVE_GETEUID
138 /*
139 * Check for setuid invocation, which we do not support!
140 */
141
142 if (getuid() != geteuid())
143 {
144 fputs("cupsd: Cannot run as a setuid program.\n", stderr);
145 return (1);
146 }
147 #endif /* HAVE_GETEUID */
148
149 /*
150 * Check for command-line arguments...
151 */
152
153 fg = 0;
154
155 for (i = 1; i < argc; i ++)
156 if (argv[i][0] == '-')
157 for (opt = argv[i] + 1; *opt != '\0'; opt ++)
158 switch (*opt)
159 {
160 case 'C' : /* Run as child with config file */
161 run_as_child = 1;
162 fg = 1;
163 close_all = 0;
164
165 case 'c' : /* Configuration file */
166 i ++;
167 if (i >= argc)
168 {
169 _cupsLangPuts(stderr, _("cupsd: Expected config filename "
170 "after \"-c\" option."));
171 usage(1);
172 }
173
174 if (argv[i][0] == '/')
175 {
176 /*
177 * Absolute directory...
178 */
179
180 cupsdSetString(&ConfigurationFile, argv[i]);
181 }
182 else
183 {
184 /*
185 * Relative directory...
186 */
187
188 char *current; /* Current directory */
189
190 /*
191 * Allocate a buffer for the current working directory to
192 * reduce run-time stack usage; this approximates the
193 * behavior of some implementations of getcwd() when they
194 * are passed a NULL pointer.
195 */
196
197 if ((current = malloc(1024)) == NULL)
198 {
199 _cupsLangPuts(stderr,
200 _("cupsd: Unable to get current directory."));
201 return (1);
202 }
203
204 if (!getcwd(current, 1024))
205 {
206 _cupsLangPuts(stderr,
207 _("cupsd: Unable to get current directory."));
208 free(current);
209 return (1);
210 }
211
212 cupsdSetStringf(&ConfigurationFile, "%s/%s", current, argv[i]);
213 free(current);
214 }
215 break;
216
217 case 'f' : /* Run in foreground... */
218 fg = 1;
219 disconnect = 0;
220 close_all = 0;
221 break;
222
223 case 'F' : /* Run in foreground, but disconnect from terminal... */
224 fg = 1;
225 close_all = 0;
226 break;
227
228 case 'h' : /* Show usage/help */
229 usage(0);
230 break;
231
232 case 'l' : /* Started by launchd/systemd/upstart... */
233 #ifdef HAVE_ONDEMAND
234 OnDemand = 1;
235 fg = 1;
236 close_all = 0;
237 disconnect = 0;
238 #else
239 _cupsLangPuts(stderr, _("cupsd: On-demand support not compiled "
240 "in, running in normal mode."));
241 fg = 0;
242 disconnect = 1;
243 close_all = 1;
244 #endif /* HAVE_ONDEMAND */
245 break;
246
247 case 'p' : /* Stop immediately for profiling */
248 fputs("cupsd: -p (startup profiling) is for internal testing "
249 "use only!\n", stderr);
250 stop_scheduler = 1;
251 fg = 1;
252 disconnect = 0;
253 close_all = 0;
254 break;
255
256 case 'P' : /* Disable security profiles */
257 fputs("cupsd: -P (disable sandboxing) is for internal testing use only.\n", stderr);
258 UseSandboxing = 0;
259 break;
260
261 case 's' : /* Set cups-files.conf location */
262 i ++;
263 if (i >= argc)
264 {
265 _cupsLangPuts(stderr, _("cupsd: Expected cups-files.conf "
266 "filename after \"-s\" option."));
267 usage(1);
268 }
269
270 if (argv[i][0] != '/')
271 {
272 /*
273 * Relative filename not allowed...
274 */
275
276 _cupsLangPuts(stderr, _("cupsd: Relative cups-files.conf "
277 "filename not allowed."));
278 usage(1);
279 }
280
281 cupsdSetString(&CupsFilesFile, argv[i]);
282 break;
283
284 #ifdef __APPLE__
285 case 'S' : /* Disable system management functions */
286 fputs("cupsd: -S (disable system management) for internal "
287 "testing use only!\n", stderr);
288 use_sysman = 0;
289 break;
290 #endif /* __APPLE__ */
291
292 case 't' : /* Test the cupsd.conf file... */
293 TestConfigFile = 1;
294 fg = 1;
295 disconnect = 0;
296 close_all = 0;
297 break;
298
299 case 'T' : /* Print security profile */
300 print_profile = 1;
301 fg = 1;
302 disconnect = 0;
303 close_all = 0;
304 break;
305
306 default : /* Unknown option */
307 _cupsLangPrintf(stderr, _("cupsd: Unknown option \"%c\" - "
308 "aborting."), *opt);
309 usage(1);
310 break;
311 }
312 else
313 {
314 _cupsLangPrintf(stderr, _("cupsd: Unknown argument \"%s\" - aborting."),
315 argv[i]);
316 usage(1);
317 }
318
319 if (!ConfigurationFile)
320 cupsdSetString(&ConfigurationFile, CUPS_SERVERROOT "/cupsd.conf");
321
322 if (!CupsFilesFile)
323 {
324 char *filename, /* Copy of cupsd.conf filename */
325 *slash; /* Final slash in cupsd.conf filename */
326 size_t len; /* Size of buffer */
327
328 len = strlen(ConfigurationFile) + 15;
329 if ((filename = malloc(len)) == NULL)
330 {
331 _cupsLangPrintf(stderr,
332 _("cupsd: Unable to get path to "
333 "cups-files.conf file."));
334 return (1);
335 }
336
337 strlcpy(filename, ConfigurationFile, len);
338 if ((slash = strrchr(filename, '/')) == NULL)
339 {
340 _cupsLangPrintf(stderr,
341 _("cupsd: Unable to get path to "
342 "cups-files.conf file."));
343 return (1);
344 }
345
346 strlcpy(slash, "/cups-files.conf", len - (size_t)(slash - filename));
347 cupsdSetString(&CupsFilesFile, filename);
348 free(filename);
349 }
350
351 if (disconnect)
352 {
353 /*
354 * Make sure we aren't tying up any filesystems...
355 */
356
357 chdir("/");
358
359 /*
360 * Disconnect from the controlling terminal...
361 */
362
363 setsid();
364 }
365
366 if (close_all)
367 {
368 /*
369 * Close all open files...
370 */
371
372 getrlimit(RLIMIT_NOFILE, &limit);
373
374 for (i = 0; i < (int)limit.rlim_cur && i < 1024; i ++)
375 close(i);
376
377 /*
378 * Redirect stdin/out/err to /dev/null...
379 */
380
381 if ((i = open("/dev/null", O_RDONLY)) != 0)
382 {
383 dup2(i, 0);
384 close(i);
385 }
386
387 if ((i = open("/dev/null", O_WRONLY)) != 1)
388 {
389 dup2(i, 1);
390 close(i);
391 }
392
393 if ((i = open("/dev/null", O_WRONLY)) != 2)
394 {
395 dup2(i, 2);
396 close(i);
397 }
398 }
399 else
400 LogStderr = cupsFileStderr();
401
402 /*
403 * Run in the background as needed...
404 */
405
406 if (!fg)
407 {
408 /*
409 * Setup signal handlers for the parent...
410 */
411
412 #ifdef HAVE_SIGSET /* Use System V signals over POSIX to avoid bugs */
413 sigset(SIGUSR1, parent_handler);
414 sigset(SIGCHLD, parent_handler);
415
416 sigset(SIGHUP, SIG_IGN);
417 #elif defined(HAVE_SIGACTION)
418 memset(&action, 0, sizeof(action));
419 sigemptyset(&action.sa_mask);
420 sigaddset(&action.sa_mask, SIGUSR1);
421 action.sa_handler = parent_handler;
422 sigaction(SIGUSR1, &action, NULL);
423 sigaction(SIGCHLD, &action, NULL);
424
425 sigemptyset(&action.sa_mask);
426 action.sa_handler = SIG_IGN;
427 sigaction(SIGHUP, &action, NULL);
428 #else
429 signal(SIGUSR1, parent_handler);
430 signal(SIGCLD, parent_handler);
431
432 signal(SIGHUP, SIG_IGN);
433 #endif /* HAVE_SIGSET */
434
435 if (fork() > 0)
436 {
437 /*
438 * OK, wait for the child to startup and send us SIGUSR1 or to crash
439 * and the OS send us SIGCHLD... We also need to ignore SIGHUP which
440 * might be sent by the init script to restart the scheduler...
441 */
442
443 for (; parent_signal == 0;)
444 sleep(1);
445
446 if (parent_signal == SIGUSR1)
447 return (0);
448
449 if (wait(&i) < 0)
450 {
451 perror("cupsd");
452 return (1);
453 }
454 else if (WIFEXITED(i))
455 {
456 fprintf(stderr, "cupsd: Child exited with status %d\n",
457 WEXITSTATUS(i));
458 return (2);
459 }
460 else
461 {
462 fprintf(stderr, "cupsd: Child exited on signal %d\n", WTERMSIG(i));
463 return (3);
464 }
465 }
466
467 #if defined(__OpenBSD__) && OpenBSD < 201211
468 /*
469 * Call _thread_sys_closefrom() so the child process doesn't reset the
470 * parent's file descriptors to be blocking. This is a workaround for a
471 * limitation of userland libpthread on older versions of OpenBSD.
472 */
473
474 _thread_sys_closefrom(0);
475 #endif /* __OpenBSD__ && OpenBSD < 201211 */
476
477 /*
478 * Since many system libraries create fork-unsafe data on execution of a
479 * program, we need to re-execute the background cupsd with the "-C" and "-s"
480 * options to avoid problems. Unfortunately, we also have to assume that
481 * argv[0] contains the name of the cupsd executable - there is no portable
482 * way to get the real pathname...
483 */
484
485 execlp(argv[0], argv[0], "-C", ConfigurationFile, "-s", CupsFilesFile, (char *)0);
486 exit(errno);
487 }
488
489 /*
490 * Let the system know we are busy while we bring up cupsd...
491 */
492
493 cupsdSetBusyState(1);
494
495 /*
496 * Set the timezone info...
497 */
498
499 tzset();
500
501 #ifdef LC_TIME
502 setlocale(LC_TIME, "");
503 #endif /* LC_TIME */
504
505 #ifdef HAVE_DBUS_THREADS_INIT
506 /*
507 * Enable threading support for D-BUS...
508 */
509
510 dbus_threads_init_default();
511 #endif /* HAVE_DBUS_THREADS_INIT */
512
513 /*
514 * Set the maximum number of files...
515 */
516
517 getrlimit(RLIMIT_NOFILE, &limit);
518
519 #if !defined(HAVE_POLL) && !defined(HAVE_EPOLL) && !defined(HAVE_KQUEUE)
520 if (limit.rlim_max > FD_SETSIZE)
521 MaxFDs = FD_SETSIZE;
522 else
523 #endif /* !HAVE_POLL && !HAVE_EPOLL && !HAVE_KQUEUE */
524 #ifdef RLIM_INFINITY
525 if (limit.rlim_max == RLIM_INFINITY)
526 MaxFDs = 16384;
527 else
528 #endif /* RLIM_INFINITY */
529 MaxFDs = limit.rlim_max;
530
531 limit.rlim_cur = (rlim_t)MaxFDs;
532
533 setrlimit(RLIMIT_NOFILE, &limit);
534
535 cupsdStartSelect();
536
537 /*
538 * Read configuration...
539 */
540
541 if (!cupsdReadConfiguration())
542 return (1);
543 else if (TestConfigFile)
544 {
545 printf("\"%s\" is OK.\n", CupsFilesFile);
546 printf("\"%s\" is OK.\n", ConfigurationFile);
547 return (0);
548 }
549 else if (print_profile)
550 {
551 cups_file_t *fp; /* File pointer */
552 const char *profile = cupsdCreateProfile(42, 0);
553 /* Profile */
554 char line[1024]; /* Line from file */
555
556
557 if ((fp = cupsFileOpen(profile, "r")) == NULL)
558 {
559 printf("Unable to open profile file \"%s\": %s\n", profile ? profile : "(null)", strerror(errno));
560 return (1);
561 }
562
563 while (cupsFileGets(fp, line, sizeof(line)))
564 puts(line);
565
566 cupsFileClose(fp);
567
568 return (0);
569 }
570
571 /*
572 * Clean out old temp files and printer cache data.
573 */
574
575 if (!strncmp(TempDir, RequestRoot, strlen(RequestRoot)))
576 cupsdCleanFiles(TempDir, NULL);
577
578 cupsdCleanFiles(CacheDir, "*.ipp");
579
580 /*
581 * If we were started on demand by launchd or systemd get the listen sockets
582 * file descriptors...
583 */
584
585 service_checkin();
586 service_checkout(0);
587
588 /*
589 * Startup the server...
590 */
591
592 httpInitialize();
593
594 cupsdStartServer();
595
596 /*
597 * Catch hangup and child signals and ignore broken pipes...
598 */
599
600 #ifdef HAVE_SIGSET /* Use System V signals over POSIX to avoid bugs */
601 sigset(SIGCHLD, sigchld_handler);
602 sigset(SIGHUP, sighup_handler);
603 sigset(SIGPIPE, SIG_IGN);
604 sigset(SIGTERM, sigterm_handler);
605 #elif defined(HAVE_SIGACTION)
606 memset(&action, 0, sizeof(action));
607
608 sigemptyset(&action.sa_mask);
609 sigaddset(&action.sa_mask, SIGTERM);
610 sigaddset(&action.sa_mask, SIGCHLD);
611 action.sa_handler = sigchld_handler;
612 sigaction(SIGCHLD, &action, NULL);
613
614 sigemptyset(&action.sa_mask);
615 sigaddset(&action.sa_mask, SIGHUP);
616 action.sa_handler = sighup_handler;
617 sigaction(SIGHUP, &action, NULL);
618
619 sigemptyset(&action.sa_mask);
620 action.sa_handler = SIG_IGN;
621 sigaction(SIGPIPE, &action, NULL);
622
623 sigemptyset(&action.sa_mask);
624 sigaddset(&action.sa_mask, SIGTERM);
625 sigaddset(&action.sa_mask, SIGCHLD);
626 action.sa_handler = sigterm_handler;
627 sigaction(SIGTERM, &action, NULL);
628 #else
629 signal(SIGCLD, sigchld_handler); /* No, SIGCLD isn't a typo... */
630 signal(SIGHUP, sighup_handler);
631 signal(SIGPIPE, SIG_IGN);
632 signal(SIGTERM, sigterm_handler);
633 #endif /* HAVE_SIGSET */
634
635 /*
636 * Initialize authentication certificates...
637 */
638
639 cupsdInitCerts();
640
641 /*
642 * If we are running in the background, signal the parent process that
643 * we are up and running...
644 */
645
646 if (!fg || run_as_child)
647 {
648 /*
649 * Send a signal to the parent process, but only if the parent is
650 * not PID 1 (init). This avoids accidentally shutting down the
651 * system on OpenBSD if you CTRL-C the server before it is up...
652 */
653
654 i = getppid(); /* Save parent PID to avoid race condition */
655
656 if (i != 1)
657 kill(i, SIGUSR1);
658 }
659
660 #ifdef __APPLE__
661 /*
662 * Start power management framework...
663 */
664
665 if (use_sysman)
666 cupsdStartSystemMonitor();
667 #endif /* __APPLE__ */
668
669 /*
670 * Send server-started event...
671 */
672
673 #ifdef HAVE_ONDEMAND
674 if (OnDemand)
675 cupsdAddEvent(CUPSD_EVENT_SERVER_STARTED, NULL, NULL, "Scheduler started on demand.");
676 else
677 #endif /* HAVE_ONDEMAND */
678 if (fg)
679 cupsdAddEvent(CUPSD_EVENT_SERVER_STARTED, NULL, NULL, "Scheduler started in foreground.");
680 else
681 cupsdAddEvent(CUPSD_EVENT_SERVER_STARTED, NULL, NULL, "Scheduler started in background.");
682
683 cupsdSetBusyState(0);
684
685 /*
686 * Start any pending print jobs...
687 */
688
689 cupsdCheckJobs();
690
691 /*
692 * Loop forever...
693 */
694
695 current_time = time(NULL);
696 event_time = current_time;
697 expire_time = current_time;
698 local_timeout = 0;
699 fds = 1;
700 report_time = 0;
701 senddoc_time = current_time;
702
703 while (!stop_scheduler)
704 {
705 /*
706 * Check if there are dead children to handle...
707 */
708
709 if (dead_children)
710 process_children();
711
712 /*
713 * Check if we need to load the server configuration file...
714 */
715
716 if (NeedReload)
717 {
718 /*
719 * Close any idle clients...
720 */
721
722 if (cupsArrayCount(Clients) > 0)
723 {
724 for (con = (cupsd_client_t *)cupsArrayFirst(Clients);
725 con;
726 con = (cupsd_client_t *)cupsArrayNext(Clients))
727 if (httpGetState(con->http) == HTTP_WAITING)
728 cupsdCloseClient(con);
729 else
730 con->http->keep_alive = HTTP_KEEPALIVE_OFF;
731
732 cupsdPauseListening();
733 }
734
735 /*
736 * Restart if all clients are closed and all jobs finished, or
737 * if the reload timeout has elapsed...
738 */
739
740 if ((cupsArrayCount(Clients) == 0 &&
741 (cupsArrayCount(PrintingJobs) == 0 || NeedReload != RELOAD_ALL)) ||
742 (time(NULL) - ReloadTime) >= ReloadTimeout)
743 {
744 /*
745 * Shutdown the server...
746 */
747
748 #ifdef HAVE_ONDEMAND
749 if (OnDemand)
750 break;
751 #endif /* HAVE_ONDEMAND */
752
753 DoingShutdown = 1;
754
755 cupsdStopServer();
756
757 /*
758 * Read configuration...
759 */
760
761 if (!cupsdReadConfiguration())
762 {
763 #ifdef HAVE_SYSTEMD_SD_JOURNAL_H
764 sd_journal_print(LOG_ERR, "Unable to read configuration file \"%s\" - exiting.", ConfigurationFile);
765 #else
766 syslog(LOG_LPR, "Unable to read configuration file \'%s\' - exiting.", ConfigurationFile);
767 #endif /* HAVE_SYSTEMD_SD_JOURNAL_H */
768
769 break;
770 }
771
772 /*
773 * Startup the server...
774 */
775
776 DoingShutdown = 0;
777
778 cupsdStartServer();
779
780 /*
781 * Send a server-restarted event...
782 */
783
784 cupsdAddEvent(CUPSD_EVENT_SERVER_RESTARTED, NULL, NULL,
785 "Scheduler restarted.");
786 }
787 }
788
789 /*
790 * Check for available input or ready output. If cupsdDoSelect()
791 * returns 0 or -1, something bad happened and we should exit
792 * immediately.
793 *
794 * Note that we at least have one listening socket open at all
795 * times.
796 */
797
798 if ((timeout = select_timeout(fds)) > 1 && LastEvent)
799 timeout = 1;
800
801 #ifdef HAVE_ONDEMAND
802 /*
803 * If no other work is scheduled and we're being controlled by launchd,
804 * systemd, etc. then timeout after 'IdleExitTimeout' seconds of
805 * inactivity...
806 */
807
808 if (timeout == 86400 && OnDemand && IdleExitTimeout &&
809 # ifdef HAVE_SYSTEMD
810 !WebInterface &&
811 # endif /* HAVE_SYSTEMD */
812 !cupsArrayCount(ActiveJobs))
813 {
814 cupsd_printer_t *p = NULL; /* Current printer */
815
816 if (Browsing && BrowseLocalProtocols)
817 {
818 for (p = (cupsd_printer_t *)cupsArrayFirst(Printers); p; p = (cupsd_printer_t *)cupsArrayNext(Printers))
819 if (p->shared)
820 break;
821 }
822
823 if (!p)
824 {
825 timeout = IdleExitTimeout;
826 service_idle_exit = 1;
827 }
828 }
829 else
830 service_idle_exit = 0;
831 #endif /* HAVE_ONDEMAND */
832
833 if ((fds = cupsdDoSelect(timeout)) < 0)
834 {
835 /*
836 * Got an error from select!
837 */
838
839 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
840 cupsd_printer_t *p; /* Current printer */
841 #endif /* HAVE_DNSSD || HAVE_AVAHI */
842
843 if (errno == EINTR) /* Just interrupted by a signal */
844 continue;
845
846 /*
847 * Log all sorts of debug info to help track down the problem.
848 */
849
850 cupsdLogMessage(CUPSD_LOG_EMERG, "cupsdDoSelect() failed - %s!",
851 strerror(errno));
852
853 for (i = 0, con = (cupsd_client_t *)cupsArrayFirst(Clients);
854 con;
855 i ++, con = (cupsd_client_t *)cupsArrayNext(Clients))
856 cupsdLogMessage(CUPSD_LOG_EMERG,
857 "Clients[%d] = %d, file = %d, state = %d",
858 i, con->number, con->file, httpGetState(con->http));
859
860 for (i = 0, lis = (cupsd_listener_t *)cupsArrayFirst(Listeners);
861 lis;
862 i ++, lis = (cupsd_listener_t *)cupsArrayNext(Listeners))
863 cupsdLogMessage(CUPSD_LOG_EMERG, "Listeners[%d] = %d", i, lis->fd);
864
865 cupsdLogMessage(CUPSD_LOG_EMERG, "CGIPipes[0] = %d", CGIPipes[0]);
866
867 #ifdef __APPLE__
868 cupsdLogMessage(CUPSD_LOG_EMERG, "SysEventPipes[0] = %d",
869 SysEventPipes[0]);
870 #endif /* __APPLE__ */
871
872 for (job = (cupsd_job_t *)cupsArrayFirst(ActiveJobs);
873 job;
874 job = (cupsd_job_t *)cupsArrayNext(ActiveJobs))
875 cupsdLogMessage(CUPSD_LOG_EMERG, "Jobs[%d] = %d < [%d %d] > [%d %d]",
876 job->id,
877 job->status_buffer ? job->status_buffer->fd : -1,
878 job->print_pipes[0], job->print_pipes[1],
879 job->back_pipes[0], job->back_pipes[1]);
880
881 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
882 for (p = (cupsd_printer_t *)cupsArrayFirst(Printers);
883 p;
884 p = (cupsd_printer_t *)cupsArrayNext(Printers))
885 cupsdLogMessage(CUPSD_LOG_EMERG, "printer[%s] reg_name=\"%s\"", p->name,
886 p->reg_name ? p->reg_name : "(null)");
887 #endif /* HAVE_DNSSD || HAVE_AVAHI */
888
889 break;
890 }
891
892 current_time = time(NULL);
893
894 /*
895 * Write dirty config/state files...
896 */
897
898 if (DirtyCleanTime && current_time >= DirtyCleanTime)
899 cupsdCleanDirty();
900
901 #ifdef __APPLE__
902 /*
903 * If we are going to sleep and still have pending jobs, stop them after
904 * a period of time...
905 */
906
907 if (SleepJobs > 0 && current_time >= SleepJobs &&
908 cupsArrayCount(PrintingJobs) > 0)
909 {
910 SleepJobs = 0;
911 cupsdStopAllJobs(CUPSD_JOB_DEFAULT, 5);
912 }
913 #endif /* __APPLE__ */
914
915 #ifndef __APPLE__
916 /*
917 * Update the network interfaces once a minute...
918 */
919
920 if ((current_time - netif_time) >= 60)
921 {
922 netif_time = current_time;
923 NetIFUpdate = 1;
924 }
925 #endif /* !__APPLE__ */
926
927 #ifdef HAVE_ONDEMAND
928 /*
929 * If no other work was scheduled and we're being controlled by launchd,
930 * systemd, or upstart then timeout after 'LaunchdTimeout' seconds of
931 * inactivity...
932 */
933
934 if (!fds && service_idle_exit)
935 {
936 cupsdLogMessage(CUPSD_LOG_INFO,
937 "Printer sharing is off and there are no jobs pending, "
938 "will restart on demand.");
939 stop_scheduler = 1;
940 break;
941 }
942 #endif /* HAVE_ONDEMAND */
943
944 /*
945 * Resume listening for new connections as needed...
946 */
947
948 if (ListeningPaused && ListeningPaused <= current_time &&
949 cupsArrayCount(Clients) < MaxClients)
950 cupsdResumeListening();
951
952 /*
953 * Expire subscriptions and unload completed jobs as needed...
954 */
955
956 if (current_time > expire_time)
957 {
958 if (cupsArrayCount(Subscriptions) > 0)
959 cupsdExpireSubscriptions(NULL, NULL);
960
961 cupsdUnloadCompletedJobs();
962
963 expire_time = current_time;
964 }
965
966 /*
967 * Delete stale local printers...
968 */
969
970 if (current_time >= local_timeout)
971 {
972 cupsdDeleteTemporaryPrinters(0);
973 local_timeout = 0;
974 }
975
976 #ifndef HAVE_AUTHORIZATION_H
977 /*
978 * Update the root certificate once every 5 minutes if we have client
979 * connections...
980 */
981
982 if ((current_time - RootCertTime) >= RootCertDuration && RootCertDuration &&
983 !RunUser && cupsArrayCount(Clients))
984 {
985 /*
986 * Update the root certificate...
987 */
988
989 cupsdDeleteCert(0);
990 cupsdAddCert(0, "root", cupsdDefaultAuthType());
991 }
992 #endif /* !HAVE_AUTHORIZATION_H */
993
994 /*
995 * Check for new data on the client sockets...
996 */
997
998 for (con = (cupsd_client_t *)cupsArrayFirst(Clients);
999 con;
1000 con = (cupsd_client_t *)cupsArrayNext(Clients))
1001 {
1002 /*
1003 * Process pending data in the input buffer...
1004 */
1005
1006 if (httpGetReady(con->http))
1007 {
1008 cupsdReadClient(con);
1009 continue;
1010 }
1011
1012 /*
1013 * Check the activity and close old clients...
1014 */
1015
1016 activity = current_time - Timeout;
1017 if (httpGetActivity(con->http) < activity && !con->pipe_pid)
1018 {
1019 cupsdLogMessage(CUPSD_LOG_DEBUG, "Closing client %d after %d seconds of inactivity.", con->number, Timeout);
1020
1021 cupsdCloseClient(con);
1022 continue;
1023 }
1024 }
1025
1026 /*
1027 * Update any pending multi-file documents...
1028 */
1029
1030 if ((current_time - senddoc_time) >= 10)
1031 {
1032 cupsdCheckJobs();
1033 senddoc_time = current_time;
1034 }
1035
1036 /*
1037 * Clean job history...
1038 */
1039
1040 if (JobHistoryUpdate && current_time >= JobHistoryUpdate)
1041 cupsdCleanJobs();
1042
1043 /*
1044 * Log statistics at most once a minute when in debug mode...
1045 */
1046
1047 if ((current_time - report_time) >= 60 && LogLevel >= CUPSD_LOG_DEBUG)
1048 {
1049 size_t string_count, /* String count */
1050 alloc_bytes, /* Allocated string bytes */
1051 total_bytes; /* Total string bytes */
1052 #ifdef HAVE_MALLINFO
1053 struct mallinfo mem; /* Malloc information */
1054
1055
1056 mem = mallinfo();
1057 cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: malloc-arena=%lu", mem.arena);
1058 cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: malloc-used=%lu",
1059 mem.usmblks + mem.uordblks);
1060 cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: malloc-free=%lu",
1061 mem.fsmblks + mem.fordblks);
1062 #endif /* HAVE_MALLINFO */
1063
1064 cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: clients=%d",
1065 cupsArrayCount(Clients));
1066 cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: jobs=%d",
1067 cupsArrayCount(Jobs));
1068 cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: jobs-active=%d",
1069 cupsArrayCount(ActiveJobs));
1070 cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: printers=%d",
1071 cupsArrayCount(Printers));
1072
1073 string_count = _cupsStrStatistics(&alloc_bytes, &total_bytes);
1074 cupsdLogMessage(CUPSD_LOG_DEBUG,
1075 "Report: stringpool-string-count=" CUPS_LLFMT,
1076 CUPS_LLCAST string_count);
1077 cupsdLogMessage(CUPSD_LOG_DEBUG,
1078 "Report: stringpool-alloc-bytes=" CUPS_LLFMT,
1079 CUPS_LLCAST alloc_bytes);
1080 cupsdLogMessage(CUPSD_LOG_DEBUG,
1081 "Report: stringpool-total-bytes=" CUPS_LLFMT,
1082 CUPS_LLCAST total_bytes);
1083
1084 report_time = current_time;
1085 }
1086
1087 /*
1088 * Handle OS-specific event notification for any events that have
1089 * accumulated. Don't send these more than once a second...
1090 */
1091
1092 if (LastEvent && (current_time - event_time) >= 1)
1093 {
1094 #ifdef HAVE_NOTIFY_POST
1095 if (LastEvent & (CUPSD_EVENT_PRINTER_ADDED |
1096 CUPSD_EVENT_PRINTER_DELETED |
1097 CUPSD_EVENT_PRINTER_MODIFIED))
1098 {
1099 cupsdLogMessage(CUPSD_LOG_DEBUG2,
1100 "notify_post(\"com.apple.printerListChange\")");
1101 notify_post("com.apple.printerListChange");
1102 }
1103
1104 if (LastEvent & CUPSD_EVENT_PRINTER_STATE_CHANGED)
1105 {
1106 cupsdLogMessage(CUPSD_LOG_DEBUG2,
1107 "notify_post(\"com.apple.printerHistoryChange\")");
1108 notify_post("com.apple.printerHistoryChange");
1109 }
1110
1111 if (LastEvent & (CUPSD_EVENT_JOB_STATE_CHANGED |
1112 CUPSD_EVENT_JOB_CONFIG_CHANGED |
1113 CUPSD_EVENT_JOB_PROGRESS))
1114 {
1115 cupsdLogMessage(CUPSD_LOG_DEBUG2,
1116 "notify_post(\"com.apple.jobChange\")");
1117 notify_post("com.apple.jobChange");
1118 }
1119 #endif /* HAVE_NOTIFY_POST */
1120
1121 /*
1122 * Reset the accumulated events...
1123 */
1124
1125 LastEvent = CUPSD_EVENT_NONE;
1126 event_time = current_time;
1127 }
1128 }
1129
1130 /*
1131 * Log a message based on what happened...
1132 */
1133
1134 if (stop_scheduler)
1135 {
1136 cupsdLogMessage(CUPSD_LOG_INFO, "Scheduler shutting down normally.");
1137 cupsdAddEvent(CUPSD_EVENT_SERVER_STOPPED, NULL, NULL,
1138 "Scheduler shutting down normally.");
1139 }
1140 else
1141 {
1142 cupsdLogMessage(CUPSD_LOG_ERROR,
1143 "Scheduler shutting down due to program error.");
1144 cupsdAddEvent(CUPSD_EVENT_SERVER_STOPPED, NULL, NULL,
1145 "Scheduler shutting down due to program error.");
1146 }
1147
1148 /*
1149 * Close all network clients...
1150 */
1151
1152 DoingShutdown = 1;
1153
1154 cupsdStopServer();
1155
1156 /*
1157 * Update the KeepAlive/PID file as needed...
1158 */
1159
1160 service_checkout(1);
1161
1162 /*
1163 * Stop all jobs...
1164 */
1165
1166 cupsdFreeAllJobs();
1167
1168 /*
1169 * Delete all temporary printers...
1170 */
1171
1172 cupsdDeleteTemporaryPrinters(1);
1173
1174 #ifdef __APPLE__
1175 /*
1176 * Stop monitoring system event monitoring...
1177 */
1178
1179 if (use_sysman)
1180 cupsdStopSystemMonitor();
1181 #endif /* __APPLE__ */
1182
1183 cupsdStopSelect();
1184
1185 return (!stop_scheduler);
1186 }
1187
1188
1189 /*
1190 * 'cupsdAddString()' - Copy and add a string to an array.
1191 */
1192
1193 int /* O - 1 on success, 0 on failure */
1194 cupsdAddString(cups_array_t **a, /* IO - String array */
1195 const char *s) /* I - String to copy and add */
1196 {
1197 if (!*a)
1198 *a = cupsArrayNew3((cups_array_func_t)strcmp, NULL,
1199 (cups_ahash_func_t)NULL, 0,
1200 (cups_acopy_func_t)strdup,
1201 (cups_afree_func_t)free);
1202
1203 return (cupsArrayAdd(*a, (char *)s));
1204 }
1205
1206
1207 /*
1208 * 'cupsdCheckProcess()' - Tell the main loop to check for dead children.
1209 */
1210
1211 void
1212 cupsdCheckProcess(void)
1213 {
1214 /*
1215 * Flag that we have dead children...
1216 */
1217
1218 dead_children = 1;
1219 }
1220
1221
1222 /*
1223 * 'cupsdClearString()' - Clear a string.
1224 */
1225
1226 void
1227 cupsdClearString(char **s) /* O - String value */
1228 {
1229 if (s && *s)
1230 {
1231 free(*s);
1232 *s = NULL;
1233 }
1234 }
1235
1236
1237 /*
1238 * 'cupsdFreeStrings()' - Free an array of strings.
1239 */
1240
1241 void
1242 cupsdFreeStrings(cups_array_t **a) /* IO - String array */
1243 {
1244 if (*a)
1245 {
1246 cupsArrayDelete(*a);
1247 *a = NULL;
1248 }
1249 }
1250
1251
1252 /*
1253 * 'cupsdHoldSignals()' - Hold child and termination signals.
1254 */
1255
1256 void
1257 cupsdHoldSignals(void)
1258 {
1259 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
1260 sigset_t newmask; /* New POSIX signal mask */
1261 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
1262
1263
1264 holdcount ++;
1265 if (holdcount > 1)
1266 return;
1267
1268 #ifdef HAVE_SIGSET
1269 sighold(SIGTERM);
1270 sighold(SIGCHLD);
1271 #elif defined(HAVE_SIGACTION)
1272 sigemptyset(&newmask);
1273 sigaddset(&newmask, SIGTERM);
1274 sigaddset(&newmask, SIGCHLD);
1275 sigprocmask(SIG_BLOCK, &newmask, &holdmask);
1276 #endif /* HAVE_SIGSET */
1277 }
1278
1279
1280 /*
1281 * 'cupsdReleaseSignals()' - Release signals for delivery.
1282 */
1283
1284 void
1285 cupsdReleaseSignals(void)
1286 {
1287 holdcount --;
1288 if (holdcount > 0)
1289 return;
1290
1291 #ifdef HAVE_SIGSET
1292 sigrelse(SIGTERM);
1293 sigrelse(SIGCHLD);
1294 #elif defined(HAVE_SIGACTION)
1295 sigprocmask(SIG_SETMASK, &holdmask, NULL);
1296 #endif /* HAVE_SIGSET */
1297 }
1298
1299
1300 /*
1301 * 'cupsdSetString()' - Set a string value.
1302 */
1303
1304 void
1305 cupsdSetString(char **s, /* O - New string */
1306 const char *v) /* I - String value */
1307 {
1308 if (!s || *s == v)
1309 return;
1310
1311 if (*s)
1312 free(*s);
1313
1314 if (v)
1315 *s = strdup(v);
1316 else
1317 *s = NULL;
1318 }
1319
1320
1321 /*
1322 * 'cupsdSetStringf()' - Set a formatted string value.
1323 */
1324
1325 void
1326 cupsdSetStringf(char **s, /* O - New string */
1327 const char *f, /* I - Printf-style format string */
1328 ...) /* I - Additional args as needed */
1329 {
1330 char v[65536 + 64]; /* Formatting string value */
1331 va_list ap; /* Argument pointer */
1332 char *olds; /* Old string */
1333
1334
1335 if (!s)
1336 return;
1337
1338 olds = *s;
1339
1340 if (f)
1341 {
1342 va_start(ap, f);
1343 vsnprintf(v, sizeof(v), f, ap);
1344 va_end(ap);
1345
1346 *s = strdup(v);
1347 }
1348 else
1349 *s = NULL;
1350
1351 if (olds)
1352 free(olds);
1353 }
1354
1355
1356 /*
1357 * 'parent_handler()' - Catch USR1/CHLD signals...
1358 */
1359
1360 static void
1361 parent_handler(int sig) /* I - Signal */
1362 {
1363 /*
1364 * Store the signal we got from the OS and return...
1365 */
1366
1367 parent_signal = sig;
1368 }
1369
1370
1371 /*
1372 * 'process_children()' - Process all dead children...
1373 */
1374
1375 static void
1376 process_children(void)
1377 {
1378 int status; /* Exit status of child */
1379 int pid, /* Process ID of child */
1380 job_id; /* Job ID of child */
1381 cupsd_job_t *job; /* Current job */
1382 int i; /* Looping var */
1383 char name[1024]; /* Process name */
1384 const char *type; /* Type of program */
1385
1386
1387 cupsdLogMessage(CUPSD_LOG_DEBUG2, "process_children()");
1388
1389 /*
1390 * Reset the dead_children flag...
1391 */
1392
1393 dead_children = 0;
1394
1395 /*
1396 * Collect the exit status of some children...
1397 */
1398
1399 #ifdef HAVE_WAITPID
1400 while ((pid = waitpid(-1, &status, WNOHANG)) > 0)
1401 #elif defined(HAVE_WAIT3)
1402 while ((pid = wait3(&status, WNOHANG, NULL)) > 0)
1403 #else
1404 if ((pid = wait(&status)) > 0)
1405 #endif /* HAVE_WAITPID */
1406 {
1407 /*
1408 * Collect the name of the process that finished...
1409 */
1410
1411 cupsdFinishProcess(pid, name, sizeof(name), &job_id);
1412
1413 /*
1414 * Delete certificates for CGI processes...
1415 */
1416
1417 if (pid)
1418 cupsdDeleteCert(pid);
1419
1420 /*
1421 * Handle completed job filters...
1422 */
1423
1424 if (job_id > 0)
1425 job = cupsdFindJob(job_id);
1426 else
1427 job = NULL;
1428
1429 if (job)
1430 {
1431 for (i = 0; job->filters[i]; i ++)
1432 if (job->filters[i] == pid)
1433 break;
1434
1435 if (job->filters[i] || job->backend == pid)
1436 {
1437 /*
1438 * OK, this process has gone away; what's left?
1439 */
1440
1441 if (job->filters[i])
1442 {
1443 job->filters[i] = -pid;
1444 type = "Filter";
1445 }
1446 else
1447 {
1448 job->backend = -pid;
1449 type = "Backend";
1450 }
1451
1452 if (status && status != SIGTERM && status != SIGKILL &&
1453 status != SIGPIPE)
1454 {
1455 /*
1456 * An error occurred; save the exit status so we know to stop
1457 * the printer or cancel the job when all of the filters finish...
1458 *
1459 * A negative status indicates that the backend failed and the
1460 * printer needs to be stopped.
1461 *
1462 * In order to preserve the most serious status, we always log
1463 * when a process dies due to a signal (e.g. SIGABRT, SIGSEGV,
1464 * and SIGBUS) and prefer to log the backend exit status over a
1465 * filter's.
1466 */
1467
1468 int old_status = abs(job->status);
1469
1470 if (WIFSIGNALED(status) || /* This process crashed, or */
1471 !job->status || /* No process had a status, or */
1472 (!job->filters[i] && WIFEXITED(old_status)))
1473 { /* Backend and filter didn't crash */
1474 if (job->filters[i])
1475 job->status = status; /* Filter failed */
1476 else
1477 job->status = -status; /* Backend failed */
1478 }
1479
1480 if (job->state_value == IPP_JOB_PROCESSING &&
1481 job->status_level > CUPSD_LOG_ERROR &&
1482 (job->filters[i] || !WIFEXITED(status)))
1483 {
1484 char message[1024]; /* New printer-state-message */
1485
1486
1487 job->status_level = CUPSD_LOG_ERROR;
1488
1489 snprintf(message, sizeof(message), "%s failed", type);
1490
1491 if (job->printer)
1492 {
1493 strlcpy(job->printer->state_message, message,
1494 sizeof(job->printer->state_message));
1495 }
1496
1497 if (!job->attrs)
1498 cupsdLoadJob(job);
1499
1500 if (!job->printer_message && job->attrs)
1501 {
1502 if ((job->printer_message =
1503 ippFindAttribute(job->attrs, "job-printer-state-message",
1504 IPP_TAG_TEXT)) == NULL)
1505 job->printer_message = ippAddString(job->attrs, IPP_TAG_JOB,
1506 IPP_TAG_TEXT,
1507 "job-printer-state-message",
1508 NULL, NULL);
1509 }
1510
1511 if (job->printer_message)
1512 ippSetString(job->attrs, &job->printer_message, 0, message);
1513 }
1514 }
1515
1516 /*
1517 * If this is not the last file in a job, see if all of the
1518 * filters are done, and if so move to the next file.
1519 */
1520
1521 if (job->state_value >= IPP_JOB_CANCELED)
1522 {
1523 /*
1524 * Remove the job from the active list if there are no processes still
1525 * running for it...
1526 */
1527
1528 for (i = 0; job->filters[i] < 0; i++);
1529
1530 if (!job->filters[i] && job->backend <= 0)
1531 cupsArrayRemove(ActiveJobs, job);
1532 }
1533 else if (job->current_file < job->num_files && job->printer)
1534 {
1535 for (i = 0; job->filters[i] < 0; i ++);
1536
1537 if (!job->filters[i] &&
1538 (!job->printer->pc || !job->printer->pc->single_file ||
1539 job->backend <= 0))
1540 {
1541 /*
1542 * Process the next file...
1543 */
1544
1545 cupsdContinueJob(job);
1546 }
1547 }
1548 }
1549 }
1550
1551 /*
1552 * Show the exit status as needed, ignoring SIGTERM and SIGKILL errors
1553 * since they come when we kill/end a process...
1554 */
1555
1556 if (status == SIGTERM || status == SIGKILL)
1557 {
1558 cupsdLogJob(job, CUPSD_LOG_DEBUG,
1559 "PID %d (%s) was terminated normally with signal %d.", pid,
1560 name, status);
1561 }
1562 else if (status == SIGPIPE)
1563 {
1564 cupsdLogJob(job, CUPSD_LOG_DEBUG,
1565 "PID %d (%s) did not catch or ignore signal %d.", pid, name,
1566 status);
1567 }
1568 else if (status)
1569 {
1570 if (WIFEXITED(status))
1571 {
1572 int code = WEXITSTATUS(status); /* Exit code */
1573
1574 if (code > 100)
1575 cupsdLogJob(job, CUPSD_LOG_DEBUG,
1576 "PID %d (%s) stopped with status %d (%s)", pid, name,
1577 code, strerror(code - 100));
1578 else
1579 cupsdLogJob(job, CUPSD_LOG_DEBUG,
1580 "PID %d (%s) stopped with status %d.", pid, name, code);
1581 }
1582 else
1583 cupsdLogJob(job, CUPSD_LOG_DEBUG, "PID %d (%s) crashed on signal %d.",
1584 pid, name, WTERMSIG(status));
1585
1586 if (LogLevel < CUPSD_LOG_DEBUG)
1587 cupsdLogJob(job, CUPSD_LOG_INFO,
1588 "Hint: Try setting the LogLevel to \"debug\" to find out "
1589 "more.");
1590 }
1591 else
1592 cupsdLogJob(job, CUPSD_LOG_DEBUG, "PID %d (%s) exited with no errors.",
1593 pid, name);
1594 }
1595
1596 /*
1597 * If wait*() is interrupted by a signal, tell main() to call us again...
1598 */
1599
1600 if (pid < 0 && errno == EINTR)
1601 dead_children = 1;
1602 }
1603
1604
1605 /*
1606 * 'select_timeout()' - Calculate the select timeout value.
1607 *
1608 */
1609
1610 static long /* O - Number of seconds */
1611 select_timeout(int fds) /* I - Number of descriptors returned */
1612 {
1613 long timeout; /* Timeout for select */
1614 time_t now; /* Current time */
1615 cupsd_client_t *con; /* Client information */
1616 cupsd_job_t *job; /* Job information */
1617 cupsd_printer_t *printer; /* Printer information */
1618 const char *why; /* Debugging aid */
1619
1620
1621 cupsdLogMessage(CUPSD_LOG_DEBUG2, "select_timeout: JobHistoryUpdate=%ld",
1622 (long)JobHistoryUpdate);
1623
1624 /*
1625 * Check to see if any of the clients have pending data to be
1626 * processed; if so, the timeout should be 0...
1627 */
1628
1629 for (con = (cupsd_client_t *)cupsArrayFirst(Clients);
1630 con;
1631 con = (cupsd_client_t *)cupsArrayNext(Clients))
1632 if (httpGetReady(con->http))
1633 return (0);
1634
1635 /*
1636 * If select has been active in the last second (fds > 0) or we have
1637 * many resources in use then don't bother trying to optimize the
1638 * timeout, just make it 1 second.
1639 */
1640
1641 if (fds > 0 || cupsArrayCount(Clients) > 50)
1642 return (1);
1643
1644 /*
1645 * Otherwise, check all of the possible events that we need to wake for...
1646 */
1647
1648 now = time(NULL);
1649 timeout = now + 86400; /* 86400 == 1 day */
1650 why = "do nothing";
1651
1652 #ifdef __APPLE__
1653 /*
1654 * When going to sleep, wake up to abort jobs that don't complete in time.
1655 */
1656
1657 if (SleepJobs > 0 && SleepJobs < timeout)
1658 {
1659 timeout = SleepJobs;
1660 why = "abort jobs before sleeping";
1661 }
1662 #endif /* __APPLE__ */
1663
1664 /*
1665 * Check whether we are accepting new connections...
1666 */
1667
1668 if (ListeningPaused > 0 && cupsArrayCount(Clients) < MaxClients &&
1669 ListeningPaused < timeout)
1670 {
1671 if (ListeningPaused <= now)
1672 timeout = now;
1673 else
1674 timeout = ListeningPaused;
1675
1676 why = "resume listening";
1677 }
1678
1679 /*
1680 * Check the activity and close old clients...
1681 */
1682
1683 for (con = (cupsd_client_t *)cupsArrayFirst(Clients);
1684 con;
1685 con = (cupsd_client_t *)cupsArrayNext(Clients))
1686 if ((httpGetActivity(con->http) + Timeout) < timeout)
1687 {
1688 timeout = httpGetActivity(con->http) + Timeout;
1689 why = "timeout a client connection";
1690 }
1691
1692 /*
1693 * Write out changes to configuration and state files...
1694 */
1695
1696 if (DirtyCleanTime && timeout > DirtyCleanTime)
1697 {
1698 timeout = DirtyCleanTime;
1699 why = "write dirty config/state files";
1700 }
1701
1702 /*
1703 * Check for any job activity...
1704 */
1705
1706 if (JobHistoryUpdate && timeout > JobHistoryUpdate)
1707 {
1708 timeout = JobHistoryUpdate;
1709 why = "update job history";
1710 }
1711
1712 for (job = (cupsd_job_t *)cupsArrayFirst(ActiveJobs);
1713 job;
1714 job = (cupsd_job_t *)cupsArrayNext(ActiveJobs))
1715 {
1716 if (job->cancel_time && job->cancel_time < timeout)
1717 {
1718 timeout = job->cancel_time;
1719 why = "cancel stuck jobs";
1720 }
1721
1722 if (job->kill_time && job->kill_time < timeout)
1723 {
1724 timeout = job->kill_time;
1725 why = "kill unresponsive jobs";
1726 }
1727
1728 if (job->state_value == IPP_JOB_HELD && job->hold_until < timeout)
1729 {
1730 timeout = job->hold_until;
1731 why = "release held jobs";
1732 }
1733
1734 if (job->state_value == IPP_JOB_PENDING && timeout > (now + 10))
1735 {
1736 timeout = now + 10;
1737 why = "start pending jobs";
1738 break;
1739 }
1740 }
1741
1742 /*
1743 * Check for temporary printers that need to be deleted...
1744 */
1745
1746 for (printer = (cupsd_printer_t *)cupsArrayFirst(Printers); printer; printer = (cupsd_printer_t *)cupsArrayNext(Printers))
1747 {
1748 if (printer->temporary && !printer->job && (!local_timeout || local_timeout > (printer->state_time + 60)))
1749 local_timeout = printer->state_time + 60;
1750 }
1751
1752 if (timeout > local_timeout && local_timeout)
1753 {
1754 timeout = local_timeout;
1755 why = "delete stale local printers";
1756 }
1757
1758 /*
1759 * Adjust from absolute to relative time. We add 1 second to the timeout since
1760 * events occur after the timeout expires, and limit the timeout to 86400
1761 * seconds (1 day) to avoid select() timeout limits present on some operating
1762 * systems...
1763 */
1764
1765 timeout = timeout - now + 1;
1766
1767 if (timeout < 1)
1768 timeout = 1;
1769 else if (timeout > 86400)
1770 timeout = 86400;
1771
1772 /*
1773 * Log and return the timeout value...
1774 */
1775
1776 cupsdLogMessage(CUPSD_LOG_DEBUG2, "select_timeout(%d): %ld seconds to %s",
1777 fds, timeout, why);
1778
1779 return (timeout);
1780 }
1781
1782
1783 /*
1784 * 'sigchld_handler()' - Handle 'child' signals from old processes.
1785 */
1786
1787 static void
1788 sigchld_handler(int sig) /* I - Signal number */
1789 {
1790 (void)sig;
1791
1792 /*
1793 * Flag that we have dead children...
1794 */
1795
1796 dead_children = 1;
1797
1798 /*
1799 * Reset the signal handler as needed...
1800 */
1801
1802 #if !defined(HAVE_SIGSET) && !defined(HAVE_SIGACTION)
1803 signal(SIGCLD, sigchld_handler);
1804 #endif /* !HAVE_SIGSET && !HAVE_SIGACTION */
1805 }
1806
1807
1808 /*
1809 * 'sighup_handler()' - Handle 'hangup' signals to reconfigure the scheduler.
1810 */
1811
1812 static void
1813 sighup_handler(int sig) /* I - Signal number */
1814 {
1815 (void)sig;
1816
1817 NeedReload = RELOAD_ALL;
1818 ReloadTime = time(NULL);
1819
1820 #if !defined(HAVE_SIGSET) && !defined(HAVE_SIGACTION)
1821 signal(SIGHUP, sighup_handler);
1822 #endif /* !HAVE_SIGSET && !HAVE_SIGACTION */
1823 }
1824
1825
1826 /*
1827 * 'sigterm_handler()' - Handle 'terminate' signals that stop the scheduler.
1828 */
1829
1830 static void
1831 sigterm_handler(int sig) /* I - Signal number */
1832 {
1833 (void)sig; /* remove compiler warnings... */
1834
1835 /*
1836 * Flag that we should stop and return...
1837 */
1838
1839 stop_scheduler = 1;
1840 }
1841
1842
1843 #ifdef HAVE_ONDEMAND
1844 /*
1845 * 'service_add_listener()' - Bind an open fd as a Listener.
1846 */
1847
1848 static void
1849 service_add_listener(int fd, /* I - Socket file descriptor */
1850 int idx) /* I - Listener number, for logging */
1851 {
1852 cupsd_listener_t *lis; /* Listeners array */
1853 http_addr_t addr; /* Address variable */
1854 socklen_t addrlen; /* Length of address */
1855 char s[256]; /* String addresss */
1856
1857
1858 addrlen = sizeof(addr);
1859
1860 if (getsockname(fd, (struct sockaddr *)&addr, &addrlen))
1861 {
1862 cupsdLogMessage(CUPSD_LOG_ERROR, "service_add_listener: Unable to get local address for listener #%d: %s", idx + 1, strerror(errno));
1863 return;
1864 }
1865
1866 cupsdLogMessage(CUPSD_LOG_DEBUG, "service_add_listener: Listener #%d at fd %d, \"%s\".", idx + 1, fd, httpAddrString(&addr, s, sizeof(s)));
1867
1868 /*
1869 * Try to match the on-demand socket address to one of the listeners...
1870 */
1871
1872 for (lis = (cupsd_listener_t *)cupsArrayFirst(Listeners);
1873 lis;
1874 lis = (cupsd_listener_t *)cupsArrayNext(Listeners))
1875 if (httpAddrEqual(&lis->address, &addr))
1876 break;
1877
1878 /*
1879 * Add a new listener If there's no match...
1880 */
1881
1882 if (lis)
1883 {
1884 cupsdLogMessage(CUPSD_LOG_DEBUG, "service_add_listener: Matched existing listener #%d to %s.", idx + 1, httpAddrString(&(lis->address), s, sizeof(s)));
1885 }
1886 else
1887 {
1888 cupsdLogMessage(CUPSD_LOG_DEBUG, "service_add_listener: Adding new listener #%d for %s.", idx + 1, httpAddrString(&addr, s, sizeof(s)));
1889
1890 if ((lis = calloc(1, sizeof(cupsd_listener_t))) == NULL)
1891 {
1892 cupsdLogMessage(CUPSD_LOG_ERROR, "service_add_listener: Unable to allocate listener: %s.", strerror(errno));
1893 exit(EXIT_FAILURE);
1894 return;
1895 }
1896
1897 cupsArrayAdd(Listeners, lis);
1898
1899 memcpy(&lis->address, &addr, sizeof(lis->address));
1900 }
1901
1902 lis->fd = fd;
1903 lis->on_demand = 1;
1904
1905 # ifdef HAVE_SSL
1906 if (httpAddrPort(&(lis->address)) == 443)
1907 lis->encryption = HTTP_ENCRYPT_ALWAYS;
1908 # endif /* HAVE_SSL */
1909 }
1910 #endif /* HAVE_ONDEMAND */
1911
1912
1913 /*
1914 * 'service_checkin()' - Check-in with launchd and collect the listening fds.
1915 */
1916
1917 static void
1918 service_checkin(void)
1919 {
1920 cupsdLogMessage(CUPSD_LOG_DEBUG, "service_checkin: pid=%d", (int)getpid());
1921
1922 #ifdef HAVE_LAUNCHD
1923 if (OnDemand)
1924 {
1925 int error; /* Check-in error, if any */
1926 size_t i, /* Looping var */
1927 count; /* Number of listeners */
1928 int *ld_sockets; /* Listener sockets */
1929
1930 # ifdef __APPLE__
1931 /*
1932 * Force "user initiated" priority for the main thread...
1933 */
1934
1935 pthread_set_qos_class_self_np(QOS_CLASS_USER_INITIATED, 0);
1936 # endif /* __APPLE__ */
1937
1938 /*
1939 * Check-in with launchd...
1940 */
1941
1942 if ((error = launch_activate_socket("Listeners", &ld_sockets, &count)) != 0)
1943 {
1944 cupsdLogMessage(CUPSD_LOG_ERROR, "service_checkin: Unable to get listener sockets: %s", strerror(error));
1945 exit(EXIT_FAILURE);
1946 return; /* anti-compiler-warning */
1947 }
1948
1949 /*
1950 * Try to match the launchd sockets to the cupsd listeners...
1951 */
1952
1953 cupsdLogMessage(CUPSD_LOG_DEBUG, "service_checkin: %d listeners.", (int)count);
1954
1955 for (i = 0; i < count; i ++)
1956 service_add_listener(ld_sockets[i], (int)i);
1957
1958 free(ld_sockets);
1959
1960 # ifdef __APPLE__
1961 xpc_transaction_begin();
1962 # endif /* __APPLE__ */
1963 }
1964
1965 #elif defined(HAVE_SYSTEMD)
1966 if (OnDemand)
1967 {
1968 int i, /* Looping var */
1969 count; /* Number of listeners */
1970
1971 /*
1972 * Check-in with systemd...
1973 */
1974
1975 if ((count = sd_listen_fds(0)) < 0)
1976 {
1977 cupsdLogMessage(CUPSD_LOG_ERROR, "service_checkin: Unable to get listener sockets: %s", strerror(-count));
1978 exit(EXIT_FAILURE);
1979 return; /* anti-compiler-warning */
1980 }
1981
1982 /*
1983 * Try to match the systemd sockets to the cupsd listeners...
1984 */
1985
1986 cupsdLogMessage(CUPSD_LOG_DEBUG, "service_checkin: %d listeners.", count);
1987
1988 for (i = 0; i < count; i ++)
1989 service_add_listener(SD_LISTEN_FDS_START + i, i);
1990 }
1991
1992 #elif defined(HAVE_UPSTART)
1993 if (OnDemand)
1994 {
1995 const char *e; /* Environment var */
1996 int fd; /* File descriptor */
1997
1998
1999 if (!(e = getenv("UPSTART_EVENTS")))
2000 {
2001 cupsdLogMessage(CUPSD_LOG_ERROR, "service_checkin: We did not get started via Upstart.");
2002 exit(EXIT_FAILURE);
2003 return;
2004 }
2005
2006 if (strcasecmp(e, "socket"))
2007 {
2008 cupsdLogMessage(CUPSD_LOG_ERROR, "service_checkin: We did not get triggered via an Upstart socket event.");
2009 exit(EXIT_FAILURE);
2010 return;
2011 }
2012
2013 if ((e = getenv("UPSTART_FDS")) == NULL)
2014 {
2015 cupsdLogMessage(CUPSD_LOG_ERROR, "service_checkin: Unable to get listener sockets from UPSTART_FDS.");
2016 exit(EXIT_FAILURE);
2017 return;
2018 }
2019
2020 cupsdLogMessage(CUPSD_LOG_DEBUG, "service_checkin: UPSTART_FDS=%s", e);
2021
2022 fd = (int)strtol(e, NULL, 10);
2023 if (fd < 0)
2024 {
2025 cupsdLogMessage(CUPSD_LOG_ERROR, "service_checkin: Could not parse UPSTART_FDS: %s", strerror(errno));
2026 exit(EXIT_FAILURE);
2027 return;
2028 }
2029
2030 /*
2031 * Upstart only supportst a single on-demand socket file descriptor...
2032 */
2033
2034 service_add_listener(fd, 0);
2035 }
2036 #endif /* HAVE_LAUNCHD */
2037 }
2038
2039
2040 /*
2041 * 'service_checkout()' - Update the KeepAlive/PID file as needed.
2042 */
2043
2044 static void
2045 service_checkout(int shutdown) /* I - Shutting down? */
2046 {
2047 cups_file_t *fp; /* File */
2048 char pidfile[1024]; /* PID/KeepAlive file */
2049
2050
2051 /*
2052 * When running on-demand, use the KeepAlive file, otherwise write a PID file
2053 * to StateDir...
2054 */
2055
2056 #ifdef HAVE_ONDEMAND
2057 if (OnDemand)
2058 {
2059 strlcpy(pidfile, CUPS_KEEPALIVE, sizeof(pidfile));
2060
2061 if (cupsArrayCount(ActiveJobs) || /* Active jobs */
2062 WebInterface || /* Web interface enabled */
2063 NeedReload || /* Doing a reload */
2064 (Browsing && BrowseLocalProtocols && cupsArrayCount(Printers)))
2065 /* Printers being shared */
2066 {
2067 /*
2068 * Create or remove the "keep-alive" file based on whether there are active
2069 * jobs or shared printers to advertise...
2070 */
2071
2072 shutdown = 0;
2073 }
2074 }
2075 else
2076 #endif /* HAVE_ONDEMAND */
2077 snprintf(pidfile, sizeof(pidfile), "%s/cupsd.pid", StateDir);
2078
2079 if (shutdown)
2080 {
2081 cupsdLogMessage(CUPSD_LOG_DEBUG, "Removing KeepAlive/PID file \"%s\".", pidfile);
2082
2083 unlink(pidfile);
2084 }
2085 else
2086 {
2087 cupsdLogMessage(CUPSD_LOG_DEBUG, "Creating KeepAlive/PID file \"%s\".", pidfile);
2088
2089 if ((fp = cupsFileOpen(pidfile, "w")) != NULL)
2090 {
2091 /*
2092 * Save the PID in the file...
2093 */
2094
2095 cupsFilePrintf(fp, "%d\n", (int)getpid());
2096 cupsFileClose(fp);
2097 }
2098 else
2099 cupsdLogMessage(CUPSD_LOG_ERROR, "Unable to create KeepAlive/PID file \"%s\": %s", pidfile, strerror(errno));
2100 }
2101
2102 # ifdef __APPLE__
2103 if (OnDemand && shutdown)
2104 xpc_transaction_end();
2105 # endif /* __APPLE__ */
2106 }
2107
2108
2109 /*
2110 * 'usage()' - Show scheduler usage.
2111 */
2112
2113 static void
2114 usage(int status) /* O - Exit status */
2115 {
2116 FILE *fp = status ? stderr : stdout; /* Output file */
2117
2118
2119 _cupsLangPuts(fp, _("Usage: cupsd [options]"));
2120 _cupsLangPuts(fp, _("Options:"));
2121 _cupsLangPuts(fp, _(" -c cupsd.conf Set cupsd.conf file to use."));
2122 _cupsLangPuts(fp, _(" -f Run in the foreground."));
2123 _cupsLangPuts(fp, _(" -F Run in the foreground but detach from console."));
2124 _cupsLangPuts(fp, _(" -h Show this usage message."));
2125 #ifdef HAVE_ONDEMAND
2126 _cupsLangPuts(fp, _(" -l Run cupsd on demand."));
2127 #endif /* HAVE_ONDEMAND */
2128 _cupsLangPuts(fp, _(" -s cups-files.conf Set cups-files.conf file to use."));
2129 _cupsLangPuts(fp, _(" -t Test the configuration file."));
2130
2131 exit(status);
2132 }