parallel_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: 06c615a810e7f062e57a6e2d71aafcb206e264b6 $
 *
 * @file unlang/parallel_priv.h
 * @brief Declarations for the unlang "parallel" keyword
 *
 * Should be moved into parallel.c when the parallel stuff is fully extracted
 * from interpret.c
 *
 * @copyright 2006-2019 The FreeRADIUS server project
 */
#include "unlang_priv.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/** Parallel child states
 *
 */
typedef enum {
        CHILD_INIT = 0,                                 //!< Initial state.
        CHILD_RUNNABLE,                                 //!< Running/runnable.
        CHILD_EXITED,                                   //!< Child has exited
        CHILD_DETACHED,                                 //!< Child has detached.
        CHILD_CANCELLED,                                //!< Child was cancelled.
        CHILD_DONE                                      //!< The child has completed.
} unlang_parallel_child_state_t;
 
/** Each parallel child has a state, and an associated request
 *
 */
typedef struct {
        int                             num;            //!< The child number.
 
        unlang_parallel_child_state_t   state;          //!< State of the child.
        request_t                       *request;       //!< Child request.
        char                            *name;          //!< Cache the request name.
        unlang_t const                  *instruction;   //!< broken out of g->children
} unlang_parallel_child_t;
 
typedef struct {
        rlm_rcode_t                     result;
        int                             priority;
 
        int                             num_children;   //!< How many children are executing.
        int                             num_complete;   //!< How many children are complete.
 
        bool                            detach;         //!< are we creating the child detached
        bool                            clone;          //!< are the children cloned
 
        unlang_parallel_child_t         children[];     //!< Array of children.
} unlang_parallel_state_t;
 
typedef struct {
        unlang_group_t                  group;
        bool                            detach;         //!< are we creating the child detached
        bool                            clone;
} unlang_parallel_t;
 
/** Cast a group structure to the parallel keyword extension
 *
 */
static inline unlang_parallel_t *unlang_group_to_parallel(unlang_group_t *g)
{
        return talloc_get_type_abort(g, unlang_parallel_t);
}
 
/** Cast a parallel keyword extension to a group structure
 *
 */
static inline unlang_group_t *unlang_parallel_to_group(unlang_parallel_t *parallel)
{
        return (unlang_group_t *)parallel;
}
 
#ifdef __cplusplus
}
#endif