modified become_master() to a state-based system. becoming a master
[samba.git] / source / include / nameserv.h
1 /* 
2    Unix SMB/Netbios implementation.
3    Version 1.9.
4    NBT netbios header - version 2
5    Copyright (C) Andrew Tridgell 1994-1995
6    
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.
11    
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.
16    
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.
20    
21 */
22
23 /* NTAS uses 2, NT uses 1, WfWg uses 0 */
24 #define MAINTAIN_LIST    2
25 #define ELECTION_VERSION 1
26
27 #define MAX_DGRAM_SIZE (576) /* tcp/ip datagram limit is 576 bytes */
28 #define MIN_DGRAM_SIZE 12
29
30 #define NMB_QUERY  0x20
31 #define NMB_STATUS 0x21
32
33 #define NMB_REG         0x05 /* see rfc1002.txt 4.2.2,3,5,6,7,8 */
34 #define NMB_REG_REFRESH 0x09 /* see rfc1002.txt 4.2.4 */
35 #define NMB_REL         0x06 /* see rfc1002.txt 4.2.9,10,11 */
36 #define NMB_WAIT_ACK    0x07 /* see rfc1002.txt 4.2.17 */
37 /* XXXX what about all the other types?? 0x1, 0x2, 0x3, 0x4, 0x8? */
38
39 /* NetBIOS flags */
40 #define NB_GROUP  0x80
41 #define NB_PERM   0x02
42 #define NB_ACTIVE 0x04
43 #define NB_CONFL  0x08
44 #define NB_DEREG  0x10
45 #define NB_BFLAG  0x00
46 #define NB_PFLAG  0x20
47 #define NB_MFLAG  0x40
48 #define NB__FLAG  0x60
49 #define NB_FLGMSK 0x60
50
51 #define REFRESH_TIME (15*60)
52 #define NAME_POLL_REFRESH_TIME (5*60)
53 #define NAME_POLL_INTERVAL 15
54
55 /* NetBIOS flag identifier */
56 #define NAME_PERMANENT(p) ((p) & NB_PERM)
57 #define NAME_ACTIVE(p)    ((p) & NB_ACTIVE)
58 #define NAME_CONFLICT(p)  ((p) & NB_CONFL)
59 #define NAME_DEREG(p)     ((p) & NB_DEREG)
60 #define NAME_GROUP(p)     ((p) & NB_GROUP)
61
62 #define NAME_BFLAG(p)     (((p) & NB_FLGMSK) == NB_BFLAG)
63 #define NAME_PFLAG(p)     (((p) & NB_FLGMSK) == NB_PFLAG)
64 #define NAME_MFLAG(p)     (((p) & NB_FLGMSK) == NB_MFLAG)
65 #define NAME__FLAG(p)     (((p) & NB_FLGMSK) == NB__FLAG)
66
67 /* server type identifiers */
68 #define AM_MASTER(work) (work->ServerType & SV_TYPE_MASTER_BROWSER)
69 #define AM_BACKUP(work) (work->ServerType & SV_TYPE_BACKUP_BROWSER)
70 #define AM_DOMCTL(work) (work->ServerType & SV_TYPE_DOMAIN_CTRL)
71
72 /* microsoft browser NetBIOS name */
73 #define MSBROWSE "\001\002__MSBROWSE__\002"
74
75 /* mail slots */
76 #define BROWSE_MAILSLOT    "\\MAILSLOT\\BROWSE"
77 #define NET_LOGON_MAILSLOT "\\MAILSLOT\\NET\\NETLOGON"
78
79 enum name_source {STATUS_QUERY, LMHOSTS, REGISTER, SELF, DNS, DNSFAIL};
80 enum node_type {B_NODE=0, P_NODE=1, M_NODE=2, NBDD_NODE=3};
81 enum packet_type {NMB_PACKET, DGRAM_PACKET};
82 enum master_state { MST_NONE, MST_WON, MST_MSB, MST_BROWSER, MST_DOMAIN };
83
84 enum state_type
85 {
86         NAME_STATUS_MASTER_CHECK,
87         NAME_STATUS_CHECK,
88         NAME_REGISTER,
89         NAME_RELEASE,
90         NAME_QUERY_CONFIRM,
91         NAME_QUERY_SYNC,
92         NAME_QUERY_MST_SRV_CHK,
93         NAME_QUERY_SRV_CHK,
94         NAME_QUERY_FIND_MST,
95         NAME_QUERY_MST_CHK
96 };
97
98 /* a netbios name structure */
99 struct nmb_name {
100   char name[17];
101   char scope[64];
102   int name_type;
103 };
104
105 /* this is the structure used for the local netbios name list */
106 struct name_record
107 {
108   struct name_record *next;
109   struct name_record *prev;
110
111   struct nmb_name name;    /* the netbios name */
112   struct in_addr ip;       /* ip address of host that owns this name */
113   int nb_flags;            /* netbios flags */
114
115   enum name_source source; /* where the name came from */
116
117   time_t death_time; /* time record must be removed (do not remove if 0) */
118   time_t refresh_time; /* time record should be refreshed */
119 };
120
121 /* browse and backup server cache for synchronising browse list */
122 struct browse_cache_record
123 {
124         struct browse_cache_record *next;
125         struct browse_cache_record *prev;
126
127         pstring name;
128         int type;
129         pstring group;
130         struct in_addr ip;
131         time_t sync_time;
132         BOOL synced;
133 };
134
135 /* this is used to hold the list of servers in my domain, and is */
136 /* contained within lists of domains */
137 struct server_record
138 {
139   struct server_record *next;
140   struct server_record *prev;
141
142   struct server_info_struct serv;
143   time_t death_time;  
144 };
145
146 /* a workgroup structure. it contains a list of servers */
147 struct work_record
148 {
149   struct work_record *next;
150   struct work_record *prev;
151
152   struct server_record *serverlist;
153
154   /* stage of development from non-master to master browser / domain master */
155   enum master_state state;
156
157   /* work group info */
158   fstring work_group;
159   int     token;        /* used when communicating with backup browsers */
160   int     ServerType;
161
162   /* announce info */
163   time_t lastannounce_time;
164   int announce_interval;
165   BOOL    needannounce;
166
167
168   /* election info */
169   BOOL    RunningElection;
170   BOOL    needelection;
171   int     ElectionCount;
172   uint32  ElectionCriterion;
173 };
174
175 /* initiated name queries recorded in this list to track any responses... */
176 struct response_record
177 {
178   struct response_record *next;
179   struct response_record *prev;
180
181   uint16 response_id;
182   enum state_type state;
183
184   int fd;
185   int quest_type;
186   struct nmb_name name;
187   int nb_flags;
188   time_t ttl;
189
190   BOOL bcast;
191   BOOL recurse;
192   struct in_addr to_ip;
193
194   int num_msgs;
195
196   time_t repeat_time;
197   time_t repeat_interval;
198   int    repeat_count;
199 };
200
201 /* a subnet structure. it contains a list of workgroups and netbios names*/
202
203 /* note that a subnet of 255.255.255.255 contains all the WINS netbios names.
204    all communication from such nodes are on a non-broadcast basis: they
205    are point-to-point (P nodes) or mixed point-to-point and broadcast
206    (M nodes). M nodes use point-to-point as a preference, and will use
207    broadcasting for certain activities, or will resort to broadcasting as a
208    last resort, if the WINS server fails (users of wfwg will notice that their
209    machine often freezes for 30 seconds at a time intermittently, if the WINS
210    server is down).
211
212    B nodes will have their own, totally separate subnet record, with their
213    own netbios name set. these do NOT interact with other subnet records'
214    netbios names, INCLUDING the WINS one (with an ip "address", so called,
215    of 255.255.255.255)
216
217    there is a separate response list for each subnet record. in the case of
218    the 255.255.255.255 subnet record (WINS), the WINS server will be able to
219    use this to poll (infrequently!) each of its entries, to ensure that the
220    names are still in use.
221    XXXX this polling is a planned feature for a really over-cautious WINS server 
222 */
223
224 struct subnet_record
225 {
226   struct subnet_record *next;
227   struct subnet_record *prev;
228
229   struct work_record *workgrouplist; /* list of workgroups */
230   struct name_record *namelist;      /* list of netbios names */
231   struct response_record *responselist; /* list of responses expected */
232
233   struct in_addr bcast_ip;
234   struct in_addr mask_ip;
235   struct in_addr myip;
236
237   BOOL my_interface;
238 };
239
240 /* a resource record */
241 struct res_rec {
242   struct nmb_name rr_name;
243   int rr_type;
244   int rr_class;
245   int ttl;
246   int rdlength;
247   char rdata[MAX_DGRAM_SIZE];
248 };
249
250 /* define a nmb packet. */
251 struct nmb_packet
252 {
253   struct {
254     int name_trn_id;
255     int opcode;
256     BOOL response;
257     struct {
258       BOOL bcast;
259       BOOL recursion_available;
260       BOOL recursion_desired;
261       BOOL trunc;
262       BOOL authoritative;
263     } nm_flags;
264     int rcode;
265     int qdcount;
266     int ancount;
267     int nscount;
268     int arcount;
269   } header;
270
271   struct {
272     struct nmb_name question_name;
273     int question_type;
274     int question_class;
275   } question;
276
277   struct res_rec *answers;
278   struct res_rec *nsrecs;
279   struct res_rec *additional;
280 };
281
282
283 /* a datagram - this normally contains SMB data in the data[] array */
284 struct dgram_packet {
285   struct {
286     int msg_type;
287     struct {
288       enum node_type node_type;
289       BOOL first;
290       BOOL more;
291     } flags;
292     int dgm_id;
293     struct in_addr source_ip;
294     int source_port;
295     int dgm_length;
296     int packet_offset;
297   } header;
298   struct nmb_name source_name;
299   struct nmb_name dest_name;
300   int datasize;
301   char data[MAX_DGRAM_SIZE];
302 };
303
304 /* define a structure used to queue packets. this will be a linked
305  list of nmb packets */
306 struct packet_struct
307 {
308   struct packet_struct *next;
309   struct packet_struct *prev;
310   struct in_addr ip;
311   int port;
312   int fd;
313   time_t timestamp;
314   enum packet_type packet_type;
315   union {
316     struct nmb_packet nmb;
317     struct dgram_packet dgram;
318   } packet;
319 };
320
321
322 /* ids for netbios packet types */
323 #define ANN_HostAnnouncement         1
324 #define ANN_AnnouncementRequest      2
325 #define ANN_Election                 8
326 #define ANN_GetBackupListReq         9
327 #define ANN_GetBackupListResp       10
328 #define ANN_BecomeBackup            11
329 #define ANN_DomainAnnouncement      12
330 #define ANN_MasterAnnouncement      13
331 #define ANN_ResetBrowserState       14
332 #define ANN_LocalMasterAnnouncement 15
333
334
335 /* broadcast packet announcement intervals, in minutes */
336
337 /* search for master browsers of workgroups samba knows about, 
338    except default */
339 #define CHECK_TIME_MST_BROWSE       5 
340
341 /* request backup browser announcements from other servers */
342 #define CHECK_TIME_ANNOUNCE_BACKUP 15
343
344 /* request host announcements from other servers: min and max of interval */
345 #define CHECK_TIME_MIN_HOST_ANNCE   3
346 #define CHECK_TIME_MAX_HOST_ANNCE  12
347
348 /* announce as master to WINS server and any Primary Domain Controllers */
349 #define CHECK_TIME_MST_ANNOUNCE    15
350