source/nmbd/nmbd_responserecordsdb.c

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 1.9.
   4    NBT netbios library routines
   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 */
  24
  25 #include "includes.h"
  26
  27 extern int ClientNMB;
  28
  29 extern int DEBUGLEVEL;
  30
  31 extern pstring scope;
  32 extern struct in_addr ipzero;
  33
  34 int num_response_packets = 0;
  35
  36 /***************************************************************************
  37   Add an expected response record into the list
  38   **************************************************************************/
  39
  40 void add_response_record(struct subnet_record *subrec,
  41                                 struct response_record *rrec)
  42 {
  43   struct response_record *rrec2;
  44
  45   num_response_packets++; /* count of total number of packets still around */
  46
  47   DEBUG(4,("add_response_record: adding response record id:%hu to subnet %s. num_records:%d\n",
  48             rrec->response_id, subrec->subnet_name, num_response_packets));
  49
  50   if (!subrec->responselist)
  51   {
  52     subrec->responselist = rrec;
  53     rrec->prev = NULL;
  54     rrec->next = NULL;
  55     return;
  56   }
  57
  58   for (rrec2 = subrec->responselist; rrec2->next; rrec2 = rrec2->next)
  59     ;
  60
  61   rrec2->next = rrec;
  62   rrec->next = NULL;
  63   rrec->prev = rrec2;
  64 }
  65
  66 /***************************************************************************
  67   Remove an expected response record from the list
  68   **************************************************************************/
  69
  70 void remove_response_record(struct subnet_record *subrec,
  71                                 struct response_record *rrec)
  72 {
  73   if (rrec->prev)
  74     rrec->prev->next = rrec->next;
  75   if (rrec->next)
  76     rrec->next->prev = rrec->prev;
  77
  78   if (subrec->responselist == rrec)
  79     subrec->responselist = rrec->next;
  80
  81   if(rrec->userdata)
  82   {
  83     if(rrec->userdata->free_fn)
  84       (*rrec->userdata->free_fn)(rrec->userdata);
  85     else
  86       free((char *)rrec->userdata);
  87   }
  88
  89   /* Ensure we can delete. */
  90   rrec->packet->locked = False;
  91   free_packet(rrec->packet);
  92
  93   free((char *)rrec);
  94
  95   num_response_packets--; /* count of total number of packets still around */
  96 }
  97
  98 /****************************************************************************
  99   Create a response record for an outgoing packet.
 100   **************************************************************************/
 101
 102 struct response_record *make_response_record( struct subnet_record *subrec,
 103                     struct packet_struct *p,
 104                     response_function resp_fn,
 105                     timeout_response_function timeout_fn,
 106                     success_function success_fn,
 107                     fail_function fail_fn,
 108                     struct userdata_struct *userdata)
 109 {
 110   struct response_record *rrec;
 111   struct nmb_packet *nmb = &p->packet.nmb;
 112
 113   if (!(rrec = (struct response_record *)malloc(sizeof(*rrec))))
 114   {
 115     DEBUG(0,("make_response_queue_record: malloc fail for response_record.\n"));
 116     return NULL;
 117   }
 118
 119   bzero((char *)rrec, sizeof(*rrec));
 120
 121   rrec->response_id = nmb->header.name_trn_id;
 122
 123   rrec->resp_fn = resp_fn;
 124   rrec->timeout_fn = timeout_fn;
 125   rrec->success_fn = success_fn;
 126   rrec->fail_fn = fail_fn;
 127
 128   rrec->packet = p;
 129
 130   if(userdata)
 131   {
 132     /* Intelligent userdata. */
 133     if(userdata->copy_fn)
 134     {
 135       if((rrec->userdata = (*userdata->copy_fn)(userdata)) == NULL)
 136       {
 137         DEBUG(0,("make_response_queue_record: copy fail for userdata.\n"));
 138         free(rrec);
 139         return NULL;
 140       }
 141     }
 142     else
 143     {
 144       /* Primitive userdata, do a memcpy. */
 145       if((rrec->userdata = (struct userdata_struct *)
 146            malloc(sizeof(struct userdata_struct)+userdata->userdata_len)) == NULL)
 147       {
 148         DEBUG(0,("make_response_queue_record: malloc fail for userdata.\n"));
 149         free(rrec);
 150         return NULL;
 151       }
 152       rrec->userdata->copy_fn = userdata->copy_fn;
 153       rrec->userdata->free_fn = userdata->free_fn;
 154       rrec->userdata->userdata_len = userdata->userdata_len;
 155       memcpy(rrec->userdata->data, userdata->data, userdata->userdata_len);
 156     }
 157   }
 158   else
 159     rrec->userdata = NULL;
 160
 161   rrec->num_msgs = 0;
 162
 163   if(!nmb->header.nm_flags.bcast)
 164     rrec->repeat_interval = 5; /* 5 seconds for unicast packets. */
 165   else
 166     rrec->repeat_interval = 1; /* XXXX should be in ms */
 167   rrec->repeat_count = 3; /* 3 retries */
 168   rrec->repeat_time = time(NULL) + rrec->repeat_interval; /* initial retry time */
 169
 170   /* Lock the packet so we won't lose it while it's on the list. */
 171   p->locked = True;
 172
 173   add_response_record(subrec, rrec);
 174
 175   return rrec;
 176 }
 177
 178 /****************************************************************************
 179   Find a response in a subnet's name query response list.
 180   **************************************************************************/
 181
 182 static struct response_record *find_response_record_on_subnet(
 183                                 struct subnet_record *subrec, uint16 id)
 184 {
 185   struct response_record *rrec = NULL;
 186
 187   for (rrec = subrec->responselist; rrec; rrec = rrec->next)
 188   {
 189     if (rrec->response_id == id)
 190     {
 191       DEBUG(4, ("find_response_record: found response record id = %hu on subnet %s\n",
 192                id, subrec->subnet_name));
 193       break;
 194     }
 195   }
 196   return rrec;
 197 }
 198
 199 /****************************************************************************
 200   Find a response in any subnet's name query response list.
 201   **************************************************************************/
 202
 203 struct response_record *find_response_record(struct subnet_record **ppsubrec,
 204                                 uint16 id)
 205 {
 206   struct response_record *rrec = NULL;
 207
 208   for ((*ppsubrec) = FIRST_SUBNET; (*ppsubrec);
 209                   (*ppsubrec) = NEXT_SUBNET_INCLUDING_UNICAST(*ppsubrec))
 210   {
 211     if((rrec = find_response_record_on_subnet(*ppsubrec, id)) != NULL)
 212       return rrec;
 213   }
 214
 215   /* There should never be response records on the remote_broadcast subnet.
 216      Sanity check to ensure this is so. */
 217   if(remote_broadcast_subnet->responselist != NULL)
 218   {
 219     DEBUG(0,("find_response_record: response record found on subnet %s. This should \
 220 never happen !\n", remote_broadcast_subnet->subnet_name));
 221   }
 222
 223   /* Now check the WINS server subnet if it exists. */
 224   if(wins_server_subnet != NULL)
 225   {
 226     *ppsubrec = wins_server_subnet;
 227     if((rrec = find_response_record_on_subnet(*ppsubrec, id))!= NULL)
 228       return rrec;
 229   }
 230
 231   DEBUG(0,("find_response_record: response packet id %hu received with no \
 232 matching record.\n", id));
 233
 234   *ppsubrec = NULL;
 235
 236   return NULL;
 237 }
 238
 239 /****************************************************************************
 240   Check if a refresh is queued for a particular name on a particular subnet.
 241   **************************************************************************/
 242
 243 BOOL is_refresh_already_queued(struct subnet_record *subrec, struct name_record *namerec)
 244 {
 245   struct response_record *rrec = NULL;
 246
 247   for (rrec = subrec->responselist; rrec; rrec = rrec->next)
 248   {
 249     struct packet_struct *p = rrec->packet;
 250     struct nmb_packet *nmb = &p->packet.nmb;
 251
 252     if((nmb->header.opcode == NMB_NAME_REFRESH_OPCODE_8) ||
 253        (nmb->header.opcode == NMB_NAME_REFRESH_OPCODE_9))
 254     {
 255       /* Yes it's a queued refresh - check if the name is correct. */
 256       if(nmb_name_equal(&nmb->question.question_name, &namerec->name))
 257         return True;
 258     }
 259   }
 260
 261   return False;
 262 }