cron.c File Reference

#include <freeradius-devel/server/base.h>
#include <freeradius-devel/io/listen.h>
#include <freeradius-devel/unlang/base.h>
#include <freeradius-devel/util/debug.h>
#include "proto_cron.h"

Include dependency graph for cron.c:

Go to the source code of this file.

Functions
static int	mod_instantiate (void *instance, CONF_SECTION *conf)
	Instantiate the application.
static int	mod_open (void *instance, fr_schedule_t *sc, UNUSED CONF_SECTION *conf)
	Open listen sockets/connect to external event source.
static int	parse_field (CONF_ITEM *ci, char const **start, char const *name, unsigned int min, unsigned int max)
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, UNUSED void *parent, CONF_ITEM *ci, UNUSED conf_parser_t const *rule)
	Checks the syntax of a cron job.
static int	type_parse (TALLOC_CTX *ctx, void *out, UNUSED void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
static int	type_parse (UNUSED TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, UNUSED conf_parser_t const *rule)
	Translates the packet-type into a submodule name.

Variables
static fr_dict_t const *	dict_cron
static conf_parser_t const	limit_config []
fr_app_t	proto_cron
static conf_parser_t const	proto_cron_config []
	How to parse a CRON listen section.
fr_dict_autoload_t	proto_cron_dict []
static fr_table_ptr_sorted_t	time_names []
static size_t	time_names_len = NUM_ELEMENTS(time_names)

Function Documentation

mod_instantiate()

static int mod_instantiate ( void *  instance, CONF_SECTION *  conf  )

static

Instantiate the application.

Instantiate I/O and type submodules.

Parameters

[in]	instance	Ctx data for this application.
[in]	conf	Listen section parsed to give us instance.

Returns

• 0 on success.
• -1 on failure.

Definition at line 395 of file cron.c.

Here is the call graph for this function:

mod_open()

static int mod_open ( void *  instance, fr_schedule_t *  sc, UNUSED CONF_SECTION *  conf  )

static

Open listen sockets/connect to external event source.

Parameters

[in]	instance	Ctx data for this application.
[in]	sc	to add our file descriptor to.
[in]	conf	Listen section parsed to give us instance.

Returns

• 0 on success.
• -1 on failure.

Definition at line 334 of file cron.c.

Here is the call graph for this function:

parse_field()

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

static

Definition at line 124 of file cron.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, UNUSED 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.

https://github.com/staticlibs/ccronexpr/blob/master/ccronexpr.c

Definition at line 279 of file cron.c.

Here is the call graph for this function:

type_parse() [1/2]

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

static

type_parse() [2/2]

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

static

Translates the packet-type into a submodule name.

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 81 of file cron.c.

Here is the call graph for this function:

Variable Documentation

dict_cron

fr_dict_t const* dict_cron

static

Definition at line 62 of file cron.c.

limit_config

conf_parser_t const limit_config[]

static

Initial value:

= {
        
        { FR_CONF_OFFSET("max_packet_size", proto_cron_t, max_packet_size) } ,
        { FR_CONF_OFFSET("num_messages", proto_cron_t, num_messages) } ,
 
        CONF_PARSER_TERMINATOR
}

Definition at line 34 of file cron.c.

proto_cron

fr_app_t proto_cron

Initial value:

= {
        .magic                  = RLM_MODULE_INIT,
        .name                   = "cron",
        .config                 = proto_cron_config,
        .inst_size              = sizeof(proto_cron_t),
 
        .instantiate            = mod_instantiate,
        .open                   = mod_open,
}

Definition at line 436 of file cron.c.

proto_cron_config

conf_parser_t const proto_cron_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_TYPE_FLAGS("type", FR_TYPE_VOID, CONF_FLAG_NOT_EMPTY | CONF_FLAG_REQUIRED, proto_cron_t,
                          type), .func = type_parse },
 
        { FR_CONF_OFFSET_FLAGS("when", CONF_FLAG_NOT_EMPTY | CONF_FLAG_REQUIRED, proto_cron_t, spec),
                        .func = time_parse },
 
        { FR_CONF_OFFSET_FLAGS("filename", CONF_FLAG_FILE_READABLE | CONF_FLAG_REQUIRED | CONF_FLAG_NOT_EMPTY, proto_cron_t, filename ) },
 
        { FR_CONF_OFFSET("priority", proto_cron_t, priority) },
 
        { FR_CONF_POINTER("limit", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) limit_config },
        CONF_PARSER_TERMINATOR
}

How to parse a CRON listen section.

Definition at line 47 of file cron.c.

proto_cron_dict

fr_dict_autoload_t proto_cron_dict

Initial value:

= {
        { .out = &dict_cron, .proto = "freeradius" },
        DICT_AUTOLOAD_TERMINATOR
}

Definition at line 65 of file cron.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("reboot"),          "+" },
        { L("shutdown"),        "-" },
        { L("startup"),         "+" },
        { L("weekly"),          "0 0 * * 0" },
        { L("yearly"),          "0 0 1 1 *" },
}

Definition at line 252 of file cron.c.

time_names_len

size_t time_names_len = NUM_ELEMENTS(time_names)

static

Definition at line 264 of file cron.c.