proto_cron_crontab.c File Reference

Generate crontab events. More...

#include <netdb.h>
#include <fcntl.h>
#include <freeradius-devel/server/protocol.h>
#include <freeradius-devel/io/application.h>
#include <freeradius-devel/io/listen.h>
#include <freeradius-devel/io/schedule.h>
#include <freeradius-devel/util/skip.h>
#include <freeradius-devel/server/cf_util.h>
#include "proto_cron.h"

Include dependency graph for proto_cron_crontab.c:

Go to the source code of this file.

Data Structures
struct	cron_tab_t
struct	proto_cron_crontab_thread_t
struct	proto_cron_tab_s

Typedefs
typedef struct proto_cron_tab_s	proto_cron_crontab_t

Functions
static void	do_cron (fr_timer_list_t *tl, fr_time_t now, void *uctx)
static bool	get_next (struct tm *tm, cron_tab_t const *tab)
static fr_client_t *	mod_client_find (fr_listen_t *li, UNUSED fr_ipaddr_t const *ipaddr, UNUSED int ipproto)
static int	mod_decode (void const *instance, request_t *request, UNUSED uint8_t *const data, UNUSED size_t data_len)
	Decode the packet.
static void	mod_event_list_set (fr_listen_t *li, fr_event_list_t *el, void *nr)
	Set the event list for a new socket.
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 crontab listener.
static ssize_t	mod_read (fr_listen_t *li, void **packet_ctx, fr_time_t *recv_time_p, uint8_t *buffer, size_t buffer_len, size_t *leftover)
static ssize_t	mod_write (UNUSED fr_listen_t *li, UNUSED void *packet_ctx, UNUSED fr_time_t request_time, UNUSED uint8_t *buffer, size_t buffer_len, UNUSED size_t written)
static int	parse_field (CONF_ITEM *ci, char const **start, char const *name, cron_tab_t *tab, unsigned int min, unsigned int max, size_t offset)
static int	time_parse (TALLOC_CTX *ctx, void *out, UNUSED void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
static int	time_parse (UNUSED TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, UNUSED conf_parser_t const *rule)
	Checks the syntax of a cron job.

Variables
static const conf_parser_t	crontab_listen_config []
fr_app_io_t	proto_cron_crontab
static fr_table_ptr_sorted_t	time_names []
static size_t	time_names_len = NUM_ELEMENTS(time_names)

Detailed Description

Generate crontab events.

Id

b2f11508040cc5f1b4059be6bc47624c16a4314e

Copyright

2021 Network RADIUS SAS (legal.nosp@m.@net.nosp@m.workr.nosp@m.adiu.nosp@m.s.com)

Definition in file proto_cron_crontab.c.

---

Data Structure Documentation

cron_tab_t

struct cron_tab_t

Definition at line 3 of file cron.h.

Data Fields
uint64_t	fields
unsigned int	max
unsigned int	min
size_t	offset
bool	wildcard

proto_cron_crontab_thread_t

struct proto_cron_crontab_thread_t

Definition at line 39 of file proto_cron_crontab.c.

Collaboration diagram for proto_cron_crontab_thread_t:

Data Fields
bool	bootstrap	get it started
fr_event_list_t *	el	event list
fr_timer_t *	ev	for writing statistics
proto_cron_crontab_t const *	inst
char const *	name	socket name
fr_network_t *	nr	network handler
fr_listen_t *	parent	master IO handler
fr_time_t	recv_time	when the timer hit.
bool	suspended	we suspend reading from the FD.

proto_cron_tab_s

struct proto_cron_tab_s

Definition at line 67 of file proto_cron_crontab.c.

Collaboration diagram for proto_cron_tab_s:

Data Fields
fr_client_t *	client	static client
int	code
CONF_SECTION *	cs	our configuration
fr_dict_t const *	dict	our namespace.
char const *	filename	where to read input packet from
fr_pair_list_t	pair_list	for input packet
proto_cron_t *	parent
char const *	spec	crontab spec
cron_tab_t	tab[5]

Typedef Documentation

proto_cron_crontab_t

typedef struct proto_cron_tab_s proto_cron_crontab_t

Definition at line 37 of file proto_cron_crontab.c.

Function Documentation

do_cron()

static void do_cron ( fr_timer_list_t *  tl, fr_time_t  now, void *  uctx  )

static

Definition at line 516 of file proto_cron_crontab.c.

Here is the call graph for this function:

Here is the caller graph for this function:

get_next()

static bool get_next ( struct tm *  tm, cron_tab_t const *  tab  )

static

Definition at line 472 of file proto_cron_crontab.c.

Here is the caller graph for this function:

mod_client_find()

static fr_client_t * mod_client_find ( fr_listen_t *  li, UNUSED fr_ipaddr_t const *  ipaddr, UNUSED int  ipproto  )

static

Definition at line 676 of file proto_cron_crontab.c.

mod_decode()

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

static

Decode the packet.

Definition at line 432 of file proto_cron_crontab.c.

Here is the call graph for this function:

mod_event_list_set()

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

static

Set the event list for a new socket.

Parameters

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

Definition at line 656 of file proto_cron_crontab.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 683 of file proto_cron_crontab.c.

Here is the call graph for this function:

mod_name()

static char const * mod_name ( fr_listen_t *  li )

static

Definition at line 669 of file proto_cron_crontab.c.

mod_open()

static int mod_open ( fr_listen_t *  li )

static

Open a crontab listener.

Definition at line 402 of file proto_cron_crontab.c.

Here is the call graph for this function:

mod_read()

static ssize_t mod_read ( fr_listen_t *  li, void **  packet_ctx, fr_time_t *  recv_time_p, uint8_t *  buffer, size_t  buffer_len, size_t *  leftover  )

static

Definition at line 332 of file proto_cron_crontab.c.

mod_write()

static ssize_t mod_write ( UNUSED fr_listen_t *  li, UNUSED void *  packet_ctx, UNUSED fr_time_t  request_time, UNUSED uint8_t *  buffer, size_t  buffer_len, UNUSED size_t  written  )

static

Definition at line 392 of file proto_cron_crontab.c.

parse_field()

static int parse_field ( CONF_ITEM *  ci, char const **  start, char const *  name, cron_tab_t *  tab, unsigned int  min, unsigned int  max, size_t  offset  )

static

Definition at line 100 of file proto_cron_crontab.c.

Here is the call graph for this function:

Here is the caller graph for this function:

time_parse() [1/2]

static int time_parse ( TALLOC_CTX *  ctx, void *  out, UNUSED void *  parent, CONF_ITEM *  ci, conf_parser_t const *  rule  )

static

time_parse() [2/2]

static int time_parse ( UNUSED TALLOC_CTX *  ctx, void *  out, void *  parent, CONF_ITEM *  ci, UNUSED conf_parser_t const *  rule  )

static

Checks the syntax of a cron job.

Parameters

[in]	ctx	to allocate data in (instance of proto_cron).
[out]	out	Where to write a module_instance_t containing the module handle and instance.
[in]	parent	Base structure address.
[in]	ci	CONF_PAIR specifying the name of the type module.
[in]	rule	unused.

Returns

• 0 on success.
• -1 on failure.

Definition at line 287 of file proto_cron_crontab.c.

Here is the call graph for this function:

Variable Documentation

crontab_listen_config

const conf_parser_t crontab_listen_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_FLAGS("filename", CONF_FLAG_FILE_READABLE | CONF_FLAG_REQUIRED | CONF_FLAG_NOT_EMPTY, proto_cron_crontab_t, filename) },
 
        { FR_CONF_OFFSET_FLAGS("timespec", CONF_FLAG_NOT_EMPTY | CONF_FLAG_REQUIRED, proto_cron_crontab_t, spec),
                        .func = time_parse },
 
        CONF_PARSER_TERMINATOR
}

Definition at line 88 of file proto_cron_crontab.c.

proto_cron_crontab

fr_app_io_t proto_cron_crontab

Initial value:

= {
        .common = {
                .magic                  = MODULE_MAGIC_INIT,
                .name                   = "cron_crontab",
                .config                 = crontab_listen_config,
                .inst_size              = sizeof(proto_cron_crontab_t),
                .thread_inst_size       = sizeof(proto_cron_crontab_thread_t),
                .instantiate            = mod_instantiate
        },
        .default_message_size   = 4096,
        .track_duplicates       = false,
 
        .open                   = mod_open,
        .read                   = mod_read,
        .write                  = mod_write,
        .event_list_set         = mod_event_list_set,
        .client_find            = mod_client_find,
        .get_name               = mod_name,
 
        .decode                 = mod_decode,
}

Definition at line 733 of file proto_cron_crontab.c.

time_names

fr_table_ptr_sorted_t time_names[]

static

Initial value:

= {
        { L("annually"),        "0 0 1 1 *" },
        { L("daily"),           "0 0 * * *" },
        { L("hourly"),          "0 * * * *" },
        { L("midnight"),        "0 0 * * *" },
        { L("monthly"),         "0 0 1 * *" },
 
        { L("weekly"),          "0 0 * * 0" },
        { L("yearly"),          "0 0 1 1 *" },
}

Definition at line 264 of file proto_cron_crontab.c.

time_names_len

size_t time_names_len = NUM_ELEMENTS(time_names)

static

Definition at line 274 of file proto_cron_crontab.c.