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);
290 const char *fname = lp_configfile();
291 if (file_exist(fname,NULL) && !strcsequal(fname,dyn_CONFIGFILE)) {
292 strlcpy(dyn_CONFIGFILE,fname,sizeof(dyn_CONFIGFILE));
297 if ( test && !lp_file_list_changed() )
300 ret = lp_load( dyn_CONFIGFILE, True , False, False, True);
302 /* perhaps the config filename is now set */
304 DEBUG( 3, ( "services not loaded\n" ) );
305 reload_nmbd_services( True );
311 /**************************************************************************** **
312 * React on 'smbcontrol nmbd reload-config' in the same way as to SIGHUP
313 * We use buf here to return bool result to process() when reload_interfaces()
314 * detects that there are no subnets.
315 **************************************************************************** */
317 static void msg_reload_nmbd_services(struct messaging_context *msg,
320 struct server_id server_id,
323 write_browse_list( 0, True );
324 dump_all_namelists();
325 reload_nmbd_services( True );
329 /* We were called from process() */
330 /* If reload_interfaces() returned True */
331 /* we need to shutdown if there are no subnets... */
332 /* pass this info back to process() */
333 *((bool *)data->data) = reload_interfaces(0);
337 static void msg_nmbd_send_packet(struct messaging_context *msg,
340 struct server_id src,
343 struct packet_struct *p = (struct packet_struct *)data->data;
344 struct subnet_record *subrec;
345 struct sockaddr_storage ss;
346 const struct sockaddr_storage *pss;
347 const struct in_addr *local_ip;
349 DEBUG(10, ("Received send_packet from %d\n", procid_to_pid(&src)));
351 if (data->length != sizeof(struct packet_struct)) {
352 DEBUG(2, ("Discarding invalid packet length from %d\n",
353 procid_to_pid(&src)));
357 if ((p->packet_type != NMB_PACKET) &&
358 (p->packet_type != DGRAM_PACKET)) {
359 DEBUG(2, ("Discarding invalid packet type from %d: %d\n",
360 procid_to_pid(&src), p->packet_type));
364 in_addr_to_sockaddr_storage(&ss, p->ip);
368 DEBUG(2, ("Could not find ip for packet from %d\n",
369 procid_to_pid(&src)));
373 local_ip = &((const struct sockaddr_in *)pss)->sin_addr;
374 subrec = FIRST_SUBNET;
376 p->fd = (p->packet_type == NMB_PACKET) ?
377 subrec->nmb_sock : subrec->dgram_sock;
379 for (subrec = FIRST_SUBNET; subrec != NULL;
380 subrec = NEXT_SUBNET_EXCLUDING_UNICAST(subrec)) {
381 if (ip_equal_v4(*local_ip, subrec->myip)) {
382 p->fd = (p->packet_type == NMB_PACKET) ?
383 subrec->nmb_sock : subrec->dgram_sock;
388 if (p->packet_type == DGRAM_PACKET) {
390 p->packet.dgram.header.source_ip.s_addr = local_ip->s_addr;
391 p->packet.dgram.header.source_port = 138;
397 /**************************************************************************** **
398 The main select loop.
399 **************************************************************************** */
401 static void process(void)
407 time_t t = time(NULL);
408 TALLOC_CTX *frame = talloc_stackframe();
410 /* Check for internal messages */
412 message_dispatch(nmbd_messaging_context());
415 * Check all broadcast subnets to see if
416 * we need to run an election on any of them.
420 run_election = check_elections();
423 * Read incoming UDP packets.
427 if(listen_for_packets(run_election)) {
433 * Handle termination inband.
442 * Process all incoming packets
443 * read above. This calls the success and
444 * failure functions registered when response
445 * packets arrrive, and also deals with request
446 * packets from other sources.
453 * Run any elections - initiate becoming
454 * a local master browser if we have won.
461 * Send out any broadcast announcements
462 * of our server names. This also announces
463 * the workgroup name if we are a local
465 * (nmbd_sendannounce.c)
468 announce_my_server_names(t);
471 * Send out any LanMan broadcast announcements
472 * of our server names.
473 * (nmbd_sendannounce.c)
476 announce_my_lm_server_names(t);
479 * If we are a local master browser, periodically
480 * announce ourselves to the domain master browser.
481 * This also deals with syncronising the domain master
482 * browser server lists with ourselves as a local
484 * (nmbd_sendannounce.c)
487 announce_myself_to_domain_master_browser(t);
490 * Fullfill any remote announce requests.
491 * (nmbd_sendannounce.c)
497 * Fullfill any remote browse sync announce requests.
498 * (nmbd_sendannounce.c)
501 browse_sync_remote(t);
504 * Scan the broadcast subnets, and WINS client
505 * namelists and refresh any that need refreshing.
512 * Scan the subnet namelists and server lists and
513 * expire thos that have timed out.
517 expire_names_and_servers(t);
520 * Write out a snapshot of our current browse list into
521 * the browse.dat file. This is used by smbd to service
522 * incoming NetServerEnum calls - used to synchronise
523 * browse lists over subnets.
524 * (nmbd_serverlistdb.c)
527 write_browse_list(t, False);
530 * If we are a domain master browser, we have a list of
531 * local master browsers we should synchronise browse
532 * lists with (these are added by an incoming local
533 * master browser announcement packet). Expire any of
534 * these that are no longer current, and pull the server
535 * lists from each of these known local master browsers.
536 * (nmbd_browsesync.c)
539 dmb_expire_and_sync_browser_lists(t);
542 * Check that there is a local master browser for our
543 * workgroup for all our broadcast subnets. If one
544 * is not found, start an election (which we ourselves
545 * may or may not participate in, depending on the
546 * setting of the 'local master' parameter.
550 check_master_browser_exists(t);
553 * If we are configured as a logon server, attempt to
554 * register the special NetBIOS names to become such
555 * (WORKGROUP<1c> name) on all broadcast subnets and
556 * with the WINS server (if used). If we are configured
557 * to become a domain master browser, attempt to register
558 * the special NetBIOS name (WORKGROUP<1b> name) to
560 * (nmbd_become_dmb.c)
566 * If we are a WINS server, do any timer dependent
567 * processing required.
568 * (nmbd_winsserver.c)
571 initiate_wins_processing(t);
574 * If we are a domain master browser, attempt to contact the
575 * WINS server to get a list of all known WORKGROUPS/DOMAINS.
576 * This will only work to a Samba WINS server.
577 * (nmbd_browsesync.c)
580 if (lp_enhanced_browsing())
581 collect_all_workgroup_names_from_wins_server(t);
584 * Go through the response record queue and time out or re-transmit
585 * and expired entries.
589 retransmit_or_expire_response_records(t);
592 * check to see if any remote browse sync child processes have completed
595 sync_check_completion();
598 * regularly sync with any other DMBs we know about
601 if (lp_enhanced_browsing())
605 * clear the unexpected packet queue
611 * Reload the services file if we got a sighup.
614 if(reload_after_sighup) {
615 DATA_BLOB blob = data_blob_const(&no_subnets,
617 DEBUG( 0, ( "Got SIGHUP dumping debug info.\n" ) );
618 msg_reload_nmbd_services(nmbd_messaging_context(),
619 NULL, MSG_SMB_CONF_UPDATED,
620 procid_self(), &blob);
626 reload_after_sighup = 0;
629 /* check for new network interfaces */
631 if(reload_interfaces(t)) {
636 /* free up temp memory */
641 /**************************************************************************** **
642 Open the socket communication.
643 **************************************************************************** */
645 static bool open_sockets(bool isdaemon, int port)
647 struct sockaddr_storage ss;
648 const char *sock_addr = lp_socket_address();
651 * The sockets opened here will be used to receive broadcast
652 * packets *only*. Interface specific sockets are opened in
653 * make_subnet() in namedbsubnet.c. Thus we bind to the
654 * address "0.0.0.0". The parameter 'socket address' is
658 if (!interpret_string_addr(&ss, sock_addr,
659 AI_NUMERICHOST|AI_PASSIVE)) {
660 DEBUG(0,("open_sockets: unable to get socket address "
661 "from string %s", sock_addr));
664 if (ss.ss_family != AF_INET) {
665 DEBUG(0,("open_sockets: unable to use IPv6 socket"
672 ClientNMB = open_socket_in(SOCK_DGRAM, port,
679 ClientDGRAM = open_socket_in(SOCK_DGRAM, DGRAM_PORT,
683 if (ClientNMB == -1) {
687 /* we are never interested in SIGPIPE */
688 BlockSignals(True,SIGPIPE);
690 set_socket_options( ClientNMB, "SO_BROADCAST" );
691 set_socket_options( ClientDGRAM, "SO_BROADCAST" );
693 /* Ensure we're non-blocking. */
694 set_blocking( ClientNMB, False);
695 set_blocking( ClientDGRAM, False);
697 DEBUG( 3, ( "open_sockets: Broadcast sockets opened.\n" ) );
701 /**************************************************************************** **
703 **************************************************************************** */
705 int main(int argc, const char *argv[])
707 static bool is_daemon;
708 static bool opt_interactive;
709 static bool Fork = true;
710 static bool no_process_group;
711 static bool log_stdout;
713 static char *p_lmhosts = dyn_LMHOSTSFILE;
719 OPT_NO_PROCESS_GROUP,
722 struct poptOption long_options[] = {
724 {"daemon", 'D', POPT_ARG_NONE, NULL, OPT_DAEMON, "Become a daemon(default)" },
725 {"interactive", 'i', POPT_ARG_NONE, NULL, OPT_INTERACTIVE, "Run interactive (not a daemon)" },
726 {"foreground", 'F', POPT_ARG_NONE, NULL, OPT_FORK, "Run daemon in foreground (for daemontools & etc)" },
727 {"no-process-group", 0, POPT_ARG_NONE, NULL, OPT_NO_PROCESS_GROUP, "Don't create a new process group" },
728 {"log-stdout", 'S', POPT_ARG_NONE, NULL, OPT_LOG_STDOUT, "Log to stdout" },
729 {"hosts", 'H', POPT_ARG_STRING, &p_lmhosts, 'H', "Load a netbios hosts file"},
730 {"port", 'p', POPT_ARG_INT, &global_nmb_port, NMB_PORT, "Listen on the specified port" },
734 TALLOC_CTX *frame = talloc_stackframe(); /* Setup tos. */
738 global_nmb_port = NMB_PORT;
740 pc = poptGetContext("nmbd", argc, argv, long_options, 0);
741 while ((opt = poptGetNextOpt(pc)) != -1) {
746 case OPT_INTERACTIVE:
747 opt_interactive = true;
752 case OPT_NO_PROCESS_GROUP:
753 no_process_group = true;
759 d_fprintf(stderr, "\nInvalid option %s: %s\n\n",
760 poptBadOption(pc, 0), poptStrerror(opt));
761 poptPrintUsage(pc, stderr, 0);
767 global_in_nmbd = true;
769 StartupTime = time(NULL);
771 sys_srandom(time(NULL) ^ sys_getpid());
773 if (!override_logfile) {
774 char *logfile = NULL;
775 if (asprintf(&logfile, "%s/log.nmbd", dyn_LOGFILEBASE) < 0) {
778 lp_set_logfile(logfile);
782 fault_setup((void (*)(void *))fault_continue );
783 dump_core_setup("nmbd");
785 /* POSIX demands that signals are inherited. If the invoking process has
786 * these signals masked, we will have problems, as we won't receive them. */
787 BlockSignals(False, SIGHUP);
788 BlockSignals(False, SIGUSR1);
789 BlockSignals(False, SIGTERM);
791 CatchSignal( SIGHUP, SIGNAL_CAST sig_hup );
792 CatchSignal( SIGTERM, SIGNAL_CAST sig_term );
795 /* we are never interested in SIGFPE */
796 BlockSignals(True,SIGFPE);
799 /* We no longer use USR2... */
801 BlockSignals(True, SIGUSR2);
804 if ( opt_interactive ) {
809 if ( log_stdout && Fork ) {
810 DEBUG(0,("ERROR: Can't log to stdout (-S) unless daemon is in foreground (-F) or interactive (-i)\n"));
814 setup_logging( argv[0], log_stdout );
818 DEBUG(0,("nmbd version %s started.\n", SAMBA_VERSION_STRING));
819 DEBUGADD(0,("%s\n", COPYRIGHT_STARTUP_MESSAGE));
821 if ( !reload_nmbd_services(False) )
827 reload_nmbd_services( True );
829 if (strequal(lp_workgroup(),"*")) {
830 DEBUG(0,("ERROR: a workgroup name of * is no longer supported\n"));
836 if (!is_daemon && !is_a_socket(0)) {
837 DEBUG(0,("standard input is not a socket, assuming -D option\n"));
841 if (is_daemon && !opt_interactive) {
842 DEBUG( 2, ( "Becoming a daemon.\n" ) );
843 become_daemon(Fork, no_process_group);
848 * If we're interactive we want to set our own process group for
851 if (opt_interactive && !no_process_group)
852 setpgid( (pid_t)0, (pid_t)0 );
855 if (nmbd_messaging_context() == NULL) {
860 /* Setup the async dns. We do it here so it doesn't have all the other
861 stuff initialised and thus chewing memory and sockets */
862 if(lp_we_are_a_wins_server() && lp_dns_proxy()) {
867 if (!directory_exist(lp_lockdir(), NULL)) {
868 mkdir(lp_lockdir(), 0755);
871 pidfile_create("nmbd");
872 messaging_register(nmbd_messaging_context(), NULL,
873 MSG_FORCE_ELECTION, nmbd_message_election);
875 /* Until winsrepl is done. */
876 messaging_register(nmbd_messaging_context(), NULL,
877 MSG_WINS_NEW_ENTRY, nmbd_wins_new_entry);
879 messaging_register(nmbd_messaging_context(), NULL,
880 MSG_SHUTDOWN, nmbd_terminate);
881 messaging_register(nmbd_messaging_context(), NULL,
882 MSG_SMB_CONF_UPDATED, msg_reload_nmbd_services);
883 messaging_register(nmbd_messaging_context(), NULL,
884 MSG_SEND_PACKET, msg_nmbd_send_packet);
888 DEBUG( 3, ( "Opening sockets %d\n", global_nmb_port ) );
890 if ( !open_sockets( is_daemon, global_nmb_port ) ) {
891 kill_async_dns_child();
895 /* Determine all the IP addresses we have. */
898 /* Create an nmbd subnet record for each of the above. */
899 if( False == create_subnets() ) {
900 DEBUG(0,("ERROR: Failed when creating subnet lists. Exiting.\n"));
901 kill_async_dns_child();
905 /* Load in any static local names. */
906 load_lmhosts_file(p_lmhosts);
907 DEBUG(3,("Loaded hosts file %s\n", p_lmhosts));
909 /* If we are acting as a WINS server, initialise data structures. */
910 if( !initialise_wins() ) {
911 DEBUG( 0, ( "nmbd: Failed when initialising WINS server.\n" ) );
912 kill_async_dns_child();
917 * Register nmbd primary workgroup and nmbd names on all
918 * the broadcast subnets, and on the WINS server (if specified).
919 * Also initiate the startup of our primary workgroup (start
920 * elections if we are setup as being able to be a local
924 if( False == register_my_workgroup_and_names() ) {
925 DEBUG(0,("ERROR: Failed when creating my my workgroup. Exiting.\n"));
926 kill_async_dns_child();
930 /* We can only take signals in the select. */
931 BlockSignals( True, SIGTERM );
938 kill_async_dns_child();