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 ************************************************************************** */
168 static bool reload_interfaces(time_t t)
172 struct subnet_record *subrec;
174 if (t && ((t - lastt) < NMBD_INTERFACES_RELOAD)) return False;
177 if (!interfaces_changed()) return False;
179 /* the list of probed interfaces has changed, we may need to add/remove
183 /* find any interfaces that need adding */
184 for (n=iface_count() - 1; n >= 0; n--) {
185 char str[INET6_ADDRSTRLEN];
186 const struct interface *iface = get_interface(n);
187 struct in_addr ip, nmask;
190 DEBUG(2,("reload_interfaces: failed to get interface %d\n", n));
194 /* Ensure we're only dealing with IPv4 here. */
195 if (iface->ip.ss_family != AF_INET) {
196 DEBUG(2,("reload_interfaces: "
197 "ignoring non IPv4 interface.\n"));
201 ip = ((struct sockaddr_in *)&iface->ip)->sin_addr;
202 nmask = ((struct sockaddr_in *)&iface->netmask)->sin_addr;
205 * We don't want to add a loopback interface, in case
206 * someone has added 127.0.0.1 for smbd, nmbd needs to
207 * ignore it here. JRA.
210 if (is_loopback_addr(&iface->ip)) {
211 DEBUG(2,("reload_interfaces: Ignoring loopback "
213 print_sockaddr(str, sizeof(str),
214 &iface->ip, sizeof(iface->ip)) ));
218 for (subrec=subnetlist; subrec; subrec=subrec->next) {
219 if (ip_equal(ip, subrec->myip) &&
220 ip_equal(nmask, subrec->mask_ip)) break;
224 /* it wasn't found! add it */
225 DEBUG(2,("Found new interface %s\n",
226 print_sockaddr(str, sizeof(str),
227 &iface->ip, sizeof(iface->ip)) ));
228 subrec = make_normal_subnet(iface);
230 register_my_workgroup_one_subnet(subrec);
234 /* find any interfaces that need deleting */
235 for (subrec=subnetlist; subrec; subrec=subrec->next) {
236 for (n=iface_count() - 1; n >= 0; n--) {
237 struct interface *iface = get_interface(n);
238 struct in_addr ip, nmask;
242 /* Ensure we're only dealing with IPv4 here. */
243 if (iface->ip.ss_family != AF_INET) {
244 DEBUG(2,("reload_interfaces: "
245 "ignoring non IPv4 interface.\n"));
248 ip = ((struct sockaddr_in *)&iface->ip)->sin_addr;
249 nmask = ((struct sockaddr_in *)&iface->netmask)->sin_addr;
250 if (ip_equal(ip, subrec->myip) &&
251 ip_equal(nmask, subrec->mask_ip)) break;
254 /* oops, an interface has disapeared. This is
255 tricky, we don't dare actually free the
256 interface as it could be being used, so
257 instead we just wear the memory leak and
258 remove it from the list of interfaces without
260 DEBUG(2,("Deleting dead interface %s\n",
261 inet_ntoa(subrec->myip)));
262 close_subnet(subrec);
266 rescan_listen_set = True;
268 /* We need to shutdown if there are no subnets... */
269 if (FIRST_SUBNET == NULL) {
270 DEBUG(0,("reload_interfaces: No subnets to listen to. Shutting down...\n"));
276 /**************************************************************************** **
277 Reload the services file.
278 **************************************************************************** */
280 static bool reload_nmbd_services(bool test)
284 set_remote_machine_name("nmbd", False);
288 pstrcpy( fname,lp_configfile());
289 if (file_exist(fname,NULL) && !strcsequal(fname,dyn_CONFIGFILE)) {
290 pstrcpy(dyn_CONFIGFILE,fname);
295 if ( test && !lp_file_list_changed() )
298 ret = lp_load( dyn_CONFIGFILE, True , False, False, True);
300 /* perhaps the config filename is now set */
302 DEBUG( 3, ( "services not loaded\n" ) );
303 reload_nmbd_services( True );
309 /**************************************************************************** **
310 * React on 'smbcontrol nmbd reload-config' in the same way as to SIGHUP
311 * We use buf here to return bool result to process() when reload_interfaces()
312 * detects that there are no subnets.
313 **************************************************************************** */
315 static void msg_reload_nmbd_services(struct messaging_context *msg,
318 struct server_id server_id,
321 write_browse_list( 0, True );
322 dump_all_namelists();
323 reload_nmbd_services( True );
327 /* We were called from process() */
328 /* If reload_interfaces() returned True */
329 /* we need to shutdown if there are no subnets... */
330 /* pass this info back to process() */
331 *((bool *)data->data) = reload_interfaces(0);
335 static void msg_nmbd_send_packet(struct messaging_context *msg,
338 struct server_id src,
341 struct packet_struct *p = (struct packet_struct *)data->data;
342 struct subnet_record *subrec;
343 struct sockaddr_storage ss;
344 const struct sockaddr_storage *pss;
345 const struct in_addr *local_ip;
347 DEBUG(10, ("Received send_packet from %d\n", procid_to_pid(&src)));
349 if (data->length != sizeof(struct packet_struct)) {
350 DEBUG(2, ("Discarding invalid packet length from %d\n",
351 procid_to_pid(&src)));
355 if ((p->packet_type != NMB_PACKET) &&
356 (p->packet_type != DGRAM_PACKET)) {
357 DEBUG(2, ("Discarding invalid packet type from %d: %d\n",
358 procid_to_pid(&src), p->packet_type));
362 in_addr_to_sockaddr_storage(&ss, p->ip);
366 DEBUG(2, ("Could not find ip for packet from %d\n",
367 procid_to_pid(&src)));
371 local_ip = &((const struct sockaddr_in *)pss)->sin_addr;
372 subrec = FIRST_SUBNET;
374 p->fd = (p->packet_type == NMB_PACKET) ?
375 subrec->nmb_sock : subrec->dgram_sock;
377 for (subrec = FIRST_SUBNET; subrec != NULL;
378 subrec = NEXT_SUBNET_EXCLUDING_UNICAST(subrec)) {
379 if (ip_equal(*local_ip, subrec->myip)) {
380 p->fd = (p->packet_type == NMB_PACKET) ?
381 subrec->nmb_sock : subrec->dgram_sock;
386 if (p->packet_type == DGRAM_PACKET) {
388 p->packet.dgram.header.source_ip.s_addr = local_ip->s_addr;
389 p->packet.dgram.header.source_port = 138;
395 /**************************************************************************** **
396 The main select loop.
397 **************************************************************************** */
399 static void process(void)
405 time_t t = time(NULL);
406 TALLOC_CTX *frame = talloc_stackframe();
408 /* Check for internal messages */
410 message_dispatch(nmbd_messaging_context());
413 * Check all broadcast subnets to see if
414 * we need to run an election on any of them.
418 run_election = check_elections();
421 * Read incoming UDP packets.
425 if(listen_for_packets(run_election)) {
431 * Handle termination inband.
440 * Process all incoming packets
441 * read above. This calls the success and
442 * failure functions registered when response
443 * packets arrrive, and also deals with request
444 * packets from other sources.
451 * Run any elections - initiate becoming
452 * a local master browser if we have won.
459 * Send out any broadcast announcements
460 * of our server names. This also announces
461 * the workgroup name if we are a local
463 * (nmbd_sendannounce.c)
466 announce_my_server_names(t);
469 * Send out any LanMan broadcast announcements
470 * of our server names.
471 * (nmbd_sendannounce.c)
474 announce_my_lm_server_names(t);
477 * If we are a local master browser, periodically
478 * announce ourselves to the domain master browser.
479 * This also deals with syncronising the domain master
480 * browser server lists with ourselves as a local
482 * (nmbd_sendannounce.c)
485 announce_myself_to_domain_master_browser(t);
488 * Fullfill any remote announce requests.
489 * (nmbd_sendannounce.c)
495 * Fullfill any remote browse sync announce requests.
496 * (nmbd_sendannounce.c)
499 browse_sync_remote(t);
502 * Scan the broadcast subnets, and WINS client
503 * namelists and refresh any that need refreshing.
510 * Scan the subnet namelists and server lists and
511 * expire thos that have timed out.
515 expire_names_and_servers(t);
518 * Write out a snapshot of our current browse list into
519 * the browse.dat file. This is used by smbd to service
520 * incoming NetServerEnum calls - used to synchronise
521 * browse lists over subnets.
522 * (nmbd_serverlistdb.c)
525 write_browse_list(t, False);
528 * If we are a domain master browser, we have a list of
529 * local master browsers we should synchronise browse
530 * lists with (these are added by an incoming local
531 * master browser announcement packet). Expire any of
532 * these that are no longer current, and pull the server
533 * lists from each of these known local master browsers.
534 * (nmbd_browsesync.c)
537 dmb_expire_and_sync_browser_lists(t);
540 * Check that there is a local master browser for our
541 * workgroup for all our broadcast subnets. If one
542 * is not found, start an election (which we ourselves
543 * may or may not participate in, depending on the
544 * setting of the 'local master' parameter.
548 check_master_browser_exists(t);
551 * If we are configured as a logon server, attempt to
552 * register the special NetBIOS names to become such
553 * (WORKGROUP<1c> name) on all broadcast subnets and
554 * with the WINS server (if used). If we are configured
555 * to become a domain master browser, attempt to register
556 * the special NetBIOS name (WORKGROUP<1b> name) to
558 * (nmbd_become_dmb.c)
564 * If we are a WINS server, do any timer dependent
565 * processing required.
566 * (nmbd_winsserver.c)
569 initiate_wins_processing(t);
572 * If we are a domain master browser, attempt to contact the
573 * WINS server to get a list of all known WORKGROUPS/DOMAINS.
574 * This will only work to a Samba WINS server.
575 * (nmbd_browsesync.c)
578 if (lp_enhanced_browsing())
579 collect_all_workgroup_names_from_wins_server(t);
582 * Go through the response record queue and time out or re-transmit
583 * and expired entries.
587 retransmit_or_expire_response_records(t);
590 * check to see if any remote browse sync child processes have completed
593 sync_check_completion();
596 * regularly sync with any other DMBs we know about
599 if (lp_enhanced_browsing())
603 * clear the unexpected packet queue
609 * Reload the services file if we got a sighup.
612 if(reload_after_sighup) {
613 DATA_BLOB blob = data_blob_const(&no_subnets,
615 DEBUG( 0, ( "Got SIGHUP dumping debug info.\n" ) );
616 msg_reload_nmbd_services(nmbd_messaging_context(),
617 NULL, MSG_SMB_CONF_UPDATED,
618 procid_self(), &blob);
624 reload_after_sighup = 0;
627 /* check for new network interfaces */
629 if(reload_interfaces(t)) {
634 /* free up temp memory */
639 /**************************************************************************** **
640 Open the socket communication.
641 **************************************************************************** */
643 static bool open_sockets(bool isdaemon, int port)
646 * The sockets opened here will be used to receive broadcast
647 * packets *only*. Interface specific sockets are opened in
648 * make_subnet() in namedbsubnet.c. Thus we bind to the
649 * address "0.0.0.0". The parameter 'socket address' is
654 ClientNMB = open_socket_in(SOCK_DGRAM, port,
655 0, interpret_addr(lp_socket_address()),
660 ClientDGRAM = open_socket_in(SOCK_DGRAM, DGRAM_PORT,
661 3, interpret_addr(lp_socket_address()),
664 if ( ClientNMB == -1 )
667 /* we are never interested in SIGPIPE */
668 BlockSignals(True,SIGPIPE);
670 set_socket_options( ClientNMB, "SO_BROADCAST" );
671 set_socket_options( ClientDGRAM, "SO_BROADCAST" );
673 /* Ensure we're non-blocking. */
674 set_blocking( ClientNMB, False);
675 set_blocking( ClientDGRAM, False);
677 DEBUG( 3, ( "open_sockets: Broadcast sockets opened.\n" ) );
681 /**************************************************************************** **
683 **************************************************************************** */
685 int main(int argc, const char *argv[])
687 static bool is_daemon;
688 static bool opt_interactive;
689 static bool Fork = true;
690 static bool no_process_group;
691 static bool log_stdout;
694 static char *p_lmhosts = dyn_LMHOSTSFILE;
700 OPT_NO_PROCESS_GROUP,
703 struct poptOption long_options[] = {
705 {"daemon", 'D', POPT_ARG_NONE, NULL, OPT_DAEMON, "Become a daemon(default)" },
706 {"interactive", 'i', POPT_ARG_NONE, NULL, OPT_INTERACTIVE, "Run interactive (not a daemon)" },
707 {"foreground", 'F', POPT_ARG_NONE, NULL, OPT_FORK, "Run daemon in foreground (for daemontools & etc)" },
708 {"no-process-group", 0, POPT_ARG_NONE, NULL, OPT_NO_PROCESS_GROUP, "Don't create a new process group" },
709 {"log-stdout", 'S', POPT_ARG_VAL, &log_stdout, True, "Log to stdout" },
710 {"hosts", 'H', POPT_ARG_STRING, &p_lmhosts, 'H', "Load a netbios hosts file"},
711 {"port", 'p', POPT_ARG_INT, &global_nmb_port, NMB_PORT, "Listen on the specified port" },
718 global_nmb_port = NMB_PORT;
720 pc = poptGetContext("nmbd", argc, argv, long_options, 0);
721 while ((opt = poptGetNextOpt(pc)) != -1) {
726 case OPT_INTERACTIVE:
727 opt_interactive = true;
732 case OPT_NO_PROCESS_GROUP:
733 no_process_group = true;
739 d_fprintf(stderr, "\nInvalid option %s: %s\n\n",
740 poptBadOption(pc, 0), poptStrerror(opt));
741 poptPrintUsage(pc, stderr, 0);
747 global_in_nmbd = True;
749 StartupTime = time(NULL);
751 sys_srandom(time(NULL) ^ sys_getpid());
753 if (!override_logfile) {
754 slprintf(logfile, sizeof(logfile)-1, "%s/log.nmbd", dyn_LOGFILEBASE);
755 lp_set_logfile(logfile);
758 fault_setup((void (*)(void *))fault_continue );
759 dump_core_setup("nmbd");
761 /* POSIX demands that signals are inherited. If the invoking process has
762 * these signals masked, we will have problems, as we won't receive them. */
763 BlockSignals(False, SIGHUP);
764 BlockSignals(False, SIGUSR1);
765 BlockSignals(False, SIGTERM);
767 CatchSignal( SIGHUP, SIGNAL_CAST sig_hup );
768 CatchSignal( SIGTERM, SIGNAL_CAST sig_term );
771 /* we are never interested in SIGFPE */
772 BlockSignals(True,SIGFPE);
775 /* We no longer use USR2... */
777 BlockSignals(True, SIGUSR2);
780 if ( opt_interactive ) {
785 if ( log_stdout && Fork ) {
786 DEBUG(0,("ERROR: Can't log to stdout (-S) unless daemon is in foreground (-F) or interactive (-i)\n"));
790 setup_logging( argv[0], log_stdout );
794 DEBUG( 0, ( "Netbios nameserver version %s started.\n", SAMBA_VERSION_STRING) );
795 DEBUGADD( 0, ( "%s\n", COPYRIGHT_STARTUP_MESSAGE ) );
797 if ( !reload_nmbd_services(False) )
803 reload_nmbd_services( True );
805 if (strequal(lp_workgroup(),"*")) {
806 DEBUG(0,("ERROR: a workgroup name of * is no longer supported\n"));
812 if (!is_daemon && !is_a_socket(0)) {
813 DEBUG(0,("standard input is not a socket, assuming -D option\n"));
817 if (is_daemon && !opt_interactive) {
818 DEBUG( 2, ( "Becoming a daemon.\n" ) );
819 become_daemon(Fork, no_process_group);
824 * If we're interactive we want to set our own process group for
827 if (opt_interactive && !no_process_group)
828 setpgid( (pid_t)0, (pid_t)0 );
831 if (nmbd_messaging_context() == NULL) {
836 /* Setup the async dns. We do it here so it doesn't have all the other
837 stuff initialised and thus chewing memory and sockets */
838 if(lp_we_are_a_wins_server() && lp_dns_proxy()) {
843 if (!directory_exist(lp_lockdir(), NULL)) {
844 mkdir(lp_lockdir(), 0755);
847 pidfile_create("nmbd");
848 messaging_register(nmbd_messaging_context(), NULL,
849 MSG_FORCE_ELECTION, nmbd_message_election);
851 /* Until winsrepl is done. */
852 messaging_register(nmbd_messaging_context(), NULL,
853 MSG_WINS_NEW_ENTRY, nmbd_wins_new_entry);
855 messaging_register(nmbd_messaging_context(), NULL,
856 MSG_SHUTDOWN, nmbd_terminate);
857 messaging_register(nmbd_messaging_context(), NULL,
858 MSG_SMB_CONF_UPDATED, msg_reload_nmbd_services);
859 messaging_register(nmbd_messaging_context(), NULL,
860 MSG_SEND_PACKET, msg_nmbd_send_packet);
864 DEBUG( 3, ( "Opening sockets %d\n", global_nmb_port ) );
866 if ( !open_sockets( is_daemon, global_nmb_port ) ) {
867 kill_async_dns_child();
871 /* Determine all the IP addresses we have. */
874 /* Create an nmbd subnet record for each of the above. */
875 if( False == create_subnets() ) {
876 DEBUG(0,("ERROR: Failed when creating subnet lists. Exiting.\n"));
877 kill_async_dns_child();
881 /* Load in any static local names. */
882 load_lmhosts_file(p_lmhosts);
883 DEBUG(3,("Loaded hosts file %s\n", p_lmhosts));
885 /* If we are acting as a WINS server, initialise data structures. */
886 if( !initialise_wins() ) {
887 DEBUG( 0, ( "nmbd: Failed when initialising WINS server.\n" ) );
888 kill_async_dns_child();
893 * Register nmbd primary workgroup and nmbd names on all
894 * the broadcast subnets, and on the WINS server (if specified).
895 * Also initiate the startup of our primary workgroup (start
896 * elections if we are setup as being able to be a local
900 if( False == register_my_workgroup_and_names() ) {
901 DEBUG(0,("ERROR: Failed when creating my my workgroup. Exiting.\n"));
902 kill_async_dns_child();
906 /* We can only take signals in the select. */
907 BlockSignals( True, SIGTERM );
913 kill_async_dns_child();