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>
26 #include <freeradius-devel/radiusd.h>
27 #include <freeradius-devel/modules.h>
28 #include <freeradius-devel/detail.h>
29 #include <freeradius-devel/process.h>
30 #include <freeradius-devel/rad_assert.h>
32 #ifdef HAVE_SYS_STAT_H
44 #define USEC (1000000)
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 },
61 * If we're limiting outstanding packets, then mark the response
64 int detail_send(rad_listen_t *listener, REQUEST *request)
66 #ifdef WITH_DETAIL_THREAD
69 listen_detail_t *data = listener->data;
71 rad_assert(request->listener == listener);
72 rad_assert(listener->send == detail_send);
75 * This request timed out. Remember that, and tell the
76 * caller it's OK to read more "detail" file stuff.
78 if (request->reply->code == 0) {
79 data->delay_time = data->retry_interval * USEC;
81 data->state = STATE_NO_REPLY;
83 RDEBUG("detail (%s): No response to request. Will retry in %d seconds",
84 data->name, data->retry_interval);
89 RDEBUG("detail (%s): Done %s packet.", data->name, fr_packet_codes[request->packet->code]);
92 * We call gettimeofday a lot. But it should be OK,
93 * because there's nothing else to do.
95 gettimeofday(&now, NULL);
98 * If we haven't sent a packet in the last second, reset
102 if (timercmp(&data->last_packet, &now, <)) {
103 data->has_rtt = false;
108 * Only one detail packet may be outstanding at a time,
109 * so it's safe to update some entries in the detail
112 * We keep smoothed round trip time (SRTT), but not round
113 * trip timeout (RTO). We use SRTT to calculate a rough
116 rtt = now.tv_sec - request->packet->timestamp.tv_sec;
119 rtt -= request->packet->timestamp.tv_usec;
122 * If we're proxying, the RTT is our processing time,
123 * plus the network delay there and back, plus the time
124 * on the other end to process the packet. Ideally, we
125 * should remove the network delays from the RTT, but we
126 * don't know what they are.
128 * So, to be safe, we over-estimate the total cost of
129 * processing the packet.
131 if (!data->has_rtt) {
132 data->has_rtt = true;
134 data->rttvar = rtt / 2;
137 data->rttvar -= data->rttvar >> 2;
138 data->rttvar += (data->srtt - rtt);
139 data->srtt -= data->srtt >> 3;
140 data->srtt += rtt >> 3;
144 * Calculate the time we wait before sending the next
147 * rtt / (rtt + delay) = load_factor / 100
149 data->delay_time = (data->srtt * (100 - data->load_factor)) / (data->load_factor);
152 * Cap delay at no less than 4 packets/s. If the
153 * end system can't handle this, then it's very
156 if (data->delay_time > (USEC / 4)) data->delay_time= USEC / 4;
158 RDEBUG3("detail (%s): Received response for request %d. Will read the next packet in %d seconds",
159 data->name, request->number, data->delay_time / USEC);
161 data->last_packet = now;
163 data->state = STATE_REPLIED;
167 #ifdef WITH_DETAIL_THREAD
168 if (write(data->child_pipe[1], &c, 1) < 0) {
169 RERROR("detail (%s): Failed writing ack to reader thread: %s", data->name, fr_syserror(errno));
172 radius_signal_self(RADIUS_SIGNAL_SELF_DETAIL);
180 * Open the detail file, if we can.
182 * FIXME: create it, if it's not already there, so that the main
183 * server select() will wake us up if there's anything to read.
185 static int detail_open(rad_listen_t *this)
188 listen_detail_t *data = this->data;
190 rad_assert(data->state == STATE_UNOPENED);
191 data->delay_time = USEC;
194 * Open detail.work first, so we don't lose
195 * accounting packets. It's probably better to
196 * duplicate them than to lose them.
198 * Note that we're not writing to the file, but
199 * we've got to open it for writing in order to
200 * establish the lock, to prevent rlm_detail from
203 * This also means that if we're doing globbing,
204 * this file will be read && processed before the
205 * file globbing is done.
208 data->work_fd = open(data->filename_work, O_RDWR);
211 * Couldn't open it for a reason OTHER than "it doesn't
212 * exist". Complain and tell the admin.
214 if ((data->work_fd < 0) && (errno != ENOENT)) {
215 ERROR("Failed opening detail file %s: %s",
216 data->filename_work, fr_syserror(errno));
221 * The file doesn't exist. Poll for it again.
223 if (data->work_fd < 0) {
230 char const *filename;
233 DEBUG2("detail (%s): Polling for detail file", data->name);
235 memset(&files, 0, sizeof(files));
236 if (glob(data->filename, 0, NULL, &files) != 0) {
243 * Loop over the glob'd files, looking for the
248 for (i = 0; i < files.gl_pathc; i++) {
249 if (stat(files.gl_pathv[i], &st) < 0) continue;
251 if ((i == 0) || (st.st_ctime < chtime)) {
252 chtime = st.st_ctime;
257 if (found < 0) goto noop;
260 * Rename detail to detail.work
262 filename = files.gl_pathv[found];
264 DEBUG("detail (%s): Renaming %s -> %s", data->name, filename, data->filename_work);
265 if (rename(filename, data->filename_work) < 0) {
266 ERROR("detail (%s): Failed renaming %s to %s: %s",
267 data->name, filename, data->filename_work, fr_syserror(errno));
271 globfree(&files); /* Shouldn't be using anything in files now */
274 * And try to open the filename.
276 data->work_fd = open(data->filename_work, O_RDWR);
277 if (data->work_fd < 0) {
278 ERROR("Failed opening detail file %s: %s",
279 data->filename_work, fr_syserror(errno));
283 } /* else detail.work existed, and we opened it */
285 rad_assert(data->vps == NULL);
286 rad_assert(data->fp == NULL);
288 data->state = STATE_UNLOCKED;
290 data->client_ip.af = AF_UNSPEC;
292 data->offset = data->last_offset = data->timestamp_offset = 0;
295 data->done_entry = false;
302 * FIXME: add a configuration "exit when done" so that the detail
303 * file reader can be used as a one-off tool to update stuff.
305 * The time sequence for reading from the detail file is:
307 * t_0 signalled that the server is idle, and we
308 * can read from the detail file.
310 * t_rtt the packet has been processed successfully,
311 * wait for t_delay to enforce load factor.
313 * t_rtt + t_delay wait for signal that the server is idle.
316 #ifndef WITH_DETAIL_THREAD
317 static RADIUS_PACKET *detail_poll(rad_listen_t *listener);
319 int detail_recv(rad_listen_t *listener)
321 RADIUS_PACKET *packet;
322 listen_detail_t *data = listener->data;
323 RAD_REQUEST_FUNP fun = NULL;
326 * We may be in the main thread. It needs to update the
327 * timers before we try to read from the file again.
329 if (data->signal) return 0;
331 packet = detail_poll(listener);
332 if (!packet) return -1;
334 if (DEBUG_ENABLED2) {
338 DEBUG2("detail (%s): Read packet from %s", data->name, data->filename_work);
339 for (vp = fr_cursor_init(&cursor, &packet->vps);
341 vp = fr_cursor_next(&cursor)) {
346 switch (packet->code) {
347 case PW_CODE_ACCOUNTING_REQUEST:
348 fun = rad_accounting;
351 case PW_CODE_COA_REQUEST:
352 case PW_CODE_DISCONNECT_REQUEST:
358 data->state = STATE_REPLIED;
363 * Don't bother doing limit checks, etc.
365 if (!request_receive(NULL, listener, packet, &data->detail_client, fun)) {
367 data->state = STATE_NO_REPLY; /* try again later */
374 int detail_recv(rad_listen_t *listener)
378 RADIUS_PACKET *packet;
379 listen_detail_t *data = listener->data;
380 RAD_REQUEST_FUNP fun = NULL;
383 * Block until there's a packet ready.
385 rcode = read(data->master_pipe[0], &packet, sizeof(packet));
386 if (rcode <= 0) return rcode;
388 rad_assert(packet != NULL);
390 if (DEBUG_ENABLED2) {
394 DEBUG2("detail (%s): Read packet from %s", data->name, data->filename_work);
395 for (vp = fr_cursor_init(&cursor, &packet->vps);
397 vp = fr_cursor_next(&cursor)) {
402 switch (packet->code) {
403 case PW_CODE_ACCOUNTING_REQUEST:
404 fun = rad_accounting;
407 case PW_CODE_COA_REQUEST:
408 case PW_CODE_DISCONNECT_REQUEST:
413 data->state = STATE_REPLIED;
417 if (!request_receive(NULL, listener, packet, &data->detail_client, fun)) {
418 data->state = STATE_NO_REPLY; /* try again later */
422 if (write(data->child_pipe[1], &c, 1) < 0) {
423 ERROR("detail (%s): Failed writing ack to reader thread: %s", data->name,
429 * Wait for the child thread to write an answer to the pipe
435 static RADIUS_PACKET *detail_poll(rad_listen_t *listener)
438 char key[256], op[8], value[1024];
441 RADIUS_PACKET *packet;
443 listen_detail_t *data = listener->data;
445 switch (data->state) {
448 rad_assert(data->work_fd < 0);
450 if (!detail_open(listener)) return NULL;
452 rad_assert(data->state == STATE_UNLOCKED);
453 rad_assert(data->work_fd >= 0);
458 * Try to lock fd. If we can't, return.
459 * If we can, continue. This means that
460 * the server doesn't block while waiting
461 * for the lock to open...
465 * Note that we do NOT block waiting for
466 * the lock. We've re-named the file
467 * above, so we've already guaranteed
468 * that any *new* detail writer will not
469 * be opening this file. The only
470 * purpose of the lock is to catch a race
471 * condition where the execution
472 * "ping-pongs" between radiusd &
475 if (rad_lockfd_nonblock(data->work_fd, 0) < 0) {
477 * Close the FD. The main loop
478 * will wake up in a second and
481 close(data->work_fd);
484 data->state = STATE_UNOPENED;
489 * Only open for writing if we're
490 * marking requests as completed.
492 data->fp = fdopen(data->work_fd, data->track ? "r+" : "r");
494 ERROR("detail (%s): FATAL: Failed to re-open detail file: %s",
495 data->name, fr_syserror(errno));
500 * Look for the header
502 data->state = STATE_HEADER;
503 data->delay_time = USEC;
510 data->done_entry = false;
511 data->timestamp_offset = 0;
515 data->state = STATE_UNOPENED;
522 if (fstat(data->work_fd, &buf) < 0) {
523 ERROR("detail (%s): Failed to stat detail file: %s",
524 data->name, fr_syserror(errno));
528 if (((off_t) ftell(data->fp)) == buf.st_size) {
534 * End of file. Delete it, and re-set
537 if (feof(data->fp)) {
539 DEBUG("detail (%s): Unlinking %s", data->name, data->filename_work);
540 unlink(data->filename_work);
541 if (data->fp) fclose(data->fp);
544 data->state = STATE_UNOPENED;
545 rad_assert(data->vps == NULL);
547 if (data->one_shot) {
548 INFO("detail (%s): Finished reading \"one shot\" detail file - Exiting", data->name);
549 radius_signal_self(RADIUS_SIGNAL_SELF_EXIT);
556 * Else go read something.
558 if (!fgets(buffer, sizeof(buffer), data->fp)) {
559 DEBUG("detail (%s): Failed reading header from file - %s",
560 data->name, data->filename_work);
565 * Badly formatted file: delete it.
567 if (!strchr(buffer, '\n')) {
568 DEBUG("detail (%s): Invalid line without trailing LF - %s", data->name, buffer);
572 if (!sscanf(buffer, "%*s %*s %*d %*d:%*d:%*d %d", &y)) {
573 DEBUG("detail (%s): Failed reading detail file header in line - %s", data->name, buffer);
577 data->state = STATE_READING;
582 * Read more value-pair's, unless we're
583 * at EOF. In that case, queue whatever
587 rad_assert(data->fp != NULL);
589 fr_cursor_init(&cursor, &data->vps);
592 * Read a header, OR a value-pair.
594 while (fgets(buffer, sizeof(buffer), data->fp)) {
595 data->last_offset = data->offset;
596 data->offset = ftell(data->fp); /* for statistics */
599 * Badly formatted file: delete it.
601 if (!strchr(buffer, '\n')) {
602 WARN("detail (%s): Skipping line without trailing LF - %s", data->name, buffer);
603 fr_pair_list_free(&data->vps);
608 * We're reading VP's, and got a blank line.
609 * That indicates the end of an entry. Queue the
612 if (buffer[0] == '\n') {
613 data->state = STATE_QUEUED;
620 * We have a full "attribute = value" line.
621 * If it doesn't look reasonable, skip it.
623 * FIXME: print an error for badly formatted attributes?
625 if (sscanf(buffer, "%255s %7s %1023s", key, op, value) != 3) {
626 DEBUG("detail (%s): Skipping badly formatted line - %s", data->name, buffer);
631 * Should be =, :=, +=, ...
633 if (!strchr(op, '=')) {
634 DEBUG("detail (%s): Skipping line without operator - %s", data->name, buffer);
639 * Skip non-protocol attributes.
641 if (!strcasecmp(key, "Request-Authenticator")) continue;
644 * Set the original client IP address, based on
645 * what's in the detail file.
647 * Hmm... we don't set the server IP address.
650 if (!strcasecmp(key, "Client-IP-Address")) {
651 data->client_ip.af = AF_INET;
652 if (ip_hton(&data->client_ip, AF_INET, value, false) < 0) {
653 DEBUG("detail (%s): Failed parsing Client-IP-Address", data->name);
654 fr_pair_list_free(&data->vps);
661 * The original time at which we received the
662 * packet. We need this to properly calculate
665 if (!strcasecmp(key, "Timestamp")) {
666 data->timestamp = atoi(value);
667 data->timestamp_offset = data->last_offset;
669 vp = fr_pair_afrom_num(data, PW_PACKET_ORIGINAL_TIMESTAMP, 0);
671 vp->vp_date = (uint32_t) data->timestamp;
673 fr_cursor_insert(&cursor, vp);
678 if (!strcasecmp(key, "Donestamp")) {
679 data->timestamp = atoi(value);
680 data->done_entry = true;
684 DEBUG3("detail (%s): Trying to read VP from line - %s", data->name, buffer);
689 * FIXME: do we want to check for non-protocol
690 * attributes like radsqlrelay does?
693 if ((fr_pair_list_afrom_str(data, buffer, &vp) > 0) &&
695 fr_cursor_merge(&cursor, vp);
697 DEBUG("detail (%s): Failed reading VP from line - %s", data->name, buffer);
703 * The writer doesn't check that the
704 * record was completely written. If the
705 * disk is full, this can result in a
706 * truncated record which has no trailing
707 * blank line. When that happens, it's a
708 * bad record, and we ignore it.
710 if (feof(data->fp)) {
711 DEBUG("detail (%s): Truncated record: treating it as EOF for detail file %s",
712 data->name, data->filename_work);
713 fr_pair_list_free(&data->vps);
718 * Some kind of non-eof error.
720 * FIXME: Leave the file in-place, and warn the
723 DEBUG("detail (%s): Unknown error, deleting detail file %s",
724 data->name, data->filename_work);
731 * Periodically check what's going on.
732 * If the request is taking too long,
736 if (time(NULL) < (data->running + (int)data->retry_interval)) {
740 DEBUG("detail (%s): No response to detail request. Retrying", data->name);
744 * If there's no reply, keep
745 * retransmitting the current packet
749 data->state = STATE_QUEUED;
753 * We have a reply. Clean up the old
754 * request, and go read another one.
758 rad_assert(data->fp != NULL);
760 if (fseek(data->fp, data->timestamp_offset, SEEK_SET) < 0) {
761 DEBUG("detail (%s): Failed seeking to timestamp offset: %s",
762 data->name, fr_syserror(errno));
763 } else if (fwrite("\tDone", 1, 5, data->fp) < 5) {
764 DEBUG("detail (%s): Failed marking request as done: %s",
765 data->name, fr_syserror(errno));
766 } else if (fflush(data->fp) != 0) {
767 DEBUG("detail (%s): Failed flushing marked detail file to disk: %s",
768 data->name, fr_syserror(errno));
771 if (fseek(data->fp, data->offset, SEEK_SET) < 0) {
772 DEBUG("detail (%s): Failed seeking to next detail request: %s",
773 data->name, fr_syserror(errno));
777 fr_pair_list_free(&data->vps);
778 data->state = STATE_HEADER;
783 * Process the packet.
786 if (data->done_entry) {
787 DEBUG2("detail (%s): Skipping record for timestamp %lu", data->name, data->timestamp);
788 fr_pair_list_free(&data->vps);
789 data->state = STATE_HEADER;
796 * We're done reading the file, but we didn't read
797 * anything. Clean up, and don't return anything.
800 WARN("detail (%s): Read empty packet from file %s",
801 data->name, data->filename_work);
802 data->state = STATE_HEADER;
807 * Allocate the packet. If we fail, it's a serious
810 packet = rad_alloc(NULL, true);
812 ERROR("detail (%s): FATAL: Failed allocating memory for detail", data->name);
816 memset(packet, 0, sizeof(*packet));
818 packet->src_ipaddr.af = AF_INET;
819 packet->src_ipaddr.ipaddr.ip4addr.s_addr = htonl(INADDR_NONE);
822 * If everything's OK, this is a waste of memory.
823 * Otherwise, it lets us re-send the original packet
824 * contents, unmolested.
826 packet->vps = fr_pair_list_copy(packet, data->vps);
828 packet->code = PW_CODE_ACCOUNTING_REQUEST;
829 vp = fr_pair_find_by_num(packet->vps, PW_PACKET_TYPE, 0, TAG_ANY);
830 if (vp) packet->code = vp->vp_integer;
832 gettimeofday(&packet->timestamp, NULL);
835 * Remember where it came from, so that we don't
836 * proxy it to the place it came from...
838 if (data->client_ip.af != AF_UNSPEC) {
839 packet->src_ipaddr = data->client_ip;
842 vp = fr_pair_find_by_num(packet->vps, PW_PACKET_SRC_IP_ADDRESS, 0, TAG_ANY);
844 packet->src_ipaddr.af = AF_INET;
845 packet->src_ipaddr.ipaddr.ip4addr.s_addr = vp->vp_ipaddr;
846 packet->src_ipaddr.prefix = 32;
848 vp = fr_pair_find_by_num(packet->vps, PW_PACKET_SRC_IPV6_ADDRESS, 0, TAG_ANY);
850 packet->src_ipaddr.af = AF_INET6;
851 memcpy(&packet->src_ipaddr.ipaddr.ip6addr,
852 &vp->vp_ipv6addr, sizeof(vp->vp_ipv6addr));
853 packet->src_ipaddr.prefix = 128;
857 vp = fr_pair_find_by_num(packet->vps, PW_PACKET_DST_IP_ADDRESS, 0, TAG_ANY);
859 packet->dst_ipaddr.af = AF_INET;
860 packet->dst_ipaddr.ipaddr.ip4addr.s_addr = vp->vp_ipaddr;
861 packet->dst_ipaddr.prefix = 32;
863 vp = fr_pair_find_by_num(packet->vps, PW_PACKET_DST_IPV6_ADDRESS, 0, TAG_ANY);
865 packet->dst_ipaddr.af = AF_INET6;
866 memcpy(&packet->dst_ipaddr.ipaddr.ip6addr,
867 &vp->vp_ipv6addr, sizeof(vp->vp_ipv6addr));
868 packet->dst_ipaddr.prefix = 128;
873 * Generate packet ID, ports, IP via a counter.
875 packet->id = data->counter & 0xff;
876 packet->src_port = 1024 + ((data->counter >> 8) & 0xff);
877 packet->dst_port = 1024 + ((data->counter >> 16) & 0xff);
879 packet->dst_ipaddr.af = AF_INET;
880 packet->dst_ipaddr.ipaddr.ip4addr.s_addr = htonl((INADDR_LOOPBACK & ~0xffffff) | ((data->counter >> 24) & 0xff));
883 * Create / update accounting attributes.
885 if (packet->code == PW_CODE_ACCOUNTING_REQUEST) {
887 * Prefer the Event-Timestamp in the packet, if it
888 * exists. That is when the event occurred, whereas the
889 * "Timestamp" field is when we wrote the packet to the
890 * detail file, which could have been much later.
892 vp = fr_pair_find_by_num(packet->vps, PW_EVENT_TIMESTAMP, 0, TAG_ANY);
894 data->timestamp = vp->vp_integer;
898 * Look for Acct-Delay-Time, and update
899 * based on Acct-Delay-Time += (time(NULL) - timestamp)
901 vp = fr_pair_find_by_num(packet->vps, PW_ACCT_DELAY_TIME, 0, TAG_ANY);
903 vp = fr_pair_afrom_num(packet, PW_ACCT_DELAY_TIME, 0);
904 rad_assert(vp != NULL);
905 fr_pair_add(&packet->vps, vp);
907 if (data->timestamp != 0) {
908 vp->vp_integer += time(NULL) - data->timestamp;
913 * Set the transmission count.
915 vp = fr_pair_find_by_num(packet->vps, PW_PACKET_TRANSMIT_COUNTER, 0, TAG_ANY);
917 vp = fr_pair_afrom_num(packet, PW_PACKET_TRANSMIT_COUNTER, 0);
918 rad_assert(vp != NULL);
919 fr_pair_add(&packet->vps, vp);
921 vp->vp_integer = data->tries;
923 data->state = STATE_RUNNING;
924 data->running = packet->timestamp.tv_sec;
930 * Free detail-specific stuff.
932 void detail_free(rad_listen_t *this)
934 listen_detail_t *data = this->data;
936 #ifdef WITH_DETAIL_THREAD
942 * Mark the child pipes as unusable
944 close(data->child_pipe[0]);
945 close(data->child_pipe[1]);
946 data->child_pipe[0] = -1;
949 * Tell it to stop (interrupting its sleep)
951 pthread_kill(data->pthread_id, SIGTERM);
954 * Wait for it to acknowledge that it's stopped.
956 ret = read(data->master_pipe[0], &arg, sizeof(arg));
958 ERROR("detail (%s): Reader thread exited without informing the master: %s",
959 data->name, fr_syserror(errno));
960 } else if (ret != sizeof(arg)) {
961 ERROR("detail (%s): Invalid thread pointer received from reader thread during exit",
963 ERROR("detail (%s): Expected %zu bytes, got %zi bytes", data->name, sizeof(arg), ret);
966 close(data->master_pipe[0]);
967 close(data->master_pipe[1]);
969 if (arg) pthread_join(data->pthread_id, &arg);
973 if (data->fp != NULL) {
980 int detail_print(rad_listen_t const *this, char *buffer, size_t bufsize)
983 return snprintf(buffer, bufsize, "%s",
984 ((listen_detail_t *)(this->data))->filename);
987 return snprintf(buffer, bufsize, "detail file %s as server %s",
988 ((listen_detail_t *)(this->data))->filename,
994 * Delay while waiting for a file to be ready
996 static int detail_delay(listen_detail_t *data)
998 int delay = (data->poll_interval - 1) * USEC;
1001 * Add +/- 0.25s of jitter
1003 delay += (USEC * 3) / 4;
1004 delay += fr_rand() % (USEC / 2);
1006 DEBUG2("detail (%s): Detail listener state %s waiting %d.%06d sec",
1008 fr_int2str(state_names, data->state, "?"),
1009 (delay / USEC), delay % USEC);
1015 * Overloaded to return delay times.
1017 int detail_encode(UNUSED rad_listen_t *this, UNUSED REQUEST *request)
1019 #ifdef WITH_DETAIL_THREAD
1022 listen_detail_t *data = this->data;
1025 * We haven't sent a packet... delay things a bit.
1027 if (!data->signal) return detail_delay(data);
1031 DEBUG2("detail (%s): Detail listener state %s signalled %d waiting %d.%06d sec",
1033 fr_int2str(state_names, data->state, "?"),
1035 data->delay_time / USEC,
1036 data->delay_time % USEC);
1038 return data->delay_time;
1043 * Overloaded to return "should we fix delay times"
1045 int detail_decode(rad_listen_t *this, REQUEST *request)
1047 #ifdef WITH_DETAIL_THREAD
1048 listen_detail_t *data = this->data;
1050 RDEBUG("Received %s from detail file %s",
1051 fr_packet_codes[request->packet->code], data->filename_work);
1053 rdebug_pair_list(L_DBG_LVL_1, request, request->packet->vps, "\t");
1057 listen_detail_t *data = this->data;
1059 RDEBUG("Received %s from detail file %s",
1060 fr_packet_codes[request->packet->code], data->filename_work);
1062 rdebug_pair_list(L_DBG_LVL_1, request, request->packet->vps, "\t");
1064 return data->signal;
1069 #ifdef WITH_DETAIL_THREAD
1070 static void *detail_handler_thread(void *arg)
1073 rad_listen_t *this = arg;
1074 listen_detail_t *data = this->data;
1077 RADIUS_PACKET *packet;
1079 while ((packet = detail_poll(this)) == NULL) {
1080 usleep(detail_delay(data));
1083 * If we're supposed to exit then tell
1084 * the master thread we've exited.
1086 if (data->child_pipe[0] < 0) {
1088 if (write(data->master_pipe[1], &packet, sizeof(packet)) < 0) {
1089 ERROR("detail (%s): Failed writing exit status to master: %s",
1090 data->name, fr_syserror(errno));
1097 * Keep retrying forever.
1099 * FIXME: cap the retries.
1102 if (write(data->master_pipe[1], &packet, sizeof(packet)) < 0) {
1103 ERROR("detail (%s): Failed passing detail packet pointer to master: %s",
1104 data->name, fr_syserror(errno));
1107 if (read(data->child_pipe[0], &c, 1) < 0) {
1108 ERROR("detail (%s): Failed getting detail packet ack from master: %s",
1109 data->name, fr_syserror(errno));
1113 if (data->delay_time > 0) usleep(data->delay_time);
1115 packet = detail_poll(this);
1117 } while (data->state != STATE_REPLIED);
1125 static const CONF_PARSER detail_config[] = {
1126 { "detail", FR_CONF_OFFSET(PW_TYPE_FILE_OUTPUT | PW_TYPE_DEPRECATED, listen_detail_t, filename), NULL },
1127 { "filename", FR_CONF_OFFSET(PW_TYPE_FILE_OUTPUT | PW_TYPE_REQUIRED, listen_detail_t, filename), NULL },
1128 { "load_factor", FR_CONF_OFFSET(PW_TYPE_INTEGER, listen_detail_t, load_factor), STRINGIFY(10) },
1129 { "poll_interval", FR_CONF_OFFSET(PW_TYPE_INTEGER, listen_detail_t, poll_interval), STRINGIFY(1) },
1130 { "retry_interval", FR_CONF_OFFSET(PW_TYPE_INTEGER, listen_detail_t, retry_interval), STRINGIFY(30) },
1131 { "one_shot", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, listen_detail_t, one_shot), "no" },
1132 { "track", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, listen_detail_t, track), "no" },
1133 CONF_PARSER_TERMINATOR
1137 * Parse a detail section.
1139 int detail_parse(CONF_SECTION *cs, rad_listen_t *this)
1142 listen_detail_t *data;
1148 rcode = cf_section_parse(cs, data, detail_config);
1150 cf_log_err_cs(cs, "Failed parsing listen section");
1154 data->name = cf_section_name2(cs);
1155 if (!data->name) data->name = data->filename;
1158 * We don't do duplicate detection for "detail" sockets.
1161 this->synchronous = false;
1163 if (!data->filename) {
1164 cf_log_err_cs(cs, "No detail file specified in listen section");
1168 FR_INTEGER_BOUND_CHECK("load_factor", data->load_factor, >=, 1);
1169 FR_INTEGER_BOUND_CHECK("load_factor", data->load_factor, <=, 100);
1171 FR_INTEGER_BOUND_CHECK("poll_interval", data->poll_interval, >=, 1);
1172 FR_INTEGER_BOUND_CHECK("poll_interval", data->poll_interval, <=, 60);
1174 FR_INTEGER_BOUND_CHECK("retry_interval", data->retry_interval, >=, 4);
1175 FR_INTEGER_BOUND_CHECK("retry_interval", data->retry_interval, <=, 3600);
1178 * Only checking the config. Don't start threads or anything else.
1180 if (check_config) return 0;
1183 * If the filename is a glob, use "detail.work" as the
1186 if ((strchr(data->filename, '*') != NULL) ||
1187 (strchr(data->filename, '[') != NULL)) {
1191 WARN("detail (%s): File \"%s\" appears to use file globbing, but it is not supported on this system",
1192 data->name, data->filename);
1194 strlcpy(buffer, data->filename, sizeof(buffer));
1195 p = strrchr(buffer, FR_DIR_SEP);
1203 * Globbing cannot be done across directories.
1205 if ((strchr(buffer, '*') != NULL) ||
1206 (strchr(buffer, '[') != NULL)) {
1207 cf_log_err_cs(cs, "Wildcard directories are not supported");
1211 strlcat(buffer, "detail.work",
1212 sizeof(buffer) - strlen(buffer));
1215 snprintf(buffer, sizeof(buffer), "%s.work", data->filename);
1218 data->filename_work = talloc_strdup(data, buffer);
1223 data->state = STATE_UNOPENED;
1224 data->delay_time = data->poll_interval * USEC;
1228 * Initialize the fake client.
1230 client = &data->detail_client;
1231 memset(client, 0, sizeof(*client));
1232 client->ipaddr.af = AF_INET;
1233 client->ipaddr.ipaddr.ip4addr.s_addr = INADDR_NONE;
1234 client->ipaddr.prefix = 0;
1235 client->longname = client->shortname = data->filename;
1236 client->secret = client->shortname;
1237 client->nas_type = talloc_strdup(data, "none"); /* Part of 'data' not dynamically allocated */
1239 #ifdef WITH_DETAIL_THREAD
1241 * Create the communication pipes.
1243 if (pipe(data->master_pipe) < 0) {
1244 ERROR("detail (%s): Error opening internal pipe: %s", data->name, fr_syserror(errno));
1248 if (pipe(data->child_pipe) < 0) {
1249 ERROR("detail (%s): Error opening internal pipe: %s", data->name, fr_syserror(errno));
1253 pthread_create(&data->pthread_id, NULL, detail_handler_thread, this);
1255 this->fd = data->master_pipe[0];