forked from freeDiameter/freeDiameter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmessages.c
2896 lines (2356 loc) · 93.7 KB
/
messages.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
/*********************************************************************************************************
* Software License Agreement (BSD License) *
* Author: Sebastien Decugis <sdecugis@freediameter.net> *
* *
* Copyright (c) 2023, WIDE Project and NICT *
* All rights reserved. *
* *
* Redistribution and use of this software in source and binary forms, with or without modification, are *
* permitted provided that the following conditions are met: *
* *
* * Redistributions of source code must retain the above *
* copyright notice, this list of conditions and the *
* following disclaimer. *
* *
* * Redistributions in binary form must reproduce the above *
* copyright notice, this list of conditions and the *
* following disclaimer in the documentation and/or other *
* materials provided with the distribution. *
* *
* * Neither the name of the WIDE Project or NICT nor the *
* names of its contributors may be used to endorse or *
* promote products derived from this software without *
* specific prior written permission of WIDE Project and *
* NICT. *
* *
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED *
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR *
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT *
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS *
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR *
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF *
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
*********************************************************************************************************/
/* Messages module.
*
* This module allows to manipulate the msg and avp structures that represents a Diameter message in memory.
*/
#include "fdproto-internal.h"
#include <sys/param.h>
/* Type of object */
enum msg_objtype {
MSG_MSG = 1,
MSG_AVP
};
/* Chaining of elements as a free hierarchy */
struct msg_avp_chain {
struct fd_list chaining; /* Chaining information at this level. */
struct fd_list children; /* sentinel for the children of this object */
enum msg_objtype type; /* Type of this object, _MSG_MSG or _MSG_AVP */
};
/* Return the chain information from an AVP or MSG. Since it's the first field, we just cast */
#define _C(_x) ((struct msg_avp_chain *)(_x))
/* Some details about chaining:
*
* A message is made of a header ( msg ) and 0 or more AVPs ( avp ).
* The structure is a kind of tree, where some AVPs (grouped AVPs) can contain other AVPs.
* Example:
* msg
* |-avp
* |-gavp
* | |-avp
* | |-avp
* | \-avp
* |-avp
* \-avp
*
* Each item (msg or avp) structure begins with a msg_avp_chain structure.
* The element at the top of the hierarchy (msg in our example) has all the fields of its "chaining" equal to the same value.
*
* All elements at the same level are linked by their "chaining" list.
* The "children" list is the sentinel for the lists of children of this element.
*/
/* The following definitions are used to recognize objects in memory. */
#define MSG_MSG_EYEC (0x11355463)
#define MSG_AVP_EYEC (0x11355467)
/* The following structure represents an AVP instance. */
struct avp {
struct msg_avp_chain avp_chain; /* Chaining information of this AVP */
int avp_eyec; /* Must be equal to MSG_AVP_EYEC */
struct dict_object *avp_model; /* If not NULL, pointer to the dictionary object of this avp */
struct {
avp_code_t mnf_code;
vendor_id_t mnf_vendor;
} avp_model_not_found; /* When model resolution has failed, store a copy of the data here to avoid searching again */
struct avp_hdr avp_public; /* AVP data that can be managed by other modules */
uint8_t *avp_source; /* If the message was parsed from a buffer, pointer to the AVP data start in the buffer. */
uint8_t *avp_rawdata; /* when the data can not be interpreted, the raw data is copied here. The header is not part of it. */
size_t avp_rawlen; /* The length of the raw buffer. */
union avp_value avp_storage; /* To avoid many alloc/free, store the integer values here and set avp_public.avp_data to &storage */
int avp_mustfreeos; /* 1 if an octetstring is malloc'd in avp_storage and must be freed. */
};
/* Macro to compute the AVP header size */
#define AVPHDRSZ_NOVEND 8
#define AVPHDRSZ_VENDOR 12
#define GETAVPHDRSZ( _flag ) ((_flag & AVP_FLAG_VENDOR) ? AVPHDRSZ_VENDOR : AVPHDRSZ_NOVEND)
/* Macro to cast a msg_avp_t */
#define _A(_x) ((struct avp *)(_x))
/* Check the type and eyecatcher */
#define CHECK_AVP(_x) ((_x) && (_C(_x)->type == MSG_AVP) && (_A(_x)->avp_eyec == MSG_AVP_EYEC))
/* The following structure represents an instance of a message (command and children AVPs). */
struct msg {
struct msg_avp_chain msg_chain; /* List of the AVPs in the message */
int msg_eyec; /* Must be equal to MSG_MSG_EYEC */
struct dict_object *msg_model; /* If not NULL, pointer to the dictionary object of this message */
struct {
command_code_t mnf_code;
uint8_t mnf_flags;
} msg_model_not_found; /* When model resolution has failed, store a copy of the data here to avoid searching again */
struct msg_hdr msg_public; /* Message data that can be managed by extensions. */
uint8_t *msg_rawbuffer; /* data buffer that was received, saved during fd_msg_parse_buffer and freed in fd_msg_parse_dict */
int msg_routable; /* Is this a routable message? (0: undef, 1: routable, 2: non routable) */
struct msg *msg_query; /* the associated query if the message is a received answer */
int msg_associated; /* and the counter part information in the query, to avoid double free */
struct rt_data *msg_rtdata; /* Routing list for the query */
struct session *msg_sess; /* Cached message session if any */
struct {
void (*anscb)(void *, struct msg **);
void (*expirecb)(void *, DiamId_t, size_t, struct msg **);
void * data;
struct timespec timeout;
} msg_cb; /* Callback to be called when an answer is received, or timeout expires, if not NULL */
DiamId_t msg_src_id; /* Diameter Id of the peer this message was received from. This string is malloc'd and must be freed */
size_t msg_src_id_len; /* cached length of this string */
struct fd_msg_pmdl msg_pmdl; /* list of permessagedata structures. */
};
/* Macro to compute the message header size */
#define GETMSGHDRSZ() 20
/* Macro to cast a msg_avp_t */
#define _M(_x) ((struct msg *)(_x))
/* Check the type and eyecatcher */
#define CHECK_MSG(_x) ((_x) && (_C(_x)->type == MSG_MSG) && (_M(_x)->msg_eyec == MSG_MSG_EYEC))
#define VALIDATE_OBJ(_x) ( (CHECK_MSG(_x)) || (CHECK_AVP(_x)) )
/* Macro to validate a MSGFL_ value */
#define CHECK_AVPFL(_fl) ( ((_fl) & (- (AVPFL_MAX << 1) )) == 0 )
#define CHECK_MSGFL(_fl) ( ((_fl) & (- (MSGFL_MAX << 1) )) == 0 )
/* initial sizes of AVP from their types, in bytes. */
static int avp_value_sizes[] = {
0, /* AVP_TYPE_GROUPED: size is dynamic */
0, /* AVP_TYPE_OCTETSTRING: size is dynamic */
4, /* AVP_TYPE_INTEGER32: size is 32 bits */
8, /* AVP_TYPE_INTEGER64: size is 64 bits */
4, /* AVP_TYPE_UNSIGNED32: size is 32 bits */
8, /* AVP_TYPE_UNSIGNED64: size is 64 bits */
4, /* AVP_TYPE_FLOAT32: size is 32 bits */
8 /* AVP_TYPE_FLOAT64: size is 64 bits */
};
#define CHECK_BASETYPE( _type ) ( ((_type) <= AVP_TYPE_MAX) && ((_type) >= 0) )
#define GETINITIALSIZE( _type, _vend ) (avp_value_sizes[ CHECK_BASETYPE(_type) ? (_type) : 0] + GETAVPHDRSZ(_vend))
/* Forward declaration */
static int parsedict_do_msg(struct dictionary * dict, struct msg * msg, int only_hdr, struct fd_pei *error_info);
/***************************************************************************************************************/
/* Creating objects */
/* Initialize a msg_avp_chain structure */
static void init_chain(struct msg_avp_chain * chain, int type)
{
fd_list_init( &chain->chaining, (void *)chain);
fd_list_init( &chain->children, (void *)chain);
chain->type = type;
}
/* Initialize a new AVP object */
static void init_avp ( struct avp * avp )
{
TRACE_ENTRY("%p", avp);
memset(avp, 0, sizeof(struct avp));
init_chain( &avp->avp_chain, MSG_AVP);
avp->avp_eyec = MSG_AVP_EYEC;
}
/* Initialize a new MSG object */
static void init_msg ( struct msg * msg )
{
TRACE_ENTRY("%p", msg);
memset(msg, 0, sizeof(struct msg));
init_chain( &msg->msg_chain, MSG_MSG);
msg->msg_eyec = MSG_MSG_EYEC;
fd_list_init(&msg->msg_pmdl.sentinel, NULL);
CHECK_POSIX_DO( pthread_mutex_init(&msg->msg_pmdl.lock, NULL), );
}
/* Create a new AVP instance */
int fd_msg_avp_new ( struct dict_object * model, int flags, struct avp ** avp )
{
struct avp *new = NULL;
TRACE_ENTRY("%p %x %p", model, flags, avp);
/* Check the parameters */
CHECK_PARAMS( avp && CHECK_AVPFL(flags) );
if (model) {
enum dict_object_type dicttype;
CHECK_PARAMS( (fd_dict_gettype(model, &dicttype) == 0) && (dicttype == DICT_AVP) );
}
/* Create a new object */
CHECK_MALLOC( new = malloc (sizeof(struct avp)) );
/* Initialize the fields */
init_avp(new);
if (model) {
struct dict_avp_data dictdata;
CHECK_FCT_DO( fd_dict_getval(model, &dictdata), { free(new); return __ret__; } );
new->avp_model = model;
new->avp_public.avp_code = dictdata.avp_code;
new->avp_public.avp_flags = dictdata.avp_flag_val;
new->avp_public.avp_len = GETINITIALSIZE(dictdata.avp_basetype, dictdata.avp_flag_val );
new->avp_public.avp_vendor = dictdata.avp_vendor;
}
if (flags & AVPFL_SET_BLANK_VALUE) {
new->avp_public.avp_value = &new->avp_storage;
}
if (flags & AVPFL_SET_RAWDATA_FROM_AVP) {
new->avp_rawlen = (*avp)->avp_public.avp_len - GETAVPHDRSZ( (*avp)->avp_public.avp_flags );
if (new->avp_rawlen) {
CHECK_MALLOC_DO( new->avp_rawdata = malloc(new->avp_rawlen), { free(new); return __ret__; } );
memset(new->avp_rawdata, 0x00, new->avp_rawlen);
}
}
/* The new object is ready, return */
*avp = new;
return 0;
}
/* Create a new message instance */
int fd_msg_new ( struct dict_object * model, int flags, struct msg ** msg )
{
struct msg * new = NULL;
TRACE_ENTRY("%p %x %p", model, flags, msg);
/* Check the parameters */
CHECK_PARAMS( msg && CHECK_MSGFL(flags) );
if (model) {
enum dict_object_type dicttype;
CHECK_PARAMS( (fd_dict_gettype(model, &dicttype) == 0) && (dicttype == DICT_COMMAND) );
}
/* Create a new object */
CHECK_MALLOC( new = malloc (sizeof(struct msg)) );
/* Initialize the fields */
init_msg(new);
new->msg_public.msg_version = DIAMETER_VERSION;
new->msg_public.msg_length = GETMSGHDRSZ(); /* This will be updated later */
if (model) {
struct dictionary *dict;
struct dict_cmd_data dictdata;
struct dict_object *dictappl;
CHECK_FCT_DO( fd_dict_getdict(model, &dict), { free(new); return __ret__; } );
CHECK_FCT_DO( fd_dict_getval(model, &dictdata), { free(new); return __ret__; } );
new->msg_model = model;
new->msg_public.msg_flags = dictdata.cmd_flag_val;
new->msg_public.msg_code = dictdata.cmd_code;
/* Initialize application from the parent, if any */
CHECK_FCT_DO( fd_dict_search( dict, DICT_APPLICATION, APPLICATION_OF_COMMAND, model, &dictappl, 0), { free(new); return __ret__; } );
if (dictappl != NULL) {
struct dict_application_data appdata;
CHECK_FCT_DO( fd_dict_getval(dictappl, &appdata), { free(new); return __ret__; } );
new->msg_public.msg_appl = appdata.application_id;
}
}
if (flags & MSGFL_ALLOC_ETEID) {
new->msg_public.msg_eteid = fd_msg_eteid_get();
}
/* The new object is ready, return */
*msg = new;
return 0;
}
static int bufferize_avp(unsigned char * buffer, size_t buflen, size_t * offset, struct avp * avp);
static int parsebuf_list(unsigned char * buf, size_t buflen, struct fd_list * head);
static int parsedict_do_chain(struct dictionary * dict, struct fd_list * head, int mandatory, struct fd_pei *error_info);
/* Create answer from a request */
int fd_msg_new_answer_from_req ( struct dictionary * dict, struct msg ** msg, int flags )
{
struct dict_object * model = NULL;
struct msg *qry, *ans;
struct session * sess = NULL;
TRACE_ENTRY("%p %x", msg, flags);
/* Check the parameters */
CHECK_PARAMS( msg );
qry = *msg;
CHECK_PARAMS( CHECK_MSG(qry) && (qry->msg_public.msg_flags & CMD_FLAG_REQUEST) );
if (! (flags & MSGFL_ANSW_NOSID)) {
/* Get the session of the message */
CHECK_FCT_DO( fd_msg_sess_get(dict, qry, &sess, NULL), /* ignore an error */ );
}
/* Find the model for the answer */
if (flags & MSGFL_ANSW_ERROR) {
/* The model is the generic error format */
CHECK_FCT( fd_dict_get_error_cmd(dict, &model) );
} else {
/* The model is the answer corresponding to the query. It supposes that these are defined in the dictionary */
CHECK_FCT_DO( parsedict_do_msg( dict, qry, 1, NULL), /* continue */ );
if (qry->msg_model) {
CHECK_FCT( fd_dict_search ( dict, DICT_COMMAND, CMD_ANSWER, qry->msg_model, &model, EINVAL ) );
}
}
/* Create the answer */
CHECK_FCT( fd_msg_new( model, flags, &ans ) );
/* Set information in the answer as in the query */
ans->msg_public.msg_code = qry->msg_public.msg_code; /* useful for MSGFL_ANSW_ERROR */
ans->msg_public.msg_appl = qry->msg_public.msg_appl;
ans->msg_public.msg_eteid = qry->msg_public.msg_eteid;
ans->msg_public.msg_hbhid = qry->msg_public.msg_hbhid;
/* Add the Session-Id AVP if session is known */
if (sess && dict) {
static struct dict_object * sess_id_avp = NULL;
os0_t sid;
size_t sidlen;
struct avp * avp;
union avp_value val;
if (!sess_id_avp) {
CHECK_FCT_DO( fd_dict_search( dict, DICT_AVP, AVP_BY_NAME, "Session-Id", &sess_id_avp, ENOENT), { free(ans); return __ret__; } );
}
CHECK_FCT_DO( fd_sess_getsid ( sess, &sid, &sidlen ), { free(ans); return __ret__; } );
CHECK_FCT_DO( fd_msg_avp_new ( sess_id_avp, 0, &avp ), { free(ans); return __ret__; } );
val.os.data = sid;
val.os.len = sidlen;
CHECK_FCT_DO( fd_msg_avp_setvalue( avp, &val ), { free(avp); free(ans); return __ret__; } );
CHECK_FCT_DO( fd_msg_avp_add( ans, MSG_BRW_FIRST_CHILD, avp ), { free(avp); free(ans); return __ret__; } );
ans->msg_sess = sess;
CHECK_FCT_DO( fd_sess_ref_msg(sess), { free(ans); return __ret__; } );
}
/* Add all Proxy-Info AVPs from the query if any */
if (! (flags & MSGFL_ANSW_NOPROXYINFO)) {
struct avp * avp;
struct fd_pei pei;
struct fd_list avpcpylist = FD_LIST_INITIALIZER(avpcpylist);
CHECK_FCT_DO( fd_msg_browse(qry, MSG_BRW_FIRST_CHILD, &avp, NULL) , { free(ans); return __ret__; } );
while (avp) {
if ( (avp->avp_public.avp_code == AC_PROXY_INFO)
&& (avp->avp_public.avp_vendor == 0) ) {
/* We found a Proxy-Info, need to duplicate it in the answer */
/* In order to avoid dealing with all different possibilities of states, we just create a buffer then parse it */
unsigned char * buf = NULL;
size_t offset = 0;
/* Create a buffer with the content of the AVP. This is easier than going through the list */
CHECK_FCT_DO( fd_msg_update_length(avp), { free(ans); return __ret__; } );
CHECK_MALLOC_DO( buf = malloc(avp->avp_public.avp_len), { free(ans); return __ret__; } );
CHECK_FCT_DO( bufferize_avp(buf, avp->avp_public.avp_len, &offset, avp), { free(buf); free(ans); return __ret__; } );
/* Now we parse this buffer to create a copy AVP */
CHECK_FCT_DO( parsebuf_list(buf, avp->avp_public.avp_len, &avpcpylist), { free(buf); free(ans); return __ret__; } );
/* Parse dictionary objects now to remove the dependency on the buffer */
CHECK_FCT_DO( parsedict_do_chain(dict, &avpcpylist, 0, &pei), { /* leaking the avpcpylist -- this should never happen anyway */ free(buf); free(ans); return __ret__; } );
/* Done for this AVP */
free(buf);
/* We move this AVP now so that we do not parse again in next loop */
fd_list_move_end(&ans->msg_chain.children, &avpcpylist);
}
/* move to next AVP in the message, we can have several Proxy-Info instances */
CHECK_FCT_DO( fd_msg_browse(avp, MSG_BRW_NEXT, &avp, NULL), { free(ans); return __ret__; } );
}
}
/* associate with query */
ans->msg_query = qry;
qry->msg_associated = 1;
/* Done */
*msg = ans;
return 0;
}
/***************************************************************************************************************/
/* Explore a message */
int fd_msg_browse_internal ( msg_or_avp * reference, enum msg_brw_dir dir, msg_or_avp ** found, int * depth )
{
struct msg_avp_chain *result = NULL;
int diff = 0;
struct fd_list *li = NULL;
TRACE_ENTRY("%p %d %p %p", reference, dir, found, depth);
/* Initialize the "found" result if any */
if (found)
*found = NULL;
/* Check the parameters */
CHECK_PARAMS( VALIDATE_OBJ(reference) );
TRACE_DEBUG(FCTS, "chaining(%p): nxt:%p prv:%p hea:%p top:%p",
&_C(reference)->chaining,
_C(reference)->chaining.next,
_C(reference)->chaining.prev,
_C(reference)->chaining.head,
_C(reference)->chaining.o);
TRACE_DEBUG(FCTS, "children(%p): nxt:%p prv:%p hea:%p top:%p",
&_C(reference)->children,
_C(reference)->children.next,
_C(reference)->children.prev,
_C(reference)->children.head,
_C(reference)->children.o);
/* Now search */
switch (dir) {
case MSG_BRW_NEXT:
/* Check the reference is an AVP */
CHECK_PARAMS( _C(reference)->type == MSG_AVP );
li = &_C(reference)->chaining;
/* Check if the next element is not the sentinel ( ==> the parent) */
if (li->next != li->head)
result = _C(li->next->o);
break;
case MSG_BRW_PREV:
/* Check the reference is an AVP */
CHECK_PARAMS( _C(reference)->type == MSG_AVP );
li = &_C(reference)->chaining;
/* Check if the prev element is not the sentinel ( ==> the parent) */
if (li->prev != li->head)
result = _C(li->prev->o);
break;
case MSG_BRW_FIRST_CHILD:
li = &_C(reference)->children;
if (! FD_IS_LIST_EMPTY(li)) {
result = _C(li->next->o);
diff = 1;
}
break;
case MSG_BRW_LAST_CHILD:
li = &_C(reference)->children;
if (! FD_IS_LIST_EMPTY(li)) {
result = _C(li->prev->o);
diff = 1;
}
break;
case MSG_BRW_PARENT:
/* If the object is not chained, it has no parent */
li = &_C(reference)->chaining;
if (li != li->head) {
/* The sentinel is the parent's children list */
result = _C(li->head->o);
diff = -1;
}
break;
case MSG_BRW_WALK:
/* First, try to find a child */
li = &_C(reference)->children;
if ( ! FD_IS_LIST_EMPTY(li) ) {
result = _C(li->next->o);
diff = 1;
break;
}
/* Then try to find a "next" at this level or one of the parent's */
li = &_C(reference)->chaining;
do {
/* If this element has a "next" element, return it */
if (li->next != li->head) {
result = _C(li->next->o);
break;
}
/* otherwise, check if we have a parent */
if (li == li->head) {
/* no parent */
break;
}
/* Go to the parent's chaining information and loop */
diff -= 1;
li = &_C(li->head->o)->chaining;
} while (1);
break;
default:
/* Other directions are invalid */
CHECK_PARAMS( dir = 0 );
}
/* Save the found object, if any */
if (found && result)
*found = (void *)result;
/* Modify the depth according to the walk direction */
if (depth && diff)
(*depth) += diff;
/* Return ENOENT if found was NULL */
if ((!found) && (!result))
return ENOENT;
else
return 0;
}
/* Add an AVP into a tree */
int fd_msg_avp_add ( msg_or_avp * reference, enum msg_brw_dir dir, struct avp *avp)
{
TRACE_ENTRY("%p %d %p", reference, dir, avp);
/* Check the parameters */
CHECK_PARAMS( VALIDATE_OBJ(reference) && CHECK_AVP(avp) && FD_IS_LIST_EMPTY(&avp->avp_chain.chaining) );
/* Now insert */
switch (dir) {
case MSG_BRW_NEXT:
/* Check the reference is an AVP -- we do not chain AVPs at same level as msgs. */
CHECK_PARAMS( _C(reference)->type == MSG_AVP );
/* Insert the new avp after the reference */
fd_list_insert_after( &_A(reference)->avp_chain.chaining, &avp->avp_chain.chaining );
break;
case MSG_BRW_PREV:
/* Check the reference is an AVP */
CHECK_PARAMS( _C(reference)->type == MSG_AVP );
/* Insert the new avp before the reference */
fd_list_insert_before( &_A(reference)->avp_chain.chaining, &avp->avp_chain.chaining );
break;
case MSG_BRW_FIRST_CHILD:
/* Insert the new avp after the children sentinel */
fd_list_insert_after( &_C(reference)->children, &avp->avp_chain.chaining );
break;
case MSG_BRW_LAST_CHILD:
/* Insert the new avp before the children sentinel */
fd_list_insert_before( &_C(reference)->children, &avp->avp_chain.chaining );
break;
default:
/* Other directions are invalid */
CHECK_PARAMS( dir = 0 );
}
return 0;
}
/* Search a given AVP model in a message or AVP */
int fd_msg_search_avp ( msg_or_avp * reference, struct dict_object * what, struct avp ** avp )
{
struct avp * nextavp;
struct dict_avp_data dictdata;
enum dict_object_type dicttype;
TRACE_ENTRY("%p %p %p", reference, what, avp);
CHECK_PARAMS( VALIDATE_OBJ(reference) && what );
CHECK_PARAMS( (fd_dict_gettype(what, &dicttype) == 0) && (dicttype == DICT_AVP) );
CHECK_FCT( fd_dict_getval(what, &dictdata) );
/* Loop on all top AVPs in message or AVP */
CHECK_FCT( fd_msg_browse(reference, MSG_BRW_FIRST_CHILD, (void *)&nextavp, NULL) );
while (nextavp) {
if ( (nextavp->avp_public.avp_code == dictdata.avp_code)
&& (nextavp->avp_public.avp_vendor == dictdata.avp_vendor) ) /* always 0 if no V flag */
break;
/* Otherwise move to next AVP in the message or AVP */
CHECK_FCT( fd_msg_browse(nextavp, MSG_BRW_NEXT, (void *)&nextavp, NULL) );
}
if (avp)
*avp = nextavp;
if (avp && nextavp) {
struct dictionary * dict;
CHECK_FCT( fd_dict_getdict( what, &dict) );
CHECK_FCT_DO( fd_msg_parse_dict( nextavp, dict, NULL ), /* nothing */ );
}
if (avp || nextavp)
return 0;
else
return ENOENT;
}
/***************************************************************************************************************/
/* Deleting objects */
void fd_msg_unhook_avp (msg_or_avp *msg)
{
/* Unlink this object if needed */
fd_list_unlink( &(_C(msg))->chaining );
}
/* Destroy and free an AVP or message */
static int destroy_obj (struct msg_avp_chain * obj )
{
TRACE_ENTRY("%p", obj);
/* Check the parameter is a valid object */
CHECK_PARAMS( VALIDATE_OBJ(obj) && FD_IS_LIST_EMPTY( &obj->children ) );
/* Unlink this object if needed */
fd_list_unlink( &obj->chaining );
/* Free the octetstring if needed */
if ((obj->type == MSG_AVP) && (_A(obj)->avp_mustfreeos == 1)) {
free(_A(obj)->avp_storage.os.data);
}
/* Free the rawdata if needed */
if ((obj->type == MSG_AVP) && (_A(obj)->avp_rawdata != NULL)) {
free(_A(obj)->avp_rawdata);
}
if ((obj->type == MSG_MSG) && (_M(obj)->msg_rawbuffer != NULL)) {
free(_M(obj)->msg_rawbuffer);
}
if ((obj->type == MSG_MSG) && (_M(obj)->msg_src_id != NULL)) {
free(_M(obj)->msg_src_id);
}
if ((obj->type == MSG_MSG) && (_M(obj)->msg_rtdata != NULL)) {
fd_rtd_free(&_M(obj)->msg_rtdata);
}
if ((obj->type == MSG_MSG) && (_M(obj)->msg_sess != NULL)) {
CHECK_FCT_DO( fd_sess_reclaim_msg ( &_M(obj)->msg_sess ), /* continue */);
}
if ((obj->type == MSG_MSG) && (_M(obj)->msg_pmdl.sentinel.o != NULL)) {
((void (*)(struct fd_msg_pmdl *))_M(obj)->msg_pmdl.sentinel.o)(&_M(obj)->msg_pmdl);
}
/* free the object */
free(obj);
return 0;
}
/* Destroy an object and all its children */
static void destroy_tree(struct msg_avp_chain * obj)
{
struct fd_list *rem;
TRACE_ENTRY("%p", obj);
/* Destroy any subtree */
while ( (rem = obj->children.next) != &obj->children)
destroy_tree(_C(rem->o));
/* Then unlink and destroy the object */
CHECK_FCT_DO( destroy_obj(obj), /* nothing */ );
}
/* Free an object and its tree */
int fd_msg_free ( msg_or_avp * object )
{
TRACE_ENTRY("%p", object);
if (object == NULL)
return 0;
if (CHECK_MSG(object)) {
if (_M(object)->msg_query) {
_M(_M(object)->msg_query)->msg_associated = 0;
CHECK_FCT( fd_msg_free( _M(object)->msg_query ) );
_M(object)->msg_query = NULL;
} else {
if (_M(object)->msg_associated) {
TRACE_DEBUG(INFO, "Not freeing query %p referenced in an answer (will be freed along the answer).", object);
return 0;
}
}
}
destroy_tree(_C(object));
return 0;
}
/***************************************************************************************************************/
/* Debug functions: dumping */
/* messages and AVP formatters */
typedef DECLARE_FD_DUMP_PROTOTYPE( (*msg_dump_formatter_msg), struct msg * msg );
typedef DECLARE_FD_DUMP_PROTOTYPE( (*msg_dump_formatter_avp), struct avp * avp, int level, int first, int last );
/* Core function to process the dumping */
static DECLARE_FD_DUMP_PROTOTYPE( msg_dump_process, msg_dump_formatter_msg msg_format, msg_dump_formatter_avp avp_format, msg_or_avp *obj, struct dictionary *dict, int force_parsing, int recurse )
{
FD_DUMP_HANDLE_OFFSET();
if (!VALIDATE_OBJ(obj)) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "INVALID MESSAGE OR AVP @%p", obj), return NULL);
return *buf;
}
if (force_parsing) {
(void) fd_msg_parse_dict(obj, dict, NULL);
}
switch (_C(obj)->type) {
case MSG_AVP:
CHECK_MALLOC_DO( (*avp_format)(FD_DUMP_STD_PARAMS, (struct avp *)obj, 0, 1, 1), return NULL);
break;
case MSG_MSG:
CHECK_MALLOC_DO( (*msg_format)(FD_DUMP_STD_PARAMS, (struct msg *)obj), return NULL);
break;
default:
ASSERT(0);
free(*buf);
*buf = NULL;
return NULL;
}
if (recurse) {
struct avp * avp = NULL;
int first = 1;
CHECK_FCT_DO( fd_msg_browse ( obj, MSG_BRW_FIRST_CHILD, &avp, NULL ), avp = NULL );
while (avp) {
struct avp * nextavp = NULL;
CHECK_FCT_DO( fd_msg_browse ( avp, MSG_BRW_NEXT, &nextavp, NULL ), nextavp = NULL );
CHECK_MALLOC_DO( (*avp_format)(FD_DUMP_STD_PARAMS, avp, 1, first, nextavp ? 0 : 1), return NULL);
avp = nextavp;
first = 0;
};
}
return *buf;
}
/*
* Tree View message dump
*/
static DECLARE_FD_DUMP_PROTOTYPE( msg_format_treeview, struct msg * msg )
{
if (!CHECK_MSG(msg)) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "INVALID MESSAGE"), return NULL);
return *buf;
}
if (!msg->msg_model) {
if (msg->msg_model_not_found.mnf_code) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(not found in dictionary)\n"), return NULL);
} else {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(not searched in dictionary)\n"), return NULL);
}
} else {
enum dict_object_type dicttype;
struct dict_cmd_data dictdata;
if (fd_dict_gettype(msg->msg_model, &dicttype) || (dicttype != DICT_COMMAND)) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(invalid model information)\n"), return NULL);
} else if (fd_dict_getval(msg->msg_model, &dictdata)) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(error getting model information)\n"), return NULL);
} else {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "'%s'\n", dictdata.cmd_name), return NULL);
}
}
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " Version: 0x%02hhX\n", msg->msg_public.msg_version), return NULL);
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " Length: %d\n", msg->msg_public.msg_length), return NULL);
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " Flags: 0x%02hhX (" DUMP_CMDFL_str ")\n", msg->msg_public.msg_flags, DUMP_CMDFL_val(msg->msg_public.msg_flags)), return NULL);
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " Command Code: %u\n", msg->msg_public.msg_code), return NULL);
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " ApplicationId: %d\n", msg->msg_public.msg_appl), return NULL);
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " Hop-by-Hop Identifier: 0x%08X\n", msg->msg_public.msg_hbhid), return NULL);
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " End-to-End Identifier: 0x%08X\n", msg->msg_public.msg_eteid), return NULL);
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " {internal data}: src:%s(%zd) rwb:%p rt:%d cb:%p,%p(%p) qry:%p asso:%d sess:%p", msg->msg_src_id?:"(nil)", msg->msg_src_id_len, msg->msg_rawbuffer, msg->msg_routable, msg->msg_cb.anscb, msg->msg_cb.expirecb, msg->msg_cb.data, msg->msg_query, msg->msg_associated, msg->msg_sess), return NULL);
return *buf;
}
static DECLARE_FD_DUMP_PROTOTYPE( avp_format_treeview, struct avp * avp, int level, int first, int last )
{
char * name;
struct dict_avp_data dictdata;
struct dict_avp_data *dictinfo = NULL;
struct dict_vendor_data vendordata;
struct dict_vendor_data *vendorinfo = NULL;
if (level) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n"), return NULL);
}
if (!CHECK_AVP(avp)) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "INVALID AVP"), return NULL);
return *buf;
}
if (level) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "%*sAVP: ", level * 3, ""), return NULL);
}
if (!avp->avp_model) {
if (avp->avp_model_not_found.mnf_code) {
name = "(not found in dictionary)";
} else {
name = "(not searched in dictionary)";
}
} else {
enum dict_object_type dicttype;
if (fd_dict_gettype(avp->avp_model, &dicttype) || (dicttype != DICT_AVP)) {
name = "(invalid model information)";
} else if (fd_dict_getval(avp->avp_model, &dictdata)) {
name = "(error getting model information)";
} else {
name = dictdata.avp_name;
dictinfo = &dictdata;
if (avp->avp_public.avp_flags & AVP_FLAG_VENDOR) {
struct dictionary * dict;
struct dict_object * vendor;
if ((!fd_dict_getdict(avp->avp_model, &dict))
&& (!fd_dict_search(dict, DICT_VENDOR, VENDOR_OF_AVP, avp->avp_model, &vendor, ENOENT))
&& (!fd_dict_getval(vendor, &vendordata))) {
vendorinfo = &vendordata;
}
}
}
}
if (dictinfo) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "'%s'(%u)", name, avp->avp_public.avp_code), return NULL);
} else {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "%u%s", avp->avp_public.avp_code, name), return NULL);
}
if (avp->avp_public.avp_flags & AVP_FLAG_VENDOR) {
if (vendorinfo) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " vend='%s'(%u)", vendorinfo->vendor_name, avp->avp_public.avp_vendor), return NULL);
} else {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " vend=%u", avp->avp_public.avp_vendor), return NULL);
}
}
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " l=%d f=" DUMP_AVPFL_str " val=", avp->avp_public.avp_len, DUMP_AVPFL_val(avp->avp_public.avp_flags)), return NULL);
if (dictinfo && (dictinfo->avp_basetype == AVP_TYPE_GROUPED)) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(grouped)"), return NULL);
if (level) {
struct avp * inavp = NULL;
int first = 1;
CHECK_FCT_DO( fd_msg_browse ( avp, MSG_BRW_FIRST_CHILD, &inavp, NULL ), inavp = NULL );
while (inavp) {
struct avp * nextavp = NULL;
CHECK_FCT_DO( fd_msg_browse ( inavp, MSG_BRW_NEXT, &nextavp, NULL ), inavp = NULL );
CHECK_MALLOC_DO( avp_format_treeview(FD_DUMP_STD_PARAMS, inavp, level + 1, first, nextavp ? 0 : 1), return NULL);
inavp = nextavp;
first = 0;
};
}
} else {
if (avp->avp_public.avp_value) {
CHECK_MALLOC_DO( fd_dict_dump_avp_value(FD_DUMP_STD_PARAMS, avp->avp_public.avp_value, avp->avp_model, 0, 0), return NULL);
} else if (avp->avp_rawdata) {
CHECK_MALLOC_DO( fd_dump_extend_hexdump(FD_DUMP_STD_PARAMS, avp->avp_rawdata, avp->avp_rawlen, 0, 0), return NULL);
} else {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(not set)"), return NULL);
}
}
return *buf;
}
/* multi-line human-readable dump similar to wireshark output */
DECLARE_FD_DUMP_PROTOTYPE( fd_msg_dump_treeview, msg_or_avp *obj, struct dictionary *dict, int force_parsing, int recurse )
{
return msg_dump_process(FD_DUMP_STD_PARAMS, msg_format_treeview, avp_format_treeview, obj, dict, force_parsing, recurse);
}
/*
* One-line dumper for compact but complete traces
*/
static DECLARE_FD_DUMP_PROTOTYPE( msg_format_full, struct msg * msg )
{
int success = 0;
struct dict_cmd_data dictdata;
if (!CHECK_MSG(msg)) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "INVALID MESSAGE"), return NULL);
return *buf;
}
if (!msg->msg_model) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(no model) "), return NULL);
} else {
enum dict_object_type dicttype=0;
if (fd_dict_gettype(msg->msg_model, &dicttype) || (dicttype != DICT_COMMAND)) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(invalid model %d) ", dicttype), return NULL);
} else if (fd_dict_getval(msg->msg_model, &dictdata)) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(error getting model data) "), return NULL);
} else {
success = 1;
}
}
if (msg->msg_public.msg_appl) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS,
"%s(%u/%u)[" DUMP_CMDFL_str "], Length=%u, Hop-By-Hop-Id=0x%08x, End-to-End=0x%08x",
success ? dictdata.cmd_name : "unknown", msg->msg_public.msg_appl, msg->msg_public.msg_code, DUMP_CMDFL_val(msg->msg_public.msg_flags),
msg->msg_public.msg_length, msg->msg_public.msg_hbhid, msg->msg_public.msg_eteid), return NULL);
} else {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS,
"%s(%u)[" DUMP_CMDFL_str "], Length=%u, Hop-By-Hop-Id=0x%08x, End-to-End=0x%08x",
success ? dictdata.cmd_name : "unknown", msg->msg_public.msg_code, DUMP_CMDFL_val(msg->msg_public.msg_flags),
msg->msg_public.msg_length, msg->msg_public.msg_hbhid, msg->msg_public.msg_eteid), return NULL);
}
return *buf;
}
static DECLARE_FD_DUMP_PROTOTYPE( avp_format_full, struct avp * avp, int level, int first, int last )
{
int success = 0;
struct dict_avp_data dictdata;
if (level) {
if ((first) && ((*buf)[*offset - 1] == '=')) {
/* We are first AVP of a grouped AVP */
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "{ "), return NULL);
} else {
/* We follow another AVP, or a message header */
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, ", { "), return NULL);
}
}
if (!CHECK_AVP(avp)) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "INVALID AVP"), return NULL);
goto end;
}
if (avp->avp_model) {
enum dict_object_type dicttype;
if (fd_dict_gettype(avp->avp_model, &dicttype) || (dicttype != DICT_AVP)) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(invalid model: %d) ", dicttype), return NULL);
} else if (fd_dict_getval(avp->avp_model, &dictdata)) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(error getting model data) "), return NULL);
} else {
success = 1;
}
}
if (avp->avp_public.avp_flags & AVP_FLAG_VENDOR) {
CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "%s(%u/%u)[" DUMP_AVPFL_str "]=",
success ? dictdata.avp_name : "unknown", avp->avp_public.avp_vendor, avp->avp_public.avp_code, DUMP_AVPFL_val(avp->avp_public.avp_flags)), return NULL);