r416: add a newline to the debuglevel message returned string
[Samba.git] / source3 / utils / smbcontrol.c
blob2eb661c8b68b4e07d1efbfb9a174112b1967fcaa
1 /*
2 Unix SMB/CIFS implementation.
4 Send messages to other Samba daemons
6 Copyright (C) Tim Potter 2003
7 Copyright (C) Andrew Tridgell 1994-1998
8 Copyright (C) Martin Pool 2001-2002
9 Copyright (C) Simo Sorce 2002
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include "includes.h"
28 /* Default timeout value when waiting for replies (in seconds) */
30 #define DEFAULT_TIMEOUT 10
32 static int timeout = DEFAULT_TIMEOUT;
33 static int num_replies; /* Used by message callback fns */
35 /* Send a message to a destination pid. Zero means broadcast smbd. */
37 static BOOL send_message(pid_t pid, int msg_type, const void *buf, int len,
38 BOOL duplicates)
40 TDB_CONTEXT *tdb;
41 BOOL ret;
42 int n_sent = 0;
44 if (!message_init())
45 return False;
47 if (pid != 0)
48 return message_send_pid(pid, msg_type, buf, len, duplicates);
50 tdb = tdb_open_log(lock_path("connections.tdb"), 0,
51 TDB_DEFAULT, O_RDWR, 0);
52 if (!tdb) {
53 fprintf(stderr,"Failed to open connections database"
54 ": %s\n", strerror(errno));
55 return False;
58 ret = message_send_all(tdb,msg_type, buf, len, duplicates,
59 &n_sent);
60 DEBUG(10,("smbcontrol/send_message: broadcast message to "
61 "%d processes\n", n_sent));
63 tdb_close(tdb);
65 return ret;
68 /* Wait for one or more reply messages */
70 static void wait_replies(BOOL multiple_replies)
72 time_t start_time = time(NULL);
74 /* Wait around a bit. This is pretty disgusting - we have to
75 busy-wait here as there is no nicer way to do it. */
77 do {
78 message_dispatch();
79 if (num_replies > 0 && !multiple_replies)
80 break;
81 sleep(1);
82 } while (timeout - (time(NULL) - start_time) > 0);
85 /* Message handler callback that displays the PID and a string on stdout */
87 static void print_pid_string_cb(int msg_type, pid_t pid, void *buf, size_t len)
89 printf("PID %u: %.*s", (unsigned int)pid, (int)len, (const char *)buf);
90 num_replies++;
93 /* Message handler callback that displays a string on stdout */
95 static void print_string_cb(int msg_type, pid_t pid, void *buf, size_t len)
97 printf("%.*s", (int)len, (const char *)buf);
98 num_replies++;
101 /* Send no message. Useful for testing. */
103 static BOOL do_noop(const pid_t pid, const int argc, const char **argv)
105 if (argc != 1) {
106 fprintf(stderr, "Usage: smbcontrol <dest> noop\n");
107 return False;
110 /* Move along, nothing to see here */
112 return True;
115 /* Send a debug string */
117 static BOOL do_debug(const pid_t pid, const int argc, const char **argv)
119 if (argc != 2) {
120 fprintf(stderr, "Usage: smbcontrol <dest> debug "
121 "<debug-string>\n");
122 return False;
125 return send_message(
126 pid, MSG_DEBUG, argv[1], strlen(argv[1]) + 1, False);
129 /* Force a browser election */
131 static BOOL do_election(const pid_t pid, const int argc, const char **argv)
133 if (argc != 1) {
134 fprintf(stderr, "Usage: smbcontrol <dest> force-election\n");
135 return False;
138 return send_message(
139 pid, MSG_FORCE_ELECTION, NULL, 0, False);
142 /* Ping a samba daemon process */
144 static void pong_cb(int msg_type, pid_t pid, void *buf, size_t len)
146 printf("PONG from pid %u\n", (unsigned int)pid);
147 num_replies++;
150 static BOOL do_ping(const pid_t pid, const int argc, const char **argv)
152 if (argc != 1) {
153 fprintf(stderr, "Usage: smbcontrol <dest> ping\n");
154 return False;
157 /* Send a message and register our interest in a reply */
159 if (!send_message(pid, MSG_PING, NULL, 0, False))
160 return False;
162 message_register(MSG_PONG, pong_cb);
164 wait_replies(pid == 0);
166 /* No replies were received within the timeout period */
168 if (num_replies == 0)
169 printf("No replies received\n");
171 message_deregister(MSG_PONG);
173 return num_replies;
176 /* Set profiling options */
178 static BOOL do_profile(const pid_t pid, const int argc, const char **argv)
180 int v;
182 if (argc != 2) {
183 fprintf(stderr, "Usage: smbcontrol <dest> profile "
184 "<off|count|on|flush>\n");
185 return False;
188 if (strcmp(argv[1], "off") == 0) {
189 v = 0;
190 } else if (strcmp(argv[1], "count") == 0) {
191 v = 1;
192 } else if (strcmp(argv[1], "on") == 0) {
193 v = 2;
194 } else if (strcmp(argv[1], "flush") == 0) {
195 v = 3;
196 } else {
197 fprintf(stderr, "Unknown profile command '%s'\n", argv[1]);
198 return False;
201 return send_message(pid, MSG_PROFILE, &v, sizeof(int), False);
204 /* Return the profiling level */
206 static void profilelevel_cb(int msg_type, pid_t pid, void *buf, size_t len)
208 int level;
209 const char *s;
211 num_replies++;
213 if (len != sizeof(int)) {
214 fprintf(stderr, "invalid message length %ld returned\n",
215 (unsigned long)len);
216 return;
219 memcpy(&level, buf, sizeof(int));
221 switch (level) {
222 case 0:
223 s = "not enabled";
224 break;
225 case 1:
226 s = "off";
227 break;
228 case 3:
229 s = "count only";
230 break;
231 case 7:
232 s = "count and time";
233 break;
234 default:
235 s = "BOGUS";
236 break;
239 printf("Profiling %s on pid %u\n",s,(unsigned int)pid);
242 static void profilelevel_rqst(int msg_type, pid_t pid, void *buf, size_t len)
244 int v = 0;
246 /* Send back a dummy reply */
248 send_message(pid, MSG_PROFILELEVEL, &v, sizeof(int), False);
251 static BOOL do_profilelevel(const pid_t pid, const int argc, const char **argv)
253 if (argc != 1) {
254 fprintf(stderr, "Usage: smbcontrol <dest> profilelevel\n");
255 return False;
258 /* Send a message and register our interest in a reply */
260 if (!send_message(pid, MSG_REQ_PROFILELEVEL, NULL, 0, False))
261 return False;
263 message_register(MSG_PROFILELEVEL, profilelevel_cb);
264 message_register(MSG_REQ_PROFILELEVEL, profilelevel_rqst);
266 wait_replies(pid == 0);
268 /* No replies were received within the timeout period */
270 if (num_replies == 0)
271 printf("No replies received\n");
273 message_deregister(MSG_PROFILE);
275 return num_replies;
278 /* Display debug level settings */
280 static BOOL do_debuglevel(const pid_t pid, const int argc, const char **argv)
282 if (argc != 1) {
283 fprintf(stderr, "Usage: smbcontrol <dest> debuglevel\n");
284 return False;
287 /* Send a message and register our interest in a reply */
289 if (!send_message(pid, MSG_REQ_DEBUGLEVEL, NULL, 0, False))
290 return False;
292 message_register(MSG_DEBUGLEVEL, print_pid_string_cb);
294 wait_replies(pid == 0);
296 /* No replies were received within the timeout period */
298 if (num_replies == 0)
299 printf("No replies received\n");
301 message_deregister(MSG_DEBUGLEVEL);
303 return num_replies;
306 /* Send a print notify message */
308 static BOOL do_printnotify(const pid_t pid, const int argc, const char **argv)
310 const char *cmd;
312 /* Check for subcommand */
314 if (argc == 1) {
315 fprintf(stderr, "Must specify subcommand:\n");
316 fprintf(stderr, "\tqueuepause <printername>\n");
317 fprintf(stderr, "\tqueueresume <printername>\n");
318 fprintf(stderr, "\tjobpause <printername> <unix jobid>\n");
319 fprintf(stderr, "\tjobresume <printername> <unix jobid>\n");
320 fprintf(stderr, "\tjobdelete <printername> <unix jobid>\n");
321 fprintf(stderr, "\tprinter <printername> <comment|port|"
322 "driver> <value>\n");
324 return False;
327 cmd = argv[1];
329 if (strcmp(cmd, "queuepause") == 0) {
331 if (argc != 3) {
332 fprintf(stderr, "Usage: smbcontrol <dest> printnotify"
333 " queuepause <printername>\n");
334 return False;
337 notify_printer_status_byname(argv[2], PRINTER_STATUS_PAUSED);
339 goto send;
341 } else if (strcmp(cmd, "queueresume") == 0) {
343 if (argc != 3) {
344 fprintf(stderr, "Usage: smbcontrol <dest> printnotify"
345 " queuereume <printername>\n");
346 return False;
349 notify_printer_status_byname(argv[2], PRINTER_STATUS_OK);
351 goto send;
353 } else if (strcmp(cmd, "jobpause") == 0) {
354 int jobid;
356 if (argc != 4) {
357 fprintf(stderr, "Usage: smbcontrol <dest> printnotify"
358 " jobpause <printername> <unix-jobid>\n");
359 return False;
362 jobid = atoi(argv[3]);
364 notify_job_status_byname(
365 argv[2], jobid, JOB_STATUS_PAUSED,
366 SPOOLSS_NOTIFY_MSG_UNIX_JOBID);
368 goto send;
370 } else if (strcmp(cmd, "jobresume") == 0) {
371 int jobid;
373 if (argc != 4) {
374 fprintf(stderr, "Usage: smbcontrol <dest> printnotify"
375 " jobpause <printername> <unix-jobid>\n");
376 return False;
379 jobid = atoi(argv[3]);
381 notify_job_status_byname(
382 argv[2], jobid, JOB_STATUS_QUEUED,
383 SPOOLSS_NOTIFY_MSG_UNIX_JOBID);
385 goto send;
387 } else if (strcmp(cmd, "jobdelete") == 0) {
388 int jobid;
390 if (argc != 4) {
391 fprintf(stderr, "Usage: smbcontrol <dest> printnotify"
392 " jobpause <printername> <unix-jobid>\n");
393 return False;
396 jobid = atoi(argv[3]);
398 notify_job_status_byname(
399 argv[2], jobid, JOB_STATUS_DELETING,
400 SPOOLSS_NOTIFY_MSG_UNIX_JOBID);
402 notify_job_status_byname(
403 argv[2], jobid, JOB_STATUS_DELETING|
404 JOB_STATUS_DELETED,
405 SPOOLSS_NOTIFY_MSG_UNIX_JOBID);
407 goto send;
409 } else if (strcmp(cmd, "printer") == 0) {
410 uint32 attribute;
412 if (argc != 5) {
413 fprintf(stderr, "Usage: smbcontrol <dest> printnotify "
414 "printer <printername> <comment|port|driver> "
415 "<value>\n");
416 return False;
419 if (strcmp(argv[3], "comment") == 0) {
420 attribute = PRINTER_NOTIFY_COMMENT;
421 } else if (strcmp(argv[3], "port") == 0) {
422 attribute = PRINTER_NOTIFY_PORT_NAME;
423 } else if (strcmp(argv[3], "driver") == 0) {
424 attribute = PRINTER_NOTIFY_DRIVER_NAME;
425 } else {
426 fprintf(stderr, "Invalid printer command '%s'\n",
427 argv[3]);
428 return False;
431 notify_printer_byname(argv[2], attribute, argv[4]);
433 goto send;
436 fprintf(stderr, "Invalid subcommand '%s'\n", cmd);
437 return False;
439 send:
440 print_notify_send_messages(0);
441 return True;
444 /* Close a share */
446 static BOOL do_closeshare(const pid_t pid, const int argc, const char **argv)
448 if (argc != 2) {
449 fprintf(stderr, "Usage: smbcontrol <dest> close-share "
450 "<sharename>\n");
451 return False;
454 return send_message(
455 pid, MSG_SMB_FORCE_TDIS, argv[1], strlen(argv[1]) + 1, False);
458 /* Force a SAM synchronisation */
460 static BOOL do_samsync(const pid_t pid, const int argc, const char **argv)
462 if (argc != 1) {
463 fprintf(stderr, "Usage: smbcontrol <dest> samsync\n");
464 return False;
467 return send_message(
468 pid, MSG_SMB_SAM_SYNC, NULL, 0, False);
471 /* Force a SAM replication */
473 static BOOL do_samrepl(const pid_t pid, const int argc, const char **argv)
475 if (argc != 1) {
476 fprintf(stderr, "Usage: smbcontrol <dest> samrepl\n");
477 return False;
480 return send_message(
481 pid, MSG_SMB_SAM_REPL, NULL, 0, False);
484 /* Display talloc pool usage */
486 static BOOL do_poolusage(const pid_t pid, const int argc, const char **argv)
488 if (argc != 1) {
489 fprintf(stderr, "Usage: smbcontrol <dest> pool-usage\n");
490 return False;
493 /* Send a message and register our interest in a reply */
495 if (!send_message(pid, MSG_REQ_POOL_USAGE, NULL, 0, False))
496 return False;
498 message_register(MSG_POOL_USAGE, print_string_cb);
500 wait_replies(pid == 0);
502 /* No replies were received within the timeout period */
504 if (num_replies == 0)
505 printf("No replies received\n");
507 message_deregister(MSG_POOL_USAGE);
509 return num_replies;
512 /* Perform a dmalloc mark */
514 static BOOL do_dmalloc_mark(const pid_t pid, const int argc, const char **argv)
516 if (argc != 1) {
517 fprintf(stderr, "Usage: smbcontrol <dest> dmalloc-mark\n");
518 return False;
521 return send_message(
522 pid, MSG_REQ_DMALLOC_MARK, NULL, 0, False);
525 /* Perform a dmalloc changed */
527 static BOOL do_dmalloc_changed(const pid_t pid, const int argc, const char **argv)
529 if (argc != 1) {
530 fprintf(stderr, "Usage: smbcontrol <dest> "
531 "dmalloc-log-changed\n");
532 return False;
535 return send_message(
536 pid, MSG_REQ_DMALLOC_LOG_CHANGED, NULL, 0, False);
539 /* Shutdown a server process */
541 static BOOL do_shutdown(const pid_t pid, const int argc, const char **argv)
543 if (argc != 1) {
544 fprintf(stderr, "Usage: smbcontrol <dest> shutdown\n");
545 return False;
548 return send_message(pid, MSG_SHUTDOWN, NULL, 0, False);
551 /* Notify a driver upgrade */
553 static BOOL do_drvupgrade(const pid_t pid, const int argc, const char **argv)
555 if (argc != 2) {
556 fprintf(stderr, "Usage: smbcontrol <dest> drvupgrade "
557 "<driver-name>\n");
558 return False;
561 return send_message(
562 pid, MSG_DEBUG, argv[1], strlen(argv[1]) + 1, False);
565 static BOOL do_reload_config(const pid_t pid, const int argc, const char **argv)
567 if (argc != 1) {
568 fprintf(stderr, "Usage: smbcontrol <dest> reload-config\n");
569 return False;
572 return send_message(pid, MSG_SMB_CONF_UPDATED, NULL, 0, False);
575 /* A list of message type supported */
577 static const struct {
578 const char *name; /* Option name */
579 BOOL (*fn)(const pid_t pid, const int argc, const char **argv);
580 const char *help; /* Short help text */
581 } msg_types[] = {
582 { "debug", do_debug, "Set debuglevel" },
583 { "force-election", do_election,
584 "Force a browse election" },
585 { "ping", do_ping, "Elicit a response" },
586 { "profile", do_profile, "" },
587 { "profilelevel", do_profilelevel, "" },
588 { "debuglevel", do_debuglevel, "Display current debuglevels" },
589 { "printnotify", do_printnotify, "Send a print notify message" },
590 { "close-share", do_closeshare, "Forcibly disconnect a share" },
591 { "samsync", do_samsync, "Initiate SAM synchronisation" },
592 { "samrepl", do_samrepl, "Initiate SAM replication" },
593 { "pool-usage", do_poolusage, "Display talloc memory usage" },
594 { "dmalloc-mark", do_dmalloc_mark, "" },
595 { "dmalloc-log-changed", do_dmalloc_changed, "" },
596 { "shutdown", do_shutdown, "Shut down daemon" },
597 { "drvupgrade", do_drvupgrade, "Notify a printer driver has changed" },
598 { "reload-config", do_reload_config, "Force smbd or winbindd to reload config file"},
599 { "noop", do_noop, "Do nothing" },
600 { NULL }
603 /* Display usage information */
605 static void usage(poptContext *pc)
607 int i;
609 poptPrintHelp(*pc, stderr, 0);
611 fprintf(stderr, "\n");
612 fprintf(stderr, "<destination> is one of \"nmbd\", \"smbd\" or a "
613 "process ID\n");
615 fprintf(stderr, "\n");
616 fprintf(stderr, "<message-type> is one of:\n");
618 for (i = 0; msg_types[i].name; i++)
619 fprintf(stderr, "\t%-30s%s\n", msg_types[i].name,
620 msg_types[i].help);
622 fprintf(stderr, "\n");
624 exit(1);
627 /* Return the pid number for a string destination */
629 static pid_t parse_dest(const char *dest)
631 pid_t pid;
633 /* Zero is a special return value for broadcast smbd */
635 if (strequal(dest, "smbd"))
636 return 0;
638 /* Try self - useful for testing */
640 if (strequal(dest, "self"))
641 return sys_getpid();
643 /* Check for numeric pid number */
645 if ((pid = atoi(dest)) != 0)
646 return pid;
648 /* Look up other destinations in pidfile directory */
650 if ((pid = pidfile_pid(dest)) != 0)
651 return pid;
653 fprintf(stderr,"Can't find pid for destination '%s'\n", dest);
655 return -1;
658 /* Execute smbcontrol command */
660 static BOOL do_command(int argc, const char **argv)
662 const char *dest = argv[0], *command = argv[1];
663 pid_t pid;
664 int i;
666 /* Check destination */
668 if ((pid = parse_dest(dest)) == -1)
669 return False;
671 /* Check command */
673 for (i = 0; msg_types[i].name; i++) {
674 if (strequal(command, msg_types[i].name))
675 return msg_types[i].fn(pid, argc - 1, argv + 1);
678 fprintf(stderr, "smbcontrol: unknown command '%s'\n", command);
680 return False;
683 /* Main program */
685 int main(int argc, const char **argv)
687 poptContext pc;
688 int opt;
690 static struct poptOption wbinfo_options[] = {
691 { "timeout", 't', POPT_ARG_INT, &timeout, 't',
692 "Set timeout value in seconds", "TIMEOUT" },
694 { "configfile", 's', POPT_ARG_STRING, NULL, 's',
695 "Use alternative configuration file", "CONFIGFILE" },
697 POPT_TABLEEND
700 struct poptOption options[] = {
701 { NULL, 0, POPT_ARG_INCLUDE_TABLE, wbinfo_options, 0,
702 "Options" },
704 POPT_AUTOHELP
705 POPT_COMMON_VERSION
706 POPT_TABLEEND
709 setup_logging(argv[0],True);
711 /* Parse command line arguments using popt */
713 pc = poptGetContext(
714 "smbcontrol", argc, (const char **)argv, options, 0);
716 poptSetOtherOptionHelp(pc, "[OPTION...] <destination> <message-type> "
717 "<parameters>");
719 if (argc == 1)
720 usage(&pc);
722 while ((opt = poptGetNextOpt(pc)) != -1) {
723 switch(opt) {
724 case 't': /* --timeout */
725 argc -= 2;
726 break;
727 case 's': /* --configfile */
728 pstrcpy(dyn_CONFIGFILE, poptGetOptArg(pc));
729 argc -= 2;
730 break;
731 default:
732 fprintf(stderr, "Invalid option\n");
733 poptPrintHelp(pc, stderr, 0);
734 break;
738 /* We should now have the remaining command line arguments in
739 argv. The argc parameter should have been decremented to the
740 correct value in the above switch statement. */
742 argv = (const char **)poptGetArgs(pc);
743 argc--; /* Don't forget about argv[0] */
745 if (argc == 1)
746 usage(&pc);
748 lp_load(dyn_CONFIGFILE,False,False,False);
750 /* Need to invert sense of return code -- samba
751 * routines mostly return True==1 for success, but
752 * shell needs 0. */
754 return !do_command(argc, argv);