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