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