first pass at updating head branch to be to be the same as the SAMBA_2_0 branch
[kai/samba-autobuild/.git] / source3 / nmbd / nmbd_subnetdb.c
1 /* 
2    Unix SMB/Netbios implementation.
3    Version 1.9.
4    NBT netbios routines and daemon - version 2
5    Copyright (C) Andrew Tridgell 1994-1998
6    Copyright (C) Luke Kenneth Casson Leighton 1994-1998
7    Copyright (C) Jeremy Allison 1994-1998
8    
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 2 of the License, or
12    (at your option) any later version.
13    
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18    
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software
21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22    
23    Revision History:
24
25 */
26
27 #include "includes.h"
28 #include "smb.h"
29
30 extern int ClientNMB;
31 extern int ClientDGRAM;
32 extern int global_nmb_port;
33
34 extern int DEBUGLEVEL;
35
36 extern fstring myworkgroup;
37 extern char **my_netbios_names;
38 extern struct in_addr ipzero;
39
40 /* This is the broadcast subnets database. */
41 struct subnet_record *subnetlist = NULL;
42
43 /* Extra subnets - keep these separate so enumeration code doesn't
44    run onto it by mistake. */
45
46 struct subnet_record *unicast_subnet = NULL;
47 struct subnet_record *remote_broadcast_subnet = NULL;
48 struct subnet_record *wins_server_subnet = NULL;
49
50 extern uint16 samba_nb_type; /* Samba's NetBIOS name type. */
51
52 /****************************************************************************
53   Add a subnet into the list.
54   **************************************************************************/
55
56 static void add_subnet(struct subnet_record *subrec)
57 {
58         DLIST_ADD(subnetlist, subrec);
59 }
60
61 /* ************************************************************************** **
62  * Comparison routine for ordering the splay-tree based namelists assoicated
63  * with each subnet record.
64  *
65  *  Input:  Item  - Pointer to the comparison key.
66  *          Node  - Pointer to a node the splay tree.
67  *
68  *  Output: The return value will be <0 , ==0, or >0 depending upon the
69  *          ordinal relationship of the two keys.
70  *
71  * ************************************************************************** **
72  */
73 static int namelist_entry_compare( ubi_trItemPtr Item, ubi_trNodePtr Node )
74   {
75   struct name_record *NR = (struct name_record *)Node;
76
77   if( DEBUGLVL( 10 ) )
78     {
79     struct nmb_name *Iname = (struct nmb_name *)Item;
80
81     Debug1( "nmbd_subnetdb:namelist_entry_compare()\n" );
82     Debug1( "%d == memcmp( \"%s\", \"%s\", %d )\n",
83             memcmp( Item, &(NR->name), sizeof(struct nmb_name) ),
84             nmb_namestr(Iname), nmb_namestr(&NR->name), (int)sizeof(struct nmb_name) );
85     }
86
87   return( memcmp( Item, &(NR->name), sizeof(struct nmb_name) ) ); 
88   } /* namelist_entry_compare */
89
90
91 /****************************************************************************
92 stop listening on a subnet
93 we don't free the record as we don't have proper reference counting for it
94 yet and it may be in use by a response record
95   ****************************************************************************/
96 void close_subnet(struct subnet_record *subrec)
97 {
98         DLIST_REMOVE(subnetlist, subrec);
99
100         if (subrec->dgram_sock != -1) {
101                 close(subrec->dgram_sock);
102                 subrec->dgram_sock = -1;
103         }
104         if (subrec->nmb_sock != -1) {
105                 close(subrec->nmb_sock);
106                 subrec->nmb_sock = -1;
107         }
108 }
109
110
111
112 /****************************************************************************
113   Create a subnet entry.
114   ****************************************************************************/
115
116 static struct subnet_record *make_subnet(char *name, enum subnet_type type,
117                                          struct in_addr myip, struct in_addr bcast_ip, 
118                                          struct in_addr mask_ip)
119 {
120   struct subnet_record *subrec = NULL;
121   int nmb_sock, dgram_sock;
122
123   /* Check if we are creating a non broadcast subnet - if so don't create
124      sockets.
125    */
126
127   if(type != NORMAL_SUBNET)
128   {
129     nmb_sock = -1;
130     dgram_sock = -1;
131   }
132   else
133   {
134     /*
135      * Attempt to open the sockets on port 137/138 for this interface
136      * and bind them.
137      * Fail the subnet creation if this fails.
138      */
139
140     if((nmb_sock = open_socket_in(SOCK_DGRAM, global_nmb_port,0, myip.s_addr,True)) == -1)
141     {
142       if( DEBUGLVL( 0 ) )
143       {
144         Debug1( "nmbd_subnetdb:make_subnet()\n" );
145         Debug1( "  Failed to open nmb socket on interface %s ", inet_ntoa(myip) );
146         Debug1( "for port %d.  ", global_nmb_port );
147         Debug1( "Error was %s\n", strerror(errno) );
148       }
149       return NULL;
150     }
151
152     if((dgram_sock = open_socket_in(SOCK_DGRAM,DGRAM_PORT,3, myip.s_addr,True)) == -1)
153     {
154       if( DEBUGLVL( 0 ) )
155       {
156         Debug1( "nmbd_subnetdb:make_subnet()\n" );
157         Debug1( "  Failed to open dgram socket on interface %s ", inet_ntoa(myip) );
158         Debug1( "for port %d.  ", DGRAM_PORT );
159         Debug1( "Error was %s\n", strerror(errno) );
160       }
161       return NULL;
162     }
163
164     /* Make sure we can broadcast from these sockets. */
165     set_socket_options(nmb_sock,"SO_BROADCAST");
166     set_socket_options(dgram_sock,"SO_BROADCAST");
167
168   }
169
170   subrec = (struct subnet_record *)malloc(sizeof(*subrec));
171   
172   if (!subrec) 
173   {
174     DEBUG(0,("make_subnet: malloc fail !\n"));
175     close(nmb_sock);
176     close(dgram_sock);
177     return(NULL);
178   }
179   
180   memset( (char *)subrec, '\0', sizeof(*subrec) );
181   (void)ubi_trInitTree( subrec->namelist,
182                         namelist_entry_compare,
183                         ubi_trOVERWRITE );
184
185   if((subrec->subnet_name = strdup(name)) == NULL)
186   {
187     DEBUG(0,("make_subnet: malloc fail for subnet name !\n"));
188     close(nmb_sock);
189     close(dgram_sock);
190     ZERO_STRUCTP(subrec);
191     free((char *)subrec);
192     return(NULL);
193   }
194
195   DEBUG(2, ("making subnet name:%s ", name ));
196   DEBUG(2, ("Broadcast address:%s ", inet_ntoa(bcast_ip)));
197   DEBUG(2, ("Subnet mask:%s\n", inet_ntoa(mask_ip)));
198  
199   subrec->namelist_changed = False;
200   subrec->work_changed = False;
201  
202   subrec->bcast_ip = bcast_ip;
203   subrec->mask_ip  = mask_ip;
204   subrec->myip = myip;
205   subrec->type = type;
206   subrec->nmb_sock = nmb_sock;
207   subrec->dgram_sock = dgram_sock;
208   
209   return subrec;
210 }
211
212
213 /****************************************************************************
214   Create a normal subnet
215 **************************************************************************/
216 struct subnet_record *make_normal_subnet(struct interface *iface)
217 {
218         struct subnet_record *subrec;
219
220         subrec = make_subnet(inet_ntoa(iface->ip), NORMAL_SUBNET,
221                              iface->ip, iface->bcast, iface->nmask);
222         if (subrec) {
223                 add_subnet(subrec);
224         }
225         return subrec;
226 }
227
228
229 /****************************************************************************
230   Create subnet entries.
231 **************************************************************************/
232
233 BOOL create_subnets(void)
234 {    
235   int num_interfaces = iface_count();
236   int i;
237   struct in_addr unicast_ip;
238
239   if(num_interfaces == 0)
240   {
241     DEBUG(0,("create_subnets: No local interfaces !\n"));
242     return False;
243   }
244
245   /* 
246    * Create subnets from all the local interfaces and thread them onto
247    * the linked list. 
248    */
249
250   for (i = 0 ; i < num_interfaces; i++)
251   {
252     struct interface *iface = get_interface(i);
253
254     if (!make_normal_subnet(iface)) return False;
255   }
256
257   /* 
258    * If we have been configured to use a WINS server, then try and
259    * get the ip address of it here. If we are the WINS server then
260    * set the unicast subnet address to be the first of our own real
261    * addresses.
262    */
263
264   if(*lp_wins_server())
265   {
266     struct in_addr real_wins_ip;
267     real_wins_ip = *interpret_addr2(lp_wins_server());
268
269     if (!zero_ip(real_wins_ip))
270     {
271       unicast_ip = real_wins_ip;
272     }
273     else
274     {
275       /* The smb.conf's wins server parameter MUST be a host_name
276          or an ip_address. */
277       DEBUG(0,("invalid smb.conf parameter 'wins server'\n"));
278       return False;
279     }
280   } 
281   else if(lp_we_are_a_wins_server())
282   {
283     /* Pick the first interface ip address as the WINS server ip. */
284     unicast_ip = *iface_n_ip(0);
285   }
286   else
287   {
288     /* We should not be using a WINS server at all. Set the
289       ip address of the subnet to be zero. */
290     unicast_ip = ipzero;
291   }
292
293   /*
294    * Create the unicast and remote broadcast subnets.
295    * Don't put these onto the linked list.
296    * The ip address of the unicast subnet is set to be
297    * the WINS server address, if it exists, or ipzero if not.
298    */
299
300   unicast_subnet = make_subnet( "UNICAST_SUBNET", UNICAST_SUBNET, 
301                                  unicast_ip, unicast_ip, unicast_ip);
302
303   remote_broadcast_subnet = make_subnet( "REMOTE_BROADCAST_SUBNET",
304                                          REMOTE_BROADCAST_SUBNET,
305                                          ipzero, ipzero, ipzero);
306
307   if((unicast_subnet == NULL) || (remote_broadcast_subnet == NULL))
308     return False;
309
310   /* 
311    * If we are WINS server, create the WINS_SERVER_SUBNET - don't put on
312    * the linked list.
313    */
314
315   if (lp_we_are_a_wins_server())
316   {
317     if((wins_server_subnet = make_subnet("WINS_SERVER_SUBNET",
318                                        WINS_SERVER_SUBNET, 
319                                        ipzero, ipzero, ipzero)) == NULL)
320       return False;
321   }
322
323   return True;
324 }
325
326 /*******************************************************************
327 Function to tell us if we can use the unicast subnet.
328 ******************************************************************/
329
330 BOOL we_are_a_wins_client(void)
331 {
332   static int cache_we_are_a_wins_client = -1;
333
334   if(cache_we_are_a_wins_client == -1)
335     cache_we_are_a_wins_client = (ip_equal(ipzero, unicast_subnet->myip) ? 
336                                   False : True);
337
338   return cache_we_are_a_wins_client;
339 }
340
341 /*******************************************************************
342 Access function used by NEXT_SUBNET_INCLUDING_UNICAST
343 ******************************************************************/
344
345 struct subnet_record *get_next_subnet_maybe_unicast(struct subnet_record *subrec)
346 {
347   if(subrec == unicast_subnet)
348     return NULL;
349   else if((subrec->next == NULL) && we_are_a_wins_client())
350     return unicast_subnet;
351   else
352     return subrec->next;
353 }
354
355 /*******************************************************************
356  Access function used by retransmit_or_expire_response_records() in
357  nmbd_packets.c. Patch from Andrey Alekseyev <fetch@muffin.arcadia.spb.ru>
358  Needed when we need to enumerate all the broadcast, unicast and
359  WINS subnets.
360 ******************************************************************/
361
362 struct subnet_record *get_next_subnet_maybe_unicast_or_wins_server(struct subnet_record *subrec)
363 {
364   if(subrec == unicast_subnet)
365   {
366     if(wins_server_subnet)
367       return wins_server_subnet;
368     else
369       return NULL;
370   }
371
372   if(wins_server_subnet && subrec == wins_server_subnet)
373     return NULL;
374
375   if((subrec->next == NULL) && we_are_a_wins_client())
376     return unicast_subnet;
377   else
378     return subrec->next;
379 }