timeout.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: 285d661597ef41df7d15f4a0acc2d29850e89ece $
 *
 * @file unlang/timeout.c
 * @brief Unlang "timeout" keyword evaluation.
 *
 * @copyright 2022 Network RADIUS SAS (legal@networkradius.com)
 */
RCSID("$Id: 285d661597ef41df7d15f4a0acc2d29850e89ece $")
 
#include <freeradius-devel/unlang/timeout.h>
#include <freeradius-devel/unlang/interpret.h>
#include <freeradius-devel/server/rcode.h>
#include "group_priv.h"
#include "timeout_priv.h"
#include "mod_action.h"
#include "unlang_priv.h"
 
typedef struct {
        bool                                    fired;
        int                                     depth;
        fr_time_delta_t                         timeout;
        request_t                               *request;
        rindent_t                               indent;
        fr_timer_t                              *ev;
 
        fr_value_box_list_t                     result;
 
        unlang_t                                *instruction;   //!< to run on timeout
} unlang_frame_state_timeout_t;
 
/** Immediately cancel the timeout if the frame is cancelled
 */
static void unlang_timeout_signal(UNUSED request_t *request, unlang_stack_frame_t *frame, fr_signal_t action)
{
        unlang_frame_state_timeout_t    *state = talloc_get_type_abort(frame->state, unlang_frame_state_timeout_t);
 
        if (action == FR_SIGNAL_CANCEL) {
                TALLOC_FREE(state->ev);
        }
}
 
static void unlang_timeout_handler(UNUSED fr_timer_list_t *tl, UNUSED fr_time_t now, void *ctx)
{
        unlang_frame_state_timeout_t    *state = talloc_get_type_abort(ctx, unlang_frame_state_timeout_t);
        request_t                       *request = talloc_get_type_abort(state->request, request_t);
        unlang_stack_t                  *stack = request->stack;
        unlang_stack_frame_t            *frame = &stack->frame[stack->depth];
        char const                      *module;
 
        /*
         *      Don't log in the context of the request
         */
        module = request->module;
        request->module = NULL;
        RDEBUG("Timeout reached, signalling interpreter to cancel child section.");
        request->module = module;
 
        /*
         *      Signal all the frames upto, but not including the timeout
         *      frame to cancel.
         *
         *      unlang_timeout_resume_done then runs, and returns "timeout"
         */
        unlang_stack_signal(request, FR_SIGNAL_CANCEL, state->depth);
 
        /*
         *      If the frame is yielded (needs to be resumed), but was cancelled
         *      we now need to mark it runnable again so it's unwound.
         *
         *      If the frame _isn't_ cancelled, then it's non-cancellable and
         *      something else will run it to completion, and mark
         *      the request as complete.
         */
        if (is_yielded(frame) && is_unwinding(frame) && !unlang_request_is_scheduled(request)) unlang_interpret_mark_runnable(request);
        state->fired = true;
 
        RINDENT_RESTORE(request, state);
 
        if (!state->instruction) return;
 
        /*
         *      Push something else onto the stack to execute.
         */
        if (unlikely(unlang_interpret_push_instruction(request, state->instruction, RLM_MODULE_TIMEOUT, true) < 0)) {
                unlang_interpret_signal(request, FR_SIGNAL_CANCEL); /* also stops the request and does cleanups */
        }
}
 
static unlang_action_t unlang_timeout_resume_done(UNUSED rlm_rcode_t *p_result, UNUSED request_t *request, unlang_stack_frame_t *frame)
{
        unlang_frame_state_timeout_t    *state = talloc_get_type_abort(frame->state, unlang_frame_state_timeout_t);
 
        /*
         *      No timeout, we go to the next instruction.
         *
         *      Unless the next instruction is a "catch timeout", in which case we skip it.
         */
        if (!state->fired) return UNLANG_ACTION_CALCULATE_RESULT;
 
        RETURN_MODULE_TIMEOUT;
}
 
static unlang_action_t unlang_timeout_set(rlm_rcode_t *p_result, request_t *request, unlang_stack_frame_t *frame)
{
        unlang_frame_state_timeout_t    *state = talloc_get_type_abort(frame->state, unlang_frame_state_timeout_t);
 
        /*
         *      Save current indentation for the error path.
         */
        RINDENT_SAVE(state, request);
 
        if (fr_timer_in(state, unlang_interpret_event_list(request)->tl, &state->ev, state->timeout,
                        false, unlang_timeout_handler, state) < 0) {
                RPEDEBUG("Failed inserting event");
                return UNLANG_ACTION_STOP_PROCESSING;
        }
 
        frame_repeat(frame, unlang_timeout_resume_done);
 
        return unlang_interpret_push_children(p_result, request, frame->result, UNLANG_NEXT_SIBLING);
}
 
static unlang_action_t unlang_timeout_done(rlm_rcode_t *p_result, request_t *request, unlang_stack_frame_t *frame)
{
        unlang_frame_state_timeout_t    *state = talloc_get_type_abort(frame->state, unlang_frame_state_timeout_t);
        fr_value_box_t                  *box = fr_value_box_list_head(&state->result);
 
        /*
         *      compile_timeout() ensures that the tmpl is cast to time_delta, so we don't have to do any more work here.
         */
        state->timeout = box->vb_time_delta;
 
        return unlang_timeout_set(p_result, request, frame);
}
 
static unlang_action_t unlang_timeout(rlm_rcode_t *p_result, request_t *request, unlang_stack_frame_t *frame)
{
        unlang_group_t                  *g;
        unlang_timeout_t                *gext;
        unlang_frame_state_timeout_t    *state = talloc_get_type_abort(frame->state, unlang_frame_state_timeout_t);
        unlang_stack_t                  *stack = request->stack;
 
        g = unlang_generic_to_group(frame->instruction);
        gext = unlang_group_to_timeout(g);
 
        /*
         *      +1 so we don't mark the timeout frame as cancelled,
         *      we want unlang_timeout_resume_done to be called.
         */
        state->depth = stack->depth + 1;
        state->request = request;
 
        if (!gext->vpt) {
                state->timeout = gext->timeout;
                return unlang_timeout_set(p_result, request, frame);
        }
 
        fr_value_box_list_init(&state->result);
 
        if (unlang_tmpl_push(state, &state->result, request, gext->vpt, NULL) < 0) return UNLANG_ACTION_FAIL;
 
        frame_repeat(frame, unlang_timeout_done);
 
        return UNLANG_ACTION_PUSHED_CHILD;
}
 
/** When a timeout fires, run the given section.
 *
 * @param[in] request           to push timeout onto
 * @param[in] timeout           when to run the timeout
 * @param[in] cs                section to run when the timeout fires.
 * @param[in] top_frame         Set to UNLANG_TOP_FRAME if the interpreter should return.
 *                              Set to UNLANG_SUB_FRAME if the interprer should continue.
 *
 * @return
 *      - 0 on success.
 *      - -1 on failure.
 */
int unlang_timeout_section_push(request_t *request, CONF_SECTION *cs, fr_time_delta_t timeout, bool top_frame)
{
        /** Static instruction for performing xlat evaluations
         *
         */
        static unlang_t timeout_instruction = {
                .type = UNLANG_TYPE_TIMEOUT,
                .name = "timeout",
                .debug_name = "timeout",
                .actions = {
                        .actions = {
                                [RLM_MODULE_REJECT]     = 0,
                                [RLM_MODULE_FAIL]       = MOD_ACTION_RETURN,    /* Exit out of nested levels */
                                [RLM_MODULE_OK]         = 0,
                                [RLM_MODULE_HANDLED]    = 0,
                                [RLM_MODULE_INVALID]    = 0,
                                [RLM_MODULE_DISALLOW]   = 0,
                                [RLM_MODULE_NOTFOUND]   = 0,
                                [RLM_MODULE_NOOP]       = 0,
                                [RLM_MODULE_TIMEOUT]    = MOD_ACTION_RETURN,    /* Exit out of nested levels */
                                [RLM_MODULE_UPDATED]    = 0
                        },
                        .retry = RETRY_INIT,
                },
        };
 
        unlang_frame_state_timeout_t    *state;
        unlang_stack_t                  *stack = request->stack;
        unlang_stack_frame_t            *frame;
        unlang_t                        *instruction;
 
        /*
         *      Get the instruction we are supposed to run on timeout.
         */
        instruction = (unlang_t *)cf_data_value(cf_data_find(cs, unlang_group_t, NULL));
        if (!instruction) {
                REDEBUG("Failed to find pre-compiled unlang for section %s { ... }",
                        cf_section_name1(cs));
                return -1;
        }
 
        /*
         *      Push a new timeout frame onto the stack
         */
        if (unlang_interpret_push(request, &timeout_instruction,
                                  RLM_MODULE_NOT_SET, UNLANG_NEXT_STOP, top_frame) < 0) return -1;
        frame = &stack->frame[stack->depth];
 
        /*
         *      Allocate its state, and set the timeout.
         */
        MEM(frame->state = state = talloc_zero(stack, unlang_frame_state_timeout_t));
 
        RINDENT_SAVE(state, request);
        state->depth = stack->depth;
        state->request = request;
        state->timeout = timeout;
        state->instruction = instruction;
 
        if (fr_timer_in(state, unlang_interpret_event_list(request)->tl, &state->ev, timeout,
                        false, unlang_timeout_handler, state) < 0) {
                RPEDEBUG("Failed setting timeout for section %s", cf_section_name1(cs));
                return -1;
        }
 
        frame_repeat(frame, unlang_timeout_resume_done);
 
        return 0;
 
}
 
void unlang_timeout_init(void)
{
        unlang_register(UNLANG_TYPE_TIMEOUT,
                        &(unlang_op_t){
                                .name = "timeout",
                                .interpret = unlang_timeout,
                                .flag = UNLANG_OP_FLAG_DEBUG_BRACES | UNLANG_OP_FLAG_RCODE_SET,
                                .signal = unlang_timeout_signal,
                                .frame_state_size = sizeof(unlang_frame_state_timeout_t),
                                .frame_state_type = "unlang_frame_state_timeout_t",
                        });
}