The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Loading...
Searching...
No Matches
proto_detail_file.c
Go to the documentation of this file.
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
15 */
16
17/**
18 * $Id: aeb23b0338e11cad24d047394f0665823e4eb7ea $
19 * @file proto_detail_file.c
20 * @brief Detail handler for files
21 *
22 * @copyright 2017 The FreeRADIUS server project.
23 * @copyright 2017 Alan DeKok (aland@deployingradius.com)
24 */
25
26#include <freeradius-devel/io/application.h>
27#include <freeradius-devel/io/listen.h>
28#include <freeradius-devel/io/schedule.h>
29
30#include <freeradius-devel/server/main_config.h>
31#include <freeradius-devel/server/protocol.h>
32
33#include <freeradius-devel/util/syserror.h>
34#include <freeradius-devel/util/misc.h>
35
36#include "proto_detail.h"
37
38#include <netdb.h>
39
40#include <fcntl.h>
41#include <sys/stat.h>
42
43#ifdef HAVE_GLOB_H
44#include <glob.h>
45#else
46#error proto_detail_file requires <glob.h>
47#endif
48
49DIAG_OFF(unused-macros)
50#if 0
51/*
52 * When we want detailed debugging here, without detailed server
53 * debugging.
54 */
55#define MPRINT DEBUG
56#else
57#define MPRINT DEBUG3
58#endif
59DIAG_ON(unused-macros)
60
61/*
62 * For talloc names, ".name = detail_file", and dl.c prepends "proto_", and appends "_t".
63 */
65
66/*
67 * @todo - this should really now be a different data structure
68 */
70
71static void work_init(proto_detail_file_thread_t *thread, bool triggered_by_delete);
72static void mod_vnode_delete(fr_event_list_t *el, int fd, UNUSED int fflags, void *ctx);
73
76
77 { FR_CONF_OFFSET("filename_work", proto_detail_file_t, filename_work ) },
78
79 { FR_CONF_OFFSET("poll_interval", proto_detail_file_t, poll_interval), .dflt = "5" },
80
81 { FR_CONF_OFFSET("immediate", proto_detail_file_t, immediate) },
82
84};
85
86
87/*
88 * All of the decoding is done by proto_detail and proto_detail_work
89 */
90static int mod_decode(void const *instance, request_t *request, uint8_t *const data, size_t data_len)
91{
93
94 return inst->parent->work_io->decode(inst->parent->work_io_instance, request, data, data_len);
95}
96
97#if 0
98static ssize_t mod_write(UNUSED fr_listen_t *li, UNUSED void *packet_ctx, UNUSED fr_time_t request_time,
99 UNUSED uint8_t *buffer, UNUSED size_t buffer_len, UNUSED size_t written)
100{
101#if 1
102 fr_assert(0);
103
104 return -1;
105#else
106 proto_detail_file_thread_t *thread = talloc_get_type_abort(li->thread_instance, proto_detail_file_thread_t);
107
108 return thread->listen->app_io->write(thread->listen, packet_ctx, request_time, buffer, buffer_len, written);
109#endif
110}
111#endif
112
114{
115 proto_detail_file_thread_t *thread = talloc_get_type_abort(li->thread_instance, proto_detail_file_thread_t);
116
117 bool has_worker = false;
118
119 pthread_mutex_lock(&thread->worker_mutex);
120 has_worker = (thread->num_workers != 0);
121 pthread_mutex_unlock(&thread->worker_mutex);
122
123 if (has_worker) return;
124
125 FR_TIMER_DISARM(thread->ev);
126
127 work_init(thread, false);
128}
129
130/** Open a detail listener
131 *
132 */
133static int mod_open(fr_listen_t *li)
134{
136 proto_detail_file_thread_t *thread = talloc_get_type_abort(li->thread_instance, proto_detail_file_thread_t);
137
138 if (inst->poll_interval == 0) {
139 int oflag;
140
141#ifdef O_EVTONLY
142 oflag = O_EVTONLY;
143#else
144 oflag = O_RDONLY;
145#endif
146 li->fd = thread->fd = open(inst->directory, oflag);
147 if (thread->fd < 0) {
148 cf_log_err(inst->cs, "Failed opening %s: %s", inst->directory, fr_syserror(errno));
149 return -1;
150 }
151 } else {
152 li->fd = thread->fd = -1;
153 li->non_socket_listener = true;
154 li->needs_full_setup = true;
155 }
156 thread->inst = inst;
157 thread->name = talloc_typed_asprintf(thread, "detail_file which will read files matching %s", inst->filename);
158 thread->vnode_fd = -1;
159 pthread_mutex_init(&thread->worker_mutex, NULL);
160
161 li->no_write_callback = true;
162
163 return 0;
164}
165
166/*
167 * The "detail.work" file doesn't exist. Let's see if we can rename one.
168 */
170{
171 proto_detail_file_t const *inst = thread->inst;
172 unsigned int i;
173 int found;
174 time_t chtime;
175 char const *filename;
176 glob_t files;
177 struct stat st;
178
179 DEBUG3("proto_detail (%s): polling for detail files in %s",
180 thread->name, inst->directory);
181
182 memset(&files, 0, sizeof(files));
183 if (glob(inst->filename, 0, NULL, &files) != 0) {
184 noop:
185 DEBUG3("proto_detail (%s): no matching files for %s",
186 thread->name, inst->filename);
187 globfree(&files);
188 return -1;
189 }
190
191 /*
192 * Loop over the glob'd files, looking for the
193 * oldest one.
194 */
195 chtime = 0;
196 found = -1;
197 for (i = 0; i < files.gl_pathc; i++) {
198 if (stat(files.gl_pathv[i], &st) < 0) continue;
199
200 if ((i == 0) || (st.st_ctime < chtime)) {
201 chtime = st.st_ctime;
202 found = i;
203 }
204 }
205
206 /*
207 * No matching files, reset the timer and continue.
208 */
209 if (found < 0) goto noop;
210
211 /*
212 * Rename detail to detail.work
213 */
214 filename = files.gl_pathv[found];
215
216 DEBUG("proto_detail (%s): Renaming %s -> %s", thread->name, filename, inst->filename_work);
217 if (rename(filename, inst->filename_work) < 0) {
218 ERROR("detail (%s): Failed renaming %s to %s: %s",
219 thread->name, filename, inst->filename_work, fr_syserror(errno));
220 goto noop;
221 }
222
223 globfree(&files); /* Shouldn't be using anything in files now */
224
225 /*
226 * The file should now exist, return the open'd FD.
227 */
228 return open(inst->filename_work, inst->mode);
229}
230
231/*
232 * Start polling again after a timeout.
233 */
234static void work_retry_timer(UNUSED fr_timer_list_t *tl, UNUSED fr_time_t now, void *uctx)
235{
236 proto_detail_file_thread_t *thread = talloc_get_type_abort(uctx, proto_detail_file_thread_t);
237
238 work_init(thread, false);
239}
240
241/*
242 * The "detail.work" file exists, and is open in the 'fd'.
243 */
244static int work_exists(proto_detail_file_thread_t *thread, int fd)
245{
246 proto_detail_file_t const *inst = thread->inst;
247 bool opened = false;
249 fr_listen_t *li = NULL;
250 struct stat st;
251
253
254 DEBUG3("proto_detail (%s): Trying to lock %s", thread->name, inst->filename_work);
255
256 /*
257 * "detail.work" exists, try to lock it.
258 */
259 if (rad_lockfd_nonblock(fd, 0) < 0) {
260 fr_time_delta_t delay;
261
262 DEBUG3("proto_detail (%s): Failed locking %s: %s",
263 thread->name, inst->filename_work, fr_syserror(errno));
264
265 close(fd);
266
267 delay = thread->lock_interval;
268
269 /*
270 * Set the next interval, and ensure that we
271 * don't do massive busy-polling.
272 */
278 }
279
280 DEBUG3("proto_detail (%s): Waiting %.6fs for lock on file %s",
281 thread->name, fr_time_delta_unwrap(delay) / (double)NSEC, inst->filename_work);
282
283 if (fr_timer_in(thread, thread->el->tl, &thread->ev, delay,
284 false, work_retry_timer, thread) < 0) {
285 ERROR("Failed inserting retry timer for %s", inst->filename_work);
286 }
287 return 0;
288 }
289
290 DEBUG3("proto_detail (%s): Obtained lock and starting to process file %s",
291 thread->name, inst->filename_work);
292
293 /*
294 * Ignore empty files.
295 */
296 if (fstat(fd, &st) < 0) {
297 ERROR("Failed opening %s: %s", inst->filename_work,
298 fr_syserror(errno));
299 unlink(inst->filename_work);
300 close(fd);
301 return 1;
302 }
303
304 if (!st.st_size) {
305 DEBUG3("proto_detail (%s): %s file is empty, ignoring it.",
306 thread->name, inst->filename_work);
307 unlink(inst->filename_work);
308 close(fd);
309 return 1;
310 }
311
312 /*
313 * This listener is allocated in a thread-specific
314 * context, so it doesn't need a destructor,
315 */
316 MEM(li = talloc_zero(NULL, fr_listen_t));
317
318 /*
319 * Create a new listener, and insert it into the
320 * scheduler. Shamelessly copied from proto_detail.c
321 * mod_open(), with changes.
322 *
323 * This listener is parented from the worker. So that
324 * when the worker goes away, so does the listener.
325 */
326 li->cs = inst->parent->work_io_conf;
327 li->app_io = inst->parent->work_io;
328
329 li->app = inst->parent->self;
330 li->app_instance = inst->parent;
331 li->server_cs = inst->parent->server_cs;
332
333 /*
334 * The worker may be in a different thread, so avoid
335 * talloc threading issues by using a NULL TALLOC_CTX.
336 */
337 MEM(li->thread_instance = work = talloc_zero(li, proto_detail_work_thread_t));
338
339 li->app_io_instance = inst->parent->work_io_instance;
340 work->inst = li->app_io_instance;
341 work->file_parent = thread;
342 work->ev = NULL;
343
344 li->fd = work->fd = dup(fd);
345 if (work->fd < 0) {
346 DEBUG("proto_detail (%s): Failed opening %s: %s",
347 thread->name, inst->filename_work, fr_syserror(errno));
348
349 close(fd);
350 talloc_free(li);
351 return -1;
352 }
353
354 /*
355 * Don't do anything until the file has been deleted.
356 *
357 * @todo - ensure that proto_detail_work is done the file...
358 * maybe by creating a new instance?
359 */
360 if (fr_event_filter_insert(thread, NULL, thread->el, fd, FR_EVENT_FILTER_VNODE,
361 &funcs, NULL, thread) < 0) {
362 PERROR("Failed adding work socket to event loop");
363 close(fd);
364 talloc_free(li);
365 return -1;
366 }
367
368 /*
369 * Remember this for later.
370 */
371 thread->vnode_fd = fd;
372
373 /*
374 * For us, this is the worker listener.
375 * For the worker, this is it's own parent
376 */
377 thread->listen = li;
378
379 work->filename_work = talloc_strdup(work, inst->filename_work);
380
381 /*
382 * Set configurable parameters for message ring buffer.
383 */
384 li->default_message_size = inst->parent->max_packet_size;
385 li->num_messages = inst->parent->num_messages;
386
387 pthread_mutex_lock(&thread->worker_mutex);
388 thread->num_workers++;
389 pthread_mutex_unlock(&thread->worker_mutex);
390
391 /*
392 * Open the detail.work file.
393 */
394 if (li->app_io->open(li) < 0) {
395 ERROR("Failed opening %s", li->app_io->common.name);
396 goto error;
397 }
398 opened = true;
399
401 li->name = li->app_io->get_name(li);
402
403 if (!fr_schedule_listen_add(inst->parent->sc, li)) {
404 error:
405 if (fr_event_fd_delete(thread->el, thread->vnode_fd, FR_EVENT_FILTER_VNODE) < 0) {
406 PERROR("Failed removing DELETE callback when opening work file");
407 }
408 close(thread->vnode_fd);
409 thread->vnode_fd = -1;
410
411 if (opened) {
412 (void) li->app_io->close(li);
413 thread->listen = NULL;
414 li = NULL;
415 }
416
417 talloc_free(li);
418 return -1;
419 }
420
421 /*
422 * Tell the worker to clean itself up.
423 */
424 work->listen = li;
425
426 return 0;
427}
428
429
430static void mod_vnode_delete(fr_event_list_t *el, int fd, UNUSED int fflags, void *ctx)
431{
432 proto_detail_file_thread_t *thread = talloc_get_type_abort(ctx, proto_detail_file_thread_t);
433 proto_detail_file_t const *inst = thread->inst;
434
435 DEBUG("proto_detail (%s): Deleted %s", thread->name, inst->filename_work);
436
437 /*
438 * Silently ignore notifications from the directory. We
439 * didn't ask for them, but libkqueue delivers them to
440 * us.
441 */
442 if (fd == thread->fd) return;
443
444 if (fd != thread->vnode_fd) {
445 ERROR("Received DELETE for FD %d, when we were expecting one on FD %d - ignoring it",
446 fd, thread->vnode_fd);
447 return;
448 }
449
451 PERROR("Failed removing DELETE callback after deletion");
452 }
453 close(fd);
454 thread->vnode_fd = -1;
455
456 /*
457 * Re-initialize the state machine.
458 *
459 * Note that a "delete" may be the result of an atomic
460 * "move", which both deletes the old file, and creates
461 * the new one.
462 */
463 work_init(thread, true);
464}
465
466
467/** Start processing a new work file
468 *
469 * @param[in] thread the thread instance.
470 * @param[in] triggered_by_delete true if this was triggered by a vnode_delete.
471 * When a new file is moved over a workfile
472 * vnode delete can serve as an indication
473 * that new data is available.
474 * It can also mean however, that the file
475 * has just been deleted, so we shouldn't
476 * treat this failure to open the new file
477 * as a fatal error.
478 */
479static void work_init(proto_detail_file_thread_t *thread, bool triggered_by_delete)
480{
481 proto_detail_file_t const *inst = thread->inst;
482 int fd, rcode;
483 bool has_worker;
484
485 pthread_mutex_lock(&thread->worker_mutex);
486 has_worker = (thread->num_workers != 0);
487 pthread_mutex_unlock(&thread->worker_mutex);
488
489 /*
490 * The worker is still processing the file, poll until
491 * it's done.
492 */
493 if (has_worker) {
494 DEBUG3("proto_detail (%s): worker %s is still alive, waiting for it to finish.",
495 thread->name, inst->filename_work);
496 goto delay;
497 }
498
499 fr_assert(thread->vnode_fd < 0);
500
501 /*
502 * See if there is a "detail.work" file. If not, try to
503 * rename an existing file to "detail.work".
504 */
505 DEBUG3("Trying to open %s", inst->filename_work);
506 fd = open(inst->filename_work, inst->mode);
507
508 /*
509 * If the work file didn't exist, try to rename detail* ->
510 * detail.work, and return the newly opened file.
511 */
512 if (fd < 0) {
513 if (errno != ENOENT) {
514 DEBUG("proto_detail (%s): Failed opening %s: %s",
515 thread->name, inst->filename_work,
516 fr_syserror(errno));
517 goto delay;
518 }
519
520retry:
521 fd = work_rename(thread);
522 }
523
524 /*
525 * The work file still doesn't exist. Go set up timers,
526 * or wait for an event which signals us that something
527 * in the directory changed.
528 */
529 if (fd < 0) {
530 /*
531 * Wait for the directory to change before
532 * looking for another "detail" file.
533 */
534 if (!inst->poll_interval) return;
535
536 /*
537 * File really was deleted, and didn't have
538 * anything moved over the top.
539 */
540 if (inst->immediate && triggered_by_delete) return;
541
542delay:
543 /*
544 * If we're processing one file and exiting, then the input file must exist.
545 */
546 if (inst->immediate && inst->parent->exit_when_done) {
547 ERROR("Input file does not exist");
548 fr_exit(EXIT_FAILURE);
549 }
550
551 /*
552 * Check every N seconds.
553 */
554 DEBUG3("Waiting %d.000000s for new files in %s", inst->poll_interval, thread->name);
555
556 if (fr_timer_in(thread, thread->el->tl, &thread->ev,
557 fr_time_delta_from_sec(inst->poll_interval),
558 false, work_retry_timer, thread) < 0) {
559 ERROR("Failed inserting poll timer for %s", inst->filename_work);
560 }
561 return;
562 }
563
565
566 /*
567 * It exists, go process it!
568 *
569 * We will get back to the main loop when the
570 * "detail.work" file is deleted.
571 */
572 rcode = work_exists(thread, fd);
573 if (rcode < 0) goto delay;
574
575 /*
576 * The file was empty, so we try to get another one.
577 */
578 if (rcode == 1) goto retry;
579
580 /*
581 * Otherwise the child is successfully processing the
582 * file.
583 */
584}
585
586
587/** Set the event list for a new IO instance
588 *
589 * @param[in] li the listener
590 * @param[in] el the event list
591 * @param[in] nr context from the network side
592 */
594{
596 proto_detail_file_thread_t *thread = talloc_get_type_abort(li->thread_instance, proto_detail_file_thread_t);
597
598 thread->el = el;
599
600 if (inst->immediate) {
601 work_init(thread, false);
602 return;
603 }
604
605 /*
606 * Delay for a bit, before reading the detail files.
607 * This gives the server time to call
608 * rad_suid_down_permanent(), and for /proc/PID to
609 * therefore change permissions, so that libkqueue can
610 * read it.
611 */
612 if (fr_timer_in(thread, thread->el->tl, &thread->ev,
613 fr_time_delta_from_sec(1), false, work_retry_timer, thread) < 0) {
614 ERROR("Failed inserting poll timer for %s", thread->filename_work);
615 }
616}
617
618
619static char const *mod_name(fr_listen_t *li)
620{
621 proto_detail_file_thread_t *thread = talloc_get_type_abort(li->thread_instance, proto_detail_file_thread_t);
622
623 return thread->name;
624}
625
626
628static pthread_mutex_t detail_file_mutex = PTHREAD_MUTEX_INITIALIZER;
629
630/** Compare two thread instances based on node pointer
631 *
632 * @param[in] one First thread specific xlat expansion instance.
633 * @param[in] two Second thread specific xlat expansion instance.
634 * @return CMP(one, two)
635 */
636static int8_t _detail_file_cmp(void const *one, void const *two)
637{
638 proto_detail_file_t const *a = one, *b = two;
639
640 return CMP(strcmp(a->filename, b->filename), 0);
641}
642
643/*
644 * Check for multiple readers on the same set of files.
645 */
646static int mod_instantiate(module_inst_ctx_t const *mctx)
647{
648 proto_detail_file_t *inst = talloc_get_type_abort(mctx->mi->data, proto_detail_file_t);
649 CONF_SECTION *conf = mctx->mi->conf;
650
651 module_instance_t const *mi;
652 char *p;
653
654#ifdef __linux__
655 /*
656 * The kqueue API takes an FD, but inotify requires a filename.
657 * libkqueue uses /proc/PID/fd/# to look up the FD -> filename mapping.
658 *
659 * However, if you start the server as "root", and then swap to "radiusd",
660 * /proc/PID will be owned by "root" for security reasons. The only way
661 * to make /proc/PID owned by "radiusd" is to set the DUMPABLE flag.
662 *
663 * Instead of making the poor sysadmin figure this out,
664 * we check for this situation, and give them a
665 * descriptive message telling them what to do.
666 */
668 main_config->uid_is_set &&
669 main_config->server_uid != 0) {
670 cf_log_err(conf, "Cannot start detail file reader due to Linux limitations.");
671 cf_log_err(conf, "Please set 'allow_core_dumps = true' in the main configuration file.");
672 return -1;
673 }
674#endif
675
676 /*
677 * Find the module_instance_t holding our instance data
678 * so we can find out what the parent of our instance
679 * was.
680 */
681 mi = mctx->mi;
682
683#ifndef __linux__
684 /*
685 * Linux inotify works. So we allow poll_interval==0
686 */
687 FR_INTEGER_BOUND_CHECK("poll_interval", inst->poll_interval, >=, 1);
688#endif
689 FR_INTEGER_BOUND_CHECK("poll_interval", inst->poll_interval, <=, 3600);
690
691 inst->parent = talloc_get_type_abort(mi->parent->data, proto_detail_t);
692 inst->cs = conf;
693
694 inst->directory = p = talloc_strdup(inst, inst->filename);
695
696 p = strrchr(p, '/');
697 if (!p) {
698 cf_log_err(conf, "Filename must contain '/'");
699 return -1;
700 }
701
702 *p = '\0';
703
704 if (!inst->filename_work) {
705 inst->filename_work = talloc_typed_asprintf(inst, "%s/detail.work", inst->directory);
706 }
707
708 /*
709 * We need this for the lock.
710 */
711 inst->mode = O_RDWR;
712
713 if (inst->parent->exit_when_done && !inst->immediate) {
714 cf_log_warn(conf, "Ignoring 'exit_when_done' due to 'immediate' flag not being set");
715 inst->parent->exit_when_done = false;
716 }
717
718 pthread_mutex_lock(&detail_file_mutex);
719 if (!detail_file_tree) {
721 if (!detail_file_tree) {
722 pthread_mutex_unlock(&detail_file_mutex);
723 cf_log_err(conf, "Failed initializing detail_file");
724 return -1;
725 }
726 }
727
729 proto_detail_file_t const *old;
730
732 fr_assert(old);
733
734 pthread_mutex_unlock(&detail_file_mutex);
735 cf_log_err(conf, "Duplicate detail listener %s", inst->filename);
736 cf_log_err(conf, "Original detail listener is in virtual server %s", cf_section_name2(old->parent->server_cs));
737 return -1;
738 }
739 pthread_mutex_unlock(&detail_file_mutex);
740
741 return 0;
742}
743
744
745static int mod_close(fr_listen_t *li)
746{
748 proto_detail_file_thread_t *thread = talloc_get_type_abort(li->thread_instance, proto_detail_file_thread_t);
749
750 if (thread->nr) {
751 if (unlikely(fr_network_listen_delete(thread->nr, inst->parent->listen) < 0)) {
752 PERROR("Failed removing listener from network on detach");
753 }
754 }
755
756 /*
757 * @todo - have our OWN event loop for timers, and a
758 * "copy timer from -> to, which means we only have to
759 * delete our child event loop from the parent on close.
760 */
761 if (thread->fd >= 0) close(thread->fd);
762
763 if (thread->vnode_fd >= 0) {
764 if (thread->nr) {
765 if (unlikely(fr_network_listen_delete(thread->nr, inst->parent->listen) < 0)) {
766 PERROR("Failed removing listener from network on detach");
767 }
768 } else {
769 if (fr_event_fd_delete(thread->el, thread->vnode_fd, FR_EVENT_FILTER_VNODE) < 0) {
770 PERROR("Failed removing DELETE callback on detach");
771 }
772 }
773 close(thread->vnode_fd);
774 thread->vnode_fd = -1;
775
776 pthread_mutex_destroy(&thread->worker_mutex);
777 }
778
779 return 0;
780}
781
782
783/** Private interface for use by proto_detail_file
784 *
785 */
788 .common = {
789 .magic = MODULE_MAGIC_INIT,
790 .name = "detail_file",
792 .inst_size = sizeof(proto_detail_file_t),
793 .thread_inst_size = sizeof(proto_detail_file_thread_t),
794 .instantiate = mod_instantiate,
795 },
796 .default_message_size = 65536,
797 .default_reply_size = 32,
798
799 .open = mod_open,
800 .close = mod_close,
801 .vnode = mod_vnode_extend,
802 .decode = mod_decode,
803// .write = mod_write,
804 .event_list_set = mod_event_list_set,
805 .get_name = mod_name,
806};
static int const char char buffer[256]
Definition acutest.h:578
fr_io_close_t close
Close the transport.
Definition app_io.h:60
fr_io_open_t open
Open a new socket for listening, or accept/connect a new connection.
Definition app_io.h:43
module_t common
Common fields to all loadable modules.
Definition app_io.h:34
fr_io_data_write_t write
Write from a data buffer to a socket.
Definition app_io.h:48
fr_io_name_t get_name
get the socket name
Definition app_io.h:70
Public structure describing an I/O path for a protocol.
Definition app_io.h:33
#define DIAG_ON(_x)
Definition build.h:462
#define CMP(_a, _b)
Same as CMP_PREFER_SMALLER use when you don't really care about ordering, you just want an ordering.
Definition build.h:112
#define unlikely(_x)
Definition build.h:383
#define UNUSED
Definition build.h:317
#define DIAG_OFF(_x)
Definition build.h:461
#define CONF_PARSER_TERMINATOR
Definition cf_parse.h:660
#define FR_INTEGER_BOUND_CHECK(_name, _var, _op, _bound)
Definition cf_parse.h:520
#define FR_CONF_OFFSET(_name, _struct, _field)
conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct
Definition cf_parse.h:283
#define FR_CONF_OFFSET_FLAGS(_name, _flags, _struct, _field)
conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct
Definition cf_parse.h:271
@ CONF_FLAG_REQUIRED
Error out if no matching CONF_PAIR is found, and no dflt value is set.
Definition cf_parse.h:432
Defines a CONF_PAIR to C data type mapping.
Definition cf_parse.h:597
A section grouping multiple CONF_PAIR.
Definition cf_priv.h:101
char const * cf_section_name2(CONF_SECTION const *cs)
Return the second identifier of a CONF_SECTION.
Definition cf_util.c:1184
#define cf_log_err(_cf, _fmt,...)
Definition cf_util.h:288
#define cf_log_warn(_cf, _fmt,...)
Definition cf_util.h:289
#define fr_exit(_x)
Exit, producing a log message in debug builds.
Definition debug.h:220
#define MEM(x)
Definition debug.h:36
#define ERROR(fmt,...)
Definition dhcpclient.c:41
#define DEBUG(fmt,...)
Definition dhcpclient.c:39
#define MODULE_MAGIC_INIT
Stop people using different module/library/server versions together.
Definition dl_module.h:63
@ FR_EVENT_FILTER_VNODE
Filter for vnode subfilters.
Definition event.h:85
#define fr_event_filter_insert(...)
Definition event.h:235
fr_event_fd_cb_t delete
The file was deleted.
Definition event.h:197
Callbacks for the FR_EVENT_FILTER_VNODE filter.
Definition event.h:196
talloc_free(hp)
size_t num_messages
for the message ring buffer
Definition listen.h:57
CONF_SECTION * cs
of this listener
Definition listen.h:41
bool non_socket_listener
special internal listener that does not use sockets.
Definition listen.h:47
char const * name
printable name for this socket - set by open
Definition listen.h:29
void const * app_instance
Definition listen.h:39
size_t default_message_size
copied from app_io, but may be changed
Definition listen.h:56
fr_app_t const * app
Definition listen.h:38
void const * app_io_instance
I/O path configuration context.
Definition listen.h:33
CONF_SECTION * server_cs
CONF_SECTION of the server.
Definition listen.h:42
void * thread_instance
thread / socket context
Definition listen.h:34
bool no_write_callback
sometimes we don't need to do writes
Definition listen.h:46
int fd
file descriptor for this socket - set by open
Definition listen.h:28
bool needs_full_setup
Set to true to avoid the short cut when adding the listener.
Definition listen.h:48
fr_app_io_t const * app_io
I/O path functions.
Definition listen.h:32
int fr_network_listen_delete(fr_network_t *nr, fr_listen_t *li)
Delete a socket from a network.
Definition network.c:271
#define PERROR(_fmt,...)
Definition log.h:228
#define DEBUG3(_fmt,...)
Definition log.h:266
int fr_event_fd_delete(fr_event_list_t *el, int fd, fr_event_filter_t filter)
Remove a file descriptor from the event loop.
Definition event.c:1203
Stores all information relating to an event list.
Definition event.c:377
main_config_t const * main_config
Main server configuration.
Definition main_config.c:58
bool allow_core_dumps
Whether the server is allowed to drop a core when receiving a fatal signal.
static ssize_t mod_write(fr_listen_t *li, void *packet_ctx, fr_time_t request_time, uint8_t *buffer, size_t buffer_len, size_t written)
Definition master.c:2339
unsigned int uint32_t
long int ssize_t
unsigned char uint8_t
int rad_lockfd_nonblock(int fd, int lock_len)
Definition misc.c:130
module_instance_t * mi
Instance of the module being instantiated.
Definition module_ctx.h:51
Temporary structure to hold arguments for instantiation calls.
Definition module_ctx.h:50
Detail master protocol handler.
proto_detail_t * parent
The module that spawned us!
proto_detail_work_thread_t * file_parent
thread instance of the directory reader that spawned us
fr_time_delta_t lock_interval
interval between trying the locks.
fr_listen_t * listen
talloc_parent() is slow
char const * filename
file name, usually with wildcards
CONF_SECTION * server_cs
server CS for this listener
char const * name
debug name for printing
int num_workers
number of workers
fr_timer_t * ev
for detail file timers.
fr_event_list_t * el
for various timers
pthread_mutex_t worker_mutex
for the workers
char const * filename_work
work file name
proto_detail_work_t const * inst
instance data
int fd
file descriptor
int vnode_fd
file descriptor for vnode_delete
fr_network_t * nr
for Linux-specific callbacks
static void mod_vnode_extend(fr_listen_t *li, UNUSED uint32_t fflags)
static const conf_parser_t file_listen_config[]
static void work_retry_timer(UNUSED fr_timer_list_t *tl, UNUSED fr_time_t now, void *uctx)
fr_app_io_t proto_detail_file
Private interface for use by proto_detail_file.
struct proto_detail_work_s proto_detail_file_t
static int8_t _detail_file_cmp(void const *one, void const *two)
Compare two thread instances based on node pointer.
static pthread_mutex_t detail_file_mutex
static int mod_decode(void const *instance, request_t *request, uint8_t *const data, size_t data_len)
static int work_rename(proto_detail_file_thread_t *thread)
static int mod_open(fr_listen_t *li)
Open a detail listener.
static fr_rb_tree_t * detail_file_tree
static void mod_event_list_set(fr_listen_t *li, fr_event_list_t *el, UNUSED void *nr)
Set the event list for a new IO instance.
static char const * mod_name(fr_listen_t *li)
static int mod_close(fr_listen_t *li)
static int mod_instantiate(module_inst_ctx_t const *mctx)
static void work_init(proto_detail_file_thread_t *thread, bool triggered_by_delete)
Start processing a new work file.
static void mod_vnode_delete(fr_event_list_t *el, int fd, UNUSED int fflags, void *ctx)
static int work_exists(proto_detail_file_thread_t *thread, int fd)
#define fr_assert(_expr)
Definition rad_assert.h:38
static rs_t * conf
Definition radsniff.c:53
void * fr_rb_find(fr_rb_tree_t const *tree, void const *data)
Find an element in the tree, returning the data, not the node.
Definition rb.c:577
bool fr_rb_insert(fr_rb_tree_t *tree, void const *data)
Insert data into a tree.
Definition rb.c:626
#define fr_rb_inline_talloc_alloc(_ctx, _type, _field, _data_cmp, _data_free)
Allocs a red black that verifies elements are of a specific talloc type.
Definition rb.h:246
The main red black tree structure.
Definition rb.h:73
fr_network_t * fr_schedule_listen_add(fr_schedule_t *sc, fr_listen_t *li)
Add a fr_listen_t to a scheduler.
Definition schedule.c:892
CONF_SECTION * conf
Module's instance configuration.
Definition module.h:349
void * data
Module's instance data.
Definition module.h:291
module_instance_t const * parent
Parent module's instance (if any).
Definition module.h:357
conf_parser_t const * config
How to convert a CONF_SECTION to a module instance.
Definition module.h:206
Module instance data.
Definition module.h:285
eap_aka_sim_process_conf_t * inst
char const * fr_syserror(int num)
Guaranteed to be thread-safe version of strerror.
Definition syserror.c:243
char * talloc_typed_asprintf(TALLOC_CTX *ctx, char const *fmt,...)
Call talloc vasprintf, setting the type on the new chunk correctly.
Definition talloc.c:515
#define talloc_get_type_abort_const
Definition talloc.h:245
static fr_time_delta_t fr_time_delta_from_msec(int64_t msec)
Definition time.h:575
static fr_time_delta_t fr_time_delta_add(fr_time_delta_t a, fr_time_delta_t b)
Definition time.h:255
static int64_t fr_time_delta_unwrap(fr_time_delta_t time)
Definition time.h:154
static fr_time_delta_t fr_time_delta_from_sec(int64_t sec)
Definition time.h:590
#define fr_time_delta_wrap(_time)
Definition time.h:152
#define NSEC
Definition time.h:379
static fr_time_delta_t fr_time_delta_div(fr_time_delta_t a, fr_time_delta_t b)
Definition time.h:267
#define fr_time_delta_gt(_a, _b)
Definition time.h:283
A time delta, a difference in time measured in nanoseconds.
Definition time.h:80
"server local" time.
Definition time.h:69
An event timer list.
Definition timer.c:50
#define fr_timer_in(...)
Definition timer.h:87
#define FR_TIMER_DISARM(_ev)
Definition timer.h:91
static fr_event_list_t * el
static fr_slen_t data
Definition value.h:1334