request_data.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: 236092b856548e85db31505040179c116384734a $
 *
 * @file lib/server/request_data.h
 * @brief Request data management functions.
 *
 * @copyright 2019 The FreeRADIUS server project
 */
RCSIDH(request_data_h, "$Id: 236092b856548e85db31505040179c116384734a $")
 
#include <freeradius-devel/server/request.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct request_data_s request_data_t;
 
void            request_data_list_init(fr_dlist_head_t *data);
 
/** Add opaque data to a request_t
 *
 * The unique ptr is meant to be a module configuration, and the unique
 * integer allows the caller to have multiple opaque data associated with a request_t.
 *
 * @param[in] _request          to associate data with.
 * @param[in] _unique_ptr       Identifier for the data.
 * @param[in] _unique_int       Qualifier for the identifier.
 * @param[in] _opaque           Data to associate with the request.  May be NULL.
 * @param[in] _free_on_replace  Free opaque data if this request_data is replaced.
 * @param[in] _free_on_parent   Free opaque data if the request is freed.
 *                              Must not be set if the opaque data is also parented by
 *                              the request or state (double free).
 * @param[in] _persist          Transfer request data to an #fr_state_entry_t, and
 *                              add it back to the next request we receive for the
 *                              session.
 * @return
 *      - -2 on bad arguments.
 *      - -1 on memory allocation error.
 *      - 0 on success.
 */
#define request_data_add(_request, _unique_ptr, _unique_int, _opaque, _free_on_replace, _free_on_parent, _persist) \
                _request_data_add(_request, _unique_ptr, _unique_int, NULL, _opaque,  \
                                  _free_on_replace, _free_on_parent, _persist, __FILE__, __LINE__)
 
 
/** Add opaque data to a request_t
 *
 * The unique ptr is meant to be a module configuration, and the unique
 * integer allows the caller to have multiple opaque data associated with a request_t.
 *
 * @param[in] _request          to associate data with.
 * @param[in] _unique_ptr       Identifier for the data.
 * @param[in] _unique_int       Qualifier for the identifier.
 * @param[in] _type             Type of data i.e. fr_pair_t.
 * @param[in] _opaque           Data to associate with the request.  May be NULL.
 * @param[in] _free_on_replace  Free opaque data if this request_data is replaced.
 * @param[in] _free_on_parent   Free opaque data if the request is freed.
 *                              Must not be set if the opaque data is also parented by
 *                              the request or state (double free).
 * @param[in] _persist          Transfer request data to an #fr_state_entry_t, and
 *                              add it back to the next request we receive for the
 *                              session.
 * @return
 *      - -2 on bad arguments.
 *      - -1 on memory allocation error.
 *      - 0 on success.
 */
#define request_data_talloc_add(_request, _unique_ptr, _unique_int, _type, _opaque, _free_on_replace, _free_on_parent, _persist) \
                _request_data_add(_request, _unique_ptr, _unique_int, STRINGIFY(_type), _opaque, \
                                  _free_on_replace, _free_on_parent, _persist, __FILE__, __LINE__)
 
int             _request_data_add(request_t *request, void const *unique_ptr, int unique_int, char const *type, void *opaque,
                                  bool free_on_replace, bool free_on_parent, bool persist, char const *file, int line);
 
void            *request_data_get(request_t *request, void const *unique_ptr, int unique_int);
 
void            *request_data_reference(request_t *request, void const *unique_ptr, int unique_int);
 
int             request_data_by_persistance(fr_dlist_head_t *out, request_t *request, bool persist);
 
int             request_data_by_persistance_reparent(TALLOC_CTX *ctx, fr_dlist_head_t *out,
                                                     request_t *request, bool persist);
 
int             request_data_by_persistance_count(request_t *request, bool persist);
 
void            request_data_restore(request_t *request, fr_dlist_head_t *in);
 
void            request_data_persistable_free(request_t *request);
 
void            request_data_list_dump(request_t *request, fr_dlist_head_t *head);
 
void            request_data_dump(request_t *request);
 
#ifdef WITH_VERIFY_PTR
bool            request_data_persistable(request_data_t *rd);
 
bool            request_data_verify_parent(TALLOC_CTX *parent, fr_dlist_head_t *entry);
#endif
 
#ifdef __cplusplus
}
#endif