proto_detail_file.c File Reference

Detail handler for files. More...

#include <freeradius-devel/io/application.h>
#include <freeradius-devel/io/listen.h>
#include <freeradius-devel/io/schedule.h>
#include <freeradius-devel/server/main_config.h>
#include <freeradius-devel/server/protocol.h>
#include <freeradius-devel/util/syserror.h>
#include <freeradius-devel/util/misc.h>
#include "proto_detail.h"
#include <netdb.h>
#include <fcntl.h>
#include <sys/stat.h>

Include dependency graph for proto_detail_file.c:

Go to the source code of this file.

Macros
#define	MPRINT   DEBUG3

Typedefs
typedef struct proto_detail_work_s	proto_detail_file_t
typedef struct proto_detail_work_thread_s	proto_detail_file_thread_t

Functions
static int8_t	_detail_file_cmp (void const *one, void const *two)
	Compare two thread instances based on node pointer. More...
static int	mod_bootstrap (module_inst_ctx_t const *mctx)
static int	mod_close (fr_listen_t *li)
static int	mod_decode (void const *instance, request_t *request, uint8_t *const data, size_t data_len)
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. More...
static int	mod_instantiate (module_inst_ctx_t const *mctx)
static char const *	mod_name (fr_listen_t *li)
static int	mod_open (fr_listen_t *li)
	Open a detail listener. More...
static void	mod_vnode_delete (fr_event_list_t *el, int fd, UNUSED int fflags, void *ctx)
static void	mod_vnode_extend (fr_listen_t *li, UNUSED uint32_t fflags)
static int	work_exists (proto_detail_file_thread_t *thread, int fd)
static void	work_init (proto_detail_file_thread_t *thread, bool triggered_by_delete)
	Start processing a new work file. More...
static int	work_rename (proto_detail_file_thread_t *thread)
static void	work_retry_timer (UNUSED fr_event_list_t *el, UNUSED fr_time_t now, void *uctx)

Variables
static pthread_mutex_t	detail_file_mutex = PTHREAD_MUTEX_INITIALIZER
static fr_rb_tree_t *	detail_file_tree = NULL
static const conf_parser_t	file_listen_config []
fr_app_io_t	proto_detail_file
	Private interface for use by proto_detail_file. More...

Detailed Description

Detail handler for files.

Id

29172408413a11ca38822d0c84833e284007f060

Copyright

2017 The FreeRADIUS server project.

2017 Alan DeKok (aland.nosp@m.@dep.nosp@m.loyin.nosp@m.grad.nosp@m.ius.c.nosp@m.om)

Definition in file proto_detail_file.c.

Macro Definition Documentation

MPRINT

#define MPRINT   DEBUG3

Definition at line 57 of file proto_detail_file.c.

Typedef Documentation

proto_detail_file_t

typedef struct proto_detail_work_s proto_detail_file_t

Definition at line 1 of file proto_detail_file.c.

proto_detail_file_thread_t

typedef struct proto_detail_work_thread_s proto_detail_file_thread_t

Definition at line 1 of file proto_detail_file.c.

Function Documentation

_detail_file_cmp()

static int8_t _detail_file_cmp ( void const *  one, void const *  two  )

static

Compare two thread instances based on node pointer.

Parameters

[in]	one	First thread specific xlat expansion instance.
[in]	two	Second thread specific xlat expansion instance.

Returns

CMP(one, two)

Definition at line 709 of file proto_detail_file.c.

Here is the caller graph for this function:

mod_bootstrap()

static int mod_bootstrap ( module_inst_ctx_t const *  mctx )

static

Definition at line 625 of file proto_detail_file.c.

Here is the call graph for this function:

mod_close()

static int mod_close ( fr_listen_t *  li )

static

Definition at line 751 of file proto_detail_file.c.

Here is the call graph for this function:

mod_decode()

static int mod_decode ( void const *  instance, request_t *  request, uint8_t *const  data, size_t  data_len  )

static

Definition at line 90 of file proto_detail_file.c.

mod_event_list_set()

static void mod_event_list_set ( fr_listen_t *  li, fr_event_list_t *  el, UNUSED void *  nr  )

static

Set the event list for a new IO instance.

Parameters

[in]	li	the listener
[in]	el	the event list
[in]	nr	context from the network side

Definition at line 591 of file proto_detail_file.c.

Here is the call graph for this function:

mod_instantiate()

static int mod_instantiate ( module_inst_ctx_t const *  mctx )

static

Definition at line 719 of file proto_detail_file.c.

Here is the call graph for this function:

mod_name()

static char const* mod_name ( fr_listen_t *  li )

static

Definition at line 617 of file proto_detail_file.c.

mod_open()

static int mod_open ( fr_listen_t *  li )

static

Open a detail listener.

Definition at line 133 of file proto_detail_file.c.

Here is the call graph for this function:

mod_vnode_delete()

static void mod_vnode_delete ( fr_event_list_t *  el, int  fd, UNUSED int  fflags, void *  ctx  )

static

Definition at line 429 of file proto_detail_file.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_vnode_extend()

static void mod_vnode_extend ( fr_listen_t *  li, UNUSED uint32_t  fflags  )

static

Definition at line 113 of file proto_detail_file.c.

Here is the call graph for this function:

work_exists()

static int work_exists ( proto_detail_file_thread_t *  thread, int  fd  )

static

Definition at line 244 of file proto_detail_file.c.

Here is the call graph for this function:

Here is the caller graph for this function:

work_init()

static void work_init ( proto_detail_file_thread_t *  thread, bool  triggered_by_delete  )

static

Start processing a new work file.

Parameters

[in]	thread	the thread instance.
[in]	triggered_by_delete	true if this was triggered by a vnode_delete. When a new file is moved over a workfile vnode delete can serve as an indication that new data is available. It can also mean however, that the file has just been deleted, so we shouldn't treat this failure to open the new file as a fatal error.

Definition at line 478 of file proto_detail_file.c.

Here is the call graph for this function:

Here is the caller graph for this function:

work_rename()

static int work_rename ( proto_detail_file_thread_t *  thread )

static

Definition at line 169 of file proto_detail_file.c.

Here is the call graph for this function:

Here is the caller graph for this function:

work_retry_timer()

static void work_retry_timer ( UNUSED fr_event_list_t *  el, UNUSED fr_time_t  now, void *  uctx  )

static

Definition at line 234 of file proto_detail_file.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

detail_file_mutex

pthread_mutex_t detail_file_mutex = PTHREAD_MUTEX_INITIALIZER

static

Definition at line 701 of file proto_detail_file.c.

detail_file_tree

fr_rb_tree_t* detail_file_tree = NULL

static

Definition at line 700 of file proto_detail_file.c.

file_listen_config

const conf_parser_t file_listen_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_FLAGS("filename", CONF_FLAG_REQUIRED, proto_detail_file_t, filename ) },
 
        { FR_CONF_OFFSET("filename_work", proto_detail_file_t, filename_work ) },
 
        { FR_CONF_OFFSET("poll_interval", proto_detail_file_t, poll_interval), .dflt = "5" },
 
        { FR_CONF_OFFSET("immediate", proto_detail_file_t, immediate) },
 
        CONF_PARSER_TERMINATOR
}

Definition at line 74 of file proto_detail_file.c.

proto_detail_file

fr_app_io_t proto_detail_file

Initial value:

= {
        .common = {
                .magic                  = MODULE_MAGIC_INIT,
                .name                   = "detail_file",
                .config                 = file_listen_config,
                .inst_size              = sizeof(proto_detail_file_t),
                .thread_inst_size       = sizeof(proto_detail_file_thread_t),
                .bootstrap              = mod_bootstrap,
                .instantiate            = mod_instantiate,
        },
        .default_message_size   = 65536,
        .default_reply_size     = 32,
 
        .open                   = mod_open,
        .close                  = mod_close,
        .vnode                  = mod_vnode_extend,
        .decode                 = mod_decode,
 
        .event_list_set         = mod_event_list_set,
        .get_name               = mod_name,
}

Private interface for use by proto_detail_file.

Definition at line 787 of file proto_detail_file.c.