redis.c File Reference

Common functions for interacting with Redis via hiredis. More...

#include <freeradius-devel/redis/base.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/value.h>

Include dependency graph for redis.c:

Go to the source code of this file.

Functions
fr_redis_rcode_t	fr_redis_command_status (fr_redis_conn_t *conn, redisReply *reply)
	Check the reply for errors.
fr_redis_rcode_t	fr_redis_get_version (char *out, size_t out_len, fr_redis_conn_t *conn)
	Get the version of Redis running on the remote server.
fr_redis_rcode_t	fr_redis_pipeline_result (unsigned int *pipelined, fr_redis_rcode_t *rcode, redisReply *out[], size_t out_len, fr_redis_conn_t *conn)
	Simplifies handling of pipelined commands with Redis cluster.
void	fr_redis_reply_print (fr_log_lvl_t lvl, redisReply *reply, request_t *request, int idx, fr_redis_rcode_t status)
	Print the response data in a useful treelike form.
int	fr_redis_reply_to_map (TALLOC_CTX *ctx, map_list_t *out, request_t *request, redisReply *key, redisReply *op, redisReply *value)
	Convert a pair of redis reply objects to a map.
int	fr_redis_reply_to_value_box (TALLOC_CTX *ctx, fr_value_box_t *out, redisReply *reply, fr_type_t dst_type, fr_dict_attr_t const *dst_enumv, bool box_error, bool shallow)
	Convert a string or integer type to fr_value_box_t of specified type.
int	fr_redis_tuple_from_map (TALLOC_CTX *pool, char const *out[], size_t out_len[], map_t *map)
	Add a single map pair to an existing command string as three elements.
uint32_t	fr_redis_version_num (char const *version)
	Convert version string into a 32bit unsigned integer for comparisons.
void	fr_redis_version_print (void)
	Print the version of libhiredis the server was built against.

Variables
fr_table_num_sorted_t const	redis_rcodes []
size_t	redis_rcodes_len = NUM_ELEMENTS(redis_rcodes)
fr_table_num_sorted_t const	redis_reply_types []
size_t	redis_reply_types_len = NUM_ELEMENTS(redis_reply_types)

Detailed Description

Common functions for interacting with Redis via hiredis.

Id

78b8f931972bd43129538c38f74616f12f2e5255

Copyright

2015 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

2000,2006,2015 The FreeRADIUS server project

2011 TekSavvy Solutions (gabe@.nosp@m.teks.nosp@m.avvy..nosp@m.com)

Definition in file redis.c.

Function Documentation

fr_redis_command_status()

fr_redis_rcode_t fr_redis_command_status	(	fr_redis_conn_t *	conn,
		redisReply *	reply
	)

Check the reply for errors.

Parameters

[in]	conn	used to issue the command.
[in]	reply	to process.

Returns

• REDIS_RCODE_TRY_AGAIN - If the operation should be retries.
• REDIS_RCODE_MOVE - If the key has been permanently moved.
• REDIS_RCODE_ASK - If the key has been temporarily moved.
• REDIS_RCODE_SUCCESS - if no errors.
• REDIS_RCODE_ERROR - on command/server error.
• REDIS_RCODE_NO_SCRIPT - script specified by evalsha doesn't exist.
• REDIS_RCODE_RECONNECT - on connection error (probably needs reconnecting).

Definition at line 71 of file redis.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_redis_get_version()

fr_redis_rcode_t fr_redis_get_version	(	char *	out,
		size_t	out_len,
		fr_redis_conn_t *	conn
	)

Get the version of Redis running on the remote server.

This can be useful for some modules, as it allows adaptive behaviour, or early termination.

Parameters

[out]	out	Where to write the version string.
[in]	out_len	Length of the version string buffer.
[in]	conn	Used to query the version string.

Returns

• REDIS_RCODE_SUCCESS on success.
• REDIS_RCODE_ERROR on command/response mismatch or command error.
• REDIS_RCODE_* on other errors;

Definition at line 642 of file redis.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_redis_pipeline_result()

fr_redis_rcode_t fr_redis_pipeline_result	(	unsigned int *	pipelined,
		fr_redis_rcode_t *	rcode,
		redisReply *	out[],
		size_t	out_len,
		fr_redis_conn_t *	conn
	)

Simplifies handling of pipelined commands with Redis cluster.

Retrieve all available pipelined responses, and write them to the array.

On encountering an error, all previously retrieved responses are freed, and the reply containing the error is written to the first element of out. All responses after the error are also freed.

If the number of responses != pipelined, that's also an error, a very serious one, in libhiredis or Redis. We can't really do much here apart from error out.

Parameters

[out]	pipelined	Number of pipelined commands we sent to the server.
[out]	rcode	Status of the first errored response, or REDIS_RCODE_SUCCESS if all responses were processed.
[out]	out	Where to write the replies from pipelined commands. Will contain exactly 1 element on error WHICH MUST BE FREED, else the number passed in pipelined.
[in]	out_len	number of elements in out.
[in]	conn	the pipelined commands were issued on.

Returns

• REDIS_RCODE_SUCCESS on success.
• REDIS_RCODE_ERROR on command/response mismatch or command error.
• REDIS_RCODE_* on other errors;

Definition at line 539 of file redis.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_redis_reply_print()

void fr_redis_reply_print	(	fr_log_lvl_t	lvl,
		redisReply *	reply,
		request_t *	request,
		int	idx,
		fr_redis_rcode_t	status
	)

Print the response data in a useful treelike form.

Parameters

[in]	lvl	to print data at.
[in]	reply	to print.
[in]	request	The current request.
[in]	idx	Response number.
[in]	status	code from processing last reply.

Definition at line 142 of file redis.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_redis_reply_to_map()

int fr_redis_reply_to_map	(	TALLOC_CTX *	ctx,
		map_list_t *	out,
		request_t *	request,
		redisReply *	key,
		redisReply *	op,
		redisReply *	value
	)

Convert a pair of redis reply objects to a map.

The maps can then be applied using map_to_request.

Parameters

[in,out]	ctx	to allocate maps in.
[out]	out	Where to write the head of the new maps list.
[in]	request	The current request.
[in]	key	to process.
[in]	op	to process.
[in]	value	to process.

Returns

• 0 on success.
• -1 on failure.

Definition at line 370 of file redis.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_redis_reply_to_value_box()

int fr_redis_reply_to_value_box	(	TALLOC_CTX *	ctx,
		fr_value_box_t *	out,
		redisReply *	reply,
		fr_type_t	dst_type,
		fr_dict_attr_t const *	dst_enumv,
		bool	box_error,
		bool	shallow
	)

Convert a string or integer type to fr_value_box_t of specified type.

Will work with REDIS_REPLY_STRING (which is converted to FR_TYPE_STRING then cast to dst_type), or REDIS_REPLY_INTEGER (which is converted to FR_TYPE_UINT64, then cast to dst_type).

Note

Any unsupported types will trigger an assert. You must check the reply type prior to calling this function.

Parameters

[in,out]	ctx	to allocate any buffers in.
[out]	out	Where to write the cast type.
[in]	reply	to process.
[in]	dst_type	to convert to. May be FR_TYPE_VOID to infer type.
[in]	dst_enumv	Used to convert string types to integers for attribute with enumerated values.
[in]	box_error	If true then REDIS_REPLY_ERROR will be copied to a box, otherwise we'll return and error with the contents of the error available on the thread local error stack.
[in]	shallow	If true, we shallow copy strings.

Returns

• 1 if we received a NIL reply.
• 0 on success.
• -1 on cast or parse failure.

Definition at line 211 of file redis.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_redis_tuple_from_map()

int fr_redis_tuple_from_map	(	TALLOC_CTX *	pool,
		char const *	out[],
		size_t	out_len[],
		map_t *	map
	)

Add a single map pair to an existing command string as three elements.

• Integer types will be encoded as integers.
• Strings and octets will be encoded in their raw form.
• Other types will be converted to their printable form and will be encoded as strings.

Note

lhs must be a TMPL_TYPE_ATTR.

rhs must be a TMPL_TYPE_DATA.

Parameters

pool	to allocate any buffers in.
out	Where to write pointers to the member of the tuple. Unused elements should be a multiple of three, and it should have at least three unused elements.
out_len	Where to write the size of the data pointed to by the equivalent index in the out array.
map	to convert.

Returns

0 on success. -1 on failure.

Definition at line 463 of file redis.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_redis_version_num()

uint32_t fr_redis_version_num

(

char const *

version

)

Convert version string into a 32bit unsigned integer for comparisons.

Parameters

[in]

version

string to parse.

Returns

32bit unsigned integer representing the version string.

Definition at line 692 of file redis.c.

Here is the caller graph for this function:

fr_redis_version_print()

void fr_redis_version_print

(

void

)

Print the version of libhiredis the server was built against.

Definition at line 53 of file redis.c.

Here is the caller graph for this function:

Variable Documentation

redis_rcodes

fr_table_num_sorted_t const redis_rcodes[]

Initial value:

= {
        { L("ask"),             REDIS_RCODE_ASK         },
        { L("error"),           REDIS_RCODE_ERROR       },
        { L("move"),            REDIS_RCODE_MOVE        },
        { L("reconnect"),       REDIS_RCODE_RECONNECT   },
        { L("success"),         REDIS_RCODE_SUCCESS     },
        { L("try again"),       REDIS_RCODE_TRY_AGAIN   }
}

Definition at line 40 of file redis.c.

redis_rcodes_len

size_t redis_rcodes_len = NUM_ELEMENTS(redis_rcodes)

Definition at line 48 of file redis.c.

redis_reply_types

fr_table_num_sorted_t const redis_reply_types[]

Initial value:

= {
        { L("array"),           REDIS_REPLY_ARRAY       },
        { L("error"),           REDIS_REPLY_ERROR       },
        { L("integer"),         REDIS_REPLY_INTEGER     },
        { L("nil"),             REDIS_REPLY_NIL         },
        { L("status"),          REDIS_REPLY_STATUS      },
        { L("string"),          REDIS_REPLY_STRING      }
}

Definition at line 30 of file redis.c.

redis_reply_types_len

size_t redis_reply_types_len = NUM_ELEMENTS(redis_reply_types)

Definition at line 38 of file redis.c.