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"
24 #include "include/printing.h"
25 #include "printing/nt_printing_migrate_internal.h"
26 #include "printing/queue_process.h"
27 #include "printing/pcap.h"
28 #include "printing/load.h"
30 #include "librpc/gen_ndr/srv_winreg.h"
31 #include "librpc/gen_ndr/srv_spoolss.h"
32 #include "rpc_server/rpc_server.h"
33 #include "rpc_server/rpc_ep_register.h"
34 #include "rpc_server/spoolss/srv_spoolss_nt.h"
35 #include "librpc/rpc/dcerpc_ep.h"
36 #include "lib/server_prefork.h"
37 #include "lib/server_prefork_util.h"
39 #define SPOOLSS_PIPE_NAME "spoolss"
40 #define DAEMON_NAME "spoolssd"
42 static struct server_id parent_id;
43 static struct prefork_pool *spoolss_pool = NULL;
44 static int spoolss_child_id = 0;
46 static struct pf_daemon_config default_pf_spoolss_cfg = {
47 .prefork_status = PFH_INIT,
51 .max_allowed_clients = 100,
52 .child_min_life = 60 /* 1 minute minimum life time */
54 static struct pf_daemon_config pf_spoolss_cfg = { 0 };
56 pid_t start_spoolssd(struct tevent_context *ev_ctx,
57 struct messaging_context *msg_ctx);
59 static void spoolss_reopen_logs(int child_id)
61 char *lfile = lp_logfile();
66 rc = asprintf(&ext, "%s.%d", DAEMON_NAME, child_id);
68 rc = asprintf(&ext, "%s", DAEMON_NAME);
76 if (lfile == NULL || lfile[0] == '\0') {
77 rc = asprintf(&lfile, "%s/log.%s",
78 get_dyn_LOGFILEBASE(), ext);
80 if (strstr(lfile, ext) == NULL) {
82 rc = asprintf(&lfile, "%s.%d",
83 lp_logfile(), child_id);
85 rc = asprintf(&lfile, "%s.%s",
92 lp_set_logfile(lfile);
101 static void update_conf(struct tevent_context *ev,
102 struct messaging_context *msg)
104 change_to_root_user();
105 lp_load(get_dyn_CONFIGFILE(), true, false, false, true);
106 reload_printers(ev, msg);
108 spoolss_reopen_logs(spoolss_child_id);
109 if (spoolss_child_id == 0) {
110 pfh_daemon_config(DAEMON_NAME,
112 &default_pf_spoolss_cfg);
113 pfh_manage_pool(ev, msg, &pf_spoolss_cfg, spoolss_pool);
117 static void smb_conf_updated(struct messaging_context *msg,
120 struct server_id server_id,
123 struct tevent_context *ev_ctx = talloc_get_type_abort(private_data,
124 struct tevent_context);
126 DEBUG(10, ("Got message saying smb.conf was updated. Reloading.\n"));
127 update_conf(ev_ctx, msg);
130 static void update_pcap(struct tevent_context *ev_ctx,
131 struct messaging_context *msg_ctx)
133 change_to_root_user();
134 reload_printers(ev_ctx, msg_ctx);
137 static void pcap_updated(struct messaging_context *msg,
140 struct server_id server_id,
143 struct tevent_context *ev_ctx;
145 ev_ctx = talloc_get_type_abort(private_data, struct tevent_context);
147 DEBUG(10, ("Got message that pcap updated. Reloading.\n"));
148 update_pcap(ev_ctx, msg);
151 static void spoolss_sig_term_handler(struct tevent_context *ev,
152 struct tevent_signal *se,
158 exit_server_cleanly("termination signal");
161 static void spoolss_setup_sig_term_handler(struct tevent_context *ev_ctx)
163 struct tevent_signal *se;
165 se = tevent_add_signal(ev_ctx,
168 spoolss_sig_term_handler,
171 exit_server("failed to setup SIGTERM handler");
175 static void spoolss_sig_hup_handler(struct tevent_context *ev,
176 struct tevent_signal *se,
182 struct messaging_context *msg_ctx;
184 msg_ctx = talloc_get_type_abort(pvt, struct messaging_context);
186 DEBUG(1,("Reloading printers after SIGHUP\n"));
187 update_conf(ev, msg_ctx);
189 /* relay to all children */
191 prefork_send_signal_to_all(spoolss_pool, SIGHUP);
195 static void spoolss_setup_sig_hup_handler(struct tevent_context *ev_ctx,
196 struct messaging_context *msg_ctx)
198 struct tevent_signal *se;
200 se = tevent_add_signal(ev_ctx,
203 spoolss_sig_hup_handler,
206 exit_server("failed to setup SIGHUP handler");
210 static bool spoolss_init_cb(void *ptr)
212 struct messaging_context *msg_ctx = talloc_get_type_abort(
213 ptr, struct messaging_context);
215 return nt_printing_tdb_migrate(msg_ctx);
218 static bool spoolss_shutdown_cb(void *ptr)
220 srv_spoolss_cleanup();
227 struct spoolss_chld_sig_hup_ctx {
228 struct messaging_context *msg_ctx;
229 struct pf_worker_data *pf;
232 static void spoolss_chld_sig_hup_handler(struct tevent_context *ev,
233 struct tevent_signal *se,
239 struct spoolss_chld_sig_hup_ctx *shc;
241 shc = talloc_get_type_abort(pvt, struct spoolss_chld_sig_hup_ctx);
243 /* avoid wasting CPU cycles if we are going to exit soon anyways */
244 if (shc->pf != NULL &&
245 shc->pf->cmds == PF_SRV_MSG_EXIT) {
249 change_to_root_user();
250 DEBUG(1,("Reloading printers after SIGHUP\n"));
251 reload_printers(ev, shc->msg_ctx);
252 spoolss_reopen_logs(spoolss_child_id);
255 static bool spoolss_setup_chld_hup_handler(struct tevent_context *ev_ctx,
256 struct messaging_context *msg_ctx,
257 struct pf_worker_data *pf)
259 struct spoolss_chld_sig_hup_ctx *shc;
260 struct tevent_signal *se;
262 shc = talloc(ev_ctx, struct spoolss_chld_sig_hup_ctx);
264 DEBUG(1, ("failed to setup SIGHUP handler"));
268 shc->msg_ctx = msg_ctx;
270 se = tevent_add_signal(ev_ctx,
273 spoolss_chld_sig_hup_handler,
276 DEBUG(1, ("failed to setup SIGHUP handler"));
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 = server_messaging_context();
291 status = reinit_after_fork(msg_ctx, ev_ctx,
292 procid_self(), true);
293 if (!NT_STATUS_IS_OK(status)) {
294 DEBUG(0,("reinit_after_fork() failed\n"));
295 smb_panic("reinit_after_fork() failed");
298 spoolss_child_id = child_id;
299 spoolss_reopen_logs(child_id);
301 ok = spoolss_setup_chld_hup_handler(ev_ctx, msg_ctx, pf);
306 if (!serverid_register(procid_self(),
308 FLAG_MSG_PRINT_GENERAL)) {
312 if (!locking_init()) {
316 messaging_register(msg_ctx, ev_ctx,
317 MSG_SMB_CONF_UPDATED, smb_conf_updated);
318 messaging_register(msg_ctx, ev_ctx, MSG_PRINTER_PCAP,
321 /* As soon as messaging is up check if pcap has been loaded already.
322 * If so then we probably missed a message and should load_printers()
323 * ourselves. If pcap has not been loaded yet, then ignore, we will get
324 * a message as soon as the bq process completes the reload. */
325 if (pcap_cache_loaded()) {
326 load_printers(ev_ctx, msg_ctx);
329 /* try to reinit rpc queues */
330 spoolss_cb.init = spoolss_init_cb;
331 spoolss_cb.shutdown = spoolss_shutdown_cb;
332 spoolss_cb.private_data = msg_ctx;
334 status = rpc_winreg_init(NULL);
335 if (!NT_STATUS_IS_OK(status)) {
336 DEBUG(0, ("Failed to register winreg rpc inteface! (%s)\n",
341 status = rpc_spoolss_init(&spoolss_cb);
342 if (!NT_STATUS_IS_OK(status)) {
343 DEBUG(0, ("Failed to register spoolss rpc inteface! (%s)\n",
351 struct spoolss_children_data {
352 struct tevent_context *ev_ctx;
353 struct messaging_context *msg_ctx;
354 struct pf_worker_data *pf;
359 static void spoolss_next_client(void *pvt);
361 static int spoolss_children_main(struct tevent_context *ev_ctx,
362 struct messaging_context *msg_ctx,
363 struct pf_worker_data *pf,
369 struct spoolss_children_data *data;
373 ok = spoolss_child_init(ev_ctx, child_id, pf);
378 data = talloc(ev_ctx, struct spoolss_children_data);
383 data->ev_ctx = ev_ctx;
384 data->msg_ctx = msg_ctx;
385 data->listen_fd_size = listen_fd_size;
386 data->listen_fds = listen_fds;
388 /* loop until it is time to exit */
389 while (pf->status != PF_WORKER_EXITING) {
390 /* try to see if it is time to schedule the next client */
391 spoolss_next_client(data);
393 ret = tevent_loop_once(ev_ctx);
395 DEBUG(0, ("tevent_loop_once() exited with %d: %s\n",
396 ret, strerror(errno)));
397 pf->status = PF_WORKER_EXITING;
404 static void spoolss_client_terminated(void *pvt)
406 struct spoolss_children_data *data;
408 data = talloc_get_type_abort(pvt, struct spoolss_children_data);
410 pfh_client_terminated(data->pf);
412 spoolss_next_client(pvt);
415 struct spoolss_new_client {
416 struct spoolss_children_data *data;
417 struct tsocket_address *srv_addr;
418 struct tsocket_address *cli_addr;
421 static void spoolss_handle_client(struct tevent_req *req);
423 static void spoolss_next_client(void *pvt)
425 struct tevent_req *req;
426 struct spoolss_children_data *data;
427 struct spoolss_new_client *next;
429 data = talloc_get_type_abort(pvt, struct spoolss_children_data);
431 if (!pfh_child_allowed_to_accept(data->pf)) {
432 /* nothing to do for now we are already listening
433 * or we are not allowed to listen further */
437 next = talloc_zero(data, struct spoolss_new_client);
439 DEBUG(1, ("Out of memory!?\n"));
444 req = prefork_listen_send(next, data->ev_ctx, data->pf,
445 data->listen_fd_size,
448 DEBUG(1, ("Failed to make listening request!?\n"));
452 tevent_req_set_callback(req, spoolss_handle_client, next);
455 static void spoolss_handle_client(struct tevent_req *req)
457 struct spoolss_children_data *data;
458 struct spoolss_new_client *client;
459 const DATA_BLOB ping = data_blob_null;
463 client = tevent_req_callback_data(req, struct spoolss_new_client);
466 ret = prefork_listen_recv(req, client, &sd,
467 &client->srv_addr, &client->cli_addr);
469 /* this will free the request too */
473 DEBUG(6, ("No client connection was available after all!\n"));
477 /* Warn parent that our status changed */
478 messaging_send(data->msg_ctx, parent_id,
479 MSG_PREFORK_CHILD_EVENT, &ping);
481 DEBUG(2, ("Spoolss preforked child %d got client connection!\n",
482 (int)(data->pf->pid)));
484 named_pipe_accept_function(data->ev_ctx, data->msg_ctx,
485 SPOOLSS_PIPE_NAME, sd,
486 spoolss_client_terminated, data);
489 /* ==== Main Process Functions ==== */
491 extern pid_t background_lpq_updater_pid;
492 static char *bq_logfile;
494 static void check_updater_child(void)
499 if (background_lpq_updater_pid == -1) {
503 pid = sys_waitpid(background_lpq_updater_pid, &status, WNOHANG);
505 DEBUG(2, ("The background queue child died... Restarting!\n"));
506 pid = start_background_queue(server_event_context(),
507 server_messaging_context(),
509 background_lpq_updater_pid = pid;
513 static void child_ping(struct messaging_context *msg_ctx,
516 struct server_id server_id,
519 struct tevent_context *ev_ctx;
521 ev_ctx = talloc_get_type_abort(private_data, struct tevent_context);
523 DEBUG(10, ("Got message that a child changed status.\n"));
524 pfh_manage_pool(ev_ctx, msg_ctx, &pf_spoolss_cfg, spoolss_pool);
527 static bool spoolssd_schedule_check(struct tevent_context *ev_ctx,
528 struct messaging_context *msg_ctx,
529 struct timeval current_time);
530 static void spoolssd_check_children(struct tevent_context *ev_ctx,
531 struct tevent_timer *te,
532 struct timeval current_time,
535 static void spoolssd_sigchld_handler(struct tevent_context *ev_ctx,
536 struct prefork_pool *pfp,
539 struct messaging_context *msg_ctx;
541 msg_ctx = talloc_get_type_abort(pvt, struct messaging_context);
543 /* run pool management so we can fork/retire or increase
544 * the allowed connections per child based on load */
545 pfh_manage_pool(ev_ctx, msg_ctx, &pf_spoolss_cfg, spoolss_pool);
547 /* also check if the updater child is alive and well */
548 check_updater_child();
551 static bool spoolssd_setup_children_monitor(struct tevent_context *ev_ctx,
552 struct messaging_context *msg_ctx)
556 /* add our oun sigchld callback */
557 prefork_set_sigchld_callback(spoolss_pool,
558 spoolssd_sigchld_handler, msg_ctx);
560 ok = spoolssd_schedule_check(ev_ctx, msg_ctx,
561 tevent_timeval_current());
565 static bool spoolssd_schedule_check(struct tevent_context *ev_ctx,
566 struct messaging_context *msg_ctx,
567 struct timeval current_time)
569 struct tevent_timer *te;
570 struct timeval next_event;
572 /* check situation again in 10 seconds */
573 next_event = tevent_timeval_current_ofs(10, 0);
575 /* TODO: check when the socket becomes readable, so that children
576 * are checked only when there is some activity ? */
577 te = tevent_add_timer(ev_ctx, spoolss_pool, next_event,
578 spoolssd_check_children, msg_ctx);
580 DEBUG(2, ("Failed to set up children monitoring!\n"));
587 static void spoolssd_check_children(struct tevent_context *ev_ctx,
588 struct tevent_timer *te,
589 struct timeval current_time,
592 struct messaging_context *msg_ctx;
594 msg_ctx = talloc_get_type_abort(pvt, struct messaging_context);
596 pfh_manage_pool(ev_ctx, msg_ctx, &pf_spoolss_cfg, spoolss_pool);
598 spoolssd_schedule_check(ev_ctx, msg_ctx, current_time);
601 static void print_queue_forward(struct messaging_context *msg,
604 struct server_id server_id,
607 messaging_send_buf(msg, pid_to_procid(background_lpq_updater_pid),
608 MSG_PRINTER_UPDATE, data->data, data->length);
611 static char *get_bq_logfile(void)
613 char *lfile = lp_logfile();
616 if (lfile == NULL || lfile[0] == '\0') {
617 rc = asprintf(&lfile, "%s/log.%s.bq",
618 get_dyn_LOGFILEBASE(), DAEMON_NAME);
620 rc = asprintf(&lfile, "%s.bq", lp_logfile());
628 pid_t start_spoolssd(struct tevent_context *ev_ctx,
629 struct messaging_context *msg_ctx)
631 struct rpc_srv_callbacks spoolss_cb;
632 struct dcerpc_binding_vector *v;
640 DEBUG(1, ("Forking SPOOLSS Daemon\n"));
643 * Block signals before forking child as it will have to
644 * set its own handlers. Child will re-enable SIGHUP as
645 * soon as the handlers are set up.
647 BlockSignals(true, SIGTERM);
648 BlockSignals(true, SIGHUP);
653 DEBUG(0, ("Failed to fork SPOOLSS [%s]\n",
657 /* parent or error */
660 /* Re-enable SIGHUP before returnig */
661 BlockSignals(false, SIGTERM);
662 BlockSignals(false, SIGHUP);
667 close_low_fds(false);
669 status = reinit_after_fork(msg_ctx,
671 procid_self(), true);
672 if (!NT_STATUS_IS_OK(status)) {
673 DEBUG(0,("reinit_after_fork() failed\n"));
674 smb_panic("reinit_after_fork() failed");
677 /* save the parent process id so the children can use it later */
678 parent_id = procid_self();
680 spoolss_reopen_logs(0);
681 pfh_daemon_config(DAEMON_NAME,
683 &default_pf_spoolss_cfg);
685 spoolss_setup_sig_term_handler(ev_ctx);
686 spoolss_setup_sig_hup_handler(ev_ctx, msg_ctx);
688 BlockSignals(false, SIGTERM);
689 BlockSignals(false, SIGHUP);
691 /* always start the backgroundqueue listner in spoolssd */
692 bq_logfile = get_bq_logfile();
693 pid = start_background_queue(ev_ctx, msg_ctx, bq_logfile);
695 background_lpq_updater_pid = pid;
698 /* the listening fd must be created before the children are actually
700 listen_fd = create_named_pipe_socket(SPOOLSS_PIPE_NAME);
701 if (listen_fd == -1) {
705 ret = listen(listen_fd, pf_spoolss_cfg.max_allowed_clients);
707 DEBUG(0, ("Failed to listen on spoolss pipe - %s\n",
712 /* start children before any more initialization is done */
713 ok = prefork_create_pool(ev_ctx, /* mem_ctx */
716 pf_spoolss_cfg.min_children,
717 pf_spoolss_cfg.max_children,
718 &spoolss_children_main, NULL,
724 if (!serverid_register(procid_self(),
726 FLAG_MSG_PRINT_GENERAL)) {
730 if (!locking_init()) {
734 messaging_register(msg_ctx, ev_ctx,
735 MSG_SMB_CONF_UPDATED, smb_conf_updated);
736 messaging_register(msg_ctx, NULL, MSG_PRINTER_UPDATE,
737 print_queue_forward);
738 messaging_register(msg_ctx, ev_ctx, MSG_PRINTER_PCAP,
740 messaging_register(msg_ctx, ev_ctx,
741 MSG_PREFORK_CHILD_EVENT, child_ping);
743 /* As soon as messaging is up check if pcap has been loaded already.
744 * If so then we probably missed a message and should load_printers()
745 * ourselves. If pcap has not been loaded yet, then ignore, we will get
746 * a message as soon as the bq process completes the reload. */
747 if (pcap_cache_loaded()) {
748 load_printers(ev_ctx, msg_ctx);
751 mem_ctx = talloc_new(NULL);
752 if (mem_ctx == NULL) {
757 * Initialize spoolss with an init function to convert printers first.
758 * static_init_rpc will try to initialize the spoolss server too but you
759 * can't register it twice.
761 spoolss_cb.init = spoolss_init_cb;
762 spoolss_cb.shutdown = spoolss_shutdown_cb;
763 spoolss_cb.private_data = msg_ctx;
765 status = rpc_winreg_init(NULL);
766 if (!NT_STATUS_IS_OK(status)) {
767 DEBUG(0, ("Failed to register winreg rpc inteface! (%s)\n",
772 status = rpc_spoolss_init(&spoolss_cb);
773 if (!NT_STATUS_IS_OK(status)) {
774 DEBUG(0, ("Failed to register spoolss rpc inteface! (%s)\n",
779 status = dcerpc_binding_vector_new(mem_ctx, &v);
780 if (!NT_STATUS_IS_OK(status)) {
781 DEBUG(0, ("Failed to create binding vector (%s)\n",
786 status = dcerpc_binding_vector_add_np_default(&ndr_table_spoolss, v);
787 if (!NT_STATUS_IS_OK(status)) {
788 DEBUG(0, ("Failed to add np to binding vector (%s)\n",
793 status = rpc_ep_register(ev_ctx, msg_ctx, &ndr_table_spoolss, v);
794 if (!NT_STATUS_IS_OK(status)) {
795 DEBUG(0, ("Failed to register spoolss endpoint! (%s)\n",
800 talloc_free(mem_ctx);
802 ok = spoolssd_setup_children_monitor(ev_ctx, msg_ctx);
804 DEBUG(0, ("Failed to setup children monitoring!\n"));
808 DEBUG(1, ("SPOOLSS Daemon Started (%d)\n", getpid()));
810 pfh_manage_pool(ev_ctx, msg_ctx, &pf_spoolss_cfg, spoolss_pool);
813 ret = tevent_loop_wait(ev_ctx);
815 /* should not be reached */
816 DEBUG(0,("spoolssd tevent_loop_wait() exited with %d - %s\n",
817 ret, (ret == 0) ? "out of events" : strerror(errno)));