map_proc_priv.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, 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 Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
 
/**
 * $Id: 584571ca507729842812733fc5a3aa284169a561 $
 *
 * @file src/lib/server/map_proc_priv.h
 * @brief Private map process structures and functions.
 *
 * @author Arran Cudbard-Bell (a.cudbardb@freeradius.org)
 */
#include <freeradius-devel/server/cf_util.h> /* Need CONF_* definitions */
#include <freeradius-devel/server/map_proc.h>
#include <freeradius-devel/server/modpriv.h>
#include <freeradius-devel/server/map_proc.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/value.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/** Map processor registration
 */
struct map_proc {
        fr_rb_node_t            node;                   //!< Entry in the map processor tree.
        void const              *mod_inst;              //!< Module instance.
        char                    name[FR_MAX_STRING_LEN];        //!< Name of the map function.
        int                     length;                 //!< Length of name.
 
        map_proc_func_t         evaluate;               //!< Module's map processor function.
        map_proc_instantiate_t  instantiate;            //!< Callback to create new instance struct.
        size_t                  inst_size;              //!< Size of map_proc instance data to allocate.
        fr_value_box_safe_for_t literals_safe_for;      //!< Safe for values to be set for literals in the map source.
};
 
/** Map processor instance
 */
struct map_proc_inst {
        map_proc_t const        *proc;                  //!< Map processor.
        tmpl_t const            *src;                   //!< Evaluated to provide source value for map processor.
        map_list_t const        *maps;                  //!< Head of the map list.
        void                    *data;                  //!< Instance data created by #map_proc_instantiate
};
 
#ifdef __cplusplus
}
#endif