2 * detail.c Process the detail file
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.
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.
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
20 * Copyright 2007 The FreeRADIUS server project
21 * Copyright 2007 Alan DeKok <aland@deployingradius.com>
24 #include <freeradius-devel/ident.h>
27 #include <freeradius-devel/radiusd.h>
28 #include <freeradius-devel/modules.h>
29 #include <freeradius-devel/detail.h>
30 #include <freeradius-devel/process.h>
31 #include <freeradius-devel/rad_assert.h>
33 #ifdef HAVE_SYS_STAT_H
45 #define USEC (1000000)
47 static FR_NAME_NUMBER state_names[] = {
48 { "unopened", STATE_UNOPENED },
49 { "unlocked", STATE_UNLOCKED },
50 { "header", STATE_HEADER },
51 { "reading", STATE_READING },
52 { "queued", STATE_QUEUED },
53 { "running", STATE_RUNNING },
54 { "no-reply", STATE_NO_REPLY },
55 { "replied", STATE_REPLIED },
61 * If we're limiting outstanding packets, then mark the response
64 int detail_send(rad_listen_t *listener, REQUEST *request)
68 listen_detail_t *data = listener->data;
70 rad_assert(request->listener == listener);
71 rad_assert(listener->send == detail_send);
74 * This request timed out. Remember that, and tell the
75 * caller it's OK to read more "detail" file stuff.
77 if (request->reply->code == 0) {
78 data->delay_time = data->retry_interval * USEC;
80 data->state = STATE_NO_REPLY;
82 RDEBUG("Detail - No response configured for request %d. Will retry in %d seconds",
83 request->number, data->retry_interval);
85 radius_signal_self(RADIUS_SIGNAL_SELF_DETAIL);
90 * We call gettimeofday a lot. But it should be OK,
91 * because there's nothing else to do.
93 gettimeofday(&now, NULL);
96 * If we haven't sent a packet in the last second, reset
100 if (timercmp(&data->last_packet, &now, <)) {
101 data->has_rtt = FALSE;
106 * Only one detail packet may be outstanding at a time,
107 * so it's safe to update some entries in the detail
110 * We keep smoothed round trip time (SRTT), but not round
111 * trip timeout (RTO). We use SRTT to calculate a rough
114 rtt = now.tv_sec - request->packet->timestamp.tv_sec;
117 rtt -= request->packet->timestamp.tv_usec;
120 * If we're proxying, the RTT is our processing time,
121 * plus the network delay there and back, plus the time
122 * on the other end to process the packet. Ideally, we
123 * should remove the network delays from the RTT, but we
124 * don't know what they are.
126 * So, to be safe, we over-estimate the total cost of
127 * processing the packet.
129 if (!data->has_rtt) {
130 data->has_rtt = TRUE;
132 data->rttvar = rtt / 2;
135 data->rttvar -= data->rttvar >> 2;
136 data->rttvar += (data->srtt - rtt);
137 data->srtt -= data->srtt >> 3;
138 data->srtt += rtt >> 3;
142 * Calculate the time we wait before sending the next
145 * rtt / (rtt + delay) = load_factor / 100
147 data->delay_time = (data->srtt * (100 - data->load_factor)) / (data->load_factor);
150 * Cap delay at 4 packets/s. If the end system can't
151 * handle this, then it's very broken.
153 if (data->delay_time > (USEC / 4)) data->delay_time= USEC / 4;
155 RDEBUG3("Received response for request %d. Will read the next packet in %d seconds",
156 request->number, data->delay_time / USEC);
158 data->last_packet = now;
160 data->state = STATE_REPLIED;
162 radius_signal_self(RADIUS_SIGNAL_SELF_DETAIL);
169 * Open the detail file, if we can.
171 * FIXME: create it, if it's not already there, so that the main
172 * server select() will wake us up if there's anything to read.
174 static int detail_open(rad_listen_t *this)
177 listen_detail_t *data = this->data;
178 char *filename = data->filename;
180 rad_assert(data->state == STATE_UNOPENED);
181 data->delay_time = USEC;
184 * Open detail.work first, so we don't lose
185 * accounting packets. It's probably better to
186 * duplicate them than to lose them.
188 * Note that we're not writing to the file, but
189 * we've got to open it for writing in order to
190 * establish the lock, to prevent rlm_detail from
193 * This also means that if we're doing globbing,
194 * this file will be read && processed before the
195 * file globbing is done.
197 this->fd = open(data->filename_work, O_RDWR);
199 DEBUG2("Polling for detail file %s", filename);
202 * Try reading the detail file. If it
203 * doesn't exist, we can't do anything.
205 * Doing the stat will tell us if the file
206 * exists, even if we don't have permissions
209 if (stat(filename, &st) < 0) {
216 memset(&files, 0, sizeof(files));
217 if (glob(filename, 0, NULL, &files) != 0) {
224 for (i = 0; i < files.gl_pathc; i++) {
225 if (stat(files.gl_pathv[i], &st) < 0) continue;
228 (st.st_ctime < chtime)) {
229 chtime = st.st_ctime;
239 filename = strdup(files.gl_pathv[found]);
247 * Open it BEFORE we rename it, just to
250 this->fd = open(filename, O_RDWR);
252 radlog(L_ERR, "Detail - Failed to open %s: %s",
253 filename, strerror(errno));
254 if (filename != data->filename) free(filename);
259 * Rename detail to detail.work
261 DEBUG("Detail - Renaming %s -> %s", filename, data->filename_work);
262 if (rename(filename, data->filename_work) < 0) {
263 if (filename != data->filename) free(filename);
268 if (filename != data->filename) free(filename);
269 } /* else detail.work existed, and we opened it */
271 rad_assert(data->vps == NULL);
272 rad_assert(data->fp == NULL);
274 data->state = STATE_UNLOCKED;
276 data->client_ip.af = AF_UNSPEC;
287 * FIXME: add a configuration "exit when done" so that the detail
288 * file reader can be used as a one-off tool to update stuff.
290 * The time sequence for reading from the detail file is:
292 * t_0 signalled that the server is idle, and we
293 * can read from the detail file.
295 * t_rtt the packet has been processed successfully,
296 * wait for t_delay to enforce load factor.
298 * t_rtt + t_delay wait for signal that the server is idle.
301 int detail_recv(rad_listen_t *listener)
303 char key[256], op[8], value[1024];
304 VALUE_PAIR *vp, **tail;
305 RADIUS_PACKET *packet;
307 listen_detail_t *data = listener->data;
311 * We may be in the main thread. It needs to update the
312 * timers before we try to read from the file again.
314 if (data->signal) return 0;
316 switch (data->state) {
319 rad_assert(listener->fd < 0);
321 if (!detail_open(listener)) return 0;
323 rad_assert(data->state == STATE_UNLOCKED);
324 rad_assert(listener->fd >= 0);
329 * Try to lock fd. If we can't, return.
330 * If we can, continue. This means that
331 * the server doesn't block while waiting
332 * for the lock to open...
336 * Note that we do NOT block waiting for
337 * the lock. We've re-named the file
338 * above, so we've already guaranteed
339 * that any *new* detail writer will not
340 * be opening this file. The only
341 * purpose of the lock is to catch a race
342 * condition where the execution
343 * "ping-pongs" between radiusd &
346 if (rad_lockfd_nonblock(listener->fd, 0) < 0) {
348 * Close the FD. The main loop
349 * will wake up in a second and
354 data->state = STATE_UNOPENED;
358 data->fp = fdopen(listener->fd, "r");
360 radlog(L_ERR, "FATAL: Failed to re-open detail file %s: %s",
361 data->filename, strerror(errno));
366 * Look for the header
368 data->state = STATE_HEADER;
369 data->delay_time = USEC;
378 data->state = STATE_UNOPENED;
385 fstat(listener->fd, &buf);
386 if (((off_t) ftell(data->fp)) == buf.st_size) {
392 * End of file. Delete it, and re-set
395 if (feof(data->fp)) {
397 DEBUG("Detail - unlinking %s",
398 data->filename_work);
399 unlink(data->filename_work);
400 if (data->fp) fclose(data->fp);
403 data->state = STATE_UNOPENED;
404 rad_assert(data->vps == NULL);
406 if (data->one_shot) {
407 radlog(L_INFO, "Finished reading \"one shot\" detail file - Exiting");
408 radius_signal_self(RADIUS_SIGNAL_SELF_EXIT);
415 * Else go read something.
420 * Read more value-pair's, unless we're
421 * at EOF. In that case, queue whatever
425 if (data->fp && !feof(data->fp)) break;
426 data->state = STATE_QUEUED;
434 * Periodically check what's going on.
435 * If the request is taking too long,
439 if (time(NULL) < (data->running + data->retry_interval)) {
443 DEBUG("No response to detail request. Retrying");
444 data->state = STATE_NO_REPLY;
448 * If there's no reply, keep
449 * retransmitting the current packet
453 data->state = STATE_QUEUED;
457 * We have a reply. Clean up the old
458 * request, and go read another one.
461 pairfree(&data->vps);
462 data->state = STATE_HEADER;
467 while (*tail) tail = &(*tail)->next;
470 * Read a header, OR a value-pair.
472 while (fgets(buffer, sizeof(buffer), data->fp)) {
473 data->offset = ftell(data->fp); /* for statistics */
476 * Badly formatted file: delete it.
478 * FIXME: Maybe flag an error?
480 if (!strchr(buffer, '\n')) {
481 pairfree(&data->vps);
486 * We're reading VP's, and got a blank line.
489 if ((data->state == STATE_READING) &&
490 (buffer[0] == '\n')) {
491 data->state = STATE_QUEUED;
496 * Look for date/time header, and read VP's if
497 * found. If not, keep reading lines until we
500 if (data->state == STATE_HEADER) {
503 if (sscanf(buffer, "%*s %*s %*d %*d:%*d:%*d %d", &y)) {
504 data->state = STATE_READING;
510 * We have a full "attribute = value" line.
511 * If it doesn't look reasonable, skip it.
513 * FIXME: print an error for badly formatted attributes?
515 if (sscanf(buffer, "%255s %8s %1023s", key, op, value) != 3) {
516 DEBUG2("WARNING: Skipping badly formatted line %s",
522 * Should be =, :=, +=, ...
524 if (!strchr(op, '=')) continue;
527 * Skip non-protocol attributes.
529 if (!strcasecmp(key, "Request-Authenticator")) continue;
532 * Set the original client IP address, based on
533 * what's in the detail file.
535 * Hmm... we don't set the server IP address.
538 if (!strcasecmp(key, "Client-IP-Address")) {
539 data->client_ip.af = AF_INET;
540 ip_hton(value, AF_INET, &data->client_ip);
545 * The original time at which we received the
546 * packet. We need this to properly calculate
549 if (!strcasecmp(key, "Timestamp")) {
550 data->timestamp = atoi(value);
552 vp = paircreate(PW_PACKET_ORIGINAL_TIMESTAMP, 0);
554 vp->vp_date = (uint32_t) data->timestamp;
564 * FIXME: do we want to check for non-protocol
565 * attributes like radsqlrelay does?
568 if ((userparse(buffer, &vp) > 0) &&
576 * Some kind of error.
578 * FIXME: Leave the file in-place, and warn the
581 if (ferror(data->fp)) goto cleanup;
587 * Process the packet.
593 * The writer doesn't check that the record was
594 * completely written. If the disk is full, this can
595 * result in a truncated record. When that happens,
598 if (data->state != STATE_QUEUED) {
599 radlog(L_ERR, "Truncated record: treating it as EOF for detail file %s", data->filename_work);
604 * We're done reading the file, but we didn't read
605 * anything. Clean up, and don't return anything.
608 data->state = STATE_HEADER;
609 if (!data->fp || feof(data->fp)) goto cleanup;
614 * Allocate the packet. If we fail, it's a serious
617 packet = rad_alloc(1);
619 radlog(L_ERR, "FATAL: Failed allocating memory for detail");
623 memset(packet, 0, sizeof(*packet));
625 packet->src_ipaddr.af = AF_INET;
626 packet->src_ipaddr.ipaddr.ip4addr.s_addr = htonl(INADDR_NONE);
627 packet->code = PW_ACCOUNTING_REQUEST;
628 gettimeofday(&packet->timestamp, NULL);
631 * Remember where it came from, so that we don't
632 * proxy it to the place it came from...
634 if (data->client_ip.af != AF_UNSPEC) {
635 packet->src_ipaddr = data->client_ip;
638 vp = pairfind(packet->vps, PW_PACKET_SRC_IP_ADDRESS, 0, TAG_ANY);
640 packet->src_ipaddr.af = AF_INET;
641 packet->src_ipaddr.ipaddr.ip4addr.s_addr = vp->vp_ipaddr;
643 vp = pairfind(packet->vps, PW_PACKET_SRC_IPV6_ADDRESS, 0, TAG_ANY);
645 packet->src_ipaddr.af = AF_INET6;
646 memcpy(&packet->src_ipaddr.ipaddr.ip6addr,
647 &vp->vp_ipv6addr, sizeof(vp->vp_ipv6addr));
651 vp = pairfind(packet->vps, PW_PACKET_DST_IP_ADDRESS, 0, TAG_ANY);
653 packet->dst_ipaddr.af = AF_INET;
654 packet->dst_ipaddr.ipaddr.ip4addr.s_addr = vp->vp_ipaddr;
656 vp = pairfind(packet->vps, PW_PACKET_DST_IPV6_ADDRESS, 0, TAG_ANY);
658 packet->dst_ipaddr.af = AF_INET6;
659 memcpy(&packet->dst_ipaddr.ipaddr.ip6addr,
660 &vp->vp_ipv6addr, sizeof(vp->vp_ipv6addr));
665 * Generate packet ID, ports, IP via a counter.
667 packet->id = data->counter & 0xff;
668 packet->src_port = 1024 + ((data->counter >> 8) & 0xff);
669 packet->dst_port = 1024 + ((data->counter >> 16) & 0xff);
671 packet->dst_ipaddr.af = AF_INET;
672 packet->dst_ipaddr.ipaddr.ip4addr.s_addr = htonl((INADDR_LOOPBACK & ~0xffffff) | ((data->counter >> 24) & 0xff));
675 * If everything's OK, this is a waste of memory.
676 * Otherwise, it lets us re-send the original packet
677 * contents, unmolested.
679 packet->vps = paircopy(data->vps);
682 * Prefer the Event-Timestamp in the packet, if it
683 * exists. That is when the event occurred, whereas the
684 * "Timestamp" field is when we wrote the packet to the
685 * detail file, which could have been much later.
687 vp = pairfind(packet->vps, PW_EVENT_TIMESTAMP, 0, TAG_ANY);
689 data->timestamp = vp->vp_integer;
693 * Look for Acct-Delay-Time, and update
694 * based on Acct-Delay-Time += (time(NULL) - timestamp)
696 vp = pairfind(packet->vps, PW_ACCT_DELAY_TIME, 0, TAG_ANY);
698 vp = paircreate(PW_ACCT_DELAY_TIME, 0);
699 rad_assert(vp != NULL);
700 pairadd(&packet->vps, vp);
702 if (data->timestamp != 0) {
703 vp->vp_integer += time(NULL) - data->timestamp;
707 * Set the transmission count.
709 vp = pairfind(packet->vps, PW_PACKET_TRANSMIT_COUNTER, 0, TAG_ANY);
711 vp = paircreate(PW_PACKET_TRANSMIT_COUNTER, 0);
712 rad_assert(vp != NULL);
713 pairadd(&packet->vps, vp);
715 vp->vp_integer = data->tries;
718 fr_printf_log("detail_recv: Read packet from %s\n", data->filename_work);
719 for (vp = packet->vps; vp; vp = vp->next) {
725 * Don't bother doing limit checks, etc.
727 gettimeofday(&now, NULL);
728 if (!request_insert(listener, packet, &data->detail_client,
729 rad_accounting, &now)) {
731 data->state = STATE_NO_REPLY; /* try again later */
735 data->state = STATE_RUNNING;
736 data->running = packet->timestamp.tv_sec;
743 * Free detail-specific stuff.
745 void detail_free(rad_listen_t *this)
747 listen_detail_t *data = this->data;
749 free(data->filename);
750 data->filename = NULL;
751 pairfree(&data->vps);
753 if (data->fp != NULL) {
760 int detail_print(const rad_listen_t *this, char *buffer, size_t bufsize)
763 return snprintf(buffer, bufsize, "%s",
764 ((listen_detail_t *)(this->data))->filename);
767 return snprintf(buffer, bufsize, "detail file %s as server %s",
768 ((listen_detail_t *)(this->data))->filename,
773 * Overloaded to return delay times.
775 int detail_encode(rad_listen_t *this, UNUSED REQUEST *request)
777 listen_detail_t *data = this->data;
780 * We haven't sent a packet... delay things a bit.
783 int delay = (data->poll_interval - 1) * USEC;
786 * Add +/- 0.25s of jitter
788 delay += (USEC * 3) / 4;
789 delay += fr_rand() % (USEC / 2);
791 DEBUG2("Detail listener %s state %s signalled %d waiting %d.%06d sec",
793 fr_int2str(state_names, data->state, "?"), data->signal,
794 (delay / USEC), delay % USEC);
801 DEBUG2("Detail listener %s state %s signalled %d waiting %d.%06d sec",
802 data->filename, fr_int2str(state_names, data->state, "?"),
804 data->delay_time / USEC,
805 data->delay_time % USEC);
807 return data->delay_time;
812 * Overloaded to return "should we fix delay times"
814 int detail_decode(rad_listen_t *this, UNUSED REQUEST *request)
816 listen_detail_t *data = this->data;
822 static const CONF_PARSER detail_config[] = {
823 { "filename", PW_TYPE_STRING_PTR,
824 offsetof(listen_detail_t, filename), NULL, NULL },
825 { "load_factor", PW_TYPE_INTEGER,
826 offsetof(listen_detail_t, load_factor), NULL, Stringify(10)},
827 { "poll_interval", PW_TYPE_INTEGER,
828 offsetof(listen_detail_t, poll_interval), NULL, Stringify(1)},
829 { "retry_interval", PW_TYPE_INTEGER,
830 offsetof(listen_detail_t, retry_interval), NULL, Stringify(30)},
831 { "one_shot", PW_TYPE_BOOLEAN,
832 offsetof(listen_detail_t, one_shot), NULL, NULL},
833 { "max_outstanding", PW_TYPE_INTEGER,
834 offsetof(listen_detail_t, load_factor), NULL, NULL},
836 { NULL, -1, 0, NULL, NULL } /* end the list */
839 extern int check_config;
842 * Parse a detail section.
844 int detail_parse(CONF_SECTION *cs, rad_listen_t *this)
847 listen_detail_t *data;
851 if (check_config) return 0;
854 this->data = rad_malloc(sizeof(*data));
855 memset(this->data, 0, sizeof(*data));
860 rcode = cf_section_parse(cs, data, detail_config);
862 cf_log_err(cf_sectiontoitem(cs), "Failed parsing listen section");
866 if (!data->filename) {
867 cf_log_err(cf_sectiontoitem(cs), "No detail file specified in listen section");
871 if ((data->load_factor < 1) || (data->load_factor > 100)) {
872 cf_log_err(cf_sectiontoitem(cs), "Load factor must be between 1 and 100");
876 if ((data->poll_interval < 1) || (data->poll_interval > 20)) {
877 cf_log_err(cf_sectiontoitem(cs), "poll_interval must be between 1 and 20");
881 if (data->max_outstanding == 0) data->max_outstanding = 1;
884 * If the filename is a glob, use "detail.work" as the
887 if ((strchr(data->filename, '*') != NULL) ||
888 (strchr(data->filename, '[') != NULL)) {
892 radlog(L_INFO, "WARNING: Detail file \"%s\" appears to use file globbing, but it is not supported on this system.", data->filename);
894 strlcpy(buffer, data->filename, sizeof(buffer));
895 p = strrchr(buffer, FR_DIR_SEP);
901 strlcat(buffer, "detail.work",
902 sizeof(buffer) - strlen(buffer));
905 snprintf(buffer, sizeof(buffer), "%s.work", data->filename);
908 free(data->filename_work);
909 data->filename_work = strdup(buffer); /* FIXME: leaked */
913 data->state = STATE_UNOPENED;
914 data->delay_time = data->poll_interval * USEC;
918 * Initialize the fake client.
920 client = &data->detail_client;
921 memset(client, 0, sizeof(*client));
922 client->ipaddr.af = AF_INET;
923 client->ipaddr.ipaddr.ip4addr.s_addr = INADDR_NONE;
925 client->longname = client->shortname = data->filename;
926 client->secret = client->shortname;
927 client->nastype = strdup("none");