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 struct in_addr loopback_ip;
31 extern BOOL global_in_nmbd;
33 extern BOOL override_logfile;
35 /* are we running as a daemon ? */
36 static BOOL is_daemon;
38 /* fork or run in foreground ? */
39 static BOOL Fork = True;
41 /* log to standard output ? */
42 static BOOL log_stdout;
44 /* have we found LanMan clients yet? */
45 BOOL found_lm_clients = False;
47 /* what server type are we currently */
49 time_t StartupTime = 0;
51 struct event_context *nmbd_event_context(void)
53 static struct event_context *ctx;
55 if (!ctx && !(ctx = event_context_init(NULL))) {
56 smb_panic("Could not init nmbd event context");
61 struct messaging_context *nmbd_messaging_context(void)
63 static struct messaging_context *ctx;
65 if (!ctx && !(ctx = messaging_init(NULL, server_id_self(),
66 nmbd_event_context()))) {
67 smb_panic("Could not init nmbd messaging context");
72 /**************************************************************************** **
73 Handle a SIGTERM in band.
74 **************************************************************************** */
76 static void terminate(void)
78 DEBUG(0,("Got SIGTERM: going down...\n"));
80 /* Write out wins.dat file if samba is a WINS server */
81 wins_write_database(0,False);
83 /* Remove all SELF registered names from WINS */
86 /* Announce all server entries as 0 time-to-live, 0 type. */
87 announce_my_servers_removed();
89 /* If there was an async dns child - kill it. */
90 kill_async_dns_child();
95 /**************************************************************************** **
96 Handle a SHUTDOWN message from smbcontrol.
97 **************************************************************************** */
99 static void nmbd_terminate(struct messaging_context *msg,
102 struct server_id server_id,
108 /**************************************************************************** **
109 Catch a SIGTERM signal.
110 **************************************************************************** */
112 static SIG_ATOMIC_T got_sig_term;
114 static void sig_term(int sig)
117 sys_select_signal(SIGTERM);
120 /**************************************************************************** **
121 Catch a SIGHUP signal.
122 **************************************************************************** */
124 static SIG_ATOMIC_T reload_after_sighup;
126 static void sig_hup(int sig)
128 reload_after_sighup = 1;
129 sys_select_signal(SIGHUP);
132 /**************************************************************************** **
133 Possibly continue after a fault.
134 **************************************************************************** */
136 static void fault_continue(void)
141 /**************************************************************************** **
142 Expire old names from the namelist and server list.
143 **************************************************************************** */
145 static void expire_names_and_servers(time_t t)
147 static time_t lastrun = 0;
151 if ( t < (lastrun + 5) )
156 * Expire any timed out names on all the broadcast
157 * subnets and those registered with the WINS server.
158 * (nmbd_namelistdb.c)
164 * Go through all the broadcast subnets and for each
165 * workgroup known on that subnet remove any expired
166 * server names. If a workgroup has an empty serverlist
167 * and has itself timed out then remove the workgroup.
168 * (nmbd_workgroupdb.c)
171 expire_workgroups_and_servers(t);
174 /************************************************************************** **
175 Reload the list of network interfaces.
176 ************************************************************************** */
178 static BOOL reload_interfaces(time_t t)
182 struct subnet_record *subrec;
184 if (t && ((t - lastt) < NMBD_INTERFACES_RELOAD)) return False;
187 if (!interfaces_changed()) return False;
189 /* the list of probed interfaces has changed, we may need to add/remove
193 /* find any interfaces that need adding */
194 for (n=iface_count() - 1; n >= 0; n--) {
195 struct interface *iface = get_interface(n);
198 DEBUG(2,("reload_interfaces: failed to get interface %d\n", n));
203 * We don't want to add a loopback interface, in case
204 * someone has added 127.0.0.1 for smbd, nmbd needs to
205 * ignore it here. JRA.
208 if (ip_equal(iface->ip, loopback_ip)) {
209 DEBUG(2,("reload_interfaces: Ignoring loopback interface %s\n", inet_ntoa(iface->ip)));
213 for (subrec=subnetlist; subrec; subrec=subrec->next) {
214 if (ip_equal(iface->ip, subrec->myip) &&
215 ip_equal(iface->nmask, subrec->mask_ip)) break;
219 /* it wasn't found! add it */
220 DEBUG(2,("Found new interface %s\n",
221 inet_ntoa(iface->ip)));
222 subrec = make_normal_subnet(iface);
224 register_my_workgroup_one_subnet(subrec);
228 /* find any interfaces that need deleting */
229 for (subrec=subnetlist; subrec; subrec=subrec->next) {
230 for (n=iface_count() - 1; n >= 0; n--) {
231 struct interface *iface = get_interface(n);
232 if (ip_equal(iface->ip, subrec->myip) &&
233 ip_equal(iface->nmask, subrec->mask_ip)) break;
236 /* oops, an interface has disapeared. This is
237 tricky, we don't dare actually free the
238 interface as it could be being used, so
239 instead we just wear the memory leak and
240 remove it from the list of interfaces without
242 DEBUG(2,("Deleting dead interface %s\n",
243 inet_ntoa(subrec->myip)));
244 close_subnet(subrec);
248 rescan_listen_set = True;
250 /* We need to shutdown if there are no subnets... */
251 if (FIRST_SUBNET == NULL) {
252 DEBUG(0,("reload_interfaces: No subnets to listen to. Shutting down...\n"));
258 /**************************************************************************** **
259 Reload the services file.
260 **************************************************************************** */
262 static BOOL reload_nmbd_services(BOOL test)
266 set_remote_machine_name("nmbd", False);
270 pstrcpy( fname,lp_configfile());
271 if (file_exist(fname,NULL) && !strcsequal(fname,dyn_CONFIGFILE)) {
272 pstrcpy(dyn_CONFIGFILE,fname);
277 if ( test && !lp_file_list_changed() )
280 ret = lp_load( dyn_CONFIGFILE, True , False, False, True);
282 /* perhaps the config filename is now set */
284 DEBUG( 3, ( "services not loaded\n" ) );
285 reload_nmbd_services( True );
291 /**************************************************************************** **
292 * React on 'smbcontrol nmbd reload-config' in the same way as to SIGHUP
293 * We use buf here to return BOOL result to process() when reload_interfaces()
294 * detects that there are no subnets.
295 **************************************************************************** */
297 static void msg_reload_nmbd_services(struct messaging_context *msg,
300 struct server_id server_id,
303 write_browse_list( 0, True );
304 dump_all_namelists();
305 reload_nmbd_services( True );
309 /* We were called from process() */
310 /* If reload_interfaces() returned True */
311 /* we need to shutdown if there are no subnets... */
312 /* pass this info back to process() */
313 *((BOOL*)data->data) = reload_interfaces(0);
317 static void msg_nmbd_send_packet(struct messaging_context *msg,
320 struct server_id src,
323 struct packet_struct *p = (struct packet_struct *)data->data;
324 struct subnet_record *subrec;
325 struct in_addr *local_ip;
327 DEBUG(10, ("Received send_packet from %d\n", procid_to_pid(&src)));
329 if (data->length != sizeof(struct packet_struct)) {
330 DEBUG(2, ("Discarding invalid packet length from %d\n",
331 procid_to_pid(&src)));
335 if ((p->packet_type != NMB_PACKET) &&
336 (p->packet_type != DGRAM_PACKET)) {
337 DEBUG(2, ("Discarding invalid packet type from %d: %d\n",
338 procid_to_pid(&src), p->packet_type));
342 local_ip = iface_ip(p->ip);
344 if (local_ip == NULL) {
345 DEBUG(2, ("Could not find ip for packet from %d\n",
346 procid_to_pid(&src)));
350 subrec = FIRST_SUBNET;
352 p->fd = (p->packet_type == NMB_PACKET) ?
353 subrec->nmb_sock : subrec->dgram_sock;
355 for (subrec = FIRST_SUBNET; subrec != NULL;
356 subrec = NEXT_SUBNET_EXCLUDING_UNICAST(subrec)) {
357 if (ip_equal(*local_ip, subrec->myip)) {
358 p->fd = (p->packet_type == NMB_PACKET) ?
359 subrec->nmb_sock : subrec->dgram_sock;
364 if (p->packet_type == DGRAM_PACKET) {
366 p->packet.dgram.header.source_ip.s_addr = local_ip->s_addr;
367 p->packet.dgram.header.source_port = 138;
373 /**************************************************************************** **
374 The main select loop.
375 **************************************************************************** */
377 static void process(void)
383 time_t t = time(NULL);
384 TALLOC_CTX *frame = talloc_stackframe();
386 /* Check for internal messages */
388 message_dispatch(nmbd_messaging_context());
391 * Check all broadcast subnets to see if
392 * we need to run an election on any of them.
396 run_election = check_elections();
399 * Read incoming UDP packets.
403 if(listen_for_packets(run_election)) {
409 * Handle termination inband.
418 * Process all incoming packets
419 * read above. This calls the success and
420 * failure functions registered when response
421 * packets arrrive, and also deals with request
422 * packets from other sources.
429 * Run any elections - initiate becoming
430 * a local master browser if we have won.
437 * Send out any broadcast announcements
438 * of our server names. This also announces
439 * the workgroup name if we are a local
441 * (nmbd_sendannounce.c)
444 announce_my_server_names(t);
447 * Send out any LanMan broadcast announcements
448 * of our server names.
449 * (nmbd_sendannounce.c)
452 announce_my_lm_server_names(t);
455 * If we are a local master browser, periodically
456 * announce ourselves to the domain master browser.
457 * This also deals with syncronising the domain master
458 * browser server lists with ourselves as a local
460 * (nmbd_sendannounce.c)
463 announce_myself_to_domain_master_browser(t);
466 * Fullfill any remote announce requests.
467 * (nmbd_sendannounce.c)
473 * Fullfill any remote browse sync announce requests.
474 * (nmbd_sendannounce.c)
477 browse_sync_remote(t);
480 * Scan the broadcast subnets, and WINS client
481 * namelists and refresh any that need refreshing.
488 * Scan the subnet namelists and server lists and
489 * expire thos that have timed out.
493 expire_names_and_servers(t);
496 * Write out a snapshot of our current browse list into
497 * the browse.dat file. This is used by smbd to service
498 * incoming NetServerEnum calls - used to synchronise
499 * browse lists over subnets.
500 * (nmbd_serverlistdb.c)
503 write_browse_list(t, False);
506 * If we are a domain master browser, we have a list of
507 * local master browsers we should synchronise browse
508 * lists with (these are added by an incoming local
509 * master browser announcement packet). Expire any of
510 * these that are no longer current, and pull the server
511 * lists from each of these known local master browsers.
512 * (nmbd_browsesync.c)
515 dmb_expire_and_sync_browser_lists(t);
518 * Check that there is a local master browser for our
519 * workgroup for all our broadcast subnets. If one
520 * is not found, start an election (which we ourselves
521 * may or may not participate in, depending on the
522 * setting of the 'local master' parameter.
526 check_master_browser_exists(t);
529 * If we are configured as a logon server, attempt to
530 * register the special NetBIOS names to become such
531 * (WORKGROUP<1c> name) on all broadcast subnets and
532 * with the WINS server (if used). If we are configured
533 * to become a domain master browser, attempt to register
534 * the special NetBIOS name (WORKGROUP<1b> name) to
536 * (nmbd_become_dmb.c)
542 * If we are a WINS server, do any timer dependent
543 * processing required.
544 * (nmbd_winsserver.c)
547 initiate_wins_processing(t);
550 * If we are a domain master browser, attempt to contact the
551 * WINS server to get a list of all known WORKGROUPS/DOMAINS.
552 * This will only work to a Samba WINS server.
553 * (nmbd_browsesync.c)
556 if (lp_enhanced_browsing())
557 collect_all_workgroup_names_from_wins_server(t);
560 * Go through the response record queue and time out or re-transmit
561 * and expired entries.
565 retransmit_or_expire_response_records(t);
568 * check to see if any remote browse sync child processes have completed
571 sync_check_completion();
574 * regularly sync with any other DMBs we know about
577 if (lp_enhanced_browsing())
581 * clear the unexpected packet queue
587 * Reload the services file if we got a sighup.
590 if(reload_after_sighup) {
591 DATA_BLOB blob = data_blob_const(&no_subnets,
593 DEBUG( 0, ( "Got SIGHUP dumping debug info.\n" ) );
594 msg_reload_nmbd_services(nmbd_messaging_context(),
595 NULL, MSG_SMB_CONF_UPDATED,
596 procid_self(), &blob);
602 reload_after_sighup = 0;
605 /* check for new network interfaces */
607 if(reload_interfaces(t)) {
612 /* free up temp memory */
617 /**************************************************************************** **
618 Open the socket communication.
619 **************************************************************************** */
621 static BOOL open_sockets(BOOL isdaemon, int port)
624 * The sockets opened here will be used to receive broadcast
625 * packets *only*. Interface specific sockets are opened in
626 * make_subnet() in namedbsubnet.c. Thus we bind to the
627 * address "0.0.0.0". The parameter 'socket address' is
632 ClientNMB = open_socket_in(SOCK_DGRAM, port,
633 0, interpret_addr(lp_socket_address()),
638 ClientDGRAM = open_socket_in(SOCK_DGRAM, DGRAM_PORT,
639 3, interpret_addr(lp_socket_address()),
642 if ( ClientNMB == -1 )
645 /* we are never interested in SIGPIPE */
646 BlockSignals(True,SIGPIPE);
648 set_socket_options( ClientNMB, "SO_BROADCAST" );
649 set_socket_options( ClientDGRAM, "SO_BROADCAST" );
651 /* Ensure we're non-blocking. */
652 set_blocking( ClientNMB, False);
653 set_blocking( ClientDGRAM, False);
655 DEBUG( 3, ( "open_sockets: Broadcast sockets opened.\n" ) );
659 /**************************************************************************** **
661 **************************************************************************** */
662 int main(int argc, const char *argv[])
665 static BOOL opt_interactive;
667 static char *p_lmhosts = dyn_LMHOSTSFILE;
668 static BOOL no_process_group = False;
670 struct poptOption long_options[] = {
672 {"daemon", 'D', POPT_ARG_VAL, &is_daemon, True, "Become a daemon(default)" },
673 {"interactive", 'i', POPT_ARG_VAL, &opt_interactive, True, "Run interactive (not a daemon)" },
674 {"foreground", 'F', POPT_ARG_VAL, &Fork, False, "Run daemon in foreground (for daemontools & etc)" },
675 {"no-process-group", 0, POPT_ARG_VAL, &no_process_group, True, "Don't create a new process group" },
676 {"log-stdout", 'S', POPT_ARG_VAL, &log_stdout, True, "Log to stdout" },
677 {"hosts", 'H', POPT_ARG_STRING, &p_lmhosts, 'H', "Load a netbios hosts file"},
678 {"port", 'p', POPT_ARG_INT, &global_nmb_port, NMB_PORT, "Listen on the specified port" },
685 global_nmb_port = NMB_PORT;
687 pc = poptGetContext("nmbd", argc, argv, long_options, 0);
688 while ((opt = poptGetNextOpt(pc)) != -1) {
691 d_fprintf(stderr, "\nInvalid option %s: %s\n\n",
692 poptBadOption(pc, 0), poptStrerror(opt));
693 poptPrintUsage(pc, stderr, 0);
699 global_in_nmbd = True;
701 StartupTime = time(NULL);
703 sys_srandom(time(NULL) ^ sys_getpid());
705 if (!override_logfile) {
706 slprintf(logfile, sizeof(logfile)-1, "%s/log.nmbd", dyn_LOGFILEBASE);
707 lp_set_logfile(logfile);
710 fault_setup((void (*)(void *))fault_continue );
711 dump_core_setup("nmbd");
713 /* POSIX demands that signals are inherited. If the invoking process has
714 * these signals masked, we will have problems, as we won't receive them. */
715 BlockSignals(False, SIGHUP);
716 BlockSignals(False, SIGUSR1);
717 BlockSignals(False, SIGTERM);
719 CatchSignal( SIGHUP, SIGNAL_CAST sig_hup );
720 CatchSignal( SIGTERM, SIGNAL_CAST sig_term );
723 /* we are never interested in SIGFPE */
724 BlockSignals(True,SIGFPE);
727 /* We no longer use USR2... */
729 BlockSignals(True, SIGUSR2);
732 if ( opt_interactive ) {
737 if ( log_stdout && Fork ) {
738 DEBUG(0,("ERROR: Can't log to stdout (-S) unless daemon is in foreground (-F) or interactive (-i)\n"));
742 setup_logging( argv[0], log_stdout );
746 DEBUG( 0, ( "Netbios nameserver version %s started.\n", SAMBA_VERSION_STRING) );
747 DEBUGADD( 0, ( "%s\n", COPYRIGHT_STARTUP_MESSAGE ) );
749 if ( !reload_nmbd_services(False) )
755 reload_nmbd_services( True );
757 if (strequal(lp_workgroup(),"*")) {
758 DEBUG(0,("ERROR: a workgroup name of * is no longer supported\n"));
764 if (!is_daemon && !is_a_socket(0)) {
765 DEBUG(0,("standard input is not a socket, assuming -D option\n"));
769 if (is_daemon && !opt_interactive) {
770 DEBUG( 2, ( "Becoming a daemon.\n" ) );
771 become_daemon(Fork, no_process_group);
776 * If we're interactive we want to set our own process group for
779 if (opt_interactive && !no_process_group)
780 setpgid( (pid_t)0, (pid_t)0 );
783 if (nmbd_messaging_context() == NULL) {
788 /* Setup the async dns. We do it here so it doesn't have all the other
789 stuff initialised and thus chewing memory and sockets */
790 if(lp_we_are_a_wins_server() && lp_dns_proxy()) {
795 if (!directory_exist(lp_lockdir(), NULL)) {
796 mkdir(lp_lockdir(), 0755);
799 pidfile_create("nmbd");
800 messaging_register(nmbd_messaging_context(), NULL,
801 MSG_FORCE_ELECTION, nmbd_message_election);
803 /* Until winsrepl is done. */
804 messaging_register(nmbd_messaging_context(), NULL,
805 MSG_WINS_NEW_ENTRY, nmbd_wins_new_entry);
807 messaging_register(nmbd_messaging_context(), NULL,
808 MSG_SHUTDOWN, nmbd_terminate);
809 messaging_register(nmbd_messaging_context(), NULL,
810 MSG_SMB_CONF_UPDATED, msg_reload_nmbd_services);
811 messaging_register(nmbd_messaging_context(), NULL,
812 MSG_SEND_PACKET, msg_nmbd_send_packet);
816 DEBUG( 3, ( "Opening sockets %d\n", global_nmb_port ) );
818 if ( !open_sockets( is_daemon, global_nmb_port ) ) {
819 kill_async_dns_child();
823 /* Determine all the IP addresses we have. */
826 /* Create an nmbd subnet record for each of the above. */
827 if( False == create_subnets() ) {
828 DEBUG(0,("ERROR: Failed when creating subnet lists. Exiting.\n"));
829 kill_async_dns_child();
833 /* Load in any static local names. */
834 load_lmhosts_file(p_lmhosts);
835 DEBUG(3,("Loaded hosts file %s\n", p_lmhosts));
837 /* If we are acting as a WINS server, initialise data structures. */
838 if( !initialise_wins() ) {
839 DEBUG( 0, ( "nmbd: Failed when initialising WINS server.\n" ) );
840 kill_async_dns_child();
845 * Register nmbd primary workgroup and nmbd names on all
846 * the broadcast subnets, and on the WINS server (if specified).
847 * Also initiate the startup of our primary workgroup (start
848 * elections if we are setup as being able to be a local
852 if( False == register_my_workgroup_and_names() ) {
853 DEBUG(0,("ERROR: Failed when creating my my workgroup. Exiting.\n"));
854 kill_async_dns_child();
858 /* We can only take signals in the select. */
859 BlockSignals( True, SIGTERM );
865 kill_async_dns_child();