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;
56 ctx = messaging_init(NULL, server_id_self(),
57 nmbd_event_context());
60 DEBUG(0, ("Could not init nmbd messaging context.\n"));
65 /**************************************************************************** **
66 Handle a SIGTERM in band.
67 **************************************************************************** */
69 static void terminate(void)
71 DEBUG(0,("Got SIGTERM: going down...\n"));
73 /* Write out wins.dat file if samba is a WINS server */
74 wins_write_database(0,False);
76 /* Remove all SELF registered names from WINS */
79 /* Announce all server entries as 0 time-to-live, 0 type. */
80 announce_my_servers_removed();
82 /* If there was an async dns child - kill it. */
83 kill_async_dns_child();
88 /**************************************************************************** **
89 Handle a SHUTDOWN message from smbcontrol.
90 **************************************************************************** */
92 static void nmbd_terminate(struct messaging_context *msg,
95 struct server_id server_id,
101 /**************************************************************************** **
102 Catch a SIGTERM signal.
103 **************************************************************************** */
105 static SIG_ATOMIC_T got_sig_term;
107 static void sig_term(int sig)
110 sys_select_signal(SIGTERM);
113 /**************************************************************************** **
114 Catch a SIGHUP signal.
115 **************************************************************************** */
117 static SIG_ATOMIC_T reload_after_sighup;
119 static void sig_hup(int sig)
121 reload_after_sighup = 1;
122 sys_select_signal(SIGHUP);
125 /**************************************************************************** **
126 Possibly continue after a fault.
127 **************************************************************************** */
129 static void fault_continue(void)
134 /**************************************************************************** **
135 Expire old names from the namelist and server list.
136 **************************************************************************** */
138 static void expire_names_and_servers(time_t t)
140 static time_t lastrun = 0;
144 if ( t < (lastrun + 5) )
149 * Expire any timed out names on all the broadcast
150 * subnets and those registered with the WINS server.
151 * (nmbd_namelistdb.c)
157 * Go through all the broadcast subnets and for each
158 * workgroup known on that subnet remove any expired
159 * server names. If a workgroup has an empty serverlist
160 * and has itself timed out then remove the workgroup.
161 * (nmbd_workgroupdb.c)
164 expire_workgroups_and_servers(t);
167 /************************************************************************** **
168 Reload the list of network interfaces.
169 Doesn't return until a network interface is up.
170 ************************************************************************** */
172 static void reload_interfaces(time_t t)
176 bool print_waiting_msg = true;
177 struct subnet_record *subrec;
179 if (t && ((t - lastt) < NMBD_INTERFACES_RELOAD)) {
185 if (!interfaces_changed()) {
191 /* the list of probed interfaces has changed, we may need to add/remove
195 /* find any interfaces that need adding */
196 for (n=iface_count() - 1; n >= 0; n--) {
197 char str[INET6_ADDRSTRLEN];
198 const struct interface *iface = get_interface(n);
199 struct in_addr ip, nmask;
202 DEBUG(2,("reload_interfaces: failed to get interface %d\n", n));
206 /* Ensure we're only dealing with IPv4 here. */
207 if (iface->ip.ss_family != AF_INET) {
208 DEBUG(2,("reload_interfaces: "
209 "ignoring non IPv4 interface.\n"));
213 ip = ((struct sockaddr_in *)&iface->ip)->sin_addr;
214 nmask = ((struct sockaddr_in *)&iface->netmask)->sin_addr;
217 * We don't want to add a loopback interface, in case
218 * someone has added 127.0.0.1 for smbd, nmbd needs to
219 * ignore it here. JRA.
222 if (is_loopback_addr((struct sockaddr *)&iface->ip)) {
223 DEBUG(2,("reload_interfaces: Ignoring loopback "
225 print_sockaddr(str, sizeof(str), &iface->ip) ));
229 for (subrec=subnetlist; subrec; subrec=subrec->next) {
230 if (ip_equal_v4(ip, subrec->myip) &&
231 ip_equal_v4(nmask, subrec->mask_ip)) {
237 /* it wasn't found! add it */
238 DEBUG(2,("Found new interface %s\n",
240 sizeof(str), &iface->ip) ));
241 subrec = make_normal_subnet(iface);
243 register_my_workgroup_one_subnet(subrec);
247 /* find any interfaces that need deleting */
248 for (subrec=subnetlist; subrec; subrec=subrec->next) {
249 for (n=iface_count() - 1; n >= 0; n--) {
250 struct interface *iface = get_interface(n);
251 struct in_addr ip, nmask;
255 /* Ensure we're only dealing with IPv4 here. */
256 if (iface->ip.ss_family != AF_INET) {
257 DEBUG(2,("reload_interfaces: "
258 "ignoring non IPv4 interface.\n"));
261 ip = ((struct sockaddr_in *)&iface->ip)->sin_addr;
262 nmask = ((struct sockaddr_in *)&iface->netmask)->sin_addr;
263 if (ip_equal_v4(ip, subrec->myip) &&
264 ip_equal_v4(nmask, subrec->mask_ip)) {
269 /* oops, an interface has disapeared. This is
270 tricky, we don't dare actually free the
271 interface as it could be being used, so
272 instead we just wear the memory leak and
273 remove it from the list of interfaces without
275 DEBUG(2,("Deleting dead interface %s\n",
276 inet_ntoa(subrec->myip)));
277 close_subnet(subrec);
281 rescan_listen_set = True;
283 /* We need to wait if there are no subnets... */
284 if (FIRST_SUBNET == NULL) {
286 if (print_waiting_msg) {
287 DEBUG(0,("reload_interfaces: "
288 "No subnets to listen to. Waiting..\n"));
289 print_waiting_msg = false;
293 * Whilst we're waiting for an interface, allow SIGTERM to
297 BlockSignals(false, SIGTERM);
299 /* We only count IPv4, non-loopback interfaces here. */
300 while (iface_count_v4_nl() == 0 && !got_sig_term) {
306 * Handle termination inband.
315 * We got an interface, go back to blocking term.
318 BlockSignals(true, SIGTERM);
323 /**************************************************************************** **
324 Reload the services file.
325 **************************************************************************** */
327 static bool reload_nmbd_services(bool test)
331 set_remote_machine_name("nmbd", False);
334 const char *fname = lp_configfile();
335 if (file_exist(fname) && !strcsequal(fname,get_dyn_CONFIGFILE())) {
336 set_dyn_CONFIGFILE(fname);
341 if ( test && !lp_file_list_changed() )
344 ret = lp_load(get_dyn_CONFIGFILE(), True , False, False, True);
346 /* perhaps the config filename is now set */
348 DEBUG( 3, ( "services not loaded\n" ) );
349 reload_nmbd_services( True );
355 /**************************************************************************** **
356 * React on 'smbcontrol nmbd reload-config' in the same way as to SIGHUP
357 **************************************************************************** */
359 static void msg_reload_nmbd_services(struct messaging_context *msg,
362 struct server_id server_id,
365 write_browse_list( 0, True );
366 dump_all_namelists();
367 reload_nmbd_services( True );
369 reload_interfaces(0);
372 static void msg_nmbd_send_packet(struct messaging_context *msg,
375 struct server_id src,
378 struct packet_struct *p = (struct packet_struct *)data->data;
379 struct subnet_record *subrec;
380 struct sockaddr_storage ss;
381 const struct sockaddr_storage *pss;
382 const struct in_addr *local_ip;
384 DEBUG(10, ("Received send_packet from %d\n", procid_to_pid(&src)));
386 if (data->length != sizeof(struct packet_struct)) {
387 DEBUG(2, ("Discarding invalid packet length from %d\n",
388 procid_to_pid(&src)));
392 if ((p->packet_type != NMB_PACKET) &&
393 (p->packet_type != DGRAM_PACKET)) {
394 DEBUG(2, ("Discarding invalid packet type from %d: %d\n",
395 procid_to_pid(&src), p->packet_type));
399 in_addr_to_sockaddr_storage(&ss, p->ip);
400 pss = iface_ip((struct sockaddr *)&ss);
403 DEBUG(2, ("Could not find ip for packet from %d\n",
404 procid_to_pid(&src)));
408 local_ip = &((const struct sockaddr_in *)pss)->sin_addr;
409 subrec = FIRST_SUBNET;
411 p->fd = (p->packet_type == NMB_PACKET) ?
412 subrec->nmb_sock : subrec->dgram_sock;
414 for (subrec = FIRST_SUBNET; subrec != NULL;
415 subrec = NEXT_SUBNET_EXCLUDING_UNICAST(subrec)) {
416 if (ip_equal_v4(*local_ip, subrec->myip)) {
417 p->fd = (p->packet_type == NMB_PACKET) ?
418 subrec->nmb_sock : subrec->dgram_sock;
423 if (p->packet_type == DGRAM_PACKET) {
425 p->packet.dgram.header.source_ip.s_addr = local_ip->s_addr;
426 p->packet.dgram.header.source_port = 138;
432 /**************************************************************************** **
433 The main select loop.
434 **************************************************************************** */
436 static void process(void)
441 time_t t = time(NULL);
442 TALLOC_CTX *frame = talloc_stackframe();
445 * Check all broadcast subnets to see if
446 * we need to run an election on any of them.
450 run_election = check_elections();
453 * Read incoming UDP packets.
457 if(listen_for_packets(run_election)) {
463 * Handle termination inband.
472 * Process all incoming packets
473 * read above. This calls the success and
474 * failure functions registered when response
475 * packets arrrive, and also deals with request
476 * packets from other sources.
483 * Run any elections - initiate becoming
484 * a local master browser if we have won.
491 * Send out any broadcast announcements
492 * of our server names. This also announces
493 * the workgroup name if we are a local
495 * (nmbd_sendannounce.c)
498 announce_my_server_names(t);
501 * Send out any LanMan broadcast announcements
502 * of our server names.
503 * (nmbd_sendannounce.c)
506 announce_my_lm_server_names(t);
509 * If we are a local master browser, periodically
510 * announce ourselves to the domain master browser.
511 * This also deals with syncronising the domain master
512 * browser server lists with ourselves as a local
514 * (nmbd_sendannounce.c)
517 announce_myself_to_domain_master_browser(t);
520 * Fullfill any remote announce requests.
521 * (nmbd_sendannounce.c)
527 * Fullfill any remote browse sync announce requests.
528 * (nmbd_sendannounce.c)
531 browse_sync_remote(t);
534 * Scan the broadcast subnets, and WINS client
535 * namelists and refresh any that need refreshing.
542 * Scan the subnet namelists and server lists and
543 * expire thos that have timed out.
547 expire_names_and_servers(t);
550 * Write out a snapshot of our current browse list into
551 * the browse.dat file. This is used by smbd to service
552 * incoming NetServerEnum calls - used to synchronise
553 * browse lists over subnets.
554 * (nmbd_serverlistdb.c)
557 write_browse_list(t, False);
560 * If we are a domain master browser, we have a list of
561 * local master browsers we should synchronise browse
562 * lists with (these are added by an incoming local
563 * master browser announcement packet). Expire any of
564 * these that are no longer current, and pull the server
565 * lists from each of these known local master browsers.
566 * (nmbd_browsesync.c)
569 dmb_expire_and_sync_browser_lists(t);
572 * Check that there is a local master browser for our
573 * workgroup for all our broadcast subnets. If one
574 * is not found, start an election (which we ourselves
575 * may or may not participate in, depending on the
576 * setting of the 'local master' parameter.
580 check_master_browser_exists(t);
583 * If we are configured as a logon server, attempt to
584 * register the special NetBIOS names to become such
585 * (WORKGROUP<1c> name) on all broadcast subnets and
586 * with the WINS server (if used). If we are configured
587 * to become a domain master browser, attempt to register
588 * the special NetBIOS name (WORKGROUP<1b> name) to
590 * (nmbd_become_dmb.c)
596 * If we are a WINS server, do any timer dependent
597 * processing required.
598 * (nmbd_winsserver.c)
601 initiate_wins_processing(t);
604 * If we are a domain master browser, attempt to contact the
605 * WINS server to get a list of all known WORKGROUPS/DOMAINS.
606 * This will only work to a Samba WINS server.
607 * (nmbd_browsesync.c)
610 if (lp_enhanced_browsing())
611 collect_all_workgroup_names_from_wins_server(t);
614 * Go through the response record queue and time out or re-transmit
615 * and expired entries.
619 retransmit_or_expire_response_records(t);
622 * check to see if any remote browse sync child processes have completed
625 sync_check_completion();
628 * regularly sync with any other DMBs we know about
631 if (lp_enhanced_browsing())
635 * clear the unexpected packet queue
641 * Reload the services file if we got a sighup.
644 if(reload_after_sighup) {
645 DEBUG( 0, ( "Got SIGHUP dumping debug info.\n" ) );
646 msg_reload_nmbd_services(nmbd_messaging_context(),
647 NULL, MSG_SMB_CONF_UPDATED,
648 procid_self(), NULL);
650 reload_after_sighup = 0;
653 /* check for new network interfaces */
655 reload_interfaces(t);
657 /* free up temp memory */
662 /**************************************************************************** **
663 Open the socket communication.
664 **************************************************************************** */
666 static bool open_sockets(bool isdaemon, int port)
668 struct sockaddr_storage ss;
669 const char *sock_addr = lp_socket_address();
672 * The sockets opened here will be used to receive broadcast
673 * packets *only*. Interface specific sockets are opened in
674 * make_subnet() in namedbsubnet.c. Thus we bind to the
675 * address "0.0.0.0". The parameter 'socket address' is
679 if (!interpret_string_addr(&ss, sock_addr,
680 AI_NUMERICHOST|AI_PASSIVE)) {
681 DEBUG(0,("open_sockets: unable to get socket address "
682 "from string %s", sock_addr));
685 if (ss.ss_family != AF_INET) {
686 DEBUG(0,("open_sockets: unable to use IPv6 socket"
693 ClientNMB = open_socket_in(SOCK_DGRAM, port,
700 if (ClientNMB == -1) {
704 ClientDGRAM = open_socket_in(SOCK_DGRAM, DGRAM_PORT,
708 if (ClientDGRAM == -1) {
709 if (ClientNMB != 0) {
715 /* we are never interested in SIGPIPE */
716 BlockSignals(True,SIGPIPE);
718 set_socket_options( ClientNMB, "SO_BROADCAST" );
719 set_socket_options( ClientDGRAM, "SO_BROADCAST" );
721 /* Ensure we're non-blocking. */
722 set_blocking( ClientNMB, False);
723 set_blocking( ClientDGRAM, False);
725 DEBUG( 3, ( "open_sockets: Broadcast sockets opened.\n" ) );
729 /**************************************************************************** **
731 **************************************************************************** */
733 int main(int argc, const char *argv[])
735 static bool is_daemon;
736 static bool opt_interactive;
737 static bool Fork = true;
738 static bool no_process_group;
739 static bool log_stdout;
741 char *p_lmhosts = NULL;
747 OPT_NO_PROCESS_GROUP,
750 struct poptOption long_options[] = {
752 {"daemon", 'D', POPT_ARG_NONE, NULL, OPT_DAEMON, "Become a daemon(default)" },
753 {"interactive", 'i', POPT_ARG_NONE, NULL, OPT_INTERACTIVE, "Run interactive (not a daemon)" },
754 {"foreground", 'F', POPT_ARG_NONE, NULL, OPT_FORK, "Run daemon in foreground (for daemontools & etc)" },
755 {"no-process-group", 0, POPT_ARG_NONE, NULL, OPT_NO_PROCESS_GROUP, "Don't create a new process group" },
756 {"log-stdout", 'S', POPT_ARG_NONE, NULL, OPT_LOG_STDOUT, "Log to stdout" },
757 {"hosts", 'H', POPT_ARG_STRING, &p_lmhosts, 'H', "Load a netbios hosts file"},
758 {"port", 'p', POPT_ARG_INT, &global_nmb_port, NMB_PORT, "Listen on the specified port" },
762 TALLOC_CTX *frame = talloc_stackframe(); /* Setup tos. */
766 global_nmb_port = NMB_PORT;
768 pc = poptGetContext("nmbd", argc, argv, long_options, 0);
769 while ((opt = poptGetNextOpt(pc)) != -1) {
774 case OPT_INTERACTIVE:
775 opt_interactive = true;
780 case OPT_NO_PROCESS_GROUP:
781 no_process_group = true;
787 d_fprintf(stderr, "\nInvalid option %s: %s\n\n",
788 poptBadOption(pc, 0), poptStrerror(opt));
789 poptPrintUsage(pc, stderr, 0);
795 global_in_nmbd = true;
797 StartupTime = time(NULL);
799 sys_srandom(time(NULL) ^ sys_getpid());
801 if (!override_logfile) {
803 if (asprintf(&lfile, "%s/log.nmbd", get_dyn_LOGFILEBASE()) < 0) {
806 lp_set_logfile(lfile);
810 fault_setup((void (*)(void *))fault_continue );
811 dump_core_setup("nmbd");
813 /* POSIX demands that signals are inherited. If the invoking process has
814 * these signals masked, we will have problems, as we won't receive them. */
815 BlockSignals(False, SIGHUP);
816 BlockSignals(False, SIGUSR1);
817 BlockSignals(False, SIGTERM);
819 CatchSignal( SIGHUP, SIGNAL_CAST sig_hup );
820 CatchSignal( SIGTERM, SIGNAL_CAST sig_term );
823 /* we are never interested in SIGFPE */
824 BlockSignals(True,SIGFPE);
827 /* We no longer use USR2... */
829 BlockSignals(True, SIGUSR2);
832 if ( opt_interactive ) {
837 if ( log_stdout && Fork ) {
838 DEBUG(0,("ERROR: Can't log to stdout (-S) unless daemon is in foreground (-F) or interactive (-i)\n"));
842 setup_logging( argv[0], log_stdout );
846 DEBUG(0,("nmbd version %s started.\n", samba_version_string()));
847 DEBUGADD(0,("%s\n", COPYRIGHT_STARTUP_MESSAGE));
849 if (!lp_load_initial_only(get_dyn_CONFIGFILE())) {
850 DEBUG(0, ("error opening config file\n"));
854 if (nmbd_messaging_context() == NULL) {
858 if ( !reload_nmbd_services(False) )
864 reload_nmbd_services( True );
866 if (strequal(lp_workgroup(),"*")) {
867 DEBUG(0,("ERROR: a workgroup name of * is no longer supported\n"));
873 if (!is_daemon && !is_a_socket(0)) {
874 DEBUG(0,("standard input is not a socket, assuming -D option\n"));
878 if (is_daemon && !opt_interactive) {
879 DEBUG( 2, ( "Becoming a daemon.\n" ) );
880 become_daemon(Fork, no_process_group);
885 * If we're interactive we want to set our own process group for
888 if (opt_interactive && !no_process_group)
889 setpgid( (pid_t)0, (pid_t)0 );
892 if (nmbd_messaging_context() == NULL) {
897 /* Setup the async dns. We do it here so it doesn't have all the other
898 stuff initialised and thus chewing memory and sockets */
899 if(lp_we_are_a_wins_server() && lp_dns_proxy()) {
904 if (!directory_exist(lp_lockdir())) {
905 mkdir(lp_lockdir(), 0755);
908 pidfile_create("nmbd");
910 if (!reinit_after_fork(nmbd_messaging_context(),
911 nmbd_event_context(), false)) {
912 DEBUG(0,("reinit_after_fork() failed\n"));
916 /* get broadcast messages */
917 claim_connection(NULL,"",FLAG_MSG_GENERAL|FLAG_MSG_DBWRAP);
919 messaging_register(nmbd_messaging_context(), NULL,
920 MSG_FORCE_ELECTION, nmbd_message_election);
922 /* Until winsrepl is done. */
923 messaging_register(nmbd_messaging_context(), NULL,
924 MSG_WINS_NEW_ENTRY, nmbd_wins_new_entry);
926 messaging_register(nmbd_messaging_context(), NULL,
927 MSG_SHUTDOWN, nmbd_terminate);
928 messaging_register(nmbd_messaging_context(), NULL,
929 MSG_SMB_CONF_UPDATED, msg_reload_nmbd_services);
930 messaging_register(nmbd_messaging_context(), NULL,
931 MSG_SEND_PACKET, msg_nmbd_send_packet);
935 DEBUG( 3, ( "Opening sockets %d\n", global_nmb_port ) );
937 if ( !open_sockets( is_daemon, global_nmb_port ) ) {
938 kill_async_dns_child();
942 /* Determine all the IP addresses we have. */
945 /* Create an nmbd subnet record for each of the above. */
946 if( False == create_subnets() ) {
947 DEBUG(0,("ERROR: Failed when creating subnet lists. Exiting.\n"));
948 kill_async_dns_child();
952 /* Load in any static local names. */
954 set_dyn_LMHOSTSFILE(p_lmhosts);
956 load_lmhosts_file(get_dyn_LMHOSTSFILE());
957 DEBUG(3,("Loaded hosts file %s\n", get_dyn_LMHOSTSFILE()));
959 /* If we are acting as a WINS server, initialise data structures. */
960 if( !initialise_wins() ) {
961 DEBUG( 0, ( "nmbd: Failed when initialising WINS server.\n" ) );
962 kill_async_dns_child();
967 * Register nmbd primary workgroup and nmbd names on all
968 * the broadcast subnets, and on the WINS server (if specified).
969 * Also initiate the startup of our primary workgroup (start
970 * elections if we are setup as being able to be a local
974 if( False == register_my_workgroup_and_names() ) {
975 DEBUG(0,("ERROR: Failed when creating my my workgroup. Exiting.\n"));
976 kill_async_dns_child();
980 /* We can only take signals in the select. */
981 BlockSignals( True, SIGTERM );
988 kill_async_dns_child();