forked from kamailio/kamailio
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcfg_ctx.c
1968 lines (1716 loc) · 53 KB
/
cfg_ctx.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (C) 2007 iptelorg GmbH
*
* This file is part of Kamailio, a free SIP server.
*
* Kamailio 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
*
* Kamailio 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
*
*/
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include "../ut.h"
#include "cfg_struct.h"
#include "cfg_script.h"
#include "cfg_ctx.h"
/* linked list of all the registered cfg contexts */
static cfg_ctx_t *cfg_ctx_list = NULL;
/* creates a new config context that is an interface to the
* cfg variables with write permission
*/
int cfg_register_ctx(cfg_ctx_t **handle, cfg_on_declare on_declare_cb)
{
cfg_ctx_t *ctx;
cfg_group_t *group;
str gname;
/* allocate memory for the new context
Better to use shm mem, because 'changed' and 'lock'
must be in shm mem anyway */
ctx = (cfg_ctx_t *)shm_malloc(sizeof(cfg_ctx_t));
if (!ctx) {
LOG(L_ERR, "ERROR: cfg_register_ctx(): not enough shm memory\n");
return -1;
}
memset(ctx, 0, sizeof(cfg_ctx_t));
if (lock_init(&ctx->lock) == 0) {
LOG(L_ERR, "ERROR: cfg_register_ctx(): failed to init lock\n");
shm_free(ctx);
return -1;
}
/* add the new ctx to the beginning of the list */
ctx->next = cfg_ctx_list;
cfg_ctx_list = ctx;
/* let the driver know about the already registered groups
* The handle of the context must be set before calling the
* on_declare callbacks. */
*handle = ctx;
if (on_declare_cb) {
ctx->on_declare_cb = on_declare_cb;
for ( group = cfg_group;
group;
group = group->next
) {
/* dynamic groups are not ready, the callback
will be called later when the group is fixed-up */
if (group->dynamic != CFG_GROUP_STATIC) continue;
gname.s = group->name;
gname.len = group->name_len;
on_declare_cb(&gname, group->mapping->def);
}
}
return 0;
}
/* free the memory allocated for the contexts */
void cfg_ctx_destroy(void)
{
cfg_ctx_t *ctx, *ctx2;
for ( ctx = cfg_ctx_list;
ctx;
ctx = ctx2
) {
ctx2 = ctx->next;
shm_free(ctx);
}
cfg_ctx_list = NULL;
}
/* notify the drivers about the new config definition */
void cfg_notify_drivers(char *group_name, int group_name_len, cfg_def_t *def)
{
cfg_ctx_t *ctx;
str gname;
gname.s = group_name;
gname.len = group_name_len;
for ( ctx = cfg_ctx_list;
ctx;
ctx = ctx->next
)
if (ctx->on_declare_cb)
ctx->on_declare_cb(&gname, def);
}
/* placeholder for a temporary string */
static char *temp_string = NULL;
/* convert the value to the requested type */
int convert_val(unsigned int val_type, void *val,
unsigned int var_type, void **new_val)
{
static str s;
char *end;
int i;
static char buf[INT2STR_MAX_LEN];
/* we have to convert from val_type to var_type */
switch (CFG_INPUT_MASK(var_type)) {
case CFG_INPUT_INT:
if (val_type == CFG_VAR_INT) {
*new_val = val;
break;
} else if (val_type == CFG_VAR_STRING) {
if (!val || (((char *)val)[0] == '\0')) {
LOG(L_ERR, "ERROR: convert_val(): "
"cannot convert NULL string value to integer\n");
return -1;
}
*new_val = (void *)(long)strtol((char *)val, &end, 10);
if (*end != '\0') {
LOG(L_ERR, "ERROR: convert_val(): "
"cannot convert string to integer '%s'\n",
(char *)val);
return -1;
}
break;
} else if (val_type == CFG_VAR_STR) {
if (!((str *)val)->len || !((str *)val)->s) {
LOG(L_ERR, "ERROR: convert_val(): "
"cannot convert NULL str value to integer\n");
return -1;
}
if (str2sint((str *)val, &i)) {
LOG(L_ERR, "ERROR: convert_val(): "
"cannot convert string to integer '%.*s'\n",
((str *)val)->len, ((str *)val)->s);
return -1;
}
*new_val = (void *)(long)i;
break;
}
goto error;
case CFG_INPUT_STRING:
if (val_type == CFG_VAR_INT) {
buf[snprintf(buf, sizeof(buf)-1, "%ld", (long)val)] = '\0';
*new_val = buf;
break;
} else if (val_type == CFG_VAR_STRING) {
*new_val = val;
break;
} else if (val_type == CFG_VAR_STR) {
if (!((str *)val)->s) {
*new_val = NULL;
break;
}
/* the value may not be zero-terminated, thus,
a new variable has to be allocated with larger memory space */
if (temp_string) pkg_free(temp_string);
temp_string = (char *)pkg_malloc(sizeof(char) * (((str *)val)->len + 1));
if (!temp_string) {
LOG(L_ERR, "ERROR: convert_val(): not enough memory\n");
return -1;
}
memcpy(temp_string, ((str *)val)->s, ((str *)val)->len);
temp_string[((str *)val)->len] = '\0';
*new_val = (void *)temp_string;
break;
}
goto error;
case CFG_INPUT_STR:
if (val_type == CFG_VAR_INT) {
s.len = snprintf(buf, sizeof(buf)-1, "%ld", (long)val);
buf[s.len] = '\0';
s.s = buf;
*new_val = (void *)&s;
break;
} else if (val_type == CFG_VAR_STRING) {
s.s = (char *)val;
s.len = (s.s) ? strlen(s.s) : 0;
*new_val = (void *)&s;
break;
} else if (val_type == CFG_VAR_STR) {
*new_val = val;
break;
}
goto error;
}
return 0;
error:
LOG(L_ERR, "ERROR: convert_val(): got a value with type %u, but expected %u\n",
val_type, CFG_INPUT_MASK(var_type));
return -1;
}
void convert_val_cleanup(void)
{
if (temp_string) {
pkg_free(temp_string);
temp_string = NULL;
}
}
/* returns the size of the variable */
static int cfg_var_size(cfg_mapping_t *var)
{
switch (CFG_VAR_TYPE(var)) {
case CFG_VAR_INT:
return sizeof(int);
case CFG_VAR_STRING:
return sizeof(char *);
case CFG_VAR_STR:
return sizeof(str);
case CFG_VAR_POINTER:
return sizeof(void *);
default:
LOG(L_CRIT, "BUG: cfg_var_size(): unknown type: %u\n",
CFG_VAR_TYPE(var));
return 0;
}
}
/* Update the varibales of the array within the meta structure
* with the new default value.
* The array is cloned before a change if clone is set to 1.
*/
static int cfg_update_defaults(cfg_group_meta_t *meta,
cfg_group_t *group, cfg_mapping_t *var, char *new_val,
int clone)
{
int i, clone_done=0;
cfg_group_inst_t *array, *ginst;
if (!(array = meta->array))
return 0;
for (i = 0; i < meta->num; i++) {
ginst = (cfg_group_inst_t *)((char *)array
+ (sizeof(cfg_group_inst_t) + group->size - 1) * i);
if (!CFG_VAR_TEST(ginst, var)) {
/* The variable uses the default value, it needs to be rewritten. */
if (clone && !clone_done) {
/* The array needs to be cloned before the modification */
if (!(array = cfg_clone_array(meta, group)))
return -1;
ginst = (cfg_group_inst_t *)translate_pointer((char *)array,
(char *)meta->array,
(char *)ginst);
/* re-link the array to the meta-data */
meta->array = array;
clone_done = 1;
}
memcpy(ginst->vars + var->offset, new_val, cfg_var_size(var));
}
}
return 0;
}
/* sets the value of a variable without the need of commit
*
* return value:
* 0: success
* -1: error
* 1: variable has not been found
*/
int cfg_set_now(cfg_ctx_t *ctx, str *group_name, unsigned int *group_id, str *var_name,
void *val, unsigned int val_type)
{
int i;
cfg_group_t *group;
cfg_mapping_t *var;
void *p, *v;
cfg_block_t *block = NULL;
str s, s2;
char *old_string = NULL;
void **replaced = NULL;
cfg_child_cb_t *child_cb = NULL;
cfg_group_inst_t *group_inst = NULL, *new_array = NULL;
unsigned char *var_block;
/* verify the context even if we do not need it now
to make sure that a cfg driver has called the function
(very very weak security) */
if (!ctx) {
LOG(L_ERR, "ERROR: cfg_set_now(): context is undefined\n");
return -1;
}
if ((val_type == CFG_VAR_UNSET) && !group_id) {
LOG(L_ERR, "ERROR: cfg_set_now(): Only group instance values can be deleted\n");
return -1;
}
if (group_id && !cfg_shmized) {
/* The config group has not been shmized yet,
but an additional instance of a variable needs to be added to the group.
Add this instance to the linked list of variables, they
will be fixed later. */
return new_add_var(group_name, *group_id, var_name,
val, val_type);
}
/* look-up the group and the variable */
if (cfg_lookup_var(group_name, var_name, &group, &var)) {
if (!cfg_shmized) {
/* The group may be dynamic which is not yet ready
* before forking */
if ((group = cfg_lookup_group(group_name->s, group_name->len))
&& (group->dynamic == CFG_GROUP_DYNAMIC)
)
return cfg_set_script_var(group, var_name, val, val_type);
}
return 1;
}
/* check whether the variable is read-only */
if (var->def->type & CFG_READONLY) {
LOG(L_ERR, "ERROR: cfg_set_now(): variable is read-only\n");
goto error0;
}
/* The additional variable instances having per-child process callback
* with CFG_CB_ONLY_ONCE flag cannot be rewritten.
* The reason is that such variables typically set global parameters
* as opposed to per-process variables. Hence, it is not possible to set
* the group handle temporary to another block, and then reset it back later. */
if (group_id
&& var->def->on_set_child_cb
&& var->def->type & CFG_CB_ONLY_ONCE
) {
LOG(L_ERR, "ERROR: cfg_set_now(): This variable does not support muliple values.\n");
goto error0;
}
/* check whether we have to convert the type */
if ((val_type != CFG_VAR_UNSET)
&& convert_val(val_type, val, CFG_INPUT_TYPE(var), &v)
)
goto error0;
if ((val_type != CFG_VAR_UNSET)
&& (CFG_INPUT_TYPE(var) == CFG_INPUT_INT)
&& (var->def->min || var->def->max)) {
/* perform a simple min-max check for integers */
if (((int)(long)v < var->def->min)
|| ((int)(long)v > var->def->max)) {
LOG(L_ERR, "ERROR: cfg_set_now(): integer value is out of range\n");
goto error0;
}
}
if ((val_type != CFG_VAR_UNSET)
&& var->def->on_change_cb
) {
/* Call the fixup function.
There is no need to set a temporary cfg handle,
becaue a single variable is changed */
if (!group_id) {
var_block = *(group->handle);
} else {
if (!cfg_local) {
LOG(L_ERR, "ERROR: cfg_set_now(): Local configuration is missing\n");
goto error0;
}
group_inst = cfg_find_group(CFG_GROUP_META(cfg_local, group),
group->size,
*group_id);
if (!group_inst) {
LOG(L_ERR, "ERROR: cfg_set_now(): local group instance %.*s[%u] is not found\n",
group_name->len, group_name->s, *group_id);
goto error0;
}
var_block = group_inst->vars;
}
if (var->def->on_change_cb(var_block,
group_name,
var_name,
&v) < 0) {
LOG(L_ERR, "ERROR: cfg_set_now(): fixup failed\n");
goto error0;
}
}
/* Set the per-child process callback only if the default value is changed.
* The callback of other instances will be called when the config is
* switched to that instance. */
if (!group_id && var->def->on_set_child_cb) {
/* get the name of the variable from the internal struct,
because var_name may be freed before the callback needs it */
s.s = group->name;
s.len = group->name_len;
s2.s = var->def->name;
s2.len = var->name_len;
child_cb = cfg_child_cb_new(&s, &s2,
var->def->on_set_child_cb,
var->def->type);
if (!child_cb) {
LOG(L_ERR, "ERROR: cfg_set_now(): not enough shm memory\n");
goto error0;
}
}
if (cfg_shmized) {
/* make sure that nobody else replaces the global config
while the new one is prepared */
CFG_WRITER_LOCK();
if (group_id) {
group_inst = cfg_find_group(CFG_GROUP_META(*cfg_global, group),
group->size,
*group_id);
if (!group_inst) {
LOG(L_ERR, "ERROR: cfg_set_now(): global group instance %.*s[%u] is not found\n",
group_name->len, group_name->s, *group_id);
goto error;
}
if ((val_type == CFG_VAR_UNSET) && !CFG_VAR_TEST(group_inst, var)) {
/* nothing to do, the variable is not set in the group instance */
CFG_WRITER_UNLOCK();
LOG(L_DBG, "DEBUG: cfg_set_now(): The variable is not set\n");
return 0;
}
var_block = group_inst->vars;
} else {
group_inst = NULL;
var_block = CFG_GROUP_DATA(*cfg_global, group);
}
if (var->def->type & CFG_ATOMIC) {
/* atomic change is allowed, we can rewrite the value
directly in the global config */
p = var_block + var->offset;
} else {
/* clone the memory block, and prepare the modification */
if (!(block = cfg_clone_global())) goto error;
if (group_inst) {
/* The additional array of the group needs to be also cloned.
* When any of the variables within this array is changed, then
* the complete config block and this array is replaced. */
if (!(new_array = cfg_clone_array(CFG_GROUP_META(*cfg_global, group), group)))
goto error;
group_inst = (cfg_group_inst_t *)translate_pointer((char *)new_array,
(char *)CFG_GROUP_META(*cfg_global, group)->array,
(char *)group_inst);
var_block = group_inst->vars;
CFG_GROUP_META(block, group)->array = new_array;
} else {
/* The additional array may need to be replaced depending
* on whether or not there is any variable in the array set
* to the default value which is changed now. If this is the case,
* then the array will be replaced later when the variables are
* updated.
*/
var_block = CFG_GROUP_DATA(block, group);
}
p = var_block + var->offset;
}
} else {
/* we are allowed to rewrite the value on-the-fly
The handle either points to group->vars, or to the
shared memory block (dynamic group) */
p = *(group->handle) + var->offset;
}
if (val_type != CFG_VAR_UNSET) {
/* set the new value */
switch (CFG_VAR_TYPE(var)) {
case CFG_VAR_INT:
*(int *)p = (int)(long)v;
break;
case CFG_VAR_STRING:
/* clone the string to shm mem */
s.s = v;
s.len = (s.s) ? strlen(s.s) : 0;
if (cfg_clone_str(&s, &s)) goto error;
old_string = *(char **)p;
*(char **)p = s.s;
break;
case CFG_VAR_STR:
/* clone the string to shm mem */
s = *(str *)v;
if (cfg_clone_str(&s, &s)) goto error;
old_string = *(char **)p;
memcpy(p, &s, sizeof(str));
break;
case CFG_VAR_POINTER:
*(void **)p = v;
break;
}
if (group_inst && !CFG_VAR_TEST_AND_SET(group_inst, var))
old_string = NULL; /* the string is the same as the default one,
it cannot be freed */
} else {
/* copy the default value to the group instance */
if ((CFG_VAR_TYPE(var) == CFG_VAR_STRING)
|| (CFG_VAR_TYPE(var) == CFG_VAR_STR))
old_string = *(char **)p;
memcpy(p, CFG_GROUP_DATA(*cfg_global, group) + var->offset, cfg_var_size(var));
CFG_VAR_TEST_AND_RESET(group_inst, var);
}
if (cfg_shmized) {
if (!group_inst) {
/* the default value is changed, the copies of this value
need to be also updated */
if (cfg_update_defaults(CFG_GROUP_META(block ? block : *cfg_global, group),
group, var, p,
block ? 1 : 0) /* clone if needed */
)
goto error;
if (block && (CFG_GROUP_META(block, group)->array != CFG_GROUP_META(*cfg_global, group)->array))
new_array = CFG_GROUP_META(block, group)->array;
}
if (old_string || new_array) {
/* prepare the array of the replaced strings,
and replaced group instances,
they will be freed when the old block is freed */
replaced = (void **)shm_malloc(sizeof(void *)
* ((old_string?1:0) + (new_array?1:0) + 1));
if (!replaced) {
LOG(L_ERR, "ERROR: cfg_set_now(): not enough shm memory\n");
goto error;
}
i = 0;
if (old_string) {
replaced[i] = old_string;
i++;
}
if (new_array) {
replaced[i] = CFG_GROUP_META(*cfg_global, group)->array;
i++;
}
replaced[i] = NULL;
}
/* replace the global config with the new one */
if (block) cfg_install_global(block, replaced, child_cb, child_cb);
CFG_WRITER_UNLOCK();
} else {
/* cfg_set() may be called more than once before forking */
if (old_string && (var->flag & cfg_var_shmized))
shm_free(old_string);
/* flag the variable because there is no need
to shmize it again */
var->flag |= cfg_var_shmized;
/* the global config does not have to be replaced,
but the child callback has to be installed, otherwise the
child processes will miss the change */
if (child_cb)
cfg_install_child_cb(child_cb, child_cb);
}
if (val_type == CFG_VAR_INT)
LOG(L_INFO, "INFO: cfg_set_now(): %.*s.%.*s "
"has been changed to %d\n",
group_name->len, group_name->s,
var_name->len, var_name->s,
(int)(long)val);
else if (val_type == CFG_VAR_STRING)
LOG(L_INFO, "INFO: cfg_set_now(): %.*s.%.*s "
"has been changed to \"%s\"\n",
group_name->len, group_name->s,
var_name->len, var_name->s,
(char *)val);
else if (val_type == CFG_VAR_STR)
LOG(L_INFO, "INFO: cfg_set_now(): %.*s.%.*s "
"has been changed to \"%.*s\"\n",
group_name->len, group_name->s,
var_name->len, var_name->s,
((str *)val)->len, ((str *)val)->s);
else if (val_type == CFG_VAR_UNSET)
LOG(L_INFO, "INFO: cfg_set_now(): %.*s.%.*s "
"has been deleted\n",
group_name->len, group_name->s,
var_name->len, var_name->s);
else
LOG(L_INFO, "INFO: cfg_set_now(): %.*s.%.*s "
"has been changed\n",
group_name->len, group_name->s,
var_name->len, var_name->s);
if (group_id)
LOG(L_INFO, "INFO: cfg_set_now(): group id = %u\n",
*group_id);
convert_val_cleanup();
return 0;
error:
if (cfg_shmized) CFG_WRITER_UNLOCK();
if (block) cfg_block_free(block);
if (new_array) shm_free(new_array);
if (child_cb) cfg_child_cb_free_list(child_cb);
if (replaced) shm_free(replaced);
error0:
LOG(L_ERR, "ERROR: cfg_set_now(): failed to set the variable: %.*s.%.*s\n",
group_name->len, group_name->s,
var_name->len, var_name->s);
convert_val_cleanup();
return -1;
}
/* wrapper function for cfg_set_now */
int cfg_set_now_int(cfg_ctx_t *ctx, str *group_name, unsigned int *group_id, str *var_name,
int val)
{
return cfg_set_now(ctx, group_name, group_id, var_name,
(void *)(long)val, CFG_VAR_INT);
}
/* wrapper function for cfg_set_now */
int cfg_set_now_string(cfg_ctx_t *ctx, str *group_name, unsigned int *group_id, str *var_name,
char *val)
{
return cfg_set_now(ctx, group_name, group_id, var_name,
(void *)val, CFG_VAR_STRING);
}
/* wrapper function for cfg_set_now */
int cfg_set_now_str(cfg_ctx_t *ctx, str *group_name, unsigned int *group_id, str *var_name,
str *val)
{
return cfg_set_now(ctx, group_name, group_id, var_name,
(void *)val, CFG_VAR_STR);
}
/* Delete a variable from the group instance.
* wrapper function for cfg_set_now */
int cfg_del_now(cfg_ctx_t *ctx, str *group_name, unsigned int *group_id, str *var_name)
{
return cfg_set_now(ctx, group_name, group_id, var_name,
NULL, CFG_VAR_UNSET);
}
/* sets the value of a variable but does not commit the change
*
* return value:
* 0: success
* -1: error
* 1: variable has not been found
*/
int cfg_set_delayed(cfg_ctx_t *ctx, str *group_name, unsigned int *group_id, str *var_name,
void *val, unsigned int val_type)
{
cfg_group_t *group;
cfg_mapping_t *var;
void *v;
unsigned char *temp_handle;
int temp_handle_created;
cfg_changed_var_t *changed = NULL, **changed_p;
int size;
str s;
cfg_group_inst_t *group_inst = NULL;
unsigned char *var_block;
if (!cfg_shmized)
/* the cfg has not been shmized yet, there is no
point in registering the change and committing it later */
return cfg_set_now(ctx, group_name, group_id, var_name,
val, val_type);
if (!ctx) {
LOG(L_ERR, "ERROR: cfg_set_delayed(): context is undefined\n");
return -1;
}
if ((val_type == CFG_VAR_UNSET) && !group_id) {
LOG(L_ERR, "ERROR: cfg_set_delayed(): Only group instance values can be deleted\n");
return -1;
}
/* look-up the group and the variable */
if (cfg_lookup_var(group_name, var_name, &group, &var))
return 1;
/* check whether the variable is read-only */
if (var->def->type & CFG_READONLY) {
LOG(L_ERR, "ERROR: cfg_set_delayed(): variable is read-only\n");
goto error0;
}
/* The additional variable instances having per-child process callback
* with CFG_CB_ONLY_ONCE flag cannot be rewritten.
* The reason is that such variables typically set global parameters
* as opposed to per-process variables. Hence, it is not possible to set
* the group handle temporary to another block, and then reset it back later. */
if (group_id
&& var->def->on_set_child_cb
&& var->def->type & CFG_CB_ONLY_ONCE
) {
LOG(L_ERR, "ERROR: cfg_set_delayed(): This variable does not support muliple values.\n");
goto error0;
}
/* check whether we have to convert the type */
if ((val_type != CFG_VAR_UNSET)
&& convert_val(val_type, val, CFG_INPUT_TYPE(var), &v)
)
goto error0;
if ((val_type != CFG_VAR_UNSET)
&& (CFG_INPUT_TYPE(var) == CFG_INPUT_INT)
&& (var->def->min || var->def->max)) {
/* perform a simple min-max check for integers */
if (((int)(long)v < var->def->min)
|| ((int)(long)v > var->def->max)) {
LOG(L_ERR, "ERROR: cfg_set_delayed(): integer value is out of range\n");
goto error0;
}
}
/* the ctx must be locked while reading and writing
the list of changed variables */
CFG_CTX_LOCK(ctx);
if ((val_type != CFG_VAR_UNSET) && var->def->on_change_cb) {
/* The fixup function must see also the
not yet committed values, so a temporary handle
must be prepared that points to the new config.
Only the values within the group are applied,
other modifications are not visible to the callback.
The local config is the base. */
if (!group_id) {
var_block = *(group->handle);
} else {
if (!cfg_local) {
LOG(L_ERR, "ERROR: cfg_set_delayed(): Local configuration is missing\n");
goto error;
}
group_inst = cfg_find_group(CFG_GROUP_META(cfg_local, group),
group->size,
*group_id);
if (!group_inst) {
LOG(L_ERR, "ERROR: cfg_set_delayed(): local group instance %.*s[%u] is not found\n",
group_name->len, group_name->s, *group_id);
goto error;
}
var_block = group_inst->vars;
}
if (ctx->changed_first) {
temp_handle = (unsigned char *)pkg_malloc(group->size);
if (!temp_handle) {
LOG(L_ERR, "ERROR: cfg_set_delayed(): "
"not enough memory\n");
goto error;
}
temp_handle_created = 1;
memcpy(temp_handle, var_block, group->size);
/* apply the changes */
for ( changed = ctx->changed_first;
changed;
changed = changed->next
) {
if (changed->group != group)
continue;
if ((!group_id && !changed->group_id_set) /* default values */
|| (group_id && !changed->group_id_set
&& !CFG_VAR_TEST(group_inst, changed->var))
/* default value is changed which affects the group_instance */
|| (group_id && changed->group_id_set
&& (*group_id == changed->group_id))
/* change within the group instance */
)
memcpy( temp_handle + changed->var->offset,
changed->new_val.vraw,
cfg_var_size(changed->var));
}
} else {
/* there is not any change */
temp_handle = var_block;
temp_handle_created = 0;
}
if (var->def->on_change_cb(temp_handle,
group_name,
var_name,
&v) < 0) {
LOG(L_ERR, "ERROR: cfg_set_delayed(): fixup failed\n");
if (temp_handle_created) pkg_free(temp_handle);
goto error;
}
if (temp_handle_created) pkg_free(temp_handle);
}
/* everything went ok, we can add the new value to the list */
size = sizeof(cfg_changed_var_t)
- sizeof(((cfg_changed_var_t*)0)->new_val)
+ ((val_type != CFG_VAR_UNSET) ? cfg_var_size(var) : 0);
changed = (cfg_changed_var_t *)shm_malloc(size);
if (!changed) {
LOG(L_ERR, "ERROR: cfg_set_delayed(): not enough shm memory\n");
goto error;
}
memset(changed, 0, size);
changed->group = group;
changed->var = var;
if (group_id) {
changed->group_id = *group_id;
changed->group_id_set = 1;
}
if (val_type != CFG_VAR_UNSET) {
switch (CFG_VAR_TYPE(var)) {
case CFG_VAR_INT:
changed->new_val.vint = (int)(long)v;
break;
case CFG_VAR_STRING:
/* clone the string to shm mem */
s.s = v;
s.len = (s.s) ? strlen(s.s) : 0;
if (cfg_clone_str(&s, &s)) goto error;
changed->new_val.vp = s.s;
break;
case CFG_VAR_STR:
/* clone the string to shm mem */
s = *(str *)v;
if (cfg_clone_str(&s, &s)) goto error;
changed->new_val.vstr=s;
break;
case CFG_VAR_POINTER:
changed->new_val.vp=v;
break;
}
} else {
changed->del_value = 1;
}
/* Order the changes by group + group_id + original order.
* Hence, the list is still kept in order within the group.
* The changes can be committed faster this way, the group instances
* do not have to be looked-up for each and every variable. */
/* Check whether there is any variable in the list which
belongs to the same group */
for ( changed_p = &ctx->changed_first;
*changed_p && ((*changed_p)->group != changed->group);
changed_p = &(*changed_p)->next);
/* try to find the group instance, and move changed_p to the end of
the instance. */
for ( ;
*changed_p
&& ((*changed_p)->group == changed->group)
&& (!(*changed_p)->group_id_set
|| ((*changed_p)->group_id_set && changed->group_id_set
&& ((*changed_p)->group_id <= changed->group_id)));
changed_p = &(*changed_p)->next);
/* Add the new variable before *changed_p */
changed->next = *changed_p;
*changed_p = changed;
CFG_CTX_UNLOCK(ctx);
if (val_type == CFG_VAR_INT)
LOG(L_INFO, "INFO: cfg_set_delayed(): %.*s.%.*s "
"is going to be changed to %d "
"[context=%p]\n",
group_name->len, group_name->s,
var_name->len, var_name->s,
(int)(long)val,
ctx);
else if (val_type == CFG_VAR_STRING)
LOG(L_INFO, "INFO: cfg_set_delayed(): %.*s.%.*s "
"is going to be changed to \"%s\" "
"[context=%p]\n",
group_name->len, group_name->s,
var_name->len, var_name->s,
(char *)val,
ctx);
else if (val_type == CFG_VAR_STR)
LOG(L_INFO, "INFO: cfg_set_delayed(): %.*s.%.*s "
"is going to be changed to \"%.*s\" "
"[context=%p]\n",
group_name->len, group_name->s,
var_name->len, var_name->s,
((str *)val)->len, ((str *)val)->s,
ctx);
else if (val_type == CFG_VAR_UNSET)
LOG(L_INFO, "INFO: cfg_set_delayed(): %.*s.%.*s "
"is going to be deleted "
"[context=%p]\n",
group_name->len, group_name->s,
var_name->len, var_name->s,
ctx);
else
LOG(L_INFO, "INFO: cfg_set_delayed(): %.*s.%.*s "
"is going to be changed "
"[context=%p]\n",
group_name->len, group_name->s,
var_name->len, var_name->s,
ctx);
if (group_id)
LOG(L_INFO, "INFO: cfg_set_delayed(): group id = %u "
"[context=%p]\n",
*group_id,
ctx);
convert_val_cleanup();
return 0;
error:
CFG_CTX_UNLOCK(ctx);
if (changed) shm_free(changed);
error0:
LOG(L_ERR, "ERROR: cfg_set_delayed(): failed to set the variable: %.*s.%.*s\n",
group_name->len, group_name->s,
var_name->len, var_name->s);
convert_val_cleanup();
return -1;
}
/* wrapper function for cfg_set_delayed */
int cfg_set_delayed_int(cfg_ctx_t *ctx, str *group_name, unsigned int *group_id, str *var_name,
int val)
{
return cfg_set_delayed(ctx, group_name, group_id, var_name,
(void *)(long)val, CFG_VAR_INT);
}
/* wrapper function for cfg_set_delayed */
int cfg_set_delayed_string(cfg_ctx_t *ctx, str *group_name, unsigned int *group_id, str *var_name,
char *val)
{
return cfg_set_delayed(ctx, group_name, group_id, var_name,
(void *)val, CFG_VAR_STRING);
}
/* wrapper function for cfg_set_delayed */
int cfg_set_delayed_str(cfg_ctx_t *ctx, str *group_name, unsigned int *group_id, str *var_name,
str *val)
{