The FreeRADIUS server  $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Functions | Variables
proto_vmps.c File Reference

VMPS master protocol handler. More...

#include <freeradius-devel/io/listen.h>
#include <freeradius-devel/protocol/vmps/vmps.h>
#include <freeradius-devel/server/module_rlm.h>
#include <freeradius-devel/util/debug.h>
#include "proto_vmps.h"
+ Include dependency graph for proto_vmps.c:

Go to the source code of this file.

Functions

static int mod_decode (UNUSED void const *instance, request_t *request, uint8_t *const data, size_t data_len)
 Decode the packet. More...
 
static ssize_t mod_encode (UNUSED void const *instance, request_t *request, uint8_t *buffer, size_t buffer_len)
 
static int mod_instantiate (module_inst_ctx_t const *mctx)
 Instantiate the application. More...
 
static int mod_load (void)
 
static int mod_open (void *instance, fr_schedule_t *sc, UNUSED CONF_SECTION *conf)
 Open listen sockets/connect to external event source. More...
 
static int mod_priority_set (void const *instance, uint8_t const *buffer, UNUSED size_t buflen)
 
static void mod_unload (void)
 
static int transport_parse (TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
 
static int type_parse (TALLOC_CTX *ctx, void *out, 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. More...
 

Variables

static fr_dict_attr_t const * attr_packet_type
 
static fr_dict_t const * dict_vmps
 
static conf_parser_t const limit_config []
 
static const conf_parser_t priority_config []
 
fr_app_t proto_vmps
 
static conf_parser_t const proto_vmps_config []
 How to parse a VMPS listen section. More...
 
fr_dict_autoload_t proto_vmps_dict []
 
fr_dict_attr_autoload_t proto_vmps_dict_attr []
 

Detailed Description

VMPS master protocol handler.

Id
751b7447f68165a0b6562f88197187c71fdd5c90
Copyright
2017 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)
2016 Alan DeKok (aland.nosp@m.@fre.nosp@m.eradi.nosp@m.us.o.nosp@m.rg)

Definition in file proto_vmps.c.

Function Documentation

◆ mod_decode()

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

Decode the packet.

Definition at line 144 of file proto_vmps.c.

+ Here is the call graph for this function:

◆ mod_encode()

static ssize_t mod_encode ( UNUSED void const *  instance,
request_t *  request,
uint8_t *  buffer,
size_t  buffer_len 
)
static

Definition at line 203 of file proto_vmps.c.

+ Here is the call graph for this function:

◆ mod_instantiate()

static int mod_instantiate ( module_inst_ctx_t const *  mctx)
static

Instantiate the application.

Instantiate I/O and type submodules.

Returns
  • 0 on success.
  • -1 on failure.

Definition at line 329 of file proto_vmps.c.

+ Here is the call graph for this function:

◆ mod_load()

static int mod_load ( void  )
static

Definition at line 393 of file proto_vmps.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]instanceCtx data for this application.
[in]scto add our file descriptor to.
[in]confListen section parsed to give us instance.
Returns
  • 0 on success.
  • -1 on failure.

Definition at line 310 of file proto_vmps.c.

+ Here is the call graph for this function:

◆ mod_priority_set()

static int mod_priority_set ( void const *  instance,
uint8_t const *  buffer,
UNUSED size_t  buflen 
)
static

Definition at line 279 of file proto_vmps.c.

◆ mod_unload()

static void mod_unload ( void  )
static

Definition at line 403 of file proto_vmps.c.

+ Here is the call graph for this function:

◆ transport_parse()

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

Definition at line 124 of file proto_vmps.c.

+ Here is the call graph for this function:

◆ type_parse() [1/2]

static int type_parse ( TALLOC_CTX *  ctx,
void *  out,
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]ctxto allocate data in (instance of proto_vmps).
[out]outWhere to write a module_instance_t containing the module handle and instance.
[in]parentBase structure address.
[in]ciCONF_PAIR specifying the name of the type module.
[in]ruleunused.
Returns
  • 0 on success.
  • -1 on failure.

Definition at line 101 of file proto_vmps.c.

+ Here is the call graph for this function:

Variable Documentation

◆ attr_packet_type

fr_dict_attr_t const* attr_packet_type
static

Definition at line 82 of file proto_vmps.c.

◆ dict_vmps

fr_dict_t const* dict_vmps
static

Definition at line 74 of file proto_vmps.c.

◆ limit_config

conf_parser_t const limit_config[]
static
Initial value:
= {
{ FR_CONF_OFFSET("idle_timeout", proto_vmps_t, io.idle_timeout), .dflt = "30.0" } ,
{ FR_CONF_OFFSET("nak_lifetime", proto_vmps_t, io.nak_lifetime), .dflt = "30.0" } ,
{ FR_CONF_OFFSET("max_connections", proto_vmps_t, io.max_connections), .dflt = "1024" } ,
{ FR_CONF_OFFSET("max_clients", proto_vmps_t, io.max_clients), .dflt = "256" } ,
{ FR_CONF_OFFSET("max_pending_packets", proto_vmps_t, io.max_pending_packets), .dflt = "256" } ,
{ FR_CONF_OFFSET("max_packet_size", proto_vmps_t, max_packet_size) } ,
{ FR_CONF_OFFSET("num_messages", proto_vmps_t, num_messages) } ,
CONF_PARSER_TERMINATOR
}
CONF_PARSER_TERMINATOR
#define CONF_PARSER_TERMINATOR
Definition: cf_parse.h:627
FR_CONF_OFFSET
#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:268
proto_vmps_t
An instance of a proto_vmps listen section.
Definition: proto_vmps.h:32

Definition at line 45 of file proto_vmps.c.

◆ priority_config

const conf_parser_t priority_config[]
static
Initial value:
= {
{ FR_CONF_OFFSET("Join-Request", proto_vmps_t, priorities[FR_PACKET_TYPE_VALUE_JOIN_REQUEST]),
.func = cf_table_parse_int, .uctx = &(cf_table_parse_ctx_t){ .table = channel_packet_priority, .len = &channel_packet_priority_len }, .dflt = "low" },
{ FR_CONF_OFFSET("Reconfirm-Request", proto_vmps_t, priorities[FR_PACKET_TYPE_VALUE_RECONFIRM_REQUEST]),
.func = cf_table_parse_int, .uctx = &(cf_table_parse_ctx_t){ .table = channel_packet_priority, .len = &channel_packet_priority_len }, .dflt = "low" },
CONF_PARSER_TERMINATOR
}
cf_table_parse_int
int cf_table_parse_int(UNUSED TALLOC_CTX *ctx, void *out, UNUSED void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
Generic function for parsing conf pair values as int.
Definition: cf_parse.c:1474
cf_table_parse_ctx_t
Definition: cf_parse.h:622
channel_packet_priority_len
size_t channel_packet_priority_len
Definition: channel.c:170
channel_packet_priority
fr_table_num_sorted_t const channel_packet_priority[]
Definition: channel.c:164

Definition at line 36 of file proto_vmps.c.

◆ proto_vmps

fr_app_t proto_vmps
Initial value:
= {
.common = {
.magic = MODULE_MAGIC_INIT,
.name = "vmps",
.config = proto_vmps_config,
.inst_size = sizeof(proto_vmps_t),
.onload = mod_load,
.unload = mod_unload,
.instantiate = mod_instantiate
},
.dict = &dict_vmps,
.open = mod_open,
.decode = mod_decode,
.encode = mod_encode,
.priority = mod_priority_set
}
MODULE_MAGIC_INIT
#define MODULE_MAGIC_INIT
Stop people using different module/library/server versions together.
Definition: dl_module.h:63
mod_load
static int mod_load(void)
Definition: proto_vmps.c:393
mod_encode
static ssize_t mod_encode(UNUSED void const *instance, request_t *request, uint8_t *buffer, size_t buffer_len)
Definition: proto_vmps.c:203
mod_unload
static void mod_unload(void)
Definition: proto_vmps.c:403
mod_decode
static int mod_decode(UNUSED void const *instance, request_t *request, uint8_t *const data, size_t data_len)
Decode the packet.
Definition: proto_vmps.c:144
proto_vmps_config
static conf_parser_t const proto_vmps_config[]
How to parse a VMPS listen section.
Definition: proto_vmps.c:65
mod_instantiate
static int mod_instantiate(module_inst_ctx_t const *mctx)
Instantiate the application.
Definition: proto_vmps.c:329
mod_open
static int mod_open(void *instance, fr_schedule_t *sc, UNUSED CONF_SECTION *conf)
Open listen sockets/connect to external event source.
Definition: proto_vmps.c:310
mod_priority_set
static int mod_priority_set(void const *instance, uint8_t const *buffer, UNUSED size_t buflen)
Definition: proto_vmps.c:279
dict_vmps
static fr_dict_t const * dict_vmps
Definition: proto_vmps.c:74
instantiate
static int instantiate(module_inst_ctx_t const *mctx)
Definition: rlm_rest.c:1302

Definition at line 408 of file proto_vmps.c.

◆ proto_vmps_config

conf_parser_t const proto_vmps_config[]
static
Initial value:
= {
{ FR_CONF_OFFSET_FLAGS("type", CONF_FLAG_NOT_EMPTY, proto_vmps_t, allowed_types), .func = type_parse },
{ FR_CONF_OFFSET_TYPE_FLAGS("transport", FR_TYPE_VOID, 0, proto_vmps_t, io.submodule), .func = transport_parse },
{ FR_CONF_POINTER("limit", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) limit_config },
{ FR_CONF_POINTER("priority", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) priority_config },
CONF_PARSER_TERMINATOR
}
FR_CONF_POINTER
#define FR_CONF_POINTER(_name, _type, _flags, _res_p)
conf_parser_t which parses a single CONF_PAIR producing a single global result
Definition: cf_parse.h:310
FR_CONF_OFFSET_FLAGS
#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:256
CONF_FLAG_NOT_EMPTY
@ CONF_FLAG_NOT_EMPTY
CONF_PAIR is required to have a non zero length value.
Definition: cf_parse.h:420
CONF_FLAG_SUBSECTION
@ CONF_FLAG_SUBSECTION
Instead of putting the information into a configuration structure, the configuration file routines MA...
Definition: cf_parse.h:399
FR_CONF_OFFSET_TYPE_FLAGS
#define FR_CONF_OFFSET_TYPE_FLAGS(_name, _type, _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:241
FR_TYPE_VOID
@ FR_TYPE_VOID
User data.
Definition: merged_model.c:127
limit_config
static conf_parser_t const limit_config[]
Definition: proto_vmps.c:45
type_parse
static int type_parse(TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
priority_config
static const conf_parser_t priority_config[]
Definition: proto_vmps.c:36
transport_parse
static int transport_parse(TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
Definition: proto_vmps.c:124

How to parse a VMPS listen section.

Definition at line 65 of file proto_vmps.c.

◆ proto_vmps_dict

fr_dict_autoload_t proto_vmps_dict
Initial value:
= {
{ .out = &dict_vmps, .proto = "vmps" },
{ NULL }
}

Definition at line 77 of file proto_vmps.c.

◆ proto_vmps_dict_attr

fr_dict_attr_autoload_t proto_vmps_dict_attr
Initial value:
= {
{ .out = &attr_packet_type, .name = "Packet-Type", .type = FR_TYPE_UINT32, .dict = &dict_vmps},
{ NULL }
}
FR_TYPE_UINT32
@ FR_TYPE_UINT32
32 Bit unsigned integer.
Definition: merged_model.c:99
attr_packet_type
static fr_dict_attr_t const * attr_packet_type
Definition: proto_vmps.c:82

Definition at line 85 of file proto_vmps.c.

Generated by   doxygen 1.9.1