s3:smbd only initialize kernel oplocks if they are enabled for a share
[Samba/vl.git] / source3 / utils / smbcontrol.c
blob7d7eb1275a344d487e462b2307410df5c3df1c71
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
10 Copyright (C) James Peach 2006
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 3 of the License, or
15 (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program. If not, see <http://www.gnu.org/licenses/>.
26 #include "includes.h"
27 #include "system/filesys.h"
28 #include "popt_common.h"
29 #include "librpc/gen_ndr/spoolss.h"
30 #include "nt_printing.h"
31 #include "printing/notify.h"
32 #include "libsmb/nmblib.h"
33 #include "messages.h"
34 #include "util_tdb.h"
36 #if HAVE_LIBUNWIND_H
37 #include <libunwind.h>
38 #endif
40 #if HAVE_LIBUNWIND_PTRACE_H
41 #include <libunwind-ptrace.h>
42 #endif
44 #if HAVE_SYS_PTRACE_H
45 #include <sys/ptrace.h>
46 #endif
48 /* Default timeout value when waiting for replies (in seconds) */
50 #define DEFAULT_TIMEOUT 10
52 static int timeout = DEFAULT_TIMEOUT;
53 static int num_replies; /* Used by message callback fns */
55 /* Send a message to a destination pid. Zero means broadcast smbd. */
57 static bool send_message(struct messaging_context *msg_ctx,
58 struct server_id pid, int msg_type,
59 const void *buf, int len)
61 bool ret;
62 int n_sent = 0;
64 if (procid_to_pid(&pid) != 0)
65 return NT_STATUS_IS_OK(
66 messaging_send_buf(msg_ctx, pid, msg_type,
67 (const uint8 *)buf, len));
69 ret = message_send_all(msg_ctx, msg_type, buf, len, &n_sent);
70 DEBUG(10,("smbcontrol/send_message: broadcast message to "
71 "%d processes\n", n_sent));
73 return ret;
76 static void smbcontrol_timeout(struct tevent_context *event_ctx,
77 struct tevent_timer *te,
78 struct timeval now,
79 void *private_data)
81 bool *timed_out = (bool *)private_data;
82 TALLOC_FREE(te);
83 *timed_out = True;
86 /* Wait for one or more reply messages */
88 static void wait_replies(struct tevent_context *ev_ctx,
89 struct messaging_context *msg_ctx,
90 bool multiple_replies)
92 struct tevent_timer *te;
93 bool timed_out = False;
95 if (!(te = tevent_add_timer(ev_ctx, NULL,
96 timeval_current_ofs(timeout, 0),
97 smbcontrol_timeout, (void *)&timed_out))) {
98 DEBUG(0, ("tevent_add_timer failed\n"));
99 return;
102 while (!timed_out) {
103 int ret;
104 if (num_replies > 0 && !multiple_replies)
105 break;
106 ret = tevent_loop_once(ev_ctx);
107 if (ret != 0) {
108 break;
113 /* Message handler callback that displays the PID and a string on stdout */
115 static void print_pid_string_cb(struct messaging_context *msg,
116 void *private_data,
117 uint32_t msg_type,
118 struct server_id pid,
119 DATA_BLOB *data)
121 char *pidstr;
123 pidstr = server_id_str(talloc_tos(), &pid);
124 printf("PID %s: %.*s", pidstr, (int)data->length,
125 (const char *)data->data);
126 TALLOC_FREE(pidstr);
127 num_replies++;
130 /* Message handler callback that displays a string on stdout */
132 static void print_string_cb(struct messaging_context *msg,
133 void *private_data,
134 uint32_t msg_type,
135 struct server_id pid,
136 DATA_BLOB *data)
138 printf("%*s", (int)data->length, (const char *)data->data);
139 num_replies++;
142 /* Send no message. Useful for testing. */
144 static bool do_noop(struct tevent_context *ev_ctx,
145 struct messaging_context *msg_ctx,
146 const struct server_id pid,
147 const int argc, const char **argv)
149 if (argc != 1) {
150 fprintf(stderr, "Usage: smbcontrol <dest> noop\n");
151 return False;
154 /* Move along, nothing to see here */
156 return True;
159 /* Send a debug string */
161 static bool do_debug(struct tevent_context *ev_ctx,
162 struct messaging_context *msg_ctx,
163 const struct server_id pid,
164 const int argc, const char **argv)
166 if (argc != 2) {
167 fprintf(stderr, "Usage: smbcontrol <dest> debug "
168 "<debug-string>\n");
169 return False;
172 return send_message(msg_ctx, pid, MSG_DEBUG, argv[1],
173 strlen(argv[1]) + 1);
177 static bool do_idmap(struct tevent_context *ev,
178 struct messaging_context *msg_ctx,
179 const struct server_id pid,
180 const int argc, const char **argv)
182 static const char* usage = "Usage: "
183 "smbcontrol <dest> idmap <cmd> [arg]\n"
184 "\tcmd:\tflush [gid|uid]\n"
185 "\t\tdelete \"UID <uid>\"|\"GID <gid>\"|<sid>\n"
186 "\t\tkill \"UID <uid>\"|\"GID <gid>\"|<sid>\n";
187 const char* arg = NULL;
188 int arglen = 0;
189 int msg_type;
191 switch (argc) {
192 case 2:
193 break;
194 case 3:
195 arg = argv[2];
196 arglen = strlen(arg) + 1;
197 break;
198 default:
199 fprintf(stderr, "%s", usage);
200 return false;
203 if (strcmp(argv[1], "flush") == 0) {
204 msg_type = ID_CACHE_FLUSH;
206 else if (strcmp(argv[1], "delete") == 0) {
207 msg_type = ID_CACHE_DELETE;
209 else if (strcmp(argv[1], "kill") == 0) {
210 msg_type = ID_CACHE_KILL;
212 else if (strcmp(argv[1], "help") == 0) {
213 fprintf(stdout, "%s", usage);
214 return true;
216 else {
217 fprintf(stderr, "%s", usage);
218 return false;
221 return send_message(msg_ctx, pid, msg_type, arg, arglen);
225 #if defined(HAVE_LIBUNWIND_PTRACE) && defined(HAVE_LINUX_PTRACE)
227 /* Return the name of a process given it's PID. This will only work on Linux,
228 * but that's probably moot since this whole stack tracing implementatino is
229 * Linux-specific anyway.
231 static const char * procname(pid_t pid, char * buf, size_t bufsz)
233 char path[64];
234 FILE * fp;
236 snprintf(path, sizeof(path), "/proc/%llu/cmdline",
237 (unsigned long long)pid);
238 if ((fp = fopen(path, "r")) == NULL) {
239 return NULL;
242 fgets(buf, bufsz, fp);
244 fclose(fp);
245 return buf;
248 static void print_stack_trace(pid_t pid, int * count)
250 void * pinfo = NULL;
251 unw_addr_space_t aspace = NULL;
252 unw_cursor_t cursor;
253 unw_word_t ip, sp;
255 char nbuf[256];
256 unw_word_t off;
258 int ret;
260 if (ptrace(PTRACE_ATTACH, pid, NULL, NULL) < 0) {
261 fprintf(stderr,
262 "Failed to attach to process %llu: %s\n",
263 (unsigned long long)pid, strerror(errno));
264 return;
267 /* Wait until the attach is complete. */
268 waitpid(pid, NULL, 0);
270 if (((pinfo = _UPT_create(pid)) == NULL) ||
271 ((aspace = unw_create_addr_space(&_UPT_accessors, 0)) == NULL)) {
272 /* Probably out of memory. */
273 fprintf(stderr,
274 "Unable to initialize stack unwind for process %llu\n",
275 (unsigned long long)pid);
276 goto cleanup;
279 if ((ret = unw_init_remote(&cursor, aspace, pinfo))) {
280 fprintf(stderr,
281 "Unable to unwind stack for process %llu: %s\n",
282 (unsigned long long)pid, unw_strerror(ret));
283 goto cleanup;
286 if (*count > 0) {
287 printf("\n");
290 if (procname(pid, nbuf, sizeof(nbuf))) {
291 printf("Stack trace for process %llu (%s):\n",
292 (unsigned long long)pid, nbuf);
293 } else {
294 printf("Stack trace for process %llu:\n",
295 (unsigned long long)pid);
298 while (unw_step(&cursor) > 0) {
299 ip = sp = off = 0;
300 unw_get_reg(&cursor, UNW_REG_IP, &ip);
301 unw_get_reg(&cursor, UNW_REG_SP, &sp);
303 ret = unw_get_proc_name(&cursor, nbuf, sizeof(nbuf), &off);
304 if (ret != 0 && ret != -UNW_ENOMEM) {
305 snprintf(nbuf, sizeof(nbuf), "<unknown symbol>");
307 printf(" %s + %#llx [ip=%#llx] [sp=%#llx]\n",
308 nbuf, (long long)off, (long long)ip,
309 (long long)sp);
312 (*count)++;
314 cleanup:
315 if (aspace) {
316 unw_destroy_addr_space(aspace);
319 if (pinfo) {
320 _UPT_destroy(pinfo);
323 ptrace(PTRACE_DETACH, pid, NULL, NULL);
326 static int stack_trace_connection(const struct connections_key *key,
327 const struct connections_data *crec,
328 void *priv)
330 print_stack_trace(procid_to_pid(&crec->pid), (int *)priv);
332 return 0;
335 static bool do_daemon_stack_trace(struct tevent_context *ev_ctx,
336 struct messaging_context *msg_ctx,
337 const struct server_id pid,
338 const int argc, const char **argv)
340 pid_t dest;
341 int count = 0;
343 if (argc != 1) {
344 fprintf(stderr, "Usage: smbcontrol <dest> stacktrace\n");
345 return False;
348 dest = procid_to_pid(&pid);
350 if (dest != 0) {
351 /* It would be nice to be able to make sure that this PID is
352 * the PID of a smbd/winbind/nmbd process, not some random PID
353 * the user liked the look of. It doesn't seem like it's worth
354 * the effort at the moment, however.
356 print_stack_trace(dest, &count);
357 } else {
358 connections_forall_read(stack_trace_connection, &count);
361 return True;
364 #else /* defined(HAVE_LIBUNWIND_PTRACE) && defined(HAVE_LINUX_PTRACE) */
366 static bool do_daemon_stack_trace(struct tevent_context *ev_ctx,
367 struct messaging_context *msg_ctx,
368 const struct server_id pid,
369 const int argc, const char **argv)
371 fprintf(stderr,
372 "Daemon stack tracing is not supported on this platform\n");
373 return False;
376 #endif /* defined(HAVE_LIBUNWIND_PTRACE) && defined(HAVE_LINUX_PTRACE) */
378 /* Inject a fault (fatal signal) into a running smbd */
380 static bool do_inject_fault(struct tevent_context *ev_ctx,
381 struct messaging_context *msg_ctx,
382 const struct server_id pid,
383 const int argc, const char **argv)
385 if (argc != 2) {
386 fprintf(stderr, "Usage: smbcontrol <dest> inject "
387 "<bus|hup|term|internal|segv>\n");
388 return False;
391 #ifndef DEVELOPER
392 fprintf(stderr, "Fault injection is only available in "
393 "developer builds\n");
394 return False;
395 #else /* DEVELOPER */
397 int sig = 0;
399 if (strcmp(argv[1], "bus") == 0) {
400 sig = SIGBUS;
401 } else if (strcmp(argv[1], "hup") == 0) {
402 sig = SIGHUP;
403 } else if (strcmp(argv[1], "term") == 0) {
404 sig = SIGTERM;
405 } else if (strcmp(argv[1], "segv") == 0) {
406 sig = SIGSEGV;
407 } else if (strcmp(argv[1], "internal") == 0) {
408 /* Force an internal error, ie. an unclean exit. */
409 sig = -1;
410 } else {
411 fprintf(stderr, "Unknown signal name '%s'\n", argv[1]);
412 return False;
415 return send_message(msg_ctx, pid, MSG_SMB_INJECT_FAULT,
416 &sig, sizeof(int));
418 #endif /* DEVELOPER */
421 /* Force a browser election */
423 static bool do_election(struct tevent_context *ev_ctx,
424 struct messaging_context *msg_ctx,
425 const struct server_id pid,
426 const int argc, const char **argv)
428 if (argc != 1) {
429 fprintf(stderr, "Usage: smbcontrol <dest> force-election\n");
430 return False;
433 return send_message(msg_ctx, pid, MSG_FORCE_ELECTION, NULL, 0);
436 /* Ping a samba daemon process */
438 static void pong_cb(struct messaging_context *msg,
439 void *private_data,
440 uint32_t msg_type,
441 struct server_id pid,
442 DATA_BLOB *data)
444 char *src_string = server_id_str(NULL, &pid);
445 printf("PONG from pid %s\n", src_string);
446 TALLOC_FREE(src_string);
447 num_replies++;
450 static bool do_ping(struct tevent_context *ev_ctx,
451 struct messaging_context *msg_ctx,
452 const struct server_id pid,
453 const int argc, const char **argv)
455 if (argc != 1) {
456 fprintf(stderr, "Usage: smbcontrol <dest> ping\n");
457 return False;
460 /* Send a message and register our interest in a reply */
462 if (!send_message(msg_ctx, pid, MSG_PING, NULL, 0))
463 return False;
465 messaging_register(msg_ctx, NULL, MSG_PONG, pong_cb);
467 wait_replies(ev_ctx, msg_ctx, procid_to_pid(&pid) == 0);
469 /* No replies were received within the timeout period */
471 if (num_replies == 0)
472 printf("No replies received\n");
474 messaging_deregister(msg_ctx, MSG_PONG, NULL);
476 return num_replies;
479 /* Set profiling options */
481 static bool do_profile(struct tevent_context *ev_ctx,
482 struct messaging_context *msg_ctx,
483 const struct server_id pid,
484 const int argc, const char **argv)
486 int v;
488 if (argc != 2) {
489 fprintf(stderr, "Usage: smbcontrol <dest> profile "
490 "<off|count|on|flush>\n");
491 return False;
494 if (strcmp(argv[1], "off") == 0) {
495 v = 0;
496 } else if (strcmp(argv[1], "count") == 0) {
497 v = 1;
498 } else if (strcmp(argv[1], "on") == 0) {
499 v = 2;
500 } else if (strcmp(argv[1], "flush") == 0) {
501 v = 3;
502 } else {
503 fprintf(stderr, "Unknown profile command '%s'\n", argv[1]);
504 return False;
507 return send_message(msg_ctx, pid, MSG_PROFILE, &v, sizeof(int));
510 /* Return the profiling level */
512 static void profilelevel_cb(struct messaging_context *msg_ctx,
513 void *private_data,
514 uint32_t msg_type,
515 struct server_id pid,
516 DATA_BLOB *data)
518 int level;
519 const char *s;
521 num_replies++;
523 if (data->length != sizeof(int)) {
524 fprintf(stderr, "invalid message length %ld returned\n",
525 (unsigned long)data->length);
526 return;
529 memcpy(&level, data->data, sizeof(int));
531 switch (level) {
532 case 0:
533 s = "not enabled";
534 break;
535 case 1:
536 s = "off";
537 break;
538 case 3:
539 s = "count only";
540 break;
541 case 7:
542 s = "count and time";
543 break;
544 default:
545 s = "BOGUS";
546 break;
549 printf("Profiling %s on pid %u\n",s,(unsigned int)procid_to_pid(&pid));
552 static void profilelevel_rqst(struct messaging_context *msg_ctx,
553 void *private_data,
554 uint32_t msg_type,
555 struct server_id pid,
556 DATA_BLOB *data)
558 int v = 0;
560 /* Send back a dummy reply */
562 send_message(msg_ctx, pid, MSG_PROFILELEVEL, &v, sizeof(int));
565 static bool do_profilelevel(struct tevent_context *ev_ctx,
566 struct messaging_context *msg_ctx,
567 const struct server_id pid,
568 const int argc, const char **argv)
570 if (argc != 1) {
571 fprintf(stderr, "Usage: smbcontrol <dest> profilelevel\n");
572 return False;
575 /* Send a message and register our interest in a reply */
577 if (!send_message(msg_ctx, pid, MSG_REQ_PROFILELEVEL, NULL, 0))
578 return False;
580 messaging_register(msg_ctx, NULL, MSG_PROFILELEVEL, profilelevel_cb);
581 messaging_register(msg_ctx, NULL, MSG_REQ_PROFILELEVEL,
582 profilelevel_rqst);
584 wait_replies(ev_ctx, msg_ctx, procid_to_pid(&pid) == 0);
586 /* No replies were received within the timeout period */
588 if (num_replies == 0)
589 printf("No replies received\n");
591 messaging_deregister(msg_ctx, MSG_PROFILE, NULL);
593 return num_replies;
596 /* Display debug level settings */
598 static bool do_debuglevel(struct tevent_context *ev_ctx,
599 struct messaging_context *msg_ctx,
600 const struct server_id pid,
601 const int argc, const char **argv)
603 if (argc != 1) {
604 fprintf(stderr, "Usage: smbcontrol <dest> debuglevel\n");
605 return False;
608 /* Send a message and register our interest in a reply */
610 if (!send_message(msg_ctx, pid, MSG_REQ_DEBUGLEVEL, NULL, 0))
611 return False;
613 messaging_register(msg_ctx, NULL, MSG_DEBUGLEVEL, print_pid_string_cb);
615 wait_replies(ev_ctx, msg_ctx, procid_to_pid(&pid) == 0);
617 /* No replies were received within the timeout period */
619 if (num_replies == 0)
620 printf("No replies received\n");
622 messaging_deregister(msg_ctx, MSG_DEBUGLEVEL, NULL);
624 return num_replies;
627 /* Send a print notify message */
629 static bool do_printnotify(struct tevent_context *ev_ctx,
630 struct messaging_context *msg_ctx,
631 const struct server_id pid,
632 const int argc, const char **argv)
634 const char *cmd;
636 /* Check for subcommand */
638 if (argc == 1) {
639 fprintf(stderr, "Must specify subcommand:\n");
640 fprintf(stderr, "\tqueuepause <printername>\n");
641 fprintf(stderr, "\tqueueresume <printername>\n");
642 fprintf(stderr, "\tjobpause <printername> <unix jobid>\n");
643 fprintf(stderr, "\tjobresume <printername> <unix jobid>\n");
644 fprintf(stderr, "\tjobdelete <printername> <unix jobid>\n");
645 fprintf(stderr, "\tprinter <printername> <comment|port|"
646 "driver> <value>\n");
648 return False;
651 cmd = argv[1];
653 if (strcmp(cmd, "queuepause") == 0) {
655 if (argc != 3) {
656 fprintf(stderr, "Usage: smbcontrol <dest> printnotify"
657 " queuepause <printername>\n");
658 return False;
661 notify_printer_status_byname(ev_ctx, msg_ctx, argv[2],
662 PRINTER_STATUS_PAUSED);
664 goto send;
666 } else if (strcmp(cmd, "queueresume") == 0) {
668 if (argc != 3) {
669 fprintf(stderr, "Usage: smbcontrol <dest> printnotify"
670 " queuereume <printername>\n");
671 return False;
674 notify_printer_status_byname(ev_ctx, msg_ctx, argv[2],
675 PRINTER_STATUS_OK);
677 goto send;
679 } else if (strcmp(cmd, "jobpause") == 0) {
680 int jobid;
682 if (argc != 4) {
683 fprintf(stderr, "Usage: smbcontrol <dest> printnotify"
684 " jobpause <printername> <unix-jobid>\n");
685 return False;
688 jobid = atoi(argv[3]);
690 notify_job_status_byname(
691 ev_ctx, msg_ctx,
692 argv[2], jobid, JOB_STATUS_PAUSED,
693 SPOOLSS_NOTIFY_MSG_UNIX_JOBID);
695 goto send;
697 } else if (strcmp(cmd, "jobresume") == 0) {
698 int jobid;
700 if (argc != 4) {
701 fprintf(stderr, "Usage: smbcontrol <dest> printnotify"
702 " jobpause <printername> <unix-jobid>\n");
703 return False;
706 jobid = atoi(argv[3]);
708 notify_job_status_byname(
709 ev_ctx, msg_ctx,
710 argv[2], jobid, JOB_STATUS_QUEUED,
711 SPOOLSS_NOTIFY_MSG_UNIX_JOBID);
713 goto send;
715 } else if (strcmp(cmd, "jobdelete") == 0) {
716 int jobid;
718 if (argc != 4) {
719 fprintf(stderr, "Usage: smbcontrol <dest> printnotify"
720 " jobpause <printername> <unix-jobid>\n");
721 return False;
724 jobid = atoi(argv[3]);
726 notify_job_status_byname(
727 ev_ctx, msg_ctx,
728 argv[2], jobid, JOB_STATUS_DELETING,
729 SPOOLSS_NOTIFY_MSG_UNIX_JOBID);
731 notify_job_status_byname(
732 ev_ctx, msg_ctx,
733 argv[2], jobid, JOB_STATUS_DELETING|
734 JOB_STATUS_DELETED,
735 SPOOLSS_NOTIFY_MSG_UNIX_JOBID);
737 goto send;
739 } else if (strcmp(cmd, "printer") == 0) {
740 uint32 attribute;
742 if (argc != 5) {
743 fprintf(stderr, "Usage: smbcontrol <dest> printnotify "
744 "printer <printername> <comment|port|driver> "
745 "<value>\n");
746 return False;
749 if (strcmp(argv[3], "comment") == 0) {
750 attribute = PRINTER_NOTIFY_FIELD_COMMENT;
751 } else if (strcmp(argv[3], "port") == 0) {
752 attribute = PRINTER_NOTIFY_FIELD_PORT_NAME;
753 } else if (strcmp(argv[3], "driver") == 0) {
754 attribute = PRINTER_NOTIFY_FIELD_DRIVER_NAME;
755 } else {
756 fprintf(stderr, "Invalid printer command '%s'\n",
757 argv[3]);
758 return False;
761 notify_printer_byname(ev_ctx, msg_ctx, argv[2], attribute,
762 discard_const_p(char, argv[4]));
764 goto send;
767 fprintf(stderr, "Invalid subcommand '%s'\n", cmd);
768 return False;
770 send:
771 print_notify_send_messages(msg_ctx, 0);
772 return True;
775 /* Close a share */
777 static bool do_closeshare(struct tevent_context *ev_ctx,
778 struct messaging_context *msg_ctx,
779 const struct server_id pid,
780 const int argc, const char **argv)
782 if (argc != 2) {
783 fprintf(stderr, "Usage: smbcontrol <dest> close-share "
784 "<sharename>\n");
785 return False;
788 return send_message(msg_ctx, pid, MSG_SMB_FORCE_TDIS, argv[1],
789 strlen(argv[1]) + 1);
792 /* Tell winbindd an IP got dropped */
794 static bool do_ip_dropped(struct tevent_context *ev_ctx,
795 struct messaging_context *msg_ctx,
796 const struct server_id pid,
797 const int argc, const char **argv)
799 if (argc != 2) {
800 fprintf(stderr, "Usage: smbcontrol <dest> ip-dropped "
801 "<ip-address>\n");
802 return False;
805 return send_message(msg_ctx, pid, MSG_WINBIND_IP_DROPPED, argv[1],
806 strlen(argv[1]) + 1);
809 /* force a blocking lock retry */
811 static bool do_lockretry(struct tevent_context *ev_ctx,
812 struct messaging_context *msg_ctx,
813 const struct server_id pid,
814 const int argc, const char **argv)
816 if (argc != 1) {
817 fprintf(stderr, "Usage: smbcontrol <dest> lockretry\n");
818 return False;
821 return send_message(msg_ctx, pid, MSG_SMB_UNLOCK, NULL, 0);
824 /* force a validation of all brl entries, including re-sends. */
826 static bool do_brl_revalidate(struct tevent_context *ev_ctx,
827 struct messaging_context *msg_ctx,
828 const struct server_id pid,
829 const int argc, const char **argv)
831 if (argc != 1) {
832 fprintf(stderr, "Usage: smbcontrol <dest> brl-revalidate\n");
833 return False;
836 return send_message(msg_ctx, pid, MSG_SMB_BRL_VALIDATE, NULL, 0);
839 /* Display talloc pool usage */
841 static bool do_poolusage(struct tevent_context *ev_ctx,
842 struct messaging_context *msg_ctx,
843 const struct server_id pid,
844 const int argc, const char **argv)
846 if (argc != 1) {
847 fprintf(stderr, "Usage: smbcontrol <dest> pool-usage\n");
848 return False;
851 messaging_register(msg_ctx, NULL, MSG_POOL_USAGE, print_string_cb);
853 /* Send a message and register our interest in a reply */
855 if (!send_message(msg_ctx, pid, MSG_REQ_POOL_USAGE, NULL, 0))
856 return False;
858 wait_replies(ev_ctx, msg_ctx, procid_to_pid(&pid) == 0);
860 /* No replies were received within the timeout period */
862 if (num_replies == 0)
863 printf("No replies received\n");
865 messaging_deregister(msg_ctx, MSG_POOL_USAGE, NULL);
867 return num_replies;
870 /* Perform a dmalloc mark */
872 static bool do_dmalloc_mark(struct tevent_context *ev_ctx,
873 struct messaging_context *msg_ctx,
874 const struct server_id pid,
875 const int argc, const char **argv)
877 if (argc != 1) {
878 fprintf(stderr, "Usage: smbcontrol <dest> dmalloc-mark\n");
879 return False;
882 return send_message(msg_ctx, pid, MSG_REQ_DMALLOC_MARK, NULL, 0);
885 /* Perform a dmalloc changed */
887 static bool do_dmalloc_changed(struct tevent_context *ev_ctx,
888 struct messaging_context *msg_ctx,
889 const struct server_id pid,
890 const int argc, const char **argv)
892 if (argc != 1) {
893 fprintf(stderr, "Usage: smbcontrol <dest> "
894 "dmalloc-log-changed\n");
895 return False;
898 return send_message(msg_ctx, pid, MSG_REQ_DMALLOC_LOG_CHANGED,
899 NULL, 0);
902 /* Shutdown a server process */
904 static bool do_shutdown(struct tevent_context *ev_ctx,
905 struct messaging_context *msg_ctx,
906 const struct server_id pid,
907 const int argc, const char **argv)
909 if (argc != 1) {
910 fprintf(stderr, "Usage: smbcontrol <dest> shutdown\n");
911 return False;
914 return send_message(msg_ctx, pid, MSG_SHUTDOWN, NULL, 0);
917 /* Notify a driver upgrade */
919 static bool do_drvupgrade(struct tevent_context *ev_ctx,
920 struct messaging_context *msg_ctx,
921 const struct server_id pid,
922 const int argc, const char **argv)
924 if (argc != 2) {
925 fprintf(stderr, "Usage: smbcontrol <dest> drvupgrade "
926 "<driver-name>\n");
927 return False;
930 return send_message(msg_ctx, pid, MSG_DEBUG, argv[1],
931 strlen(argv[1]) + 1);
934 static bool do_winbind_online(struct tevent_context *ev_ctx,
935 struct messaging_context *msg_ctx,
936 const struct server_id pid,
937 const int argc, const char **argv)
939 TDB_CONTEXT *tdb;
941 if (argc != 1) {
942 fprintf(stderr, "Usage: smbcontrol winbindd online\n");
943 return False;
946 /* Remove the entry in the winbindd_cache tdb to tell a later
947 starting winbindd that we're online. */
949 tdb = tdb_open_log(state_path("winbindd_cache.tdb"), 0, TDB_DEFAULT, O_RDWR, 0600);
950 if (!tdb) {
951 fprintf(stderr, "Cannot open the tdb %s for writing.\n",
952 state_path("winbindd_cache.tdb"));
953 return False;
956 tdb_delete_bystring(tdb, "WINBINDD_OFFLINE");
957 tdb_close(tdb);
959 return send_message(msg_ctx, pid, MSG_WINBIND_ONLINE, NULL, 0);
962 static bool do_winbind_offline(struct tevent_context *ev_ctx,
963 struct messaging_context *msg_ctx,
964 const struct server_id pid,
965 const int argc, const char **argv)
967 TDB_CONTEXT *tdb;
968 bool ret = False;
969 int retry = 0;
971 if (argc != 1) {
972 fprintf(stderr, "Usage: smbcontrol winbindd offline\n");
973 return False;
976 /* Create an entry in the winbindd_cache tdb to tell a later
977 starting winbindd that we're offline. We may actually create
978 it here... */
980 tdb = tdb_open_log(state_path("winbindd_cache.tdb"),
981 WINBINDD_CACHE_TDB_DEFAULT_HASH_SIZE,
982 TDB_DEFAULT|TDB_INCOMPATIBLE_HASH /* TDB_CLEAR_IF_FIRST */,
983 O_RDWR|O_CREAT, 0600);
985 if (!tdb) {
986 fprintf(stderr, "Cannot open the tdb %s for writing.\n",
987 state_path("winbindd_cache.tdb"));
988 return False;
991 /* There's a potential race condition that if a child
992 winbindd detects a domain is online at the same time
993 we're trying to tell it to go offline that it might
994 delete the record we add between us adding it and
995 sending the message. Minimize this by retrying up to
996 5 times. */
998 for (retry = 0; retry < 5; retry++) {
999 TDB_DATA d;
1000 uint8 buf[4];
1002 ZERO_STRUCT(d);
1004 SIVAL(buf, 0, time(NULL));
1005 d.dptr = buf;
1006 d.dsize = 4;
1008 tdb_store_bystring(tdb, "WINBINDD_OFFLINE", d, TDB_INSERT);
1010 ret = send_message(msg_ctx, pid, MSG_WINBIND_OFFLINE,
1011 NULL, 0);
1013 /* Check that the entry "WINBINDD_OFFLINE" still exists. */
1014 d = tdb_fetch_bystring( tdb, "WINBINDD_OFFLINE" );
1016 if (!d.dptr || d.dsize != 4) {
1017 SAFE_FREE(d.dptr);
1018 DEBUG(10,("do_winbind_offline: offline state not set - retrying.\n"));
1019 } else {
1020 SAFE_FREE(d.dptr);
1021 break;
1025 tdb_close(tdb);
1026 return ret;
1029 static bool do_winbind_onlinestatus(struct tevent_context *ev_ctx,
1030 struct messaging_context *msg_ctx,
1031 const struct server_id pid,
1032 const int argc, const char **argv)
1034 struct server_id myid;
1036 myid = messaging_server_id(msg_ctx);
1038 if (argc != 1) {
1039 fprintf(stderr, "Usage: smbcontrol winbindd onlinestatus\n");
1040 return False;
1043 messaging_register(msg_ctx, NULL, MSG_WINBIND_ONLINESTATUS,
1044 print_pid_string_cb);
1046 if (!send_message(msg_ctx, pid, MSG_WINBIND_ONLINESTATUS, &myid,
1047 sizeof(myid)))
1048 return False;
1050 wait_replies(ev_ctx, msg_ctx, procid_to_pid(&pid) == 0);
1052 /* No replies were received within the timeout period */
1054 if (num_replies == 0)
1055 printf("No replies received\n");
1057 messaging_deregister(msg_ctx, MSG_WINBIND_ONLINESTATUS, NULL);
1059 return num_replies;
1062 static bool do_dump_event_list(struct tevent_context *ev_ctx,
1063 struct messaging_context *msg_ctx,
1064 const struct server_id pid,
1065 const int argc, const char **argv)
1067 struct server_id myid;
1069 myid = messaging_server_id(msg_ctx);
1071 if (argc != 1) {
1072 fprintf(stderr, "Usage: smbcontrol <dest> dump-event-list\n");
1073 return False;
1076 return send_message(msg_ctx, pid, MSG_DUMP_EVENT_LIST, NULL, 0);
1079 static bool do_winbind_dump_domain_list(struct tevent_context *ev_ctx,
1080 struct messaging_context *msg_ctx,
1081 const struct server_id pid,
1082 const int argc, const char **argv)
1084 const char *domain = NULL;
1085 int domain_len = 0;
1086 struct server_id myid;
1087 uint8_t *buf = NULL;
1088 int buf_len = 0;
1090 myid = messaging_server_id(msg_ctx);
1092 if (argc < 1 || argc > 2) {
1093 fprintf(stderr, "Usage: smbcontrol <dest> dump-domain-list "
1094 "<domain>\n");
1095 return false;
1098 if (argc == 2) {
1099 domain = argv[1];
1100 domain_len = strlen(argv[1]) + 1;
1103 messaging_register(msg_ctx, NULL, MSG_WINBIND_DUMP_DOMAIN_LIST,
1104 print_pid_string_cb);
1106 buf_len = sizeof(myid)+domain_len;
1107 buf = SMB_MALLOC_ARRAY(uint8_t, buf_len);
1108 if (!buf) {
1109 return false;
1112 memcpy(buf, &myid, sizeof(myid));
1113 memcpy(&buf[sizeof(myid)], domain, domain_len);
1115 if (!send_message(msg_ctx, pid, MSG_WINBIND_DUMP_DOMAIN_LIST,
1116 buf, buf_len))
1118 SAFE_FREE(buf);
1119 return false;
1122 wait_replies(ev_ctx, msg_ctx, procid_to_pid(&pid) == 0);
1124 /* No replies were received within the timeout period */
1126 SAFE_FREE(buf);
1127 if (num_replies == 0) {
1128 printf("No replies received\n");
1131 messaging_deregister(msg_ctx, MSG_WINBIND_DUMP_DOMAIN_LIST, NULL);
1133 return num_replies;
1136 static void winbind_validate_cache_cb(struct messaging_context *msg,
1137 void *private_data,
1138 uint32_t msg_type,
1139 struct server_id pid,
1140 DATA_BLOB *data)
1142 char *src_string = server_id_str(NULL, &pid);
1143 printf("Winbindd cache is %svalid. (answer from pid %s)\n",
1144 (*(data->data) == 0 ? "" : "NOT "), src_string);
1145 TALLOC_FREE(src_string);
1146 num_replies++;
1149 static bool do_winbind_validate_cache(struct tevent_context *ev_ctx,
1150 struct messaging_context *msg_ctx,
1151 const struct server_id pid,
1152 const int argc, const char **argv)
1154 struct server_id myid;
1156 myid = messaging_server_id(msg_ctx);
1158 if (argc != 1) {
1159 fprintf(stderr, "Usage: smbcontrol winbindd validate-cache\n");
1160 return False;
1163 messaging_register(msg_ctx, NULL, MSG_WINBIND_VALIDATE_CACHE,
1164 winbind_validate_cache_cb);
1166 if (!send_message(msg_ctx, pid, MSG_WINBIND_VALIDATE_CACHE, &myid,
1167 sizeof(myid))) {
1168 return False;
1171 wait_replies(ev_ctx, msg_ctx, procid_to_pid(&pid) == 0);
1173 if (num_replies == 0) {
1174 printf("No replies received\n");
1177 messaging_deregister(msg_ctx, MSG_WINBIND_VALIDATE_CACHE, NULL);
1179 return num_replies;
1182 static bool do_reload_config(struct tevent_context *ev_ctx,
1183 struct messaging_context *msg_ctx,
1184 const struct server_id pid,
1185 const int argc, const char **argv)
1187 if (argc != 1) {
1188 fprintf(stderr, "Usage: smbcontrol <dest> reload-config\n");
1189 return False;
1192 return send_message(msg_ctx, pid, MSG_SMB_CONF_UPDATED, NULL, 0);
1195 static bool do_reload_printers(struct tevent_context *ev_ctx,
1196 struct messaging_context *msg_ctx,
1197 const struct server_id pid,
1198 const int argc, const char **argv)
1200 if (argc != 1) {
1201 fprintf(stderr, "Usage: smbcontrol <dest> reload-printers\n");
1202 return False;
1205 return send_message(msg_ctx, pid, MSG_PRINTER_PCAP, NULL, 0);
1208 static void my_make_nmb_name( struct nmb_name *n, const char *name, int type)
1210 fstring unix_name;
1211 memset( (char *)n, '\0', sizeof(struct nmb_name) );
1212 fstrcpy(unix_name, name);
1213 strupper_m(unix_name);
1214 push_ascii(n->name, unix_name, sizeof(n->name), STR_TERMINATE);
1215 n->name_type = (unsigned int)type & 0xFF;
1216 push_ascii(n->scope, lp_netbios_scope(), 64, STR_TERMINATE);
1219 static bool do_nodestatus(struct tevent_context *ev_ctx,
1220 struct messaging_context *msg_ctx,
1221 const struct server_id pid,
1222 const int argc, const char **argv)
1224 struct packet_struct p;
1226 if (argc != 2) {
1227 fprintf(stderr, "Usage: smbcontrol nmbd nodestatus <ip>\n");
1228 return False;
1231 ZERO_STRUCT(p);
1233 p.ip = interpret_addr2(argv[1]);
1234 p.port = 137;
1235 p.packet_type = NMB_PACKET;
1237 p.packet.nmb.header.name_trn_id = 10;
1238 p.packet.nmb.header.opcode = 0;
1239 p.packet.nmb.header.response = False;
1240 p.packet.nmb.header.nm_flags.bcast = False;
1241 p.packet.nmb.header.nm_flags.recursion_available = False;
1242 p.packet.nmb.header.nm_flags.recursion_desired = False;
1243 p.packet.nmb.header.nm_flags.trunc = False;
1244 p.packet.nmb.header.nm_flags.authoritative = False;
1245 p.packet.nmb.header.rcode = 0;
1246 p.packet.nmb.header.qdcount = 1;
1247 p.packet.nmb.header.ancount = 0;
1248 p.packet.nmb.header.nscount = 0;
1249 p.packet.nmb.header.arcount = 0;
1250 my_make_nmb_name(&p.packet.nmb.question.question_name, "*", 0x00);
1251 p.packet.nmb.question.question_type = 0x21;
1252 p.packet.nmb.question.question_class = 0x1;
1254 return send_message(msg_ctx, pid, MSG_SEND_PACKET, &p, sizeof(p));
1257 /* A list of message type supported */
1259 static const struct {
1260 const char *name; /* Option name */
1261 bool (*fn)(struct tevent_context *ev_ctx,
1262 struct messaging_context *msg_ctx,
1263 const struct server_id pid,
1264 const int argc, const char **argv);
1265 const char *help; /* Short help text */
1266 } msg_types[] = {
1267 { "debug", do_debug, "Set debuglevel" },
1268 { "idmap", do_idmap, "Manipulate idmap cache" },
1269 { "force-election", do_election,
1270 "Force a browse election" },
1271 { "ping", do_ping, "Elicit a response" },
1272 { "profile", do_profile, "" },
1273 { "inject", do_inject_fault,
1274 "Inject a fatal signal into a running smbd"},
1275 { "stacktrace", do_daemon_stack_trace,
1276 "Display a stack trace of a daemon" },
1277 { "profilelevel", do_profilelevel, "" },
1278 { "debuglevel", do_debuglevel, "Display current debuglevels" },
1279 { "printnotify", do_printnotify, "Send a print notify message" },
1280 { "close-share", do_closeshare, "Forcibly disconnect a share" },
1281 { "ip-dropped", do_ip_dropped, "Tell winbind that an IP got dropped" },
1282 { "lockretry", do_lockretry, "Force a blocking lock retry" },
1283 { "brl-revalidate", do_brl_revalidate, "Revalidate all brl entries" },
1284 { "pool-usage", do_poolusage, "Display talloc memory usage" },
1285 { "dmalloc-mark", do_dmalloc_mark, "" },
1286 { "dmalloc-log-changed", do_dmalloc_changed, "" },
1287 { "shutdown", do_shutdown, "Shut down daemon" },
1288 { "drvupgrade", do_drvupgrade, "Notify a printer driver has changed" },
1289 { "reload-config", do_reload_config, "Force smbd or winbindd to reload config file"},
1290 { "reload-printers", do_reload_printers, "Force smbd to reload printers"},
1291 { "nodestatus", do_nodestatus, "Ask nmbd to do a node status request"},
1292 { "online", do_winbind_online, "Ask winbind to go into online state"},
1293 { "offline", do_winbind_offline, "Ask winbind to go into offline state"},
1294 { "onlinestatus", do_winbind_onlinestatus, "Request winbind online status"},
1295 { "dump-event-list", do_dump_event_list, "Dump event list"},
1296 { "validate-cache" , do_winbind_validate_cache,
1297 "Validate winbind's credential cache" },
1298 { "dump-domain-list", do_winbind_dump_domain_list, "Dump winbind domain list"},
1299 { "noop", do_noop, "Do nothing" },
1300 { NULL }
1303 /* Display usage information */
1305 static void usage(poptContext pc)
1307 int i;
1309 poptPrintHelp(pc, stderr, 0);
1311 fprintf(stderr, "\n");
1312 fprintf(stderr, "<destination> is one of \"nmbd\", \"smbd\", \"winbindd\" or a "
1313 "process ID\n");
1315 fprintf(stderr, "\n");
1316 fprintf(stderr, "<message-type> is one of:\n");
1318 for (i = 0; msg_types[i].name; i++)
1319 fprintf(stderr, "\t%-30s%s\n", msg_types[i].name,
1320 msg_types[i].help);
1322 fprintf(stderr, "\n");
1324 exit(1);
1327 /* Return the pid number for a string destination */
1329 static struct server_id parse_dest(struct messaging_context *msg,
1330 const char *dest)
1332 struct server_id result = {-1};
1333 pid_t pid;
1335 /* Zero is a special return value for broadcast to all processes */
1337 if (strequal(dest, "all")) {
1338 return interpret_pid(MSG_BROADCAST_PID_STR);
1341 /* Try self - useful for testing */
1343 if (strequal(dest, "self")) {
1344 return messaging_server_id(msg);
1347 /* Fix winbind typo. */
1348 if (strequal(dest, "winbind")) {
1349 dest = "winbindd";
1352 /* Check for numeric pid number */
1353 result = interpret_pid(dest);
1355 /* Zero isn't valid if not "all". */
1356 if (result.pid && procid_valid(&result)) {
1357 return result;
1360 /* Look up other destinations in pidfile directory */
1362 if ((pid = pidfile_pid(dest)) != 0) {
1363 return pid_to_procid(pid);
1366 fprintf(stderr,"Can't find pid for destination '%s'\n", dest);
1368 return result;
1371 /* Execute smbcontrol command */
1373 static bool do_command(struct tevent_context *ev_ctx,
1374 struct messaging_context *msg_ctx,
1375 int argc, const char **argv)
1377 const char *dest = argv[0], *command = argv[1];
1378 struct server_id pid;
1379 int i;
1381 /* Check destination */
1383 pid = parse_dest(msg_ctx, dest);
1384 if (!procid_valid(&pid)) {
1385 return False;
1388 /* Check command */
1390 for (i = 0; msg_types[i].name; i++) {
1391 if (strequal(command, msg_types[i].name))
1392 return msg_types[i].fn(ev_ctx, msg_ctx, pid,
1393 argc - 1, argv + 1);
1396 fprintf(stderr, "smbcontrol: unknown command '%s'\n", command);
1398 return False;
1401 static void smbcontrol_help(poptContext pc,
1402 enum poptCallbackReason preason,
1403 struct poptOption * poption,
1404 const char * parg,
1405 void * pdata)
1407 if (poption->shortName != '?') {
1408 poptPrintUsage(pc, stdout, 0);
1409 } else {
1410 usage(pc);
1413 exit(0);
1416 struct poptOption help_options[] = {
1417 { NULL, '\0', POPT_ARG_CALLBACK, (void *)&smbcontrol_help, '\0',
1418 NULL, NULL },
1419 { "help", '?', 0, NULL, '?', "Show this help message", NULL },
1420 { "usage", '\0', 0, NULL, 'u', "Display brief usage message", NULL },
1421 { NULL }
1424 /* Main program */
1426 int main(int argc, const char **argv)
1428 poptContext pc;
1429 int opt;
1430 struct tevent_context *evt_ctx;
1431 struct messaging_context *msg_ctx;
1433 static struct poptOption long_options[] = {
1434 /* POPT_AUTOHELP */
1435 { NULL, '\0', POPT_ARG_INCLUDE_TABLE, help_options,
1436 0, "Help options:", NULL },
1437 { "timeout", 't', POPT_ARG_INT, &timeout, 't',
1438 "Set timeout value in seconds", "TIMEOUT" },
1440 POPT_COMMON_SAMBA
1441 POPT_TABLEEND
1443 TALLOC_CTX *frame = talloc_stackframe();
1444 int ret = 0;
1446 load_case_tables();
1448 setup_logging(argv[0], DEBUG_STDOUT);
1450 /* Parse command line arguments using popt */
1452 pc = poptGetContext(
1453 "smbcontrol", argc, (const char **)argv, long_options, 0);
1455 poptSetOtherOptionHelp(pc, "[OPTION...] <destination> <message-type> "
1456 "<parameters>");
1458 if (argc == 1)
1459 usage(pc);
1461 while ((opt = poptGetNextOpt(pc)) != -1) {
1462 switch(opt) {
1463 case 't': /* --timeout */
1464 break;
1465 default:
1466 fprintf(stderr, "Invalid option\n");
1467 poptPrintHelp(pc, stderr, 0);
1468 break;
1472 /* We should now have the remaining command line arguments in
1473 argv. The argc parameter should have been decremented to the
1474 correct value in the above switch statement. */
1476 argv = (const char **)poptGetArgs(pc);
1477 argc = 0;
1478 if (argv != NULL) {
1479 while (argv[argc] != NULL) {
1480 argc++;
1484 if (argc <= 1)
1485 usage(pc);
1487 lp_load_global(get_dyn_CONFIGFILE());
1489 /* Need to invert sense of return code -- samba
1490 * routines mostly return True==1 for success, but
1491 * shell needs 0. */
1493 if (!(evt_ctx = tevent_context_init(NULL)) ||
1494 !(msg_ctx = messaging_init(NULL, evt_ctx))) {
1495 fprintf(stderr, "could not init messaging context\n");
1496 TALLOC_FREE(frame);
1497 exit(1);
1500 ret = !do_command(evt_ctx, msg_ctx, argc, argv);
1501 TALLOC_FREE(frame);
1502 return ret;