cluster_async.h

Go to the documentation of this file.

#pragma once
 
/*
 *   This program is is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or (at
 *   your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
/**
 * $Id: 1abb83a907bcb36c62334f7e97027dd84c908915 $
 * @file lib/redis/cluster_async.h
 * @brief Redis asynchronous cluster management
 *
 * @copyright 2026 The FreeRADIUS server project
 * @copyright 2026 Network RADIUS SAS (legal@networkradius.com)
 *
 * @author Arran Cudbard-Bell (a.cudbardb@freeradius.org)
 */
RCSIDH(redis_cluster_async_h, "$Id: 1abb83a907bcb36c62334f7e97027dd84c908915 $")
 
#include <freeradius-devel/server/trunk.h>
#include <freeradius-devel/io/coord_pair.h>
#include "base.h"
#include "pipeline.h"
 
#define KEY_SLOTS               16384                   //!< Maximum number of keyslots (should not change).
 
typedef struct fr_redis_ct_key_slot_s fr_redis_ct_key_slot_t;
typedef struct fr_redis_ct_node_s fr_redis_ct_node_t;
typedef struct fr_redis_async_cmd_s fr_redis_async_cmd_t;
 
/** Convenience macro to reduce boilerplate
 *
 * @param _rcode                to process.
 * @param _cluster              Redis cluster thread.
 * @param _cw                   Coordinator worker for cluster bootstrapping.
 * @param _coord_pair_reg       Coordinator pair reg for cluster bootstrapping.
 * @param _error_msg            Message to report on error.
 * @param _error_ret            Return value on error.
 */
#define REDIS_ASYNC_START_RCODE_PROCESS(_rcode, _cluster, _cw, _coord_pair_reg, _error_msg, _error_ret) \
do { \
        switch (_rcode) { \
        case REDIS_ASYNC_RCODE_BOOTSTRAP: \
                fr_redis_ct_map_bootstrap(_cluster, _cw, _coord_pair_reg); \
                break; \
        case REDIS_ASYNC_RCODE_GETMAP: \
                fr_redis_ct_map_get(_cluster, _cw, _coord_pair_reg, false); \
                break; \
        case REDIS_ASYNC_RCODE_FAIL: \
        case REDIS_ASYNC_RCODE_ERROR: \
                RPERROR(_error_msg); \
                return _error_ret; \
        default: \
                break; \
        } \
} while (0)
 
#define REDIS_ASYNC_COORD_CALLBACKS(_thread_type) \
typedef enum : uint8_t { \
        REDIS_COORD_PAIR_CALLBACK_ID = 0, \
} rlm_redis_coord_t; \
static void cluster_map_update(UNUSED fr_coord_worker_t *cw, UNUSED fr_coord_pair_reg_t *coord_pair_reg, \
                               fr_pair_list_t const *list, UNUSED fr_time_t now, \
                               module_ctx_t *mctx, UNUSED void *uctx) \
{ \
        _thread_type    *t = talloc_get_type_abort(mctx->thread, _thread_type); \
        module_thread_instance_t        *mt; \
        if (fr_redis_ct_map_update(t->rtcluster, list) < 0) return; \
        mt = module_thread(mctx->mi); \
        module_thread_force(mt, RLM_MODULE_NOT_SET); \
        return; \
} \
static void cluster_map_fail(UNUSED fr_coord_worker_t *cw, UNUSED fr_coord_pair_reg_t *coord_pair_reg, \
                            fr_pair_list_t const *list, UNUSED fr_time_t now, \
                            module_ctx_t *mctx, UNUSED void *uctx) \
{ \
        _thread_type    *t = talloc_get_type_abort(mctx->thread, _thread_type); \
        module_thread_instance_t        *mt; \
        fr_redis_ct_map_fail(t->rtcluster, list); \
        mt = module_thread(mctx->mi); \
        module_thread_force(mt, RLM_MODULE_FAIL); \
        return; \
} \
static fr_coord_cb_reg_t coord_callbacks[] = { \
        FR_COORD_PAIR_CALLBACK(REDIS_COORD_PAIR_CALLBACK_ID), \
        FR_COORD_CALLBACK_TERMINATOR \
}; \
static fr_coord_worker_cb_reg_t worker_callbacks[] = { \
        FR_COORD_WORKER_PAIR_CALLBACK(REDIS_COORD_PAIR_CALLBACK_ID), \
        FR_COORD_CALLBACK_TERMINATOR \
}; \
static fr_coord_worker_pair_cb_reg_t worker_pair_callbacks[] = { \
        { .packet_type = FR_REDIS_CLUSTER_MAP_UPDATE, .callback = cluster_map_update }, \
        { .packet_type = FR_REDIS_CLUSTER_MAP_FAIL, .callback = cluster_map_fail }, \
        FR_COORD_CALLBACK_TERMINATOR \
}
 
fr_redis_ct_key_slot_t const    *fr_redis_ct_slot_by_key(fr_redis_ct_t *rtcluster, request_t *request,
                                                         uint8_t const *key, size_t key_len);
 
fr_redis_ct_node_t const        *fr_redis_ct_master(fr_redis_ct_t *thread, fr_redis_ct_key_slot_t const *key_slot);
 
fr_redis_ct_node_t const        *fr_redis_ct_replica(fr_redis_ct_t *thread,
                                                     fr_redis_ct_key_slot_t const *key_slot, uint8_t replica_num);
 
char const                      *fr_redis_ct_ipaddr(fr_redis_ct_node_t const *node);
 
int                             fr_redis_ct_port(uint16_t *out, fr_redis_ct_node_t const *node);
 
fr_redis_ct_t                   *fr_redis_ct_alloc(TALLOC_CTX *ctx, fr_event_list_t *el,
                                                   fr_redis_conf_t *conf, fr_redis_trunk_active_t active,
                                                   void *active_uctx, bool active_oneshot);
 
fr_event_list_t                 *fr_redis_ct_el(fr_redis_ct_t *rtcluster);
 
trunk_conf_t const              *fr_redis_ct_trunk_conf(fr_redis_ct_t *thread);
 
uint8_t                         fr_redis_ct_max_redirects(fr_redis_ct_t *rtcluster);
 
#ifdef HAVE_REDIS_SSL
SSL_CTX                         *fr_redis_ct_ssl_ctx(fr_redis_ct_t *rtcluster);
#endif
 
int                             fr_redis_ct_map_bootstrap(fr_redis_ct_t *rtcluster, fr_coord_worker_t *cw,
                                                          fr_coord_pair_reg_t *coord_pair_reg);
 
fr_redis_async_rcode_t          fr_redis_ct_map_get(fr_redis_ct_t *rtcluster, fr_coord_worker_t *cw,
                                                    fr_coord_pair_reg_t *coord_pair_reg, bool force);
 
int                             fr_redis_ct_map_update(fr_redis_ct_t *thread, fr_pair_list_t const *list);
 
int                             fr_redis_ct_map_fail(fr_redis_ct_t *rtcluster, fr_pair_list_t const *list);
 
fr_redis_async_cmd_t            *fr_redis_async_cmd_start(TALLOC_CTX *ctx, request_t *request, fr_redis_async_rcode_t *rcode,
                                                          fr_redis_ct_t *rtcluster, uint8_t const *key, size_t key_len,
                                                          fr_redis_command_set_t *cmds, bool read_only, fr_redis_ct_node_t *node);
 
void                            fr_redis_async_cmd_cancel(fr_redis_async_cmd_t *cmd);
 
fr_redis_trunk_t                *fr_redis_async_cmd_trunk(fr_redis_async_cmd_t *cmd);
 
fr_redis_ct_node_t              *fr_redis_async_cmd_node(fr_redis_async_cmd_t *cmd);
 
fr_redis_async_rcode_t          fr_redis_async_cmd_redirect(fr_redis_async_cmd_t *cmd);
 
fr_redis_async_rcode_t          fr_redis_async_cmd_resend(fr_redis_async_cmd_t *cmd);
 
fr_redis_ct_node_t              *fr_redis_ct_node_by_addr(fr_redis_ct_t *rtcluster, fr_redis_io_conf_t *addr);
 
fr_redis_async_rcode_t          fr_redis_ct_node_addr_by_role(TALLOC_CTX *ctx, fr_redis_io_conf_t *out[], uint8_t *count_out,
                                                              fr_redis_ct_t *rtcluster, bool is_master, bool is_replica);
 
void                            fr_redis_ct_request_yield(TALLOC_CTX *ctx, fr_redis_ct_t *rtcluster,
                                                          request_t *request);