2 Unix SMB/Netbios implementation.
4 NBT netbios routines and daemon - version 2
5 Copyright (C) Andrew Tridgell 1994-1997
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 Module name: nameelect.c
25 14 jan 96: lkcl@pires.co.uk
26 added multiple workgroup domain master support
28 04 jul 96: lkcl@pires.co.uk
29 added system to become a master browser by stages.
37 extern int ClientDGRAM
;
39 extern int DEBUGLEVEL
;
42 extern pstring myname
;
43 extern fstring myworkgroup
;
44 extern struct in_addr ipzero
;
45 extern struct in_addr wins_ip
;
47 /* here are my election parameters */
49 extern time_t StartupTime
;
51 extern struct subnet_record
*subnetlist
;
53 extern uint16 nb_type
; /* samba's NetBIOS name type */
56 /*******************************************************************
57 occasionally check to see if the master browser is around
58 ******************************************************************/
59 void check_master_browser(time_t t
)
61 static time_t lastrun
=0;
62 struct subnet_record
*d
;
64 if (!lastrun
) lastrun
= t
;
65 if (t
< lastrun
+ CHECK_TIME_MST_BROWSE
* 60) return;
71 for (d
= FIRST_SUBNET
; d
; d
= NEXT_SUBNET_EXCLUDING_WINS(d
))
73 struct work_record
*work
;
75 for (work
= d
->workgrouplist
; work
; work
= work
->next
)
77 if (strequal(work
->work_group
, myworkgroup
) && !AM_MASTER(work
))
79 if (lp_local_master())
81 /* potential master browser - not a master browser. force
82 becoming a master browser, hence the log message.
85 DEBUG(0,("%s potential master for %s %s - force election\n",
86 timestring(), work
->work_group
,
87 inet_ntoa(d
->bcast_ip
)));
89 browser_gone(work
->work_group
, d
->bcast_ip
);
93 /* if we are not the browse master of a workgroup,
94 and we can't find a browser on the subnet, do
98 queue_netbios_packet(d
,ClientNMB
,NMB_QUERY
,NAME_QUERY_MST_CHK
,
99 work
->work_group
,0x1d,0,0,0,NULL
,NULL
,
100 True
,False
,d
->bcast_ip
,d
->bcast_ip
);
108 /*******************************************************************
109 what to do if a master browser DOESN't exist.
111 option 1: force an election, and participate in it
112 option 2: force an election, and let everyone else participate.
114 ******************************************************************/
115 void browser_gone(char *work_name
, struct in_addr ip
)
117 struct subnet_record
*d
= find_subnet(ip
);
118 struct work_record
*work
= find_workgroupstruct(d
, work_name
, False
);
120 /* i don't know about this workgroup, therefore i don't care */
121 if (!work
|| !d
) return;
123 /* don't do election stuff on the WINS subnet */
124 if (ip_equal(d
->bcast_ip
,wins_ip
))
127 if (strequal(work
->work_group
, myworkgroup
))
130 if (lp_local_master())
132 /* we have discovered that there is no local master
133 browser, and we are configured to initiate
134 an election under exactly such circumstances.
136 DEBUG(2,("Forcing election on %s %s\n",
137 work
->work_group
,inet_ntoa(d
->bcast_ip
)));
139 /* we can attempt to become master browser */
140 work
->needelection
= True
;
144 /* we need to force an election, because we are configured
145 not to _become_ the local master, but we still _need_ one,
146 having detected that one doesn't exist.
149 /* local interfaces: force an election */
150 send_election(d
, work
->work_group
, 0, 0, myname
);
152 /* only removes workgroup completely on a local interface
153 persistent lmhosts entries on a local interface _will_ be removed).
155 remove_workgroup(d
, work
,True
);
156 add_workgroup_to_subnet(d
, work
->work_group
);
162 /****************************************************************************
163 send an election packet
164 **************************************************************************/
165 void send_election(struct subnet_record
*d
, char *group
,uint32 criterion
,
166 int timeup
,char *name
)
173 DEBUG(2,("Sending election to %s for workgroup %s\n",
174 inet_ntoa(d
->bcast_ip
),group
));
176 bzero(outbuf
,sizeof(outbuf
));
178 CVAL(p
,0) = ANN_Election
; /* election */
181 CVAL(p
,0) = (criterion
== 0 && timeup
== 0) ? 0 : ELECTION_VERSION
;
182 SIVAL(p
,1,criterion
);
183 SIVAL(p
,5,timeup
*1000); /* ms - despite the spec */
187 p
= skip_string(p
,1);
189 send_mailslot_reply(False
,BROWSE_MAILSLOT
,ClientDGRAM
,
190 outbuf
,PTR_DIFF(p
,outbuf
),
191 name
,group
,0,0x1e,d
->bcast_ip
,*iface_ip(d
->bcast_ip
));
195 /****************************************************************************
196 un-register a SELF name that got rejected.
198 if this name happens to be rejected when samba is in the process
199 of becoming a master browser (registering __MSBROWSE__, WORKGROUP(1d)
200 or WORKGROUP(1b)) then we must stop being a master browser. sad.
202 **************************************************************************/
203 void name_unregister_work(struct subnet_record
*d
, char *name
, int name_type
)
205 struct work_record
*work
;
206 int remove_type_local
= 0;
207 int remove_type_domain
= 0;
208 int remove_type_logon
= 0;
210 remove_netbios_name(d
,name
,name_type
,SELF
,ipzero
);
212 if (!(work
= find_workgroupstruct(d
, name
, False
))) return;
214 /* work out what to unbecome, from the name type being removed */
216 if (ms_browser_name(name
, name_type
))
218 remove_type_local
|= SV_TYPE_MASTER_BROWSER
;
220 if (AM_MASTER(work
) && strequal(name
, myworkgroup
) && name_type
== 0x1d)
222 remove_type_local
|= SV_TYPE_MASTER_BROWSER
;
224 if (AM_DOMMST(work
) && strequal(name
, myworkgroup
) && name_type
== 0x1b)
226 remove_type_domain
|= SV_TYPE_DOMAIN_MASTER
;
228 if (AM_DOMMEM(work
) && strequal(name
, myworkgroup
) && name_type
== 0x1c)
230 remove_type_logon
|= SV_TYPE_DOMAIN_MEMBER
;
233 if (remove_type_local
) unbecome_local_master (d
, work
, remove_type_local
);
234 if (remove_type_domain
) unbecome_domain_master(d
, work
, remove_type_domain
);
235 if (remove_type_logon
) unbecome_logon_server (d
, work
, remove_type_logon
);
239 /****************************************************************************
242 if the name being added is a SELF name, we must additionally check
243 whether to proceed to the next stage in samba becoming a master browser.
245 **************************************************************************/
246 void name_register_work(struct subnet_record
*d
, char *name
, int name_type
,
247 int nb_flags
, time_t ttl
, struct in_addr ip
, BOOL bcast
)
249 enum name_source source
= (ismyip(ip
) || ip_equal(ip
, ipzero
)) ?
254 struct work_record
*work
= find_workgroupstruct(d
,
257 add_netbios_entry(d
,name
,name_type
,nb_flags
,ttl
,source
,ip
,True
,!bcast
);
261 int add_type_local
= False
;
262 int add_type_domain
= False
;
263 int add_type_logon
= False
;
265 DEBUG(4,("checking next stage: name_register_work %s\n", name
));
267 /* work out what to become, from the name type being added */
269 if (ms_browser_name(name
, name_type
))
271 add_type_local
= True
;
273 if (strequal(name
, myworkgroup
) && name_type
== 0x1d)
275 add_type_local
= True
;
277 if (strequal(name
, myworkgroup
) && name_type
== 0x1b)
279 add_type_domain
= True
;
281 if (strequal(name
, myworkgroup
) && name_type
== 0x1c)
283 add_type_logon
= True
;
286 if (add_type_local
) become_local_master (d
, work
);
287 if (add_type_domain
) become_domain_master(d
, work
);
288 if (add_type_logon
) become_logon_server (d
, work
);
294 /*******************************************************************
295 become the local master browser.
297 this is done in stages. note that this could take a while,
298 particularly on a broadcast subnet, as we have to wait for
299 the implicit registration of each name to be accepted.
301 as each name is successfully registered, become_local_master() is
302 called again, in order to initiate the next stage. see
303 dead_netbios_entry() - deals with implicit name registration
304 and response_name_reg() - deals with explicit registration
307 stage 1: was MST_POTENTIAL - go to MST_POTENTIAL and register ^1^2__MSBROWSE__^2^1.
308 stage 2: was MST_BACK - go to MST_MSB and register WORKGROUP(0x1d)
309 stage 3: was MST_MSB - go to MST_BROWSER and stay there
311 XXXX note: this code still does not cope with the distinction
312 between different types of nodes, particularly between M and P
313 nodes. that comes later.
315 ******************************************************************/
316 void become_local_master(struct subnet_record
*d
, struct work_record
*work
)
318 /* domain type must be limited to domain enum + server type. it must
319 not have SV_TYPE_SERVER or anything else with SERVER in it, else
320 clients get confused and start thinking this entry is a server
323 uint32 domain_type
= SV_TYPE_DOMAIN_ENUM
|SV_TYPE_NT
;
328 DEBUG(2,("Becoming master for %s %s (currently at stage %d)\n",
329 work
->work_group
,inet_ntoa(d
->bcast_ip
),work
->mst_state
));
331 switch (work
->mst_state
)
333 case MST_POTENTIAL
: /* while we were nothing but a server... */
335 DEBUG(3,("go to first stage: register ^1^2__MSBROWSE__^2^1\n"));
336 work
->mst_state
= MST_BACK
; /* an election win was successful */
338 work
->ElectionCriterion
|= 0x5;
340 /* update our server status */
341 work
->ServerType
&= ~SV_TYPE_POTENTIAL_BROWSER
;
342 add_server_entry(d
,work
,myname
,work
->ServerType
,0,lp_serverstring(),True
);
344 /* add special browser name */
345 add_my_name_entry(d
,MSBROWSE
,0x01,nb_type
|NB_ACTIVE
|NB_GROUP
);
347 /* DON'T do anything else after calling add_my_name_entry() */
351 case MST_BACK
: /* while nothing had happened except we won an election... */
353 DEBUG(3,("go to second stage: register as master browser\n"));
354 work
->mst_state
= MST_MSB
; /* registering MSBROWSE was successful */
356 /* add server entry on successful registration of MSBROWSE */
357 add_server_entry(d
,work
,work
->work_group
,domain_type
,0,myname
,True
);
359 /* add master name */
360 add_my_name_entry(d
,work
->work_group
,0x1d,nb_type
|NB_ACTIVE
);
362 /* DON'T do anything else after calling add_my_name_entry() */
366 case MST_MSB
: /* while we were still only registered MSBROWSE state... */
368 DEBUG(3,("2nd stage complete: registered as master browser\n"));
369 work
->mst_state
= MST_BROWSER
; /* registering WORKGROUP(1d) succeeded */
371 /* update our server status */
372 work
->ServerType
|= SV_TYPE_MASTER_BROWSER
;
374 DEBUG(3,("become_local_master: updating our server %s to type %x\n",
375 myname
, work
->ServerType
));
377 add_server_entry(d
,work
,myname
,work
->ServerType
,0,lp_serverstring(),True
);
379 if (work
->serverlist
== NULL
) /* no servers! */
381 /* ask all servers on our local net to announce to us */
382 /* XXXX OOPS! add_server_entry always adds one entry - ours. */
383 announce_request(work
, d
->bcast_ip
);
386 /* Reset the announce master timer so that we do an announce as soon as possible
387 now we are a master. */
388 reset_announce_timer();
394 /* don't have to do anything: just report success */
395 DEBUG(3,("3rd stage: become master browser!\n"));
402 /*******************************************************************
403 become the domain master browser.
405 this is done in stages. note that this could take a while,
406 particularly on a broadcast subnet, as we have to wait for
407 the implicit registration of each name to be accepted.
409 as each name is successfully registered, become_domain_master() is
410 called again, in order to initiate the next stage. see
411 dead_netbios_entry() - deals with implicit name registration
412 and response_name_reg() - deals with explicit registration
415 stage 1: was DOMAIN_NONE - go to DOMAIN_MST
417 XXXX note: this code still does not cope with the distinction
418 between different types of nodes, particularly between M and P
419 nodes. that comes later.
421 ******************************************************************/
422 void become_domain_master(struct subnet_record
*d
, struct work_record
*work
)
424 /* domain type must be limited to domain enum + server type. it must
425 not have SV_TYPE_SERVER or anything else with SERVER in it, else
426 clients get confused and start thinking this entry is a server
430 if (!work
|| !d
) return;
432 DEBUG(2,("Becoming domain master for %s %s (currently at stage %d)\n",
433 work
->work_group
,inet_ntoa(d
->bcast_ip
),work
->dom_state
));
435 switch (work
->dom_state
)
437 case DOMAIN_NONE
: /* while we were nothing but a server... */
439 if (lp_domain_master())
441 DEBUG(3,("go to first stage: register <1b> name\n"));
442 work
->dom_state
= DOMAIN_WAIT
;
444 /* XXXX the 0x1b is domain master browser name */
445 add_my_name_entry(d
, work
->work_group
,0x1b,nb_type
|NB_ACTIVE
|NB_GROUP
);
447 /* DON'T do anything else after calling add_my_name_entry() */
452 DEBUG(4,("samba not configured as a domain master.\n"));
460 if (lp_domain_master())
462 work
->dom_state
= DOMAIN_MST
; /* ... become domain master */
463 DEBUG(3,("domain first stage: register as domain member\n"));
465 /* update our server status */
466 work
->ServerType
|= SV_TYPE_NT
|SV_TYPE_DOMAIN_MASTER
;
467 add_server_entry(d
,work
,myname
,work
->ServerType
,0,
468 lp_serverstring(),True
);
470 DEBUG(4,("samba is now a domain master\n"));
476 DEBUG(4,("samba not configured as a domain master.\n"));
484 /* don't have to do anything: just report success */
485 DEBUG(3,("domain second stage: there isn't one!\n"));
492 /*******************************************************************
493 become a logon server.
494 ******************************************************************/
495 void become_logon_server(struct subnet_record
*d
, struct work_record
*work
)
497 if (!work
|| !d
) return;
499 DEBUG(2,("Becoming logon server for %s %s (currently at stage %d)\n",
500 work
->work_group
,inet_ntoa(d
->bcast_ip
),work
->log_state
));
502 switch (work
->log_state
)
504 case LOGON_NONE
: /* while we were nothing but a server... */
506 if (lp_domain_logons())
508 DEBUG(3,("go to first stage: register <1c> name\n"));
509 work
->log_state
= LOGON_WAIT
;
511 /* XXXX the 0x1c is apparently something to do with domain logons */
512 add_my_name_entry(d
, myworkgroup
,0x1c,nb_type
|NB_ACTIVE
|NB_GROUP
);
514 /* DON'T do anything else after calling add_my_name_entry() */
518 DEBUG(4,("samba not configured as a logon master.\n"));
526 if (lp_domain_logons())
528 work
->log_state
= LOGON_SRV
; /* ... become logon server */
529 DEBUG(3,("logon second stage: register \n"));
531 /* update our server status */
532 work
->ServerType
|= SV_TYPE_NT
|SV_TYPE_DOMAIN_MEMBER
;
533 add_server_entry(d
,work
,myname
,work
->ServerType
,0,
534 lp_serverstring(),True
);
536 /* DON'T do anything else after calling add_my_name_entry() */
541 DEBUG(4,("samba not configured as a logon server.\n"));
549 DEBUG(3,("logon third stage: there isn't one!\n"));
557 /*******************************************************************
558 unbecome the local master browser. initates removal of necessary netbios
559 names, and tells the world that we are no longer a master browser.
561 XXXX this _should_ be used to demote to a backup master browser, without
562 going straight to non-master browser. another time.
564 ******************************************************************/
565 void unbecome_local_master(struct subnet_record
*d
, struct work_record
*work
,
568 int new_server_type
= work
->ServerType
;
570 /* can only remove master types with this function */
571 remove_type
&= SV_TYPE_MASTER_BROWSER
;
573 new_server_type
&= ~remove_type
;
577 DEBUG(2,("Becoming local non-master for %s\n",work
->work_group
));
579 /* no longer a master browser of any sort */
581 work
->ServerType
|= SV_TYPE_POTENTIAL_BROWSER
;
582 work
->ElectionCriterion
&= ~0x4;
583 work
->mst_state
= MST_POTENTIAL
;
585 /* announce ourselves as no longer active as a master browser. */
586 announce_server(d
, work
, work
->work_group
, myname
, 0, 0);
587 remove_name_entry(d
,MSBROWSE
,0x01);
588 remove_name_entry(d
,work
->work_group
,0x1d);
593 /*******************************************************************
594 unbecome the domain master browser. initates removal of necessary netbios
595 names, and tells the world that we are no longer a domain browser.
596 ******************************************************************/
597 void unbecome_domain_master(struct subnet_record
*d
, struct work_record
*work
,
600 int new_server_type
= work
->ServerType
;
602 DEBUG(2,("Becoming domain non-master for %s\n",work
->work_group
));
604 /* can only remove master or domain types with this function */
605 remove_type
&= SV_TYPE_DOMAIN_MASTER
;
607 new_server_type
&= ~remove_type
;
611 /* no longer a domain master browser of any sort */
613 work
->dom_state
= DOMAIN_NONE
;
615 /* announce ourselves as no longer active as a master browser. */
616 announce_server(d
, work
, work
->work_group
, myname
, 0, 0);
617 remove_name_entry(d
,work
->work_group
,0x1b);
622 /*******************************************************************
623 unbecome the logon server. initates removal of necessary netbios
624 names, and tells the world that we are no longer a logon server.
625 ******************************************************************/
626 void unbecome_logon_server(struct subnet_record
*d
, struct work_record
*work
,
629 int new_server_type
= work
->ServerType
;
631 DEBUG(2,("Becoming logon non-server for %s\n",work
->work_group
));
633 /* can only remove master or domain types with this function */
634 remove_type
&= SV_TYPE_DOMAIN_MEMBER
;
636 new_server_type
&= ~remove_type
;
640 /* no longer a master browser of any sort */
642 work
->log_state
= LOGON_NONE
;
644 /* announce ourselves as no longer active as a master browser. */
645 announce_server(d
, work
, work
->work_group
, myname
, 0, 0);
646 remove_name_entry(d
,work
->work_group
,0x1c);
651 /*******************************************************************
653 ******************************************************************/
654 void run_elections(time_t t
)
656 static time_t lastime
= 0;
658 struct subnet_record
*d
;
660 /* send election packets once a second */
661 if (lastime
&& t
-lastime
<= 0) return;
665 for (d
= FIRST_SUBNET
; d
; d
= NEXT_SUBNET_EXCLUDING_WINS(d
))
667 struct work_record
*work
;
669 for (work
= d
->workgrouplist
; work
; work
= work
->next
)
671 if (work
->RunningElection
)
673 send_election(d
,work
->work_group
, work
->ElectionCriterion
,
674 t
-StartupTime
,myname
);
676 if (work
->ElectionCount
++ >= 4)
678 /* I won! now what :-) */
679 DEBUG(2,(">>> Won election on %s %s <<<\n",
680 work
->work_group
,inet_ntoa(d
->bcast_ip
)));
682 work
->RunningElection
= False
;
683 work
->mst_state
= MST_POTENTIAL
;
685 become_local_master(d
, work
);
693 /*******************************************************************
694 work out if I win an election
695 ******************************************************************/
696 static BOOL
win_election(struct work_record
*work
,int version
,uint32 criterion
,
697 int timeup
,char *name
)
699 int mytimeup
= time(NULL
) - StartupTime
;
700 uint32 mycriterion
= work
->ElectionCriterion
;
702 /* If local master is set to false then never win
703 in election broadcasts. */
704 if(lp_local_master() == False
)
706 DEBUG(3,("win_election: Losing election as local master == False\n"));
710 DEBUG(4,("election comparison: %x:%x %x:%x %d:%d %s:%s\n",
711 version
,ELECTION_VERSION
,
712 criterion
,mycriterion
,
716 if (version
> ELECTION_VERSION
) return(False
);
717 if (version
< ELECTION_VERSION
) return(True
);
719 if (criterion
> mycriterion
) return(False
);
720 if (criterion
< mycriterion
) return(True
);
722 if (timeup
> mytimeup
) return(False
);
723 if (timeup
< mytimeup
) return(True
);
725 if (strcasecmp(myname
,name
) > 0) return(False
);
731 /*******************************************************************
732 process a election packet
734 An election dynamically decides who will be the master.
735 ******************************************************************/
736 void process_election(struct packet_struct
*p
,char *buf
)
738 struct dgram_packet
*dgram
= &p
->packet
.dgram
;
739 struct in_addr ip
= dgram
->header
.source_ip
;
740 struct subnet_record
*d
= find_subnet(ip
);
741 int version
= CVAL(buf
,0);
742 uint32 criterion
= IVAL(buf
,1);
743 int timeup
= IVAL(buf
,5)/1000;
745 struct work_record
*work
;
749 if (ip_equal(d
->bcast_ip
,wins_ip
)) {
750 DEBUG(3,("Unexpected election request from %s %s on WINS net\n",
751 name
, inet_ntoa(p
->ip
)));
757 DEBUG(3,("Election request from %s %s vers=%d criterion=%08x timeup=%d\n",
758 name
,inet_ntoa(p
->ip
),version
,criterion
,timeup
));
760 if (same_context(dgram
)) return;
762 for (work
= d
->workgrouplist
; work
; work
= work
->next
)
764 if (!strequal(work
->work_group
, myworkgroup
))
767 if (win_election(work
, version
,criterion
,timeup
,name
)) {
768 if (!work
->RunningElection
) {
769 work
->needelection
= True
;
770 work
->ElectionCount
=0;
771 work
->mst_state
= MST_POTENTIAL
;
774 work
->needelection
= False
;
776 if (work
->RunningElection
|| AM_MASTER(work
)) {
777 work
->RunningElection
= False
;
778 DEBUG(3,(">>> Lost election on %s %s <<<\n",
779 work
->work_group
,inet_ntoa(d
->bcast_ip
)));
781 unbecome_local_master(d
, work
, SV_TYPE_MASTER_BROWSER
);
788 /****************************************************************************
789 checks whether a browser election is to be run on any workgroup
791 this function really ought to return the time between election
792 packets (which depends on whether samba intends to be a domain
793 master or a master browser) in milliseconds.
795 ***************************************************************************/
796 BOOL
check_elections(void)
798 struct subnet_record
*d
;
799 BOOL run_any_election
= False
;
801 for (d
= FIRST_SUBNET
; d
; d
= NEXT_SUBNET_EXCLUDING_WINS(d
))
803 struct work_record
*work
;
804 for (work
= d
->workgrouplist
; work
; work
= work
->next
)
806 run_any_election
|= work
->RunningElection
;
808 if (work
->needelection
&& !work
->RunningElection
)
810 DEBUG(3,(">>> Starting election on %s %s <<<\n",
811 work
->work_group
,inet_ntoa(d
->bcast_ip
)));
812 work
->ElectionCount
= 0;
813 work
->RunningElection
= True
;
814 work
->needelection
= False
;
818 return run_any_election
;