cf_util.c

Go to the documentation of this file.

/*
 *   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: c765dfac3d74f64f5b9d1679119d9c63ef7a07c9 $
 * @file cf_util.c
 * @brief Functions for building and managing the structure of internal format config items.
 *
 * @copyright 2017 Arran Cudbard-Bell (a.cudbardb@freeradius.org)
 */
RCSID("$Id: c765dfac3d74f64f5b9d1679119d9c63ef7a07c9 $")
 
#include <string.h>
 
#include <freeradius-devel/server/cf_file.h>
#include <freeradius-devel/server/cf_priv.h>
#include <freeradius-devel/server/log.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/atexit.h>
 
static inline int8_t cf_ident2_cmp(void const *a, void const *b);
static int8_t _cf_ident1_cmp(void const *a, void const *b);
static int8_t _cf_ident2_cmp(void const *a, void const *b);
 
/** Return the next child that's of the specified type
 *
 * @param[in] parent    to return children from.
 * @param[in] current   child to start searching from.
 * @param[in] type      to search for.
 * @return
 *      - The next #CONF_ITEM that's a child of ci matching type.
 *      - NULL if no #CONF_ITEM matches that criteria.
 */
static CONF_ITEM *cf_next(CONF_ITEM const *parent, CONF_ITEM const *current, CONF_ITEM_TYPE type)
{
        cf_item_foreach_next(parent, ci, UNCONST(CONF_ITEM *, current)) {
                if (ci->type == type) return ci;
        }
 
        return NULL;
}
 
/** Return the previous child that's of the specified type
 *
 * @param[in] parent    to return children from.
 * @param[in] current   child to start searching from.
 * @param[in] type      to search for.
 * @return
 *      - The next #CONF_ITEM that's a child of ci matching type.
 *      - NULL if no #CONF_ITEM matches that criteria.
 */
static inline CC_HINT(always_inline)
CONF_ITEM *cf_prev(CONF_ITEM const *parent, CONF_ITEM const *current, CONF_ITEM_TYPE type)
{
        cf_item_foreach_prev(parent, ci, UNCONST(CONF_ITEM *, current)) {
                if (ci->type == type) return ci;
        }
 
        return NULL;
}
 
#define IS_WILDCARD(_ident) (_ident == CF_IDENT_ANY)
 
/** Return the next child that's of the specified type with the specified identifiers
 *
 * @param[in] parent    The section we're searching in.
 * @param[in] type      of #CONF_ITEM we're searching for.
 * @param[in] ident1    The first identifier.
 * @param[in] ident2    The second identifier. Special value CF_IDENT_ANY
 *                      can be used to match any ident2 value.
 * @return
 *      - The first matching item.
 *      - NULL if no items matched.
 */
static CONF_ITEM *cf_find(CONF_ITEM const *parent, CONF_ITEM_TYPE type, char const *ident1, char const *ident2)
{
        CONF_SECTION    cs_find;
        CONF_PAIR       cp_find;
        CONF_DATA       cd_find;
        CONF_ITEM       *find;
 
        if (!parent) return NULL;
        if (cf_item_has_no_children(parent)) return NULL;
 
        if (!ident1) return cf_next(parent, NULL, type);
 
        switch (type) {
        case CONF_ITEM_SECTION:
                memset(&cs_find, 0, sizeof(cs_find));
                cs_find.item.type = CONF_ITEM_SECTION;
                cs_find.name1 = ident1;
                if (!IS_WILDCARD(ident2)) cs_find.name2 = ident2;
 
                find = (CONF_ITEM *)&cs_find;
                break;
 
        case CONF_ITEM_PAIR:
                fr_assert((ident2 == NULL) || IS_WILDCARD(ident2));
 
                memset(&cp_find, 0, sizeof(cp_find));
                cp_find.item.type = CONF_ITEM_PAIR;
                cp_find.attr = ident1;
 
                find = (CONF_ITEM *)&cp_find;
                break;
 
        case CONF_ITEM_DATA:
                memset(&cd_find, 0, sizeof(cd_find));
                cd_find.item.type = CONF_ITEM_DATA;
                cd_find.type = ident1;
                if (!IS_WILDCARD(ident2)) cd_find.name = ident2;
 
                find = (CONF_ITEM *)&cd_find;
                break;
 
        default:
                fr_assert_fail(NULL);
                return NULL;
        }
 
        /*
         *      No ident1, iterate over the child list
         */
        if (IS_WILDCARD(ident1)) {
                cf_item_foreach(parent, ci) {
                        if (find->type != ci->type) continue;
 
                        if (cf_ident2_cmp(find, ci) == 0) return ci;
                }
 
                return NULL;
        }
 
        /*
         *      No ident2, use the ident1 tree.  The tree itself may be
         *      NULL when the parent has only had non-indexed children
         *      added (e.g. CONF_COMMENT items don't populate the rbtree).
         */
        if (IS_WILDCARD(ident2)) {
                if (!parent->ident1) return NULL;
                return fr_rb_find(parent->ident1, find);
        }
 
        /*
         *      Only sections have an ident2 tree.
         */
        if (parent->type != CONF_ITEM_SECTION) return NULL;
 
        /*
         *      Both ident1 and ident2 use the ident2 tree.  As above,
         *      the tree may be NULL when only non-indexed children exist.
         */
        if (!parent->ident2) return NULL;
        return fr_rb_find(parent->ident2, find);
}
 
/** Return the next child that's of the specified type with the specified identifiers
 *
 * @param[in] parent    The section we're searching in.
 * @param[in] prev      item we found, or NULL to start from the beginning.
 * @param[in] type      of #CONF_ITEM we're searching for.
 * @param[in] ident1    The first identifier.
 * @param[in] ident2    The second identifier. Special value CF_IDENT_ANY
 *                      can be used to match any ident2 value.
 * @return
 *      - The first matching item.
 *      - NULL if no items matched.
 */
static CONF_ITEM *cf_find_next(CONF_ITEM const *parent, CONF_ITEM const *prev,
                               CONF_ITEM_TYPE type, char const *ident1, char const *ident2)
{
        CONF_SECTION    cs_find;
        CONF_PAIR       cp_find;
        CONF_DATA       cd_find;
        CONF_ITEM       *find;
 
        if (!parent) return NULL;
 
        if (!prev) {
                if (!ident1) return cf_next(parent, NULL, type);
                return cf_find(parent, type, ident1, ident2);
        }
        if (!ident1) return cf_next(parent, prev, type);
 
        switch (type) {
        case CONF_ITEM_SECTION:
                memset(&cs_find, 0, sizeof(cs_find));
                cs_find.item.type = CONF_ITEM_SECTION;
                cs_find.name1 = ident1;
                if (!IS_WILDCARD(ident2)) cs_find.name2 = ident2;
 
                find = (CONF_ITEM *)&cs_find;
                break;
 
        case CONF_ITEM_PAIR:
                fr_assert((ident2 == NULL) || IS_WILDCARD(ident2));
 
                memset(&cp_find, 0, sizeof(cp_find));
                cp_find.item.type = CONF_ITEM_PAIR;
                cp_find.attr = ident1;
 
                find = (CONF_ITEM *)&cp_find;
                break;
 
        case CONF_ITEM_DATA:
                memset(&cd_find, 0, sizeof(cd_find));
                cd_find.item.type = CONF_ITEM_DATA;
                cd_find.type = ident1;
                if (!IS_WILDCARD(ident2)) cd_find.name = ident2;
 
                find = (CONF_ITEM *)&cd_find;
                break;
 
        default:
                fr_assert_fail(NULL);
                return NULL;
        }
 
        if (IS_WILDCARD(ident1)) {
                cf_item_foreach_next(parent, ci, prev) {
                        if (find->type != ci->type) continue;
 
                        if (cf_ident2_cmp(find, ci) == 0) return ci;
                }
 
                return NULL;
        }
 
        if (IS_WILDCARD(ident2)) {
                cf_item_foreach_next(parent, ci, prev) {
                     if (_cf_ident1_cmp(ci, find) == 0) return ci;
 
                }
 
                return NULL;
        }
 
        cf_item_foreach_next(parent, ci, prev) {
                if (_cf_ident2_cmp(ci, find) == 0) return ci;
        }
 
        return NULL;
}
 
/** Compare the first identifier of a child
 *
 * For CONF_ITEM_PAIR this is 'attr'.
 * For CONF_ITEM_SECTION this is 'name1'.
 * For CONF_ITEM_DATA this is 'type'.
 *
 * @param[in] one       First CONF_ITEM to compare.
 * @param[in] two       Second CONF_ITEM to compare.
 * @return CMP(one, two)
 */
static inline int8_t _cf_ident1_cmp(void const *one, void const *two)
{
        int ret;
 
        CONF_ITEM_TYPE type;
 
        {
                CONF_ITEM const *a = one;
                CONF_ITEM const *b = two;
 
                CMP_RETURN(a, b, type);
                type = a->type;
        }
 
        switch (type) {
        case CONF_ITEM_PAIR:
        {
                CONF_PAIR const *a = one;
                CONF_PAIR const *b = two;
 
                ret = strcmp(a->attr, b->attr);
                return CMP(ret, 0);
        }
 
        case CONF_ITEM_SECTION:
        {
                CONF_SECTION const *a = one;
                CONF_SECTION const *b = two;
 
                ret = strcmp(a->name1, b->name1);
                return CMP(ret, 0);
        }
 
        case CONF_ITEM_DATA:
        {
                CONF_DATA const *a = one;
                CONF_DATA const *b = two;
 
                ret = strcmp(a->type, b->type);
                return CMP(ret, 0);
        }
 
        default:
                fr_assert_fail(NULL);
                return 0;
        }
}
 
/** Compare only the second identifier of a child
 *
 * For CONF_ITEM_SECTION this is 'name2'.
 * For CONF_ITEM_DATA this is 'name'.
 *
 * @param[in] one       First CONF_ITEM to compare.
 * @param[in] two       Second CONF_ITEM to compare.
 * @return CMP(one,two)
 */
static inline int8_t cf_ident2_cmp(void const *one, void const *two)
{
        CONF_ITEM const *ci = one;
        int ret;
 
        switch (ci->type) {
        case CONF_ITEM_PAIR:
                return 0;
 
        case CONF_ITEM_SECTION:
        {
                CONF_SECTION const *a = one;
                CONF_SECTION const *b = two;
 
                if (!b->name2 && a->name2) return +1;
                if (b->name2 && !a->name2) return -1;
                if (!b->name2 && !a->name2) return 0;
 
                ret = strcmp(a->name2, b->name2);
                return CMP(ret, 0);
        }
 
        case CONF_ITEM_DATA:
        {
                CONF_DATA const *a = one;
                CONF_DATA const *b = two;
 
                if (!b->name && a->name) return +1;
                if (b->name && !a->name) return -1;
                if (!b->name && !a->name) return 0;
 
                ret = strcmp(a->name, b->name);
                return CMP(ret, 0);
        }
 
        default:
                fr_assert_fail(NULL);
                return 0;
        }
}
 
/** Compare the first and second identifiers of a child
 *
 * For CONF_ITEM_SECTION this is 'name2'.
 * For CONF_ITEM_DATA this is 'name'.
 *
 * @param[in] a First CONF_ITEM to compare.
 * @param[in] b Second CONF_ITEM to compare.
 * @return CMP(a, b)
 */
static int8_t _cf_ident2_cmp(void const *a, void const *b)
{
        int ret;
 
        ret = _cf_ident1_cmp(a, b);
        if (ret != 0) return ret;
 
        return cf_ident2_cmp(a, b);
}
 
/** Add a child
 *
 * @param[in] parent    to add child to.
 * @param[in] child     to add.
 */
void _cf_item_add(CONF_ITEM *parent, CONF_ITEM *child)
{
        fr_assert(parent != child);
 
        if (!parent || !child) return;
 
        /*
         *      New child, add child trees.
         */
        if (!parent->ident1) parent->ident1 = fr_rb_inline_alloc(parent, CONF_ITEM, ident1_node,
                                                                 _cf_ident1_cmp, NULL);
        fr_rb_insert(parent->ident1, child);
        fr_dlist_insert_tail(&parent->children, child); /* Append to the list of children */
 
        if (parent->type != CONF_ITEM_SECTION) return;  /* Only sections can have ident2 trees */
 
        if (!parent->ident2) parent->ident2 = fr_rb_inline_alloc(parent, CONF_ITEM, ident2_node,
                                                                 _cf_ident2_cmp, NULL);
        fr_rb_insert(parent->ident2, child);            /* NULL ident2 is still a value */
}
 
/** Insert a child after a given one
 *
 * @param[in] parent    to add child to.
 * @param[in] prev      previous
 * @param[in] child     to add.
 */
void _cf_item_insert_after(CONF_ITEM *parent, CONF_ITEM *prev, CONF_ITEM *child)
{
        fr_assert(parent != child);
        fr_assert(prev != child);
 
        /*
         *      Must be given something.  Can't insert at HEAD.
         */
        if (!parent || !child) return;
 
        if (!prev) {
                cf_item_add(parent, child);
                return;
        }
 
        /*
         *      If there's a prev, then the ident trees must be there.
         */
        fr_assert(parent->ident1 != NULL);
 
        fr_rb_insert(parent->ident1, child);
        fr_dlist_insert_after(&parent->children, prev, child);  /* insert in the list of children */
 
        if (parent->type != CONF_ITEM_SECTION) return;          /* only sections can have ident2 trees */
 
        fr_assert(parent->ident2 != NULL);
        fr_rb_insert(parent->ident2, child);                    /* NULL ident2 is still a value */
}
 
 
/** Remove item from parent and fixup trees
 *
 * @param[in] parent    to remove child from.
 * @param[in] child     to remove.
 * @return
 *      - The previous item (makes iteration easier)
 *      - NULL if the item wasn't set.
 */
CONF_ITEM *_cf_item_remove(CONF_ITEM *parent, CONF_ITEM *child)
{
        CONF_ITEM       *found = NULL;
        CONF_ITEM       *prev;
        bool            in_ident1, in_ident2;
 
        if (!parent || cf_item_has_no_children(parent)) return NULL;
        if (parent != child->parent) return NULL;
 
        cf_item_foreach(parent, ci) {
                if (ci == child) {
                        found = ci;
                        break;
                }
        }
 
        if (!found) return NULL;
 
        /*
         *      Fixup the linked list
         */
        prev = fr_dlist_remove(&parent->children, child);
 
        in_ident1 = (fr_rb_remove_by_inline_node(parent->ident1, &child->ident1_node) != NULL);
 
        /*
         *      Only sections can have ident2 trees.
         */
        if (parent->type != CONF_ITEM_SECTION) {
                in_ident2 = false;
        } else {
                in_ident2 = (fr_rb_remove_by_inline_node(parent->ident2, &child->ident2_node) != NULL);
        }
 
        /*
         *      Look for twins.  They weren't in the tree initially,
         *      because "child" was there.
         */
        cf_item_foreach(parent, ci) {
                if (!in_ident1 && !in_ident2) break;
 
                if (in_ident1 && (_cf_ident1_cmp(ci, child) == 0)) {
                        fr_rb_insert(parent->ident1, ci);
                        in_ident1 = false;
                }
 
                if (in_ident2 && (_cf_ident2_cmp(ci, child) == 0)) {
                        fr_rb_insert(parent->ident2, ci);
                        in_ident2 = false;
                }
        }
 
        return prev;
}
 
/** Return the next child of the CONF_ITEM
 *
 * @param[in] parent    to return children from.
 * @param[in] curr      child to start searching from.
 * @return
 *      - The next #CONF_ITEM that's a child of cs.
 *      - NULL if no more #CONF_ITEM.
 */
CONF_ITEM *_cf_item_next(CONF_ITEM const *parent, CONF_ITEM const *curr)
{
        if (!parent) return NULL;
 
        return fr_dlist_next(&parent->children, curr);
}
 
/** Return the next child of cs
 *
 * @param[in] ci        to return children from.
 * @param[in] curr      child to start searching from.
 * @return
 *      - The next #CONF_ITEM that's a child of cs.
 *      - NULL if no more #CONF_ITEM.
 */
CONF_ITEM *_cf_item_prev(CONF_ITEM const *ci, CONF_ITEM const *curr)
{
        if (!ci) return NULL;
 
        return fr_dlist_prev(&ci->children, curr);
}
 
/** Initialize a CONF_ITEM, so we don't have repeated code
 *
 * @param[in] ci        the CONF_ITEM to initialize
 * @param[in] type      the type to set
 * @param[in] parent    the parent node hosting this one
 * @param[in] filename  which caused this node to be created
 * @param[in] lineno    where in the filename
 */
static void cf_item_init(CONF_ITEM *ci, CONF_ITEM_TYPE type, CONF_ITEM *parent, char const *filename, int lineno)
{
        ci->type = type;
        ci->parent = parent;
 
        fr_dlist_init(&ci->children, CONF_ITEM, entry);
 
        if (filename) cf_filename_set(ci, filename);
        if (lineno) cf_lineno_set(ci, lineno);
}
 
/** Return the top level #CONF_SECTION holding all other #CONF_ITEM
 *
 * @param[in] ci        to traverse up from.
 * @return
 *      - NULL if ci was NULL.
 *      - The top level #CONF_SECTION
 */
CONF_SECTION *_cf_root(CONF_ITEM const *ci)
{
        CONF_ITEM const *ci_p;
 
        if (!ci) return NULL;
 
        for (ci_p = ci; ci_p->parent; ci_p = ci_p->parent);
 
        return cf_item_to_section(ci_p);
}
 
/** Return the parent of a #CONF_ITEM
 *
 * @param[in] ci        to return the parent of.
 * @return
 *      - NULL if ci was NULL or it has no parents.
 *      - The parent of ci.
 */
CONF_ITEM *_cf_parent(CONF_ITEM const *ci)
{
        if (!ci) return NULL;
 
        return ci->parent;
}
 
/** Return the lineno the #CONF_ITEM was parsed at
 *
 * @param[in] ci        to return the location of.
 * @return
 *      - -1 if the #CONF_ITEM was created programmatically.
 *      - >= 0 where in the config file the line was parsed from.
 */
int _cf_lineno(CONF_ITEM const *ci)
{
        if (!ci) return -1;
 
        return ci->lineno;
}
 
/** Return the filename the #CONF_ITEM was parsed in
 *
 * @param[in] ci        to return the location of.
 * @return
 *      - NULL if the #CONF_ITEM was created programmatically.
 *      - The path of the config file the #CONF_ITEM was located in.
 */
char const *_cf_filename(CONF_ITEM const *ci)
{
        if (!ci) return NULL;
 
        return ci->filename;
}
 
/** Determine if #CONF_ITEM is a #CONF_SECTION
 *
 * @param[in] ci        to check.
 * @return
 *      - true if ci is a #CONF_SECTION.
 *      - false if ci is another specialisation.
 */
bool cf_item_is_section(CONF_ITEM const *ci)
{
        if (!ci) return false;
 
        return ci->type == CONF_ITEM_SECTION;
}
 
/** Determine if #CONF_ITEM is a #CONF_PAIR
 *
 * @param[in] ci        to check.
 * @return
 *      - true if ci is a #CONF_PAIR.
 *      - false if ci is another specialisation.
 */
bool cf_item_is_pair(CONF_ITEM const *ci)
{
        if (!ci) return false;
 
        return ci->type == CONF_ITEM_PAIR;
}
 
/** Determine if #CONF_ITEM is #CONF_DATA
 *
 * @param[in] ci        to check.
 * @return
 *      - true if ci is #CONF_DATA.
 *      - false if ci is another specialisation.
 */
bool cf_item_is_data(CONF_ITEM const *ci)
{
        if (!ci) return false;
 
        return ci->type == CONF_ITEM_DATA;
}
 
/** Cast a #CONF_ITEM to a #CONF_PAIR
 *
 * @note Will assert if ci does not contain #CONF_PAIR.
 *
 * @param[in] ci        to cast.
 * @return
 *      - #CONF_PAIR.
 *      - NULL if ci was NULL.
 *
 * @hidecallergraph
 */
CONF_PAIR *cf_item_to_pair(CONF_ITEM const *ci)
{
        if (ci == NULL) return NULL;
 
        fr_assert(ci->type == CONF_ITEM_PAIR);
 
        return UNCONST(CONF_PAIR *, ci);
}
 
/** Cast a #CONF_ITEM to a #CONF_SECTION
 *
 * @note Will assert if ci does not contain #CONF_SECTION.
 *
 * @param[in] ci        to cast.
 * @return
 *      - #CONF_SECTION.
 *      - NULL if ci was NULL.
 *
 * @hidecallergraph
 */
CONF_SECTION *cf_item_to_section(CONF_ITEM const *ci)
{
        if (ci == NULL) return NULL;
 
        fr_assert(ci->type == CONF_ITEM_SECTION);
 
        return UNCONST(CONF_SECTION *, ci);
}
 
/** Cast #CONF_ITEM to #CONF_DATA performing a type check
 *
 * @note Will assert if ci does not contain #CONF_DATA.
 *
 * @param[in] ci        to cast.
 * @return
 *      - #CONF_DATA.
 *      - NULL if ci was NULL.
 *
 * @hidecallergraph
 */
CONF_DATA *cf_item_to_data(CONF_ITEM const *ci)
{
        if (ci == NULL) return NULL;
 
        fr_assert(ci->type == CONF_ITEM_DATA);
 
        return UNCONST(CONF_DATA *, ci);
}
 
/** Cast a #CONF_PAIR to a #CONF_ITEM
 *
 * @param[in] cp        to cast.
 * @return
 *      - The common #CONF_ITEM header.
 *      - NULL if cp was NULL.
 *
 * @hidecallergraph
 */
CONF_ITEM *cf_pair_to_item(CONF_PAIR const *cp)
{
        if (cp == NULL) return NULL;
 
        return UNCONST(CONF_ITEM *, cp);
}
 
/** Cast a #CONF_SECTION to a #CONF_ITEM
 *
 * @param[in] cs        to cast.
 * @return
 *      - The common #CONF_ITEM header.
 *      - NULL if cs was NULL.
 *
 * @hidecallergraph
 */
CONF_ITEM *cf_section_to_item(CONF_SECTION const *cs)
{
        if (cs == NULL) return NULL;
 
        return UNCONST(CONF_ITEM *, cs);
}
 
/** Cast #CONF_DATA to a #CONF_ITEM
 *
 * @param[in] cd        to cast.
 * @return
 *      - The common #CONF_ITEM header.
 *      - NULL if cd was NULL.
 *
 * @hidecallergraph
 */
CONF_ITEM *cf_data_to_item(CONF_DATA const *cd)
{
        if (cd == NULL) return NULL;
 
        return UNCONST(CONF_ITEM *, cd);
}
 
/** Determine if #CONF_ITEM is a #CONF_COMMENT.
 */
bool cf_item_is_comment(CONF_ITEM const *ci)
{
        if (!ci) return false;
        return ci->type == CONF_ITEM_COMMENT;
}
 
/** Cast a #CONF_ITEM to a #CONF_COMMENT (asserts on type mismatch).
 */
CONF_COMMENT *cf_item_to_comment(CONF_ITEM const *ci)
{
        if (ci == NULL) return NULL;
        fr_assert(ci->type == CONF_ITEM_COMMENT);
        return UNCONST(CONF_COMMENT *, ci);
}
 
/** Cast a #CONF_COMMENT back to a #CONF_ITEM.
 */
CONF_ITEM *cf_comment_to_item(CONF_COMMENT const *c)
{
        if (c == NULL) return NULL;
        return UNCONST(CONF_ITEM *, c);
}
 
char const *cf_comment_text(CONF_COMMENT const *c)
{
        if (c == NULL) return NULL;
        return c->text;
}
 
/*
 *      Off by default - the runtime server parser drops comments as it
 *      always has.  Utilities call cf_preserve_comments_set() before
 *      cf_file_read() when they want the round-trip.
 */
static bool cf_preserve_comments = false;
 
void cf_preserve_comments_set(bool preserve)
{
        cf_preserve_comments = preserve;
}
 
/*
 *      Private getter declared in cf_priv.h for cf_file.c's parser hook.
 *      Keeps cf_preserve_comments truly private to cf_util.c; the public
 *      API is the setter.
 */
bool _cf_preserve_comments(void)
{
        return cf_preserve_comments;
}
 
/*
 *      On by default - the runtime parser always wants `${foo}` resolved
 *      to the value of `foo`.  Tools like radjson2conf, which build a
 *      tree from JSON and write it back out, flip this off so values
 *      containing `${...}` round-trip verbatim instead of being resolved
 *      against an incomplete fragment tree.  $INCLUDE is a separate code
 *      path and is unaffected.
 */
static bool cf_expand_vars = true;
 
void cf_expand_variables_set(bool expand)
{
        cf_expand_vars = expand;
}
 
bool _cf_expand_variables(void)
{
        return cf_expand_vars;
}
 
CONF_COMMENT *cf_comment_alloc(CONF_SECTION *parent, char const *text)
{
        CONF_COMMENT *c;
 
        if (!parent) return NULL;
 
        c = talloc_zero(parent, CONF_COMMENT);
        if (!c) return NULL;
 
        cf_item_init(cf_comment_to_item(c), CONF_ITEM_COMMENT,
                     cf_section_to_item(parent), NULL, 0);
 
        c->text = text ? talloc_strdup(c, text) : NULL;
 
        /*
         *      Append to the parent's ordered children list, but do NOT
         *      insert into ident1 / ident2 trees - comments aren't
         *      name-keyed and shouldn't show up in cf_pair_find / cf_section_find.
         */
        fr_dlist_insert_tail(&parent->item.children, &c->item);
        return c;
}
 
/** Free a section and associated trees
 *
 * @param[in] cs        to free.
 * @return 0
 */
static int _cf_section_free(CONF_SECTION *cs)
{
        if (cs->item.ident1) TALLOC_FREE(cs->item.ident1);
        if (cs->item.ident2) TALLOC_FREE(cs->item.ident2);
 
        return 0;
}
 
/** Allocate a #CONF_SECTION
 *
 * @param[in] ctx       to allocate
 * @param[in] parent    #CONF_SECTION to hang this #CONF_SECTION off of.
 *                      If parent is not NULL, the new section will be added as a child.
 * @param[in] name1     Primary name.
 * @param[in] name2     Secondary name.
 * @param[in] filename  Caller file name for debugging.  May be overridden later.
 * @param[in] lineno    Caller line number for debugging.  May be overridden later.
 * @return
 *      - NULL on error.
 *      - A new #CONF_SECTION parented by parent.
 */
CONF_SECTION *_cf_section_alloc(TALLOC_CTX *ctx, CONF_SECTION *parent,
                                char const *name1, char const *name2,
                                char const *filename, int lineno)
{
        CONF_SECTION    *cs;
        char            buffer[1024];
 
        if (!name1) return NULL;
 
        if (name2 && parent) {
                char const *p;
 
                p = strchr(name2, '$');
                if (p && (p[1] != '{')) p = NULL;
 
                if (p) {
                        name2 = cf_expand_variables(parent->item.filename,
                                                    parent->item.lineno,
                                                    parent,
                                                    buffer, sizeof(buffer), name2, -1, NULL, false);
 
                        if (!name2) {
                                ERROR("Failed expanding section name");
                                return NULL;
                        }
                }
        }
 
        cs = talloc_zero(ctx, CONF_SECTION);
        if (!cs) return NULL;
 
        cf_item_init(cf_section_to_item(cs), CONF_ITEM_SECTION, cf_section_to_item(parent), filename, lineno);
 
        MEM(cs->name1 = talloc_strdup(cs, name1));
        if (name2) {
                MEM(cs->name2 = talloc_strdup(cs, name2));
                cs->name2_quote = T_BARE_WORD;
        }
        talloc_set_destructor(cs, _cf_section_free);
 
        if (parent) {
                CONF_DATA const *cd;
                conf_parser_t *rule;
 
                /*
                 *      Look up the parents parsing rules for itself.
                 *      If there are rules, then one of them might be
                 *      parsing rules for this new child.  If that
                 *      happens, we push the child parsing rules to
                 *      this new child.
                 */
                cd = cf_data_find(CF_TO_ITEM(parent), conf_parser_t, cf_section_name1(parent));
                if (cd) {
                        rule = cf_data_value(cd);
 
                        if ((rule->flags & CONF_FLAG_SUBSECTION) &&
                            rule->on_read && rule->subcs) {
                                conf_parser_t const *rule_p;
 
                                for (rule_p = rule->subcs; rule_p->name1; rule_p++) {
                                        if ((rule_p->flags & CONF_FLAG_SUBSECTION) &&
                                            rule_p->on_read &&
                                            (strcmp(rule_p->name1, name1) == 0)) {
                                                if (_cf_section_rule_push(cs, rule_p,
                                                                          cd->item.filename, cd->item.lineno) < 0) {
                                                error:
                                                        talloc_free(cs);
                                                        return NULL;
                                                }
 
                                                if (rule_p->on_read(ctx, NULL, NULL,
                                                                 cf_section_to_item(cs), rule_p) < 0) goto error;
                                                goto done;
                                        }
                                }
                        }
                }
 
                /*
                 *      Or, the parent may already have parse rules
                 *      for this new child.  In which case we push the
                 *      child rules for this section, and then do the
                 *      on_read callback.
                 */
                cd = cf_data_find(CF_TO_ITEM(parent), conf_parser_t, name1);
                if (cd) {
                        rule = cf_data_value(cd);
                        if ((rule->flags & CONF_FLAG_SUBSECTION) &&
                            rule->on_read) {
                                if (cf_section_rules_push(cs, rule->subcs) < 0) goto error;
                                if (rule->on_read(ctx, NULL, NULL, cf_section_to_item(cs), rule) < 0) goto error;
                        }
                }
 
        done:
                cs->depth = parent->depth + 1;
                cf_item_add(parent, &(cs->item));
        }
 
        return cs;
}
 
/** Set the filename of a #CONF_ITEM
 *
 * @param[in] ci        to set filename on.
 * @param[in] filename  to set.
 */
void _cf_filename_set(CONF_ITEM *ci, char const *filename)
{
        talloc_const_free(ci->filename);
 
        ci->filename = talloc_strdup(ci, filename);
}
 
/** Set the line number of a #CONF_ITEM
 *
 * @param[in] ci        to set the lineno for.
 * @param[in] lineno    to set.
 */
void _cf_lineno_set(CONF_ITEM *ci, int lineno)
{
        ci->lineno = lineno;
}
 
/** Duplicate a configuration section
 *
 * @note recursively duplicates any child sections.
 * @note does not duplicate any data associated with a section, or its child sections.
 *
 * @param[in] ctx       to allocate memory in.
 * @param[in] parent    section (may be NULL).
 * @param[in] cs        to duplicate.
 * @param[in] name1     of new section.
 * @param[in] name2     of new section.
 * @param[in] copy_meta Copy additional meta data for a section
 *                      (like template, base, depth, parsed state,
 *                      and variables).
 * @return
 *      - A duplicate of the existing section.
 *      - NULL on error.
 */
CONF_SECTION *cf_section_dup(TALLOC_CTX *ctx, CONF_SECTION *parent, CONF_SECTION const *cs,
                             char const *name1, char const *name2, bool copy_meta)
{
        CONF_SECTION       *out, *dst;
        CONF_SECTION const *src;
        CONF_ITEM const    *ci;
 
        /*
         *      Create the new output section.
         */
        out = cf_section_alloc(ctx, parent, name1, name2);
 
        if (copy_meta) {
                out->template = cs->template;
                out->base = cs->base;
                out->depth = cs->depth;
        }
 
        cf_filename_set(out, cs->item.filename);
        cf_lineno_set(out, cs->item.lineno);
 
        /*
         *      Start copying children of the input.
         */
        src = cs;
        ci = NULL;
        dst = out;
 
        /*
         *      Do this iteratively, because it's nicer than using the C stack.
         */
        while (true) {
                CONF_SECTION *src_child, *dst_child;
                CONF_PAIR *cp;
 
                /*
                 *      Go to the next child.  If there is none, then try to go back up to the parent.
                 */
                ci = fr_dlist_next(&src->item.children, ci);
                if (!ci) {
                        /*
                         *      We're back at the top, and we have no more children.  We can stop looping.
                         */
                        if (src == cs) break;
 
                        /*
                         *      The current child is what we were just copying.  The parent is now the childs
                         *      parent.
                         */
                        ci = &src->item;
                        src = cf_item_to_section(src->item.parent);
                        dst = cf_item_to_section(dst->item.parent);
                        continue;
                }
 
                fr_assert(ci != cf_section_to_item(cs));
                fr_assert(ci != cf_section_to_item(parent));
 
                switch (ci->type) {
                case CONF_ITEM_SECTION:
                        src_child = cf_item_to_section(ci);
                        dst_child = cf_section_alloc(dst, dst, src_child->name1, src_child->name2);
                        if (!dst_child) {
                        oom:
                                talloc_free(out);
                                return NULL;
                        }
 
                        if (copy_meta) {
                                dst_child->template = src_child->template;
                                dst_child->base = src_child->base;
                                dst_child->depth = src_child->depth;
                        }
 
                        dst_child->item.filename = src_child->item.filename;
                        dst_child->item.lineno = src_child->item.lineno;
 
                        /*
                         *      Descend into the child so its children get copied too.
                         */
                        src = src_child;
                        dst = dst_child;
                        ci = NULL;
                        continue;
 
                case CONF_ITEM_PAIR:
                        cp = cf_pair_dup(dst, cf_item_to_pair(ci), copy_meta);
                        if (!cp) goto oom;
                        break;
 
                case CONF_ITEM_DATA: /* Skip data */
                        break;
 
                case CONF_ITEM_COMMENT:
                        /*
                         *      Preserve comment lines when duplicating a section -
                         *      it costs almost nothing and round-tripping utilities
                         *      stay correct.
                         */
                        {
                                CONF_COMMENT const *src_co = cf_item_to_comment(ci);
                                CONF_COMMENT *dst_co = cf_comment_alloc(dst, src_co->text);
 
                                if (!dst_co) goto oom;
 
                                cf_filename_set(dst_co, src_co->item.filename);
                                cf_lineno_set(dst_co, src_co->item.lineno);
                        }
                        break;
 
                case CONF_ITEM_INVALID:
                        fr_assert(0);
                }
        }
 
        return out;
}
 
/** Return the first child in a CONF_SECTION
 *
 * @param[in] cs        to return children from.
 * @return
 *      - The next #CONF_ITEM that's a child of cs and a CONF_SECTION.
 *      - NULL if no #CONF_ITEM matches that criteria.
 */
CONF_SECTION *cf_section_first(CONF_SECTION const *cs)
{
        return cf_item_to_section(cf_next(cf_section_to_item(cs), NULL, CONF_ITEM_SECTION));
}
 
/** Return the next child that's a #CONF_SECTION
 *
 * @param[in] cs        to return children from.
 * @param[in] curr      child to start searching from.
 * @return
 *      - The next #CONF_ITEM that's a child of cs and a CONF_SECTION.
 *      - NULL if no #CONF_ITEM matches that criteria.
 */
CONF_SECTION *cf_section_next(CONF_SECTION const *cs, CONF_SECTION const *curr)
{
        return cf_item_to_section(cf_next(cf_section_to_item(cs), cf_section_to_item(curr), CONF_ITEM_SECTION));
}
 
/** Return the previous child that's a #CONF_SECTION
 *
 * @param[in] cs        to return children from.
 * @param[in] curr      child to start searching from.
 * @return
 *      - The next #CONF_ITEM that's a child of cs and a CONF_SECTION.
 *      - NULL if no #CONF_ITEM matches that criteria.
 */
CONF_SECTION *cf_section_prev(CONF_SECTION const *cs, CONF_SECTION const *curr)
{
        return cf_item_to_section(cf_prev(cf_section_to_item(cs), cf_section_to_item(curr), CONF_ITEM_SECTION));
}
 
/** Find a CONF_SECTION with name1 and optionally name2.
 *
 * @param[in] cs        The section we're searching in.
 * @param[in] name1     of the section we're searching for. Special value CF_IDENT_ANY
 *                      can be used to match any name1 value.
 * @param[in] name2     of the section we're searching for. Special value CF_IDENT_ANY
 *                      can be used to match any name2 value.
 * @return
 *      - The first matching subsection.
 *      - NULL if no subsections match.
 *
 * @hidecallergraph
 */
CONF_SECTION *cf_section_find(CONF_SECTION const *cs,
                              char const *name1, char const *name2)
{
        return cf_item_to_section(cf_find(cf_section_to_item(cs), CONF_ITEM_SECTION, name1, name2));
}
 
/** Return the next matching section
 *
 * @param[in] cs        The section we're searching in.
 * @param[in] prev      section we found.  May be NULL in which case
 *                      we just return the next section after prev.
 * @param[in] name1     of the section we're searching for.  Special value CF_IDENT_ANY
 *                      can be used to match any name1 value.
 * @param[in] name2     of the section we're searching for.  Special value CF_IDENT_ANY
 *                      can be used to match any name2 value.
 * @return
 *      - The next CONF_SECTION.
 *      - NULL if there are no more CONF_SECTIONs
 *
 * @hidecallergraph
 */
CONF_SECTION *cf_section_find_next(CONF_SECTION const *cs, CONF_SECTION const *prev,
                                   char const *name1, char const *name2)
{
        return cf_item_to_section(cf_find_next(cf_section_to_item(cs), cf_section_to_item(prev),
                                               CONF_ITEM_SECTION, name1, name2));
}
 
/** Find an ancestor of the passed CONF_ITEM which has a child matching a specific name1 and optionally name2.
 *
 * @note Despite the name, this function also searches in ci for a matching item.
 *
 * Will walk up the configuration tree, searching in each parent until a matching section is found or
 * we hit the root.
 *
 * @param[in] ci        The conf item we're searching back from.
 * @param[in] name1     of the section we're searching for. Special value CF_IDENT_ANY
 *                      can be used to match any name1 value.
 * @param[in] name2     of the section we're searching for. Special value CF_IDENT_ANY
 *                      can be used to match any name2 value.
 * @return
 *      - The first matching subsection.
 *      - NULL if no subsections match.
 */
CONF_SECTION *_cf_section_find_in_parent(CONF_ITEM const *ci,
                                         char const *name1, char const *name2)
{
        do {
                CONF_ITEM *found;
 
                found = cf_find(ci, CONF_ITEM_SECTION, name1, name2);
                if (found) return cf_item_to_section(found);
        } while ((ci = cf_parent(ci)));
 
        return NULL;
}
 
/** Find a parent CONF_SECTION with name1 and optionally name2.
 *
 * @param[in] ci        The section we're searching in.
 * @param[in] name1     of the section we're searching for. Special value CF_IDENT_ANY
 *                      can be used to match any name1 value.
 * @param[in] name2     of the section we're searching for. Special value CF_IDENT_ANY
 *                      can be used to match any name2 value.
 * @return
 *      - The first matching subsection.
 *      - NULL if no subsections match.
 */
CONF_SECTION *_cf_section_find_parent(CONF_ITEM const *ci,
                                      char const *name1, char const *name2)
{
        while ((ci = cf_parent(ci))) {
                CONF_SECTION *found;
 
                if (!cf_item_is_section(ci)) continue;  /* Could be data hanging off a pair*/
 
                found = cf_item_to_section(ci);
 
                if (cf_section_name_cmp(found, name1, name2) == 0) return found;
        }
 
        return NULL;
}
 
/** Find a pair in a #CONF_SECTION
 *
 * @param[in] cs        the #CONF_SECTION to search in.
 * @param[in] attr      to search for.
 * @return
 *      - NULL if no pair can be found.
 *      - The value of the pair found.
 */
char const *cf_section_value_find(CONF_SECTION const *cs, char const *attr)
{
        CONF_PAIR       *cp;
 
        cp = cf_pair_find(cs, attr);
 
        return (cp ? cp->value : NULL);
}
 
/** Check if a given section matches the specified name1/name2 identifiers
 *
 * @param[in] cs        to check.
 * @param[in] name1     identifier.  May be CF_IDENT_ANY for wildcard matches.
 * @param[in] name2     identifier.  May be CF_IDENT_ANY for wildcard matches.
 * @return
 *      - >1 if cs is greater than the identifiers.
 *      - 0 if cs matches the identifiers.
 *      - <0 if cs is less than the identifiers.
 */
int8_t cf_section_name_cmp(CONF_SECTION const *cs, char const *name1, char const *name2)
{
        int8_t ret;
 
        if (name1 != CF_IDENT_ANY) {
                ret = CMP(strcmp(cf_section_name1(cs), name1), 0);
                if (ret != 0) return ret;
        }
 
        if (name2 != CF_IDENT_ANY) {
                char const *cs_name2 = cf_section_name2(cs);
 
                if (!cs_name2) {
                        if (!name2) return 0;
                        return 1;
                }
                if (!name2) return -1;
 
                return CMP(strcmp(cs_name2, name2), 0);
        }
 
        return 0;
}
 
/** Return the first identifier of a #CONF_SECTION
 *
 * @param[in] cs        to return identifiers for.
 * @return
 *      - The first identifier.
 *      - NULL if cs was NULL or no name1 set.
 *
 * @hidecallergraph
 */
char const *cf_section_name1(CONF_SECTION const *cs)
{
        return (cs ? cs->name1 : NULL);
}
 
/** Return the second identifier of a #CONF_SECTION
 *
 * @param[in] cs        to return identifiers for.
 * @return
 *      - The second identifier.
 *      - NULL if cs was NULL or no name2 set.
 *
 * @hidecallergraph
 */
char const *cf_section_name2(CONF_SECTION const *cs)
{
        return (cs ? cs->name2 : NULL);
}
 
/** Return name2 if set, else name1
 *
 * @param[in] cs        to return identifiers for.
 * @return name1 or name2 identifier.
 *
 * @hidecallergraph
 */
char const *cf_section_name(CONF_SECTION const *cs)
{
        char const *name;
 
        name = cf_section_name2(cs);
        if (name) return name;
 
        return cf_section_name1(cs);
}
 
/** Return variadic argument at the specified index
 *
 * @param[in] cs        containing the arguments.
 * @param[in] argc      Argument index. Note name1 and name2 are not counted in this index.
 * @return the argument value or NULL.
 */
char const *cf_section_argv(CONF_SECTION const *cs, int argc)
{
        if (!cs || !cs->argv || (argc < 0) || (argc >= cs->argc)) return NULL;
 
        return cs->argv[argc];
}
 
/** Return the quoting of the name2 identifier
 *
 * @param[in] cs        containing name2.
 * @return
 *      - #T_BARE_WORD.
 *      - #T_SINGLE_QUOTED_STRING.
 *      - #T_BACK_QUOTED_STRING.
 *      - #T_DOUBLE_QUOTED_STRING.
 *      - #T_INVALID if cs was NULL.
 */
fr_token_t cf_section_name2_quote(CONF_SECTION const *cs)
{
        if (!cs) return T_INVALID;
 
        return cs->name2_quote;
}
 
/** Return the quoting for one of the variadic arguments
 *
 * @param[in] cs        containing the arguments.
 * @param[in] argc      Argument index.  Note name1 and name2 are not counted in this index.
 * @return
 *      - #T_BARE_WORD.
 *      - #T_SINGLE_QUOTED_STRING.
 *      - #T_BACK_QUOTED_STRING.
 *      - #T_DOUBLE_QUOTED_STRING.
 *      - #T_INVALID if cs was NULL or the index was invalid.
 */
fr_token_t cf_section_argv_quote(CONF_SECTION const *cs, int argc)
{
        if (!cs || !cs->argv_quote || (argc < 0) || (argc >= cs->argc)) return T_INVALID;
 
        return cs->argv_quote[argc];
}
 
/** Allocate a #CONF_PAIR
 *
 * @param[in] parent            #CONF_SECTION to hang this #CONF_PAIR off of.
 * @param[in] attr              name.
 * @param[in] value             of #CONF_PAIR.
 * @param[in] op                #T_OP_EQ, #T_OP_SET etc.
 * @param[in] lhs_quote         #T_BARE_WORD, #T_DOUBLE_QUOTED_STRING, #T_BACK_QUOTED_STRING.
 * @param[in] rhs_quote         #T_BARE_WORD, #T_DOUBLE_QUOTED_STRING, #T_BACK_QUOTED_STRING.
 * @return
 *      - NULL on error.
 *      - A new #CONF_SECTION parented by parent.
 */
CONF_PAIR *cf_pair_alloc(CONF_SECTION *parent, char const *attr, char const *value,
                         fr_token_t op, fr_token_t lhs_quote, fr_token_t rhs_quote)
{
        CONF_PAIR *cp;
 
        fr_assert(fr_comparison_op[op] || fr_assignment_op[op] || fr_binary_op[op]);
        if (!attr) return NULL;
 
        cp = talloc_zero(parent, CONF_PAIR);
        if (!cp) return NULL;
 
        cf_item_init(cf_pair_to_item(cp), CONF_ITEM_PAIR, cf_section_to_item(parent), NULL, 0);
 
        cp->lhs_quote = lhs_quote;
        cp->rhs_quote = rhs_quote;
        cp->op = op;
 
        cp->attr = talloc_strdup(cp, attr);
        if (!cp->attr) {
        error:
                talloc_free(cp);
                return NULL;
        }
 
        if (value) {
                cp->value = talloc_strdup(cp, value);
                if (!cp->value) goto error;
        }
 
        cf_item_add(parent, &(cp->item));
        return cp;
}
 
/** Duplicate a #CONF_PAIR
 *
 * @param parent        to allocate new pair in.
 * @param cp            to duplicate.
 * @param copy_meta     Copy additional meta data for a pair
 * @return
 *      - NULL on error.
 *      - A duplicate of the input pair.
 */
CONF_PAIR *cf_pair_dup(CONF_SECTION *parent, CONF_PAIR *cp, bool copy_meta)
{
        CONF_PAIR *new;
 
        fr_assert(parent);
        fr_assert(cp);
 
        new = cf_pair_alloc(parent, cp->attr, cf_pair_value(cp), cp->op, cp->lhs_quote, cp->rhs_quote);
        if (!new) return NULL;
 
        if (copy_meta) {
                new->item.parsed = cp->item.parsed;
                new->item.referenced = cp->item.referenced;
        }
        cf_lineno_set(new, cp->item.lineno);
        cf_filename_set(new, cp->item.filename);
 
        return new;
}
 
/** Replace pair value in a given section with the given value.
 *
 * @note A new pair with the same metadata as the #CONF_PAIR will be added
 *      even if the #CONF_PAIR can't be found inside the #CONF_SECTION.
 *
 * @param[in] cs        to replace pair in.
 * @param[in] cp        to replace.
 * @param[in] value     New value to assign to cp.
 * @return
 *      - 0 on success.
 *      - -1 on failure.
 */
int cf_pair_replace(CONF_SECTION *cs, CONF_PAIR *cp, char const *value)
{
        if (!cs || !cp || !value) return -1;
 
        talloc_const_free(cp->value);
 
        MEM(cp->value = talloc_strdup(cp, value));
 
        return 0;
}
 
 
/** Mark an item as parsed
 *
 * @param[in] ci        to mark as parsed.
 */
void _cf_item_mark_parsed(CONF_ITEM *ci)
{
        ci->parsed = true;
}
 
/** Return whether an item has already been parsed
 *
 * @param[in] ci        to check.
 * @return
 *      - true if item has been parsed.
 *      - false if the pair hasn't been parsed.
 */
bool _cf_item_is_parsed(CONF_ITEM *ci)
{
        return ci->parsed;
}
 
/** Return the first child that's a #CONF_PAIR
 *
 * @param[in] cs        to return children from.
 * @return
 *      - The first #CONF_ITEM that's a child of cs and a CONF_PAIR.
 *      - NULL if no #CONF_ITEM matches that criteria.
 */
CONF_PAIR *cf_pair_first(CONF_SECTION const *cs)
{
        return cf_item_to_pair(cf_next(cf_section_to_item(cs), NULL, CONF_ITEM_PAIR));
}
 
/** Return the next child that's a #CONF_PAIR
 *
 * @param[in] cs        to return children from.
 * @param[in] curr      child to start searching from.
 * @return
 *      - The next #CONF_ITEM that's a child of cs and a CONF_PAIR.
 *      - NULL if no #CONF_ITEM matches that criteria.
 */
CONF_PAIR *cf_pair_next(CONF_SECTION const *cs, CONF_PAIR const *curr)
{
        return cf_item_to_pair(cf_next(cf_section_to_item(cs), cf_pair_to_item(curr), CONF_ITEM_PAIR));
}
 
/** Return the previous child that's a #CONF_PAIR
 *
 * @param[in] cs        to return children from.
 * @param[in] curr      child to start searching from.
 * @return
 *      - The previous #CONF_ITEM that's a child of cs and a CONF_PAIR.
 *      - NULL if no #CONF_ITEM matches that criteria.
 */
CONF_PAIR *cf_pair_prev(CONF_SECTION const *cs, CONF_PAIR const *curr)
{
        return cf_item_to_pair(cf_prev(cf_section_to_item(cs), cf_pair_to_item(curr), CONF_ITEM_PAIR));
}
 
/** Search for a #CONF_PAIR with a specific name
 *
 * @param[in] cs        to search in.
 * @param[in] attr      to find.
 * @return
 *      - The next matching #CONF_PAIR.
 *      - NULL if none matched.
 */
CONF_PAIR *cf_pair_find(CONF_SECTION const *cs, char const *attr)
{
        return cf_item_to_pair(cf_find(cf_section_to_item(cs), CONF_ITEM_PAIR, attr, NULL));
}
 
/** Find a pair with a name matching attr, after specified pair
 *
 * @param[in] cs        to search in.
 * @param[in] prev      Pair to search from (may be NULL).
 * @param[in] attr      to find (may be NULL in which case any attribute matches).
 * @return
 *      - The next matching #CONF_PAIR
 *      - NULL if none matched.
 */
CONF_PAIR *cf_pair_find_next(CONF_SECTION const *cs, CONF_PAIR const *prev, char const *attr)
{
        return cf_item_to_pair(cf_find_next(cf_section_to_item(cs), cf_pair_to_item(prev), CONF_ITEM_PAIR, attr, NULL));
}
 
/** Find a pair with a name matching attr in the specified section or one of its parents
 *
 * @param[in] cs        to search in.  Will start in the current section
 *                      and work upwards.
 * @param[in] attr      to find.
 * @return
 *      - A matching #CONF_PAIR.
 *      - NULL if none matched.
 */
CONF_PAIR *cf_pair_find_in_parent(CONF_SECTION const *cs, char const *attr)
{
        CONF_ITEM const *parent = cf_section_to_item(cs);
 
        do {
                CONF_ITEM *found;
 
                found = cf_find(parent, CONF_ITEM_PAIR, attr, NULL);
                if (found) return cf_item_to_pair(found);
        } while ((parent = cf_parent(parent)));
 
        return NULL;
}
 
/** Callback to determine the number of pairs in a section
 *
 * @param[out] count    Where we store the number of pairs found.
 * @param[in] cs        we're currently searching in.
 */
static void _pair_count(int *count, CONF_SECTION const *cs)
{
        CONF_ITEM const *ci = NULL;
 
        while ((ci = cf_item_next(cs, ci))) {
                if (cf_item_is_section(ci)) {
                        _pair_count(count, cf_item_to_section(ci));
                        continue;
                }
 
                (*count)++;
        }
}
 
/** Count the number of conf pairs beneath a section
 *
 * @param[in] cs to search for items in.
 * @return The number of pairs nested within section.
 */
unsigned int cf_pair_count_descendents(CONF_SECTION const *cs)
{
        int count = 0;
 
        _pair_count(&count, cs);
 
        return count;
}
 
/** Count the number of times an attribute occurs in a parent section
 *
 * @param[in] cs        to search for items in.
 * @param[in] attr      to search for.
 * @return The number of pairs of that attribute type.
 */
unsigned int cf_pair_count(CONF_SECTION const *cs, char const *attr)
{
        size_t          i;
        CONF_PAIR       *cp = NULL;
 
        for (i = 0; (cp = cf_pair_find_next(cs, cp, attr)); i++);
 
        return i;
}
 
/** Concatenate the values of any pairs with name attr
 *
 * @param[out] out      where to write the concatenated values.
 * @param[in] cs        to search in.
 * @param[in] attr      to search for.
 * @param[in] sep       to use to separate values
 * @return
 *      - Length of the data written to out on success.
 *      - < 0 on failure.  Number of additional bytes required in buffer.
 */
fr_slen_t cf_pair_values_concat(fr_sbuff_t *out, CONF_SECTION const *cs, char const *attr, char const *sep)
{
        fr_sbuff_t              our_out = FR_SBUFF(out);
        CONF_PAIR               *cp;
        fr_slen_t               slen = 0;
        fr_sbuff_escape_rules_t e_rules = {
                                        .name = __FUNCTION__,
                                        .chr = '\\'
                                };
 
        if (sep) e_rules.subs[(uint8_t)*sep] = *sep;
 
        for (cp = cf_pair_find(cs, attr); cp;) {
                char const *value = cf_pair_value(cp);
 
                cp = cf_pair_find_next(cs, cp, attr);
 
                if (!value) continue;
 
                slen = fr_sbuff_in_escape(&our_out, value, strlen(value), &e_rules);
                if (slen < 0) return slen;
 
                if (cp && sep) {
                        slen = fr_sbuff_in_strcpy(&our_out, sep);
                        if (slen < 0) return slen;
                }
        }
 
        FR_SBUFF_SET_RETURN(out, &our_out);
}
 
/** Return the attr of a #CONF_PAIR
 *
 * Return the LHS value of a pair (the attribute).
 *
 * @param[in] pair      to return the attribute for.
 * @return
 *      - NULL if the pair was NULL.
 *      - The attribute name of the pair.
 *
 * @hidecallergraph
 */
char const *cf_pair_attr(CONF_PAIR const *pair)
{
        return (pair ? pair->attr : NULL);
}
 
/** Return the value of a #CONF_PAIR
 *
 * Return the RHS value of a pair (the value).
 *
 * @param[in]   pair to return the value of.
 * @return
 *      - NULL if pair was NULL or the pair has no value.
 *      - The string value of the pair.
 *
 * @hidecallergraph
 */
char const *cf_pair_value(CONF_PAIR const *pair)
{
        return (pair ? pair->value : NULL);
}
 
/** Return the operator of a pair
 *
 * @param[in] pair      to return the operator of.
 * @return
 *      - T_INVALID if pair was NULL.
 *      - T_OP_* (one of the operator constants).
 *
 * @hidecallergraph
 */
fr_token_t cf_pair_operator(CONF_PAIR const *pair)
{
        return (pair ? pair->op : T_INVALID);
}
 
/** Return the value (lhs) quoting of a pair
 *
 * @param pair to extract value type from.
 * @return
 *      - #T_BARE_WORD.
 *      - #T_SINGLE_QUOTED_STRING.
 *      - #T_BACK_QUOTED_STRING.
 *      - #T_DOUBLE_QUOTED_STRING.
 *      - #T_INVALID if the pair is NULL.
 */
fr_token_t cf_pair_attr_quote(CONF_PAIR const *pair)
{
        return (pair ? pair->lhs_quote : T_INVALID);
}
 
/** Return the value (rhs) quoting of a pair
 *
 * @param pair to extract value type from.
 * @return
 *      - #T_BARE_WORD.
 *      - #T_SINGLE_QUOTED_STRING.
 *      - #T_BACK_QUOTED_STRING.
 *      - #T_DOUBLE_QUOTED_STRING.
 *      - #T_INVALID if the pair is NULL.
 */
fr_token_t cf_pair_value_quote(CONF_PAIR const *pair)
{
        return (pair ? pair->rhs_quote : T_INVALID);
}
 
/** Free user data associated with #CONF_DATA
 *
 * @param[in] cd        being freed.
 * @return 0
 */
static int _cd_free(CONF_DATA *cd)
{
        return talloc_free(UNCONST(void *, cd->data));
}
 
/** Allocate a new user data container
 *
 * @param[in] parent    #CONF_PAIR, or #CONF_SECTION to hang CONF_DATA off of.
 * @param[in] data      being added.
 * @param[in] type      of data being added.
 * @param[in] name      String identifier of the user data.
 * @param[in] do_free   function, called when the parent #CONF_SECTION is being freed.
 * @return
 *      - CONF_DATA on success.
 *      - NULL on error.
 */
static CONF_DATA *cf_data_alloc(CONF_ITEM *parent, void const *data, char const *type, char const *name, bool do_free)
{
        CONF_DATA *cd;
 
        cd = talloc_zero(parent, CONF_DATA);
        if (!cd) return NULL;
 
        cf_item_init(cf_data_to_item(cd), CONF_ITEM_DATA, parent, NULL, 0);
 
        /*
         *      strdup so if the data is freed, we can
         *      still remove it from the section without
         *      explosions.
         */
        if (data) {
                cd->type = talloc_strdup(cd, type);
                cd->data = data;
        }
        if (name) cd->name = talloc_strdup(cd, name);
 
        if (do_free) talloc_set_destructor(cd, _cd_free);
 
        cf_item_add(parent, cd);
        return cd;
}
 
/** Find user data in a config section
 *
 * @param[in] ci        The section to search for data in.
 * @param[in] type      of user data.  Used for name spacing and walking over a specific
 *                      type of user data.
 * @param[in] name      String identifier of the user data.  Special value CF_IDENT_ANY
 *                      may be used to match on type only.
 * @return
 *      - The user data.
 *      - NULL if no user data exists.
 */
CONF_DATA const *_cf_data_find(CONF_ITEM const *ci, char const *type, char const *name)
{
        return cf_item_to_data(cf_find(ci, CONF_ITEM_DATA, type, name));
}
 
/** Return the next item of user data
 *
 * @param[in] ci        The section to search for data in.
 * @param[in] prev      section we found.  May be NULL in which case
 *                      we just return the next section after prev.
 * @param[in] type      of user data.  Used for name spacing and walking over a specific
 *                      type of user data.
 * @param[in] name      String identifier of the user data.  Special value CF_IDENT_ANY
 *                      can be used to match any name2 value.
 * @return
 *      - The next matching #CONF_DATA.
 *      - NULL if there is no more matching #CONF_DATA.
 */
CONF_DATA const *_cf_data_find_next(CONF_ITEM const *ci, CONF_ITEM const *prev, char const *type, char const *name)
{
        return cf_item_to_data(cf_find_next(ci, prev, CONF_ITEM_DATA, type, name));
}
 
/** Find matching data in the specified section or one of its parents
 *
 * @param[in] ci        The section to search for data in.
 * @param[in] type      of user data.  Used for name spacing and walking over a specific
 *                      type of user data.
 * @param[in] name      String identifier of the user data.  Special value CF_IDENT_ANY
 *                      may be used to match on type only.
 * @return
 *      - The next matching #CONF_DATA.
 *      - NULL if there is no more matching #CONF_DATA.
 */
CONF_DATA *_cf_data_find_in_parent(CONF_ITEM const *ci, char const *type, char const *name)
{
        CONF_ITEM const *parent = ci;
 
        do {
                CONF_ITEM *found;
 
                found = cf_find(parent, CONF_ITEM_DATA, type, name);
                if (found) return cf_item_to_data(found);
        } while ((parent = cf_parent(parent)));
 
        return NULL;
}
 
/** Return the user assigned value of #CONF_DATA
 *
 * @param[in] cd        to return value of.
 * @return the user data stored within the #CONF_DATA.
 */
void *cf_data_value(CONF_DATA const *cd)
{
        void *to_return;
 
        if (!cd) return NULL;
 
        memcpy(&to_return, &cd->data, sizeof(to_return));
 
        return to_return;
}
 
/** Add talloced user data to a config section
 *
 * @param[in] ci        to add data to.
 * @param[in] data      to add.
 * @param[in] name      String identifier of the user data.
 * @param[in] do_free   Function to free user data when the CONF_SECTION is freed.
 * @param[in] filename  Source file the #CONF_DATA was added in.
 * @param[in] lineno    the #CONF_DATA was added at.
 * @return
 *      - #CONF_DATA  - opaque handle to the stored data - on success.
 *      - NULL error.
 */
CONF_DATA const *_cf_data_add(CONF_ITEM *ci, void const *data, char const *name, bool do_free,
                              char const *filename, int lineno)
{
        CONF_DATA       *cd;
        CONF_DATA const *found;
        char const      *type = NULL;
 
        if (!ci) return NULL;
 
        if (data) type = talloc_get_name(data);
 
        /*
         *      Already exists.  Can't add it.
         */
        found = _cf_data_find(ci, type, name);
        if (found) {
                return NULL;
        }
 
        cd = cf_data_alloc(ci, data, type, name, do_free);
        if (!cd) {
                cf_log_err(ci, "Failed allocating data");
                return NULL;
        }
        cd->is_talloced = true;
        cf_filename_set(cd, filename);
        cf_lineno_set(cd, lineno);
 
        return cd;
}
 
/** Add non-talloced user data to a config section
 *
 * @param[in] ci        to add data to.
 * @param[in] data      to add.
 * @param[in] type      identifier of the user data.
 * @param[in] name      String identifier of the user data.
 * @param[in] filename  Source file the #CONF_DATA was added in.
 * @param[in] lineno    the #CONF_DATA was added at.
 *      - #CONF_DATA  - opaque handle to the stored data - on success.
 *      - NULL error.
 */
CONF_DATA const *_cf_data_add_static(CONF_ITEM *ci, void const *data, char const *type, char const *name,
                                     char const *filename, int lineno)
{
        CONF_DATA *cd;
        CONF_DATA const *found;
 
        /*
         *      Already exists.  Can't add it.
         */
        found = _cf_data_find(ci, type, name);
        if (found) {
                /*
                 *      Suppress these, as it's OK for the conf_parser_t in main_config.c
                 */
                if (strcmp(type, "conf_parser_t") == 0) return NULL;
 
                cf_log_err(ci, "Data of type %s with name \"%s\" already exists.  Existing data added %s[%i]", type,
                           name, found->item.filename, found->item.lineno);
                return NULL;
        }
 
        cd = cf_data_alloc(ci, data, type, name, false);
        if (!cd) {
                cf_log_err(ci, "Failed allocating data");
                return NULL;
        }
        cd->is_talloced = false;
        cf_filename_set(cd, filename);
        cf_lineno_set(cd, lineno);
 
        return cd;
}
 
/** Remove data from a configuration section
 *
 * @note If cd was not found it will not be freed, and it is the caller's responsibility
 *      to free it explicitly, or free the section it belongs to.
 *
 * @param[in] parent    to remove data from.
 * @param[in] cd        opaque handle of the stored data.
 * @return
 *      - The value stored within the data (if cd is valid and was found and removed).
 *      - NULL if not found.
 */
void *_cf_data_remove(CONF_ITEM *parent, CONF_DATA const *cd)
{
        void *data;
 
        if (!cd) return NULL;
 
        (void)cf_item_remove(parent, cd);
 
        talloc_set_destructor(cd, NULL);        /* Disarm the destructor */
        memcpy(&data, &cd->data, sizeof(data));
        talloc_const_free(cd);
 
        return data;
}
 
/** Walk over a specific type of CONF_DATA
 *
 * @param[in] ci        containing the CONF_DATA to walk over.
 * @param[in] type      of CONF_DATA to walk over.
 * @param[in] cb        to call when we find CONF_DATA of the specified type.
 * @param[in] ctx       to pass to cb.
 * @return
 *      - 0 on success.
 *      - -1 on failure.
 */
int _cf_data_walk(CONF_ITEM *ci, char const *type, cf_walker_t cb, void *ctx)
{
        CONF_DATA                       *cd;
        CONF_ITEM                       *item;
        fr_rb_tree_t                    *tree;
        fr_rb_iter_inorder_t    iter;
        int                             ret = 0;
 
        if (!ci->ident2) return 0;
 
        tree = ci->ident2;
 
        for (item = fr_rb_iter_init_inorder(tree, &iter);
             item;
             item = fr_rb_iter_next_inorder(tree, &iter)) {
                /*
                 *      We're walking ident2, not all of the items will be data
                 */
                if (item->type != CONF_ITEM_DATA) continue;
 
                cd = (void *) item;
                if ((cd->type != type) && (strcmp(cd->type, type) != 0)) continue;
 
                ret = cb(UNCONST(void *, cd->data), ctx);
                if (ret) {
                        break;
                }
        }
 
        return ret;
}
 
static inline CC_HINT(nonnull) void truncate_filename(char const **e, char const **p, int *len, char const *filename)
{
        size_t flen;
        char const *q;
 
        #define FILENAME_TRUNCATE       60
 
        *p = filename;
        *e = "";
 
        flen = talloc_strlen(filename);
        if (flen <= FILENAME_TRUNCATE) {
                *len = (int)flen;
                return;
        }
 
        *p += flen - FILENAME_TRUNCATE;
        *len = FILENAME_TRUNCATE;
 
        q = strchr(*p, FR_DIR_SEP);
        if (q) {
                q++;
                *len -= (q - *p);
                *p += (q - *p);
        }
 
        *e = "...";
}
 
/** Check to see if the CONF_PAIR value is present in the specified table
 *
 * If it's not present, return an error and produce a helpful log message
 *
 * @param[out] out      The result of parsing the pair value.
 * @param[in] table     to look for string values in.
 * @param[in] table_len Length of the table.
 * @param[in] cp        to parse.
 * @return
 *      - 0 on success.
 *      - -1 on failure.
 */
int cf_pair_in_table(int32_t *out, fr_table_num_sorted_t const *table, size_t table_len, CONF_PAIR *cp)
{
        char                            *list = NULL;
        int32_t                         res;
        size_t                          i;
 
        res = fr_table_value_by_str(table, cf_pair_value(cp), FR_TABLE_NOT_FOUND);
        if (res != FR_TABLE_NOT_FOUND) {
                *out = res;
                return 0;
        }
 
        for (i = 0; i < table_len; i++) MEM(list = talloc_asprintf_append_buffer(list, "'%s', ", table[i].name.str));
 
        if (!list) {
                cf_log_err(cp, "Internal error parsing %s: Table was empty", cf_pair_attr(cp));
                return -1;
        }
 
        /*
         *      Trim the final ", "
         */
        MEM(list = talloc_bstr_realloc(NULL, list, talloc_array_length(list) - 2));
 
        cf_log_err(cp, "Invalid value \"%s\". Expected one of %s", cf_pair_value(cp), list);
 
        talloc_free(list);
 
        return -1;
}
 
/** Log an error message relating to a #CONF_ITEM
 *
 * @param[in] type      of log message.
 * @param[in] ci        #CONF_ITEM to print file/lineno for.
 * @param[in] file      src file the log message was generated in.
 * @param[in] line      number the log message was generated on.
 * @param[in] fmt       of the message.
 * @param[in] ap        Message args.
 */
void _cf_vlog(fr_log_type_t type, CONF_ITEM const *ci, char const *file, int line, char const *fmt, va_list ap)
{
        va_list aq;
 
        if ((type == L_DBG) && !DEBUG_ENABLED) return;
 
        if (!ci || !ci->filename || !*ci->filename || (*ci->filename == '<') ||
            (((type == L_DBG) || (type == L_INFO)) && !DEBUG_ENABLED4)) {
                va_copy(aq, ap);
                fr_vlog(LOG_DST, type, file, line, fmt, aq);
                va_end(aq);
                return;
        }
 
        {
                char const      *e, *p;
                int             len;
                char            *msg;
 
                truncate_filename(&e, &p, &len, ci->filename);
 
                va_copy(aq, ap);
                msg = fr_vasprintf(NULL, fmt, aq);
                va_end(aq);
 
                fr_log(LOG_DST, type, file, line, "%s%.*s[%d]: %s", e, len, p, ci->lineno, msg);
                talloc_free(msg);
        }
}
 
/** Log an error message relating to a #CONF_ITEM
 *
 * @param[in] type      of log message.
 * @param[in] file      src file the log message was generated in.
 * @param[in] line      number the log message was generated on.
 * @param[in] ci        #CONF_ITEM to print file/lineno for.
 * @param[in] fmt       of the message.
 * @param[in] ...       Message args.
 */
void _cf_log(fr_log_type_t type, CONF_ITEM const *ci, char const *file, int line, char const *fmt, ...)
{
        va_list ap;
 
        if ((type == L_DBG) && !DEBUG_ENABLED) return;
 
        va_start(ap, fmt);
        _cf_vlog(type, ci, file, line, fmt, ap);
        va_end(ap);
}
 
/** Log an error message relating to a #CONF_ITEM
 *
 * Drains the fr_strerror() stack emitting one or more error messages.
 *
 * @param[in] type      of log message.
 * @param[in] file      src file the log message was generated in.
 * @param[in] line      number the log message was generated on.
 * @param[in] ci        #CONF_ITEM to print file/lineno for.
 * @param[in] f_rules   Additional optional formatting controls.
 * @param[in] fmt       of the message.
 * @param[in] ap        Message args.
 */
void _cf_vlog_perr(fr_log_type_t type, CONF_ITEM const *ci, char const *file, int line,
                   fr_log_perror_format_t const *f_rules, char const *fmt, va_list ap)
{
        va_list aq;
 
        if ((type == L_DBG) && !DEBUG_ENABLED) return;
 
        if (!ci || !ci->filename) {
                va_copy(aq, ap);
                fr_vlog_perror(LOG_DST, type, file, line, f_rules, fmt, aq);
                va_end(aq);
                return;
        }
 
        {
                char const              *e, *p;
                int                     len;
                char                    *prefix;
                TALLOC_CTX              *thread_log_pool;
                TALLOC_CTX              *pool;
                fr_log_perror_format_t  our_f_rules;
 
                if (f_rules) {
                        our_f_rules = *f_rules;
                } else {
                        our_f_rules = (fr_log_perror_format_t){};
                }
 
                /*
                 *      Get some scratch space from the logging code
                 */
                thread_log_pool = fr_log_pool_init();
                pool = talloc_new(thread_log_pool);
 
                truncate_filename(&e, &p, &len, ci->filename);
 
                /*
                 *      Create the file location string
                 */
                prefix = fr_asprintf(pool, "%s%.*s[%d]: ", e, len, p, ci->lineno);
 
                /*
                 *      Prepend it to an existing first prefix
                 */
                if (f_rules && f_rules->first_prefix) {
                        char *first;
 
                        first = talloc_bstrdup(pool, prefix);
                        MEM(talloc_strndup_append_buffer(first, f_rules->first_prefix, SIZE_MAX));
 
                        our_f_rules.first_prefix = first;
                } else {
                        our_f_rules.first_prefix = prefix;
                }
 
                /*
                 *      Prepend it to an existing subsq prefix
                 */
                if (f_rules && f_rules->subsq_prefix) {
                        char *subsq;
 
                        subsq = talloc_bstrdup(pool, prefix);
                        MEM(talloc_strndup_append_buffer(subsq, f_rules->subsq_prefix, SIZE_MAX));
 
                        our_f_rules.subsq_prefix = subsq;
                } else {
                        our_f_rules.subsq_prefix = prefix;
                }
 
                va_copy(aq, ap);
                fr_vlog_perror(LOG_DST, type, file, line, &our_f_rules, fmt, aq);
                va_end(aq);
 
                talloc_free(pool);
        }
}
 
/** Log an error message relating to a #CONF_ITEM
 *
 * Drains the fr_strerror() stack emitting one or more error messages.
 *
 * @param[in] type      of log message.
 * @param[in] file      src file the log message was generated in.
 * @param[in] line      number the log message was generated on.
 * @param[in] ci        #CONF_ITEM to print file/lineno for.
 * @param[in] f_rules   Additional optional formatting controls.
 * @param[in] fmt       of the message.
 * @param[in] ...       Message args.
 */
void _cf_log_perr(fr_log_type_t type, CONF_ITEM const *ci, char const *file, int line,
                  fr_log_perror_format_t const *f_rules, char const *fmt, ...)
{
        va_list ap;
 
        if ((type == L_DBG) && !DEBUG_ENABLED) return;
 
        va_start(ap, fmt);
        _cf_vlog_perr(type, ci, file, line, f_rules, fmt, ap);
        va_end(ap);
}
 
/** Log a debug message relating to a #CONF_ITEM
 *
 * Always emits a filename/lineno prefix if available
 *
 * @param[in] type      of log message.
 * @param[in] file      src file the log message was generated in.
 * @param[in] line      number the log message was generated on.
 * @param[in] ci        #CONF_ITEM to print file/lineno for.
 * @param[in] fmt       of the message.
 * @param[in] ...       Message args.
 */
void _cf_log_with_filename(fr_log_type_t type, CONF_ITEM const *ci, char const *file, int line, char const *fmt, ...)
{
        va_list ap;
 
        if ((type == L_DBG) && !DEBUG_ENABLED) return;
 
        if (!ci || !ci->filename) {
                va_start(ap, fmt);
                fr_vlog(LOG_DST, type, file, line, fmt, ap);
                va_end(ap);
                return;
        }
 
        {
                char const      *e, *p;
                int             len;
                char            *msg;
 
                truncate_filename(&e, &p, &len, ci->filename);
 
                va_start(ap, fmt);
                msg = fr_vasprintf(NULL, fmt, ap);
                va_end(ap);
 
                fr_log(LOG_DST, type, file, line, "%s%.*s[%d]: %s", e, len, p, ci->lineno, msg);
                talloc_free(msg);
        }
}
 
/** Log an error message in the context of a child pair of the specified parent
 *
 * @param[in] parent    containing the pair.
 * @param[in] child     name to use as a logging context.
 * @param[in] type      of log message.
 * @param[in] file      src file the log message was generated in.
 * @param[in] line      number the log message was generated on.
 * @param[in] fmt       of the message.
 * @param[in] ...       Message args.
 */
void _cf_log_by_child(fr_log_type_t type, CONF_SECTION const *parent, char const *child,
                      char const *file, int line, char const *fmt, ...)
{
        va_list         ap;
        CONF_PAIR const *cp;
 
        cp = cf_pair_find(parent, child);
        if (cp) {
                va_start(ap, fmt);
                _cf_vlog(type, CF_TO_ITEM(cp), file, line, fmt, ap);
                va_end(ap);
                return;
        }
 
        va_start(ap, fmt);
        _cf_vlog(type, CF_TO_ITEM(parent), file, line, fmt, ap);
        va_end(ap);
}
 
 
/** Log an error message in the context of a child pair of the specified parent
 *
 * @param[in] parent    containing the pair.
 * @param[in] child     name to use as a logging context.
 * @param[in] type      of log message.
 * @param[in] file      src file the log message was generated in.
 * @param[in] line      number the log message was generated on.
 * @param[in] f_rules   Line prefixes.
 * @param[in] fmt       of the message.
 * @param[in] ...       Message args.
 */
void _cf_log_perr_by_child(fr_log_type_t type, CONF_SECTION const *parent, char const *child,
                           char const *file, int line, fr_log_perror_format_t const *f_rules,
                           char const *fmt, ...)
{
        va_list         ap;
        CONF_PAIR const *cp;
 
        cp = cf_pair_find(parent, child);
        if (cp) {
                va_start(ap, fmt);
                _cf_vlog_perr(type, CF_TO_ITEM(cp), file, line, f_rules, fmt, ap);
                va_end(ap);
                return;
        }
 
        va_start(ap, fmt);
        _cf_vlog_perr(type, CF_TO_ITEM(parent), file, line, f_rules, fmt, ap);
        va_end(ap);
}
 
/** Print out debugging information about a CONFIG_ITEM
 *
 * @param[in] ci        being debugged.
 */
void _cf_item_debug(CONF_ITEM const *ci)
{
        /*
         *      Print summary of the item
         */
        switch (ci->type) {
        case CONF_ITEM_SECTION:
        {
                CONF_SECTION const *cs = cf_item_to_section(ci);
                int i;
 
                DEBUG("SECTION - %p", cs);
                DEBUG("  name1         : %s", cs->name1);
                DEBUG("  name2         : %s", cs->name2 ? cs->name2 : "<none>");
                DEBUG("  name2_quote   : %s", fr_table_str_by_value(fr_token_quotes_table, cs->name2_quote, "<INVALID>"));
                DEBUG("  argc          : %d", cs->argc);
 
                for (i = 0; i < cs->argc; i++) {
                        char const *quote = fr_table_str_by_value(fr_token_quotes_table, cs->argv_quote[i], "<INVALID>");
                        DEBUG("  argv[%i]      : %s%s%s", i, quote, cs->argv[i], quote);
                }
        }
                break;
 
        case CONF_ITEM_PAIR:
        {
                CONF_PAIR const *cp = cf_item_to_pair(ci);
 
                DEBUG("PAIR - %p", cp);
                DEBUG("  attr          : %s", cp->attr);
                DEBUG("  value         : %s", cp->value);
                DEBUG("  operator      : %s", fr_table_str_by_value(fr_tokens_table, cp->op, "<INVALID>"));
                DEBUG("  lhs_quote     : %s", fr_table_str_by_value(fr_token_quotes_table, cp->lhs_quote, "<INVALID>"));
                DEBUG("  rhs_quote     : %s", fr_table_str_by_value(fr_token_quotes_table, cp->rhs_quote, "<INVALID>"));
                DEBUG("  pass2         : %s", cp->pass2 ? "yes" : "no");
                DEBUG("  parsed        : %s", cp->item.parsed ? "yes" : "no");
        }
                break;
 
        case CONF_ITEM_DATA:
        {
                CONF_DATA const *cd = cf_item_to_data(ci);
 
                DEBUG("DATA - %p", cd);
                DEBUG("  type          : %s", cd->type);
                DEBUG("  name          : %s", cd->name);
                DEBUG("  data          : %p", cd->data);
        }
                break;
 
        default:
                DEBUG("INVALID - %p", ci);
                return;
        }
 
        DEBUG("  filename      : %s", ci->filename);
        DEBUG("  line          : %i", ci->lineno);
        if (ci->parent) DEBUG("  next          : %p", fr_dlist_next(&ci->parent->children, ci));
        DEBUG("  parent        : %p", ci->parent);
        DEBUG("  children      : %s", cf_item_has_no_children(ci) ? "no" : "yes");
        DEBUG("  ident1 tree   : %p (%u entries)", ci->ident1, ci->ident1 ? fr_rb_num_elements(ci->ident1) : 0);
        DEBUG("  ident2 tree   : %p (%u entries)", ci->ident2, ci->ident2 ? fr_rb_num_elements(ci->ident2) : 0);
 
        if (cf_item_has_no_children(ci)) return;
 
        /*
         *      Print summary of the item's children
         */
        DEBUG("CHILDREN");
 
        cf_item_foreach(ci, child) {
                char const *in_ident1, *in_ident2;
 
                in_ident1 = fr_rb_find(ci->ident1, child) == child? "in ident1 " : "";
 
                if (ci->type != CONF_ITEM_SECTION) {
                        in_ident2 = NULL;
                } else {
                        in_ident2 = fr_rb_find(ci->ident2, child) == child? "in ident2 " : "";
                }
 
                switch (child->type) {
                case CONF_ITEM_SECTION:
                {
                        CONF_SECTION const *cs = cf_item_to_section(child);
 
                        DEBUG("  SECTION %p (%s %s) %s%s", child, cs->name1, cs->name2 ? cs->name2 : "<none>",
                              in_ident1, in_ident2);
                }
                        break;
 
                case CONF_ITEM_PAIR:
                {
                        CONF_PAIR const *cp = cf_item_to_pair(child);
                        char const      *lhs_quote = fr_table_str_by_value(fr_token_quotes_table, cp->lhs_quote, "<INVALID>");
                        char const      *rhs_quote = fr_table_str_by_value(fr_token_quotes_table, cp->rhs_quote, "<INVALID>");
 
                        DEBUG("  PAIR %p (%s%s%s %s %s%s%s) %s%s", child,
                              lhs_quote, cp->attr, lhs_quote,
                              fr_table_str_by_value(fr_tokens_table, cp->op, "<INVALID>"),
                              rhs_quote, cp->value, rhs_quote,
                              in_ident1, in_ident2);
                }
                        break;
 
                case CONF_ITEM_DATA:
                {
                        CONF_DATA const *cd = cf_item_to_data(child);
 
                        DEBUG("  DATA %p (%s *)%s = %p %s%s", child,
                              cd->type, cd->name ? cd->name : "", cd->data,
                              in_ident1, in_ident2);
                        break;
                }
 
                default:
                        DEBUG("  INVALID - %p", child);
                        break;
                }
        }
}
 
/** Ease of use from debugger
 */
void cf_pair_debug(CONF_PAIR *cp)
{
        cf_item_debug(cp);
}
 
/** Ease of use from debugger
 */
void cf_section_debug(CONF_SECTION *cs)
{
        cf_item_debug(cs);
}
 
/*
 *      Used when we don't need the children any more, as with
 *
 *              if (0) { ... }
 */
void cf_item_free_children(CONF_ITEM *ci)
{
        CONF_ITEM *child;
 
        while ((child = cf_item_next(ci, NULL)) != NULL) {
                _cf_item_remove(ci, child);
        }
}
 
void _cf_canonicalize_error(CONF_ITEM *ci, ssize_t slen, char const *msg, char const *str)
{
        char *spaces, *text;
 
        fr_canonicalize_error(ci, &spaces, &text, slen, str);
 
        cf_log_err(ci, "%s", msg);
        cf_log_err(ci, "%s", text);
        cf_log_perr(ci, "%s^", spaces);
 
        talloc_free(spaces);
        talloc_free(text);
}
 
/*
 *      Create or find a CONF_PAIR, including parents.
 *
 *      This is only used by the command-line argument '-S foo.bar=baz'
 */
int cf_pair_replace_or_add(CONF_SECTION *cs, char const *ref, char const *value)
{
        char *name2;
        CONF_PAIR *cp;
        char buffer[256];
 
        while (*ref) {
                char *p;
                CONF_SECTION *subcs;
 
                p = strchr(ref, '.');
                if (!p) break;
 
                p++;
                if (*p == '[') {
                        size_t len;
 
                        name2 = p + 1;
                        p = strchr(name2, ']'); /* doesn't support nesting, too bad */
                        if (!p) {
                                fr_strerror_printf("Missing ']' after %s", name2);
                                return -1;
                        }
 
                        len = (size_t) (p - name2);
                        if (len >= sizeof(buffer)) {
                                fr_strerror_printf("Reference in '[...]' is too long after %s", name2);
                                return -1;
                        }
                        memcpy(buffer, name2, len);
                        buffer[len] = '\0';
                        name2 = buffer;
 
                } else {
                        name2 = NULL;
                }
 
                subcs = cf_section_find(cs, ref, name2);
                if (!subcs) {
                        subcs = cf_section_alloc(cs, cs, ref, name2);
                        if (!subcs) return -1;
                }
 
                cs = subcs;
                ref = p;
        }
 
        cp = cf_pair_find(cs, ref);
        if (cp) return cf_pair_replace(cs, cp, value);
 
        cp = cf_pair_alloc(cs, ref, value, T_OP_EQ, T_BARE_WORD, T_BARE_WORD);
        if (!cp) return -1;
 
        return 0;
}