src/main/detail.c

   1 /*
   2  * detail.c     Process the detail file
   3  *
   4  * Version:     $Id$
   5  *
   6  *   This program is free software; you can redistribute it and/or modify
   7  *   it under the terms of the GNU General Public License as published by
   8  *   the Free Software Foundation; either version 2 of the License, or
   9  *   (at your option) any later version.
  10  *
  11  *   This program is distributed in the hope that it will be useful,
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *   GNU General Public License for more details.
  15  *
  16  *   You should have received a copy of the GNU General Public License
  17  *   along with this program; if not, write to the Free Software
  18  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  *
  20  * Copyright 2007  The FreeRADIUS server project
  21  * Copyright 2007  Alan DeKok <aland@deployingradius.com>
  22  */
  23
  24 #include <freeradius-devel/ident.h>
  25 RCSID("$Id$")
  26
  27 #include <freeradius-devel/radiusd.h>
  28 #include <freeradius-devel/modules.h>
  29 #include <freeradius-devel/detail.h>
  30 #include <freeradius-devel/rad_assert.h>
  31
  32 #ifdef HAVE_SYS_STAT_H
  33 #include <sys/stat.h>
  34 #endif
  35
  36 #ifdef HAVE_GLOB_H
  37 #include <glob.h>
  38 #endif
  39
  40 #include <fcntl.h>
  41
  42 #ifdef WITH_DETAIL
  43
  44 #define USEC (1000000)
  45
  46 static FR_NAME_NUMBER state_names[] = {
  47         { "unopened", STATE_UNOPENED },
  48         { "unlocked", STATE_UNLOCKED },
  49         { "header", STATE_HEADER },
  50         { "reading", STATE_READING },
  51         { "queued", STATE_QUEUED },
  52         { "running", STATE_RUNNING },
  53         { "no-reply", STATE_NO_REPLY },
  54         { "replied", STATE_REPLIED },
  55
  56         { NULL, 0 }
  57 };
  58
  59 /*
  60  *      If we're limiting outstanding packets, then mark the response
  61  *      as being sent.
  62  */
  63 int detail_send(rad_listen_t *listener, REQUEST *request)
  64 {
  65         int rtt;
  66         struct timeval now;
  67         listen_detail_t *data = listener->data;
  68
  69         rad_assert(request->listener == listener);
  70         rad_assert(listener->send == detail_send);
  71
  72         /*
  73          *      This request timed out.  Remember that, and tell the
  74          *      caller it's OK to read more "detail" file stuff.
  75          */
  76         if (request->reply->code == 0) {
  77                 data->delay_time = data->retry_interval * USEC;
  78                 data->signal = 1;
  79                 data->state = STATE_NO_REPLY;
  80
  81                 RDEBUG("Detail - No response configured for request %d.  Will retry in %d seconds",
  82                        request->number, data->retry_interval);
  83
  84                 radius_signal_self(RADIUS_SIGNAL_SELF_DETAIL);
  85                 return 0;
  86         }
  87
  88         /*
  89          *      We call gettimeofday a lot.  But it should be OK,
  90          *      because there's nothing else to do.
  91          */
  92         gettimeofday(&now, NULL);
  93
  94         /*
  95          *      If we haven't sent a packet in the last second, reset
  96          *      the RTT.
  97          */
  98         now.tv_sec -= 1;
  99         if (timercmp(&data->last_packet, &now, <)) {
 100                 data->has_rtt = FALSE;
 101         }
 102         now.tv_sec += 1;
 103
 104         /*
 105          *      Only one detail packet may be outstanding at a time,
 106          *      so it's safe to update some entries in the detail
 107          *      structure.
 108          *
 109          *      We keep smoothed round trip time (SRTT), but not round
 110          *      trip timeout (RTO).  We use SRTT to calculate a rough
 111          *      load factor.
 112          */
 113         rtt = now.tv_sec - request->received.tv_sec;
 114         rtt *= USEC;
 115         rtt += now.tv_usec;
 116         rtt -= request->received.tv_usec;
 117
 118         /*
 119          *      If we're proxying, the RTT is our processing time,
 120          *      plus the network delay there and back, plus the time
 121          *      on the other end to process the packet.  Ideally, we
 122          *      should remove the network delays from the RTT, but we
 123          *      don't know what they are.
 124          *
 125          *      So, to be safe, we over-estimate the total cost of
 126          *      processing the packet.
 127          */
 128         if (!data->has_rtt) {
 129                 data->has_rtt = TRUE;
 130                 data->srtt = rtt;
 131                 data->rttvar = rtt / 2;
 132
 133         } else {
 134                 data->rttvar -= data->rttvar >> 2;
 135                 data->rttvar += (data->srtt - rtt);
 136                 data->srtt -= data->srtt >> 3;
 137                 data->srtt += rtt >> 3;
 138         }
 139
 140         /*
 141          *      Calculate the time we wait before sending the next
 142          *      packet.
 143          *
 144          *      rtt / (rtt + delay) = load_factor / 100
 145          */
 146         data->delay_time = (data->srtt * (100 - data->load_factor)) / (data->load_factor);
 147
 148         /*
 149          *      Cap delay at 4 packets/s.  If the end system can't
 150          *      handle this, then it's very broken.
 151          */
 152         if (data->delay_time > (USEC / 4)) data->delay_time= USEC / 4;
 153
 154         RDEBUG3("Received response for request %d.  Will read the next packet in %d seconds",
 155                 request->number, data->delay_time / USEC);
 156
 157         data->last_packet = now;
 158         data->signal = 1;
 159         data->state = STATE_REPLIED;
 160         radius_signal_self(RADIUS_SIGNAL_SELF_DETAIL);
 161
 162         return 0;
 163 }
 164
 165
 166 /*
 167  *      Open the detail file, if we can.
 168  *
 169  *      FIXME: create it, if it's not already there, so that the main
 170  *      server select() will wake us up if there's anything to read.
 171  */
 172 static int detail_open(rad_listen_t *this)
 173 {
 174         struct stat st;
 175         listen_detail_t *data = this->data;
 176         char *filename = data->filename;
 177
 178         rad_assert(data->state == STATE_UNOPENED);
 179         data->delay_time = USEC;
 180
 181         /*
 182          *      Open detail.work first, so we don't lose
 183          *      accounting packets.  It's probably better to
 184          *      duplicate them than to lose them.
 185          *
 186          *      Note that we're not writing to the file, but
 187          *      we've got to open it for writing in order to
 188          *      establish the lock, to prevent rlm_detail from
 189          *      writing to it.
 190          *
 191          *      This also means that if we're doing globbing,
 192          *      this file will be read && processed before the
 193          *      file globbing is done.
 194          */
 195         this->fd = open(data->filename_work, O_RDWR);
 196         if (this->fd < 0) {
 197                 DEBUG2("Polling for detail file %s", filename);
 198
 199                 /*
 200                  *      Try reading the detail file.  If it
 201                  *      doesn't exist, we can't do anything.
 202                  *
 203                  *      Doing the stat will tell us if the file
 204                  *      exists, even if we don't have permissions
 205                  *      to read it.
 206                  */
 207                 if (stat(filename, &st) < 0) {
 208 #ifdef HAVE_GLOB_H
 209                         unsigned int i;
 210                         int found;
 211                         time_t chtime;
 212                         glob_t files;
 213
 214                         memset(&files, 0, sizeof(files));
 215                         if (glob(filename, 0, NULL, &files) != 0) {
 216                                 return 0;
 217                         }
 218
 219                         chtime = 0;
 220                         found = -1;
 221                         for (i = 0; i < files.gl_pathc; i++) {
 222                                 if (stat(files.gl_pathv[i], &st) < 0) continue;
 223
 224                                 if ((i == 0) ||
 225                                     (st.st_ctime < chtime)) {
 226                                         chtime = st.st_ctime;
 227                                         found = i;
 228                                 }
 229                         }
 230
 231                         if (found < 0) {
 232                                 globfree(&files);
 233                                 return 0;
 234                         }
 235
 236                         filename = strdup(files.gl_pathv[found]);
 237                         globfree(&files);
 238 #else
 239                         return 0;
 240 #endif
 241                 }
 242
 243                 /*
 244                  *      Open it BEFORE we rename it, just to
 245                  *      be safe...
 246                  */
 247                 this->fd = open(filename, O_RDWR);
 248                 if (this->fd < 0) {
 249                         radlog(L_ERR, "Detail - Failed to open %s: %s",
 250                                filename, strerror(errno));
 251                         if (filename != data->filename) free(filename);
 252                         return 0;
 253                 }
 254
 255                 /*
 256                  *      Rename detail to detail.work
 257                  */
 258                 DEBUG("Detail - Renaming %s -> %s", filename, data->filename_work);
 259                 if (rename(filename, data->filename_work) < 0) {
 260                         if (filename != data->filename) free(filename);
 261                         close(this->fd);
 262                         this->fd = -1;
 263                         return 0;
 264                 }
 265                 if (filename != data->filename) free(filename);
 266         } /* else detail.work existed, and we opened it */
 267
 268         rad_assert(data->vps == NULL);
 269         rad_assert(data->fp == NULL);
 270
 271         data->state = STATE_UNLOCKED;
 272
 273         data->client_ip.af = AF_UNSPEC;
 274         data->timestamp = 0;
 275         data->offset = 0;
 276         data->packets = 0;
 277         data->tries = 0;
 278
 279         return 1;
 280 }
 281
 282
 283 /*
 284  *      FIXME: add a configuration "exit when done" so that the detail
 285  *      file reader can be used as a one-off tool to update stuff.
 286  *
 287  *      The time sequence for reading from the detail file is:
 288  *
 289  *      t_0             signalled that the server is idle, and we
 290  *                      can read from the detail file.
 291  *
 292  *      t_rtt           the packet has been processed successfully,
 293  *                      wait for t_delay to enforce load factor.
 294  *
 295  *      t_rtt + t_delay wait for signal that the server is idle.
 296  *
 297  */
 298 int detail_recv(rad_listen_t *listener,
 299                 RAD_REQUEST_FUNP *pfun, REQUEST **prequest)
 300 {
 301         char            key[256], op[8], value[1024];
 302         VALUE_PAIR      *vp, **tail;
 303         RADIUS_PACKET   *packet;
 304         char            buffer[2048];
 305         listen_detail_t *data = listener->data;
 306
 307         /*
 308          *      We may be in the main thread.  It needs to update the
 309          *      timers before we try to read from the file again.
 310          */
 311         if (data->signal) return 0;
 312
 313         switch (data->state) {
 314                 case STATE_UNOPENED:
 315         open_file:
 316                         rad_assert(listener->fd < 0);
 317
 318                         if (!detail_open(listener)) return 0;
 319
 320                         rad_assert(data->state == STATE_UNLOCKED);
 321                         rad_assert(listener->fd >= 0);
 322
 323                         /* FALL-THROUGH */
 324
 325                         /*
 326                          *      Try to lock fd.  If we can't, return.
 327                          *      If we can, continue.  This means that
 328                          *      the server doesn't block while waiting
 329                          *      for the lock to open...
 330                          */
 331                 case STATE_UNLOCKED:
 332                         /*
 333                          *      Note that we do NOT block waiting for
 334                          *      the lock.  We've re-named the file
 335                          *      above, so we've already guaranteed
 336                          *      that any *new* detail writer will not
 337                          *      be opening this file.  The only
 338                          *      purpose of the lock is to catch a race
 339                          *      condition where the execution
 340                          *      "ping-pongs" between radiusd &
 341                          *      radrelay.
 342                          */
 343                         if (rad_lockfd_nonblock(listener->fd, 0) < 0) {
 344                                 /*
 345                                  *      Close the FD.  The main loop
 346                                  *      will wake up in a second and
 347                                  *      try again.
 348                                  */
 349                                 close(listener->fd);
 350                                 listener->fd = -1;
 351                                 data->state = STATE_UNOPENED;
 352                                 return 0;
 353                         }
 354
 355                         data->fp = fdopen(listener->fd, "r");
 356                         if (!data->fp) {
 357                                 radlog(L_ERR, "FATAL: Failed to re-open detail file %s: %s",
 358                                        data->filename, strerror(errno));
 359                                 exit(1);
 360                         }
 361
 362                         /*
 363                          *      Look for the header
 364                          */
 365                         data->state = STATE_HEADER;
 366                         data->delay_time = USEC;
 367                         data->vps = NULL;
 368
 369                         /* FALL-THROUGH */
 370
 371                 case STATE_HEADER:
 372                 do_header:
 373                         if (!data->fp) {
 374                                 data->state = STATE_UNOPENED;
 375                                 goto open_file;
 376                         }
 377
 378                         {
 379                                 struct stat buf;
 380
 381                                 fstat(listener->fd, &buf);
 382                                 if (((off_t) ftell(data->fp)) == buf.st_size) {
 383                                         goto cleanup;
 384                                 }
 385                         }
 386
 387                         /*
 388                          *      End of file.  Delete it, and re-set
 389                          *      everything.
 390                          */
 391                         if (feof(data->fp)) {
 392                         cleanup:
 393                                 DEBUG("Detail - unlinking %s",
 394                                       data->filename_work);
 395                                 unlink(data->filename_work);
 396                                 if (data->fp) fclose(data->fp);
 397                                 data->fp = NULL;
 398                                 listener->fd = -1;
 399                                 data->state = STATE_UNOPENED;
 400                                 rad_assert(data->vps == NULL);
 401                                 return 0;
 402                         }
 403
 404                         /*
 405                          *      Else go read something.
 406                          */
 407                         break;
 408
 409                         /*
 410                          *      Read more value-pair's, unless we're
 411                          *      at EOF.  In that case, queue whatever
 412                          *      we have.
 413                          */
 414                 case STATE_READING:
 415                         if (data->fp && !feof(data->fp)) break;
 416                         data->state = STATE_QUEUED;
 417
 418                         /* FALL-THROUGH */
 419
 420                 case STATE_QUEUED:
 421                         goto alloc_packet;
 422
 423                         /*
 424                          *      Periodically check what's going on.
 425                          *      If the request is taking too long,
 426                          *      retry it.
 427                          */
 428                 case STATE_RUNNING:
 429                         if (time(NULL) < (data->running + data->retry_interval)) {
 430                                 return 0;
 431                         }
 432
 433                         DEBUG("No response to detail request.  Retrying");
 434                         data->state = STATE_NO_REPLY;
 435                         /* FALL-THROUGH */
 436
 437                         /*
 438                          *      If there's no reply, keep
 439                          *      retransmitting the current packet
 440                          *      forever.
 441                          */
 442                 case STATE_NO_REPLY:
 443                         data->state = STATE_QUEUED;
 444                         goto alloc_packet;
 445
 446                         /*
 447                          *      We have a reply.  Clean up the old
 448                          *      request, and go read another one.
 449                          */
 450                 case STATE_REPLIED:
 451                         pairfree(&data->vps);
 452                         data->state = STATE_HEADER;
 453                         goto do_header;
 454         }
 455
 456         tail = &data->vps;
 457         while (*tail) tail = &(*tail)->next;
 458
 459         /*
 460          *      Read a header, OR a value-pair.
 461          */
 462         while (fgets(buffer, sizeof(buffer), data->fp)) {
 463                 data->offset = ftell(data->fp); /* for statistics */
 464
 465                 /*
 466                  *      Badly formatted file: delete it.
 467                  *
 468                  *      FIXME: Maybe flag an error?
 469                  */
 470                 if (!strchr(buffer, '\n')) {
 471                         pairfree(&data->vps);
 472                         goto cleanup;
 473                 }
 474
 475                 /*
 476                  *      We're reading VP's, and got a blank line.
 477                  *      Queue the packet.
 478                  */
 479                 if ((data->state == STATE_READING) &&
 480                     (buffer[0] == '\n')) {
 481                         data->state = STATE_QUEUED;
 482                         break;
 483                 }
 484
 485                 /*
 486                  *      Look for date/time header, and read VP's if
 487                  *      found.  If not, keep reading lines until we
 488                  *      find one.
 489                  */
 490                 if (data->state == STATE_HEADER) {
 491                         int y;
 492
 493                         if (sscanf(buffer, "%*s %*s %*d %*d:%*d:%*d %d", &y)) {
 494                                 data->state = STATE_READING;
 495                         }
 496                         continue;
 497                 }
 498
 499                 /*
 500                  *      We have a full "attribute = value" line.
 501                  *      If it doesn't look reasonable, skip it.
 502                  *
 503                  *      FIXME: print an error for badly formatted attributes?
 504                  */
 505                 if (sscanf(buffer, "%255s %8s %1023s", key, op, value) != 3) {
 506                         DEBUG2("WARNING: Skipping badly formatted line %s",
 507                                buffer);
 508                         continue;
 509                 }
 510
 511                 /*
 512                  *      Should be =, :=, +=, ...
 513                  */
 514                 if (!strchr(op, '=')) continue;
 515
 516                 /*
 517                  *      Skip non-protocol attributes.
 518                  */
 519                 if (!strcasecmp(key, "Request-Authenticator")) continue;
 520
 521                 /*
 522                  *      Set the original client IP address, based on
 523                  *      what's in the detail file.
 524                  *
 525                  *      Hmm... we don't set the server IP address.
 526                  *      or port.  Oh well.
 527                  */
 528                 if (!strcasecmp(key, "Client-IP-Address")) {
 529                         data->client_ip.af = AF_INET;
 530                         ip_hton(value, AF_INET, &data->client_ip);
 531                         continue;
 532                 }
 533
 534                 /*
 535                  *      The original time at which we received the
 536                  *      packet.  We need this to properly calculate
 537                  *      Acct-Delay-Time.
 538                  */
 539                 if (!strcasecmp(key, "Timestamp")) {
 540                         data->timestamp = atoi(value);
 541
 542                         vp = paircreate(PW_PACKET_ORIGINAL_TIMESTAMP, 0,
 543                                         PW_TYPE_DATE);
 544                         if (vp) {
 545                                 vp->vp_date = (uint32_t) data->timestamp;
 546                                 *tail = vp;
 547                                 tail = &(vp->next);
 548                         }
 549                         continue;
 550                 }
 551
 552                 /*
 553                  *      Read one VP.
 554                  *
 555                  *      FIXME: do we want to check for non-protocol
 556                  *      attributes like radsqlrelay does?
 557                  */
 558                 vp = NULL;
 559                 if ((userparse(buffer, &vp) > 0) &&
 560                     (vp != NULL)) {
 561                         *tail = vp;
 562                         tail = &(vp->next);
 563                 }
 564         }
 565
 566         /*
 567          *      Some kind of error.
 568          *
 569          *      FIXME: Leave the file in-place, and warn the
 570          *      administrator?
 571          */
 572         if (ferror(data->fp)) goto cleanup;
 573
 574         data->tries = 0;
 575         data->packets++;
 576
 577         /*
 578          *      Process the packet.
 579          */
 580  alloc_packet:
 581         data->tries++;
 582
 583         /*
 584          *      The writer doesn't check that the record was
 585          *      completely written.  If the disk is full, this can
 586          *      result in a truncated record.  When that happens,
 587          *      treat it as EOF.
 588          */
 589         if (data->state != STATE_QUEUED) {
 590                 radlog(L_ERR, "Truncated record: treating it as EOF for detail file %s", data->filename_work);
 591                 goto cleanup;
 592         }
 593
 594         /*
 595          *      We're done reading the file, but we didn't read
 596          *      anything.  Clean up, and don't return anything.
 597          */
 598         if (!data->vps) {
 599                 data->state = STATE_HEADER;
 600                 if (feof(data->fp)) goto cleanup;
 601                 return 0;
 602         }
 603
 604         /*
 605          *      Allocate the packet.  If we fail, it's a serious
 606          *      problem.
 607          */
 608         packet = rad_alloc(1);
 609         if (!packet) {
 610                 radlog(L_ERR, "FATAL: Failed allocating memory for detail");
 611                 exit(1);
 612         }
 613
 614         memset(packet, 0, sizeof(*packet));
 615         packet->sockfd = -1;
 616         packet->src_ipaddr.af = AF_INET;
 617         packet->src_ipaddr.ipaddr.ip4addr.s_addr = htonl(INADDR_NONE);
 618         packet->code = PW_ACCOUNTING_REQUEST;
 619         packet->timestamp = time(NULL);
 620
 621         /*
 622          *      Remember where it came from, so that we don't
 623          *      proxy it to the place it came from...
 624          */
 625         if (data->client_ip.af != AF_UNSPEC) {
 626                 packet->src_ipaddr = data->client_ip;
 627         }
 628
 629         vp = pairfind(packet->vps, PW_PACKET_SRC_IP_ADDRESS, 0);
 630         if (vp) {
 631                 packet->src_ipaddr.af = AF_INET;
 632                 packet->src_ipaddr.ipaddr.ip4addr.s_addr = vp->vp_ipaddr;
 633         } else {
 634                 vp = pairfind(packet->vps, PW_PACKET_SRC_IPV6_ADDRESS, 0);
 635                 if (vp) {
 636                         packet->src_ipaddr.af = AF_INET6;
 637                         memcpy(&packet->src_ipaddr.ipaddr.ip6addr,
 638                                &vp->vp_ipv6addr, sizeof(vp->vp_ipv6addr));
 639                 }
 640         }
 641
 642         vp = pairfind(packet->vps, PW_PACKET_DST_IP_ADDRESS, 0);
 643         if (vp) {
 644                 packet->dst_ipaddr.af = AF_INET;
 645                 packet->dst_ipaddr.ipaddr.ip4addr.s_addr = vp->vp_ipaddr;
 646         } else {
 647                 vp = pairfind(packet->vps, PW_PACKET_DST_IPV6_ADDRESS, 0);
 648                 if (vp) {
 649                         packet->dst_ipaddr.af = AF_INET6;
 650                         memcpy(&packet->dst_ipaddr.ipaddr.ip6addr,
 651                                &vp->vp_ipv6addr, sizeof(vp->vp_ipv6addr));
 652                 }
 653         }
 654
 655         /*
 656          *      We've got to give SOME value for Id & ports, so that
 657          *      the packets can be added to the request queue.
 658          *      However, we don't want to keep track of used/unused
 659          *      id's and ports, as that's a lot of work.  This hack
 660          *      ensures that (if we have real random numbers), that
 661          *      there will be a collision on every 2^(16+15+15+24 - 1)
 662          *      packets, on average.  That means we can read 2^37
 663          *      packets before having a collision, which means it's
 664          *      effectively impossible.
 665          */
 666         packet->id = fr_rand() & 0xffff;
 667         packet->src_port = 1024 + (fr_rand() & 0x7fff);
 668         packet->dst_port = 1024 + (fr_rand() & 0x7fff);
 669
 670         packet->dst_ipaddr.af = AF_INET;
 671         packet->dst_ipaddr.ipaddr.ip4addr.s_addr = htonl((INADDR_LOOPBACK & ~0xffffff) | (fr_rand() & 0xffffff));
 672
 673         /*
 674          *      If everything's OK, this is a waste of memory.
 675          *      Otherwise, it lets us re-send the original packet
 676          *      contents, unmolested.
 677          */
 678         packet->vps = paircopy(data->vps);
 679
 680         /*
 681          *      Look for Acct-Delay-Time, and update
 682          *      based on Acct-Delay-Time += (time(NULL) - timestamp)
 683          */
 684         vp = pairfind(packet->vps, PW_ACCT_DELAY_TIME, 0);
 685         if (!vp) {
 686                 vp = paircreate(PW_ACCT_DELAY_TIME, 0, PW_TYPE_INTEGER);
 687                 rad_assert(vp != NULL);
 688                 pairadd(&packet->vps, vp);
 689         }
 690         if (data->timestamp != 0) {
 691                 vp->vp_integer += time(NULL) - data->timestamp;
 692         }
 693
 694         *pfun = rad_accounting;
 695
 696         if (debug_flag) {
 697                 fr_printf_log("detail_recv: Read packet from %s\n", data->filename_work);
 698                 for (vp = packet->vps; vp; vp = vp->next) {
 699                         debug_pair(vp);
 700                 }
 701         }
 702
 703         /*
 704          *      FIXME: many of these checks may not be necessary when
 705          *      reading from the detail file.
 706          *
 707          *      Try again later...
 708          */
 709         if (!received_request(listener, packet, prequest,
 710                               &data->detail_client)) {
 711                 rad_free(&packet);
 712                 data->state = STATE_NO_REPLY;   /* try again later */
 713                 return 0;
 714         }
 715
 716         data->state = STATE_RUNNING;
 717         data->running = packet->timestamp;
 718
 719         return 1;
 720 }
 721
 722
 723 /*
 724  *      Free detail-specific stuff.
 725  */
 726 void detail_free(rad_listen_t *this)
 727 {
 728         listen_detail_t *data = this->data;
 729
 730         free(data->filename);
 731         data->filename = NULL;
 732         pairfree(&data->vps);
 733
 734         if (data->fp != NULL) {
 735                 fclose(data->fp);
 736                 data->fp = NULL;
 737         }
 738 }
 739
 740
 741 int detail_print(rad_listen_t *this, char *buffer, size_t bufsize)
 742 {
 743         if (!this->server) {
 744                 return snprintf(buffer, bufsize, "%s",
 745                                 ((listen_detail_t *)(this->data))->filename);
 746         }
 747
 748         return snprintf(buffer, bufsize, "detail file %s as server %s",
 749                         ((listen_detail_t *)(this->data))->filename,
 750                         this->server);
 751 }
 752
 753 /*
 754  *      Overloaded to return delay times.
 755  */
 756 int detail_encode(rad_listen_t *this, UNUSED REQUEST *request)
 757 {
 758         listen_detail_t *data = this->data;
 759
 760         /*
 761          *      We haven't sent a packet... delay things a bit.
 762          */
 763         if (!data->signal) {
 764                 int delay = (data->poll_interval - 1) * USEC;
 765
 766                 /*
 767                  *      Add +/- 0.25s of jitter
 768                  */
 769                 delay += (USEC * 3) / 4;
 770                 delay += fr_rand() % (USEC / 2);
 771
 772                 DEBUG2("Detail listener %s state %s signalled %d waiting %d.%06d sec",
 773                        data->filename,
 774                        fr_int2str(state_names, data->state, "?"), data->signal,
 775                        (delay / USEC), delay % USEC);
 776
 777                 return delay;
 778         }
 779
 780         data->signal = 0;
 781
 782         DEBUG2("Detail listener %s state %s signalled %d waiting %d.%06d sec",
 783                data->filename, fr_int2str(state_names, data->state, "?"),
 784                data->signal,
 785                data->delay_time / USEC,
 786                data->delay_time % USEC);
 787
 788         return data->delay_time;
 789 }
 790
 791
 792 /*
 793  *      Overloaded to return "should we fix delay times"
 794  */
 795 int detail_decode(rad_listen_t *this, UNUSED REQUEST *request)
 796 {
 797         listen_detail_t *data = this->data;
 798
 799         return data->signal;
 800 }
 801
 802
 803 static const CONF_PARSER detail_config[] = {
 804         { "filename",   PW_TYPE_STRING_PTR,
 805           offsetof(listen_detail_t, filename), NULL,  NULL },
 806         { "load_factor",   PW_TYPE_INTEGER,
 807           offsetof(listen_detail_t, load_factor), NULL, Stringify(10)},
 808         { "poll_interval",   PW_TYPE_INTEGER,
 809           offsetof(listen_detail_t, poll_interval), NULL, Stringify(1)},
 810         { "retry_interval",   PW_TYPE_INTEGER,
 811           offsetof(listen_detail_t, retry_interval), NULL, Stringify(30)},
 812
 813         { NULL, -1, 0, NULL, NULL }             /* end the list */
 814 };
 815
 816 extern int check_config;
 817
 818 /*
 819  *      Parse a detail section.
 820  */
 821 int detail_parse(CONF_SECTION *cs, rad_listen_t *this)
 822 {
 823         int             rcode;
 824         listen_detail_t *data;
 825         RADCLIENT       *client;
 826         char buffer[2048];
 827
 828         if (check_config) return 0;
 829
 830         if (!this->data) {
 831                 this->data = rad_malloc(sizeof(*data));
 832                 memset(this->data, 0, sizeof(*data));
 833         }
 834
 835         data = this->data;
 836
 837         rcode = cf_section_parse(cs, data, detail_config);
 838         if (rcode < 0) {
 839                 cf_log_err(cf_sectiontoitem(cs), "Failed parsing listen section");
 840                 return -1;
 841         }
 842
 843         if (!data->filename) {
 844                 cf_log_err(cf_sectiontoitem(cs), "No detail file specified in listen section");
 845                 return -1;
 846         }
 847
 848         if ((data->load_factor < 1) || (data->load_factor > 100)) {
 849                 cf_log_err(cf_sectiontoitem(cs), "Load factor must be between 1 and 100");
 850                 return -1;
 851         }
 852
 853         if ((data->poll_interval < 1) || (data->poll_interval > 20)) {
 854                 cf_log_err(cf_sectiontoitem(cs), "poll_interval must be between 1 and 20");
 855                 return -1;
 856         }
 857
 858         /*
 859          *      If the filename is a glob, use "detail.work" as the
 860          *      work file name.
 861          */
 862         if ((strchr(data->filename, '*') != NULL) ||
 863             (strchr(data->filename, '[') != NULL)) {
 864                 char *p;
 865
 866 #ifndef HAVE_GLOB_H
 867                 radlog(L_INFO, "WARNING: Detail file \"%s\" appears to use file globbing, but it is not supported on this system.", data->filename);
 868 #endif
 869                 strlcpy(buffer, data->filename, sizeof(buffer));
 870                 p = strrchr(buffer, FR_DIR_SEP);
 871                 if (p) {
 872                         p[1] = '\0';
 873                 } else {
 874                         buffer[0] = '\0';
 875                 }
 876                 strlcat(buffer, "detail.work",
 877                         sizeof(buffer) - strlen(buffer));
 878
 879         } else {
 880                 snprintf(buffer, sizeof(buffer), "%s.work", data->filename);
 881         }
 882
 883         free(data->filename_work);
 884         data->filename_work = strdup(buffer); /* FIXME: leaked */
 885
 886         data->vps = NULL;
 887         data->fp = NULL;
 888         data->state = STATE_UNOPENED;
 889         data->delay_time = data->poll_interval * USEC;
 890         data->signal = 1;
 891
 892         /*
 893          *      Initialize the fake client.
 894          */
 895         client = &data->detail_client;
 896         memset(client, 0, sizeof(*client));
 897         client->ipaddr.af = AF_INET;
 898         client->ipaddr.ipaddr.ip4addr.s_addr = INADDR_NONE;
 899         client->prefix = 0;
 900         client->longname = client->shortname = data->filename;
 901         client->secret = client->shortname;
 902         client->nastype = strdup("none");
 903
 904         return 0;
 905 }
 906 #endif