2 Unix SMB/Netbios implementation.
4 Copyright (C) Simo Sorce <idra@samba.org> 2010-2011
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "smbd/smbd.h"
23 #include "lib/util/util_process.h"
26 #include "include/printing.h"
27 #include "printing/nt_printing_migrate_internal.h"
28 #include "printing/queue_process.h"
29 #include "printing/pcap.h"
30 #include "printing/load.h"
32 #include "librpc/gen_ndr/srv_winreg.h"
33 #include "librpc/gen_ndr/srv_spoolss.h"
34 #include "rpc_server/rpc_server.h"
35 #include "rpc_server/rpc_ep_register.h"
36 #include "rpc_server/spoolss/srv_spoolss_nt.h"
37 #include "librpc/rpc/dcerpc_ep.h"
38 #include "lib/server_prefork.h"
39 #include "lib/server_prefork_util.h"
41 #define SPOOLSS_PIPE_NAME "spoolss"
42 #define DAEMON_NAME "spoolssd"
44 static struct server_id parent_id;
45 static struct prefork_pool *spoolss_pool = NULL;
46 static int spoolss_child_id = 0;
48 static struct pf_daemon_config default_pf_spoolss_cfg = {
49 .prefork_status = PFH_INIT,
53 .max_allowed_clients = 100,
54 .child_min_life = 60 /* 1 minute minimum life time */
56 static struct pf_daemon_config pf_spoolss_cfg = { 0 };
58 pid_t start_spoolssd(struct tevent_context *ev_ctx,
59 struct messaging_context *msg_ctx);
61 static void spoolss_reopen_logs(int child_id)
63 char *lfile = lp_logfile(talloc_tos());
68 rc = asprintf(&ext, "%s.%d", DAEMON_NAME, child_id);
70 rc = asprintf(&ext, "%s", DAEMON_NAME);
78 if (lfile == NULL || lfile[0] == '\0') {
79 rc = asprintf(&lfile, "%s/log.%s",
80 get_dyn_LOGFILEBASE(), ext);
82 if (strstr(lfile, ext) == NULL) {
84 rc = asprintf(&lfile, "%s.%d",
85 lp_logfile(talloc_tos()),
88 rc = asprintf(&lfile, "%s.%s",
89 lp_logfile(talloc_tos()),
96 lp_set_logfile(lfile);
105 static void update_conf(struct tevent_context *ev,
106 struct messaging_context *msg)
108 change_to_root_user();
109 lp_load(get_dyn_CONFIGFILE(), true, false, false, true);
110 load_printers(ev, msg);
112 spoolss_reopen_logs(spoolss_child_id);
113 if (spoolss_child_id == 0) {
114 pfh_daemon_config(DAEMON_NAME,
116 &default_pf_spoolss_cfg);
117 pfh_manage_pool(ev, msg, &pf_spoolss_cfg, spoolss_pool);
121 static void smb_conf_updated(struct messaging_context *msg,
124 struct server_id server_id,
127 struct tevent_context *ev_ctx = talloc_get_type_abort(private_data,
128 struct tevent_context);
130 DEBUG(10, ("Got message saying smb.conf was updated. Reloading.\n"));
131 update_conf(ev_ctx, msg);
134 static void update_pcap(struct tevent_context *ev_ctx,
135 struct messaging_context *msg_ctx)
137 change_to_root_user();
138 delete_and_reload_printers(ev_ctx, msg_ctx);
141 static void pcap_updated(struct messaging_context *msg,
144 struct server_id server_id,
147 struct tevent_context *ev_ctx;
149 ev_ctx = talloc_get_type_abort(private_data, struct tevent_context);
151 DEBUG(10, ("Got message that pcap updated. Reloading.\n"));
152 update_pcap(ev_ctx, msg);
155 static void spoolss_sig_term_handler(struct tevent_context *ev,
156 struct tevent_signal *se,
162 exit_server_cleanly("termination signal");
165 static void spoolss_setup_sig_term_handler(struct tevent_context *ev_ctx)
167 struct tevent_signal *se;
169 se = tevent_add_signal(ev_ctx,
172 spoolss_sig_term_handler,
175 exit_server("failed to setup SIGTERM handler");
179 static void spoolss_sig_hup_handler(struct tevent_context *ev,
180 struct tevent_signal *se,
186 struct messaging_context *msg_ctx;
188 msg_ctx = talloc_get_type_abort(pvt, struct messaging_context);
190 DEBUG(1,("Reloading printers after SIGHUP\n"));
191 update_conf(ev, msg_ctx);
193 /* relay to all children */
195 prefork_send_signal_to_all(spoolss_pool, SIGHUP);
199 static void spoolss_setup_sig_hup_handler(struct tevent_context *ev_ctx,
200 struct messaging_context *msg_ctx)
202 struct tevent_signal *se;
204 se = tevent_add_signal(ev_ctx,
207 spoolss_sig_hup_handler,
210 exit_server("failed to setup SIGHUP handler");
214 static bool spoolss_init_cb(void *ptr)
216 struct messaging_context *msg_ctx = talloc_get_type_abort(
217 ptr, struct messaging_context);
219 return nt_printing_tdb_migrate(msg_ctx);
222 static bool spoolss_shutdown_cb(void *ptr)
224 srv_spoolss_cleanup();
231 static void spoolss_chld_sig_hup_handler(struct tevent_context *ev,
232 struct tevent_signal *se,
238 struct messaging_context *msg_ctx;
240 msg_ctx = talloc_get_type_abort(pvt, struct messaging_context);
242 change_to_root_user();
243 DEBUG(1,("Reloading printers after SIGHUP\n"));
244 load_printers(ev, msg_ctx);
245 spoolss_reopen_logs(spoolss_child_id);
248 static bool spoolss_setup_chld_hup_handler(struct tevent_context *ev_ctx,
249 struct messaging_context *msg_ctx,
250 struct pf_worker_data *pf)
252 struct tevent_signal *se;
254 se = tevent_add_signal(ev_ctx,
257 spoolss_chld_sig_hup_handler,
260 DEBUG(1, ("failed to setup SIGHUP handler"));
267 static void parent_ping(struct messaging_context *msg_ctx,
270 struct server_id server_id,
274 /* The fact we received this message is enough to let make the event
275 * loop if it was idle. spoolss_children_main will cycle through
276 * spoolss_next_client at least once. That function will take whatever
277 * action is necessary */
279 DEBUG(10, ("Got message that the parent changed status.\n"));
283 static bool spoolss_child_init(struct tevent_context *ev_ctx,
284 int child_id, struct pf_worker_data *pf)
287 struct rpc_srv_callbacks spoolss_cb;
288 struct messaging_context *msg_ctx = messaging_init(NULL, ev_ctx);
291 status = reinit_after_fork(msg_ctx, ev_ctx,
293 if (!NT_STATUS_IS_OK(status)) {
294 DEBUG(0,("reinit_after_fork() failed\n"));
295 smb_panic("reinit_after_fork() failed");
298 prctl_set_comment("spoolssd-child");
300 spoolss_child_id = child_id;
301 spoolss_reopen_logs(child_id);
303 ok = spoolss_setup_chld_hup_handler(ev_ctx, msg_ctx, pf);
308 if (!serverid_register(messaging_server_id(msg_ctx),
310 FLAG_MSG_PRINT_GENERAL)) {
314 if (!locking_init()) {
318 messaging_register(msg_ctx, ev_ctx,
319 MSG_SMB_CONF_UPDATED, smb_conf_updated);
320 messaging_register(msg_ctx, ev_ctx, MSG_PRINTER_PCAP,
322 messaging_register(msg_ctx, ev_ctx,
323 MSG_PREFORK_PARENT_EVENT, parent_ping);
325 /* As soon as messaging is up check if pcap has been loaded already.
326 * If so then we probably missed a message and should load_printers()
327 * ourselves. If pcap has not been loaded yet, then ignore, we will get
328 * a message as soon as the bq process completes the reload. */
329 if (pcap_cache_loaded()) {
330 load_printers(ev_ctx, msg_ctx);
333 /* try to reinit rpc queues */
334 spoolss_cb.init = spoolss_init_cb;
335 spoolss_cb.shutdown = spoolss_shutdown_cb;
336 spoolss_cb.private_data = msg_ctx;
338 status = rpc_winreg_init(NULL);
339 if (!NT_STATUS_IS_OK(status)) {
340 DEBUG(0, ("Failed to register winreg rpc inteface! (%s)\n",
345 status = rpc_spoolss_init(&spoolss_cb);
346 if (!NT_STATUS_IS_OK(status)) {
347 DEBUG(0, ("Failed to register spoolss rpc inteface! (%s)\n",
355 struct spoolss_children_data {
356 struct tevent_context *ev_ctx;
357 struct messaging_context *msg_ctx;
358 struct pf_worker_data *pf;
363 static void spoolss_next_client(void *pvt);
365 static int spoolss_children_main(struct tevent_context *ev_ctx,
366 struct messaging_context *msg_ctx,
367 struct pf_worker_data *pf,
373 struct spoolss_children_data *data;
377 ok = spoolss_child_init(ev_ctx, child_id, pf);
382 data = talloc(ev_ctx, struct spoolss_children_data);
387 data->ev_ctx = ev_ctx;
388 data->msg_ctx = msg_ctx;
389 data->listen_fd_size = listen_fd_size;
390 data->listen_fds = listen_fds;
392 /* loop until it is time to exit */
393 while (pf->status != PF_WORKER_EXITING) {
394 /* try to see if it is time to schedule the next client */
395 spoolss_next_client(data);
397 ret = tevent_loop_once(ev_ctx);
399 DEBUG(0, ("tevent_loop_once() exited with %d: %s\n",
400 ret, strerror(errno)));
401 pf->status = PF_WORKER_EXITING;
408 static void spoolss_client_terminated(void *pvt)
410 struct spoolss_children_data *data;
412 data = talloc_get_type_abort(pvt, struct spoolss_children_data);
414 pfh_client_terminated(data->pf);
416 spoolss_next_client(pvt);
419 struct spoolss_new_client {
420 struct spoolss_children_data *data;
421 struct tsocket_address *srv_addr;
422 struct tsocket_address *cli_addr;
425 static void spoolss_handle_client(struct tevent_req *req);
427 static void spoolss_next_client(void *pvt)
429 struct tevent_req *req;
430 struct spoolss_children_data *data;
431 struct spoolss_new_client *next;
433 data = talloc_get_type_abort(pvt, struct spoolss_children_data);
435 if (!pfh_child_allowed_to_accept(data->pf)) {
436 /* nothing to do for now we are already listening
437 * or we are not allowed to listen further */
441 next = talloc_zero(data, struct spoolss_new_client);
443 DEBUG(1, ("Out of memory!?\n"));
448 req = prefork_listen_send(next, data->ev_ctx, data->pf,
449 data->listen_fd_size,
452 DEBUG(1, ("Failed to make listening request!?\n"));
456 tevent_req_set_callback(req, spoolss_handle_client, next);
459 static void spoolss_handle_client(struct tevent_req *req)
461 struct spoolss_children_data *data;
462 struct spoolss_new_client *client;
463 const DATA_BLOB ping = data_blob_null;
467 client = tevent_req_callback_data(req, struct spoolss_new_client);
470 ret = prefork_listen_recv(req, client, &sd,
471 &client->srv_addr, &client->cli_addr);
473 /* this will free the request too */
477 DEBUG(6, ("No client connection was available after all!\n"));
481 /* Warn parent that our status changed */
482 messaging_send(data->msg_ctx, parent_id,
483 MSG_PREFORK_CHILD_EVENT, &ping);
485 DEBUG(2, ("Spoolss preforked child %d got client connection!\n",
486 (int)(data->pf->pid)));
488 named_pipe_accept_function(data->ev_ctx, data->msg_ctx,
489 SPOOLSS_PIPE_NAME, sd,
490 spoolss_client_terminated, data);
493 /* ==== Main Process Functions ==== */
495 extern pid_t background_lpq_updater_pid;
496 static char *bq_logfile;
498 static void check_updater_child(struct tevent_context *ev_ctx,
499 struct messaging_context *msg_ctx)
504 if (background_lpq_updater_pid == -1) {
508 pid = sys_waitpid(background_lpq_updater_pid, &status, WNOHANG);
510 DEBUG(2, ("The background queue child died... Restarting!\n"));
511 pid = start_background_queue(ev_ctx, msg_ctx, bq_logfile);
512 background_lpq_updater_pid = pid;
516 static void child_ping(struct messaging_context *msg_ctx,
519 struct server_id server_id,
522 struct tevent_context *ev_ctx;
524 ev_ctx = talloc_get_type_abort(private_data, struct tevent_context);
526 DEBUG(10, ("Got message that a child changed status.\n"));
527 pfh_manage_pool(ev_ctx, msg_ctx, &pf_spoolss_cfg, spoolss_pool);
530 static bool spoolssd_schedule_check(struct tevent_context *ev_ctx,
531 struct messaging_context *msg_ctx,
532 struct timeval current_time);
533 static void spoolssd_check_children(struct tevent_context *ev_ctx,
534 struct tevent_timer *te,
535 struct timeval current_time,
538 static void spoolssd_sigchld_handler(struct tevent_context *ev_ctx,
539 struct prefork_pool *pfp,
542 struct messaging_context *msg_ctx;
544 msg_ctx = talloc_get_type_abort(pvt, struct messaging_context);
546 /* run pool management so we can fork/retire or increase
547 * the allowed connections per child based on load */
548 pfh_manage_pool(ev_ctx, msg_ctx, &pf_spoolss_cfg, spoolss_pool);
550 /* also check if the updater child is alive and well */
551 check_updater_child(ev_ctx, msg_ctx);
554 static bool spoolssd_setup_children_monitor(struct tevent_context *ev_ctx,
555 struct messaging_context *msg_ctx)
559 /* add our oun sigchld callback */
560 prefork_set_sigchld_callback(spoolss_pool,
561 spoolssd_sigchld_handler, msg_ctx);
563 ok = spoolssd_schedule_check(ev_ctx, msg_ctx,
564 tevent_timeval_current());
568 static bool spoolssd_schedule_check(struct tevent_context *ev_ctx,
569 struct messaging_context *msg_ctx,
570 struct timeval current_time)
572 struct tevent_timer *te;
573 struct timeval next_event;
575 /* check situation again in 10 seconds */
576 next_event = tevent_timeval_current_ofs(10, 0);
578 /* TODO: check when the socket becomes readable, so that children
579 * are checked only when there is some activity ? */
580 te = tevent_add_timer(ev_ctx, spoolss_pool, next_event,
581 spoolssd_check_children, msg_ctx);
583 DEBUG(2, ("Failed to set up children monitoring!\n"));
590 static void spoolssd_check_children(struct tevent_context *ev_ctx,
591 struct tevent_timer *te,
592 struct timeval current_time,
595 struct messaging_context *msg_ctx;
597 msg_ctx = talloc_get_type_abort(pvt, struct messaging_context);
599 pfh_manage_pool(ev_ctx, msg_ctx, &pf_spoolss_cfg, spoolss_pool);
601 spoolssd_schedule_check(ev_ctx, msg_ctx, current_time);
604 static void print_queue_forward(struct messaging_context *msg,
607 struct server_id server_id,
610 messaging_send_buf(msg, pid_to_procid(background_lpq_updater_pid),
611 MSG_PRINTER_UPDATE, data->data, data->length);
614 static char *get_bq_logfile(void)
616 char *lfile = lp_logfile(talloc_tos());
619 if (lfile == NULL || lfile[0] == '\0') {
620 rc = asprintf(&lfile, "%s/log.%s.bq",
621 get_dyn_LOGFILEBASE(), DAEMON_NAME);
623 rc = asprintf(&lfile, "%s.bq", lp_logfile(talloc_tos()));
631 pid_t start_spoolssd(struct tevent_context *ev_ctx,
632 struct messaging_context *msg_ctx)
634 struct rpc_srv_callbacks spoolss_cb;
635 struct dcerpc_binding_vector *v;
643 DEBUG(1, ("Forking SPOOLSS Daemon\n"));
646 * Block signals before forking child as it will have to
647 * set its own handlers. Child will re-enable SIGHUP as
648 * soon as the handlers are set up.
650 BlockSignals(true, SIGTERM);
651 BlockSignals(true, SIGHUP);
656 DEBUG(0, ("Failed to fork SPOOLSS [%s]\n",
660 /* parent or error */
663 /* Re-enable SIGHUP before returnig */
664 BlockSignals(false, SIGTERM);
665 BlockSignals(false, SIGHUP);
669 status = reinit_after_fork(msg_ctx,
672 if (!NT_STATUS_IS_OK(status)) {
673 DEBUG(0,("reinit_after_fork() failed\n"));
674 smb_panic("reinit_after_fork() failed");
677 prctl_set_comment("spoolssd-master");
679 /* save the parent process id so the children can use it later */
680 parent_id = messaging_server_id(msg_ctx);
682 spoolss_reopen_logs(0);
683 pfh_daemon_config(DAEMON_NAME,
685 &default_pf_spoolss_cfg);
687 spoolss_setup_sig_term_handler(ev_ctx);
688 spoolss_setup_sig_hup_handler(ev_ctx, msg_ctx);
690 BlockSignals(false, SIGTERM);
691 BlockSignals(false, SIGHUP);
693 /* always start the backgroundqueue listner in spoolssd */
694 bq_logfile = get_bq_logfile();
695 pid = start_background_queue(ev_ctx, msg_ctx, bq_logfile);
697 background_lpq_updater_pid = pid;
700 /* the listening fd must be created before the children are actually
702 listen_fd = create_named_pipe_socket(SPOOLSS_PIPE_NAME);
703 if (listen_fd == -1) {
707 ret = listen(listen_fd, pf_spoolss_cfg.max_allowed_clients);
709 DEBUG(0, ("Failed to listen on spoolss pipe - %s\n",
714 /* start children before any more initialization is done */
715 ok = prefork_create_pool(ev_ctx, /* mem_ctx */
718 pf_spoolss_cfg.min_children,
719 pf_spoolss_cfg.max_children,
720 &spoolss_children_main, NULL,
726 if (!serverid_register(messaging_server_id(msg_ctx),
728 FLAG_MSG_PRINT_GENERAL)) {
732 if (!locking_init()) {
736 messaging_register(msg_ctx, ev_ctx,
737 MSG_SMB_CONF_UPDATED, smb_conf_updated);
738 messaging_register(msg_ctx, NULL, MSG_PRINTER_UPDATE,
739 print_queue_forward);
740 messaging_register(msg_ctx, ev_ctx, MSG_PRINTER_PCAP,
742 messaging_register(msg_ctx, ev_ctx,
743 MSG_PREFORK_CHILD_EVENT, child_ping);
745 /* As soon as messaging is up check if pcap has been loaded already.
746 * If so then we probably missed a message and should load_printers()
747 * ourselves. If pcap has not been loaded yet, then ignore, we will get
748 * a message as soon as the bq process completes the reload. */
749 if (pcap_cache_loaded()) {
750 load_printers(ev_ctx, msg_ctx);
753 mem_ctx = talloc_new(NULL);
754 if (mem_ctx == NULL) {
759 * Initialize spoolss with an init function to convert printers first.
760 * static_init_rpc will try to initialize the spoolss server too but you
761 * can't register it twice.
763 spoolss_cb.init = spoolss_init_cb;
764 spoolss_cb.shutdown = spoolss_shutdown_cb;
765 spoolss_cb.private_data = msg_ctx;
767 status = rpc_winreg_init(NULL);
768 if (!NT_STATUS_IS_OK(status)) {
769 DEBUG(0, ("Failed to register winreg rpc inteface! (%s)\n",
774 status = rpc_spoolss_init(&spoolss_cb);
775 if (!NT_STATUS_IS_OK(status)) {
776 DEBUG(0, ("Failed to register spoolss rpc inteface! (%s)\n",
781 status = dcerpc_binding_vector_new(mem_ctx, &v);
782 if (!NT_STATUS_IS_OK(status)) {
783 DEBUG(0, ("Failed to create binding vector (%s)\n",
788 status = dcerpc_binding_vector_add_np_default(&ndr_table_spoolss, v);
789 if (!NT_STATUS_IS_OK(status)) {
790 DEBUG(0, ("Failed to add np to binding vector (%s)\n",
795 status = rpc_ep_register(ev_ctx, msg_ctx, &ndr_table_spoolss, v);
796 if (!NT_STATUS_IS_OK(status)) {
797 DEBUG(0, ("Failed to register spoolss endpoint! (%s)\n",
802 talloc_free(mem_ctx);
804 ok = spoolssd_setup_children_monitor(ev_ctx, msg_ctx);
806 DEBUG(0, ("Failed to setup children monitoring!\n"));
810 DEBUG(1, ("SPOOLSS Daemon Started (%u)\n", (unsigned int)getpid()));
812 pfh_manage_pool(ev_ctx, msg_ctx, &pf_spoolss_cfg, spoolss_pool);
815 ret = tevent_loop_wait(ev_ctx);
817 /* should not be reached */
818 DEBUG(0,("spoolssd tevent_loop_wait() exited with %d - %s\n",
819 ret, (ret == 0) ? "out of events" : strerror(errno)));