worker.h

Go to the documentation of this file.

#pragma once
/*
 *  This program 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: ddf0f29e17efa34776a213ded041367f0b70c99b $
 *
 * @file io/worker.h
 * @brief Functions and data structures for worker threads.
 *
 * @copyright 2016 Alan DeKok (aland@freeradius.org)
 */
RCSIDH(worker_h, "$Id: ddf0f29e17efa34776a213ded041367f0b70c99b $")
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
/** Events for a worker's own control messages, in the FR_CONTROL_EVENTSET_WORKER event set
 */
typedef enum fr_worker_control_event_t : uint16_t {
        FR_WORKER_CONTROL_LISTEN_DEAD = 0       //!< A listener has been closed.
} fr_worker_control_event_t;
 
/**
 *  A data structure to track the worker.
 *
 *  Once spawned, workers exist until they choose to exit.
 */
typedef struct fr_worker_s fr_worker_t;
 
#ifdef __cplusplus
}
#endif
 
#include <freeradius-devel/io/base.h>
#include <freeradius-devel/server/command.h>
#include <freeradius-devel/util/event.h>
#include <freeradius-devel/util/heap.h>
#include <freeradius-devel/util/log.h>
#include <freeradius-devel/util/slab.h>
#include <freeradius-devel/util/talloc.h>
 
#include <pthread.h>
 
#ifdef __cplusplus
extern "C" {
#endif
extern fr_cmd_table_t cmd_worker_table[];
 
typedef struct {
        int                     max_requests;           //!< max requests this worker will handle
 
        int                     max_channels;           //!< maximum number of channels
 
        int                     message_set_size;       //!< default start number of messages
        int                     ring_buffer_size;       //!< default start size for the ring buffers
 
        fr_time_delta_t         max_request_time;       //!< maximum time a request can be processed
 
        fr_slab_config_t        reuse;                  //!< slab allocator configuration
} fr_worker_config_t;
 
int             fr_worker_request_timeout_set(fr_worker_t *worker, request_t *request, fr_time_delta_t timeout) CC_HINT(nonnull);
 
fr_worker_t     *fr_worker_alloc(TALLOC_CTX *ctx, fr_event_list_t *el, char const *name,
                                  fr_log_t const *logger, fr_log_lvl_t lvl, fr_worker_config_t *config) CC_HINT(nonnull(2,3,4));
 
int             fr_worker_close_event_insert(fr_worker_t *worker);
 
void            fr_worker_shutting_down(fr_worker_t *worker) CC_HINT(nonnull);
 
void            fr_worker_exit(fr_worker_t *worker);
 
void            fr_worker(fr_worker_t *worker) CC_HINT(nonnull);
 
void            fr_worker_debug(fr_worker_t *worker, FILE *fp) CC_HINT(nonnull);
 
int             fr_worker_pre_event(fr_time_t now, fr_time_delta_t wake, void *uctx);
 
void            fr_worker_post_event(fr_event_list_t *el, fr_time_t now, void *uctx);
 
fr_channel_t    *fr_worker_channel_create(fr_worker_t *worker, TALLOC_CTX *ctx, fr_control_t *master,
                                          fr_message_set_t *reply_ms) CC_HINT(nonnull);
 
int             fr_worker_stats(fr_worker_t const *worker, int num, uint64_t *stats) CC_HINT(nonnull);
 
int             fr_worker_listen_cancel(fr_worker_t *worker, fr_listen_instance_t const *li);
 
fr_worker_config_t const *fr_worker_config(fr_worker_t *worker) CC_HINT(nonnull);
 
#include <freeradius-devel/server/module.h>
 
int             fr_worker_subrequest_add(request_t *request) CC_HINT(nonnull);
 
#ifdef __cplusplus
}
#endif