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), &iface->ip) ));
217 for (subrec=subnetlist; subrec; subrec=subrec->next) {
218 if (ip_equal_v4(ip, subrec->myip) &&
219 ip_equal_v4(nmask, subrec->mask_ip)) {
225 /* it wasn't found! add it */
226 DEBUG(2,("Found new interface %s\n",
228 sizeof(str), &iface->ip) ));
229 subrec = make_normal_subnet(iface);
231 register_my_workgroup_one_subnet(subrec);
235 /* find any interfaces that need deleting */
236 for (subrec=subnetlist; subrec; subrec=subrec->next) {
237 for (n=iface_count() - 1; n >= 0; n--) {
238 struct interface *iface = get_interface(n);
239 struct in_addr ip, nmask;
243 /* Ensure we're only dealing with IPv4 here. */
244 if (iface->ip.ss_family != AF_INET) {
245 DEBUG(2,("reload_interfaces: "
246 "ignoring non IPv4 interface.\n"));
249 ip = ((struct sockaddr_in *)&iface->ip)->sin_addr;
250 nmask = ((struct sockaddr_in *)&iface->netmask)->sin_addr;
251 if (ip_equal_v4(ip, subrec->myip) &&
252 ip_equal_v4(nmask, subrec->mask_ip)) {
257 /* oops, an interface has disapeared. This is
258 tricky, we don't dare actually free the
259 interface as it could be being used, so
260 instead we just wear the memory leak and
261 remove it from the list of interfaces without
263 DEBUG(2,("Deleting dead interface %s\n",
264 inet_ntoa(subrec->myip)));
265 close_subnet(subrec);
269 rescan_listen_set = True;
271 /* We need to shutdown if there are no subnets... */
272 if (FIRST_SUBNET == NULL) {
273 DEBUG(0,("reload_interfaces: No subnets to listen to. Shutting down...\n"));
279 /**************************************************************************** **
280 Reload the services file.
281 **************************************************************************** */
283 static bool reload_nmbd_services(bool test)
287 set_remote_machine_name("nmbd", False);
291 pstrcpy( fname,lp_configfile());
292 if (file_exist(fname,NULL) && !strcsequal(fname,dyn_CONFIGFILE)) {
293 pstrcpy(dyn_CONFIGFILE,fname);
298 if ( test && !lp_file_list_changed() )
301 ret = lp_load( dyn_CONFIGFILE, True , False, False, True);
303 /* perhaps the config filename is now set */
305 DEBUG( 3, ( "services not loaded\n" ) );
306 reload_nmbd_services( True );
312 /**************************************************************************** **
313 * React on 'smbcontrol nmbd reload-config' in the same way as to SIGHUP
314 * We use buf here to return bool result to process() when reload_interfaces()
315 * detects that there are no subnets.
316 **************************************************************************** */
318 static void msg_reload_nmbd_services(struct messaging_context *msg,
321 struct server_id server_id,
324 write_browse_list( 0, True );
325 dump_all_namelists();
326 reload_nmbd_services( True );
330 /* We were called from process() */
331 /* If reload_interfaces() returned True */
332 /* we need to shutdown if there are no subnets... */
333 /* pass this info back to process() */
334 *((bool *)data->data) = reload_interfaces(0);
338 static void msg_nmbd_send_packet(struct messaging_context *msg,
341 struct server_id src,
344 struct packet_struct *p = (struct packet_struct *)data->data;
345 struct subnet_record *subrec;
346 struct sockaddr_storage ss;
347 const struct sockaddr_storage *pss;
348 const struct in_addr *local_ip;
350 DEBUG(10, ("Received send_packet from %d\n", procid_to_pid(&src)));
352 if (data->length != sizeof(struct packet_struct)) {
353 DEBUG(2, ("Discarding invalid packet length from %d\n",
354 procid_to_pid(&src)));
358 if ((p->packet_type != NMB_PACKET) &&
359 (p->packet_type != DGRAM_PACKET)) {
360 DEBUG(2, ("Discarding invalid packet type from %d: %d\n",
361 procid_to_pid(&src), p->packet_type));
365 in_addr_to_sockaddr_storage(&ss, p->ip);
369 DEBUG(2, ("Could not find ip for packet from %d\n",
370 procid_to_pid(&src)));
374 local_ip = &((const struct sockaddr_in *)pss)->sin_addr;
375 subrec = FIRST_SUBNET;
377 p->fd = (p->packet_type == NMB_PACKET) ?
378 subrec->nmb_sock : subrec->dgram_sock;
380 for (subrec = FIRST_SUBNET; subrec != NULL;
381 subrec = NEXT_SUBNET_EXCLUDING_UNICAST(subrec)) {
382 if (ip_equal_v4(*local_ip, subrec->myip)) {
383 p->fd = (p->packet_type == NMB_PACKET) ?
384 subrec->nmb_sock : subrec->dgram_sock;
389 if (p->packet_type == DGRAM_PACKET) {
391 p->packet.dgram.header.source_ip.s_addr = local_ip->s_addr;
392 p->packet.dgram.header.source_port = 138;
398 /**************************************************************************** **
399 The main select loop.
400 **************************************************************************** */
402 static void process(void)
408 time_t t = time(NULL);
409 TALLOC_CTX *frame = talloc_stackframe();
411 /* Check for internal messages */
413 message_dispatch(nmbd_messaging_context());
416 * Check all broadcast subnets to see if
417 * we need to run an election on any of them.
421 run_election = check_elections();
424 * Read incoming UDP packets.
428 if(listen_for_packets(run_election)) {
434 * Handle termination inband.
443 * Process all incoming packets
444 * read above. This calls the success and
445 * failure functions registered when response
446 * packets arrrive, and also deals with request
447 * packets from other sources.
454 * Run any elections - initiate becoming
455 * a local master browser if we have won.
462 * Send out any broadcast announcements
463 * of our server names. This also announces
464 * the workgroup name if we are a local
466 * (nmbd_sendannounce.c)
469 announce_my_server_names(t);
472 * Send out any LanMan broadcast announcements
473 * of our server names.
474 * (nmbd_sendannounce.c)
477 announce_my_lm_server_names(t);
480 * If we are a local master browser, periodically
481 * announce ourselves to the domain master browser.
482 * This also deals with syncronising the domain master
483 * browser server lists with ourselves as a local
485 * (nmbd_sendannounce.c)
488 announce_myself_to_domain_master_browser(t);
491 * Fullfill any remote announce requests.
492 * (nmbd_sendannounce.c)
498 * Fullfill any remote browse sync announce requests.
499 * (nmbd_sendannounce.c)
502 browse_sync_remote(t);
505 * Scan the broadcast subnets, and WINS client
506 * namelists and refresh any that need refreshing.
513 * Scan the subnet namelists and server lists and
514 * expire thos that have timed out.
518 expire_names_and_servers(t);
521 * Write out a snapshot of our current browse list into
522 * the browse.dat file. This is used by smbd to service
523 * incoming NetServerEnum calls - used to synchronise
524 * browse lists over subnets.
525 * (nmbd_serverlistdb.c)
528 write_browse_list(t, False);
531 * If we are a domain master browser, we have a list of
532 * local master browsers we should synchronise browse
533 * lists with (these are added by an incoming local
534 * master browser announcement packet). Expire any of
535 * these that are no longer current, and pull the server
536 * lists from each of these known local master browsers.
537 * (nmbd_browsesync.c)
540 dmb_expire_and_sync_browser_lists(t);
543 * Check that there is a local master browser for our
544 * workgroup for all our broadcast subnets. If one
545 * is not found, start an election (which we ourselves
546 * may or may not participate in, depending on the
547 * setting of the 'local master' parameter.
551 check_master_browser_exists(t);
554 * If we are configured as a logon server, attempt to
555 * register the special NetBIOS names to become such
556 * (WORKGROUP<1c> name) on all broadcast subnets and
557 * with the WINS server (if used). If we are configured
558 * to become a domain master browser, attempt to register
559 * the special NetBIOS name (WORKGROUP<1b> name) to
561 * (nmbd_become_dmb.c)
567 * If we are a WINS server, do any timer dependent
568 * processing required.
569 * (nmbd_winsserver.c)
572 initiate_wins_processing(t);
575 * If we are a domain master browser, attempt to contact the
576 * WINS server to get a list of all known WORKGROUPS/DOMAINS.
577 * This will only work to a Samba WINS server.
578 * (nmbd_browsesync.c)
581 if (lp_enhanced_browsing())
582 collect_all_workgroup_names_from_wins_server(t);
585 * Go through the response record queue and time out or re-transmit
586 * and expired entries.
590 retransmit_or_expire_response_records(t);
593 * check to see if any remote browse sync child processes have completed
596 sync_check_completion();
599 * regularly sync with any other DMBs we know about
602 if (lp_enhanced_browsing())
606 * clear the unexpected packet queue
612 * Reload the services file if we got a sighup.
615 if(reload_after_sighup) {
616 DATA_BLOB blob = data_blob_const(&no_subnets,
618 DEBUG( 0, ( "Got SIGHUP dumping debug info.\n" ) );
619 msg_reload_nmbd_services(nmbd_messaging_context(),
620 NULL, MSG_SMB_CONF_UPDATED,
621 procid_self(), &blob);
627 reload_after_sighup = 0;
630 /* check for new network interfaces */
632 if(reload_interfaces(t)) {
637 /* free up temp memory */
642 /**************************************************************************** **
643 Open the socket communication.
644 **************************************************************************** */
646 static bool open_sockets(bool isdaemon, int port)
648 struct sockaddr_storage ss;
649 const char *sock_addr = lp_socket_address();
652 * The sockets opened here will be used to receive broadcast
653 * packets *only*. Interface specific sockets are opened in
654 * make_subnet() in namedbsubnet.c. Thus we bind to the
655 * address "0.0.0.0". The parameter 'socket address' is
659 if (!interpret_string_addr(&ss, sock_addr,
660 AI_NUMERICHOST|AI_PASSIVE)) {
661 DEBUG(0,("open_sockets: unable to get socket address "
662 "from string %s", sock_addr));
665 if (ss.ss_family != AF_INET) {
666 DEBUG(0,("open_sockets: unable to use IPv6 socket"
673 ClientNMB = open_socket_in(SOCK_DGRAM, port,
680 ClientDGRAM = open_socket_in(SOCK_DGRAM, DGRAM_PORT,
684 if (ClientNMB == -1) {
688 /* we are never interested in SIGPIPE */
689 BlockSignals(True,SIGPIPE);
691 set_socket_options( ClientNMB, "SO_BROADCAST" );
692 set_socket_options( ClientDGRAM, "SO_BROADCAST" );
694 /* Ensure we're non-blocking. */
695 set_blocking( ClientNMB, False);
696 set_blocking( ClientDGRAM, False);
698 DEBUG( 3, ( "open_sockets: Broadcast sockets opened.\n" ) );
702 /**************************************************************************** **
704 **************************************************************************** */
706 int main(int argc, const char *argv[])
708 static bool is_daemon;
709 static bool opt_interactive;
710 static bool Fork = true;
711 static bool no_process_group;
712 static bool log_stdout;
715 static char *p_lmhosts = dyn_LMHOSTSFILE;
721 OPT_NO_PROCESS_GROUP,
724 struct poptOption long_options[] = {
726 {"daemon", 'D', POPT_ARG_NONE, NULL, OPT_DAEMON, "Become a daemon(default)" },
727 {"interactive", 'i', POPT_ARG_NONE, NULL, OPT_INTERACTIVE, "Run interactive (not a daemon)" },
728 {"foreground", 'F', POPT_ARG_NONE, NULL, OPT_FORK, "Run daemon in foreground (for daemontools & etc)" },
729 {"no-process-group", 0, POPT_ARG_NONE, NULL, OPT_NO_PROCESS_GROUP, "Don't create a new process group" },
730 {"log-stdout", 'S', POPT_ARG_NONE, NULL, OPT_LOG_STDOUT, "Log to stdout" },
731 {"hosts", 'H', POPT_ARG_STRING, &p_lmhosts, 'H', "Load a netbios hosts file"},
732 {"port", 'p', POPT_ARG_INT, &global_nmb_port, NMB_PORT, "Listen on the specified port" },
736 TALLOC_CTX *frame = talloc_stackframe(); /* Setup tos. */
740 global_nmb_port = NMB_PORT;
742 pc = poptGetContext("nmbd", argc, argv, long_options, 0);
743 while ((opt = poptGetNextOpt(pc)) != -1) {
748 case OPT_INTERACTIVE:
749 opt_interactive = true;
754 case OPT_NO_PROCESS_GROUP:
755 no_process_group = true;
761 d_fprintf(stderr, "\nInvalid option %s: %s\n\n",
762 poptBadOption(pc, 0), poptStrerror(opt));
763 poptPrintUsage(pc, stderr, 0);
769 global_in_nmbd = true;
771 StartupTime = time(NULL);
773 sys_srandom(time(NULL) ^ sys_getpid());
775 if (!override_logfile) {
776 slprintf(logfile, sizeof(logfile)-1, "%s/log.nmbd", dyn_LOGFILEBASE);
777 lp_set_logfile(logfile);
780 fault_setup((void (*)(void *))fault_continue );
781 dump_core_setup("nmbd");
783 /* POSIX demands that signals are inherited. If the invoking process has
784 * these signals masked, we will have problems, as we won't receive them. */
785 BlockSignals(False, SIGHUP);
786 BlockSignals(False, SIGUSR1);
787 BlockSignals(False, SIGTERM);
789 CatchSignal( SIGHUP, SIGNAL_CAST sig_hup );
790 CatchSignal( SIGTERM, SIGNAL_CAST sig_term );
793 /* we are never interested in SIGFPE */
794 BlockSignals(True,SIGFPE);
797 /* We no longer use USR2... */
799 BlockSignals(True, SIGUSR2);
802 if ( opt_interactive ) {
807 if ( log_stdout && Fork ) {
808 DEBUG(0,("ERROR: Can't log to stdout (-S) unless daemon is in foreground (-F) or interactive (-i)\n"));
812 setup_logging( argv[0], log_stdout );
816 DEBUG(0,("nmbd version %s started.\n", SAMBA_VERSION_STRING));
817 DEBUGADD(0,("%s\n", COPYRIGHT_STARTUP_MESSAGE));
819 if ( !reload_nmbd_services(False) )
825 reload_nmbd_services( True );
827 if (strequal(lp_workgroup(),"*")) {
828 DEBUG(0,("ERROR: a workgroup name of * is no longer supported\n"));
834 if (!is_daemon && !is_a_socket(0)) {
835 DEBUG(0,("standard input is not a socket, assuming -D option\n"));
839 if (is_daemon && !opt_interactive) {
840 DEBUG( 2, ( "Becoming a daemon.\n" ) );
841 become_daemon(Fork, no_process_group);
846 * If we're interactive we want to set our own process group for
849 if (opt_interactive && !no_process_group)
850 setpgid( (pid_t)0, (pid_t)0 );
853 if (nmbd_messaging_context() == NULL) {
858 /* Setup the async dns. We do it here so it doesn't have all the other
859 stuff initialised and thus chewing memory and sockets */
860 if(lp_we_are_a_wins_server() && lp_dns_proxy()) {
865 if (!directory_exist(lp_lockdir(), NULL)) {
866 mkdir(lp_lockdir(), 0755);
869 pidfile_create("nmbd");
870 messaging_register(nmbd_messaging_context(), NULL,
871 MSG_FORCE_ELECTION, nmbd_message_election);
873 /* Until winsrepl is done. */
874 messaging_register(nmbd_messaging_context(), NULL,
875 MSG_WINS_NEW_ENTRY, nmbd_wins_new_entry);
877 messaging_register(nmbd_messaging_context(), NULL,
878 MSG_SHUTDOWN, nmbd_terminate);
879 messaging_register(nmbd_messaging_context(), NULL,
880 MSG_SMB_CONF_UPDATED, msg_reload_nmbd_services);
881 messaging_register(nmbd_messaging_context(), NULL,
882 MSG_SEND_PACKET, msg_nmbd_send_packet);
886 DEBUG( 3, ( "Opening sockets %d\n", global_nmb_port ) );
888 if ( !open_sockets( is_daemon, global_nmb_port ) ) {
889 kill_async_dns_child();
893 /* Determine all the IP addresses we have. */
896 /* Create an nmbd subnet record for each of the above. */
897 if( False == create_subnets() ) {
898 DEBUG(0,("ERROR: Failed when creating subnet lists. Exiting.\n"));
899 kill_async_dns_child();
903 /* Load in any static local names. */
904 load_lmhosts_file(p_lmhosts);
905 DEBUG(3,("Loaded hosts file %s\n", p_lmhosts));
907 /* If we are acting as a WINS server, initialise data structures. */
908 if( !initialise_wins() ) {
909 DEBUG( 0, ( "nmbd: Failed when initialising WINS server.\n" ) );
910 kill_async_dns_child();
915 * Register nmbd primary workgroup and nmbd names on all
916 * the broadcast subnets, and on the WINS server (if specified).
917 * Also initiate the startup of our primary workgroup (start
918 * elections if we are setup as being able to be a local
922 if( False == register_my_workgroup_and_names() ) {
923 DEBUG(0,("ERROR: Failed when creating my my workgroup. Exiting.\n"));
924 kill_async_dns_child();
928 /* We can only take signals in the select. */
929 BlockSignals( True, SIGTERM );
936 kill_async_dns_child();