2 Unix SMB/CIFS implementation.
3 NBT netbios routines and daemon - version 2
4 Copyright (C) Andrew Tridgell 1994-1998
5 Copyright (C) Jeremy Allison 1997-2002
6 Copyright (C) Jelmer Vernooij 2002,2003 (Conversion to popt)
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
27 int global_nmb_port = -1;
29 extern bool rescan_listen_set;
30 extern bool global_in_nmbd;
32 extern bool override_logfile;
34 /* have we found LanMan clients yet? */
35 bool found_lm_clients = False;
37 /* what server type are we currently */
39 time_t StartupTime = 0;
41 struct event_context *nmbd_event_context(void)
43 static struct event_context *ctx;
45 if (!ctx && !(ctx = event_context_init(NULL))) {
46 smb_panic("Could not init nmbd event context");
51 struct messaging_context *nmbd_messaging_context(void)
53 static struct messaging_context *ctx;
55 if (!ctx && !(ctx = messaging_init(NULL, server_id_self(),
56 nmbd_event_context()))) {
57 smb_panic("Could not init nmbd messaging context");
62 /**************************************************************************** **
63 Handle a SIGTERM in band.
64 **************************************************************************** */
66 static void terminate(void)
68 DEBUG(0,("Got SIGTERM: going down...\n"));
70 /* Write out wins.dat file if samba is a WINS server */
71 wins_write_database(0,False);
73 /* Remove all SELF registered names from WINS */
76 /* Announce all server entries as 0 time-to-live, 0 type. */
77 announce_my_servers_removed();
79 /* If there was an async dns child - kill it. */
80 kill_async_dns_child();
85 /**************************************************************************** **
86 Handle a SHUTDOWN message from smbcontrol.
87 **************************************************************************** */
89 static void nmbd_terminate(struct messaging_context *msg,
92 struct server_id server_id,
98 /**************************************************************************** **
99 Catch a SIGTERM signal.
100 **************************************************************************** */
102 static SIG_ATOMIC_T got_sig_term;
104 static void sig_term(int sig)
107 sys_select_signal(SIGTERM);
110 /**************************************************************************** **
111 Catch a SIGHUP signal.
112 **************************************************************************** */
114 static SIG_ATOMIC_T reload_after_sighup;
116 static void sig_hup(int sig)
118 reload_after_sighup = 1;
119 sys_select_signal(SIGHUP);
122 /**************************************************************************** **
123 Possibly continue after a fault.
124 **************************************************************************** */
126 static void fault_continue(void)
131 /**************************************************************************** **
132 Expire old names from the namelist and server list.
133 **************************************************************************** */
135 static void expire_names_and_servers(time_t t)
137 static time_t lastrun = 0;
141 if ( t < (lastrun + 5) )
146 * Expire any timed out names on all the broadcast
147 * subnets and those registered with the WINS server.
148 * (nmbd_namelistdb.c)
154 * Go through all the broadcast subnets and for each
155 * workgroup known on that subnet remove any expired
156 * server names. If a workgroup has an empty serverlist
157 * and has itself timed out then remove the workgroup.
158 * (nmbd_workgroupdb.c)
161 expire_workgroups_and_servers(t);
164 /************************************************************************** **
165 Reload the list of network interfaces.
166 Doesn't return until a network interface is up.
167 ************************************************************************** */
169 static void reload_interfaces(time_t t)
173 struct subnet_record *subrec;
175 if (t && ((t - lastt) < NMBD_INTERFACES_RELOAD)) {
181 if (!interfaces_changed()) {
187 /* the list of probed interfaces has changed, we may need to add/remove
192 /* find any interfaces that need adding */
193 for (n=iface_count() - 1; n >= 0; n--) {
194 char str[INET6_ADDRSTRLEN];
195 const struct interface *iface = get_interface(n);
196 struct in_addr ip, nmask;
199 DEBUG(2,("reload_interfaces: failed to get interface %d\n", n));
203 /* Ensure we're only dealing with IPv4 here. */
204 if (iface->ip.ss_family != AF_INET) {
205 DEBUG(2,("reload_interfaces: "
206 "ignoring non IPv4 interface.\n"));
210 ip = ((struct sockaddr_in *)&iface->ip)->sin_addr;
211 nmask = ((struct sockaddr_in *)&iface->netmask)->sin_addr;
214 * We don't want to add a loopback interface, in case
215 * someone has added 127.0.0.1 for smbd, nmbd needs to
216 * ignore it here. JRA.
219 if (is_loopback_addr(&iface->ip)) {
220 DEBUG(2,("reload_interfaces: Ignoring loopback "
222 print_sockaddr(str, sizeof(str), &iface->ip) ));
226 for (subrec=subnetlist; subrec; subrec=subrec->next) {
227 if (ip_equal_v4(ip, subrec->myip) &&
228 ip_equal_v4(nmask, subrec->mask_ip)) {
234 /* it wasn't found! add it */
235 DEBUG(2,("Found new interface %s\n",
237 sizeof(str), &iface->ip) ));
238 subrec = make_normal_subnet(iface);
240 register_my_workgroup_one_subnet(subrec);
244 /* find any interfaces that need deleting */
245 for (subrec=subnetlist; subrec; subrec=subrec->next) {
246 for (n=iface_count() - 1; n >= 0; n--) {
247 struct interface *iface = get_interface(n);
248 struct in_addr ip, nmask;
252 /* Ensure we're only dealing with IPv4 here. */
253 if (iface->ip.ss_family != AF_INET) {
254 DEBUG(2,("reload_interfaces: "
255 "ignoring non IPv4 interface.\n"));
258 ip = ((struct sockaddr_in *)&iface->ip)->sin_addr;
259 nmask = ((struct sockaddr_in *)&iface->netmask)->sin_addr;
260 if (ip_equal_v4(ip, subrec->myip) &&
261 ip_equal_v4(nmask, subrec->mask_ip)) {
266 /* oops, an interface has disapeared. This is
267 tricky, we don't dare actually free the
268 interface as it could be being used, so
269 instead we just wear the memory leak and
270 remove it from the list of interfaces without
272 DEBUG(2,("Deleting dead interface %s\n",
273 inet_ntoa(subrec->myip)));
274 close_subnet(subrec);
278 rescan_listen_set = True;
280 /* We need to wait if there are no subnets... */
281 if (FIRST_SUBNET == NULL) {
283 DEBUG(0,("reload_interfaces: "
284 "No subnets to listen to. Waiting..\n"));
287 * Whilst we're waiting for an interface, allow SIGTERM to
291 BlockSignals(false, SIGTERM);
293 /* We only count IPv4 interfaces here. */
294 while (iface_count_v4() == 0 && !got_sig_term) {
300 * Handle termination inband.
309 * We got an interface, go back to blocking term.
312 BlockSignals(true, SIGTERM);
317 /**************************************************************************** **
318 Reload the services file.
319 **************************************************************************** */
321 static bool reload_nmbd_services(bool test)
325 set_remote_machine_name("nmbd", False);
328 const char *fname = lp_configfile();
329 if (file_exist(fname,NULL) && !strcsequal(fname,get_dyn_CONFIGFILE())) {
330 set_dyn_CONFIGFILE(fname);
335 if ( test && !lp_file_list_changed() )
338 ret = lp_load(get_dyn_CONFIGFILE(), True , False, False, True);
340 /* perhaps the config filename is now set */
342 DEBUG( 3, ( "services not loaded\n" ) );
343 reload_nmbd_services( True );
349 /**************************************************************************** **
350 * React on 'smbcontrol nmbd reload-config' in the same way as to SIGHUP
351 **************************************************************************** */
353 static void msg_reload_nmbd_services(struct messaging_context *msg,
356 struct server_id server_id,
359 write_browse_list( 0, True );
360 dump_all_namelists();
361 reload_nmbd_services( True );
363 reload_interfaces(0);
366 static void msg_nmbd_send_packet(struct messaging_context *msg,
369 struct server_id src,
372 struct packet_struct *p = (struct packet_struct *)data->data;
373 struct subnet_record *subrec;
374 struct sockaddr_storage ss;
375 const struct sockaddr_storage *pss;
376 const struct in_addr *local_ip;
378 DEBUG(10, ("Received send_packet from %d\n", procid_to_pid(&src)));
380 if (data->length != sizeof(struct packet_struct)) {
381 DEBUG(2, ("Discarding invalid packet length from %d\n",
382 procid_to_pid(&src)));
386 if ((p->packet_type != NMB_PACKET) &&
387 (p->packet_type != DGRAM_PACKET)) {
388 DEBUG(2, ("Discarding invalid packet type from %d: %d\n",
389 procid_to_pid(&src), p->packet_type));
393 in_addr_to_sockaddr_storage(&ss, p->ip);
397 DEBUG(2, ("Could not find ip for packet from %d\n",
398 procid_to_pid(&src)));
402 local_ip = &((const struct sockaddr_in *)pss)->sin_addr;
403 subrec = FIRST_SUBNET;
405 p->fd = (p->packet_type == NMB_PACKET) ?
406 subrec->nmb_sock : subrec->dgram_sock;
408 for (subrec = FIRST_SUBNET; subrec != NULL;
409 subrec = NEXT_SUBNET_EXCLUDING_UNICAST(subrec)) {
410 if (ip_equal_v4(*local_ip, subrec->myip)) {
411 p->fd = (p->packet_type == NMB_PACKET) ?
412 subrec->nmb_sock : subrec->dgram_sock;
417 if (p->packet_type == DGRAM_PACKET) {
419 p->packet.dgram.header.source_ip.s_addr = local_ip->s_addr;
420 p->packet.dgram.header.source_port = 138;
426 /**************************************************************************** **
427 The main select loop.
428 **************************************************************************** */
430 static void process(void)
435 time_t t = time(NULL);
436 TALLOC_CTX *frame = talloc_stackframe();
438 /* Check for internal messages */
440 message_dispatch(nmbd_messaging_context());
443 * Check all broadcast subnets to see if
444 * we need to run an election on any of them.
448 run_election = check_elections();
451 * Read incoming UDP packets.
455 if(listen_for_packets(run_election)) {
461 * Handle termination inband.
470 * Process all incoming packets
471 * read above. This calls the success and
472 * failure functions registered when response
473 * packets arrrive, and also deals with request
474 * packets from other sources.
481 * Run any elections - initiate becoming
482 * a local master browser if we have won.
489 * Send out any broadcast announcements
490 * of our server names. This also announces
491 * the workgroup name if we are a local
493 * (nmbd_sendannounce.c)
496 announce_my_server_names(t);
499 * Send out any LanMan broadcast announcements
500 * of our server names.
501 * (nmbd_sendannounce.c)
504 announce_my_lm_server_names(t);
507 * If we are a local master browser, periodically
508 * announce ourselves to the domain master browser.
509 * This also deals with syncronising the domain master
510 * browser server lists with ourselves as a local
512 * (nmbd_sendannounce.c)
515 announce_myself_to_domain_master_browser(t);
518 * Fullfill any remote announce requests.
519 * (nmbd_sendannounce.c)
525 * Fullfill any remote browse sync announce requests.
526 * (nmbd_sendannounce.c)
529 browse_sync_remote(t);
532 * Scan the broadcast subnets, and WINS client
533 * namelists and refresh any that need refreshing.
540 * Scan the subnet namelists and server lists and
541 * expire thos that have timed out.
545 expire_names_and_servers(t);
548 * Write out a snapshot of our current browse list into
549 * the browse.dat file. This is used by smbd to service
550 * incoming NetServerEnum calls - used to synchronise
551 * browse lists over subnets.
552 * (nmbd_serverlistdb.c)
555 write_browse_list(t, False);
558 * If we are a domain master browser, we have a list of
559 * local master browsers we should synchronise browse
560 * lists with (these are added by an incoming local
561 * master browser announcement packet). Expire any of
562 * these that are no longer current, and pull the server
563 * lists from each of these known local master browsers.
564 * (nmbd_browsesync.c)
567 dmb_expire_and_sync_browser_lists(t);
570 * Check that there is a local master browser for our
571 * workgroup for all our broadcast subnets. If one
572 * is not found, start an election (which we ourselves
573 * may or may not participate in, depending on the
574 * setting of the 'local master' parameter.
578 check_master_browser_exists(t);
581 * If we are configured as a logon server, attempt to
582 * register the special NetBIOS names to become such
583 * (WORKGROUP<1c> name) on all broadcast subnets and
584 * with the WINS server (if used). If we are configured
585 * to become a domain master browser, attempt to register
586 * the special NetBIOS name (WORKGROUP<1b> name) to
588 * (nmbd_become_dmb.c)
594 * If we are a WINS server, do any timer dependent
595 * processing required.
596 * (nmbd_winsserver.c)
599 initiate_wins_processing(t);
602 * If we are a domain master browser, attempt to contact the
603 * WINS server to get a list of all known WORKGROUPS/DOMAINS.
604 * This will only work to a Samba WINS server.
605 * (nmbd_browsesync.c)
608 if (lp_enhanced_browsing())
609 collect_all_workgroup_names_from_wins_server(t);
612 * Go through the response record queue and time out or re-transmit
613 * and expired entries.
617 retransmit_or_expire_response_records(t);
620 * check to see if any remote browse sync child processes have completed
623 sync_check_completion();
626 * regularly sync with any other DMBs we know about
629 if (lp_enhanced_browsing())
633 * clear the unexpected packet queue
639 * Reload the services file if we got a sighup.
642 if(reload_after_sighup) {
643 DEBUG( 0, ( "Got SIGHUP dumping debug info.\n" ) );
644 msg_reload_nmbd_services(nmbd_messaging_context(),
645 NULL, MSG_SMB_CONF_UPDATED,
646 procid_self(), NULL);
648 reload_after_sighup = 0;
651 /* check for new network interfaces */
653 reload_interfaces(t);
655 /* free up temp memory */
660 /**************************************************************************** **
661 Open the socket communication.
662 **************************************************************************** */
664 static bool open_sockets(bool isdaemon, int port)
666 struct sockaddr_storage ss;
667 const char *sock_addr = lp_socket_address();
670 * The sockets opened here will be used to receive broadcast
671 * packets *only*. Interface specific sockets are opened in
672 * make_subnet() in namedbsubnet.c. Thus we bind to the
673 * address "0.0.0.0". The parameter 'socket address' is
677 if (!interpret_string_addr(&ss, sock_addr,
678 AI_NUMERICHOST|AI_PASSIVE)) {
679 DEBUG(0,("open_sockets: unable to get socket address "
680 "from string %s", sock_addr));
683 if (ss.ss_family != AF_INET) {
684 DEBUG(0,("open_sockets: unable to use IPv6 socket"
691 ClientNMB = open_socket_in(SOCK_DGRAM, port,
698 if (ClientNMB == -1) {
702 ClientDGRAM = open_socket_in(SOCK_DGRAM, DGRAM_PORT,
706 if (ClientDGRAM == -1) {
707 if (ClientNMB != 0) {
713 /* we are never interested in SIGPIPE */
714 BlockSignals(True,SIGPIPE);
716 set_socket_options( ClientNMB, "SO_BROADCAST" );
717 set_socket_options( ClientDGRAM, "SO_BROADCAST" );
719 /* Ensure we're non-blocking. */
720 set_blocking( ClientNMB, False);
721 set_blocking( ClientDGRAM, False);
723 DEBUG( 3, ( "open_sockets: Broadcast sockets opened.\n" ) );
727 /**************************************************************************** **
729 **************************************************************************** */
731 int main(int argc, const char *argv[])
733 static bool is_daemon;
734 static bool opt_interactive;
735 static bool Fork = true;
736 static bool no_process_group;
737 static bool log_stdout;
739 char *p_lmhosts = NULL;
745 OPT_NO_PROCESS_GROUP,
748 struct poptOption long_options[] = {
750 {"daemon", 'D', POPT_ARG_NONE, NULL, OPT_DAEMON, "Become a daemon(default)" },
751 {"interactive", 'i', POPT_ARG_NONE, NULL, OPT_INTERACTIVE, "Run interactive (not a daemon)" },
752 {"foreground", 'F', POPT_ARG_NONE, NULL, OPT_FORK, "Run daemon in foreground (for daemontools & etc)" },
753 {"no-process-group", 0, POPT_ARG_NONE, NULL, OPT_NO_PROCESS_GROUP, "Don't create a new process group" },
754 {"log-stdout", 'S', POPT_ARG_NONE, NULL, OPT_LOG_STDOUT, "Log to stdout" },
755 {"hosts", 'H', POPT_ARG_STRING, &p_lmhosts, 'H', "Load a netbios hosts file"},
756 {"port", 'p', POPT_ARG_INT, &global_nmb_port, NMB_PORT, "Listen on the specified port" },
760 TALLOC_CTX *frame = talloc_stackframe(); /* Setup tos. */
764 global_nmb_port = NMB_PORT;
766 pc = poptGetContext("nmbd", argc, argv, long_options, 0);
767 while ((opt = poptGetNextOpt(pc)) != -1) {
772 case OPT_INTERACTIVE:
773 opt_interactive = true;
778 case OPT_NO_PROCESS_GROUP:
779 no_process_group = true;
785 d_fprintf(stderr, "\nInvalid option %s: %s\n\n",
786 poptBadOption(pc, 0), poptStrerror(opt));
787 poptPrintUsage(pc, stderr, 0);
793 global_in_nmbd = true;
795 StartupTime = time(NULL);
797 sys_srandom(time(NULL) ^ sys_getpid());
799 if (!override_logfile) {
800 char *logfile = NULL;
801 if (asprintf(&logfile, "%s/log.nmbd", get_dyn_LOGFILEBASE()) < 0) {
804 lp_set_logfile(logfile);
808 fault_setup((void (*)(void *))fault_continue );
809 dump_core_setup("nmbd");
811 /* POSIX demands that signals are inherited. If the invoking process has
812 * these signals masked, we will have problems, as we won't receive them. */
813 BlockSignals(False, SIGHUP);
814 BlockSignals(False, SIGUSR1);
815 BlockSignals(False, SIGTERM);
817 CatchSignal( SIGHUP, SIGNAL_CAST sig_hup );
818 CatchSignal( SIGTERM, SIGNAL_CAST sig_term );
821 /* we are never interested in SIGFPE */
822 BlockSignals(True,SIGFPE);
825 /* We no longer use USR2... */
827 BlockSignals(True, SIGUSR2);
830 if ( opt_interactive ) {
835 if ( log_stdout && Fork ) {
836 DEBUG(0,("ERROR: Can't log to stdout (-S) unless daemon is in foreground (-F) or interactive (-i)\n"));
840 setup_logging( argv[0], log_stdout );
844 DEBUG(0,("nmbd version %s started.\n", SAMBA_VERSION_STRING));
845 DEBUGADD(0,("%s\n", COPYRIGHT_STARTUP_MESSAGE));
847 if ( !reload_nmbd_services(False) )
853 reload_nmbd_services( True );
855 if (strequal(lp_workgroup(),"*")) {
856 DEBUG(0,("ERROR: a workgroup name of * is no longer supported\n"));
862 if (!is_daemon && !is_a_socket(0)) {
863 DEBUG(0,("standard input is not a socket, assuming -D option\n"));
867 if (is_daemon && !opt_interactive) {
868 DEBUG( 2, ( "Becoming a daemon.\n" ) );
869 become_daemon(Fork, no_process_group);
874 * If we're interactive we want to set our own process group for
877 if (opt_interactive && !no_process_group)
878 setpgid( (pid_t)0, (pid_t)0 );
881 if (nmbd_messaging_context() == NULL) {
886 /* Setup the async dns. We do it here so it doesn't have all the other
887 stuff initialised and thus chewing memory and sockets */
888 if(lp_we_are_a_wins_server() && lp_dns_proxy()) {
893 if (!directory_exist(lp_lockdir(), NULL)) {
894 mkdir(lp_lockdir(), 0755);
897 pidfile_create("nmbd");
898 messaging_register(nmbd_messaging_context(), NULL,
899 MSG_FORCE_ELECTION, nmbd_message_election);
901 /* Until winsrepl is done. */
902 messaging_register(nmbd_messaging_context(), NULL,
903 MSG_WINS_NEW_ENTRY, nmbd_wins_new_entry);
905 messaging_register(nmbd_messaging_context(), NULL,
906 MSG_SHUTDOWN, nmbd_terminate);
907 messaging_register(nmbd_messaging_context(), NULL,
908 MSG_SMB_CONF_UPDATED, msg_reload_nmbd_services);
909 messaging_register(nmbd_messaging_context(), NULL,
910 MSG_SEND_PACKET, msg_nmbd_send_packet);
914 DEBUG( 3, ( "Opening sockets %d\n", global_nmb_port ) );
916 if ( !open_sockets( is_daemon, global_nmb_port ) ) {
917 kill_async_dns_child();
921 /* Determine all the IP addresses we have. */
924 /* Create an nmbd subnet record for each of the above. */
925 if( False == create_subnets() ) {
926 DEBUG(0,("ERROR: Failed when creating subnet lists. Exiting.\n"));
927 kill_async_dns_child();
931 /* Load in any static local names. */
933 set_dyn_LMHOSTSFILE(p_lmhosts);
935 load_lmhosts_file(get_dyn_LMHOSTSFILE());
936 DEBUG(3,("Loaded hosts file %s\n", get_dyn_LMHOSTSFILE()));
938 /* If we are acting as a WINS server, initialise data structures. */
939 if( !initialise_wins() ) {
940 DEBUG( 0, ( "nmbd: Failed when initialising WINS server.\n" ) );
941 kill_async_dns_child();
946 * Register nmbd primary workgroup and nmbd names on all
947 * the broadcast subnets, and on the WINS server (if specified).
948 * Also initiate the startup of our primary workgroup (start
949 * elections if we are setup as being able to be a local
953 if( False == register_my_workgroup_and_names() ) {
954 DEBUG(0,("ERROR: Failed when creating my my workgroup. Exiting.\n"));
955 kill_async_dns_child();
959 /* We can only take signals in the select. */
960 BlockSignals( True, SIGTERM );
967 kill_async_dns_child();