rlm_sql_sqlite.c File Reference

SQLite driver. More...

#include <freeradius-devel/server/base.h>
#include <freeradius-devel/util/debug.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <sqlite3.h>
#include "rlm_sql.h"
#include "rlm_sql_trunk.h"
#include "config.h"

Include dependency graph for rlm_sql_sqlite.c:

Go to the source code of this file.

Data Structures
struct	rlm_sql_sqlite_conn_t
struct	rlm_sql_sqlite_t

Macros
#define	BOOTSTRAP_MAX   (1048576 * 10)
#define	LOG_PREFIX   "sql - sqlite"
#define	SQLITE_OPEN_NOMUTEX   0

Typedefs
typedef sqlite_int64	sqlite3_int64

Functions
static void	_sql_connection_close (UNUSED fr_event_list_t *el, void *h, UNUSED void *uctx)
static connection_state_t	_sql_connection_init (void **h, connection_t *conn, void *uctx)
static void	_sql_greatest (sqlite3_context *ctx, int num_values, sqlite3_value **values)
static int	mod_instantiate (module_inst_ctx_t const *mctx)
static int	mod_load (void)
static int	sql_affected_rows (fr_sql_query_t *query_ctx, UNUSED rlm_sql_config_t const *config)
static sql_rcode_t	sql_check_error (sqlite3 *db, int status)
	Determine if an error occurred, and what type of error it was.
static size_t	sql_error (UNUSED TALLOC_CTX *ctx, sql_log_entry_t out[], NDEBUG_UNUSED size_t outlen, fr_sql_query_t *query_ctx)
	Retrieves any errors associated with the query context.
static sql_rcode_t	sql_error_to_rcode (int status)
	Convert an sqlite status code to an sql_rcode_t.
static unlang_action_t	sql_fetch_row (unlang_result_t *p_result, UNUSED request_t *request, void *uctx)
static sql_rcode_t	sql_fields (char const **out[], fr_sql_query_t *query_ctx, UNUSED rlm_sql_config_t const *config)
static sql_rcode_t	sql_finish_query (fr_sql_query_t *query_ctx, rlm_sql_config_t const *config)
static sql_rcode_t	sql_free_result (fr_sql_query_t *query_ctx, UNUSED rlm_sql_config_t const *config)
static int	sql_loadfile (TALLOC_CTX *ctx, sqlite3 *db, char const *filename)
static void	sql_print_error (sqlite3 *db, int status, char const *fmt,...))
	Print an error to the global debug log.
static void	sql_request_complete (UNUSED request_t *request, void *preq, UNUSED void *rctx, UNUSED void *uctx)
static SQL_QUERY_RESUME void	sql_request_fail (UNUSED request_t *request, void *preq, UNUSED void *rctx, UNUSED trunk_request_state_t state, UNUSED void *uctx)
static SQL_TRUNK_CONNECTION_ALLOC void	sql_trunk_request_mux (UNUSED fr_event_list_t *el, trunk_connection_t *tconn, connection_t *conn, UNUSED void *uctx)

Variables
static const conf_parser_t	driver_config []
rlm_sql_driver_t	rlm_sql_sqlite

Detailed Description

SQLite driver.

Id

d6ea7fa6f4cc7bf2085b468be3f9ee129367e3d9

Copyright

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

2007 Apple Inc.

Definition in file rlm_sql_sqlite.c.

---

Data Structure Documentation

rlm_sql_sqlite_conn_t

struct rlm_sql_sqlite_conn_t

Definition at line 53 of file rlm_sql_sqlite.c.

Data Fields
int	col_count
sqlite3 *	db
sqlite3_stmt *	statement

rlm_sql_sqlite_t

struct rlm_sql_sqlite_t

Definition at line 59 of file rlm_sql_sqlite.c.

Collaboration diagram for rlm_sql_sqlite_t:

Data Fields
bool	bootstrap
fr_time_delta_t	busy_timeout
char const *	filename

Macro Definition Documentation

BOOTSTRAP_MAX

#define BOOTSTRAP_MAX   (1048576 * 10)

Definition at line 40 of file rlm_sql_sqlite.c.

LOG_PREFIX

#define LOG_PREFIX   "sql - sqlite"

Definition at line 27 of file rlm_sql_sqlite.c.

SQLITE_OPEN_NOMUTEX

#define SQLITE_OPEN_NOMUTEX   0

Definition at line 46 of file rlm_sql_sqlite.c.

Typedef Documentation

sqlite3_int64

typedef sqlite_int64 sqlite3_int64

Definition at line 50 of file rlm_sql_sqlite.c.

Function Documentation

_sql_connection_close()

static void _sql_connection_close ( UNUSED fr_event_list_t *  el, void *  h, UNUSED void *  uctx  )

static

Definition at line 431 of file rlm_sql_sqlite.c.

_sql_connection_init()

static connection_state_t _sql_connection_init ( void **  h, connection_t *  conn, void *  uctx  )

static

Definition at line 367 of file rlm_sql_sqlite.c.

Here is the call graph for this function:

_sql_greatest()

static void _sql_greatest ( sqlite3_context *  ctx, int  num_values, sqlite3_value **  values  )

static

Definition at line 351 of file rlm_sql_sqlite.c.

Here is the caller graph for this function:

mod_instantiate()

static int mod_instantiate ( module_inst_ctx_t const *  mctx )

static

Definition at line 687 of file rlm_sql_sqlite.c.

Here is the call graph for this function:

mod_load()

static int mod_load ( void  )

static

Definition at line 807 of file rlm_sql_sqlite.c.

sql_affected_rows()

static int sql_affected_rows ( fr_sql_query_t *  query_ctx, UNUSED rlm_sql_config_t const *  config  )

static

Definition at line 605 of file rlm_sql_sqlite.c.

sql_check_error()

static sql_rcode_t sql_check_error ( sqlite3 *  db, int  status  )

static

Determine if an error occurred, and what type of error it was.

Parameters

db	handle to extract error from (may be NULL).
status	to check (if unused, set to SQLITE_OK).

Returns

• RLM_SQL_OK - If no errors found.
• RLM_SQL_ERROR - If a known, non-fatal, error occurred.
• RLM_SQL_ALT_QUERY - If a constraints violation occurred.
• RLM_SQL_RECONNECT - Anything else. We assume the connection can no longer be used.

Definition at line 128 of file rlm_sql_sqlite.c.

Here is the call graph for this function:

Here is the caller graph for this function:

sql_error()

static size_t sql_error ( UNUSED TALLOC_CTX *  ctx, sql_log_entry_t  out[], NDEBUG_UNUSED size_t  outlen, fr_sql_query_t *  query_ctx  )

static

Retrieves any errors associated with the query context.

Note

Caller will free any memory allocated in ctx.

Parameters

ctx	to allocate temporary error buffers in.
out	Array of sql_log_entrys to fill.
outlen	Length of out array.
query_ctx	Query context to retrieve error for.

Returns

number of errors written to the sql_log_entry_t array.

Definition at line 583 of file rlm_sql_sqlite.c.

sql_error_to_rcode()

static sql_rcode_t sql_error_to_rcode ( int  status )

static

Convert an sqlite status code to an sql_rcode_t.

Parameters

status

to convert.

Returns

• RLM_SQL_OK - If no errors found.
• RLM_SQL_ERROR - If a known, non-fatal, error occurred.
• RLM_SQL_ALT_QUERY - If a constraints violation occurred.
• RLM_SQL_RECONNECT - Anything else, we assume the connection can no longer be used.

Definition at line 80 of file rlm_sql_sqlite.c.

Here is the caller graph for this function:

sql_fetch_row()

static unlang_action_t sql_fetch_row ( unlang_result_t *  p_result, UNUSED request_t *  request, void *  uctx  )

static

Definition at line 463 of file rlm_sql_sqlite.c.

Here is the call graph for this function:

sql_fields()

static sql_rcode_t sql_fields ( char const **  out[], fr_sql_query_t *  query_ctx, UNUSED rlm_sql_config_t const *  config  )

static

Definition at line 445 of file rlm_sql_sqlite.c.

sql_finish_query()

static sql_rcode_t sql_finish_query ( fr_sql_query_t *  query_ctx, rlm_sql_config_t const *  config  )

static

Definition at line 600 of file rlm_sql_sqlite.c.

Here is the call graph for this function:

sql_free_result()

static sql_rcode_t sql_free_result ( fr_sql_query_t *  query_ctx, UNUSED rlm_sql_config_t const *  config  )

static

Definition at line 551 of file rlm_sql_sqlite.c.

Here is the caller graph for this function:

sql_loadfile()

static int sql_loadfile ( TALLOC_CTX *  ctx, sqlite3 *  db, char const *  filename  )

static

Definition at line 231 of file rlm_sql_sqlite.c.

Here is the call graph for this function:

Here is the caller graph for this function:

sql_print_error()

static void sql_print_error ( sqlite3 *  db, int  status, char const *  fmt,   ...  )

static

Print an error to the global debug log.

If status does not indicate success, write an error to the global error log.

Note

The error code will be appended to the fmt string in the format ": code 0x<hex> (<int>)[: <string>]".

Parameters

db	handle to extract error from (may be NULL).
status	to check (if unused, set to SQLITE_OK).
fmt	to prepend.
...	arguments to fmt.

Definition at line 176 of file rlm_sql_sqlite.c.

Here is the call graph for this function:

Here is the caller graph for this function:

sql_request_complete()

static void sql_request_complete ( UNUSED request_t *  request, void *  preq, UNUSED void *  rctx, UNUSED void *  uctx  )

static

Definition at line 680 of file rlm_sql_sqlite.c.

Here is the call graph for this function:

sql_request_fail()

static SQL_QUERY_RESUME void sql_request_fail ( UNUSED request_t *  request, void *  preq, UNUSED void *  rctx, UNUSED trunk_request_state_t  state, UNUSED void *  uctx  )

static

Definition at line 671 of file rlm_sql_sqlite.c.

sql_trunk_request_mux()

static SQL_TRUNK_CONNECTION_ALLOC void sql_trunk_request_mux ( UNUSED fr_event_list_t *  el, trunk_connection_t *  tconn, connection_t *  conn, UNUSED void *  uctx  )

static

Definition at line 618 of file rlm_sql_sqlite.c.

Here is the call graph for this function:

Variable Documentation

driver_config

const conf_parser_t driver_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_FLAGS("filename", CONF_FLAG_FILE_WRITABLE | CONF_FLAG_REQUIRED, rlm_sql_sqlite_t, filename) },
        { FR_CONF_OFFSET("busy_timeout", rlm_sql_sqlite_t, busy_timeout) },
        CONF_PARSER_TERMINATOR
}

Definition at line 65 of file rlm_sql_sqlite.c.

rlm_sql_sqlite

rlm_sql_driver_t rlm_sql_sqlite

Initial value:

= {
        .common = {
                .name                           = "sql_sqlite",
                .magic                          = MODULE_MAGIC_INIT,
                .inst_size                      = sizeof(rlm_sql_sqlite_t),
                .config                         = driver_config,
                .onload                         = mod_load,
                .instantiate                    = mod_instantiate
        },
        .flags                          = RLM_SQL_RCODE_FLAGS_ALT_QUERY,
        .sql_query_resume               = sql_query_resume,
        .sql_select_query_resume        = sql_query_resume,
        .sql_affected_rows              = sql_affected_rows,
        .sql_fetch_row                  = sql_fetch_row,
        .sql_fields                     = sql_fields,
        .sql_free_result                = sql_free_result,
        .sql_error                      = sql_error,
        .sql_finish_query               = sql_finish_query,
        .sql_finish_select_query        = sql_finish_query,
        .trunk_io_funcs = {
                .connection_alloc       = sql_trunk_connection_alloc,
                .request_mux            = sql_trunk_request_mux,
                .request_complete       = sql_request_complete,
                .request_fail           = sql_request_fail
        }
}

Definition at line 820 of file rlm_sql_sqlite.c.