The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Loading...
Searching...
No Matches
subrequest.c
Go to the documentation of this file.
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
15 */
16
17/**
18 * $Id: 93a90459efc7a1da935e3e09fe6edd97185d6e8d $
19 *
20 * @file unlang/subrequest.c
21 * @brief Unlang "subrequest" and "detach" keyword evaluation.
22 *
23 * @copyright 2006-2019 The FreeRADIUS server project
24 */
25
26RCSID("$Id: 93a90459efc7a1da935e3e09fe6edd97185d6e8d $")
27
28#include <freeradius-devel/server/state.h>
29#include <freeradius-devel/server/tmpl_dcursor.h>
30#include "unlang_priv.h"
31#include "interpret_priv.h"
32#include "subrequest_priv.h"
33#include "child_request_priv.h"
34
35/** Send a signal from parent request to subrequest
36 *
37 */
39#ifndef NDEBUG
40 UNUSED
41#endif
42 request_t *request, unlang_stack_frame_t *frame, fr_signal_t action)
43{
44 unlang_child_request_t *cr = talloc_get_type_abort(frame->state, unlang_child_request_t);
45 request_t *child = talloc_get_type_abort(cr->request, request_t);
46
47 switch (cr->state) {
48 case CHILD_DETACHED:
49 RDEBUG3("subrequest detached during its execution - Not sending signal to child");
50 return;
51
52 case CHILD_CANCELLED:
53 RDEBUG3("subrequest is cancelled - Not sending signal to child");
54 return;
55
56 case CHILD_RUNNABLE:
57 fr_assert_msg(!unlang_request_is_scheduled(request), "Parent cannot be runnable if child has not completed");
58 break;
59
60 default:
61 break;
62 }
63
64 /*
65 * Parent should never receive a detach
66 * signal whilst the child is running.
67 *
68 * Only the child receives a detach
69 * signal when the detach keyword is used.
70 */
71 fr_assert(action != FR_SIGNAL_DETACH);
72
73 /*
74 * If the server is stopped, inside a breakpoint,
75 * whilst processing a child, on resumption both
76 * requests (parent and child) may need to be
77 * cancelled as they've both hit max request_time.
78 *
79 * Sometimes the child will run to completion before
80 * the cancellation is processed, but the parent
81 * will still be cancelled.
82 *
83 * When the parent is cancelled this function is
84 * executed, which will signal an already stopped
85 * child to cancel itself.
86 *
87 * This triggers asserts in the time tracking code.
88 *
89 * ...so we check to see if the child is done before
90 * sending a signal.
91 */
92 if (unlang_request_is_done(child)) return;
93
94 /*
95 * Forward other signals to the child
96 */
97 unlang_interpret_signal(child, action);
98}
99
100/** Parent being resumed after a child completes
101 *
102 */
105{
107 unlang_child_request_t *cr = talloc_get_type_abort(frame->state, unlang_child_request_t);
108 request_t *child = cr->request;
110
111 /*
112 * Child detached
113 */
114 if (cr->state == CHILD_DETACHED) {
115 RDEBUG3("subrequest detached during its execution - Not updating rcode or reply attributes");
116
117 /*
118 * If the child detached the subrequest section
119 * should become entirely transparent, and
120 * should not update the section rcode.
121 */
123 }
124
125 RDEBUG3("subrequest completed with rcode %s",
127
128 /*
129 * If there's a no destination tmpl, we're done.
130 */
131 if (!child->reply) {
134 }
135
136 /*
137 * Otherwise... copy reply attributes into the
138 * specified destination.
139 */
141 if (gext->dst) {
142 fr_pair_t *vp = NULL;
144 fr_dcursor_t cursor;
145
146 /*
147 * Use callback to build missing destination container.
148 */
149 vp = tmpl_dcursor_build_init(NULL, request, &cc, &cursor, request, gext->dst, tmpl_dcursor_pair_build, NULL);
150 if (!vp) {
151 RPDEBUG("Discarding subrequest attributes - Failed allocating groups");
153 return UNLANG_ACTION_FAIL;
154 }
155
156 MEM(fr_pair_list_copy(vp, &vp->vp_group, &child->reply_pairs) >= 0);
157
159 }
160
163}
164
165/** Allocates a new subrequest and initialises it
166 *
167 */
169{
170 unlang_child_request_t *cr = talloc_get_type_abort(frame->state, unlang_child_request_t);
171 request_t *child;
172 fr_pair_t *vp;
173
176
177 /*
178 * This should only be set for manually pushed subrequests
179 */
180 fr_assert(!cr->config.free_child);
181
182 /*
183 * Initialize the state
184 */
186 if (unlang_list_empty(&g->children)) RETURN_UNLANG_NOOP;
187
189 child = unlang_io_subrequest_alloc(request, gext->dict, UNLANG_DETACHABLE);
190 if (!child) {
191 fail:
192 talloc_free(child);
193 return UNLANG_ACTION_FAIL;
194 }
195 /*
196 * Set the packet type.
197 */
198 MEM(vp = fr_pair_afrom_da(child->request_ctx, gext->attr_packet_type));
199 if (gext->type_enum) {
200 child->packet->code = vp->vp_uint32 = gext->type_enum->value->vb_uint32;
201 } else {
202 fr_dict_enum_value_t const *type_enum;
203 fr_pair_t *attr;
204
205 if (tmpl_find_vp(&attr, request, gext->vpt) < 0) {
206 RDEBUG("Failed finding attribute %s", gext->vpt->name);
207 goto fail;
208 }
209
210 if (tmpl_attr_tail_da(gext->vpt)->type == FR_TYPE_STRING) {
211 type_enum = fr_dict_enum_by_name(gext->attr_packet_type, attr->vp_strvalue, attr->vp_length);
212 if (!type_enum) {
213 RDEBUG("Unknown Packet-Type %pV", &attr->data);
214 goto fail;
215 }
216
217 child->packet->code = vp->vp_uint32 = type_enum->value->vb_uint32;
218 } else {
219 fr_value_box_t box;
220
221 fr_value_box_init(&box, FR_TYPE_UINT32, NULL, false);
222 if (fr_value_box_cast(request, &box, FR_TYPE_UINT32, NULL, &attr->data) < 0) {
223 RDEBUG("Failed casting value from %pV to data type uint32", &attr->data);
224 goto fail;
225 }
226
227 /*
228 * Check that the value is known to the server.
229 *
230 * If it isn't known, then there's no
231 * "recv foo" section for it and we can't
232 * do anything with this packet.
233 */
234 type_enum = fr_dict_enum_by_value(gext->attr_packet_type, &box);
235 if (!type_enum) {
236 RDEBUG("Invalid value %pV for Packet-Type", &box);
237 goto fail;
238 }
239
240 child->packet->code = vp->vp_uint32 = box.vb_uint32;
241 }
242
243 }
244 fr_pair_append(&child->request_pairs, vp);
245
246 if ((gext->src) && (tmpl_copy_pair_children(child->request_ctx, &child->request_pairs, request, gext->src) < -1)) {
247 RPEDEBUG("Failed copying source attributes into subrequest");
248 goto fail;
249 }
250
251 /*
252 * Setup the child so it'll inform us when
253 * it resumes, or if it detaches.
254 *
255 * frame->instruction should be consistent
256 * as it's allocated by the unlang compiler.
257 */
258 if (unlang_child_request_init(cr, cr, child, p_result, NULL, frame->instruction, false) < 0) goto fail;
259
260 /*
261 * Push the first instruction the child's
262 * going to run.
263 */
264 if (unlang_interpret_push(NULL, child, unlang_list_head(&g->children),
266 UNLANG_NEXT_SIBLING) < 0) goto fail;
267
268 /*
269 * Finally, setup the function that will be
270 * called when the child indicates the
271 * parent should be resumed.
272 */
274
275 /*
276 * This is a common function, either pushed
277 * onto the parent's stack, or called directly
278 * from the subrequest instruction..
279 */
280 return unlang_subrequest_child_run(p_result, request, frame); /* returns UNLANG_ACTION_YIELD */
281}
282
283/** Free a child request, detaching it from its parent and freeing allocated memory
284 *
285 * @param[in] child to free.
286 */
288{
289 request_detach(*child);
290 talloc_free(*child);
291 *child = NULL;
292}
293
294/** Allocate a subrequest to run through a virtual server at some point in the future
295 *
296 * @param[in] parent to hang sub request off of.
297 * @param[in] namespace the child will operate in.
298 * @return
299 * - A new child request.
300 * - NULL on failure.
301 */
306
307
308/** Function to run in the context of the parent on resumption
309 *
310 * @note Only executes if unlang_subrequest_child_push was called, not with the normal subrequest keyword.
311 */
314{
315 unlang_child_request_t *cr = talloc_get_type_abort(frame->state, unlang_child_request_t);
316
317 /*
318 * Default to NOOP
319 */
320 if (cr->result.rcode == RLM_MODULE_NOT_SET) {
322 if (cr->p_result) {
323 *cr->p_result = cr->result;
324 } else {
325 *p_result = cr->result;
326 }
327 }
328
329 /*
330 * We can free the child here as we're its parent
331 */
332 if (cr->config.free_child) {
335 } else {
336 TALLOC_FREE(cr->request);
337 }
338 }
339
341}
342
343/** Function called by the unlang interpreter, or manually to start the child running
344 *
345 * The reason why we do this on the unlang stack is so that _this_ frame
346 * is marked as resumable in the parent, not whatever frame was previously
347 * being processed by the interpreter when the parent was called.
348 *
349 * i.e. after calling unlang_subrequest_child_push, the code in the parent
350 * can call UNLANG_ACTION_PUSHED_CHILD, which will result in _this_ frame
351 * being executed, and _this_ frame can yield.
352 *
353 * @note Called from the parent to start a child running.
354 */
357{
358 unlang_child_request_t *cr = talloc_get_type_abort(frame->state, unlang_child_request_t);
359 request_t *child = cr->request;
360
361 /*
362 * No parent means this is a pre-detached child
363 * so the parent should continue executing.
364 */
365 if (!child || !child->parent) return UNLANG_ACTION_CALCULATE_RESULT;
366
367
368 /*
369 * Ensure we restore the session state information
370 * into the child.
371 */
372 if (cr->config.session_unique_ptr) fr_state_restore_from_parent(child,
373 cr->config.session_unique_ptr,
374 cr->num);
375 /*
376 * Ensures the child is setup correctly and adds
377 * it into the runnable queue of whatever owns
378 * the interpreter.
379 */
381
382 /*
383 * This function is being called by something
384 * other than the subrequest keyword.
385 *
386 * Set a different resumption function that
387 * just writes the final rcode out.
388 */
389 if (frame->process == unlang_subrequest_child_run) {
391 }
392
393 cr->state = CHILD_RUNNABLE;
394
395 return UNLANG_ACTION_YIELD;
396}
397
398/** Push a pre-existing child back onto the stack as a subrequest
399 *
400 * The child *MUST* have been allocated with unlang_io_subrequest_alloc, or something
401 * that calls it.
402 *
403 * After the child is no longer required it *MUST* be freed with #unlang_subrequest_detach_and_free.
404 * It's not enough to free it with talloc_free.
405 *
406 * This function should be called _before_ pushing any additional frames onto the child's
407 * stack for it to execute.
408 *
409 * The parent should return UNLANG_ACTION_PUSHED_CHILD, when it's done setting up the
410 * child request. It should NOT return UNLANG_ACTION_YIELD.
411 *
412 * @param[in] p_result Where to write the result of the subrequest.
413 * @param[in] child to push.
414 * @param[in] unique_session_ptr Unique identifier for child's session data.
415 * @param[in] free_child automatically free the child when it's finished executing.
416 * This is useful if extracting the result from the child is
417 * done using the child's stack, and so the parent never needs
418 * to access it.
419 * @param[in] top_frame Set to UNLANG_TOP_FRAME if the interpreter should return.
420 * Set to UNLANG_SUB_FRAME if the interprer should continue.
421 * @return
422 * - 0 on success.
423 * - -1 on failure.
424 */
425
426int unlang_subrequest_child_push(unlang_result_t *p_result, request_t *child, void const *unique_session_ptr, bool free_child, bool top_frame)
427{
430
431 static unlang_t subrequest_instruction = {
433 .name = "subrequest",
434 .debug_name = "subrequest",
435 .actions = DEFAULT_MOD_ACTIONS,
436 };
437
438 fr_assert_msg(free_child || child->parent, "Child's request pointer must not be NULL when calling subrequest_child_push");
439
441 "Child stack depth must be 0 (not %d), when calling subrequest_child_push",
442 stack_depth_current(child))) return -1;
443
444 /*
445 * Push a new subrequest frame onto the stack
446 * of the parent.
447 *
448 * This allocates memory for the frame state
449 * which we fill in below.
450 *
451 * This frame executes once the subrequest has
452 * completed.
453 */
454 if (unlang_interpret_push(NULL, child->parent, &subrequest_instruction,
456 return -1;
457 }
458
459 frame = frame_current(child->parent);
461
462 /*
463 * Setup the state for the subrequest
464 */
465 cr = talloc_get_type_abort(frame_current(child->parent)->state, unlang_child_request_t);
466
467 /*
468 * Initialise our frame state, and push the first
469 * instruction onto the child's stack.
470 *
471 * This instruction will mark the parent as runnable
472 * when it executed.
473 */
474 if (unlang_child_request_init(cr, cr, child, p_result, NULL, unique_session_ptr, free_child) < 0) {
475 unwind_set(frame);
476 return -1;
477 }
478
479 return 0;
480}
481
482/** Add a child request to the runnable queue
483 *
484 * @param[in] request to add to the runnable queue.
485 * @return
486 * - 0 on success.
487 * - -1 on failure.
488 */
490{
491 /*
492 * Ensures the child is setup correctly and adds
493 * it into the runnable queue of whatever owns
494 * the interpreter.
495 */
496 interpret_child_init(request);
497
498 if (request_detach(request) < 0) {
499 RPEDEBUG("Failed detaching request");
500 return -1;
501 }
502
503 return 0;
504}
505
507{
509 char const *name2;
510
511 unlang_t *c;
512
515
516 unlang_compile_ctx_t unlang_ctx2;
517
518 tmpl_rules_t t_rules;
519 fr_dict_autoload_talloc_t *dict_ref = NULL;
520
521 fr_dict_t const *dict;
522 fr_dict_attr_t const *attr_packet_type = NULL;
523 fr_dict_enum_value_t const *type_enum = NULL;
524
525 ssize_t slen;
526 char *namespace = NULL;
527 char const *packet_name = NULL;
528
529 tmpl_t *vpt = NULL, *src_vpt = NULL, *dst_vpt = NULL;
530
531 if (!cf_item_next(cs, NULL)) return UNLANG_IGNORE;
532
533 /*
534 * subrequest { ... }
535 *
536 * Create a subrequest which is of the same dictionary
537 * and packet type as the current request.
538 *
539 * We assume that the Packet-Type attribute exists.
540 */
541 name2 = cf_section_name2(cs);
542 if (!name2) {
543 dict = unlang_ctx->rules->attr.dict_def;
544 packet_name = name2 = unlang_ctx->section_name2;
546 goto get_packet_type;
547 }
548
550 cf_log_err(cs, "The arguments to 'subrequest' must be a name or an attribute reference");
551 print_url:
552 cf_log_err(ci, DOC_KEYWORD_REF(subrequest));
553 return NULL;
554 }
555
556 dict = unlang_ctx->rules->attr.dict_def;
557
558 /*
559 * @foo is "dictionary foo", as with references in the dictionaries.
560 *
561 * @foo::bar is "dictionary foo, Packet-Type = ::bar"
562 *
563 * foo::bar is "dictionary foo, Packet-Type = ::bar"
564 *
565 * ::bar is "this dictionary, Packet-Type = ::bar", BUT
566 * we don't try to parse the new dictionary name, as it
567 * doesn't exist.
568 */
569 if ((name2[0] == '@') ||
570 ((name2[0] != ':') && (name2[0] != '&') && (strchr(name2 + 1, ':') != NULL))) {
571 char *q;
572
573 /*
574 * This is a different protocol dictionary. We reset the packet type.
575 *
576 * @todo - the packet type should really be stored in #fr_dict_protocol_t.
577 */
578 if (name2[0] == '@') {
579 attr_packet_type = NULL;
580 name2++;
581 }
582
583 MEM(namespace = talloc_strdup(parent, name2));
584 q = namespace;
585
586 while (fr_dict_attr_allowed_chars[(unsigned int) *q]) {
587 q++;
588 }
589 *q = '\0';
590
591 dict = fr_dict_by_protocol_name(namespace);
592 if (!dict) {
593 dict_ref = fr_dict_autoload_talloc(NULL, &dict, namespace);
594 if (!dict_ref) {
595 cf_log_err(cs, "Unknown namespace in '%s'", name2);
596 talloc_free(namespace);
597 return NULL;
598 }
599 }
600
601 /*
602 * Skip the dictionary name, and go to the thing
603 * right after it.
604 */
605 name2 += (q - namespace);
606 TALLOC_FREE(namespace);
607 }
608
609 /*
610 * @dict::enum is "other dictionary, Packet-Type = ::enum"
611 * ::enum is this dictionary, "Packet-Type = ::enum"
612 */
613 if ((name2[0] == ':') && (name2[1] == ':')) {
614 packet_name = name2;
615 goto get_packet_type;
616 }
617
618 /*
619 * Can't do foo.bar.baz::foo, the enums are only used for Packet-Type.
620 */
621 if (strchr(name2, ':') != NULL) {
622 cf_log_err(cs, "Reference cannot contain enum value in '%s'", name2);
623 return NULL;
624 }
625
626 /*
627 * Bare words are attribute references.
628 */
629 slen = tmpl_afrom_attr_substr(parent, NULL, &vpt,
630 &FR_SBUFF_IN(name2, talloc_strlen(name2)),
631 NULL, unlang_ctx->rules);
632 if (slen <= 0) {
633 cf_log_perr(cs, "Invalid argument to 'subrequest', failed parsing packet-type");
634 goto print_url;
635 }
636
638
639 /*
640 * Anything resembling an integer or string is
641 * OK. Nothing else makes sense.
642 */
643 switch (tmpl_attr_tail_da(vpt)->type) {
645 case FR_TYPE_STRING:
646 break;
647
648 default:
650 cf_log_err(cs, "Invalid data type for attribute %s. "
651 "Must be an integer type or string", name2 + 1);
652 goto print_url;
653 }
654
655 dict = unlang_ctx->rules->attr.dict_def;
656 packet_name = NULL;
657
658get_packet_type:
659 /*
660 * Local attributes cannot be used in a subrequest. They belong to the parent. Local attributes
661 * are NOT copied to the subrequest.
662 *
663 * @todo - maybe we want to copy local variables, too? But there may be multiple nested local
664 * variables, each with their own dictionary.
665 */
666 dict = fr_dict_proto_dict(dict);
667
668 /*
669 * We're switching virtual servers, find the packet type by name.
670 */
671 if (!attr_packet_type) {
672 attr_packet_type = fr_dict_attr_by_name(NULL, fr_dict_root(dict), "Packet-Type");
673 if (!attr_packet_type) {
674 cf_log_err(cs, "No such attribute 'Packet-Type' in namespace '%s'", fr_dict_root(dict)->name);
675 error:
676 talloc_free(namespace);
678 talloc_free(dict_ref);
679 goto print_url;
680 }
681 }
682
683 if (packet_name) {
684 /*
685 * Allow ::enum-name for packet types
686 */
687 if ((packet_name[0] == ':') && (packet_name[1] == ':')) packet_name += 2;
688
690 if (!type_enum) {
691 cf_log_err(cs, "No such value '%s' for attribute '%s' in namespace '%s'",
693 goto error;
694 }
695 }
696
697 /*
698 * No longer needed
699 */
700 talloc_free(namespace);
701
702 /*
703 * Source and destination arguments
704 */
705 {
706 char const *dst, *src;
707
708 src = cf_section_argv(cs, 0);
709 if (src) {
710 RULES_VERIFY(unlang_ctx->rules);
711
712 (void) tmpl_afrom_substr(parent, &src_vpt,
713 &FR_SBUFF_IN(src, talloc_strlen(src)),
714 cf_section_argv_quote(cs, 0), NULL, unlang_ctx->rules);
715 if (!src_vpt) {
716 cf_log_perr(cs, "Invalid argument to 'subrequest', failed parsing src");
717 goto error;
718 }
719
720 if (!tmpl_contains_attr(src_vpt)) {
721 cf_log_err(cs, "Invalid argument to 'subrequest' src must be an attr or list, got %s",
722 tmpl_type_to_str(src_vpt->type));
723 talloc_free(src_vpt);
724 goto error;
725 }
726
727 dst = cf_section_argv(cs, 1);
728 if (dst) {
729 RULES_VERIFY(unlang_ctx->rules);
730
731 (void) tmpl_afrom_substr(parent, &dst_vpt,
732 &FR_SBUFF_IN(dst, talloc_strlen(dst)),
733 cf_section_argv_quote(cs, 1), NULL, unlang_ctx->rules);
734 if (!dst_vpt) {
735 cf_log_perr(cs, "Invalid argument to 'subrequest', failed parsing dst");
736 goto error;
737 }
738
739 if (!tmpl_contains_attr(dst_vpt)) {
740 cf_log_err(cs, "Invalid argument to 'subrequest' dst must be an "
741 "attr or list, got %s",
742 tmpl_type_to_str(dst_vpt->type));
743 talloc_free(src_vpt);
744 talloc_free(dst_vpt);
745 goto error;
746 }
747 }
748 }
749 }
750
751 if (!cf_item_next(cs, NULL)) {
753 talloc_free(src_vpt);
754 talloc_free(dst_vpt);
755 return UNLANG_IGNORE;
756 }
757
758 t_rules = *unlang_ctx->rules;
759 t_rules.parent = unlang_ctx->rules;
760 t_rules.attr.dict_def = dict;
761 t_rules.attr.allow_foreign = false;
762
763 /*
764 * Copy over the compilation context. This is mostly
765 * just to ensure that retry is handled correctly.
766 * i.e. reset.
767 */
768 unlang_compile_ctx_copy(&unlang_ctx2, unlang_ctx);
769
770 /*
771 * Then over-write the new compilation context.
772 */
773 unlang_ctx2.section_name1 = "subrequest";
774 unlang_ctx2.section_name2 = name2;
775 unlang_ctx2.rules = &t_rules;
776
777 /*
778 * Compile the subsection with a *different* default dictionary.
779 */
781 if (!c) return NULL;
782
783 /*
784 * Set the dictionary and packet information, which tells
785 * unlang_subrequest() how to process the request.
786 */
789
790 if (dict_ref) {
791 /*
792 * Parent the dictionary reference correctly now that we
793 * have the section with the dependency. This should
794 * be fast as dict_ref has no siblings.
795 */
796 talloc_steal(gext, dict_ref);
797 }
798 if (vpt) gext->vpt = talloc_steal(gext, vpt);
799
800 gext->dict = dict;
802 gext->type_enum = type_enum;
803 gext->src = src_vpt;
804 gext->dst = dst_vpt;
805
806 return c;
807}
808
809
810/** Initialise subrequest ops
811 *
812 */
814{
816 .name = "subrequest",
818
819 /*
820 * Frame can't be cancelled, because children need to
821 * write out status to the parent. If we don't do this,
822 * then all children must be detachable and must detach
823 * so they don't try and write out status to a "done"
824 * parent.
825 *
826 * It's easier to allow the child/parent relationship
827 * to end normally so that non-detachable requests are
828 * guaranteed the parent still exists.
829 */
831
832 .compile = unlang_compile_subrequest,
833 .interpret = unlang_subrequest_init,
834 .signal = unlang_subrequest_signal,
835
836 .unlang_size = sizeof(unlang_subrequest_t),
837 .unlang_name = "unlang_subrequest_t",
838 .pool_headers = (TMPL_POOL_DEF_HEADERS * 3),
839 .pool_len = (TMPL_POOL_DEF_LEN * 3),
840
841 .frame_state_size = sizeof(unlang_child_request_t),
842 .frame_state_type = "unlang_child_request_t",
843 });
844
845 if (unlang_child_request_op_init() < 0) return -1;
846
847 return 0;
848}
unlang_action_t
Returned by unlang_op_t calls, determine the next action of the interpreter.
Definition action.h:35
@ UNLANG_ACTION_EXECUTE_NEXT
Execute the next unlang_t.
Definition action.h:38
@ UNLANG_ACTION_FAIL
Encountered an unexpected error.
Definition action.h:36
@ UNLANG_ACTION_CALCULATE_RESULT
Calculate a new section rlm_rcode_t value.
Definition action.h:37
@ UNLANG_ACTION_YIELD
Temporarily pause execution until an event occurs.
Definition action.h:41
#define RCSID(id)
Definition build.h:488
#define UNUSED
Definition build.h:318
#define RULES_VERIFY(_cs, _rules)
Definition cf_file.c:175
Common header for all CONF_* types.
Definition cf_priv.h:49
A section grouping multiple CONF_PAIR.
Definition cf_priv.h:101
fr_token_t cf_section_argv_quote(CONF_SECTION const *cs, int argc)
Return the quoting for one of the variadic arguments.
Definition cf_util.c:1247
char const * cf_section_name2(CONF_SECTION const *cs)
Return the second identifier of a CONF_SECTION.
Definition cf_util.c:1184
CONF_SECTION * cf_item_to_section(CONF_ITEM const *ci)
Cast a CONF_ITEM to a CONF_SECTION.
Definition cf_util.c:683
char const * cf_section_argv(CONF_SECTION const *cs, int argc)
Return variadic argument at the specified index.
Definition cf_util.c:1212
fr_token_t cf_section_name2_quote(CONF_SECTION const *cs)
Return the quoting of the name2 identifier.
Definition cf_util.c:1229
#define cf_log_err(_cf, _fmt,...)
Definition cf_util.h:285
#define cf_item_next(_parent, _curr)
Definition cf_util.h:89
#define cf_log_perr(_cf, _fmt,...)
Definition cf_util.h:292
int unlang_child_request_op_init(void)
int unlang_child_request_init(TALLOC_CTX *ctx, unlang_child_request_t *out, request_t *child, unlang_result_t *p_result, unsigned int *sibling_count, void const *unique_session_ptr, bool free_child)
Initialize a child request.
struct unlang_child_request_t::@100 config
request_t * request
Child request. The actual request the child will run.
unlang_result_t result
The result of the child request.
unlang_child_request_state_t state
State of the child.
unlang_result_t * p_result
Pointer to the result of the child request.
@ CHILD_RUNNABLE
Running/runnable.
@ CHILD_DETACHED
Child has detached, we can't signal it or communicate with it anymore.
@ CHILD_CANCELLED
Child was cancelled.
int num
The child number.
Each child has a state, a number, a request, and a count of their siblings.
unlang_t * unlang_compile_section(unlang_t *parent, unlang_compile_ctx_t *unlang_ctx, CONF_SECTION *cs, unlang_type_t type)
Definition compile.c:1523
fr_table_num_sorted_t const mod_rcode_table[]
Definition compile.c:74
#define fr_assert_msg(_x, _msg,...)
Calls panic_action ifndef NDEBUG, else logs error and causes the server to exit immediately with code...
Definition debug.h:212
#define fr_cond_assert_msg(_x, _fmt,...)
Calls panic_action ifndef NDEBUG, else logs error and evaluates to value of _x.
Definition debug.h:158
#define MEM(x)
Definition debug.h:46
static fr_dict_attr_t const * attr_packet_type
Definition dhcpclient.c:88
#define fr_dict_autoload_talloc(_ctx, _dict_out, _proto)
Definition dict.h:918
bool const fr_dict_attr_allowed_chars[SBUFF_CHAR_CLASS]
Characters allowed in a single dictionary attribute name.
Definition dict_util.c:63
fr_dict_t const * fr_dict_proto_dict(fr_dict_t const *dict)
Definition dict_util.c:5276
fr_dict_attr_t const * fr_dict_attr_by_name(fr_dict_attr_err_t *err, fr_dict_attr_t const *parent, char const *attr))
Locate a fr_dict_attr_t by its name.
Definition dict_util.c:3528
fr_dict_attr_t const * fr_dict_root(fr_dict_t const *dict)
Return the root attribute of a dictionary.
Definition dict_util.c:2665
fr_value_box_t const * value
Enum value (what name maps to).
Definition dict.h:257
fr_dict_enum_value_t const * fr_dict_enum_by_value(fr_dict_attr_t const *da, fr_value_box_t const *value)
Lookup the structure representing an enum value in a fr_dict_attr_t.
Definition dict_util.c:3655
fr_dict_t const * fr_dict_by_protocol_name(char const *name)
Lookup a protocol by its name.
Definition dict_util.c:2842
fr_dict_enum_value_t const * fr_dict_enum_by_name(fr_dict_attr_t const *da, char const *name, ssize_t len)
Definition dict_util.c:3701
Value of an enumerated attribute.
Definition dict.h:253
Structure used to managed the lifetime of a dictionary.
Definition dict_util.c:4517
talloc_free(hp)
bool unlang_request_is_done(request_t const *request)
Return whether a request has been marked done.
Definition interpret.c:1606
bool unlang_request_is_scheduled(request_t const *request)
Return whether a request is currently scheduled.
Definition interpret.c:1589
void unlang_interpret_signal(request_t *request, fr_signal_t action)
Send a signal (usually stop) to a request.
Definition interpret.c:1417
int unlang_interpret_push(unlang_result_t *p_result, request_t *request, unlang_t const *instruction, unlang_frame_conf_t const *conf, bool do_next_sibling)
Push a new frame onto the stack.
Definition interpret.c:278
#define FRAME_CONF(_default_rcode, _top_frame)
Definition interpret.h:152
#define UNLANG_SUB_FRAME
Definition interpret.h:37
rlm_rcode_t rcode
The current rcode, from executing the instruction or merging the result from a frame.
Definition interpret.h:134
Private declarations for the unlang interpreter.
static void interpret_child_init(request_t *request)
#define RDEBUG3(fmt,...)
Definition log.h:355
#define RPDEBUG(fmt,...)
Definition log.h:358
#define RPEDEBUG(fmt,...)
Definition log.h:388
static TALLOC_CTX * unlang_ctx
Definition base.c:71
void unlang_register(unlang_op_t *op)
Register an operation with the interpreter.
Definition base.c:56
request_t * unlang_io_subrequest_alloc(request_t *parent, fr_dict_t const *namespace, bool detachable)
Allocate a child request based on the parent.
Definition io.c:39
@ FR_TYPE_STRING
String of printable characters.
@ FR_TYPE_UINT32
32 Bit unsigned integer.
long int ssize_t
#define DEFAULT_MOD_ACTIONS
Definition mod_action.h:73
int fr_pair_list_copy(TALLOC_CTX *ctx, fr_pair_list_t *to, fr_pair_list_t const *from)
Duplicate a list of pairs.
Definition pair.c:2330
int fr_pair_append(fr_pair_list_t *list, fr_pair_t *to_add)
Add a VP to the end of the list.
Definition pair.c:1352
fr_pair_t * fr_pair_afrom_da(TALLOC_CTX *ctx, fr_dict_attr_t const *da)
Dynamically allocate a new attribute and assign a fr_dict_attr_t.
Definition pair.c:290
static const char * packet_name[]
#define fr_assert(_expr)
Definition rad_assert.h:37
#define RDEBUG(fmt,...)
@ RLM_MODULE_NOT_SET
Error resolving rcode (should not be returned by modules).
Definition rcode.h:45
@ RLM_MODULE_NOOP
Module succeeded without doing anything.
Definition rcode.h:54
#define RETURN_UNLANG_NOOP
Definition rcode.h:69
int request_detach(request_t *child)
Unlink a subrequest from its parent.
Definition request.c:542
#define request_is_detachable(_x)
Definition request.h:187
static char const * name
#define FR_SBUFF_IN(_start, _len_or_end)
void fr_state_restore_from_parent(request_t *child, void const *unique_ptr, int unique_int)
Restore subrequest data from a parent request.
Definition state.c:958
int tmpl_find_vp(fr_pair_t **out, request_t *request, tmpl_t const *vpt))
Returns the first VP matching a tmpl_t.
Definition tmpl_eval.c:776
static char const * tmpl_type_to_str(tmpl_type_t type)
Return a static string containing the type name.
Definition tmpl.h:638
#define tmpl_is_attr(vpt)
Definition tmpl.h:208
tmpl_rules_t const * parent
for parent / child relationships
Definition tmpl.h:337
#define tmpl_contains_attr(vpt)
Definition tmpl.h:225
ssize_t tmpl_afrom_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_token_t quote, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules))
Convert an arbitrary string into a tmpl_t.
ssize_t tmpl_afrom_attr_substr(TALLOC_CTX *ctx, tmpl_attr_error_t *err, tmpl_t **out, fr_sbuff_t *name, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules))
Parse a string into a TMPL_TYPE_ATTR_* type tmpl_t.
static fr_slen_t vpt
Definition tmpl.h:1269
#define TMPL_POOL_DEF_HEADERS
Define manipulation functions for the attribute reference list.
Definition tmpl.h:490
#define TMPL_POOL_DEF_LEN
How many additional bytes to allocate in a pool for a tmpl_t.
Definition tmpl.h:495
tmpl_attr_rules_t attr
Rules/data for parsing attribute references.
Definition tmpl.h:339
static fr_dict_attr_t const * tmpl_attr_tail_da(tmpl_t const *vpt)
Return the last attribute reference da.
Definition tmpl.h:801
int tmpl_copy_pair_children(TALLOC_CTX *ctx, fr_pair_list_t *out, request_t *request, tmpl_t const *vpt))
Copy children of pairs matching a tmpl_t in the current request_t.
Definition tmpl_eval.c:728
Optional arguments passed to vp_tmpl functions.
Definition tmpl.h:336
fr_signal_t
Signals that can be generated/processed by request signal handlers.
Definition signal.h:38
@ FR_SIGNAL_DETACH
Request is being detached from its parent.
Definition signal.h:45
fr_aka_sim_id_type_t type
fr_pair_t * vp
fr_dict_t const * dict_def
Default dictionary to use with unqualified attribute references.
Definition tmpl.h:273
unsigned int allow_foreign
Allow arguments not found in dict_def.
Definition tmpl.h:314
Stores an attribute, a value and various bits of other data.
Definition pair.h:68
static unlang_action_t unlang_subrequest_parent_resume(UNUSED unlang_result_t *p_result, request_t *request, unlang_stack_frame_t *frame)
Parent being resumed after a child completes.
Definition subrequest.c:103
static unlang_action_t unlang_subrequest_init(unlang_result_t *p_result, request_t *request, unlang_stack_frame_t *frame)
Allocates a new subrequest and initialises it.
Definition subrequest.c:168
int unlang_subrequest_op_init(void)
Initialise subrequest ops.
Definition subrequest.c:813
static void unlang_subrequest_signal(UNUSED request_t *request, unlang_stack_frame_t *frame, fr_signal_t action)
Send a signal from parent request to subrequest.
Definition subrequest.c:38
int unlang_subrequest_child_push_and_detach(request_t *request)
Add a child request to the runnable queue.
Definition subrequest.c:489
request_t * unlang_subrequest_alloc(request_t *parent, fr_dict_t const *namespace)
Allocate a subrequest to run through a virtual server at some point in the future.
Definition subrequest.c:302
void unlang_subrequest_detach_and_free(request_t **child)
Free a child request, detaching it from its parent and freeing allocated memory.
Definition subrequest.c:287
static unlang_action_t unlang_subrequest_child_done(unlang_result_t *p_result, UNUSED request_t *request, unlang_stack_frame_t *frame)
Function to run in the context of the parent on resumption.
Definition subrequest.c:312
static unlang_t * unlang_compile_subrequest(unlang_t *parent, unlang_compile_ctx_t *unlang_ctx, CONF_ITEM const *ci)
Definition subrequest.c:506
int unlang_subrequest_child_push(unlang_result_t *p_result, request_t *child, void const *unique_session_ptr, bool free_child, bool top_frame)
Push a pre-existing child back onto the stack as a subrequest.
Definition subrequest.c:426
unlang_action_t unlang_subrequest_child_run(UNUSED unlang_result_t *p_result, UNUSED request_t *request, unlang_stack_frame_t *frame)
Function called by the unlang interpreter, or manually to start the child running.
Definition subrequest.c:355
static unlang_subrequest_t * unlang_group_to_subrequest(unlang_group_t *g)
Cast a group structure to the subrequest keyword extension.
tmpl_t * vpt
Value to expand to find the value to place into the packet-type attribute.
fr_dict_attr_t const * attr_packet_type
Packet-type attribute in the subrequest protocol.
tmpl_t * src
Pairs to copy into the subrequest request list.
fr_dict_t const * dict
Dictionary of the subrequest protocol.
tmpl_t * dst
Where to copy pairs from the reply list in the subrequest to.
fr_dict_enum_value_t const * type_enum
Static enumeration value for attr_packet_type.
#define fr_table_str_by_value(_table, _number, _def)
Convert an integer to a string.
Definition table.h:772
#define talloc_strdup(_ctx, _str)
Definition talloc.h:142
static size_t talloc_strlen(char const *s)
Returns the length of a talloc array containing a string.
Definition talloc.h:136
fr_pair_t * tmpl_dcursor_pair_build(fr_pair_t *parent, fr_dcursor_t *cursor, fr_dict_attr_t const *da, UNUSED void *uctx)
Simple pair building callback for use with tmpl_dcursors.
void tmpl_dcursor_clear(tmpl_dcursor_ctx_t *cc)
Clear any temporary state allocations.
#define tmpl_dcursor_build_init(_err, _ctx, _cc, _cursor, _request, _vpt, _build, _uctx)
Maintains state between cursor calls.
@ T_BARE_WORD
Definition token.h:118
Private interpreter structures and functions.
#define UNLANG_NORMAL_CHILD
#define UNLANG_DETACHABLE
#define UNLANG_NEXT_SIBLING
Definition unlang_priv.h:99
void * state
Stack frame specialisations.
tmpl_rules_t const * rules
#define UNLANG_NEXT_STOP
Definition unlang_priv.h:98
static void unwind_set(unlang_stack_frame_t *frame)
static void unlang_compile_ctx_copy(unlang_compile_ctx_t *dst, unlang_compile_ctx_t const *src)
#define UNLANG_IGNORE
static unlang_group_t * unlang_generic_to_group(unlang_t const *p)
char const * section_name1
static unlang_stack_frame_t * frame_current(request_t *request)
unlang_list_t children
static int stack_depth_current(request_t *request)
@ UNLANG_TYPE_SUBREQUEST
create a child subrequest
Definition unlang_priv.h:67
static void frame_repeat(unlang_stack_frame_t *frame, unlang_process_t process)
Mark the current stack frame up for repeat, and set a new process function.
unlang_t const * instruction
The unlang node we're evaluating.
@ UNLANG_OP_FLAG_NO_FORCE_UNWIND
Must not be cancelled.
@ UNLANG_OP_FLAG_DEBUG_BRACES
Print debug braces.
@ UNLANG_OP_FLAG_RCODE_SET
Set request->rcode to the result of this operation.
unlang_process_t process
function to call for interpreting this stack frame
unlang_type_t type
The specialisation of this node.
char const * section_name2
Generic representation of a grouping.
An unlang operation.
A node in a graph of unlang_op_t (s) that we execute.
Our interpreter stack, as distinct from the C stack.
static fr_slen_t parent
Definition pair.h:858
#define FR_TYPE_INTEGER_EXCEPT_BOOL
Definition types.h:303
#define DOC_KEYWORD_REF(_x)
Definition version.h:89
int fr_value_box_cast(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_type_t dst_type, fr_dict_attr_t const *dst_enumv, fr_value_box_t const *src)
Convert one type of fr_value_box_t to another.
Definition value.c:3960
#define fr_value_box_init(_vb, _type, _enumv, _tainted)
Initialise a fr_value_box_t.
Definition value.h:610
CONF_SECTION * virtual_server_cs(virtual_server_t const *vs)
Return the configuration section for a virtual server.
fr_dict_attr_t const * virtual_server_packet_type_by_cs(CONF_SECTION const *server_cs)
Return the packet type attribute for a virtual server specified by a config section.