Initial commit
Change-Id: I6a4444e3c193dae437cd7929f4c39aba7b749efa
diff --git a/libfdproto/CMakeLists.txt b/libfdproto/CMakeLists.txt
new file mode 100644
index 0000000..3650719
--- /dev/null
+++ b/libfdproto/CMakeLists.txt
@@ -0,0 +1,58 @@
+# Name of the subproject
+Project("libfdproto" C)
+
+# Configuration for newer cmake
+cmake_policy(VERSION 2.6)
+if (POLICY CMP0022)
+ cmake_policy(SET CMP0022 OLD)
+endif (POLICY CMP0022)
+
+# List of source files for the library
+SET(LFDPROTO_SRC
+ fdproto-internal.h
+ dictionary.c
+ dictionary_functions.c
+ dispatch.c
+ fifo.c
+ init.c
+ lists.c
+ log.c
+ messages.c
+ ostr.c
+ portability.c
+ rt_data.c
+ sessions.c
+ utils.c
+ version.c
+ )
+
+
+# Save the list of files for testcases in the core's directory
+SET(LFDPROTO_SRC ${LFDPROTO_SRC} PARENT_SCOPE)
+
+# Include path
+INCLUDE_DIRECTORIES(${LFDPROTO_INCLUDES})
+
+# Build as a shared library
+ADD_LIBRARY(libfdproto SHARED ${LFDPROTO_SRC})
+
+ADD_DEPENDENCIES(libfdproto version_information)
+
+# Avoid the liblib name, and set the version
+SET_TARGET_PROPERTIES(libfdproto PROPERTIES
+ OUTPUT_NAME "fdproto"
+ SOVERSION ${FD_PROJECT_VERSION_API}
+ VERSION ${FD_PROJECT_VERSION_MAJOR}.${FD_PROJECT_VERSION_MINOR}.${FD_PROJECT_VERSION_REV}
+ LINK_INTERFACE_LIBRARIES "${LFDPROTO_LINK_INTERFACES}")
+
+# The library itself needs other libraries
+TARGET_LINK_LIBRARIES(libfdproto ${LFDPROTO_LIBS})
+
+
+####
+## INSTALL section ##
+
+INSTALL(TARGETS libfdproto
+ LIBRARY DESTINATION ${INSTALL_LIBRARY_SUFFIX}
+ COMPONENT freeDiameter-common)
+
diff --git a/libfdproto/dictionary.c b/libfdproto/dictionary.c
new file mode 100644
index 0000000..ff902a0
--- /dev/null
+++ b/libfdproto/dictionary.c
@@ -0,0 +1,2306 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2015, 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. *
+*********************************************************************************************************/
+
+#include "fdproto-internal.h"
+#include <inttypes.h>
+
+/* Names of the base types */
+const char * type_base_name[] = { /* must keep in sync with dict_avp_basetype */
+ "GROUPED", /* AVP_TYPE_GROUPED */
+ "OCTETSTRING", /* AVP_TYPE_OCTETSTRING */
+ "INTEGER32", /* AVP_TYPE_INTEGER32 */
+ "INTEGER64", /* AVP_TYPE_INTEGER64 */
+ "UNSIGNED32", /* AVP_TYPE_UNSIGNED32 */
+ "UNSIGNED64", /* AVP_TYPE_UNSIGNED64 */
+ "FLOAT32", /* AVP_TYPE_FLOAT32 */
+ "FLOAT64" /* AVP_TYPE_FLOAT64 */
+ };
+
+/* The number of lists in an object */
+#define NB_LISTS_PER_OBJ 3
+
+/* Some eye catchers definitions */
+#define OBJECT_EYECATCHER (0x0b13c7)
+#define DICT_EYECATCHER (0x00d1c7)
+
+/* Definition of the dictionary objects */
+struct dict_object {
+ enum dict_object_type type; /* What type of object is this? */
+ int objeyec;/* eyecatcher for this object */
+ int typeyec;/* eyecatcher for this type of object */
+ struct dictionary *dico; /* The dictionary this object belongs to */
+
+ union {
+ struct dict_vendor_data vendor; /* datastr_len = strlen(vendor_name) */
+ struct dict_application_data application; /* datastr_len = strlen(application_name) */
+ struct dict_type_data type; /* datastr_len = strlen(type_name) */
+ struct dict_enumval_data enumval; /* datastr_len = strlen(enum_name) */
+ struct dict_avp_data avp; /* datastr_len = strlen(avp_name) */
+ struct dict_cmd_data cmd; /* datastr_len = strlen(cmd_name) */
+ struct dict_rule_data rule; /* datastr_len = 0 */
+ } data; /* The data of this object */
+
+ size_t datastr_len; /* cached length of the string inside the data. Saved when the object is created. */
+
+ struct dict_object * parent; /* The parent of this object, if any */
+
+ struct fd_list list[NB_LISTS_PER_OBJ];/* used to chain objects.*/
+ /* More information about the lists :
+
+ - the use for each list depends on the type of object. See detail below.
+
+ - a sentinel for a list has its 'o' field cleared. (this is the criteria to detect end of a loop)
+
+ - The lists are always ordered. The criteria are described below. the functions to order them are referenced in dict_obj_info
+
+ - The dict_lock must be held for any list operation.
+
+ => VENDORS:
+ list[0]: list of the vendors, ordered by their id. The sentinel is g_dict_vendors (vendor with id 0)
+ list[1]: sentinel for the list of AVPs from this vendor, ordered by AVP code.
+ list[2]: sentinel for the list of AVPs from this vendor, ordered by AVP name (fd_os_cmp).
+
+ => APPLICATIONS:
+ list[0]: list of the applications, ordered by their id. The sentinel is g_dict_applications (application with id 0)
+ list[1]: not used
+ list[2]: not used.
+
+ => TYPES:
+ list[0]: list of the types, ordered by their names. The sentinel is g_list_types.
+ list[1]: sentinel for the type_enum list of this type, ordered by their constant name (fd_os_cmp).
+ list[2]: sentinel for the type_enum list of this type, ordered by their constant value.
+
+ => TYPE_ENUMS:
+ list[0]: list of the contants for a given type, ordered by the constant name (fd_os_cmp). Sentinel is a (list[1]) element of a TYPE object.
+ list[1]: list of the contants for a given type, ordered by the constant value. Sentinel is a (list[2]) element of a TYPE object.
+ list[2]: not used
+
+ => AVPS:
+ list[0]: list of the AVP from a given vendor, ordered by avp code. Sentinel is a list[1] element of a VENDOR object.
+ list[1]: list of the AVP from a given vendor, ordered by avp name (fd_os_cmp). Sentinel is a list[2] element of a VENDOR object.
+ list[2]: sentinel for the rule list that apply to this AVP.
+
+ => COMMANDS:
+ list[0]: list of the commands, ordered by their names (fd_os_cmp). The sentinel is g_list_cmd_name.
+ list[1]: list of the commands, ordered by their command code and 'R' flag. The sentinel is g_list_cmd_code.
+ list[2]: sentinel for the rule list that apply to this command.
+
+ => RULES:
+ list[0]: list of the rules for a given (grouped) AVP or Command, ordered by the AVP vendor & code to which they refer. sentinel is list[2] of a command or (grouped) avp.
+ list[1]: not used
+ list[2]: not used.
+
+ */
+
+ /* Sentinel for the dispatch callbacks */
+ struct fd_list disp_cbs;
+
+};
+
+/* Definition of the dictionary structure */
+struct dictionary {
+ int dict_eyec; /* Eye-catcher for the dictionary (DICT_EYECATCHER) */
+
+ pthread_rwlock_t dict_lock; /* The global rwlock for the dictionary */
+
+ struct dict_object dict_vendors; /* Sentinel for the list of vendors, corresponding to vendor 0 */
+ struct dict_object dict_applications; /* Sentinel for the list of applications, corresponding to app 0 */
+ struct fd_list dict_types; /* Sentinel for the list of types */
+ struct fd_list dict_cmd_name; /* Sentinel for the list of commands, ordered by names */
+ struct fd_list dict_cmd_code; /* Sentinel for the list of commands, ordered by codes */
+
+ struct dict_object dict_cmd_error; /* Special command object for answers with the 'E' bit set */
+
+ int dict_count[DICT_TYPE_MAX + 1]; /* Number of objects of each type */
+};
+
+/* Forward declarations of dump functions */
+static DECLARE_FD_DUMP_PROTOTYPE(dump_vendor_data, void * data );
+static DECLARE_FD_DUMP_PROTOTYPE(dump_application_data, void * data );
+static DECLARE_FD_DUMP_PROTOTYPE(dump_type_data, void * data );
+ /* the dump function for enum has a different prototype since it need the datatype */
+static DECLARE_FD_DUMP_PROTOTYPE(dump_avp_data, void * data );
+static DECLARE_FD_DUMP_PROTOTYPE(dump_command_data, void * data );
+static DECLARE_FD_DUMP_PROTOTYPE(dump_rule_data, void * data );
+
+/* Forward declarations of search functions */
+static int search_vendor ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result );
+static int search_application ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result );
+static int search_type ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result );
+static int search_enumval ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result );
+static int search_avp ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result );
+static int search_cmd ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result );
+static int search_rule ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result );
+
+/* The following array contains lot of data about the different types of objects, for automated handling */
+static struct {
+ enum dict_object_type type; /* information for this type */
+ char * name; /* string describing this object, for debug */
+ size_t datasize; /* The size of the data structure */
+ int parent; /* 0: never; 1: may; 2: must */
+ enum dict_object_type parenttype; /* The type of the parent, when relevant */
+ int eyecatcher; /* A kind of signature for this object */
+ DECLARE_FD_DUMP_PROTOTYPE( (*dump_data), void * data ); /* The function to dump the data section */
+ int (*search_fct)(struct dictionary * dict, int criteria, const void * what, struct dict_object **result );; /* The function to search an object of this type */
+ int haslist[NB_LISTS_PER_OBJ]; /* Tell if this list is used */
+} dict_obj_info[] = { { 0, "(error)", 0, 0, 0, 0, NULL, NULL, {0, 0, 0} }
+
+ /* type name datasize parent parenttype
+ eyecatcher dump_data search_fct, haslist[] */
+
+ ,{ DICT_VENDOR, "VENDOR", sizeof(struct dict_vendor_data), 0, 0,
+ OBJECT_EYECATCHER + 1, dump_vendor_data, search_vendor, { 1, 0, 0 } }
+
+ ,{ DICT_APPLICATION, "APPLICATION", sizeof(struct dict_application_data), 1, DICT_VENDOR,
+ OBJECT_EYECATCHER + 2, dump_application_data, search_application, { 1, 0, 0 } }
+
+ ,{ DICT_TYPE, "TYPE", sizeof(struct dict_type_data), 1, DICT_APPLICATION,
+ OBJECT_EYECATCHER + 3, dump_type_data, search_type, { 1, 0, 0 } }
+
+ ,{ DICT_ENUMVAL, "ENUMVAL", sizeof(struct dict_enumval_data), 2, DICT_TYPE,
+ OBJECT_EYECATCHER + 4, NULL, search_enumval, { 1, 1, 0 } }
+
+ ,{ DICT_AVP, "AVP", sizeof(struct dict_avp_data), 1, DICT_TYPE,
+ OBJECT_EYECATCHER + 5, dump_avp_data, search_avp, { 1, 1, 0 } }
+
+ ,{ DICT_COMMAND, "COMMAND", sizeof(struct dict_cmd_data), 1, DICT_APPLICATION,
+ OBJECT_EYECATCHER + 6, dump_command_data, search_cmd, { 1, 1, 0 } }
+
+ ,{ DICT_RULE, "RULE", sizeof(struct dict_rule_data), 2, -1 /* special case: grouped avp or command */,
+ OBJECT_EYECATCHER + 7, dump_rule_data, search_rule, { 1, 0, 0 } }
+
+};
+
+/* Macro to verify a "type" value */
+#define CHECK_TYPE( type ) ( ((type) > 0) && ((type) <= DICT_TYPE_MAX) )
+
+/* Cast macro */
+#define _O( object ) ((struct dict_object *) (object))
+
+/* Get information line for a given object */
+#define _OBINFO(object) (dict_obj_info[CHECK_TYPE(_O(object)->type) ? _O(object)->type : 0])
+
+
+
+
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+/* */
+/* Objects management */
+/* */
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+
+/* Functions to manage the objects creation and destruction. */
+
+/* Duplicate a string inplace, save its length */
+#define DUP_string_len( str, plen ) { \
+ *(plen) = strlen((str)); \
+ str = os0dup( str, *(plen)); \
+}
+
+/* Initialize an object */
+static void init_object( struct dict_object * obj, enum dict_object_type type )
+{
+ int i;
+
+ TRACE_ENTRY("%p %d", obj, type);
+
+ /* Clean the object first */
+ memset ( obj, 0, sizeof(struct dict_object));
+
+ CHECK_PARAMS_DO( CHECK_TYPE(type), return );
+
+ obj->type = type;
+ obj->objeyec = OBJECT_EYECATCHER;
+ obj->typeyec = _OBINFO(obj).eyecatcher;
+
+ /* We don't initialize the data nor the parent here */
+
+ /* Now init the lists */
+ for (i=0; i<NB_LISTS_PER_OBJ; i++) {
+ if (_OBINFO(obj).haslist[i] != 0)
+ fd_list_init(&obj->list[i], obj);
+ else
+ fd_list_init(&obj->list[i], NULL);
+ }
+
+ fd_list_init(&obj->disp_cbs, NULL);
+}
+
+/* Initialize the "data" part of an object */
+static int init_object_data(struct dict_object * dest, void * source, enum dict_object_type type, int dupos)
+{
+ TRACE_ENTRY("%p %p %d", dest, source, type);
+ CHECK_PARAMS( dest && source && CHECK_TYPE(type) );
+
+ /* Generic: copy the full data structure */
+ memcpy( &dest->data, source, dict_obj_info[type].datasize );
+
+ /* Then strings must be duplicated, not copied */
+ /* This function might be simplified by always defining the "name" field as the first field of the structures, but... it's error-prone */
+ switch (type) {
+ case DICT_VENDOR:
+ DUP_string_len( dest->data.vendor.vendor_name, &dest->datastr_len );
+ break;
+
+ case DICT_APPLICATION:
+ DUP_string_len( dest->data.application.application_name, &dest->datastr_len );
+ break;
+
+ case DICT_TYPE:
+ DUP_string_len( dest->data.type.type_name, &dest->datastr_len );
+ break;
+
+ case DICT_ENUMVAL:
+ DUP_string_len( dest->data.enumval.enum_name, &dest->datastr_len );
+ if (dupos) {
+ // we also need to duplicate the octetstring constant value since it is a pointer.
+ dest->data.enumval.enum_value.os.data = os0dup(
+ ((struct dict_enumval_data *)source)->enum_value.os.data,
+ ((struct dict_enumval_data *)source)->enum_value.os.len
+ );
+ }
+ break;
+
+ case DICT_AVP:
+ DUP_string_len( dest->data.avp.avp_name, &dest->datastr_len );
+ break;
+
+ case DICT_COMMAND:
+ DUP_string_len( dest->data.cmd.cmd_name, &dest->datastr_len );
+ break;
+
+ default:
+ /* Nothing to do for RULES */
+ ;
+ }
+
+ return 0;
+}
+
+/* Check that an object is valid (1: OK, 0: error) */
+static int verify_object( struct dict_object * obj )
+{
+ TRACE_ENTRY("%p", obj);
+
+ CHECK_PARAMS_DO( obj
+ && (obj->objeyec == OBJECT_EYECATCHER)
+ && CHECK_TYPE(obj->type)
+ && (obj->typeyec == dict_obj_info[obj->type].eyecatcher),
+ {
+ if (obj) {
+ TRACE_DEBUG(FULL, "Invalid object: %p, obj->objeyec: %x/%x, obj->type: %d, obj->objeyec: %x/%x, obj->typeyec: %x/%x",
+ obj,
+ obj->objeyec, OBJECT_EYECATCHER,
+ obj->type,
+ obj->objeyec, OBJECT_EYECATCHER,
+ obj->typeyec, _OBINFO(obj).eyecatcher);
+ } else {
+ TRACE_DEBUG(FULL, "Invalid object : NULL pointer");
+ }
+ return 0;
+ } );
+
+ /* The object is probably valid. */
+ return 1;
+}
+
+/* Free the data associated to an object */
+static void destroy_object_data(struct dict_object * obj)
+{
+ /* TRACE_ENTRY("%p", obj); */
+
+ switch (obj->type) {
+ case DICT_VENDOR:
+ free( obj->data.vendor.vendor_name );
+ break;
+
+ case DICT_APPLICATION:
+ free( obj->data.application.application_name );
+ break;
+
+ case DICT_TYPE:
+ free( obj->data.type.type_name );
+ break;
+
+ case DICT_ENUMVAL:
+ free( obj->data.enumval.enum_name );
+ break;
+
+ case DICT_AVP:
+ free( obj->data.avp.avp_name );
+ break;
+
+ case DICT_COMMAND:
+ free( obj->data.cmd.cmd_name );
+ break;
+
+ default:
+ /* nothing to do */
+ ;
+ }
+}
+
+/* Forward declaration */
+static void destroy_object(struct dict_object * obj);
+
+/* Destroy all objects in a list - the lock must be held */
+static void destroy_list(struct fd_list * head)
+{
+ /* TRACE_ENTRY("%p", head); */
+
+ /* loop in the list */
+ while (!FD_IS_LIST_EMPTY(head))
+ {
+ /* When destroying the object, it is unlinked from the list */
+ destroy_object(_O(head->next->o));
+ }
+}
+
+/* Free an object and its sublists */
+static void destroy_object(struct dict_object * obj)
+{
+ int i;
+
+ /* TRACE_ENTRY("%p", obj); */
+
+ /* Update global count */
+ if (obj->dico)
+ obj->dico->dict_count[obj->type]--;
+
+ /* Mark the object as invalid */
+ obj->objeyec = 0xdead;
+
+ /* First, destroy the data associated to the object */
+ destroy_object_data(obj);
+
+ for (i=0; i<NB_LISTS_PER_OBJ; i++) {
+ if (_OBINFO(obj).haslist[i])
+ /* unlink the element from the list */
+ fd_list_unlink( &obj->list[i] );
+ else
+ /* This is either a sentinel or unused (=emtpy) list, let's destroy it */
+ destroy_list( &obj->list[i] );
+ }
+
+ /* Unlink all elements from the dispatch list; they will be freed when callback is unregistered */
+ CHECK_POSIX_DO( pthread_rwlock_wrlock(&fd_disp_lock), /* continue */ );
+ while (!FD_IS_LIST_EMPTY(&obj->disp_cbs)) {
+ fd_list_unlink( obj->disp_cbs.next );
+ }
+ CHECK_POSIX_DO( pthread_rwlock_unlock(&fd_disp_lock), /* continue */ );
+
+ /* Last, destroy the object */
+ free(obj);
+}
+
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+/* */
+/* Compare functions */
+/* */
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+
+/* Compare two values */
+#define ORDER_scalar( i1, i2 ) \
+ ((i1 < i2 ) ? -1 : ( i1 > i2 ? 1 : 0 ))
+
+
+/* Compare two vendor objects by their id (checks already performed) */
+static int order_vendor_by_id ( struct dict_object *o1, struct dict_object *o2 )
+{
+ TRACE_ENTRY("%p %p", o1, o2);
+
+ return ORDER_scalar( o1->data.vendor.vendor_id, o2->data.vendor.vendor_id );
+}
+
+/* Compare two application objects by their id (checks already performed) */
+static int order_appli_by_id ( struct dict_object *o1, struct dict_object *o2 )
+{
+ TRACE_ENTRY("%p %p", o1, o2);
+
+ return ORDER_scalar( o1->data.application.application_id, o2->data.application.application_id );
+}
+
+/* Compare two type objects by their name (checks already performed) */
+static int order_type_by_name ( struct dict_object *o1, struct dict_object *o2 )
+{
+ TRACE_ENTRY("%p %p", o1, o2);
+
+ return fd_os_cmp( o1->data.type.type_name, o1->datastr_len, o2->data.type.type_name, o2->datastr_len );
+}
+
+/* Compare two type_enum objects by their names (checks already performed) */
+static int order_enum_by_name ( struct dict_object *o1, struct dict_object *o2 )
+{
+ TRACE_ENTRY("%p %p", o1, o2);
+
+ return fd_os_cmp( o1->data.enumval.enum_name, o1->datastr_len, o2->data.enumval.enum_name, o2->datastr_len );
+}
+
+/* Compare two type_enum objects by their values (checks already performed) */
+static int order_enum_by_val ( struct dict_object *o1, struct dict_object *o2 )
+{
+ TRACE_ENTRY("%p %p", o1, o2);
+
+ /* The comparison function depends on the type of data */
+ switch ( o1->parent->data.type.type_base ) {
+ case AVP_TYPE_OCTETSTRING:
+ return fd_os_cmp( o1->data.enumval.enum_value.os.data, o1->data.enumval.enum_value.os.len,
+ o2->data.enumval.enum_value.os.data, o2->data.enumval.enum_value.os.len);
+
+ case AVP_TYPE_INTEGER32:
+ return ORDER_scalar( o1->data.enumval.enum_value.i32, o2->data.enumval.enum_value.i32 );
+
+ case AVP_TYPE_INTEGER64:
+ return ORDER_scalar( o1->data.enumval.enum_value.i64, o2->data.enumval.enum_value.i64 );
+
+ case AVP_TYPE_UNSIGNED32:
+ return ORDER_scalar( o1->data.enumval.enum_value.u32, o2->data.enumval.enum_value.u32 );
+
+ case AVP_TYPE_UNSIGNED64:
+ return ORDER_scalar( o1->data.enumval.enum_value.u64, o2->data.enumval.enum_value.u64 );
+
+ case AVP_TYPE_FLOAT32:
+ return ORDER_scalar( o1->data.enumval.enum_value.f32, o2->data.enumval.enum_value.f32 );
+
+ case AVP_TYPE_FLOAT64:
+ return ORDER_scalar( o1->data.enumval.enum_value.f64, o2->data.enumval.enum_value.f64 );
+
+ case AVP_TYPE_GROUPED:
+ default:
+ ASSERT(0);
+ }
+ return 0;
+}
+
+/* Compare two avp objects by their codes (checks already performed) */
+static int order_avp_by_code ( struct dict_object *o1, struct dict_object *o2 )
+{
+ TRACE_ENTRY("%p %p", o1, o2);
+
+ return ORDER_scalar( o1->data.avp.avp_code, o2->data.avp.avp_code );
+}
+
+/* Compare two avp objects by their names (checks already performed) */
+static int order_avp_by_name ( struct dict_object *o1, struct dict_object *o2 )
+{
+ TRACE_ENTRY("%p %p", o1, o2);
+
+ return fd_os_cmp( o1->data.avp.avp_name, o1->datastr_len, o2->data.avp.avp_name, o2->datastr_len );
+}
+
+/* Compare two command objects by their names (checks already performed) */
+static int order_cmd_by_name ( struct dict_object *o1, struct dict_object *o2 )
+{
+ TRACE_ENTRY("%p %p", o1, o2);
+
+ return fd_os_cmp( o1->data.cmd.cmd_name, o1->datastr_len, o2->data.cmd.cmd_name, o2->datastr_len );
+}
+
+/* Compare two command objects by their codes and flags (request or answer) (checks already performed) */
+static int order_cmd_by_codefl( struct dict_object *o1, struct dict_object *o2 )
+{
+ uint8_t fl1, fl2;
+ int cmp = 0;
+
+ TRACE_ENTRY("%p %p", o1, o2);
+
+ cmp = ORDER_scalar( o1->data.cmd.cmd_code, o2->data.cmd.cmd_code );
+ if (cmp)
+ return cmp;
+
+ /* Same command code, we must compare the value of the 'R' flag */
+ fl1 = o1->data.cmd.cmd_flag_val & CMD_FLAG_REQUEST;
+ fl2 = o2->data.cmd.cmd_flag_val & CMD_FLAG_REQUEST;
+
+ /* We want requests first, so we reverse the operators here */
+ return ORDER_scalar(fl2, fl1);
+
+}
+
+/* Compare two rule object by the AVP vendor & code that they refer (checks already performed) */
+static int order_rule_by_avpvc ( struct dict_object *o1, struct dict_object *o2 )
+{
+ TRACE_ENTRY("%p %p", o1, o2);
+
+ return ORDER_scalar(o1->data.rule.rule_avp->data.avp.avp_vendor, o2->data.rule.rule_avp->data.avp.avp_vendor)
+ ?: ORDER_scalar(o1->data.rule.rule_avp->data.avp.avp_code, o2->data.rule.rule_avp->data.avp.avp_code) ;
+}
+
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+/* */
+/* Search functions */
+/* */
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+
+/* Functions used to search for objects in the lists, according to some criteria */
+
+/* On a general note, if result is not NULL, ENOENT is not returned but *result is NULL. */
+
+/* The following macros assume that "what", "ret", "result" (variables), and "end" (label) exist
+in the local context where they are called. They are meant to be called only from the functions that follow. */
+
+/* For searchs of type "xxx_OF_xxx": children's parent or default parent */
+#define SEARCH_childs_parent( type_of_child, default_parent ) { \
+ struct dict_object *__child = (struct dict_object *) what; \
+ CHECK_PARAMS_DO( verify_object(__child) && \
+ (__child->type == (type_of_child)), \
+ { ret = EINVAL; goto end; } ); \
+ ret = 0; \
+ if (result) \
+ *result = (__child->parent ? __child->parent :(default_parent));\
+}
+
+/* For search of strings in lists. isindex= 1 if the string is the ordering key of the list */
+/* it is expected that object->datastr_len is the length of the datafield parameter */
+#define SEARCH_os0_l( str, len, sentinel, datafield, isindex ) { \
+ char * __str = (char *) (str); \
+ size_t __strlen = (size_t)(len); \
+ int __cmp; \
+ struct fd_list * __li; \
+ ret = 0; \
+ for (__li = (sentinel)->next; __li != (sentinel); __li = __li->next) { \
+ __cmp = fd_os_cmp(__str, __strlen, \
+ _O(__li->o)->data. datafield, _O(__li->o)->datastr_len);\
+ if (__cmp == 0) { \
+ if (result) \
+ *result = _O(__li->o); \
+ goto end; \
+ } \
+ if ((isindex) && (__cmp < 0)) \
+ break; \
+ } \
+ if (result) \
+ *result = NULL; \
+ else \
+ ret = ENOENT; \
+}
+
+/* When len is not provided */
+#define SEARCH_os0( str, sentinel, datafield, isindex ) { \
+ char * _str = (char *) (str); \
+ size_t _strlen = strlen(_str); \
+ SEARCH_os0_l( _str, _strlen, sentinel, datafield, isindex ); \
+}
+
+
+/* For search of octetstrings in lists. */
+#define SEARCH_os( str, strlen, sentinel, osdatafield, isindex ) { \
+ uint8_t * __str = (uint8_t *) (str); \
+ size_t __strlen = (size_t)(strlen); \
+ int __cmp; \
+ struct fd_list * __li; \
+ ret = 0; \
+ for (__li = (sentinel)->next; __li != (sentinel); __li = __li->next) { \
+ __cmp = fd_os_cmp(__str, __strlen, \
+ _O(__li->o)->data. osdatafield .data, \
+ _O(__li->o)->data. osdatafield .len); \
+ if (__cmp == 0) { \
+ if (result) \
+ *result = _O(__li->o); \
+ goto end; \
+ } \
+ if ((isindex) && (__cmp < 0)) \
+ break; \
+ } \
+ if (result) \
+ *result = NULL; \
+ else \
+ ret = ENOENT; \
+}
+
+/* For search of AVP name in rule lists -- the list is not ordered by AVP names! */
+#define SEARCH_ruleavpname( str, strlen, sentinel ) { \
+ char * __str = (char *) (str); \
+ size_t __strlen = (size_t) (strlen); \
+ int __cmp; \
+ struct fd_list * __li; \
+ ret = 0; \
+ for (__li = (sentinel)->next; __li != (sentinel); __li = __li->next) { \
+ __cmp = fd_os_cmp(__str, __strlen, \
+ _O(__li->o)->data.rule.rule_avp->data.avp.avp_name, \
+ _O(__li->o)->data.rule.rule_avp->datastr_len); \
+ if (__cmp == 0) { \
+ if (result) \
+ *result = _O(__li->o); \
+ goto end; \
+ } \
+ } \
+ if (result) \
+ *result = NULL; \
+ else \
+ ret = ENOENT; \
+}
+
+/* For search of scalars in lists. isindex= 1 if the value is the ordering key of the list */
+#define SEARCH_scalar( value, sentinel, datafield, isindex, defaultobj ) { \
+ int __cmp; \
+ struct fd_list * __li; \
+ ret = 0; \
+ if ( ((defaultobj) != NULL) \
+ && (_O(defaultobj)->data. datafield == value)) { \
+ if (result) \
+ *result = _O(defaultobj); \
+ goto end; \
+ } \
+ for (__li = (sentinel)->next; __li != (sentinel); __li = __li->next) { \
+ __cmp= ORDER_scalar(value, _O(__li->o)->data. datafield ); \
+ if (__cmp == 0) { \
+ if (result) \
+ *result = _O(__li->o); \
+ goto end; \
+ } \
+ if ((isindex) && (__cmp < 0)) \
+ break; \
+ } \
+ if (result) \
+ *result = NULL; \
+ else \
+ ret = ENOENT; \
+}
+
+/* For search of commands in lists by code and flag. R_flag_val = 0 or CMD_FLAG_REQUEST */
+#define SEARCH_codefl( value, R_flag_val, sentinel) { \
+ int __cmp; \
+ struct fd_list * __li; \
+ ret = 0; \
+ for (__li = (sentinel)->next; __li != (sentinel); __li = __li->next) { \
+ __cmp = ORDER_scalar(value, \
+ _O(__li->o)->data.cmd.cmd_code ); \
+ if (__cmp == 0) { \
+ uint8_t __mask, __val; \
+ __mask = _O(__li->o)->data.cmd.cmd_flag_mask; \
+ __val = _O(__li->o)->data.cmd.cmd_flag_val; \
+ if ( ! (__mask & CMD_FLAG_REQUEST) ) \
+ continue; \
+ if ( ( __val & CMD_FLAG_REQUEST ) != R_flag_val ) \
+ continue; \
+ if (result) \
+ *result = _O(__li->o); \
+ goto end; \
+ } \
+ if (__cmp < 0) \
+ break; \
+ } \
+ if (result) \
+ *result = NULL; \
+ else \
+ ret = ENOENT; \
+}
+
+/* For searchs of type "xxx_OF_xxx": if the search object is sentinel list for the "what" object */
+#define SEARCH_sentinel( type_of_what, what_list_nr, sentinel_list_nr ) { \
+ struct dict_object *__what = (struct dict_object *) what; \
+ CHECK_PARAMS_DO( verify_object(__what) && \
+ (__what->type == (type_of_what)), \
+ { ret = EINVAL; goto end; } ); \
+ ret = 0; \
+ if (result) { \
+ /* this is similar to the "container_of" */ \
+ *result = (struct dict_object *)((char *)(__what->list[what_list_nr].head) - \
+ (size_t)&(((struct dict_object *)0)->list[sentinel_list_nr])); \
+ } \
+}
+
+
+static int search_vendor ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result )
+{
+ int ret = 0;
+ vendor_id_t id;
+
+ TRACE_ENTRY("%p %d %p %p", dict, criteria, what, result);
+
+ switch (criteria) {
+ case VENDOR_BY_ID:
+ id = *(vendor_id_t *) what;
+ SEARCH_scalar( id, &dict->dict_vendors.list[0], vendor.vendor_id, 1, &dict->dict_vendors );
+ break;
+
+ case VENDOR_BY_NAME:
+ /* "what" is a vendor name */
+ SEARCH_os0( what, &dict->dict_vendors.list[0], vendor.vendor_name, 0);
+ break;
+
+ case VENDOR_OF_APPLICATION:
+ /* "what" should be an application object */
+ SEARCH_childs_parent( DICT_APPLICATION, &dict->dict_vendors );
+ break;
+
+ case VENDOR_OF_AVP:
+ /* "what" should be an avp object */
+ SEARCH_sentinel( DICT_AVP, 0, 1 );
+ break;
+
+ default:
+ /* Invalid criteria */
+ CHECK_PARAMS( criteria = 0 );
+ }
+end:
+ return ret;
+}
+
+static int search_application ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result )
+{
+ int ret = 0;
+ application_id_t id;
+
+ TRACE_ENTRY("%p %d %p %p", dict, criteria, what, result);
+
+ switch (criteria) {
+ case APPLICATION_BY_ID:
+ id = *(application_id_t *) what;
+
+ SEARCH_scalar( id, &dict->dict_applications.list[0], application.application_id, 1, &dict->dict_applications );
+ break;
+
+ case APPLICATION_BY_NAME:
+ /* "what" is an application name */
+ SEARCH_os0( what, &dict->dict_applications.list[0], application.application_name, 0);
+ break;
+
+ case APPLICATION_OF_TYPE:
+ /* "what" should be a type object */
+ SEARCH_childs_parent( DICT_TYPE, &dict->dict_applications );
+ break;
+
+ case APPLICATION_OF_COMMAND:
+ /* "what" should be a command object */
+ SEARCH_childs_parent( DICT_COMMAND, &dict->dict_applications );
+ break;
+
+ default:
+ /* Invalid criteria */
+ CHECK_PARAMS( criteria = 0 );
+ }
+end:
+ return ret;
+}
+
+static int search_type ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result )
+{
+ int ret = 0;
+
+ TRACE_ENTRY("%p %d %p %p", dict, criteria, what, result);
+
+ switch (criteria) {
+ case TYPE_BY_NAME:
+ /* "what" is a type name */
+ SEARCH_os0( what, &dict->dict_types, type.type_name, 1);
+ break;
+
+ case TYPE_OF_ENUMVAL:
+ /* "what" should be a type_enum object */
+ SEARCH_childs_parent( DICT_ENUMVAL, NULL );
+ break;
+
+ case TYPE_OF_AVP:
+ /* "what" should be an avp object */
+ SEARCH_childs_parent( DICT_AVP, NULL );
+ break;
+
+
+ default:
+ /* Invalid criteria */
+ CHECK_PARAMS( criteria = 0 );
+ }
+end:
+ return ret;
+}
+
+static int search_enumval ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result )
+{
+ int ret = 0;
+
+ TRACE_ENTRY("%p %d %p %p", dict, criteria, what, result);
+
+ switch (criteria) {
+ case ENUMVAL_BY_STRUCT:
+ {
+ struct dict_object * parent = NULL;
+ struct dict_enumval_request * _what = (struct dict_enumval_request *) what;
+
+ CHECK_PARAMS( _what && ( _what->type_obj || _what->type_name ) );
+
+ if (_what->type_obj != NULL) {
+ parent = _what->type_obj;
+ CHECK_PARAMS( verify_object(parent) && (parent->type == DICT_TYPE) );
+ } else {
+ /* We received only the type name, we must find it first */
+ CHECK_FCT_DO( search_type( dict, TYPE_BY_NAME, _what->type_name, &parent ),
+ CHECK_PARAMS( 0 ) );
+ }
+
+ /* From here the "parent" object is valid */
+
+ if ( _what->search.enum_name != NULL ) {
+ /* We are looking for this string */
+ SEARCH_os0( _what->search.enum_name, &parent->list[1], enumval.enum_name, 1 );
+ } else {
+ /* We are looking for the value in enum_value */
+ switch (parent->data.type.type_base) {
+ case AVP_TYPE_OCTETSTRING:
+ SEARCH_os( _what->search.enum_value.os.data,
+ _what->search.enum_value.os.len,
+ &parent->list[2],
+ enumval.enum_value.os ,
+ 1 );
+ break;
+
+ case AVP_TYPE_INTEGER32:
+ SEARCH_scalar( _what->search.enum_value.i32,
+ &parent->list[2],
+ enumval.enum_value.i32,
+ 1,
+ (struct dict_object *)NULL);
+ break;
+
+ case AVP_TYPE_INTEGER64:
+ SEARCH_scalar( _what->search.enum_value.i64,
+ &parent->list[2],
+ enumval.enum_value.i64,
+ 1,
+ (struct dict_object *)NULL);
+ break;
+
+ case AVP_TYPE_UNSIGNED32:
+ SEARCH_scalar( _what->search.enum_value.u32,
+ &parent->list[2],
+ enumval.enum_value.u32,
+ 1,
+ (struct dict_object *)NULL);
+ break;
+
+ case AVP_TYPE_UNSIGNED64:
+ SEARCH_scalar( _what->search.enum_value.u64,
+ &parent->list[2],
+ enumval.enum_value.u64,
+ 1,
+ (struct dict_object *)NULL);
+ break;
+
+ case AVP_TYPE_FLOAT32:
+ SEARCH_scalar( _what->search.enum_value.f32,
+ &parent->list[2],
+ enumval.enum_value.f32,
+ 1,
+ (struct dict_object *)NULL);
+ break;
+
+ case AVP_TYPE_FLOAT64:
+ SEARCH_scalar( _what->search.enum_value.f64,
+ &parent->list[2],
+ enumval.enum_value.f64,
+ 1,
+ (struct dict_object *)NULL);
+ break;
+
+ default:
+ /* Invalid parent type basetype */
+ CHECK_PARAMS( parent = NULL );
+ }
+ }
+
+ }
+ break;
+
+
+ default:
+ /* Invalid criteria */
+ CHECK_PARAMS( criteria = 0 );
+ }
+end:
+ return ret;
+}
+
+static int search_avp ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result )
+{
+ int ret = 0;
+
+ TRACE_ENTRY("%p %d %p %p", dict, criteria, what, result);
+
+ switch (criteria) {
+ case AVP_BY_CODE:
+ {
+ avp_code_t code;
+ code = *(avp_code_t *) what;
+
+ SEARCH_scalar( code, &dict->dict_vendors.list[1], avp.avp_code, 1, (struct dict_object *)NULL );
+ }
+ break;
+
+ case AVP_BY_NAME:
+ /* "what" is the AVP name, vendor 0 */
+ SEARCH_os0( what, &dict->dict_vendors.list[2], avp.avp_name, 1);
+ break;
+
+ case AVP_BY_CODE_AND_VENDOR:
+ case AVP_BY_NAME_AND_VENDOR:
+ {
+ struct dict_avp_request * _what = (struct dict_avp_request *) what;
+ struct dict_object * vendor = NULL;
+
+ CHECK_PARAMS( (criteria != AVP_BY_NAME_AND_VENDOR) || _what->avp_name );
+
+ /* Now look for the vendor first */
+ CHECK_FCT( search_vendor( dict, VENDOR_BY_ID, &_what->avp_vendor, &vendor ) );
+ if (vendor == NULL) {
+ if (result)
+ *result = NULL;
+ else
+ ret = ENOENT;
+ goto end;
+ }
+
+ /* We now have our vendor = head of the appropriate avp list */
+ if (criteria == AVP_BY_NAME_AND_VENDOR) {
+ SEARCH_os0( _what->avp_name, &vendor->list[2], avp.avp_name, 1);
+ } else {
+ /* AVP_BY_CODE_AND_VENDOR */
+ SEARCH_scalar( _what->avp_code, &vendor->list[1], avp.avp_code, 1, (struct dict_object *)NULL );
+ }
+ }
+ break;
+
+ case AVP_BY_STRUCT:
+ {
+ struct dict_avp_request_ex * _what = (struct dict_avp_request_ex *) what;
+ struct dict_object * vendor = NULL;
+
+ CHECK_PARAMS( _what->avp_vendor.vendor || _what->avp_vendor.vendor_id || _what->avp_vendor.vendor_name );
+ CHECK_PARAMS( _what->avp_data.avp_code || _what->avp_data.avp_name );
+
+ /* Now look for the vendor first */
+ if (_what->avp_vendor.vendor) {
+ CHECK_PARAMS( ! _what->avp_vendor.vendor_id && ! _what->avp_vendor.vendor_name );
+ vendor = _what->avp_vendor.vendor;
+ } else if (_what->avp_vendor.vendor_id) {
+ CHECK_PARAMS( ! _what->avp_vendor.vendor_name );
+ CHECK_FCT( search_vendor( dict, VENDOR_BY_ID, &_what->avp_vendor.vendor_id, &vendor ) );
+ } else {
+ CHECK_FCT( search_vendor( dict, VENDOR_BY_NAME, _what->avp_vendor.vendor_name, &vendor ) );
+ }
+
+ if (vendor == NULL) {
+ if (result)
+ *result = NULL;
+ else
+ ret = ENOENT;
+ goto end;
+ }
+
+ /* We now have our vendor = head of the appropriate avp list */
+ if (_what->avp_data.avp_code) {
+ CHECK_PARAMS( ! _what->avp_data.avp_name );
+ SEARCH_scalar( _what->avp_data.avp_code, &vendor->list[1], avp.avp_code, 1, (struct dict_object *)NULL );
+ } else {
+ SEARCH_os0( _what->avp_data.avp_name, &vendor->list[2], avp.avp_name, 1);
+ }
+ }
+ break;
+
+ case AVP_BY_NAME_ALL_VENDORS:
+ {
+ struct fd_list * li;
+ size_t wl = strlen((char *)what);
+
+ /* First, search for vendor 0 */
+ SEARCH_os0_l( what, wl, &dict->dict_vendors.list[2], avp.avp_name, 1);
+
+ /* If not found, loop for all vendors, until found */
+ for (li = dict->dict_vendors.list[0].next; li != &dict->dict_vendors.list[0]; li = li->next) {
+ SEARCH_os0_l( what, wl, &_O(li->o)->list[2], avp.avp_name, 1);
+ }
+ }
+ break;
+
+ default:
+ /* Invalid criteria */
+ CHECK_PARAMS( criteria = 0 );
+ }
+end:
+ return ret;
+}
+
+static int search_cmd ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result )
+{
+ int ret = 0;
+
+ TRACE_ENTRY("%p %d %p %p", dict, criteria, what, result);
+
+ switch (criteria) {
+ case CMD_BY_NAME:
+ /* "what" is a command name */
+ SEARCH_os0( what, &dict->dict_cmd_name, cmd.cmd_name, 1);
+ break;
+
+ case CMD_BY_CODE_R:
+ case CMD_BY_CODE_A:
+ {
+ command_code_t code;
+ uint8_t searchfl = 0;
+
+ /* The command code that we are searching */
+ code = *(command_code_t *) what;
+
+ /* The flag (request or answer) of the command we are searching */
+ if (criteria == CMD_BY_CODE_R) {
+ searchfl = CMD_FLAG_REQUEST;
+ }
+
+ /* perform the search */
+ SEARCH_codefl( code, searchfl, &dict->dict_cmd_code );
+ }
+ break;
+
+ case CMD_ANSWER:
+ {
+ /* "what" is a command object of type "request" */
+ struct dict_object * req = (struct dict_object *) what;
+ struct dict_object * ans = NULL;
+
+ CHECK_PARAMS( verify_object(req)
+ && (req->type == DICT_COMMAND)
+ && (req->data.cmd.cmd_flag_mask & CMD_FLAG_REQUEST)
+ && (req->data.cmd.cmd_flag_val & CMD_FLAG_REQUEST) );
+
+ /* The answer is supposed to be the next element in the list, if it exists */
+ ans = req->list[1].next->o;
+ if ( ans == NULL ) {
+ TRACE_DEBUG( FULL, "the request was the last element in the list" );
+ ret = ENOENT;
+ goto end;
+ }
+
+ /* Now check that the ans element is really the correct one */
+ if ( (ans->data.cmd.cmd_code != req->data.cmd.cmd_code)
+ || (!(ans->data.cmd.cmd_flag_mask & CMD_FLAG_REQUEST))
+ || ( ans->data.cmd.cmd_flag_val & CMD_FLAG_REQUEST ) ) {
+ TRACE_DEBUG( FULL, "the answer does not follow the request in the list" );
+ ret = ENOENT;
+ goto end;
+ }
+
+ if (result)
+ *result = ans;
+ ret = 0;
+ }
+ break;
+
+ default:
+ /* Invalid criteria */
+ CHECK_PARAMS( criteria = 0 );
+ }
+end:
+ return ret;
+}
+
+static int search_rule ( struct dictionary * dict, int criteria, const void * what, struct dict_object **result )
+{
+ int ret = 0;
+
+ TRACE_ENTRY("%p %d %p %p", dict, criteria, what, result);
+
+ switch (criteria) {
+ case RULE_BY_AVP_AND_PARENT:
+ {
+ struct dict_object * parent = NULL;
+ struct dict_object * avp = NULL;
+ struct dict_rule_request * _what = (struct dict_rule_request *) what;
+
+ CHECK_PARAMS( _what
+ && (parent = _what->rule_parent)
+ && (avp = _what->rule_avp ) );
+
+ CHECK_PARAMS( verify_object(parent)
+ && ((parent->type == DICT_COMMAND)
+ || ((parent->type == DICT_AVP) && (parent->data.avp.avp_basetype == AVP_TYPE_GROUPED))) );
+
+ CHECK_PARAMS( verify_object(avp) && (avp->type == DICT_AVP) );
+
+ /* Perform the search */
+ SEARCH_ruleavpname( avp->data.avp.avp_name, avp->datastr_len, &parent->list[2]);
+
+ }
+ break;
+
+ default:
+ /* Invalid criteria */
+ CHECK_PARAMS( criteria = 0 );
+ }
+end:
+ return ret;
+}
+
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+/* */
+/* Dump / debug functions */
+/* */
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+/* The following functions are used to debug the module, and allow to print out the content of the dictionary */
+static DECLARE_FD_DUMP_PROTOTYPE(dump_vendor_data, void * data )
+{
+ struct dict_vendor_data * vendor = (struct dict_vendor_data *)data;
+
+ return fd_dump_extend( FD_DUMP_STD_PARAMS, "data: %-6u \"%s\"", vendor->vendor_id, vendor->vendor_name);
+}
+static DECLARE_FD_DUMP_PROTOTYPE(dump_application_data, void * data )
+{
+ struct dict_application_data * appli = (struct dict_application_data *) data;
+ return fd_dump_extend( FD_DUMP_STD_PARAMS, "data: %-6u \"%s\"", appli->application_id, appli->application_name);
+}
+static DECLARE_FD_DUMP_PROTOTYPE(dump_type_data, void * data )
+{
+ struct dict_type_data * type = ( struct dict_type_data * ) data;
+
+ return fd_dump_extend( FD_DUMP_STD_PARAMS, "data: %-12s \"%s\"",
+ type_base_name[type->type_base],
+ type->type_name);
+}
+static DECLARE_FD_DUMP_PROTOTYPE(dump_enumval_data, struct dict_enumval_data * enumval, enum dict_avp_basetype type )
+{
+ const int LEN_MAX = 20;
+ CHECK_MALLOC_DO(fd_dump_extend( FD_DUMP_STD_PARAMS, "data: (%-12s) \"%s\" -> ", type_base_name[type], enumval->enum_name), return NULL);
+ switch (type) {
+ case AVP_TYPE_OCTETSTRING:
+ {
+ int i, n=LEN_MAX;
+ if (enumval->enum_value.os.len < LEN_MAX)
+ n = enumval->enum_value.os.len;
+ for (i=0; i < n; i++)
+ CHECK_MALLOC_DO(fd_dump_extend( FD_DUMP_STD_PARAMS, "0x%2hhX/'%c' ", enumval->enum_value.os.data[i], ASCII(enumval->enum_value.os.data[i])), return NULL);
+ if (n == LEN_MAX)
+ CHECK_MALLOC_DO(fd_dump_extend( FD_DUMP_STD_PARAMS, "..."), return NULL);
+ }
+ break;
+
+ case AVP_TYPE_INTEGER32:
+ CHECK_MALLOC_DO(fd_dump_extend( FD_DUMP_STD_PARAMS, "%i", enumval->enum_value.i32), return NULL);
+ break;
+
+ case AVP_TYPE_INTEGER64:
+ CHECK_MALLOC_DO(fd_dump_extend( FD_DUMP_STD_PARAMS, "%"PRId64, enumval->enum_value.i64), return NULL);
+ break;
+
+ case AVP_TYPE_UNSIGNED32:
+ CHECK_MALLOC_DO(fd_dump_extend( FD_DUMP_STD_PARAMS, "%u", enumval->enum_value.u32), return NULL);
+ break;
+
+ case AVP_TYPE_UNSIGNED64:
+ CHECK_MALLOC_DO(fd_dump_extend( FD_DUMP_STD_PARAMS, "%"PRIu64, enumval->enum_value.u64), return NULL);
+ break;
+
+ case AVP_TYPE_FLOAT32:
+ CHECK_MALLOC_DO(fd_dump_extend( FD_DUMP_STD_PARAMS, "%f", enumval->enum_value.f32), return NULL);
+ break;
+
+ case AVP_TYPE_FLOAT64:
+ CHECK_MALLOC_DO(fd_dump_extend( FD_DUMP_STD_PARAMS, "%g", enumval->enum_value.f64), return NULL);
+ break;
+
+ default:
+ CHECK_MALLOC_DO(fd_dump_extend( FD_DUMP_STD_PARAMS, "??? (ERROR unknown type %d)", type), return NULL);
+ }
+ return *buf;
+}
+static DECLARE_FD_DUMP_PROTOTYPE(dump_avp_data, void * data )
+{
+ struct dict_avp_data * avp = (struct dict_avp_data * ) data;
+ return fd_dump_extend( FD_DUMP_STD_PARAMS, "data: v/m:" DUMP_AVPFL_str "/" DUMP_AVPFL_str ", %12s, %-6u \"%s\"",
+ DUMP_AVPFL_val(avp->avp_flag_val),
+ DUMP_AVPFL_val(avp->avp_flag_mask),
+ type_base_name[avp->avp_basetype],
+ avp->avp_code,
+ avp->avp_name );
+}
+static DECLARE_FD_DUMP_PROTOTYPE(dump_command_data, void * data )
+{
+ struct dict_cmd_data * cmd = (struct dict_cmd_data *) data;
+ return fd_dump_extend( FD_DUMP_STD_PARAMS, "data: v/m:" DUMP_CMDFL_str "/" DUMP_CMDFL_str ", %-6u \"%s\"",
+ DUMP_CMDFL_val(cmd->cmd_flag_val), DUMP_CMDFL_val(cmd->cmd_flag_mask), cmd->cmd_code, cmd->cmd_name);
+}
+static DECLARE_FD_DUMP_PROTOTYPE(dump_rule_data, void * data )
+{
+ struct dict_rule_data * rule = (struct dict_rule_data * )data;
+ return fd_dump_extend( FD_DUMP_STD_PARAMS, "data: pos:%d ord:%d m/M:%2d/%2d avp:\"%s\"",
+ rule->rule_position,
+ rule->rule_order,
+ rule->rule_min,
+ rule->rule_max,
+ rule->rule_avp->data.avp.avp_name);
+}
+
+static DECLARE_FD_DUMP_PROTOTYPE(dump_object, struct dict_object * obj, int parents, int depth, int indent );
+
+static DECLARE_FD_DUMP_PROTOTYPE(dump_list, struct fd_list * sentinel, int parents, int depth, int indent )
+{
+ struct fd_list * li = sentinel;
+ /* We don't lock here, the caller must have taken the dictionary lock for reading already */
+ if (FD_IS_LIST_EMPTY(sentinel)) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n%*s{empty list}", indent, ""), return NULL);
+ } else {
+ while (li->next != sentinel)
+ {
+ li = li->next;
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n"), return NULL);
+ CHECK_MALLOC_DO( dump_object (FD_DUMP_STD_PARAMS, _O(li->o), parents, depth, indent ), return NULL);
+ }
+ }
+ return *buf;
+}
+
+static DECLARE_FD_DUMP_PROTOTYPE(dump_object, struct dict_object * obj, int parents, int depth, int indent )
+{
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "%*s{dictobj}(@%p): ", indent, "", obj), return NULL);
+
+ if (!verify_object(obj)) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "INVALID/NULL"), return NULL);
+ return *buf;
+ }
+
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "%s p:%p ",
+ _OBINFO(obj).name,
+ obj->parent), return NULL);
+
+ if (obj->type == DICT_ENUMVAL) {
+ CHECK_MALLOC_DO( dump_enumval_data ( FD_DUMP_STD_PARAMS, &obj->data.enumval, obj->parent->data.type.type_base ), return NULL);
+ } else {
+ CHECK_MALLOC_DO( _OBINFO(obj).dump_data(FD_DUMP_STD_PARAMS, &obj->data), return NULL);
+ }
+
+ if (parents) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n%*sparent:", indent + 1, ""), return NULL);
+ CHECK_MALLOC_DO( dump_object (FD_DUMP_STD_PARAMS, obj->parent, parents-1, 0, 0 ), return NULL);
+ }
+
+ if (depth) {
+ int i;
+ for (i=0; i<NB_LISTS_PER_OBJ; i++) {
+ if ((obj->list[i].o == NULL) && (obj->list[i].next != &obj->list[i])) {
+ CHECK_MALLOC_DO( dump_list(FD_DUMP_STD_PARAMS, &obj->list[i], 0, depth - 1, indent + 2), return NULL);
+ break; /* we get duplicate information sorted by another criteria otherwise, which is not very useful */
+ }
+ }
+ }
+
+ return *buf;
+}
+
+DECLARE_FD_DUMP_PROTOTYPE(fd_dict_dump_object, struct dict_object * obj)
+{
+ FD_DUMP_HANDLE_OFFSET();
+
+ CHECK_MALLOC_DO( dump_object(FD_DUMP_STD_PARAMS, obj, 1, 2, 0), return NULL);
+
+ return *buf;
+}
+
+DECLARE_FD_DUMP_PROTOTYPE(fd_dict_dump, struct dictionary * dict)
+{
+ int i;
+ struct fd_list * li;
+
+ FD_DUMP_HANDLE_OFFSET();
+
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "{dictionary}(@%p): ", dict), return NULL);
+
+ if ((dict == NULL) || (dict->dict_eyec != DICT_EYECATCHER)) {
+ return fd_dump_extend(FD_DUMP_STD_PARAMS, "INVALID/NULL");
+ }
+
+ CHECK_POSIX_DO( pthread_rwlock_rdlock( &dict->dict_lock ), /* ignore */ );
+
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n {dict(%p) : VENDORS / AVP / RULES}\n", dict), goto error);
+ CHECK_MALLOC_DO( dump_object (FD_DUMP_STD_PARAMS, &dict->dict_vendors, 0, 3, 3 ), goto error);
+ for (li = dict->dict_vendors.list[0].next; li != &dict->dict_vendors.list[0]; li = li->next) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n"), return NULL);
+ CHECK_MALLOC_DO( dump_object (FD_DUMP_STD_PARAMS, li->o, 0, 3, 3 ), goto error);
+ }
+
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n {dict(%p) : APPLICATIONS}\n", dict), goto error);
+ CHECK_MALLOC_DO( dump_object (FD_DUMP_STD_PARAMS, &dict->dict_applications, 0, 1, 3 ), goto error);
+ for (li = dict->dict_applications.list[0].next; li != &dict->dict_applications.list[0]; li = li->next) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n"), return NULL);
+ CHECK_MALLOC_DO( dump_object (FD_DUMP_STD_PARAMS, li->o, 0, 1, 3 ), goto error);
+ }
+
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n {dict(%p) : TYPES / ENUMVAL}", dict), goto error);
+ CHECK_MALLOC_DO( dump_list(FD_DUMP_STD_PARAMS, &dict->dict_types, 0, 2, 3 ), goto error);
+
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n {dict(%p) : COMMANDS / RULES}", dict), goto error);
+ CHECK_MALLOC_DO( dump_list(FD_DUMP_STD_PARAMS, &dict->dict_cmd_code, 0, 0, 3 ), goto error);
+
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n {dict(%p) : statistics}", dict), goto error);
+ for (i=1; i<=DICT_TYPE_MAX; i++)
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n %5d: %s", dict->dict_count[i], dict_obj_info[i].name), goto error);
+
+ CHECK_POSIX_DO( pthread_rwlock_unlock( &dict->dict_lock ), /* ignore */ );
+ return *buf;
+error:
+ /* Free the rwlock */
+ CHECK_POSIX_DO( pthread_rwlock_unlock( &dict->dict_lock ), /* ignore */ );
+ return NULL;
+}
+
+/**************************** Dump AVP values ********************************/
+
+/* Default dump functions */
+static DECLARE_FD_DUMP_PROTOTYPE(dump_val_os, union avp_value * value)
+{
+ int i;
+
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "<"), return NULL);
+ for (i = 0; i < value->os.len; i++) {
+ if (i == 1024) { /* Dump only up to 1024 bytes of the buffer */
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "[...] (len=%zd)", value->os.len), return NULL);
+ break;
+ }
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "%s%02hhX", (i==0 ? "" : " "), value->os.data[i]), return NULL);
+ }
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, ">"), return NULL);
+ return *buf;
+}
+
+static DECLARE_FD_DUMP_PROTOTYPE(dump_val_i32, union avp_value * value)
+{
+ return fd_dump_extend( FD_DUMP_STD_PARAMS, "%i (0x%x)", value->i32, value->i32);
+}
+
+static DECLARE_FD_DUMP_PROTOTYPE(dump_val_i64, union avp_value * value)
+{
+ return fd_dump_extend( FD_DUMP_STD_PARAMS, "%" PRId64 " (0x%" PRIx64 ")", value->i64, value->i64);
+}
+
+static DECLARE_FD_DUMP_PROTOTYPE(dump_val_u32, union avp_value * value)
+{
+ return fd_dump_extend( FD_DUMP_STD_PARAMS, "%u (0x%x)", value->u32, value->u32);
+}
+
+static DECLARE_FD_DUMP_PROTOTYPE(dump_val_u64, union avp_value * value)
+{
+ return fd_dump_extend( FD_DUMP_STD_PARAMS, "%" PRIu64 " (0x%" PRIx64 ")", value->u64, value->u64);
+}
+
+static DECLARE_FD_DUMP_PROTOTYPE(dump_val_f32, union avp_value * value)
+{
+ return fd_dump_extend( FD_DUMP_STD_PARAMS, "%f", value->f32);
+}
+
+static DECLARE_FD_DUMP_PROTOTYPE(dump_val_f64, union avp_value * value)
+{
+ return fd_dump_extend( FD_DUMP_STD_PARAMS, "%g", value->f64);
+}
+
+/* Get the dump function for basic dict_avp_basetype */
+static DECLARE_FD_DUMP_PROTOTYPE((*get_default_dump_val_cb(enum dict_avp_basetype datatype)), union avp_value *)
+{
+ switch (datatype) {
+ case AVP_TYPE_OCTETSTRING:
+ return &dump_val_os;
+
+ case AVP_TYPE_INTEGER32:
+ return &dump_val_i32;
+
+ case AVP_TYPE_INTEGER64:
+ return &dump_val_i64;
+
+ case AVP_TYPE_UNSIGNED32:
+ return &dump_val_u32;
+
+ case AVP_TYPE_UNSIGNED64:
+ return &dump_val_u64;
+
+ case AVP_TYPE_FLOAT32:
+ return &dump_val_f32;
+
+ case AVP_TYPE_FLOAT64:
+ return &dump_val_f64;
+
+ case AVP_TYPE_GROUPED:
+ TRACE_DEBUG(FULL, "error: grouped AVP with a value!");
+ }
+ return NULL;
+}
+
+/* indent inside an object (duplicate from messages.c) */
+#define INOBJHDR "%*s "
+#define INOBJHDRVAL indent<0 ? 1 : indent, indent<0 ? "-" : "|"
+
+typedef DECLARE_FD_DUMP_PROTOTYPE((*dump_val_cb_t), union avp_value *);
+
+/* Formatter for the AVP value dump line */
+static DECLARE_FD_DUMP_PROTOTYPE(dump_avp_val, union avp_value *avp_value,
+ dump_val_cb_t def_dump_val_cb,
+ dump_val_cb_t dump_val_cb,
+ enum dict_avp_basetype datatype,
+ char * type_name,
+ char * const_name,
+ int indent,
+ int header)
+{
+ if (header) {
+ /* Header for all AVP values dumps: */
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, INOBJHDR "value ", INOBJHDRVAL), return NULL);
+
+ /* If the type is provided, write it */
+ if (type_name) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "t: '%s' ", type_name), return NULL);
+ }
+
+ /* Always give the base datatype anyway */
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(%s) ", type_base_name[datatype]), return NULL);
+
+ /* Now, the value */
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "v: "), return NULL);
+ }
+ if (const_name) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "'%s' (", const_name), return NULL);
+ }
+ if (dump_val_cb) {
+ CHECK_MALLOC_DO( (*dump_val_cb)( FD_DUMP_STD_PARAMS, avp_value), fd_dump_extend( FD_DUMP_STD_PARAMS, "(dump failed)"));
+ } else {
+ CHECK_MALLOC_DO( (*def_dump_val_cb)( FD_DUMP_STD_PARAMS, avp_value), return NULL);
+ }
+ if (const_name) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, ")"), return NULL);
+ }
+
+ /* Done! */
+ return *buf;
+}
+
+/* Dump the value of an AVP of known type into the returned str */
+DECLARE_FD_DUMP_PROTOTYPE(fd_dict_dump_avp_value, union avp_value *avp_value, struct dict_object * model, int indent, int header)
+{
+ DECLARE_FD_DUMP_PROTOTYPE((*dump_val_cb), union avp_value *avp_value) = NULL;
+ struct dict_object * type = NULL;
+ char * type_name = NULL;
+ char * const_name = NULL;
+
+ FD_DUMP_HANDLE_OFFSET();
+
+ /* Handle invalid parameters */
+ if (!avp_value) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(avp value not set)"), return NULL);
+ return *buf;
+ }
+
+ if (!model) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(model not set)"), return NULL);
+ return *buf;
+ }
+
+ if (! ( verify_object(model) && (model->type == DICT_AVP) )) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(invalid model)"), return NULL);
+ return *buf;
+ }
+
+ /* Get the type definition of this AVP */
+ type = model->parent;
+ if (type) {
+ struct dict_enumval_request request;
+ struct dict_object * enumval = NULL;
+
+ type_name = type->data.type.type_name;
+
+ /* overwrite the dump function ? */
+ if (type->data.type.type_dump)
+ dump_val_cb = type->data.type.type_dump;
+
+ /* Now check if the AVP value matches a constant */
+ memset(&request, 0, sizeof(request));
+ request.type_obj = type;
+ memcpy(&request.search.enum_value, avp_value, sizeof(union avp_value));
+ /* bypass checks */
+ if ((search_enumval( type->dico, ENUMVAL_BY_STRUCT, &request, &enumval ) == 0) && (enumval)) {
+ /* We found a constant, get its name */
+ const_name = enumval->data.enumval.enum_name;
+ }
+ }
+
+ /* And finally, dump the value */
+ CHECK_MALLOC_DO( dump_avp_val(FD_DUMP_STD_PARAMS, avp_value, get_default_dump_val_cb(model->data.avp.avp_basetype), dump_val_cb, model->data.avp.avp_basetype, type_name, const_name, indent, header), return NULL );
+ return *buf;
+}
+
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+/* */
+/* Exported functions */
+/* */
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+
+/* These are the functions exported outside libfreeDiameter. */
+
+/* Get the data associated to an object */
+int fd_dict_gettype ( struct dict_object * object, enum dict_object_type * type)
+{
+ TRACE_ENTRY("%p %p", object, type);
+
+ CHECK_PARAMS( type && verify_object(object) );
+
+ /* Copy the value and return */
+ *type = object->type;
+ return 0;
+}
+
+int fd_dict_getdict ( struct dict_object * object, struct dictionary ** dict)
+{
+ TRACE_ENTRY("%p %p", object, dict);
+
+ CHECK_PARAMS( dict && verify_object(object) );
+
+ /* Copy the value and return */
+ *dict = object->dico;
+ return 0;
+}
+
+
+/* Get the data associated to an object */
+int fd_dict_getval ( struct dict_object * object, void * val)
+{
+ TRACE_ENTRY("%p %p", object, val);
+
+ CHECK_PARAMS( val && verify_object(object) );
+
+ /* Copy the value and return */
+ memcpy(val, &object->data, _OBINFO(object).datasize);;
+ return 0;
+}
+
+/* Add a new object in the dictionary */
+int fd_dict_new ( struct dictionary * dict, enum dict_object_type type, void * data, struct dict_object * parent, struct dict_object **ref )
+{
+ int ret = 0;
+ int dupos = 0;
+ struct dict_object * new = NULL;
+ struct dict_object * vendor = NULL;
+ struct dict_object * locref = NULL;
+
+ TRACE_ENTRY("%p %d(%s) %p %p %p", dict, type, dict_obj_info[CHECK_TYPE(type) ? type : 0].name, data, parent, ref);
+
+ /* Check parameters */
+ CHECK_PARAMS( dict && (dict->dict_eyec == DICT_EYECATCHER) && CHECK_TYPE(type) && data );
+
+ /* Check the "parent" parameter */
+ switch (dict_obj_info[type].parent) {
+ case 0: /* parent is forbidden */
+ CHECK_PARAMS_DO( parent == NULL, goto error_param );
+
+ case 1: /* parent is optional */
+ if (parent == NULL)
+ break;
+
+ case 2: /* parent is mandatory */
+ CHECK_PARAMS_DO( verify_object(parent), goto error_param );
+
+ if (type == DICT_RULE ) { /* Special case : grouped AVP or Command parents are allowed */
+ CHECK_PARAMS_DO( (parent->type == DICT_COMMAND )
+ || ( (parent->type == DICT_AVP) && (parent->data.avp.avp_basetype == AVP_TYPE_GROUPED ) ), goto error_param );
+ } else {
+ CHECK_PARAMS_DO( parent->type == dict_obj_info[type].parenttype, goto error_param );
+ }
+ }
+
+ /* For AVP object, we must also check that the "vendor" referenced exists */
+ if (type == DICT_AVP) {
+ CHECK_FCT_DO( fd_dict_search( dict, DICT_VENDOR, VENDOR_BY_ID, &(((struct dict_avp_data *)data)->avp_vendor), (void*)&vendor, ENOENT ),
+ { TRACE_DEBUG(INFO, "Unable to find vendor '%d' referenced in the AVP data", ((struct dict_avp_data *)data)->avp_vendor); goto error_param; } );
+
+ /* Also check if a parent is provided, that the type are the same */
+ if (parent) {
+ CHECK_PARAMS_DO( parent->data.type.type_base == ((struct dict_avp_data *)data)->avp_basetype, goto error_param );
+ }
+ }
+
+ /* For RULE object, we must also check that the "avp" referenced exists */
+ if (type == DICT_RULE) {
+ CHECK_PARAMS_DO( verify_object(((struct dict_rule_data *)data)->rule_avp), goto error_param );
+ CHECK_PARAMS_DO( ((struct dict_rule_data *)data)->rule_avp->type == DICT_AVP, goto error_param );
+ }
+
+ /* For COMMAND object, check that the 'R' flag is fixed */
+ if (type == DICT_COMMAND) {
+ CHECK_PARAMS_DO( ((struct dict_cmd_data *)data)->cmd_flag_mask & CMD_FLAG_REQUEST, goto error_param );
+ }
+
+ /* For ENUMVAL object, check if the parent type is an OctetString */
+ if (type == DICT_ENUMVAL) {
+ if (parent->data.type.type_base == AVP_TYPE_OCTETSTRING)
+ dupos = 1;
+ }
+
+ /* We have to check that the new values are not equal to the sentinels */
+ if (type == DICT_VENDOR) {
+ CHECK_PARAMS_DO( ((struct dict_vendor_data *)data)->vendor_id != 0, goto error_param );
+ }
+ if (type == DICT_APPLICATION) {
+ CHECK_PARAMS_DO( ((struct dict_application_data *)data)->application_id != 0, goto error_param );
+ }
+
+ /* Parameters are valid, create the new object */
+ CHECK_MALLOC( new = malloc(sizeof(struct dict_object)) );
+
+ /* Initialize the data of the new object */
+ init_object(new, type);
+ init_object_data(new, data, type, dupos);
+ new->dico = dict;
+ new->parent = parent;
+
+ /* We will change the dictionary => acquire the write lock */
+ CHECK_POSIX_DO( ret = pthread_rwlock_wrlock(&dict->dict_lock), goto error_free );
+
+ /* Now link the object -- this also checks that no object with same keys already exists */
+ switch (type) {
+ case DICT_VENDOR:
+ /* A vendor object is linked in the g_dict_vendors.list[0], by their id */
+ ret = fd_list_insert_ordered ( &dict->dict_vendors.list[0], &new->list[0], (int (*)(void*, void *))order_vendor_by_id, (void **)&locref );
+ if (ret)
+ goto error_unlock;
+ break;
+
+ case DICT_APPLICATION:
+ /* An application object is linked in the g_dict_applciations.list[0], by their id */
+ ret = fd_list_insert_ordered ( &dict->dict_applications.list[0], &new->list[0], (int (*)(void*, void *))order_appli_by_id, (void **)&locref );
+ if (ret)
+ goto error_unlock;
+ break;
+
+ case DICT_TYPE:
+ /* A type object is linked in g_list_types by its name */
+ ret = fd_list_insert_ordered ( &dict->dict_types, &new->list[0], (int (*)(void*, void *))order_type_by_name, (void **)&locref );
+ if (ret)
+ goto error_unlock;
+ break;
+
+ case DICT_ENUMVAL:
+ /* A type_enum object is linked in it's parent 'type' object lists 1 and 2 by its name and values */
+ ret = fd_list_insert_ordered ( &parent->list[1], &new->list[0], (int (*)(void*, void *))order_enum_by_name, (void **)&locref );
+ if (ret)
+ goto error_unlock;
+
+ ret = fd_list_insert_ordered ( &parent->list[2], &new->list[1], (int (*)(void*, void *))order_enum_by_val, (void **)&locref );
+ if (ret) {
+ fd_list_unlink(&new->list[0]);
+ goto error_unlock;
+ }
+ break;
+
+ case DICT_AVP:
+ /* An avp object is linked in lists 1 and 2 of its vendor, by code and name */
+ ret = fd_list_insert_ordered ( &vendor->list[1], &new->list[0], (int (*)(void*, void *))order_avp_by_code, (void **)&locref );
+ if (ret)
+ goto error_unlock;
+
+ ret = fd_list_insert_ordered ( &vendor->list[2], &new->list[1], (int (*)(void*, void *))order_avp_by_name, (void **)&locref );
+ if (ret) {
+ fd_list_unlink(&new->list[0]);
+ goto error_unlock;
+ }
+ break;
+
+ case DICT_COMMAND:
+ /* A command object is linked in g_list_cmd_name and g_list_cmd_code by its name and code */
+ ret = fd_list_insert_ordered ( &dict->dict_cmd_code, &new->list[1], (int (*)(void*, void *))order_cmd_by_codefl, (void **)&locref );
+ if (ret)
+ goto error_unlock;
+
+ ret = fd_list_insert_ordered ( &dict->dict_cmd_name, &new->list[0], (int (*)(void*, void *))order_cmd_by_name, (void **)&locref );
+ if (ret) {
+ fd_list_unlink(&new->list[1]);
+ goto error_unlock;
+ }
+ break;
+
+ case DICT_RULE:
+ /* A rule object is linked in list[2] of its parent command or AVP by the name of the AVP it refers */
+ ret = fd_list_insert_ordered ( &parent->list[2], &new->list[0], (int (*)(void*, void *))order_rule_by_avpvc, (void **)&locref );
+ if (ret)
+ goto error_unlock;
+ break;
+
+ default:
+ ASSERT(0);
+ }
+
+ /* A new object has been created, increment the global counter */
+ dict->dict_count[type]++;
+
+ /* Unlock the dictionary */
+ CHECK_POSIX_DO( ret = pthread_rwlock_unlock(&dict->dict_lock), goto error_free );
+
+ /* Save the pointer to the new object */
+ if (ref)
+ *ref = new;
+
+ return 0;
+
+error_param:
+ ret = EINVAL;
+ goto all_errors;
+
+error_unlock:
+ CHECK_POSIX_DO( pthread_rwlock_unlock(&dict->dict_lock), /* continue */ );
+ if (ret == EEXIST) {
+ /* We have a duplicate key in locref. Check if the pointed object is the same or not */
+ switch (type) {
+ case DICT_VENDOR:
+ TRACE_DEBUG(FULL, "Vendor %s already in dictionary", new->data.vendor.vendor_name);
+ /* if we are here, it means the two vendors id are identical */
+ if (fd_os_cmp(locref->data.vendor.vendor_name, locref->datastr_len,
+ new->data.vendor.vendor_name, new->datastr_len)) {
+ TRACE_DEBUG(INFO, "Conflicting vendor name: %s", new->data.vendor.vendor_name);
+ break;
+ }
+ /* Otherwise (same name), we consider the function succeeded, since the (same) object is in the dictionary */
+ ret = 0;
+ break;
+
+ case DICT_APPLICATION:
+ TRACE_DEBUG(FULL, "Application %s already in dictionary", new->data.application.application_name);
+ /* got same id */
+ if (fd_os_cmp(locref->data.application.application_name, locref->datastr_len,
+ new->data.application.application_name, new->datastr_len)) {
+ TRACE_DEBUG(FULL, "Conflicting application name");
+ break;
+ }
+ ret = 0;
+ break;
+
+ case DICT_TYPE:
+ TRACE_DEBUG(FULL, "Type %s already in dictionary", new->data.type.type_name);
+ /* got same name */
+ if (locref->data.type.type_base != new->data.type.type_base) {
+ TRACE_DEBUG(FULL, "Conflicting base type");
+ break;
+ }
+ /* discard new definition only it a callback is provided and different from the previous one */
+ if ((new->data.type.type_interpret) && (locref->data.type.type_interpret != new->data.type.type_interpret)) {
+ TRACE_DEBUG(FULL, "Conflicting interpret cb");
+ break;
+ }
+ if ((new->data.type.type_encode) && (locref->data.type.type_encode != new->data.type.type_encode)) {
+ TRACE_DEBUG(FULL, "Conflicting encode cb");
+ break;
+ }
+ if ((new->data.type.type_dump) && (locref->data.type.type_dump != new->data.type.type_dump)) {
+ TRACE_DEBUG(FULL, "Conflicting dump cb");
+ break;
+ }
+ ret = 0;
+ break;
+
+ case DICT_ENUMVAL:
+ TRACE_DEBUG(FULL, "Enum %s already in dictionary", new->data.enumval.enum_name);
+ /* got either same name or same value. We check that both are true */
+ if (order_enum_by_name(locref, new)) {
+ TRACE_DEBUG(FULL, "Conflicting enum name");
+ break;
+ }
+ if (order_enum_by_val(locref, new)) {
+ TRACE_DEBUG(FULL, "Conflicting enum value");
+ break;
+ }
+ ret = 0;
+ break;
+
+ case DICT_AVP:
+ TRACE_DEBUG(FULL, "AVP %s already in dictionary", new->data.avp.avp_name);
+ /* got either same name or code */
+ if (order_avp_by_code(locref, new)) {
+ TRACE_DEBUG(FULL, "Conflicting AVP code");
+ break;
+ }
+ if (order_avp_by_name(locref, new)) {
+ TRACE_DEBUG(FULL, "Conflicting AVP name");
+ break;
+ }
+ if (locref->data.avp.avp_vendor != new->data.avp.avp_vendor) {
+ TRACE_DEBUG(FULL, "Conflicting AVP vendor");
+ break;
+ }
+ if (locref->data.avp.avp_flag_mask != new->data.avp.avp_flag_mask) {
+ TRACE_DEBUG(FULL, "Conflicting AVP flags mask");
+ break;
+ }
+ if ((locref->data.avp.avp_flag_val & locref->data.avp.avp_flag_mask) != (new->data.avp.avp_flag_val & new->data.avp.avp_flag_mask)) {
+ TRACE_DEBUG(FULL, "Conflicting AVP flags value");
+ break;
+ }
+ if (locref->data.avp.avp_basetype != new->data.avp.avp_basetype) {
+ TRACE_DEBUG(FULL, "Conflicting AVP base type");
+ break;
+ }
+ ret = 0;
+ break;
+
+ case DICT_COMMAND:
+ TRACE_DEBUG(FULL, "Command %s already in dictionary", new->data.cmd.cmd_name);
+ /* We got either same name, or same code + R flag */
+ if (order_cmd_by_name(locref, new)) {
+ TRACE_DEBUG(FULL, "Conflicting command name");
+ break;
+ }
+ if (locref->data.cmd.cmd_code != new->data.cmd.cmd_code) {
+ TRACE_DEBUG(FULL, "Conflicting command code");
+ break;
+ }
+ if (locref->data.cmd.cmd_flag_mask != new->data.cmd.cmd_flag_mask) {
+ TRACE_DEBUG(FULL, "Conflicting command flags mask %hhx:%hhx", locref->data.cmd.cmd_flag_mask, new->data.cmd.cmd_flag_mask);
+ break;
+ }
+ if ((locref->data.cmd.cmd_flag_val & locref->data.cmd.cmd_flag_mask) != (new->data.cmd.cmd_flag_val & new->data.cmd.cmd_flag_mask)) {
+ TRACE_DEBUG(FULL, "Conflicting command flags value");
+ break;
+ }
+ ret = 0;
+ break;
+
+ case DICT_RULE:
+ /* Both rules point to the same AVPs (code & vendor) */
+ if (locref->data.rule.rule_position != new->data.rule.rule_position) {
+ TRACE_DEBUG(FULL, "Conflicting rule position");
+ break;
+ }
+ if ( ((locref->data.rule.rule_position == RULE_FIXED_HEAD) ||
+ (locref->data.rule.rule_position == RULE_FIXED_TAIL))
+ && (locref->data.rule.rule_order != new->data.rule.rule_order)) {
+ TRACE_DEBUG(FULL, "Conflicting rule order");
+ break;
+ }
+ if (locref->data.rule.rule_min != new->data.rule.rule_min) {
+ int r1 = locref->data.rule.rule_min;
+ int r2 = new->data.rule.rule_min;
+ int p = locref->data.rule.rule_position;
+ if ( ((r1 != -1) && (r2 != -1)) /* none of the definitions contains the "default" value */
+ || ((p == RULE_OPTIONAL) && (r1 != 0) && (r2 != 0)) /* the other value is not 0 for an optional rule */
+ || ((r1 != 1) && (r2 != 1)) /* the other value is not 1 for another rule */
+ ) {
+ TRACE_DEBUG(FULL, "Conflicting rule min");
+ break;
+ }
+ }
+ if (locref->data.rule.rule_max != new->data.rule.rule_max) {
+ TRACE_DEBUG(FULL, "Conflicting rule max");
+ break;
+ }
+ ret = 0;
+ break;
+ }
+ if (!ret) {
+ TRACE_DEBUG(FULL, "An existing object with the same data was found, ignoring the error...");
+ }
+ if (ref)
+ *ref = locref;
+ }
+all_errors:
+ if (ret != 0) {
+ char * buf = NULL;
+ size_t len = 0, offset=0;
+
+ if (type == DICT_ENUMVAL) {
+ CHECK_MALLOC( dump_enumval_data ( &buf, &len, &offset, data, parent->data.type.type_base ));
+ } else {
+ CHECK_MALLOC( dict_obj_info[CHECK_TYPE(type) ? type : 0].dump_data(&buf, &len, &offset, data) );
+ }
+
+ TRACE_DEBUG(INFO, "An error occurred while adding the following data in the dictionary: %s", buf);
+
+ if (ret == EEXIST) {
+ offset=0;
+ CHECK_MALLOC( dump_object(&buf, &len, &offset, locref, 0, 0, 0) );
+ TRACE_DEBUG(INFO, "Conflicting entry in the dictionary: %s", buf);
+ }
+ free(buf);
+ }
+error_free:
+ free(new);
+ return ret;
+}
+
+
+int fd_dict_delete(struct dict_object * obj)
+{
+ int i;
+ struct dictionary * dict;
+ int ret=0;
+
+ /* check params */
+ CHECK_PARAMS( verify_object(obj) && obj->dico);
+ dict = obj->dico;
+
+ /* Lock the dictionary for change */
+ CHECK_POSIX( pthread_rwlock_wrlock(&dict->dict_lock) );
+
+ /* check the object is not sentinel for another list */
+ for (i=0; i<NB_LISTS_PER_OBJ; i++) {
+ if (!_OBINFO(obj).haslist[i] && !(FD_IS_LIST_EMPTY(&obj->list[i]))) {
+ /* There are children, this is not good */
+ ret = EINVAL;
+ TRACE_DEBUG (FULL, "Cannot delete object, list %d not empty:", i);
+ #if 0
+ dump_list(&obj->list[i], 0,0,0);
+ #endif
+ break;
+ }
+ }
+
+ /* ok, now destroy the object */
+ if (!ret)
+ destroy_object(obj);
+
+ /* Unlock */
+ CHECK_POSIX( pthread_rwlock_unlock(&dict->dict_lock) );
+
+ return ret;
+}
+
+
+int fd_dict_search ( struct dictionary * dict, enum dict_object_type type, int criteria, const void * what, struct dict_object **result, int retval )
+{
+ int ret = 0;
+
+ TRACE_ENTRY("%p %d(%s) %d %p %p %d", dict, type, dict_obj_info[CHECK_TYPE(type) ? type : 0].name, criteria, what, result, retval);
+
+ /* Check param */
+ CHECK_PARAMS( dict && (dict->dict_eyec == DICT_EYECATCHER) && CHECK_TYPE(type) );
+
+ /* Lock the dictionary for reading */
+ CHECK_POSIX( pthread_rwlock_rdlock(&dict->dict_lock) );
+
+ /* Now call the type-specific search function */
+ ret = dict_obj_info[type].search_fct (dict, criteria, what, result);
+
+ /* Unlock */
+ CHECK_POSIX( pthread_rwlock_unlock(&dict->dict_lock) );
+
+ /* Update the return value as needed */
+ if ((result != NULL) && (*result == NULL))
+ ret = retval;
+
+ return ret;
+}
+
+/* Function to retrieve list of objects in the dictionary. Use with care (read only).
+
+All returned list must be accessed like this:
+
+ for (li = sentinel->next; li != sentinel; li=li->next) {
+ struct dict_object * obj = li->o;
+ ...
+ }
+
+The following criteria are allowed, with corresponding parent.
+The parent is either struct dictionary * or struct dict_object *
+
+VENDOR_BY_ID : (parent = dictionary) returns list of vendors ordered by ID
+APPLICATION_BY_ID : (parent = dictionary) returns list of applications ordered by ID
+ ** for these two lists, the Vendor with id 0 and applciation with id 0 are excluded.
+ You must resolve them separatly with dict_search.
+
+TYPE_BY_NAME : (parent = dictionary) returns list of types ordered by name (osstring order)
+ENUMVAL_BY_NAME : (parent = type object) return list of constants for this type ordered by name (osstring order)
+ENUMVAL_BY_VALUE : (parent = type object) return list of constants for this type ordered by values
+AVP_BY_NAME : (parent = vendor object) return list of AVP for this vendor ordered by name (osstring order)
+AVP_BY_CODE : (parent = vendor object) return list of AVP for this vendor ordered by code
+CMD_BY_NAME : (parent = dictionary) returns list of commands ordered by name (osstring order)
+CMD_BY_CODE_R : (parent = dictionary) returns list of commands ordered by code
+RULE_BY_AVP_AND_PARENT: (parent = command or grouped AVP object) return list of rules for this object ordered by AVP vendor/code
+
+All other criteria are rejected.
+ */
+int fd_dict_getlistof(int criteria, void * parent, struct fd_list ** sentinel)
+{
+ struct dictionary * dict = parent;
+ struct dict_object * obj_parent = parent;
+
+ TRACE_ENTRY("%i %p %p", criteria, parent, sentinel);
+
+ CHECK_PARAMS(sentinel && parent);
+
+ switch(criteria) {
+ case VENDOR_BY_ID: /* parent must be the dictionary */
+ CHECK_PARAMS(dict->dict_eyec == DICT_EYECATCHER);
+ *sentinel = &dict->dict_vendors.list[0];
+ break;
+
+ case APPLICATION_BY_ID: /* parent must be the dictionary */
+ CHECK_PARAMS(dict->dict_eyec == DICT_EYECATCHER);
+ *sentinel = &dict->dict_applications.list[0];
+ break;
+
+ case TYPE_BY_NAME: /* parent must be the dictionary */
+ CHECK_PARAMS(dict->dict_eyec == DICT_EYECATCHER);
+ *sentinel = &dict->dict_types;
+ break;
+
+ case ENUMVAL_BY_NAME: /* parent must be a type object */
+ CHECK_PARAMS(verify_object(obj_parent) && (obj_parent->type == DICT_TYPE));
+ *sentinel = &obj_parent->list[1];
+ break;
+
+ case ENUMVAL_BY_VALUE: /* parent must be a type object */
+ CHECK_PARAMS(verify_object(obj_parent) && (obj_parent->type == DICT_TYPE));
+ *sentinel = &obj_parent->list[2];
+ break;
+
+ case AVP_BY_NAME: /* parent must be a VENDOR object */
+ CHECK_PARAMS(verify_object(obj_parent) && (obj_parent->type == DICT_VENDOR));
+ *sentinel = &obj_parent->list[2];
+ break;
+
+ case AVP_BY_CODE: /* parent must be a VENDOR object */
+ CHECK_PARAMS(verify_object(obj_parent) && (obj_parent->type == DICT_VENDOR));
+ *sentinel = &obj_parent->list[1];
+ break;
+
+ case CMD_BY_NAME: /* parent must be the dictionary */
+ CHECK_PARAMS(dict->dict_eyec == DICT_EYECATCHER);
+ *sentinel = &dict->dict_cmd_name;
+ break;
+
+ case CMD_BY_CODE_R: /* parent must be the dictionary */
+ CHECK_PARAMS(dict->dict_eyec == DICT_EYECATCHER);
+ *sentinel = &dict->dict_cmd_code;
+ break;
+
+ case RULE_BY_AVP_AND_PARENT: /* parent must be command or grouped AVP */
+ CHECK_PARAMS(verify_object(obj_parent));
+ CHECK_PARAMS( (obj_parent->type == DICT_COMMAND) ||
+ ((obj_parent->type == DICT_AVP)
+ && (obj_parent->data.avp.avp_basetype == AVP_TYPE_GROUPED)) );
+ *sentinel = &obj_parent->list[2];
+ break;
+
+ default:
+ CHECK_PARAMS(0);
+ }
+
+ return 0;
+}
+
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+/* */
+/* The init/fini functions */
+/* */
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+
+/* Initialize the dictionary */
+int fd_dict_init ( struct dictionary ** dict)
+{
+ struct dictionary * new = NULL;
+
+ TRACE_ENTRY("%p", dict);
+
+ /* Sanity checks */
+ ASSERT( (sizeof(type_base_name) / sizeof(type_base_name[0])) == (AVP_TYPE_MAX + 1) );
+ ASSERT( (sizeof(dict_obj_info) / sizeof(dict_obj_info[0])) == (DICT_TYPE_MAX + 1) );
+ CHECK_PARAMS(dict);
+
+ /* Allocate the memory for the dictionary */
+ CHECK_MALLOC( new = malloc(sizeof(struct dictionary)) );
+ memset(new, 0, sizeof(struct dictionary));
+
+ new->dict_eyec = DICT_EYECATCHER;
+
+ /* Initialize the lock for the dictionary */
+ CHECK_POSIX( pthread_rwlock_init(&new->dict_lock, NULL) );
+
+ /* Initialize the sentinel for vendors and AVP lists */
+ init_object( &new->dict_vendors, DICT_VENDOR );
+ #define NO_VENDOR_NAME "(no vendor)"
+ new->dict_vendors.data.vendor.vendor_name = NO_VENDOR_NAME;
+ new->dict_vendors.datastr_len = CONSTSTRLEN(NO_VENDOR_NAME);
+ /* new->dict_vendors.list[0].o = NULL; *//* overwrite since element is also sentinel for this list. */
+ new->dict_vendors.dico = new;
+
+ /* Initialize the sentinel for applications */
+ init_object( &new->dict_applications, DICT_APPLICATION );
+ #define APPLICATION_0_NAME "Diameter Common Messages"
+ new->dict_applications.data.application.application_name = APPLICATION_0_NAME;
+ new->dict_applications.datastr_len = CONSTSTRLEN(APPLICATION_0_NAME);
+ /* new->dict_applications.list[0].o = NULL; *//* overwrite since since element is also sentinel for this list. */
+ new->dict_applications.dico = new;
+
+ /* Initialize the sentinel for types */
+ fd_list_init ( &new->dict_types, NULL );
+
+ /* Initialize the sentinels for commands */
+ fd_list_init ( &new->dict_cmd_name, NULL );
+ fd_list_init ( &new->dict_cmd_code, NULL );
+
+ /* Initialize the error command object */
+ init_object( &new->dict_cmd_error, DICT_COMMAND );
+ #define GENERIC_ERROR_NAME "(generic error format)"
+ new->dict_cmd_error.data.cmd.cmd_name = GENERIC_ERROR_NAME;
+ new->dict_cmd_error.datastr_len = CONSTSTRLEN(GENERIC_ERROR_NAME);
+ new->dict_cmd_error.data.cmd.cmd_flag_mask=CMD_FLAG_ERROR | CMD_FLAG_REQUEST | CMD_FLAG_RETRANSMIT;
+ new->dict_cmd_error.data.cmd.cmd_flag_val =CMD_FLAG_ERROR;
+ new->dict_cmd_error.dico = new;
+
+ *dict = new;
+
+ /* Done */
+ return 0;
+}
+
+/* Destroy a dictionary */
+int fd_dict_fini ( struct dictionary ** dict)
+{
+ int i;
+
+ TRACE_ENTRY("");
+ CHECK_PARAMS( dict && *dict && ((*dict)->dict_eyec == DICT_EYECATCHER) );
+
+ /* Acquire the write lock to make sure no other operation is ongoing */
+ CHECK_POSIX( pthread_rwlock_wrlock(&(*dict)->dict_lock) );
+
+ /* Empty all the lists, free the elements */
+ destroy_list ( &(*dict)->dict_cmd_error.list[2] );
+ destroy_list ( &(*dict)->dict_cmd_code );
+ destroy_list ( &(*dict)->dict_cmd_name );
+ destroy_list ( &(*dict)->dict_types );
+ for (i=0; i< NB_LISTS_PER_OBJ; i++) {
+ destroy_list ( &(*dict)->dict_applications.list[i] );
+ destroy_list ( &(*dict)->dict_vendors.list[i] );
+ }
+
+ /* Dictionary is empty, now destroy the lock */
+ CHECK_POSIX( pthread_rwlock_unlock(&(*dict)->dict_lock) );
+ CHECK_POSIX( pthread_rwlock_destroy(&(*dict)->dict_lock) );
+
+ free(*dict);
+ *dict = NULL;
+
+ return 0;
+}
+
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+/* */
+/* Other functions */
+/* */
+/*******************************************************************************************************/
+/*******************************************************************************************************/
+
+/* Iterate a callback on the rules for an object */
+int fd_dict_iterate_rules ( struct dict_object *parent, void * data, int (*cb)(void *, struct dict_rule_data *) )
+{
+ int ret = 0;
+ struct fd_list * li;
+
+ TRACE_ENTRY("%p %p %p", parent, data, cb);
+
+ /* Check parameters */
+ CHECK_PARAMS( verify_object(parent) );
+ CHECK_PARAMS( (parent->type == DICT_COMMAND)
+ || ((parent->type == DICT_AVP) && (parent->data.avp.avp_basetype == AVP_TYPE_GROUPED)) );
+ TRACE_DEBUG (FULL, "Iterating on rules of %s: '%s'.",
+ _OBINFO(parent).name,
+ parent->type == DICT_COMMAND ?
+ parent->data.cmd.cmd_name
+ : parent->data.avp.avp_name);
+
+ /* Acquire the read lock */
+ CHECK_POSIX( pthread_rwlock_rdlock(&parent->dico->dict_lock) );
+
+ /* go through the list and call the cb on each rule data */
+ for (li = &(parent->list[2]); li->next != &(parent->list[2]); li = li->next) {
+ ret = (*cb)(data, &(_O(li->next->o)->data.rule));
+ if (ret != 0)
+ break;
+ }
+
+ /* Release the lock */
+ CHECK_POSIX( pthread_rwlock_unlock(&parent->dico->dict_lock) );
+
+ return ret;
+}
+
+/* Create the list of vendors. Returns a 0-terminated array, that must be freed after use. Returns NULL on error. */
+uint32_t * fd_dict_get_vendorid_list(struct dictionary * dict)
+{
+ uint32_t * ret = NULL;
+ int i = 0;
+ struct fd_list * li;
+
+ TRACE_ENTRY();
+
+ /* Acquire the read lock */
+ CHECK_POSIX_DO( pthread_rwlock_rdlock(&dict->dict_lock), return NULL );
+
+ /* Allocate an array to contain all the elements */
+ CHECK_MALLOC_DO( ret = calloc( dict->dict_count[DICT_VENDOR] + 1, sizeof(uint32_t) ), goto out );
+
+ /* Copy the vendors IDs */
+ for (li = dict->dict_vendors.list[0].next; li != &(dict->dict_vendors.list[0]); li = li->next) {
+ ret[i] = _O(li->o)->data.vendor.vendor_id;
+ i++;
+ ASSERT( i <= dict->dict_count[DICT_VENDOR] );
+ }
+out:
+ /* Release the lock */
+ CHECK_POSIX_DO( pthread_rwlock_unlock(&dict->dict_lock), return NULL );
+
+ return ret;
+}
+
+/* Return the location of the cb list for an object, after checking its type */
+int fd_dict_disp_cb(enum dict_object_type type, struct dict_object *obj, struct fd_list ** cb_list)
+{
+ TRACE_ENTRY("%d %p %p", type, obj, cb_list);
+ CHECK_PARAMS( verify_object(obj) );
+ CHECK_PARAMS( _OBINFO(obj).type == type );
+ CHECK_PARAMS( cb_list );
+ *cb_list = &obj->disp_cbs;
+ return 0;
+}
+
+int fd_dict_get_error_cmd(struct dictionary * dict, struct dict_object **obj)
+{
+ TRACE_ENTRY("%p %p", dict, obj);
+ CHECK_PARAMS( dict && (dict->dict_eyec == DICT_EYECATCHER) && obj );
+ *obj = &dict->dict_cmd_error;
+ return 0;
+}
diff --git a/libfdproto/dictionary_functions.c b/libfdproto/dictionary_functions.c
new file mode 100644
index 0000000..315b417
--- /dev/null
+++ b/libfdproto/dictionary_functions.c
@@ -0,0 +1,387 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2015, 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. *
+*********************************************************************************************************/
+
+#include "fdproto-internal.h"
+#include <time.h>
+
+/* This file contains helpers functions to be reused as callbacks in the struct dict_type_data structure.
+There are three callbacks there:
+
+ - type_encode :
+ - type_interpret :
+ Those two callbacks allow to manipulate more natural structures of data in the code, and to
+ map transparently these natural structures with the AVP-encoded format by calling the functions
+ msg_avp_value_encode or msg_avp_value_interpret.
+ - type_dump :
+ This callback if provided gives a more human-readable debug information.
+
+ */
+
+/****************************/
+/* Address AVP type */
+/****************************/
+
+/* The interpret and encode functions work with a "struct sockaddr_storage" pointer for mapping
+the contents of the AVP */
+
+int fd_dictfct_Address_encode(void * data, union avp_value * avp_value)
+{
+ sSS * ss = (sSS *) data;
+ uint16_t AddressType = 0;
+ size_t size = 0;
+ unsigned char * buf = NULL;
+
+ TRACE_ENTRY("%p %p", data, avp_value);
+ CHECK_PARAMS( data && avp_value );
+
+ switch (ss->ss_family) {
+ case AF_INET:
+ {
+ /* We are encoding an IP address */
+ sSA4 * sin = (sSA4 *)ss;
+
+ AddressType = 1;/* see http://www.iana.org/assignments/address-family-numbers/ */
+ size = 6; /* 2 for AddressType + 4 for data */
+
+ CHECK_MALLOC( buf = malloc(size) );
+
+ /* may not work because of alignment: *(uint32_t *)(buf+2) = htonl(sin->sin_addr.s_addr); */
+ memcpy(buf + 2, &sin->sin_addr.s_addr, 4);
+ }
+ break;
+
+ case AF_INET6:
+ {
+ /* We are encoding an IPv6 address */
+ sSA6 * sin6 = (sSA6 *)ss;
+
+ AddressType = 2;/* see http://www.iana.org/assignments/address-family-numbers/ */
+ size = 18; /* 2 for AddressType + 16 for data */
+
+ CHECK_MALLOC( buf = malloc(size) );
+
+ /* The order is already good here */
+ memcpy(buf + 2, &sin6->sin6_addr.s6_addr, 16);
+
+ }
+ break;
+
+ default:
+ CHECK_PARAMS( AddressType = 0 );
+ }
+
+ *(uint16_t *)buf = htons(AddressType);
+
+ avp_value->os.len = size;
+ avp_value->os.data = buf;
+
+ return 0;
+}
+
+int fd_dictfct_Address_interpret(union avp_value * avp_value, void * interpreted)
+{
+ uint16_t AddressType = 0;
+ unsigned char * buf;
+
+ TRACE_ENTRY("%p %p", avp_value, interpreted);
+
+ CHECK_PARAMS( avp_value && interpreted && (avp_value->os.len >= 2) );
+
+ AddressType = ntohs(*(uint16_t *)avp_value->os.data);
+ buf = &avp_value->os.data[2];
+
+ switch (AddressType) {
+ case 1 /* IP */:
+ {
+ sSA4 * sin = (sSA4 *)interpreted;
+
+ CHECK_PARAMS( avp_value->os.len == 6 );
+
+ sin->sin_family = AF_INET;
+ /* sin->sin_addr.s_addr = ntohl( * (uint32_t *) buf); -- may not work because of bad alignment */
+ memcpy(&sin->sin_addr.s_addr, buf, 4);
+ }
+ break;
+
+ case 2 /* IP6 */:
+ {
+ sSA6 * sin6 = (sSA6 *)interpreted;
+
+ CHECK_PARAMS( avp_value->os.len == 18 );
+
+ sin6->sin6_family = AF_INET6;
+ memcpy(&sin6->sin6_addr.s6_addr, buf, 16);
+
+ }
+ break;
+
+ default:
+ CHECK_PARAMS( AddressType = 0 );
+ }
+
+ return 0;
+}
+
+/* Dump the content of an Address AVP */
+DECLARE_FD_DUMP_PROTOTYPE(fd_dictfct_Address_dump, union avp_value * avp_value)
+{
+ union {
+ sSA sa;
+ sSS ss;
+ sSA4 sin;
+ sSA6 sin6;
+ } s;
+ uint16_t fam;
+
+ FD_DUMP_HANDLE_OFFSET();
+
+ memset(&s, 0, sizeof(s));
+
+ /* The first two octets represent the address family, http://www.iana.org/assignments/address-family-numbers/ */
+ if (avp_value->os.len < 2) {
+ CHECK_MALLOC_DO( fd_dump_extend(FD_DUMP_STD_PARAMS, "[invalid length: %zd]", avp_value->os.len), return NULL);
+ return *buf;
+ }
+
+ /* Following octets are the address in network byte order already */
+ fam = avp_value->os.data[0] << 8 | avp_value->os.data[1];
+ switch (fam) {
+ case 1:
+ /* IP */
+ s.sa.sa_family = AF_INET;
+ if ((avp_value->os.len != 6) && (avp_value->os.len != 8)) {
+ CHECK_MALLOC_DO( fd_dump_extend(FD_DUMP_STD_PARAMS, "[invalid IP length: %zd]", avp_value->os.len), return NULL);
+ return *buf;
+ }
+ memcpy(&s.sin.sin_addr.s_addr, avp_value->os.data + 2, 4);
+ if (avp_value->os.len == 8)
+ memcpy(&s.sin.sin_port, avp_value->os.data + 6, 2);
+ break;
+ case 2:
+ /* IP6 */
+ s.sa.sa_family = AF_INET6;
+ if ((avp_value->os.len != 18) && (avp_value->os.len != 20)) {
+ CHECK_MALLOC_DO( fd_dump_extend(FD_DUMP_STD_PARAMS, "[invalid IP6 length: %zd]", avp_value->os.len), return NULL);
+ return *buf;
+ }
+ memcpy(&s.sin6.sin6_addr.s6_addr, avp_value->os.data + 2, 16);
+ if (avp_value->os.len == 20)
+ memcpy(&s.sin6.sin6_port, avp_value->os.data + 18, 2);
+ break;
+ case 8:
+ /* E.164 */
+ CHECK_MALLOC_DO( fd_dump_extend(FD_DUMP_STD_PARAMS, "%.*s", (int)(avp_value->os.len-2), avp_value->os.data+2), return NULL);
+ return *buf;
+ default:
+ CHECK_MALLOC_DO( fd_dump_extend(FD_DUMP_STD_PARAMS, "[unsupported family: 0x%hx]", fam), return NULL);
+ return *buf;
+ }
+
+ return fd_sa_dump(FD_DUMP_STD_PARAMS, &s.sa, NI_NUMERICHOST);
+}
+
+
+
+/*******************************/
+/* UTF8String AVP type */
+/*******************************/
+
+/* Dump the AVP in a natural human-readable format. This dumps the complete length of the AVP, it is up to the caller to truncate if needed */
+DECLARE_FD_DUMP_PROTOTYPE(fd_dictfct_UTF8String_dump, union avp_value * avp_value)
+{
+ size_t l;
+ FD_DUMP_HANDLE_OFFSET();
+
+ l = avp_value->os.len;
+ /* Just in case the string ends in invalid UTF-8 chars, we shorten it */
+ while ((l > 0) && (avp_value->os.data[l - 1] & 0x80)) {
+ /* this byte is start or cont. of multibyte sequence, as we do not know the next byte we need to delete it. */
+ l--;
+ if (avp_value->os.data[l] & 0x40)
+ break; /* This was a start byte, we can stop the loop */
+ }
+
+ CHECK_MALLOC_DO( fd_dump_extend(FD_DUMP_STD_PARAMS, "\"%.*s\"", (int)l, (char *)avp_value->os.data), return NULL);
+
+ return *buf;
+}
+
+
+/*******************************/
+/* Time AVP type */
+/*******************************/
+
+/* The interpret and encode functions work with a "time_t" pointer for mapping
+the contents of the AVP */
+
+/* Unix Epoch starts 1970-01-01, NTP 0 is at 1900-01-01 */
+#define DIFF_EPOCH_TO_NTP ((365*(1970-1900) + 17ul) * 24 * 60 * 60)
+
+static int diameter_string_to_time_t(const char *str, size_t len, time_t *result) {
+ time_t time_stamp;
+ CHECK_PARAMS(len == 4);
+
+ time_stamp = (((unsigned long)(str[0]&0xff))<<24) + ((str[1]&0xff)<<16) + ((str[2]&0xff)<<8) + ((str[3]&0xff));
+ time_stamp -= DIFF_EPOCH_TO_NTP;
+#ifdef FIX__NEEDED_FOR_YEAR_2036_AND_LATER
+/* NTP overflows in 2036; after that, values start at zero again */
+#define NTP_OVERFLOW_CORRECTION (0x100000000ull)
+ /* XXX: debug and find correct conversion */
+ if (str[0] & 0x80 == 0x00) {
+ time_stamp += NTP_OVERFLOW_CORRECTION;
+ }
+#endif
+ *result = time_stamp;
+ return 0;
+}
+
+static int time_t_to_diameter_string(time_t time_stamp, char **result) {
+ uint64_t out = time_stamp;
+ char *conv;
+ /* XXX: 2036 fix */
+ out += DIFF_EPOCH_TO_NTP;
+ CHECK_PARAMS( (out >> 32) == 0);
+
+ CHECK_MALLOC(conv=(char *)malloc(5));
+
+ conv[0] = (out>>24) & 0xff;
+ conv[1] = (out>>16) & 0xff;
+ conv[2] = (out>> 8) & 0xff;
+ conv[3] = out & 0xff;
+ conv[4] = '\0';
+ *result = conv;
+ return 0;
+}
+
+int fd_dictfct_Time_encode(void * data, union avp_value * avp_value)
+{
+ char * buf;
+ size_t len;
+
+ TRACE_ENTRY("%p %p", data, avp_value);
+ CHECK_PARAMS( data && avp_value );
+
+ CHECK_FCT( time_t_to_diameter_string( *((time_t *)data), &buf) );
+ /* FIXME: return len from the function above? */ len = 4;
+
+ avp_value->os.len = len;
+ avp_value->os.data = (uint8_t *)buf;
+ return 0;
+}
+
+int fd_dictfct_Time_interpret(union avp_value * avp_value, void * interpreted)
+{
+ TRACE_ENTRY("%p %p", avp_value, interpreted);
+
+ CHECK_PARAMS( avp_value && interpreted );
+
+ return diameter_string_to_time_t((const char *)avp_value->os.data, avp_value->os.len, interpreted);
+}
+
+static void _format_offs (long offset, char *buf) {
+ int offs_hours, offs_minutes, sgn = 1;
+ if (offset < 0) {
+ offset = -offset;
+ sgn = 1;
+ }
+ offs_hours = (int)(offset/3600);
+ offs_minutes = (offset%3600)/60;
+
+ char* s = buf;
+
+ *(s++) = sgn == 1 ? '+' : '-';
+ *(s++) = (char)(offs_hours/10) + '0';
+ *(s++) = offs_hours%10 + '0';
+
+ if (offs_minutes == 0) {
+ *(s++) = '\0';
+ } else {
+ *(s++) = (char)(offs_minutes/10) + '0';
+ *(s++) = offs_minutes%10 + '0';
+ *(s++) = '\0';
+ }
+}
+
+DECLARE_FD_DUMP_PROTOTYPE(fd_dictfct_Time_dump, union avp_value * avp_value)
+{
+ time_t val;
+ struct tm conv;
+ char tz_buf[7];
+
+ FD_DUMP_HANDLE_OFFSET();
+
+ if (avp_value->os.len != 4) {
+ CHECK_MALLOC_DO( fd_dump_extend(FD_DUMP_STD_PARAMS, "[invalid length: %zd]", avp_value->os.len), return NULL);
+ return *buf;
+ }
+
+ if (diameter_string_to_time_t((char *)avp_value->os.data, avp_value->os.len, &val) != 0) {
+ CHECK_MALLOC_DO( fd_dump_extend(FD_DUMP_STD_PARAMS, "[time conversion error]"), return NULL);
+ return *buf;
+ }
+
+ CHECK_MALLOC_DO( localtime_r(&val, &conv), return NULL);
+ _format_offs(conv.tm_gmtoff, tz_buf);
+ CHECK_MALLOC_DO( fd_dump_extend(FD_DUMP_STD_PARAMS, "%d%02d%02dT%02d%02d%02d%s", conv.tm_year+1900, conv.tm_mon+1, conv.tm_mday, conv.tm_hour, conv.tm_min, conv.tm_sec, tz_buf), return NULL);
+ return *buf;
+}
+
+/* Check that a given AVP value contains all the characters from data in the same order */
+static char error_message[80];
+int fd_dictfct_CharInOS_check(void * data, union avp_value * val, char ** error_msg)
+{
+ char * inChar = data;
+ char * inData = (char *)val->os.data;
+ int i = 0;
+ CHECK_PARAMS(data);
+ while (*inChar != '\0') {
+ while (i < val->os.len) {
+ if (*inChar == inData[i++]) {
+ inChar++;
+ break;
+ }
+ }
+ if (i >= val->os.len)
+ break;
+ }
+ if (*inChar == '\0')
+ return 0;
+
+ if (error_msg) {
+ snprintf(error_message, sizeof(error_message), "Could not find '%c' in AVP", *inChar);
+ *error_msg = error_message;
+ }
+ return EBADMSG;
+}
diff --git a/libfdproto/dispatch.c b/libfdproto/dispatch.c
new file mode 100644
index 0000000..6111915
--- /dev/null
+++ b/libfdproto/dispatch.c
@@ -0,0 +1,228 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2013, 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. *
+*********************************************************************************************************/
+
+#include "fdproto-internal.h"
+
+/* The dispatch module in the library is quite simple: callbacks are saved in a global list
+ * in no particular order. In addition, they are also linked from the dictionary objects they
+ * refer to. */
+
+/* Protection for the lists managed in this module. */
+pthread_rwlock_t fd_disp_lock = PTHREAD_RWLOCK_INITIALIZER;
+
+/* List of all registered handlers -- useful if we want to cleanup properly at some point... */
+static struct fd_list all_handlers = FD_LIST_INITIALIZER( all_handlers );
+
+/* List of handlers registered for DISP_HOW_ANY. Other handlers are stored in the dictionary */
+static struct fd_list any_handlers = FD_LIST_INITIALIZER( any_handlers );
+
+/* The structure to store a callback */
+struct disp_hdl {
+ int eyec; /* Eye catcher, DISP_EYEC */
+ struct fd_list all; /* link in the all_handlers list */
+ struct fd_list parent;/* link in dictionary cb_list or in any_handlers */
+ enum disp_how how; /* Copy of registration parameter */
+ struct disp_when when; /* Copy of registration parameter */
+ int (*cb)( struct msg **, struct avp *, struct session *, void *, enum disp_action *); /* The callback itself */
+ void *opaque; /* opaque data passed back to the callback */
+};
+
+#define DISP_EYEC 0xD15241C1
+#define VALIDATE_HDL( _hdl ) \
+ ( ( ( _hdl ) != NULL ) && ( ((struct disp_hdl *)( _hdl ))->eyec == DISP_EYEC ) )
+
+/**************************************************************************************/
+
+/* Call CBs from a given list (any_handlers if cb_list is NULL) -- must have locked fd_disp_lock before */
+int fd_disp_call_cb_int( struct fd_list * cb_list, struct msg ** msg, struct avp *avp, struct session *sess, enum disp_action *action,
+ struct dict_object * obj_app, struct dict_object * obj_cmd, struct dict_object * obj_avp, struct dict_object * obj_enu,
+ char ** drop_reason, struct msg ** drop_msg)
+{
+ struct fd_list * senti, *li;
+ int r;
+ TRACE_ENTRY("%p %p %p %p %p %p %p %p %p", cb_list, msg, avp, sess, action, obj_app, obj_cmd, obj_avp, obj_enu);
+ CHECK_PARAMS(msg && action);
+
+ senti = cb_list;
+ if (!senti)
+ senti = &any_handlers;
+
+ for (li = senti->next; li != senti; li = li->next) {
+ struct disp_hdl * hdl = (struct disp_hdl *)(li->o);
+
+ TRACE_DEBUG(ANNOYING, "when: %p %p %p %p", hdl->when.app, hdl->when.command, hdl->when.avp, hdl->when.value);
+
+ /* Check this handler matches this message / avp */
+ if (hdl->when.app && (hdl->when.app != obj_app))
+ continue;
+ if (hdl->when.command && (hdl->when.command != obj_cmd))
+ continue;
+ if (hdl->when.avp && (hdl->when.avp != obj_avp))
+ continue;
+ if (hdl->when.value && (hdl->when.value != obj_enu))
+ continue;
+
+ /* We have a match, the cb must be called. */
+ CHECK_FCT_DO( (r = (*hdl->cb)(msg, avp, sess, hdl->opaque, action)),
+ {
+ *drop_reason = "Internal error: a DISPATCH callback returned an error";
+ *drop_msg = *msg;
+ *msg = NULL;
+ }
+ );
+
+ if (*action != DISP_ACT_CONT)
+ break;
+
+ if ( *msg == NULL )
+ break;
+ }
+
+ /* We're done on this list */
+ return 0;
+}
+
+/**************************************************************************************/
+
+/* Create a new handler and link it */
+int fd_disp_register ( int (*cb)( struct msg **, struct avp *, struct session *, void *, enum disp_action *),
+ enum disp_how how, struct disp_when * when, void * opaque, struct disp_hdl ** handle )
+{
+ struct fd_list * cb_list = NULL;
+ struct disp_hdl * new;
+ struct dict_object * type_enum = NULL, * type_avp;
+ struct dictionary * dict = NULL;
+
+ TRACE_ENTRY("%p %d %p %p", cb, how, when, handle);
+ CHECK_PARAMS( cb && ( (how == DISP_HOW_ANY) || when ));
+
+ switch (how) {
+ case DISP_HOW_ANY:
+ cb_list = &any_handlers;
+ break;
+
+ case DISP_HOW_APPID:
+ CHECK_FCT( fd_dict_disp_cb(DICT_APPLICATION, when->app, &cb_list) );
+ break;
+
+ case DISP_HOW_CC:
+ CHECK_FCT( fd_dict_disp_cb(DICT_COMMAND, when->command, &cb_list) );
+ break;
+
+ case DISP_HOW_AVP_ENUMVAL:
+ CHECK_FCT( fd_dict_disp_cb(DICT_ENUMVAL, when->value, &cb_list) ); /* cb_list is then overwritten */
+ CHECK_FCT( fd_dict_getdict(when->value, &dict) );
+ CHECK_FCT( fd_dict_search(dict, DICT_TYPE, TYPE_OF_ENUMVAL, when->value, &type_enum, EINVAL) );
+ case DISP_HOW_AVP:
+ CHECK_FCT( fd_dict_disp_cb(DICT_AVP, when->avp, &cb_list) );
+ if (dict) {
+ CHECK_FCT( fd_dict_search(dict, DICT_TYPE, TYPE_OF_AVP, when->avp, &type_avp, EINVAL) );
+ if (type_enum) {
+ CHECK_PARAMS( type_enum == type_avp );
+ }
+ }
+ break;
+
+ default:
+ CHECK_PARAMS(how = 0);
+ }
+ /* We might further check optional fields, but we trust the caller ^^ */
+
+ /* Create the new handler */
+ CHECK_MALLOC( new = malloc( sizeof(struct disp_hdl) ) );
+ memset(new, 0, sizeof(struct disp_hdl));
+ new->eyec = DISP_EYEC;
+ fd_list_init(&new->all, new);
+ fd_list_init(&new->parent, new);
+ new->how = how;
+ switch (how) {
+ case DISP_HOW_ANY:
+ /* there is no "when" in that case */
+ break;
+ case DISP_HOW_AVP_ENUMVAL:
+ new->when.value = when->value;
+ case DISP_HOW_AVP:
+ new->when.avp = when->avp;
+ case DISP_HOW_CC:
+ new->when.command = when->command;
+ case DISP_HOW_APPID:
+ new->when.app = when->app;
+ }
+ new->cb = cb;
+ new->opaque = opaque;
+
+ /* Now, link this new element in the appropriate lists */
+ CHECK_POSIX( pthread_rwlock_wrlock(&fd_disp_lock) );
+ fd_list_insert_before(&all_handlers, &new->all);
+ fd_list_insert_before(cb_list, &new->parent);
+ CHECK_POSIX( pthread_rwlock_unlock(&fd_disp_lock) );
+
+ /* We're done */
+ if (handle)
+ *handle = new;
+
+ return 0;
+}
+
+/* Delete a handler */
+int fd_disp_unregister ( struct disp_hdl ** handle, void ** opaque )
+{
+ struct disp_hdl * del;
+ TRACE_ENTRY("%p", handle);
+ CHECK_PARAMS( handle && VALIDATE_HDL(*handle) );
+ del = *handle;
+ *handle = NULL;
+
+ CHECK_POSIX( pthread_rwlock_wrlock(&fd_disp_lock) );
+ fd_list_unlink(&del->all);
+ fd_list_unlink(&del->parent);
+ CHECK_POSIX( pthread_rwlock_unlock(&fd_disp_lock) );
+
+ if (opaque)
+ *opaque = del->opaque;
+
+ free(del);
+ return 0;
+}
+
+/* Delete all handlers */
+void fd_disp_unregister_all ( void )
+{
+ TRACE_ENTRY("");
+ while (!FD_IS_LIST_EMPTY(&all_handlers)) {
+ CHECK_FCT_DO( fd_disp_unregister((void *)&(all_handlers.next->o), NULL), /* continue */ );
+ }
+ return;
+}
diff --git a/libfdproto/fdproto-internal.h b/libfdproto/fdproto-internal.h
new file mode 100644
index 0000000..a328c57
--- /dev/null
+++ b/libfdproto/fdproto-internal.h
@@ -0,0 +1,65 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2013, 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. *
+*********************************************************************************************************/
+
+/* This file contains the definitions for internal use in the freeDiameter protocol library */
+
+#ifndef _LIBFDPROTO_INTERNAL_H
+#define _LIBFDPROTO_INTERNAL_H
+
+#include <freeDiameter/freeDiameter-host.h>
+#include <freeDiameter/libfdproto.h>
+
+/* Internal to the library */
+extern const char * type_base_name[];
+void fd_msg_eteid_init(void);
+int fd_sess_init(void);
+void fd_sess_fini(void);
+
+/* Iterator on the rules of a parent object */
+int fd_dict_iterate_rules ( struct dict_object *parent, void * data, int (*cb)(void *, struct dict_rule_data *) );
+
+/* Dispatch / messages / dictionary API */
+int fd_dict_disp_cb(enum dict_object_type type, struct dict_object *obj, struct fd_list ** cb_list);
+DECLARE_FD_DUMP_PROTOTYPE(fd_dict_dump_avp_value, union avp_value *avp_value, struct dict_object * model, int indent, int header);
+int fd_disp_call_cb_int( struct fd_list * cb_list, struct msg ** msg, struct avp *avp, struct session *sess, enum disp_action *action,
+ struct dict_object * obj_app, struct dict_object * obj_cmd, struct dict_object * obj_avp, struct dict_object * obj_enu,
+ char ** drop_reason, struct msg ** drop_msg);
+extern pthread_rwlock_t fd_disp_lock;
+
+/* Messages / sessions API */
+int fd_sess_reclaim_msg ( struct session ** session );
+
+
+#endif /* _LIBFDPROTO_INTERNAL_H */
diff --git a/libfdproto/fifo.c b/libfdproto/fifo.c
new file mode 100644
index 0000000..cf5b7fc
--- /dev/null
+++ b/libfdproto/fifo.c
@@ -0,0 +1,700 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2013, 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. *
+*********************************************************************************************************/
+
+/* FIFO queues module.
+ *
+ * The threads that call these functions must be in the cancellation state PTHREAD_CANCEL_ENABLE and type PTHREAD_CANCEL_DEFERRED.
+ * This is the default state and type on thread creation.
+ *
+ * In order to destroy properly a queue, the application must:
+ * -> shutdown any process that can add into the queue first.
+ * -> pthread_cancel any thread that could be waiting on the queue.
+ * -> consume any element that is in the queue, using fd_qu_tryget_int.
+ * -> then destroy the queue using fd_mq_del.
+ */
+
+#include "fdproto-internal.h"
+
+/* Definition of a FIFO queue object */
+struct fifo {
+ int eyec; /* An eye catcher, also used to check a queue is valid. FIFO_EYEC */
+
+ pthread_mutex_t mtx; /* Mutex protecting this queue */
+ pthread_cond_t cond_pull; /* condition variable for pulling threads */
+ pthread_cond_t cond_push; /* condition variable for pushing threads */
+
+ struct fd_list list; /* sentinel for the list of elements */
+ int count; /* number of objects in the list */
+ int thrs; /* number of threads waiting for a new element (when count is 0) */
+
+ int max; /* maximum number of items to accept if not 0 */
+ int thrs_push; /* number of threads waitnig to push an item */
+
+ uint16_t high; /* High level threshold (see libfreeDiameter.h for details) */
+ uint16_t low; /* Low level threshhold */
+ void *data; /* Opaque pointer for threshold callbacks */
+ void (*h_cb)(struct fifo *, void **); /* The callbacks */
+ void (*l_cb)(struct fifo *, void **);
+ int highest;/* The highest count value for which h_cb has been called */
+ int highest_ever; /* The max count value this queue has reached (for tweaking) */
+
+ long long total_items; /* Cumulated number of items that went through this fifo (excluding current count), always increasing. */
+ struct timespec total_time; /* Cumulated time all items spent in this queue, including blocking time (always growing, use deltas for monitoring) */
+ struct timespec blocking_time; /* Cumulated time threads trying to post new items were blocked (queue full). */
+ struct timespec last_time; /* For the last element retrieved from the queue, how long it take between posting (including blocking) and poping */
+
+};
+
+struct fifo_item {
+ struct fd_list item;
+ struct timespec posted_on;
+};
+
+/* The eye catcher value */
+#define FIFO_EYEC 0xe7ec1130
+
+/* Macro to check a pointer */
+#define CHECK_FIFO( _queue ) (( (_queue) != NULL) && ( (_queue)->eyec == FIFO_EYEC) )
+
+
+/* Create a new queue, with max number of items -- use 0 for no max */
+int fd_fifo_new ( struct fifo ** queue, int max )
+{
+ struct fifo * new;
+
+ TRACE_ENTRY( "%p", queue );
+
+ CHECK_PARAMS( queue );
+
+ /* Create a new object */
+ CHECK_MALLOC( new = malloc (sizeof (struct fifo) ) );
+
+ /* Initialize the content */
+ memset(new, 0, sizeof(struct fifo));
+
+ new->eyec = FIFO_EYEC;
+ CHECK_POSIX( pthread_mutex_init(&new->mtx, NULL) );
+ CHECK_POSIX( pthread_cond_init(&new->cond_pull, NULL) );
+ CHECK_POSIX( pthread_cond_init(&new->cond_push, NULL) );
+ new->max = max;
+
+ fd_list_init(&new->list, NULL);
+
+ /* We're done */
+ *queue = new;
+ return 0;
+}
+
+/* Dump the content of a queue */
+DECLARE_FD_DUMP_PROTOTYPE(fd_fifo_dump, char * name, struct fifo * queue, fd_fifo_dump_item_cb dump_item)
+{
+ FD_DUMP_HANDLE_OFFSET();
+
+ if (name) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "'%s'(@%p): ", name, queue), return NULL);
+ } else {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "{fifo}(@%p): ", queue), return NULL);
+ }
+
+ if (!CHECK_FIFO( queue )) {
+ return fd_dump_extend(FD_DUMP_STD_PARAMS, "INVALID/NULL");
+ }
+
+ CHECK_POSIX_DO( pthread_mutex_lock( &queue->mtx ), /* continue */ );
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "items:%d,%d,%d threads:%d,%d stats:%lld/%ld.%06ld,%ld.%06ld,%ld.%06ld thresholds:%d,%d,%d,%p,%p,%p",
+ queue->count, queue->highest_ever, queue->max,
+ queue->thrs, queue->thrs_push,
+ queue->total_items,(long)queue->total_time.tv_sec,(long)(queue->total_time.tv_nsec/1000),(long)queue->blocking_time.tv_sec,(long)(queue->blocking_time.tv_nsec/1000),(long)queue->last_time.tv_sec,(long)(queue->last_time.tv_nsec/1000),
+ queue->high, queue->low, queue->highest, queue->h_cb, queue->l_cb, queue->data),
+ goto error);
+
+ if (dump_item) {
+ struct fd_list * li;
+ int i = 0;
+ for (li = queue->list.next; li != &queue->list; li = li->next) {
+ struct fifo_item * fi = (struct fifo_item *)li;
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n [#%i](@%p)@%ld.%06ld: ",
+ i++, fi->item.o, (long)fi->posted_on.tv_sec,(long)(fi->posted_on.tv_nsec/1000)),
+ goto error);
+ CHECK_MALLOC_DO( (*dump_item)(FD_DUMP_STD_PARAMS, fi->item.o), goto error);
+ }
+ }
+ CHECK_POSIX_DO( pthread_mutex_unlock( &queue->mtx ), /* continue */ );
+
+ return *buf;
+error:
+ CHECK_POSIX_DO( pthread_mutex_unlock( &queue->mtx ), /* continue */ );
+ return NULL;
+}
+
+/* Delete a queue. It must be empty. */
+int fd_fifo_del ( struct fifo ** queue )
+{
+ struct fifo * q;
+ int loops = 0;
+
+ TRACE_ENTRY( "%p", queue );
+
+ CHECK_PARAMS( queue && CHECK_FIFO( *queue ) );
+
+ q = *queue;
+
+ CHECK_POSIX( pthread_mutex_lock( &q->mtx ) );
+
+ if ((q->count != 0) || (q->data != NULL)) {
+ TRACE_DEBUG(INFO, "The queue cannot be destroyed (%d, %p)", q->count, q->data);
+ CHECK_POSIX_DO( pthread_mutex_unlock( &q->mtx ), /* no fallback */ );
+ return EINVAL;
+ }
+
+ /* Ok, now invalidate the queue */
+ q->eyec = 0xdead;
+
+ /* Have all waiting threads return an error */
+ while (q->thrs) {
+ CHECK_POSIX( pthread_mutex_unlock( &q->mtx ));
+ CHECK_POSIX( pthread_cond_signal(&q->cond_pull) );
+ usleep(1000);
+
+ CHECK_POSIX( pthread_mutex_lock( &q->mtx ) );
+ ASSERT( ++loops < 20 ); /* detect infinite loops */
+ }
+
+ /* sanity check */
+ ASSERT(FD_IS_LIST_EMPTY(&q->list));
+
+ /* And destroy it */
+ CHECK_POSIX( pthread_mutex_unlock( &q->mtx ) );
+
+ CHECK_POSIX_DO( pthread_cond_destroy( &q->cond_pull ), );
+
+ CHECK_POSIX_DO( pthread_cond_destroy( &q->cond_push ), );
+
+ CHECK_POSIX_DO( pthread_mutex_destroy( &q->mtx ), );
+
+ free(q);
+ *queue = NULL;
+
+ return 0;
+}
+
+/* Move the content of old into new, and update loc_update atomically. We leave the old queue empty but valid */
+int fd_fifo_move ( struct fifo * old, struct fifo * new, struct fifo ** loc_update )
+{
+ int loops = 0;
+
+ TRACE_ENTRY("%p %p %p", old, new, loc_update);
+ CHECK_PARAMS( CHECK_FIFO( old ) && CHECK_FIFO( new ));
+
+ CHECK_PARAMS( ! old->data );
+ if (new->high) {
+ TODO("Implement support for thresholds in fd_fifo_move...");
+ }
+
+ /* Update loc_update */
+ if (loc_update)
+ *loc_update = new;
+
+ /* Lock the queues */
+ CHECK_POSIX( pthread_mutex_lock( &old->mtx ) );
+
+ CHECK_PARAMS_DO( (! old->thrs_push), {
+ pthread_mutex_unlock( &old->mtx );
+ return EINVAL;
+ } );
+
+ CHECK_POSIX( pthread_mutex_lock( &new->mtx ) );
+
+ /* Any waiting thread on the old queue returns an error */
+ old->eyec = 0xdead;
+ while (old->thrs) {
+ CHECK_POSIX( pthread_mutex_unlock( &old->mtx ));
+ CHECK_POSIX( pthread_cond_signal( &old->cond_pull ) );
+ usleep(1000);
+
+ CHECK_POSIX( pthread_mutex_lock( &old->mtx ) );
+ ASSERT( loops < 20 ); /* detect infinite loops */
+ }
+
+ /* Move all data from old to new */
+ fd_list_move_end( &new->list, &old->list );
+ if (old->count && (!new->count)) {
+ CHECK_POSIX( pthread_cond_signal(&new->cond_pull) );
+ }
+ new->count += old->count;
+
+ /* Reset old */
+ old->count = 0;
+ old->eyec = FIFO_EYEC;
+
+ /* Merge the stats in the new queue */
+ new->total_items += old->total_items;
+ old->total_items = 0;
+
+ new->total_time.tv_nsec += old->total_time.tv_nsec;
+ new->total_time.tv_sec += old->total_time.tv_sec + (new->total_time.tv_nsec / 1000000000);
+ new->total_time.tv_nsec %= 1000000000;
+ old->total_time.tv_nsec = 0;
+ old->total_time.tv_sec = 0;
+
+ new->blocking_time.tv_nsec += old->blocking_time.tv_nsec;
+ new->blocking_time.tv_sec += old->blocking_time.tv_sec + (new->blocking_time.tv_nsec / 1000000000);
+ new->blocking_time.tv_nsec %= 1000000000;
+ old->blocking_time.tv_nsec = 0;
+ old->blocking_time.tv_sec = 0;
+
+ /* Unlock, we're done */
+ CHECK_POSIX( pthread_mutex_unlock( &new->mtx ) );
+ CHECK_POSIX( pthread_mutex_unlock( &old->mtx ) );
+
+ return 0;
+}
+
+/* Get the information on the queue */
+int fd_fifo_getstats( struct fifo * queue, int * current_count, int * limit_count, int * highest_count, long long * total_count,
+ struct timespec * total, struct timespec * blocking, struct timespec * last)
+{
+ TRACE_ENTRY( "%p %p %p %p %p %p %p %p", queue, current_count, limit_count, highest_count, total_count, total, blocking, last);
+
+ /* Check the parameters */
+ CHECK_PARAMS( CHECK_FIFO( queue ) );
+
+ /* lock the queue */
+ CHECK_POSIX( pthread_mutex_lock( &queue->mtx ) );
+
+ if (current_count)
+ *current_count = queue->count;
+
+ if (limit_count)
+ *limit_count = queue->max;
+
+ if (highest_count)
+ *highest_count = queue->highest_ever;
+
+ if (total_count)
+ *total_count = queue->total_items;
+
+ if (total)
+ memcpy(total, &queue->total_time, sizeof(struct timespec));
+
+ if (blocking)
+ memcpy(blocking, &queue->blocking_time, sizeof(struct timespec));
+
+ if (last)
+ memcpy(last, &queue->last_time, sizeof(struct timespec));
+
+ /* Unlock */
+ CHECK_POSIX( pthread_mutex_unlock( &queue->mtx ) );
+
+ /* Done */
+ return 0;
+}
+
+
+/* alternate version with no error checking */
+int fd_fifo_length ( struct fifo * queue )
+{
+ if ( !CHECK_FIFO( queue ) )
+ return 0;
+
+ return queue->count; /* Let's hope it's read atomically, since we are not locking... */
+}
+
+/* Set the thresholds of the queue */
+int fd_fifo_setthrhd ( struct fifo * queue, void * data, uint16_t high, void (*h_cb)(struct fifo *, void **), uint16_t low, void (*l_cb)(struct fifo *, void **) )
+{
+ TRACE_ENTRY( "%p %p %hu %p %hu %p", queue, data, high, h_cb, low, l_cb );
+
+ /* Check the parameters */
+ CHECK_PARAMS( CHECK_FIFO( queue ) && (high > low) && (queue->data == NULL) );
+
+ /* lock the queue */
+ CHECK_POSIX( pthread_mutex_lock( &queue->mtx ) );
+
+ /* Save the values */
+ queue->high = high;
+ queue->low = low;
+ queue->data = data;
+ queue->h_cb = h_cb;
+ queue->l_cb = l_cb;
+
+ /* Unlock */
+ CHECK_POSIX( pthread_mutex_unlock( &queue->mtx ) );
+
+ /* Done */
+ return 0;
+}
+
+
+/* This handler is called when a thread is blocked on a queue, and cancelled */
+static void fifo_cleanup_push(void * queue)
+{
+ struct fifo * q = (struct fifo *)queue;
+ TRACE_ENTRY( "%p", queue );
+
+ /* The thread has been cancelled, therefore it does not wait on the queue anymore */
+ q->thrs_push--;
+
+ /* Now unlock the queue, and we're done */
+ CHECK_POSIX_DO( pthread_mutex_unlock( &q->mtx ), /* nothing */ );
+
+ /* End of cleanup handler */
+ return;
+}
+
+
+/* Post a new item in the queue */
+int fd_fifo_post_internal ( struct fifo * queue, void ** item, int skip_max )
+{
+ struct fifo_item * new;
+ int call_cb = 0;
+ struct timespec posted_on, queued_on;
+
+ /* Get the timing of this call */
+ CHECK_SYS( clock_gettime(CLOCK_REALTIME, &posted_on) );
+
+ /* lock the queue */
+ CHECK_POSIX( pthread_mutex_lock( &queue->mtx ) );
+
+ if ((!skip_max) && (queue->max)) {
+ while (queue->count >= queue->max) {
+ int ret = 0;
+
+ /* We have to wait for an item to be pulled */
+ queue->thrs_push++ ;
+ pthread_cleanup_push( fifo_cleanup_push, queue);
+ ret = pthread_cond_wait( &queue->cond_push, &queue->mtx );
+ pthread_cleanup_pop(0);
+ queue->thrs_push-- ;
+
+ ASSERT( ret == 0 );
+ }
+ }
+
+ /* Create a new list item */
+ CHECK_MALLOC_DO( new = malloc (sizeof (struct fifo_item)) , {
+ pthread_mutex_unlock( &queue->mtx );
+ return ENOMEM;
+ } );
+
+ fd_list_init(&new->item, *item);
+ *item = NULL;
+
+ /* Add the new item at the end */
+ fd_list_insert_before( &queue->list, &new->item);
+ queue->count++;
+ if (queue->highest_ever < queue->count)
+ queue->highest_ever = queue->count;
+ if (queue->high && ((queue->count % queue->high) == 0)) {
+ call_cb = 1;
+ queue->highest = queue->count;
+ }
+
+ /* store timing */
+ memcpy(&new->posted_on, &posted_on, sizeof(struct timespec));
+
+ /* update queue timing info "blocking time" */
+ {
+ long long blocked_ns;
+ CHECK_SYS( clock_gettime(CLOCK_REALTIME, &queued_on) );
+ blocked_ns = (queued_on.tv_sec - posted_on.tv_sec) * 1000000000;
+ blocked_ns += (queued_on.tv_nsec - posted_on.tv_nsec);
+ blocked_ns += queue->blocking_time.tv_nsec;
+ queue->blocking_time.tv_sec += blocked_ns / 1000000000;
+ queue->blocking_time.tv_nsec = blocked_ns % 1000000000;
+ }
+
+ /* Signal if threads are asleep */
+ if (queue->thrs > 0) {
+ CHECK_POSIX( pthread_cond_signal(&queue->cond_pull) );
+ }
+ if (queue->thrs_push > 0) {
+ /* cascade */
+ CHECK_POSIX( pthread_cond_signal(&queue->cond_push) );
+ }
+
+ /* Unlock */
+ CHECK_POSIX( pthread_mutex_unlock( &queue->mtx ) );
+
+ /* Call high-watermark cb as needed */
+ if (call_cb && queue->h_cb)
+ (*queue->h_cb)(queue, &queue->data);
+
+ /* Done */
+ return 0;
+}
+
+/* Post a new item in the queue */
+int fd_fifo_post_int ( struct fifo * queue, void ** item )
+{
+ TRACE_ENTRY( "%p %p", queue, item );
+
+ /* Check the parameters */
+ CHECK_PARAMS( CHECK_FIFO( queue ) && item && *item );
+
+ return fd_fifo_post_internal ( queue,item, 0 );
+
+}
+
+/* Post a new item in the queue, not blocking */
+int fd_fifo_post_noblock ( struct fifo * queue, void ** item )
+{
+ TRACE_ENTRY( "%p %p", queue, item );
+
+ /* Check the parameters */
+ CHECK_PARAMS( CHECK_FIFO( queue ) && item && *item );
+
+ return fd_fifo_post_internal ( queue,item, 1 );
+
+}
+
+/* Pop the first item from the queue */
+static void * mq_pop(struct fifo * queue)
+{
+ void * ret = NULL;
+ struct fifo_item * fi;
+ struct timespec now;
+
+ ASSERT( ! FD_IS_LIST_EMPTY(&queue->list) );
+
+ fi = (struct fifo_item *)(queue->list.next);
+ ret = fi->item.o;
+ fd_list_unlink(&fi->item);
+ queue->count--;
+ queue->total_items++;
+
+ /* Update the timings */
+ CHECK_SYS_DO( clock_gettime(CLOCK_REALTIME, &now), goto skip_timing );
+ {
+ long long elapsed = (now.tv_sec - fi->posted_on.tv_sec) * 1000000000;
+ elapsed += now.tv_nsec - fi->posted_on.tv_nsec;
+
+ queue->last_time.tv_sec = elapsed / 1000000000;
+ queue->last_time.tv_nsec = elapsed % 1000000000;
+
+ elapsed += queue->total_time.tv_nsec;
+ queue->total_time.tv_sec += elapsed / 1000000000;
+ queue->total_time.tv_nsec = elapsed % 1000000000;
+ }
+skip_timing:
+ free(fi);
+
+ if (queue->thrs_push) {
+ CHECK_POSIX_DO( pthread_cond_signal( &queue->cond_push ), );
+ }
+
+ return ret;
+}
+
+/* Check if the low watermark callback must be called. */
+static __inline__ int test_l_cb(struct fifo * queue)
+{
+ if ((queue->high == 0) || (queue->low == 0) || (queue->l_cb == 0))
+ return 0;
+
+ if (((queue->count % queue->high) == queue->low) && (queue->highest > queue->count)) {
+ queue->highest -= queue->high;
+ return 1;
+ }
+
+ return 0;
+}
+
+/* Try poping an item */
+int fd_fifo_tryget_int ( struct fifo * queue, void ** item )
+{
+ int wouldblock = 0;
+ int call_cb = 0;
+
+ TRACE_ENTRY( "%p %p", queue, item );
+
+ /* Check the parameters */
+ CHECK_PARAMS( CHECK_FIFO( queue ) && item );
+
+ /* lock the queue */
+ CHECK_POSIX( pthread_mutex_lock( &queue->mtx ) );
+
+ /* Check queue status */
+ if (queue->count > 0) {
+got_item:
+ /* There are elements in the queue, so pick the first one */
+ *item = mq_pop(queue);
+ call_cb = test_l_cb(queue);
+ } else {
+ if (queue->thrs_push > 0) {
+ /* A thread is trying to push something, let's give it a chance */
+ CHECK_POSIX( pthread_mutex_unlock( &queue->mtx ) );
+ CHECK_POSIX( pthread_cond_signal( &queue->cond_push ) );
+ usleep(1000);
+ CHECK_POSIX( pthread_mutex_lock( &queue->mtx ) );
+ if (queue->count > 0)
+ goto got_item;
+ }
+
+ wouldblock = 1;
+ *item = NULL;
+ }
+
+ /* Unlock */
+ CHECK_POSIX( pthread_mutex_unlock( &queue->mtx ) );
+
+ /* Call low watermark callback as needed */
+ if (call_cb)
+ (*queue->l_cb)(queue, &queue->data);
+
+ /* Done */
+ return wouldblock ? EWOULDBLOCK : 0;
+}
+
+/* This handler is called when a thread is blocked on a queue, and cancelled */
+static void fifo_cleanup(void * queue)
+{
+ struct fifo * q = (struct fifo *)queue;
+ TRACE_ENTRY( "%p", queue );
+
+ /* The thread has been cancelled, therefore it does not wait on the queue anymore */
+ q->thrs--;
+
+ /* Now unlock the queue, and we're done */
+ CHECK_POSIX_DO( pthread_mutex_unlock( &q->mtx ), /* nothing */ );
+
+ /* End of cleanup handler */
+ return;
+}
+
+/* The internal function for fd_fifo_timedget and fd_fifo_get */
+static int fifo_tget ( struct fifo * queue, void ** item, int istimed, const struct timespec *abstime)
+{
+ int call_cb = 0;
+ int ret = 0;
+
+ /* Check the parameters */
+ CHECK_PARAMS( CHECK_FIFO( queue ) && item && (abstime || !istimed) );
+
+ /* Initialize the return value */
+ *item = NULL;
+
+ /* lock the queue */
+ CHECK_POSIX( pthread_mutex_lock( &queue->mtx ) );
+
+awaken:
+ /* Check queue status */
+ if (!CHECK_FIFO( queue )) {
+ /* The queue is being destroyed */
+ CHECK_POSIX( pthread_mutex_unlock( &queue->mtx ) );
+ TRACE_DEBUG(FULL, "The queue is being destroyed -> EPIPE");
+ return EPIPE;
+ }
+
+ if (queue->count > 0) {
+ /* There are items in the queue, so pick the first one */
+ *item = mq_pop(queue);
+ call_cb = test_l_cb(queue);
+ } else {
+ /* We have to wait for a new item */
+ queue->thrs++ ;
+ pthread_cleanup_push( fifo_cleanup, queue);
+ if (istimed) {
+ ret = pthread_cond_timedwait( &queue->cond_pull, &queue->mtx, abstime );
+ } else {
+ ret = pthread_cond_wait( &queue->cond_pull, &queue->mtx );
+ }
+ pthread_cleanup_pop(0);
+ queue->thrs-- ;
+ if (ret == 0)
+ goto awaken; /* test for spurious wake-ups */
+
+ /* otherwise (ETIMEDOUT / other error) just continue */
+ }
+
+ /* Unlock */
+ CHECK_POSIX( pthread_mutex_unlock( &queue->mtx ) );
+
+ /* Call low watermark callback as needed */
+ if (call_cb)
+ (*queue->l_cb)(queue, &queue->data);
+
+ /* Done */
+ return ret;
+}
+
+/* Get the next available item, block until there is one */
+int fd_fifo_get_int ( struct fifo * queue, void ** item )
+{
+ TRACE_ENTRY( "%p %p", queue, item );
+ return fifo_tget(queue, item, 0, NULL);
+}
+
+/* Get the next available item, block until there is one, or the timeout expires */
+int fd_fifo_timedget_int ( struct fifo * queue, void ** item, const struct timespec *abstime )
+{
+ TRACE_ENTRY( "%p %p %p", queue, item, abstime );
+ return fifo_tget(queue, item, 1, abstime);
+}
+
+/* Test if data is available in the queue, without pulling it */
+int fd_fifo_select ( struct fifo * queue, const struct timespec *abstime )
+{
+ int ret = 0;
+ TRACE_ENTRY( "%p %p", queue, abstime );
+
+ CHECK_PARAMS_DO( CHECK_FIFO( queue ), return -EINVAL );
+
+ /* lock the queue */
+ CHECK_POSIX_DO( pthread_mutex_lock( &queue->mtx ), return -__ret__ );
+
+awaken:
+ ret = (queue->count > 0 ) ? queue->count : 0;
+ if ((ret == 0) && (abstime != NULL)) {
+ /* We have to wait for a new item */
+ queue->thrs++ ;
+ pthread_cleanup_push( fifo_cleanup, queue);
+ ret = pthread_cond_timedwait( &queue->cond_pull, &queue->mtx, abstime );
+ pthread_cleanup_pop(0);
+ queue->thrs-- ;
+ if (ret == 0)
+ goto awaken; /* test for spurious wake-ups */
+
+ if (ret == ETIMEDOUT)
+ ret = 0;
+ else
+ ret = -ret;
+ }
+
+ /* Unlock */
+ CHECK_POSIX_DO( pthread_mutex_unlock( &queue->mtx ), return -__ret__ );
+
+ return ret;
+}
diff --git a/libfdproto/init.c b/libfdproto/init.c
new file mode 100644
index 0000000..5519ca6
--- /dev/null
+++ b/libfdproto/init.c
@@ -0,0 +1,71 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2013, 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. *
+*********************************************************************************************************/
+
+#include "fdproto-internal.h"
+
+/* function to free the threadnames */
+static void freelogstr(void * str) {
+ if (TRACE_BOOL(ANNOYING)) {
+ if (str) {
+ fd_log_debug("(Thread '%s' terminating)", (char *)str);
+ }
+ }
+ free(str);
+}
+
+/* Initialize library variables and threads */
+int fd_libproto_init()
+{
+ int ret = 0;
+
+ /* Create the thread key that contains thread name for debug messages */
+ ret = pthread_key_create(&fd_log_thname, freelogstr);
+ if (ret != 0) {
+ fprintf(stderr, "Error initializing the libfreeDiameter library: %s\n", strerror(ret) );
+ return ret;
+ }
+
+ /* Initialize the modules that need it */
+ fd_msg_eteid_init();
+ CHECK_FCT( fd_sess_init() );
+
+ return 0;
+}
+
+/* Stop all threads created in the library */
+void fd_libproto_fini(void)
+{
+ fd_sess_fini();
+}
diff --git a/libfdproto/lists.c b/libfdproto/lists.c
new file mode 100644
index 0000000..2aa1429
--- /dev/null
+++ b/libfdproto/lists.c
@@ -0,0 +1,168 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2013, 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. *
+*********************************************************************************************************/
+
+#include "fdproto-internal.h"
+
+/* Initialize a list element */
+void fd_list_init ( struct fd_list * list, void * obj )
+{
+ memset(list, 0, sizeof(struct fd_list));
+ list->next = list;
+ list->prev = list;
+ list->head = list;
+ list->o = obj;
+}
+
+#define CHECK_SINGLE( li ) { \
+ ASSERT( ((struct fd_list *)(li))->next == (li) ); \
+ ASSERT( ((struct fd_list *)(li))->prev == (li) ); \
+ ASSERT( ((struct fd_list *)(li))->head == (li) ); \
+}
+
+/* insert after a reference, checks done */
+static void list_insert_after( struct fd_list * ref, struct fd_list * item )
+{
+ item->prev = ref;
+ item->next = ref->next;
+ item->head = ref->head;
+ ref->next->prev = item;
+ ref->next = item;
+}
+
+/* insert after a reference */
+void fd_list_insert_after ( struct fd_list * ref, struct fd_list * item )
+{
+ ASSERT(item != NULL);
+ ASSERT(ref != NULL);
+ CHECK_SINGLE ( item );
+ ASSERT(ref->head != item);
+ list_insert_after(ref, item);
+}
+
+/* Move all elements of list senti at the end of list ref */
+void fd_list_move_end(struct fd_list * ref, struct fd_list * senti)
+{
+ struct fd_list * li;
+ ASSERT(ref->head == ref);
+ ASSERT(senti->head == senti);
+
+ if (senti->next == senti)
+ return;
+
+ for (li = senti->next; li != senti; li = li->next)
+ li->head = ref;
+
+ senti->next->prev = ref->prev;
+ ref->prev->next = senti->next;
+ senti->prev->next = ref;
+ ref->prev = senti->prev;
+ senti->prev = senti;
+ senti->next = senti;
+}
+
+/* insert before a reference, checks done */
+static void list_insert_before ( struct fd_list * ref, struct fd_list * item )
+{
+ item->prev = ref->prev;
+ item->next = ref;
+ item->head = ref->head;
+ ref->prev->next = item;
+ ref->prev = item;
+}
+
+/* insert before a reference */
+void fd_list_insert_before ( struct fd_list * ref, struct fd_list * item )
+{
+ ASSERT(item != NULL);
+ ASSERT(ref != NULL);
+ CHECK_SINGLE ( item );
+ ASSERT(ref->head != item);
+ list_insert_before(ref, item);
+}
+
+/* Insert an item in an ordered list -- ordering function provided. If duplicate object found, it is returned in ref_duplicate */
+int fd_list_insert_ordered( struct fd_list * head, struct fd_list * item, int (*cmp_fct)(void *, void *), void ** ref_duplicate)
+{
+ struct fd_list * ptr = head;
+ int cmp;
+
+ /* Some debug sanity checks */
+ ASSERT(head != NULL);
+ ASSERT(item != NULL);
+ ASSERT(cmp_fct != NULL);
+ ASSERT(head->head == head);
+ CHECK_SINGLE ( item );
+
+ /* loop in the list */
+ while (ptr->next != head)
+ {
+ /* Compare the object to insert with the next object in list */
+ cmp = cmp_fct( item->o, ptr->next->o );
+ if (!cmp) {
+ /* An element with the same key already exists */
+ if (ref_duplicate != NULL)
+ *ref_duplicate = ptr->next->o;
+ return EEXIST;
+ }
+
+ if (cmp < 0)
+ break; /* We must insert the element here */
+
+ ptr = ptr->next;
+ }
+
+ /* Now insert the element between ptr and ptr->next */
+ list_insert_after( ptr, item );
+
+ /* Ok */
+ return 0;
+}
+
+/* Unlink an object */
+void fd_list_unlink ( struct fd_list * item )
+{
+ ASSERT(item != NULL);
+ if (item->head == item)
+ return;
+ /* unlink */
+ item->next->prev = item->prev;
+ item->prev->next = item->next;
+ /* sanitize */
+ item->next = item;
+ item->prev = item;
+ item->head = item;
+}
+
+
diff --git a/libfdproto/log.c b/libfdproto/log.c
new file mode 100644
index 0000000..7bbe307
--- /dev/null
+++ b/libfdproto/log.c
@@ -0,0 +1,325 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2015, 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. *
+*********************************************************************************************************/
+
+#include "fdproto-internal.h"
+
+#include <stdarg.h>
+
+pthread_mutex_t fd_log_lock = PTHREAD_MUTEX_INITIALIZER;
+pthread_key_t fd_log_thname;
+int fd_g_debug_lvl = FD_LOG_NOTICE;
+
+static void fd_internal_logger( int, const char *, va_list );
+static int use_colors = 0; /* 0: not init, 1: yes, 2: no */
+
+/* These may be used to pass specific debug requests via the command-line parameters */
+char * fd_debug_one_function = NULL;
+char * fd_debug_one_file = NULL;
+
+/* Useless function, only to ease setting up a breakpoint in gdb (break fd_breakhere) -- use TRACE_HERE */
+int fd_breaks = 0;
+int fd_breakhere(void) { return ++fd_breaks; }
+
+/* Allow passing of the log and debug information from base stack to extensions */
+void (*fd_logger)( int loglevel, const char * format, va_list args ) = fd_internal_logger;
+
+/* Register an external call back for tracing and debug */
+int fd_log_handler_register( void (*logger)(int loglevel, const char * format, va_list args) )
+{
+ CHECK_PARAMS( logger );
+
+ if ( fd_logger != fd_internal_logger )
+ {
+ return EALREADY; /* only one registration allowed */
+ }
+ else
+ {
+ fd_logger = logger;
+ }
+
+ return 0;
+}
+
+/* Implement a simple reset function here */
+int fd_log_handler_unregister ( void )
+{
+ fd_logger = fd_internal_logger;
+ return 0; /* Successfull in all cases. */
+}
+
+static void fd_cleanup_mutex_silent( void * mutex )
+{
+ (void)pthread_mutex_unlock((pthread_mutex_t *)mutex);
+}
+
+
+static void fd_internal_logger( int printlevel, const char *format, va_list ap )
+{
+ char buf[25];
+
+ /* Do we need to trace this ? */
+ if (printlevel < fd_g_debug_lvl)
+ return;
+
+ /* add timestamp */
+ printf("%s ", fd_log_time(NULL, buf, sizeof(buf),
+#if (defined(DEBUG) && defined(DEBUG_WITH_META))
+ 1, 1
+#else /* (defined(DEBUG) && defined(DEBUG_WITH_META)) */
+ 0, 0
+#endif /* (defined(DEBUG) && defined(DEBUG_WITH_META)) */
+ ));
+ /* Use colors on stdout ? */
+ if (!use_colors) {
+ if (isatty(STDOUT_FILENO))
+ use_colors = 1;
+ else
+ use_colors = 2;
+ }
+
+ switch(printlevel) {
+ case FD_LOG_ANNOYING: printf("%s A ", (use_colors == 1) ? "\e[0;37m" : ""); break;
+ case FD_LOG_DEBUG: printf("%s DBG ", (use_colors == 1) ? "\e[0;37m" : ""); break;
+ case FD_LOG_NOTICE: printf("%sNOTI ", (use_colors == 1) ? "\e[1;37m" : ""); break;
+ case FD_LOG_ERROR: printf("%sERROR ", (use_colors == 1) ? "\e[0;31m" : ""); break;
+ case FD_LOG_FATAL: printf("%sFATAL! ", (use_colors == 1) ? "\e[0;31m" : ""); break;
+ default: printf("%s ??? ", (use_colors == 1) ? "\e[0;31m" : "");
+ }
+ vprintf(format, ap);
+ if (use_colors == 1)
+ printf("\e[00m");
+ printf("\n");
+
+ fflush(stdout);
+}
+
+/* Log a debug message */
+void fd_log ( int loglevel, const char * format, ... )
+{
+ va_list ap;
+
+ (void)pthread_mutex_lock(&fd_log_lock);
+
+ pthread_cleanup_push(fd_cleanup_mutex_silent, &fd_log_lock);
+
+ va_start(ap, format);
+ fd_logger(loglevel, format, ap);
+ va_end(ap);
+
+ pthread_cleanup_pop(0);
+
+ (void)pthread_mutex_unlock(&fd_log_lock);
+}
+
+/* Log a debug message */
+void fd_log_va ( int loglevel, const char * format, va_list args )
+{
+ (void)pthread_mutex_lock(&fd_log_lock);
+
+ pthread_cleanup_push(fd_cleanup_mutex_silent, &fd_log_lock);
+ fd_logger(loglevel, format, args);
+ pthread_cleanup_pop(0);
+
+ (void)pthread_mutex_unlock(&fd_log_lock);
+}
+
+/* Function to set the thread's friendly name */
+void fd_log_threadname ( const char * name )
+{
+ void * val = NULL;
+
+ TRACE_ENTRY("%p(%s)", name, name?:"/");
+
+ /* First, check if a value is already assigned to the current thread */
+ val = pthread_getspecific(fd_log_thname);
+ if (TRACE_BOOL(ANNOYING)) {
+ if (val) {
+ fd_log_debug("(Thread '%s' renamed to '%s')", (char *)val, name?:"(nil)");
+ } else {
+ fd_log_debug("(Thread %p named '%s')", (void *)pthread_self(), name?:"(nil)");
+ }
+ }
+ if (val != NULL) {
+ free(val);
+ }
+
+ /* Now create the new string */
+ if (name == NULL) {
+ CHECK_POSIX_DO( pthread_setspecific(fd_log_thname, NULL), /* continue */);
+ return;
+ }
+
+ CHECK_MALLOC_DO( val = strdup(name), return );
+
+ CHECK_POSIX_DO( pthread_setspecific(fd_log_thname, val), /* continue */);
+ return;
+}
+
+/* Write time into a buffer */
+char * fd_log_time ( struct timespec * ts, char * buf, size_t len, int incl_date, int incl_ms )
+{
+ int ret;
+ size_t offset = 0;
+ struct timespec tp;
+ struct tm tm;
+
+ /* Get current time */
+ if (!ts) {
+ ret = clock_gettime(CLOCK_REALTIME, &tp);
+ if (ret != 0) {
+ snprintf(buf, len, "%s", strerror(ret));
+ return buf;
+ }
+ ts = &tp;
+ }
+
+ offset += strftime(buf + offset, len - offset, incl_date?"%D,%T":"%T", localtime_r( &ts->tv_sec , &tm ));
+ if (incl_ms)
+ offset += snprintf(buf + offset, len - offset, ".%6.6ld", ts->tv_nsec / 1000);
+
+ return buf;
+}
+
+
+static size_t sys_mempagesz = 0;
+
+static size_t get_mempagesz(void) {
+ if (!sys_mempagesz) {
+ sys_mempagesz = sysconf(_SC_PAGESIZE); /* We alloc buffer by memory pages for efficiency. This can be readjusted if too memory consuming */
+ if (sys_mempagesz <= 0)
+ sys_mempagesz = 256; /* default size if above call failed */
+ }
+ return sys_mempagesz;
+}
+
+
+/* Helper function for fd_*_dump. Prints the format string from 'offset' into '*buf', extends if needed. The location of buf can be updated by this function. */
+char * fd_dump_extend(char ** buf, size_t *len, size_t *offset, const char * format, ... )
+{
+ va_list ap;
+ int to_write;
+ size_t o = 0;
+ size_t mempagesz = get_mempagesz();
+
+ /* we do not TRACE_ENTRY this one on purpose */
+
+ CHECK_PARAMS_DO(buf && len, return NULL);
+
+ if (*buf == NULL) {
+ CHECK_MALLOC_DO(*buf = malloc(mempagesz), return NULL);
+ *len = mempagesz;
+ }
+
+ if (offset)
+ o = *offset;
+
+ va_start(ap, format);
+ to_write = vsnprintf(*buf + o, *len - o, format, ap);
+ va_end(ap);
+
+ if (to_write + o >= *len) {
+ /* There was no room in the buffer, we extend and redo */
+ size_t new_len = (((to_write + o) / mempagesz) + 1) * mempagesz;
+ CHECK_MALLOC_DO(*buf = realloc(*buf, new_len), return NULL);
+ *len = new_len;
+
+ va_start(ap, format);
+ to_write = vsnprintf(*buf + o, *len - o, format, ap);
+ va_end(ap);
+ }
+
+ if (offset)
+ *offset += to_write;
+
+ return *buf;
+}
+
+char * fd_dump_extend_hexdump(char ** buf, size_t *len, size_t *offset, uint8_t *data, size_t datalen, size_t trunc, size_t wrap )
+{
+ int truncated = 0;
+ size_t towrite = 0;
+ size_t o = 0;
+ int i;
+ char * p;
+ size_t mempagesz = get_mempagesz();
+#define TRUNK_MARK "[...]"
+
+ CHECK_PARAMS_DO(buf && len && data, return NULL);
+
+ if (trunc && (datalen > trunc)) {
+ datalen = trunc;
+ truncated = 1;
+ }
+
+ towrite = datalen * 2;
+
+ if (wrap)
+ towrite += datalen / wrap; /* add 1 '\n' every wrap byte */
+
+ if (truncated)
+ towrite += CONSTSTRLEN(TRUNK_MARK);
+
+
+ if (offset)
+ o = *offset;
+
+ if (*buf == NULL) {
+ /* Directly allocate the size we need */
+ *len = (((towrite + o) / mempagesz) + 1 ) * mempagesz;
+ CHECK_MALLOC_DO(*buf = malloc(*len), return NULL);
+ } else if ((towrite + o) >= *len) {
+ /* There is no room in the buffer, we extend and redo */
+ size_t new_len = (((towrite + o) / mempagesz) + 1) * mempagesz;
+ CHECK_MALLOC_DO(*buf = realloc(*buf, new_len), return NULL);
+ *len = new_len;
+ }
+
+ p = *buf + o;
+ for (i = 0; i < datalen; i++) {
+ sprintf(p, "%02hhX", data[i]);
+ p+=2;
+ if ((wrap) && ((i+1) % wrap == 0)) {
+ *p++='\n'; *p ='\0'; /* we want to ensure the buffer is always 0-terminated */
+ }
+ }
+
+ if (truncated)
+ memcpy(p, TRUNK_MARK, CONSTSTRLEN(TRUNK_MARK));
+
+ if (offset)
+ *offset += towrite;
+
+ return *buf;
+}
diff --git a/libfdproto/messages.c b/libfdproto/messages.c
new file mode 100644
index 0000000..3da8d2e
--- /dev/null
+++ b/libfdproto/messages.c
@@ -0,0 +1,2850 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2015, 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;
+}
+
+int fd_msg_new ( struct dict_object * model, int flags, struct msg ** msg )
+{
+ return fd_msg_new_appl( model, NULL, flags, msg );
+}
+
+/* Create a new message instance */
+int fd_msg_new_appl ( struct dict_object * model, struct dict_object * appl, 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 */
+ if (appl)
+ dictappl = appl;
+ else
+ 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 informations 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 */
+int fd_msg_search_avp ( struct msg * msg, 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", msg, what, avp);
+
+ CHECK_PARAMS( CHECK_MSG(msg) && what );
+
+ CHECK_PARAMS( (fd_dict_gettype(what, &dicttype) == 0) && (dicttype == DICT_AVP) );
+ CHECK_FCT( fd_dict_getval(what, &dictdata) );
+
+ /* Loop on all top AVPs */
+ CHECK_FCT( fd_msg_browse(msg, 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 */
+ 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 */
+
+/* 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);
+ } else {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "%s(%u)[" DUMP_AVPFL_str "]=",
+ success ? dictdata.avp_name : "unknown", avp->avp_public.avp_code, DUMP_AVPFL_val(avp->avp_public.avp_flags)), return NULL);
+ }
+
+
+ if (success && (dictdata.avp_basetype == AVP_TYPE_GROUPED)) {
+ 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_full(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);
+ }
+ }
+
+end:
+ if (level) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " }"), return NULL);
+ }
+
+ return *buf;
+}
+
+/* one-line dump with all the contents of the message */
+DECLARE_FD_DUMP_PROTOTYPE( fd_msg_dump_full, msg_or_avp *obj, struct dictionary *dict, int force_parsing, int recurse )
+{
+ return msg_dump_process(FD_DUMP_STD_PARAMS, msg_format_full, avp_format_full, obj, dict, force_parsing, recurse);
+}
+
+
+
+/*
+ * One-line dumper for compact but complete traces
+ */
+static DECLARE_FD_DUMP_PROTOTYPE( msg_format_summary, 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) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(no model)"), return NULL);
+ } else {
+ enum dict_object_type dicttype;
+ struct dict_cmd_data dictdata;
+ if (fd_dict_gettype(msg->msg_model, &dicttype) || (dicttype != DICT_COMMAND) || (fd_dict_getval(msg->msg_model, &dictdata))) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(model error)"), return NULL);
+ } else {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "'%s'", dictdata.cmd_name), return NULL);
+ }
+ }
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "%u/%u f:" DUMP_CMDFL_str " src:'%s' len:%d",
+ msg->msg_public.msg_appl, msg->msg_public.msg_code, DUMP_CMDFL_val(msg->msg_public.msg_flags), msg->msg_src_id?:"(nil)", msg->msg_public.msg_length), return NULL);
+
+ return *buf;
+}
+
+static DECLARE_FD_DUMP_PROTOTYPE( avp_format_summary, 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) {
+ if (first) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " {"), return NULL);
+ } else {
+ 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 (!level) {
+ /* We have been called to explicitely dump this AVP, so we parse its name if available */
+ if (!avp->avp_model) {
+ name = "(no model)";
+ } else {
+ enum dict_object_type dicttype;
+ if (fd_dict_gettype(avp->avp_model, &dicttype) || (dicttype != DICT_AVP) || (fd_dict_getval(avp->avp_model, &dictdata))) {
+ name = "(model error)";
+ } 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, " V='%s'(%u)", vendorinfo->vendor_name, avp->avp_public.avp_vendor), return NULL);
+ } else {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " V=%u", avp->avp_public.avp_vendor), return NULL);
+ }
+ }
+
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, " L=%d F=" DUMP_AVPFL_str " V=", avp->avp_public.avp_len, DUMP_AVPFL_val(avp->avp_public.avp_flags)), return NULL);
+
+ if ((!dictinfo) || (dictinfo->avp_basetype != AVP_TYPE_GROUPED)) {
+ 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);
+ }
+ }
+ } else {
+ /* For embedded AVPs, we only display (vendor,) code & length */
+ if (avp->avp_public.avp_flags & AVP_FLAG_VENDOR) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "V:%u/", avp->avp_public.avp_vendor), return NULL);
+ }
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "C:%u/l:%d", avp->avp_public.avp_code, avp->avp_public.avp_len), return NULL);
+ }
+
+end:
+ if ((level) && (last)) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "}"), return NULL);
+ }
+
+ return *buf;
+}
+
+/* This one only prints a short display, does not go into the complete tree */
+DECLARE_FD_DUMP_PROTOTYPE( fd_msg_dump_summary, msg_or_avp *obj, struct dictionary *dict, int force_parsing, int recurse )
+{
+ return msg_dump_process(FD_DUMP_STD_PARAMS, msg_format_summary, avp_format_summary, obj, dict, force_parsing, recurse);
+}
+
+/***************************************************************************************************************/
+/* Simple meta-data management */
+
+/* Retrieve the model of an object */
+int fd_msg_model ( msg_or_avp * reference, struct dict_object ** model )
+{
+ TRACE_ENTRY("%p %p", reference, model);
+
+ /* Check the parameters */
+ CHECK_PARAMS( model && VALIDATE_OBJ(reference) );
+
+ /* copy the model reference */
+ switch (_C(reference)->type) {
+ case MSG_AVP:
+ *model = _A(reference)->avp_model;
+ break;
+
+ case MSG_MSG:
+ *model = _M(reference)->msg_model;
+ break;
+
+ default:
+ CHECK_PARAMS(0);
+ }
+
+ return 0;
+}
+
+/* Retrieve the address of the msg_public field of a message */
+int fd_msg_hdr ( struct msg *msg, struct msg_hdr **pdata )
+{
+ TRACE_ENTRY("%p %p", msg, pdata);
+ CHECK_PARAMS( CHECK_MSG(msg) && pdata );
+
+ *pdata = &msg->msg_public;
+ return 0;
+}
+
+/* Retrieve the address of the avp_public field of an avp */
+int fd_msg_avp_hdr ( struct avp *avp, struct avp_hdr **pdata )
+{
+ TRACE_ENTRY("%p %p", avp, pdata);
+ CHECK_PARAMS( CHECK_AVP(avp) && pdata );
+
+ *pdata = &avp->avp_public;
+ return 0;
+}
+
+/* Associate answers and queries */
+int fd_msg_answ_associate( struct msg * answer, struct msg * query )
+{
+ TRACE_ENTRY( "%p %p", answer, query );
+
+ CHECK_PARAMS( CHECK_MSG(answer) && CHECK_MSG(query) && (answer->msg_query == NULL ) );
+
+ answer->msg_query = query;
+ query->msg_associated = 1;
+
+ return 0;
+}
+
+int fd_msg_answ_getq( struct msg * answer, struct msg ** query )
+{
+ TRACE_ENTRY( "%p %p", answer, query );
+
+ CHECK_PARAMS( CHECK_MSG(answer) && query );
+
+ *query = answer->msg_query;
+
+ return 0;
+}
+
+int fd_msg_answ_detach( struct msg * answer )
+{
+ TRACE_ENTRY( "%p", answer );
+
+ CHECK_PARAMS( CHECK_MSG(answer) );
+
+ answer->msg_query->msg_associated = 0;
+ answer->msg_query = NULL;
+
+ return 0;
+}
+
+/* Associate / get answer callbacks */
+int fd_msg_anscb_associate( struct msg * msg, void ( *anscb)(void *, struct msg **), void * data, void (*expirecb)(void *, DiamId_t, size_t, struct msg **), const struct timespec *timeout )
+{
+ TRACE_ENTRY("%p %p %p %p", msg, anscb, expirecb, data);
+
+ /* Check the parameters */
+ CHECK_PARAMS( CHECK_MSG(msg) );
+
+ if (! (msg->msg_public.msg_flags & CMD_FLAG_REQUEST ))
+ return anscb ? EINVAL : 0; /* we associate with requests only */
+
+ CHECK_PARAMS( (anscb == NULL) || (msg->msg_cb.anscb == NULL) ); /* We are not overwriting a cb */
+ CHECK_PARAMS( (expirecb == NULL) || (msg->msg_cb.expirecb == NULL) ); /* We are not overwriting a cb */
+
+ /* Associate callback and data with the message, if any */
+ if (anscb) {
+ msg->msg_cb.anscb = anscb;
+ msg->msg_cb.data = data;
+ }
+ if (expirecb) {
+ msg->msg_cb.expirecb = expirecb;
+ if (timeout) {
+ memcpy(&msg->msg_cb.timeout, timeout, sizeof(struct timespec));
+ }
+ }
+
+ return 0;
+}
+
+/* Remove a callback */
+int fd_msg_anscb_reset(struct msg * msg, int clear_anscb, int clear_expirecb)
+{
+ TRACE_ENTRY("%p %d %d", msg, clear_anscb, clear_expirecb);
+
+ /* Check the parameters */
+ CHECK_PARAMS( CHECK_MSG(msg) );
+
+ if (clear_anscb) {
+ msg->msg_cb.anscb = NULL;
+ msg->msg_cb.data = NULL;
+ }
+ if (clear_expirecb) {
+ msg->msg_cb.expirecb = NULL;
+ memset(&msg->msg_cb.timeout, 0, sizeof(struct timespec));
+ }
+
+ return 0;
+}
+
+
+int fd_msg_anscb_get( struct msg * msg, void (**anscb)(void *, struct msg **), void (**expirecb)(void *, DiamId_t, size_t, struct msg **), void ** data )
+{
+ TRACE_ENTRY("%p %p %p %p", msg, anscb, expirecb, data);
+
+ /* Check the parameters */
+ CHECK_PARAMS( CHECK_MSG(msg) );
+
+ /* Copy the result */
+ if (anscb)
+ *anscb = msg->msg_cb.anscb;
+ if (data)
+ *data = msg->msg_cb.data;
+ if (expirecb)
+ *expirecb = msg->msg_cb.expirecb;
+
+ return 0;
+}
+
+struct timespec *fd_msg_anscb_gettimeout( struct msg * msg )
+{
+ TRACE_ENTRY("%p", msg);
+
+ /* Check the parameters */
+ CHECK_PARAMS_DO( CHECK_MSG(msg), return NULL );
+
+ if (!msg->msg_cb.timeout.tv_sec) {
+ return NULL;
+ }
+
+ return &msg->msg_cb.timeout;
+}
+
+/* Associate routing lists */
+int fd_msg_rt_associate( struct msg * msg, struct rt_data * rtd )
+{
+ TRACE_ENTRY( "%p %p", msg, rtd );
+
+ CHECK_PARAMS( CHECK_MSG(msg) && rtd );
+
+ msg->msg_rtdata = rtd;
+
+ return 0;
+}
+
+int fd_msg_rt_get( struct msg * msg, struct rt_data ** rtd )
+{
+ TRACE_ENTRY( "%p %p", msg, rtd );
+
+ CHECK_PARAMS( CHECK_MSG(msg) && rtd );
+
+ *rtd = msg->msg_rtdata;
+
+ return 0;
+}
+
+/* Find if a message is routable */
+int fd_msg_is_routable ( struct msg * msg )
+{
+ TRACE_ENTRY("%p", msg);
+
+ CHECK_PARAMS_DO( CHECK_MSG(msg), return 0 /* pretend the message is not routable */ );
+
+ if ( ! msg->msg_routable ) {
+ /* To define if a message is routable, we rely on the "PXY" flag (for application 0). */
+ msg->msg_routable = ((msg->msg_public.msg_appl != 0) || (msg->msg_public.msg_flags & CMD_FLAG_PROXIABLE)) ? 1 : 2;
+
+ /* Note : the 'real' criteria according to the Diameter I-D is that the message is
+ routable if and only if the "Destination-Realm" AVP is required by the command ABNF.
+ We could make a test for this here, but it's more computational work and our test
+ seems accurate (until proven otherwise...) */
+ }
+
+ return (msg->msg_routable == 1) ? 1 : 0;
+}
+
+/* cache the dictionary model for next function to avoid re-searching at every incoming message */
+static struct dict_object *cached_avp_rr_model = NULL;
+static struct dictionary *cached_avp_rr_dict = NULL;
+static pthread_mutex_t cached_avp_rr_lock = PTHREAD_MUTEX_INITIALIZER;
+
+/* Associate source peer */
+int fd_msg_source_set( struct msg * msg, DiamId_t diamid, size_t diamidlen )
+{
+ TRACE_ENTRY( "%p %p %zd", msg, diamid, diamidlen);
+
+ /* Check we received a valid message */
+ CHECK_PARAMS( CHECK_MSG(msg) );
+
+ /* Cleanup any previous source */
+ free(msg->msg_src_id); msg->msg_src_id = NULL; msg->msg_src_id_len = 0;
+
+ /* If the request is to cleanup the source, we are done */
+ if (diamid == NULL) {
+ return 0;
+ }
+
+ /* Otherwise save the new informations */
+ CHECK_MALLOC( msg->msg_src_id = os0dup(diamid, diamidlen) );
+ msg->msg_src_id_len = diamidlen;
+ /* done */
+ return 0;
+}
+
+/* Associate source peer */
+int fd_msg_source_setrr( struct msg * msg, DiamId_t diamid, size_t diamidlen, struct dictionary * dict )
+{
+ struct dict_object *avp_rr_model = NULL;
+ avp_code_t code = AC_ROUTE_RECORD;
+ struct avp *avp;
+ union avp_value val;
+
+ TRACE_ENTRY( "%p %p %zd %p", msg, diamid, diamidlen, dict);
+
+ /* Check we received a valid message */
+ CHECK_PARAMS( CHECK_MSG(msg) && dict );
+
+ /* Lock the cached values */
+ CHECK_POSIX( pthread_mutex_lock(&cached_avp_rr_lock) );
+ if (cached_avp_rr_dict == dict) {
+ avp_rr_model = cached_avp_rr_model;
+ }
+ CHECK_POSIX( pthread_mutex_unlock(&cached_avp_rr_lock) );
+
+ /* If it was not cached */
+ if (!avp_rr_model) {
+ /* Find the model for Route-Record in the dictionary */
+ CHECK_FCT( fd_dict_search ( dict, DICT_AVP, AVP_BY_CODE, &code, &avp_rr_model, ENOENT) );
+
+ /* Now cache this result */
+ CHECK_POSIX( pthread_mutex_lock(&cached_avp_rr_lock) );
+ cached_avp_rr_dict = dict;
+ cached_avp_rr_model = avp_rr_model;
+ CHECK_POSIX( pthread_mutex_unlock(&cached_avp_rr_lock) );
+ }
+
+ /* Create the AVP with this model */
+ CHECK_FCT( fd_msg_avp_new ( avp_rr_model, 0, &avp ) );
+
+ /* Set the AVP value with the diameter id */
+ memset(&val, 0, sizeof(val));
+ val.os.data = (uint8_t *)diamid;
+ val.os.len = diamidlen;
+ CHECK_FCT( fd_msg_avp_setvalue( avp, &val ) );
+
+ /* Add the AVP in the message */
+ CHECK_FCT( fd_msg_avp_add( msg, MSG_BRW_LAST_CHILD, avp ) );
+
+ /* done */
+ return 0;
+}
+
+int fd_msg_source_get( struct msg * msg, DiamId_t* diamid, size_t * diamidlen )
+{
+ TRACE_ENTRY( "%p %p %p", msg, diamid, diamidlen);
+
+ /* Check we received valid parameters */
+ CHECK_PARAMS( CHECK_MSG(msg) );
+ CHECK_PARAMS( diamid );
+
+ /* Copy the informations */
+ *diamid = msg->msg_src_id;
+
+ if (diamidlen)
+ *diamidlen = msg->msg_src_id_len;
+
+ /* done */
+ return 0;
+}
+
+/* Associate a session with a message, use only when the session was just created */
+int fd_msg_sess_set(struct msg * msg, struct session * session)
+{
+ TRACE_ENTRY("%p %p", msg, session);
+
+ /* Check we received valid parameters */
+ CHECK_PARAMS( CHECK_MSG(msg) );
+ CHECK_PARAMS( session );
+ CHECK_PARAMS( msg->msg_sess == NULL );
+
+ msg->msg_sess = session;
+ return 0;
+}
+
+
+/* Retrieve the session of the message */
+int fd_msg_sess_get(struct dictionary * dict, struct msg * msg, struct session ** session, int * new)
+{
+ struct avp * avp;
+
+ TRACE_ENTRY("%p %p %p", msg, session, new);
+
+ /* Check we received valid parameters */
+ CHECK_PARAMS( CHECK_MSG(msg) );
+ CHECK_PARAMS( session );
+
+ /* If we already resolved the session, just send it back */
+ if (msg->msg_sess) {
+ *session = msg->msg_sess;
+ if (new)
+ *new = 0;
+ return 0;
+ }
+
+ /* OK, we have to search for Session-Id AVP -- it is usually the first AVP, but let's be permissive here */
+ /* -- note: we accept messages that have not yet been dictionary parsed... */
+ CHECK_FCT( fd_msg_browse(msg, MSG_BRW_FIRST_CHILD, &avp, NULL) );
+ while (avp) {
+ if ( (avp->avp_public.avp_code == AC_SESSION_ID)
+ && (avp->avp_public.avp_vendor == 0) )
+ break;
+
+ /* Otherwise move to next AVP in the message */
+ CHECK_FCT( fd_msg_browse(avp, MSG_BRW_NEXT, &avp, NULL) );
+ }
+
+ if (!avp) {
+ TRACE_DEBUG(FULL, "No Session-Id AVP found in message %p", msg);
+ *session = NULL;
+ return 0;
+ }
+
+ if (!avp->avp_model) {
+ CHECK_FCT( fd_msg_parse_dict ( avp, dict, NULL ) );
+ }
+
+ ASSERT( avp->avp_public.avp_value );
+
+ /* Resolve the session and we are done */
+ if (avp->avp_public.avp_value->os.len > 0) {
+ CHECK_FCT( fd_sess_fromsid_msg ( avp->avp_public.avp_value->os.data, avp->avp_public.avp_value->os.len, &msg->msg_sess, new) );
+ *session = msg->msg_sess;
+ } else {
+ TRACE_DEBUG(FULL, "Session-Id AVP with 0-byte length found in message %p", msg);
+ *session = NULL;
+ }
+
+ return 0;
+}
+
+/* Retrieve the location of the pmd list for the message; return NULL if failed */
+struct fd_msg_pmdl * fd_msg_pmdl_get(struct msg * msg)
+{
+ CHECK_PARAMS_DO( CHECK_MSG(msg), return NULL );
+ return &msg->msg_pmdl;
+}
+
+
+/******************* End-to-end counter *********************/
+static uint32_t fd_eteid;
+static pthread_mutex_t fd_eteid_lck = PTHREAD_MUTEX_INITIALIZER;
+
+void fd_msg_eteid_init(void)
+{
+ uint32_t t = (uint32_t)time(NULL);
+ srand48(t);
+ fd_eteid = (t << 20) | ((uint32_t)lrand48() & ( (1 << 20) - 1 ));
+}
+
+uint32_t fd_msg_eteid_get ( void )
+{
+ uint32_t ret;
+
+ CHECK_POSIX_DO( pthread_mutex_lock(&fd_eteid_lck), /* continue */ );
+
+ ret = fd_eteid ++;
+
+ CHECK_POSIX_DO( pthread_mutex_unlock(&fd_eteid_lck), /* continue */ );
+
+ return ret;
+}
+
+/***************************************************************************************************************/
+/* Manage AVPs values */
+
+/* Set the value of an AVP */
+int fd_msg_avp_setvalue ( struct avp *avp, union avp_value *value )
+{
+ enum dict_avp_basetype type = -1;
+
+ TRACE_ENTRY("%p %p", avp, value);
+
+ /* Check parameter */
+ CHECK_PARAMS( CHECK_AVP(avp) && avp->avp_model );
+
+ /* Retrieve information from the AVP model */
+ {
+ enum dict_object_type dicttype;
+ struct dict_avp_data dictdata;
+
+ CHECK_PARAMS( (fd_dict_gettype(avp->avp_model, &dicttype) == 0) && (dicttype == DICT_AVP) );
+ CHECK_FCT( fd_dict_getval(avp->avp_model, &dictdata) );
+ type = dictdata.avp_basetype;
+ CHECK_PARAMS( type != AVP_TYPE_GROUPED );
+ }
+
+ /* First, clean any previous value */
+ if (avp->avp_mustfreeos != 0) {
+ free(avp->avp_storage.os.data);
+ avp->avp_mustfreeos = 0;
+ }
+
+ memset(&avp->avp_storage, 0, sizeof(union avp_value));
+
+ /* If the request was to delete a value: */
+ if (!value) {
+ avp->avp_public.avp_value = NULL;
+ return 0;
+ }
+
+ /* Now we have to set the value */
+ memcpy(&avp->avp_storage, value, sizeof(union avp_value));
+
+ /* Duplicate an octetstring if needed. */
+ if (type == AVP_TYPE_OCTETSTRING) {
+ CHECK_MALLOC( avp->avp_storage.os.data = os0dup(value->os.data, value->os.len) );
+ avp->avp_mustfreeos = 1;
+ }
+
+ /* Set the data pointer of the public part */
+ avp->avp_public.avp_value = &avp->avp_storage;
+
+ return 0;
+}
+
+/* Set the value of an AVP, using formatted data */
+int fd_msg_avp_value_encode ( void *data, struct avp *avp )
+{
+ enum dict_avp_basetype type = -1;
+ struct dict_type_data type_data;
+
+ TRACE_ENTRY("%p %p", data, avp);
+
+ /* Check parameter */
+ CHECK_PARAMS( CHECK_AVP(avp) && avp->avp_model );
+
+ /* Retrieve information from the AVP model and it's parent type */
+ {
+ enum dict_object_type dicttype;
+ struct dict_avp_data dictdata;
+ struct dictionary * dict;
+ struct dict_object * parenttype = NULL;
+
+ /* First check the base type of the AVP */
+ CHECK_PARAMS( (fd_dict_gettype(avp->avp_model, &dicttype) == 0) && (dicttype == DICT_AVP) );
+ CHECK_FCT( fd_dict_getval(avp->avp_model, &dictdata) );
+ type = dictdata.avp_basetype;
+ CHECK_PARAMS( type != AVP_TYPE_GROUPED );
+
+ /* Then retrieve information about the parent's type (= derived type) */
+ CHECK_FCT( fd_dict_getdict( avp->avp_model, &dict ) );
+ CHECK_FCT( fd_dict_search( dict, DICT_TYPE, TYPE_OF_AVP, avp->avp_model, &parenttype, EINVAL) );
+ CHECK_FCT( fd_dict_getval(parenttype, &type_data) );
+ if (type_data.type_encode == NULL) {
+ TRACE_DEBUG(INFO, "This AVP type does not provide a callback to encode formatted data. ENOTSUP.");
+ return ENOTSUP;
+ }
+ }
+
+ /* Ok, now we can encode the value */
+
+ /* First, clean any previous value */
+ if (avp->avp_mustfreeos != 0) {
+ free(avp->avp_storage.os.data);
+ avp->avp_mustfreeos = 0;
+ }
+ avp->avp_public.avp_value = NULL;
+ memset(&avp->avp_storage, 0, sizeof(union avp_value));
+
+ /* Now call the type's callback to encode the data */
+ CHECK_FCT( (*type_data.type_encode)(data, &avp->avp_storage) );
+
+ /* If an octetstring has been allocated, let's mark it to be freed */
+ if (type == AVP_TYPE_OCTETSTRING)
+ avp->avp_mustfreeos = 1;
+
+ /* Set the data pointer of the public part */
+ avp->avp_public.avp_value = &avp->avp_storage;
+
+ return 0;
+}
+
+/* Interpret the value of an AVP into formatted data */
+int fd_msg_avp_value_interpret ( struct avp *avp, void *data )
+{
+ struct dict_type_data type_data;
+
+ TRACE_ENTRY("%p %p", avp, data);
+
+ /* Check parameter */
+ CHECK_PARAMS( CHECK_AVP(avp) && avp->avp_model && avp->avp_public.avp_value );
+
+ /* Retrieve information about the AVP parent type */
+ {
+ struct dictionary * dict;
+ struct dict_object * parenttype = NULL;
+
+ CHECK_FCT( fd_dict_getdict( avp->avp_model, &dict ) );
+ CHECK_FCT( fd_dict_search( dict, DICT_TYPE, TYPE_OF_AVP, avp->avp_model, &parenttype, EINVAL) );
+ CHECK_FCT( fd_dict_getval(parenttype, &type_data) );
+ if (type_data.type_interpret == NULL) {
+ TRACE_DEBUG(INFO, "This AVP type does not provide a callback to interpret value in formatted data. ENOTSUP.");
+ return ENOTSUP;
+ }
+ }
+
+ /* Ok, now we can interpret the value */
+
+ CHECK_FCT( (*type_data.type_interpret)(avp->avp_public.avp_value, data) );
+
+ return 0;
+}
+
+/***************************************************************************************************************/
+/* Creating a buffer from memory objects (bufferize a struct msg) */
+
+/* Following macros are used to store 32 and 64 bit fields into a buffer in network byte order */
+#define PUT_in_buf_32( _u32data, _bufptr ) { \
+ *(uint32_t *)(_bufptr) = htonl((uint32_t)(_u32data)); \
+}
+
+/* The location is not on 64b boundary, so we split the writing in two operations to avoid sigbus */
+#define PUT_in_buf_64( _u64data, _bufptr ) { \
+ uint64_t __v = htonll((uint64_t)(_u64data)); \
+ memcpy(_bufptr, &__v, sizeof(__v)); \
+}
+
+/* Write a message header in the buffer */
+static int bufferize_msg(unsigned char * buffer, size_t buflen, size_t * offset, struct msg * msg)
+{
+ TRACE_ENTRY("%p %zd %p %p", buffer, buflen, offset, msg);
+
+ if ((buflen - *offset) < GETMSGHDRSZ())
+ return ENOSPC;
+
+ if (*offset & 0x3)
+ return EFAULT; /* We are supposed to start on 32 bit boundaries */
+
+ PUT_in_buf_32(msg->msg_public.msg_length, buffer + *offset);
+ buffer[*offset] = msg->msg_public.msg_version;
+ *offset += 4;
+
+ PUT_in_buf_32(msg->msg_public.msg_code, buffer + *offset);
+ buffer[*offset] = msg->msg_public.msg_flags;
+ *offset += 4;
+
+ PUT_in_buf_32(msg->msg_public.msg_appl, buffer + *offset);
+ *offset += 4;
+
+ PUT_in_buf_32(msg->msg_public.msg_hbhid, buffer + *offset);
+ *offset += 4;
+
+ PUT_in_buf_32(msg->msg_public.msg_eteid, buffer + *offset);
+ *offset += 4;
+
+ return 0;
+}
+
+static int bufferize_chain(unsigned char * buffer, size_t buflen, size_t * offset, struct fd_list * list);
+
+/* Write an AVP in the buffer */
+static int bufferize_avp(unsigned char * buffer, size_t buflen, size_t * offset, struct avp * avp)
+{
+ struct dict_avp_data dictdata;
+
+ TRACE_ENTRY("%p %zd %p %p", buffer, buflen, offset, avp);
+
+ if ((buflen - *offset) < avp->avp_public.avp_len)
+ return ENOSPC;
+
+ /* Write the header */
+ PUT_in_buf_32(avp->avp_public.avp_code, buffer + *offset);
+ *offset += 4;
+
+ PUT_in_buf_32(avp->avp_public.avp_len, buffer + *offset);
+ buffer[*offset] = avp->avp_public.avp_flags;
+ *offset += 4;
+
+ if (avp->avp_public.avp_flags & AVP_FLAG_VENDOR) {
+ PUT_in_buf_32(avp->avp_public.avp_vendor, buffer + *offset);
+ *offset += 4;
+ }
+
+ /* Then we must write the AVP value */
+
+ if (avp->avp_model == NULL) {
+ /* In the case where we don't know the type of AVP, just copy the raw data or source */
+ CHECK_PARAMS( avp->avp_source || avp->avp_rawdata );
+
+ if ( avp->avp_rawdata != NULL ) {
+ /* the content was stored in rawdata */
+ memcpy(&buffer[*offset], avp->avp_rawdata, avp->avp_rawlen);
+ *offset += PAD4(avp->avp_rawlen);
+ } else {
+ /* the message was not parsed completely */
+ size_t datalen = avp->avp_public.avp_len - GETAVPHDRSZ(avp->avp_public.avp_flags);
+ memcpy(&buffer[*offset], avp->avp_source, datalen);
+ *offset += PAD4(datalen);
+ }
+
+ } else {
+ /* The AVP is defined in the dictionary */
+ CHECK_FCT( fd_dict_getval(avp->avp_model, &dictdata) );
+
+ CHECK_PARAMS( ( dictdata.avp_basetype == AVP_TYPE_GROUPED ) || avp->avp_public.avp_value );
+
+ switch (dictdata.avp_basetype) {
+ case AVP_TYPE_GROUPED:
+ return bufferize_chain(buffer, buflen, offset, &avp->avp_chain.children);
+
+ case AVP_TYPE_OCTETSTRING:
+ if (avp->avp_public.avp_value->os.len)
+ memcpy(&buffer[*offset], avp->avp_public.avp_value->os.data, avp->avp_public.avp_value->os.len);
+ *offset += PAD4(avp->avp_public.avp_value->os.len);
+ break;
+
+ case AVP_TYPE_INTEGER32:
+ PUT_in_buf_32(avp->avp_public.avp_value->i32, buffer + *offset);
+ *offset += 4;
+ break;
+
+ case AVP_TYPE_INTEGER64:
+ PUT_in_buf_64(avp->avp_public.avp_value->i64, buffer + *offset);
+ *offset += 8;
+ break;
+
+ case AVP_TYPE_UNSIGNED32:
+ PUT_in_buf_32(avp->avp_public.avp_value->u32, buffer + *offset);
+ *offset += 4;
+ break;
+
+ case AVP_TYPE_UNSIGNED64:
+ PUT_in_buf_64(avp->avp_public.avp_value->u64, buffer + *offset);
+ *offset += 8;
+ break;
+
+ case AVP_TYPE_FLOAT32:
+ /* We read the f32 as "u32" here to avoid casting to uint make decimals go away.
+ The alternative would be something like "*(uint32_t *)(& f32)" but
+ then the compiler complains about strict-aliasing rules. */
+ PUT_in_buf_32(avp->avp_public.avp_value->u32, buffer + *offset);
+ *offset += 4;
+ break;
+
+ case AVP_TYPE_FLOAT64:
+ /* Same remark as previously */
+ PUT_in_buf_64(avp->avp_public.avp_value->u64, buffer + *offset);
+ *offset += 8;
+ break;
+
+ default:
+ ASSERT(0);
+ }
+ }
+ return 0;
+}
+
+/* Write a chain of AVPs in the buffer */
+static int bufferize_chain(unsigned char * buffer, size_t buflen, size_t * offset, struct fd_list * list)
+{
+ struct fd_list * avpch;
+
+ TRACE_ENTRY("%p %zd %p %p", buffer, buflen, offset, list);
+
+ for (avpch = list->next; avpch != list; avpch = avpch->next) {
+ /* Bufferize the AVP */
+ CHECK_FCT( bufferize_avp(buffer, buflen, offset, _A(avpch->o)) );
+ }
+ return 0;
+}
+
+/* Create the message buffer, in network-byte order. We browse the tree twice, this could be probably improved if needed */
+int fd_msg_bufferize ( struct msg * msg, unsigned char ** buffer, size_t * len )
+{
+ int ret = 0;
+ unsigned char * buf = NULL;
+ size_t offset = 0;
+
+ TRACE_ENTRY("%p %p %p", msg, buffer, len);
+
+ /* Check the parameters */
+ CHECK_PARAMS( buffer && CHECK_MSG(msg) );
+
+ /* Update the length. This also checks that all AVP have their values set */
+ CHECK_FCT( fd_msg_update_length(msg) );
+
+ /* Now allocate a buffer to store the message */
+ CHECK_MALLOC( buf = malloc(msg->msg_public.msg_length) );
+
+ /* Clear the memory, so that the padding is always 0 (should not matter) */
+ memset(buf, 0, msg->msg_public.msg_length);
+
+ /* Write the message header in the buffer */
+ CHECK_FCT_DO( ret = bufferize_msg(buf, msg->msg_public.msg_length, &offset, msg),
+ {
+ free(buf);
+ return ret;
+ } );
+
+ /* Write the list of AVPs */
+ CHECK_FCT_DO( ret = bufferize_chain(buf, msg->msg_public.msg_length, &offset, &msg->msg_chain.children),
+ {
+ free(buf);
+ return ret;
+ } );
+
+ ASSERT(offset == msg->msg_public.msg_length); /* or the msg_update_length is buggy */
+
+ if (len) {
+ *len = offset;
+ }
+
+ *buffer = buf;
+ return 0;
+}
+
+
+/***************************************************************************************************************/
+/* Parsing buffers and building AVP objects lists (not parsing the AVP values which requires dictionary knowledge) */
+
+/* Parse a buffer containing a supposed list of AVPs */
+static int parsebuf_list(unsigned char * buf, size_t buflen, struct fd_list * head)
+{
+ size_t offset = 0;
+
+ TRACE_ENTRY("%p %zd %p", buf, buflen, head);
+
+ while (offset < buflen) {
+ struct avp * avp;
+
+ if (buflen - offset < AVPHDRSZ_NOVEND) {
+ TRACE_DEBUG(INFO, "truncated buffer: remaining only %zd bytes", buflen - offset);
+ return EBADMSG;
+ }
+
+ /* Create a new AVP object */
+ CHECK_MALLOC( avp = malloc (sizeof(struct avp)) );
+
+ init_avp(avp);
+
+ /* Initialize the header */
+ avp->avp_public.avp_code = ntohl(*(uint32_t *)(buf + offset));
+ avp->avp_public.avp_flags = buf[offset + 4];
+ avp->avp_public.avp_len = ((uint32_t)buf[offset+5]) << 16 | ((uint32_t)buf[offset+6]) << 8 | ((uint32_t)buf[offset+7]) ;
+
+ offset += 8;
+
+ if (avp->avp_public.avp_flags & AVP_FLAG_VENDOR) {
+ if (buflen - offset < 4) {
+ TRACE_DEBUG(INFO, "truncated buffer: remaining only %zd bytes for vendor and data", buflen - offset);
+ free(avp);
+ return EBADMSG;
+ }
+ avp->avp_public.avp_vendor = ntohl(*(uint32_t *)(buf + offset));
+ offset += 4;
+ }
+
+ /* Check there is enough remaining data in the buffer */
+ if ( (avp->avp_public.avp_len > GETAVPHDRSZ(avp->avp_public.avp_flags))
+ && (buflen - offset < avp->avp_public.avp_len - GETAVPHDRSZ(avp->avp_public.avp_flags))) {
+ TRACE_DEBUG(INFO, "truncated buffer: remaining only %zd bytes for data, and avp data size is %d",
+ buflen - offset,
+ avp->avp_public.avp_len - GETAVPHDRSZ(avp->avp_public.avp_flags));
+ free(avp);
+ return EBADMSG;
+ }
+
+ /* buf[offset] is now the beginning of the data */
+ avp->avp_source = &buf[offset];
+
+ /* Now eat the data and eventual padding */
+ offset += PAD4(avp->avp_public.avp_len - GETAVPHDRSZ(avp->avp_public.avp_flags));
+
+ /* And insert this avp in the list, at the end */
+ fd_list_insert_before( head, &avp->avp_chain.chaining );
+ }
+
+ return 0;
+}
+
+/* Create a message object from a buffer. Dictionary objects are not resolved, AVP contents are not interpreted, buffer is saved in msg */
+int fd_msg_parse_buffer ( unsigned char ** buffer, size_t buflen, struct msg ** msg )
+{
+ struct msg * new = NULL;
+ int ret = 0;
+ uint32_t msglen = 0;
+ unsigned char * buf;
+
+ TRACE_ENTRY("%p %zd %p", buffer, buflen, msg);
+
+ CHECK_PARAMS( buffer && *buffer && msg && (buflen >= GETMSGHDRSZ()) );
+ buf = *buffer;
+
+ if ( buf[0] != DIAMETER_VERSION) {
+ TRACE_DEBUG(INFO, "Invalid version in message: %d (supported: %d)", buf[0], DIAMETER_VERSION);
+ return EBADMSG;
+ }
+
+ msglen = ntohl(*(uint32_t *)buf) & 0x00ffffff;
+ if ( buflen < msglen ) {
+ TRACE_DEBUG(INFO, "Truncated message (%zd / %d)", buflen, msglen );
+ return EBADMSG;
+ }
+
+ /* Create a new object */
+ CHECK_MALLOC( new = malloc (sizeof(struct msg)) );
+
+ /* Initialize the fields */
+ init_msg(new);
+
+ /* Now read from the buffer */
+ new->msg_public.msg_version = buf[0];
+ new->msg_public.msg_length = msglen;
+
+ new->msg_public.msg_flags = buf[4];
+ new->msg_public.msg_code = ntohl(*(uint32_t *)(buf+4)) & 0x00ffffff;
+
+ new->msg_public.msg_appl = ntohl(*(uint32_t *)(buf+8));
+ new->msg_public.msg_hbhid = ntohl(*(uint32_t *)(buf+12));
+ new->msg_public.msg_eteid = ntohl(*(uint32_t *)(buf+16));
+
+ /* Parse the AVP list */
+ CHECK_FCT_DO( ret = parsebuf_list(buf + GETMSGHDRSZ(), buflen - GETMSGHDRSZ(), &new->msg_chain.children), { destroy_tree(_C(new)); return ret; } );
+
+ /* Parsing successful */
+ new->msg_rawbuffer = buf;
+ *buffer = NULL;
+ *msg = new;
+ return 0;
+}
+
+
+/***************************************************************************************************************/
+/* Parsing messages and AVP with dictionary information */
+
+/* Resolve dictionary objects of the cmd and avp instances, from their headers.
+ * When the model is found, the data is interpreted from the avp_source buffer and copied to avp_storage.
+ * When the model is not found, the data is copied as rawdata and saved (in case we FW the message).
+ * Therefore, after this function has been called, the source buffer can be freed.
+ * For command, if the dictionary model is not found, an error is returned.
+ */
+
+static char error_message[256];
+
+/* Process an AVP. If we are not in recheck, the avp_source must be set. */
+static int parsedict_do_avp(struct dictionary * dict, struct avp * avp, int mandatory, struct fd_pei *error_info)
+{
+ struct dict_avp_data dictdata;
+ struct dict_type_data derivedtypedata;
+ struct dict_object * avp_derived_type = NULL;
+ uint8_t * source;
+
+ TRACE_ENTRY("%p %p %d %p", dict, avp, mandatory, error_info);
+
+ /* First check we received an AVP as input */
+ CHECK_PARAMS( CHECK_AVP(avp) );
+
+ if (avp->avp_model != NULL) {
+ /* the model has already been resolved. we do check it is still valid */
+
+ CHECK_FCT( fd_dict_getval(avp->avp_model, &dictdata) );
+
+ if ( avp->avp_public.avp_code == dictdata.avp_code ) {
+ /* Ok then just process the children if any */
+ return parsedict_do_chain(dict, &avp->avp_chain.children, mandatory && (avp->avp_public.avp_flags & AVP_FLAG_MANDATORY), error_info);
+ } else {
+ /* We just erase the old model */
+ avp->avp_model = NULL;
+ }
+ }
+
+ /* Check if we already searched for this model without success */
+ if ((avp->avp_model_not_found.mnf_code != avp->avp_public.avp_code)
+ || (avp->avp_model_not_found.mnf_vendor != avp->avp_public.avp_vendor)) {
+
+ /* Now try and resolve the model from the avp code and vendor */
+ if (avp->avp_public.avp_flags & AVP_FLAG_VENDOR) {
+ struct dict_avp_request_ex avpreq;
+ memset(&avpreq, 0, sizeof(avpreq));
+ avpreq.avp_vendor.vendor_id = avp->avp_public.avp_vendor;
+ avpreq.avp_data.avp_code = avp->avp_public.avp_code;
+ CHECK_FCT( fd_dict_search ( dict, DICT_AVP, AVP_BY_STRUCT, &avpreq, &avp->avp_model, 0));
+ } else {
+ /* no vendor */
+ CHECK_FCT( fd_dict_search ( dict, DICT_AVP, AVP_BY_CODE, &avp->avp_public.avp_code, &avp->avp_model, 0));
+ }
+
+ if (!avp->avp_model) {
+ avp->avp_model_not_found.mnf_code = avp->avp_public.avp_code;
+ avp->avp_model_not_found.mnf_vendor = avp->avp_public.avp_vendor;
+ }
+ }
+
+ /* First handle the case where we have not found this AVP in the dictionary */
+ if (!avp->avp_model) {
+
+ if (mandatory && (avp->avp_public.avp_flags & AVP_FLAG_MANDATORY)) {
+ TRACE_DEBUG(INFO, "Unsupported mandatory AVP found");
+ if (error_info) {
+ error_info->pei_errcode = "DIAMETER_AVP_UNSUPPORTED";
+ error_info->pei_avp = avp;
+ } else {
+ char * buf = NULL;
+ size_t buflen;
+ CHECK_MALLOC(fd_msg_dump_treeview(&buf, &buflen, NULL, avp, NULL, 0, 0));
+ LOG_E("Unsupported AVP: %s", buf);
+ free(buf);
+ }
+ return ENOTSUP;
+ }
+
+ if (avp->avp_source) {
+ /* we must copy the data from the source to the internal buffer area */
+ CHECK_PARAMS( !avp->avp_rawdata );
+
+ avp->avp_rawlen = avp->avp_public.avp_len - GETAVPHDRSZ( avp->avp_public.avp_flags );
+
+ if (avp->avp_rawlen) {
+ CHECK_MALLOC( avp->avp_rawdata = malloc(avp->avp_rawlen) );
+
+ memcpy(avp->avp_rawdata, avp->avp_source, avp->avp_rawlen);
+ }
+
+ avp->avp_source = NULL;
+
+ TRACE_DEBUG(FULL, "Unsupported optional AVP found, raw source data saved in avp_rawdata.");
+ }
+
+ return 0;
+ }
+
+ /* Ok we have resolved the object. Now we need to interpret its content. */
+
+ CHECK_FCT( fd_dict_getval(avp->avp_model, &dictdata) );
+
+ if (avp->avp_rawdata) {
+ /* This happens if the dictionary object was defined after the first check */
+ avp->avp_source = avp->avp_rawdata;
+ }
+
+ /* A bit of sanity here... */
+ ASSERT(CHECK_BASETYPE(dictdata.avp_basetype));
+
+ /* Check the size is valid */
+ if ((avp_value_sizes[dictdata.avp_basetype] != 0) &&
+ (avp->avp_public.avp_len - GETAVPHDRSZ( avp->avp_public.avp_flags ) != avp_value_sizes[dictdata.avp_basetype])) {
+ TRACE_DEBUG(INFO, "The AVP size is not suitable for the type");
+ if (error_info) {
+ error_info->pei_errcode = "DIAMETER_INVALID_AVP_LENGTH";
+ error_info->pei_avp = avp;
+ snprintf(error_message, sizeof(error_message), "I expected a size of %d for this AVP according to my dictionary", avp_value_sizes[dictdata.avp_basetype]);
+ error_info->pei_message = error_message;
+ } else {
+ char * buf = NULL;
+ size_t buflen;
+ CHECK_MALLOC(fd_msg_dump_treeview(&buf, &buflen, NULL, avp, NULL, 0, 0));
+ LOG_E("Invalid length AVP: %s", buf);
+ free(buf);
+ }
+ avp->avp_model = NULL;
+ return EBADMSG;
+ }
+
+ source = avp->avp_source;
+ avp->avp_source = NULL;
+
+ /* Now get the value inside */
+ switch (dictdata.avp_basetype) {
+ case AVP_TYPE_GROUPED: {
+ int ret;
+
+ /* This is a grouped AVP, so let's parse the list of AVPs inside */
+ CHECK_FCT_DO( ret = parsebuf_list(source, avp->avp_public.avp_len - GETAVPHDRSZ( avp->avp_public.avp_flags ), &avp->avp_chain.children),
+ {
+ if ((ret == EBADMSG) && (error_info)) {
+ error_info->pei_errcode = "DIAMETER_INVALID_AVP_VALUE";
+ error_info->pei_avp = avp;
+ snprintf(error_message, sizeof(error_message), "I cannot parse this AVP as a Grouped AVP");
+ error_info->pei_message = error_message;
+ }
+ avp->avp_source = source;
+ return ret;
+ } );
+
+ return parsedict_do_chain(dict, &avp->avp_chain.children, mandatory && (avp->avp_public.avp_flags & AVP_FLAG_MANDATORY), error_info);
+ }
+
+ case AVP_TYPE_OCTETSTRING:
+ /* We just have to copy the string into the storage area */
+ CHECK_PARAMS_DO( avp->avp_public.avp_len >= GETAVPHDRSZ( avp->avp_public.avp_flags ),
+ {
+ if (error_info) {
+ error_info->pei_errcode = "DIAMETER_INVALID_AVP_LENGTH";
+ error_info->pei_avp = avp;
+ }
+ avp->avp_source = source;
+ return EBADMSG;
+ } );
+ avp->avp_storage.os.len = avp->avp_public.avp_len - GETAVPHDRSZ( avp->avp_public.avp_flags );
+ CHECK_MALLOC( avp->avp_storage.os.data = os0dup(source, avp->avp_storage.os.len) );
+ avp->avp_mustfreeos = 1;
+ break;
+
+ case AVP_TYPE_INTEGER32:
+ avp->avp_storage.i32 = (int32_t)ntohl(*(uint32_t *)source);
+ break;
+
+ case AVP_TYPE_INTEGER64:
+ /* the storage might not be aligned on 64b boundary, so no direct indirection here is possible */
+ {
+ uint64_t __stor;
+ memcpy(&__stor, source, sizeof(__stor));
+ avp->avp_storage.i64 = (int64_t)ntohll(__stor);
+ }
+ break;
+
+ case AVP_TYPE_UNSIGNED32:
+ case AVP_TYPE_FLOAT32: /* For float, we must not cast, or the value is changed. Instead we use implicit cast by changing the member of the union */
+ avp->avp_storage.u32 = (uint32_t)ntohl(*(uint32_t *)source);
+ break;
+
+ case AVP_TYPE_UNSIGNED64:
+ case AVP_TYPE_FLOAT64: /* same as 32 bits */
+ {
+ uint64_t __stor;
+ memcpy(&__stor, source, sizeof(__stor));
+ avp->avp_storage.u64 = (uint64_t)ntohll(__stor);
+ }
+ break;
+
+ }
+
+ /* Is there a derived type check function ? */
+ CHECK_FCT ( fd_dict_search ( dict, DICT_TYPE, TYPE_OF_AVP, avp->avp_model, &avp_derived_type, 0) );
+ if (avp_derived_type) {
+ CHECK_FCT( fd_dict_getval(avp_derived_type, &derivedtypedata) );
+ if (derivedtypedata.type_check != NULL) {
+ char * err;
+ int ret = (*derivedtypedata.type_check)( derivedtypedata.type_check_param, &avp->avp_storage, &err );
+
+ if (ret != 0) {
+ TRACE_DEBUG(INFO, "The AVP failed to pass the dictionary validation");
+ if (error_info) {
+ error_info->pei_errcode = "DIAMETER_INVALID_AVP_VALUE";
+ error_info->pei_avp = avp;
+ strncpy(error_message, err, sizeof(error_message));
+ error_info->pei_message = error_message;
+ } else {
+ char * buf = NULL;
+ size_t buflen;
+ CHECK_MALLOC(fd_msg_dump_treeview(&buf, &buflen, NULL, avp, NULL, 0, 0));
+ LOG_E("Invalid AVP: %s", buf);
+ free(buf);
+ }
+ return ret; /* should we just return EBADMSG? */
+ }
+ }
+ }
+
+ /* The value is now set, so set the data pointer and return 0 */
+ avp->avp_public.avp_value = &avp->avp_storage;
+ return 0;
+}
+
+/* Process a list of AVPs */
+static int parsedict_do_chain(struct dictionary * dict, struct fd_list * head, int mandatory, struct fd_pei *error_info)
+{
+ struct fd_list * avpch;
+
+ TRACE_ENTRY("%p %p %d %p", dict, head, mandatory, error_info);
+
+ /* Sanity check */
+ ASSERT ( head == head->head );
+
+ /* Now process the list */
+ for (avpch=head->next; avpch != head; avpch = avpch->next) {
+ CHECK_FCT( parsedict_do_avp(dict, _A(avpch->o), mandatory, error_info) );
+ }
+
+ /* Done */
+ return 0;
+}
+
+/* Process a msg header. */
+static int parsedict_do_msg(struct dictionary * dict, struct msg * msg, int only_hdr, struct fd_pei *error_info)
+{
+ int ret = 0;
+
+ TRACE_ENTRY("%p %p %d %p", dict, msg, only_hdr, error_info);
+
+ CHECK_PARAMS( CHECK_MSG(msg) );
+
+ /* First, check if we already have a model. */
+ if (msg->msg_model != NULL) {
+ /* Check if this model is still valid for the message data */
+ enum dict_object_type dicttype;
+ struct dict_cmd_data data;
+ ASSERT(((fd_dict_gettype(msg->msg_model, &dicttype) == 0) && (dicttype == DICT_COMMAND)));
+ (void)fd_dict_getval( msg->msg_model, &data);
+ if ((data.cmd_code != msg->msg_public.msg_code)
+ || ((data.cmd_flag_val & data.cmd_flag_mask) != (msg->msg_public.msg_flags && data.cmd_flag_mask))) {
+ msg->msg_model = NULL;
+ } else {
+ goto chain;
+ }
+ }
+
+ /* Check if we already searched for this model without success */
+ if ((msg->msg_model_not_found.mnf_code == msg->msg_public.msg_code)
+ && (msg->msg_model_not_found.mnf_flags == msg->msg_public.msg_flags)) {
+ goto no_model;
+ } else {
+ msg->msg_model_not_found.mnf_code = 0;
+ }
+
+ /* Look for the model from the header */
+ CHECK_FCT_DO( ret = fd_dict_search ( dict, DICT_COMMAND,
+ (msg->msg_public.msg_flags & CMD_FLAG_REQUEST) ? CMD_BY_CODE_R : CMD_BY_CODE_A,
+ &msg->msg_public.msg_code,
+ &msg->msg_model, ENOTSUP),
+ {
+ if (ret == ENOTSUP) {
+ /* update the model not found info */
+ msg->msg_model_not_found.mnf_code = msg->msg_public.msg_code;
+ msg->msg_model_not_found.mnf_flags = msg->msg_public.msg_flags;
+ goto no_model;
+ }
+ return ret;
+ } );
+chain:
+ if (!only_hdr) {
+ /* Then process the children */
+ ret = parsedict_do_chain(dict, &msg->msg_chain.children, 1, error_info);
+
+ /* Free the raw buffer if any */
+ if ((ret == 0) && (msg->msg_rawbuffer != NULL)) {
+ free(msg->msg_rawbuffer);
+ msg->msg_rawbuffer=NULL;
+ }
+ }
+
+ return ret;
+no_model:
+ if (error_info) {
+ error_info->pei_errcode = "DIAMETER_COMMAND_UNSUPPORTED";
+ error_info->pei_protoerr = 1;
+ }
+ return ENOTSUP;
+}
+
+int fd_msg_parse_dict ( msg_or_avp * object, struct dictionary * dict, struct fd_pei *error_info )
+{
+ TRACE_ENTRY("%p %p %p", dict, object, error_info);
+
+ CHECK_PARAMS( VALIDATE_OBJ(object) );
+
+ if (error_info)
+ memset(error_info, 0, sizeof(struct fd_pei));
+
+ switch (_C(object)->type) {
+ case MSG_MSG:
+ return parsedict_do_msg(dict, _M(object), 0, error_info);
+
+ case MSG_AVP:
+ return parsedict_do_avp(dict, _A(object), 0, error_info);
+
+ default:
+ ASSERT(0);
+ }
+ return EINVAL;
+}
+
+/***************************************************************************************************************/
+/* Parsing messages and AVP for rules (ABNF) compliance */
+
+/* This function is used to get stats (first occurence position, last occurence position, number of occurences)
+ of AVP instances of a given model in a chain of AVP */
+static void parserules_stat_avps( struct dict_object * model_avp, struct fd_list *list, int * count, int * firstpos, int * lastpos)
+{
+ struct fd_list * li;
+ int curpos = 0; /* The current position in the list */
+
+ TRACE_ENTRY("%p %p %p %p %p", model_avp, list, count, firstpos, lastpos);
+
+ *count = 0; /* number of instances found */
+ *firstpos = 0; /* position of the first instance */
+ *lastpos = 0; /* position of the last instance, starting from the end */
+
+ for (li = list->next; li != list; li = li->next) {
+ /* Increment the current position counter */
+ curpos++;
+
+ /* If we previously saved a "lastpos" information, increment it */
+ if (*lastpos != 0)
+ (*lastpos)++;
+
+ /* Check the type of the next AVP. We can compare the references directly, it is safe. */
+ if (_A(li->o)->avp_model == model_avp) {
+
+ /* This AVP is of the type we are searching */
+ (*count)++;
+
+ /* If we don't have yet a "firstpos", save it */
+ if (*firstpos == 0)
+ *firstpos = curpos;
+
+ /* Reset the lastpos */
+ (*lastpos) = 1;
+ }
+ }
+}
+
+/* We use this structure as parameter for the next function */
+struct parserules_data {
+ struct fd_list * sentinel; /* Sentinel of the list of children AVP */
+ struct fd_pei * pei; /* If the rule conflicts, save the error here */
+};
+
+/* Create an empty AVP of a given model (to use in Failed-AVP) */
+static struct avp * empty_avp(struct dict_object * model_avp)
+{
+ struct avp * avp = NULL;
+ struct dict_avp_data avp_info;
+ union avp_value val;
+ unsigned char os[1] = { '\0' };
+
+ /* Create an instance */
+ CHECK_FCT_DO( fd_msg_avp_new(model_avp, 0, &avp ), return NULL );
+
+ /* Type of the AVP */
+ CHECK_FCT_DO( fd_dict_getval(model_avp, &avp_info), return NULL );
+
+ /* Set an initial size */
+ avp->avp_public.avp_len = GETAVPHDRSZ( avp->avp_public.avp_flags ) + avp_value_sizes[avp_info.avp_basetype];
+
+ /* Prepare the empty value */
+ memset(&val, 0, sizeof(val));
+ switch (avp_info.avp_basetype) {
+ case AVP_TYPE_OCTETSTRING:
+ val.os.data = os;
+ val.os.len = sizeof(os);
+ avp->avp_public.avp_len += val.os.len;
+ case AVP_TYPE_INTEGER32:
+ case AVP_TYPE_INTEGER64:
+ case AVP_TYPE_UNSIGNED32:
+ case AVP_TYPE_UNSIGNED64:
+ case AVP_TYPE_FLOAT32:
+ case AVP_TYPE_FLOAT64:
+ CHECK_FCT_DO( fd_msg_avp_setvalue(avp, &val), return NULL );
+ case AVP_TYPE_GROUPED:
+ /* For AVP_TYPE_GROUPED we don't do anything */
+ break;
+ default:
+ ASSERT(0); /* not handled */
+ }
+
+ return avp;
+}
+
+/* Check that a list of AVPs is compliant with a given rule -- will be iterated on the list of rules */
+static int parserules_check_one_rule(void * data, struct dict_rule_data *rule)
+{
+ int count, first, last, min;
+ struct parserules_data * pr_data = data;
+ char * avp_name = "<unresolved name>";
+
+ TRACE_ENTRY("%p %p", data, rule);
+
+ /* Get statistics of the AVP concerned by this rule in the parent instance */
+ parserules_stat_avps( rule->rule_avp, pr_data->sentinel, &count, &first, &last);
+
+ if (TRACE_BOOL(INFO))
+ {
+ struct dict_avp_data avpdata;
+ int ret;
+ ret = fd_dict_getval(rule->rule_avp, &avpdata);
+ if (ret == 0)
+ avp_name = avpdata.avp_name;
+
+ TRACE_DEBUG(ANNOYING, "Checking rule: p:%d(%d) m/M:%2d/%2d. Counted %d (first: %d, last:%d) of AVP '%s'",
+ rule->rule_position,
+ rule->rule_order,
+ rule->rule_min,
+ rule->rule_max,
+ count,
+ first,
+ last,
+ avp_name
+ );
+ }
+
+ /* Now check the rule is not conflicting */
+
+ /* Check the "min" value */
+ if ((min = rule->rule_min) == -1) {
+ if (rule->rule_position == RULE_OPTIONAL)
+ min = 0;
+ else
+ min = 1;
+ }
+ if (count < min) {
+ fd_log_error("Conflicting rule: the number of occurences (%d) is < the rule min (%d) for '%s'.", count, min, avp_name);
+ if (pr_data->pei) {
+ pr_data->pei->pei_errcode = "DIAMETER_MISSING_AVP";
+ pr_data->pei->pei_avp = empty_avp(rule->rule_avp);
+ pr_data->pei->pei_avp_free = 1;
+ }
+ return EBADMSG;
+ }
+
+ /* Check the "max" value */
+ if ((rule->rule_max != -1) && (count > rule->rule_max)) {
+ fd_log_error("Conflicting rule: the number of occurences (%d) is > the rule max (%d) for '%s'.", count, rule->rule_max, avp_name);
+ if (pr_data->pei) {
+ if (rule->rule_max == 0)
+ pr_data->pei->pei_errcode = "DIAMETER_AVP_NOT_ALLOWED";
+ else
+ pr_data->pei->pei_errcode = "DIAMETER_AVP_OCCURS_TOO_MANY_TIMES";
+ pr_data->pei->pei_avp = empty_avp(rule->rule_avp); /* Well we are supposed to return the (max + 1)th instance of the AVP instead... Pfff... */ TODO("Improve...");
+ pr_data->pei->pei_avp_free = 1;
+ }
+ return EBADMSG;
+ }
+
+ /* Check the position and order (if relevant) */
+ switch (rule->rule_position) {
+ case RULE_OPTIONAL:
+ case RULE_REQUIRED:
+ /* No special position constraints */
+ break;
+
+ case RULE_FIXED_HEAD:
+ /* Since "0*1<fixed>" is a valid rule specifier, we only reject cases where the AVP appears *after* its fixed position */
+ if (first > rule->rule_order) {
+ fd_log_error("Conflicting rule: the FIXED_HEAD AVP appears first in (%d) position, the rule requires (%d) for '%s'.", first, rule->rule_order, avp_name);
+ if (pr_data->pei) {
+ pr_data->pei->pei_errcode = "DIAMETER_MISSING_AVP";
+ pr_data->pei->pei_message = "AVP was not in its fixed position";
+ pr_data->pei->pei_avp = empty_avp(rule->rule_avp);
+ pr_data->pei->pei_avp_free = 1;
+ }
+ return EBADMSG;
+ }
+ break;
+
+ case RULE_FIXED_TAIL:
+ /* Since "0*1<fixed>" is a valid rule specifier, we only reject cases where the AVP appears *before* its fixed position */
+ if (last > rule->rule_order) { /* We have a ">" here because we count in reverse order (i.e. from the end) */
+ fd_log_error("Conflicting rule: the FIXED_TAIL AVP appears last in (%d) position, the rule requires (%d) for '%s'.", last, rule->rule_order, avp_name);
+ if (pr_data->pei) {
+ pr_data->pei->pei_errcode = "DIAMETER_MISSING_AVP";
+ pr_data->pei->pei_message = "AVP was not in its fixed position";
+ pr_data->pei->pei_avp = empty_avp(rule->rule_avp);
+ pr_data->pei->pei_avp_free = 1;
+ }
+ return EBADMSG;
+ }
+ break;
+
+ default:
+ /* What is this position ??? */
+ ASSERT(0);
+ return ENOTSUP;
+ }
+
+ /* We've checked all the parameters */
+ return 0;
+}
+
+/* Check the rules recursively */
+static int parserules_do ( struct dictionary * dict, msg_or_avp * object, struct fd_pei *error_info, int mandatory)
+{
+ struct parserules_data data;
+ struct dict_object * model = NULL;
+
+ TRACE_ENTRY("%p %p %p %d", dict, object, error_info, mandatory);
+
+ /* object has already been checked and dict-parsed when we are called. */
+
+ /* First, handle the cases where there is no model */
+ {
+ if (CHECK_MSG(object)) {
+ if ( _M(object)->msg_public.msg_flags & CMD_FLAG_ERROR ) {
+ /* The case of error messages: the ABNF is different */
+ CHECK_FCT( fd_dict_get_error_cmd(dict, &model) );
+ } else {
+ model = _M(object)->msg_model;
+ }
+ /* Commands MUST be supported in the dictionary */
+ if (model == NULL) {
+ TRACE_DEBUG(INFO, "Message with no dictionary model. EBADMSG");
+ if (error_info) {
+ error_info->pei_errcode = "DIAMETER_COMMAND_UNSUPPORTED";
+ error_info->pei_protoerr = 1;
+ }
+ return EBADMSG;
+ }
+ }
+
+ /* AVP with the 'M' flag must also be recognized in the dictionary -- except inside an optional grouped AVP */
+ if (CHECK_AVP(object) && ((model = _A(object)->avp_model) == NULL)) {
+ if ( mandatory && (_A(object)->avp_public.avp_flags & AVP_FLAG_MANDATORY)) {
+ /* Return an error in this case */
+ TRACE_DEBUG(INFO, "Mandatory AVP with no dictionary model. EBADMSG");
+ if (error_info) {
+ error_info->pei_errcode = "DIAMETER_AVP_UNSUPPORTED";
+ error_info->pei_avp = object;
+ }
+ return EBADMSG;
+ } else {
+ /* We don't know any rule for this object, so assume OK */
+ TRACE_DEBUG(FULL, "Unknown informational AVP, ignoring...");
+ return 0;
+ }
+ }
+ }
+
+ /* At this point we know "model" is set and points to the object's model */
+
+ /* If we are an AVP with no children, just return OK */
+ if (CHECK_AVP(object)) {
+ struct dict_avp_data dictdata;
+ CHECK_FCT( fd_dict_getval(model, &dictdata) );
+ if (dictdata.avp_basetype != AVP_TYPE_GROUPED) {
+ /* This object has no children and no rules */
+ return 0;
+ }
+ }
+
+ /* If this object has children, first check the rules for all its children */
+ {
+ int is_child_mand = 0;
+ struct fd_list * ch = NULL;
+ if ( CHECK_MSG(object)
+ || (mandatory && (_A(object)->avp_public.avp_flags & AVP_FLAG_MANDATORY)) )
+ is_child_mand = 1;
+ for (ch = _C(object)->children.next; ch != &_C(object)->children; ch = ch->next) {
+ CHECK_FCT( parserules_do ( dict, _C(ch->o), error_info, is_child_mand ) );
+ }
+ }
+
+ /* Now check all rules of this object */
+ data.sentinel = &_C(object)->children;
+ data.pei = error_info;
+ CHECK_FCT( fd_dict_iterate_rules ( model, &data, parserules_check_one_rule ) );
+
+ return 0;
+}
+
+int fd_msg_parse_rules ( msg_or_avp * object, struct dictionary * dict, struct fd_pei *error_info)
+{
+ TRACE_ENTRY("%p %p %p", object, dict, error_info);
+
+ if (error_info)
+ memset(error_info, 0, sizeof(struct fd_pei));
+
+ /* Resolve the dictionary objects when missing. This also validates the object. */
+ CHECK_FCT( fd_msg_parse_dict ( object, dict, error_info ) );
+
+ /* Call the recursive function */
+ return parserules_do ( dict, object, error_info, 1 ) ;
+}
+
+/***************************************************************************************************************/
+
+/* Compute the lengh of an object and its subtree. */
+int fd_msg_update_length ( msg_or_avp * object )
+{
+ size_t sz = 0;
+ struct dict_object * model;
+ union {
+ struct dict_cmd_data cmddata;
+ struct dict_avp_data avpdata;
+ } dictdata;
+
+ TRACE_ENTRY("%p", object);
+
+ /* Get the model of the object. This also validates the object */
+ CHECK_FCT( fd_msg_model ( object, &model ) );
+
+ /* Get the information of the model */
+ if (model) {
+ CHECK_FCT( fd_dict_getval(model, &dictdata) );
+ } else {
+ /* For unknown AVP, just don't change the size */
+ if (_C(object)->type == MSG_AVP)
+ return 0;
+ }
+
+ /* Deal with easy cases: AVPs without children */
+ if ((_C(object)->type == MSG_AVP) && (dictdata.avpdata.avp_basetype != AVP_TYPE_GROUPED)) {
+ /* Sanity check */
+ ASSERT(FD_IS_LIST_EMPTY(&_A(object)->avp_chain.children));
+
+ /* Now check that the data is set in the AVP */
+ CHECK_PARAMS( _A(object)->avp_public.avp_value );
+
+ sz = GETAVPHDRSZ( _A(object)->avp_public.avp_flags );
+
+ switch (dictdata.avpdata.avp_basetype) {
+ case AVP_TYPE_OCTETSTRING:
+ sz += _A(object)->avp_public.avp_value->os.len;
+ break;
+
+ case AVP_TYPE_INTEGER32:
+ case AVP_TYPE_INTEGER64:
+ case AVP_TYPE_UNSIGNED32:
+ case AVP_TYPE_UNSIGNED64:
+ case AVP_TYPE_FLOAT32:
+ case AVP_TYPE_FLOAT64:
+ sz += avp_value_sizes[dictdata.avpdata.avp_basetype];
+ break;
+
+ default:
+ /* Something went wrong... */
+ ASSERT(0);
+ }
+ }
+ else /* message or grouped AVP */
+ {
+ struct fd_list * ch = NULL;
+
+ /* First, compute the header size */
+ if (_C(object)->type == MSG_AVP) {
+ sz = GETAVPHDRSZ( _A(object)->avp_public.avp_flags );
+ } else {
+ sz = GETMSGHDRSZ( );
+ }
+
+ /* Recurse in all children and update the sz information */
+ for (ch = _C(object)->children.next; ch != &_C(object)->children; ch = ch->next) {
+ CHECK_FCT( fd_msg_update_length ( ch->o ) );
+
+ /* Add the padded size to the parent */
+ sz += PAD4( _A(ch->o)->avp_public.avp_len );
+ }
+ }
+
+ /* When we arrive here, the "sz" variable contains the size to write in the object */
+ if (_C(object)->type == MSG_AVP)
+ _A(object)->avp_public.avp_len = sz;
+ else
+ _M(object)->msg_public.msg_length = sz;
+
+ return 0;
+}
+
+/***************************************************************************************************************/
+/* Macro to check if further callbacks must be called */
+#define TEST_ACTION_STOP() \
+ if ((*msg == NULL) || (*action != DISP_ACT_CONT)) \
+ goto out;
+
+/* Call all dispatch callbacks for a given message */
+int fd_msg_dispatch ( struct msg ** msg, struct session * session, enum disp_action *action, char ** error_code, char ** drop_reason, struct msg ** drop_msg)
+{
+ struct dictionary * dict;
+ struct dict_object * app;
+ struct dict_object * cmd;
+ struct avp * avp;
+ struct fd_list * cb_list;
+ int ret = 0, r2;
+
+ TRACE_ENTRY("%p %p %p %p", msg, session, action, error_code);
+ CHECK_PARAMS( msg && CHECK_MSG(*msg) && action);
+
+ if (error_code)
+ *error_code = NULL;
+ if (drop_reason)
+ *drop_reason = NULL;
+ *action = DISP_ACT_CONT;
+
+ /* Take the dispatch lock */
+ CHECK_FCT( pthread_rwlock_rdlock(&fd_disp_lock) );
+ pthread_cleanup_push( fd_cleanup_rwlock, &fd_disp_lock );
+
+ /* First, call the DISP_HOW_ANY callbacks */
+ CHECK_FCT_DO( ret = fd_disp_call_cb_int( NULL, msg, NULL, session, action, NULL, NULL, NULL, NULL, drop_reason, drop_msg ), goto out );
+
+ TEST_ACTION_STOP();
+
+ /* If we don't know the model at this point, we stop cause we cannot get the dictionary. It's invalid: an error should already have been trigged by ANY callbacks */
+ CHECK_PARAMS_DO(cmd = (*msg)->msg_model, { ret = EINVAL; goto out; } );
+
+ /* Now resolve message application */
+ CHECK_FCT_DO( ret = fd_dict_getdict( cmd, &dict ), goto out );
+ CHECK_FCT_DO( ret = fd_dict_search( dict, DICT_APPLICATION, APPLICATION_BY_ID, &(*msg)->msg_public.msg_appl, &app, 0 ), goto out );
+
+ if (app == NULL) {
+ if ((*msg)->msg_public.msg_flags & CMD_FLAG_REQUEST) {
+ if (error_code)
+ *error_code = "DIAMETER_APPLICATION_UNSUPPORTED";
+ *action = DISP_ACT_ERROR;
+ } else {
+ *drop_reason = "Internal error: Received this answer to a local query with an unsupported application";
+ *drop_msg = *msg;
+ *msg = NULL;
+ }
+ goto out;
+ }
+
+ /* So start browsing the message */
+ CHECK_FCT_DO( ret = fd_msg_browse( *msg, MSG_BRW_FIRST_CHILD, &avp, NULL ), goto out );
+ while (avp != NULL) {
+ /* For unknown AVP, we don't have a callback registered, so just skip */
+ if (avp->avp_model) {
+ struct dict_object * enumval = NULL;
+
+ /* Get the list of callback for this AVP */
+ CHECK_FCT_DO( ret = fd_dict_disp_cb(DICT_AVP, avp->avp_model, &cb_list), goto out );
+
+ /* We search enumerated values only in case of non-grouped AVP */
+ if ( avp->avp_public.avp_value ) {
+ struct dict_object * type;
+ /* Check if the AVP has a constant value */
+ CHECK_FCT_DO( ret = fd_dict_search(dict, DICT_TYPE, TYPE_OF_AVP, avp->avp_model, &type, 0), goto out );
+ if (type) {
+ struct dict_enumval_request req;
+ memset(&req, 0, sizeof(struct dict_enumval_request));
+ req.type_obj = type;
+ memcpy( &req.search.enum_value, avp->avp_public.avp_value, sizeof(union avp_value) );
+ CHECK_FCT_DO( ret = fd_dict_search(dict, DICT_ENUMVAL, ENUMVAL_BY_STRUCT, &req, &enumval, 0), goto out );
+ }
+ }
+
+ /* Call the callbacks */
+ CHECK_FCT_DO( ret = fd_disp_call_cb_int( cb_list, msg, avp, session, action, app, cmd, avp->avp_model, enumval, drop_reason, drop_msg ), goto out );
+ TEST_ACTION_STOP();
+ }
+ /* Go to next AVP */
+ CHECK_FCT_DO( ret = fd_msg_browse( avp, MSG_BRW_WALK, &avp, NULL ), goto out );
+ }
+
+ /* Now call command and application callbacks */
+ CHECK_FCT_DO( ret = fd_dict_disp_cb(DICT_COMMAND, cmd, &cb_list), goto out );
+ CHECK_FCT_DO( ret = fd_disp_call_cb_int( cb_list, msg, NULL, session, action, app, cmd, NULL, NULL, drop_reason, drop_msg ), goto out );
+ TEST_ACTION_STOP();
+
+ if (app) {
+ CHECK_FCT_DO( ret = fd_dict_disp_cb(DICT_APPLICATION, app, &cb_list), goto out );
+ CHECK_FCT_DO( ret = fd_disp_call_cb_int( cb_list, msg, NULL, session, action, app, cmd, NULL, NULL, drop_reason, drop_msg ), goto out );
+ TEST_ACTION_STOP();
+ }
+out:
+ ; /* some systems would complain without this */
+ pthread_cleanup_pop(0);
+
+ CHECK_POSIX_DO(r2 = pthread_rwlock_unlock(&fd_disp_lock), /* ignore */ );
+ return ret ?: r2;
+}
+
+
diff --git a/libfdproto/ostr.c b/libfdproto/ostr.c
new file mode 100644
index 0000000..0dc9972
--- /dev/null
+++ b/libfdproto/ostr.c
@@ -0,0 +1,561 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2013, 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. *
+*********************************************************************************************************/
+
+#include "fdproto-internal.h"
+
+#if (!defined(DIAMID_IDNA_IGNORE) && !defined(DIAMID_IDNA_REJECT))
+/* Process IDNA with stringprep -- See RFC5890 -- and libidn documentation... */
+#include <idna.h> /* idna_to_ascii_8z() */
+#endif /* !defined(DIAMID_IDNA_IGNORE) && !defined(DIAMID_IDNA_REJECT) */
+
+/* Similar to strdup with (must have been verified) os0_t */
+os0_t os0dup_int(os0_t s, size_t l) {
+ os0_t r;
+ CHECK_MALLOC_DO( r = malloc(l+1), return NULL );
+ if (l)
+ memcpy(r, s, l); /* this might be faster than a strcpy or strdup because it can work with 32 or 64b blocks */
+ r[l] = '\0';
+ return r;
+}
+
+/* case sensitive comparison, fast */
+int fd_os_cmp_int(uint8_t * os1, size_t os1sz, uint8_t * os2, size_t os2sz)
+{
+ ASSERT( os1 && os2);
+ if (os1sz < os2sz)
+ return -1;
+ if (os1sz > os2sz)
+ return 1;
+ return os1sz ? memcmp(os1, os2, os1sz) : 0;
+}
+
+/* a local version of tolower() that does not depend on LC_CTYPE locale */
+static inline uint8_t asciitolower(uint8_t a)
+{
+ if ((a >= 'A') && (a <= 'Z'))
+ return a + 32 /* == 'a' - 'A' */;
+ return a;
+}
+
+/* less sensitive to case, slower. */
+/* the semantics of "maybefurther" assume you are searching for os1 in a list of elements ordered, each element passed as os2 */
+int fd_os_almostcasesrch_int(uint8_t * os1, size_t os1sz, uint8_t * os2, size_t os2sz, int *maybefurther)
+{
+ int i;
+ int res = 0;
+
+ ASSERT( os1 && os2);
+ if (maybefurther)
+ *maybefurther = 0;
+
+ if (os1sz < os2sz)
+ return -1;
+
+ if (maybefurther)
+ *maybefurther = 1;
+
+ if (os1sz > os2sz)
+ return 1;
+
+ for (i = 0; i < os1sz; i++) {
+ if (os1[i] == os2[i])
+ continue;
+
+ if (!res)
+ res = os1[i] < os2[i] ? -1 : 1;
+
+ if (asciitolower(os1[i]) == asciitolower(os2[i]))
+ continue;
+
+ return res;
+ }
+
+ return 0;
+}
+
+/* Check if the string contains only ASCII */
+int fd_os_is_valid_DiameterIdentity(uint8_t * os, size_t ossz)
+{
+#ifdef DIAMID_IDNA_IGNORE
+
+ /* Allow anything */
+
+#else /* DIAMID_IDNA_IGNORE */
+
+ int i;
+
+ /* Allow only letters, digits, hyphen, dot */
+ for (i=0; i < ossz; i++) {
+ if (os[i] > 'z')
+ break;
+ if (os[i] >= 'a')
+ continue;
+ if ((os[i] >= 'A') && (os[i] <= 'Z'))
+ continue;
+ if ((os[i] == '-') || (os[i] == '.'))
+ continue;
+ if ((os[i] >= '0') && (os[i] <= '9'))
+ continue;
+ break;
+ }
+ if (i < ossz) {
+ int nb = 1;
+ /* To get a better display, check if the invalid char is UTF-8 */
+ if ((os[i] & 0xE0) == 0xC0 /* 110xxxxx */) {
+ if ((i < ossz - 1) && ((os[i + 1] & 0xC0) == 0x80 /* 10xxxxxx */))
+ nb = 2;
+ goto disp;
+ }
+ if ((os[i] & 0xF0) == 0xE0 /* 1110xxxx */) {
+ if ((i < ossz - 2) && ((os[i + 1] & 0xC0) == 0x80 /* 10xxxxxx */)
+ && ((os[i + 2] & 0xC0) == 0x80 /* 10xxxxxx */))
+ nb = 3;
+ goto disp;
+ }
+ if ((os[i] & 0xF8) == 0xF0 /* 11110xxx */) {
+ if ((i < ossz - 3) && ((os[i + 1] & 0xC0) == 0x80 /* 10xxxxxx */)
+ && ((os[i + 2] & 0xC0) == 0x80 /* 10xxxxxx */)
+ && ((os[i + 3] & 0xC0) == 0x80 /* 10xxxxxx */))
+ nb = 4;
+ goto disp;
+ }
+ if ((os[i] & 0xFC) == 0xF8 /* 111110xx */) {
+ if ((i < ossz - 4) && ((os[i + 1] & 0xC0) == 0x80 /* 10xxxxxx */)
+ && ((os[i + 2] & 0xC0) == 0x80 /* 10xxxxxx */)
+ && ((os[i + 3] & 0xC0) == 0x80 /* 10xxxxxx */)
+ && ((os[i + 4] & 0xC0) == 0x80 /* 10xxxxxx */))
+ nb = 5;
+ goto disp;
+ }
+ if ((os[i] & 0xFE) == 0xFC /* 1111110x */) {
+ if ((i < ossz - 5) && ((os[i + 1] & 0xC0) == 0x80 /* 10xxxxxx */)
+ && ((os[i + 2] & 0xC0) == 0x80 /* 10xxxxxx */)
+ && ((os[i + 3] & 0xC0) == 0x80 /* 10xxxxxx */)
+ && ((os[i + 4] & 0xC0) == 0x80 /* 10xxxxxx */)
+ && ((os[i + 5] & 0xC0) == 0x80 /* 10xxxxxx */))
+ nb = 6;
+ goto disp;
+ }
+ /* otherwise, we just display the hex code */
+ TRACE_DEBUG(INFO, "Invalid character (0x%hhX) at offset %d in DiameterIdentity '%.*s'", os[i], i+1, (int)ossz, os);
+ return 0;
+disp:
+ TRACE_DEBUG(INFO, "Invalid character '%.*s' at offset %d in DiameterIdentity '%.*s'", nb, os + i, i+1, (int)ossz, os);
+ return 0;
+ }
+
+#endif /* DIAMID_IDNA_IGNORE */
+
+ return 1;
+}
+
+/* The following function validates a string as a Diameter Identity or applies the IDNA transformation on it
+ if *inoutsz is != 0 on entry, *id may not be \0-terminated.
+ memory has the following meaning: 0: *id can be realloc'd. 1: *id must be malloc'd on output (was static)
+*/
+int fd_os_validate_DiameterIdentity(char ** id, size_t * inoutsz, int memory)
+{
+#if !defined(DIAMID_IDNA_IGNORE) && !defined(DIAMID_IDNA_REJECT)
+ int gotsize = 0;
+#endif /* defined(DIAMID_IDNA_IGNORE) || defined(DIAMID_IDNA_REJECT) */
+
+ TRACE_ENTRY("%p %p", id, inoutsz);
+ CHECK_PARAMS( id && *id && inoutsz );
+
+ if (!*inoutsz)
+ *inoutsz = strlen(*id);
+#if !defined(DIAMID_IDNA_IGNORE) && !defined(DIAMID_IDNA_REJECT)
+ else
+ gotsize = 1;
+#endif /* defined(DIAMID_IDNA_IGNORE) || defined(DIAMID_IDNA_REJECT) */
+
+#ifndef DIAMID_IDNA_IGNORE
+
+ if (!fd_os_is_valid_DiameterIdentity((os0_t)*id, *inoutsz)) {
+
+#ifdef DIAMID_IDNA_REJECT
+
+ TRACE_DEBUG(INFO, "The string '%s' is not a valid DiameterIdentity!", *id);
+ TRACE_DEBUG(INFO, "Returning EINVAL since fD is compiled with option DIAMID_IDNA_REJECT.");
+ return EINVAL;
+
+#else /* DIAMID_IDNA_REJECT */
+
+ char *processed;
+ int ret;
+
+ if (gotsize) { /* make it \0-terminated */
+ if (memory) {
+ CHECK_MALLOC( *id = os0dup(*id, *inoutsz) );
+ memory = 0;
+ } else {
+ CHECK_MALLOC( *id = realloc(*id, *inoutsz + 1) );
+ (*id)[*inoutsz] = '0';
+ }
+ }
+
+ ret = idna_to_ascii_8z ( *id, &processed, IDNA_USE_STD3_ASCII_RULES );
+ if (ret == IDNA_SUCCESS) {
+ TRACE_DEBUG(INFO, "The string '%s' is not a valid DiameterIdentity, it was changed to '%s'", *id, processed);
+ if (memory == 0)
+ free(*id);
+ *id = processed;
+ *inoutsz = strlen(processed);
+ /* Done! */
+ } else {
+ TRACE_DEBUG(INFO, "The string '%s' is not a valid DiameterIdentity and cannot be sanitanized: %s", *id, idna_strerror (ret));
+ return EINVAL;
+ }
+
+#endif /* DIAMID_IDNA_REJECT */
+ } else
+#endif /* ! DIAMID_IDNA_IGNORE */
+ {
+ if (memory == 1) {
+ CHECK_MALLOC( *id = os0dup(*id, *inoutsz) );
+ }
+ }
+ return 0;
+}
+
+/* Analyze a DiameterURI and return its components.
+ Return EINVAL if the URI is not valid.
+ *diamid is malloc'd on function return and must be freed (it is processed by fd_os_validate_DiameterIdentity).
+ *secure is 0 (no security) or 1 (security enabled) on return.
+ *port is 0 (default) or a value in host byte order on return.
+ *transport is 0 (default) or IPPROTO_* on return.
+ *proto is 0 (default) or 'd' (diameter), 'r' (radius), or 't' (tacacs+) on return.
+ */
+int fd_os_parse_DiameterURI(uint8_t * uri, size_t urisz, DiamId_t * diamid, size_t * diamidlen, int * secure, uint16_t * port, int * transport, char *proto)
+{
+ size_t offset = 0;
+ DiamId_t fqdn = NULL;
+ size_t fqdnlen;
+ TRACE_ENTRY("%p %zd %p %p %p %p %p %p", uri, urisz, diamid, diamidlen, secure, port, transport, proto);
+ CHECK_PARAMS( uri && urisz );
+
+ CHECK_PARAMS( urisz > 7 ); /* "aaa" + "://" + something else at least */
+
+ /* Initialize values */
+ if (secure)
+ *secure = 0;
+ if (port)
+ *port = 0;
+ if (transport)
+ *transport = 0;
+ if (proto)
+ *proto = 0;
+
+ /* Check the beginning */
+ if (memcmp( uri, "aaa", 3)) {
+ TRACE_DEBUG(INFO, "Invalid DiameterURI prefix: got '%.*s', expected 'aaa'", 3, uri);
+ return EINVAL;
+ }
+ offset += 3;
+
+ /* Secure? */
+ if (uri[offset] == (uint8_t)'s') {
+ if (secure)
+ *secure = 1;
+ offset += 1;
+ }
+
+ /* Remaining of URI marker */
+ if (memcmp( uri + offset, "://", 3)) {
+ TRACE_DEBUG(INFO, "Invalid DiameterURI prefix: got '%.*s', expected 'aaa://' or 'aaas://'", (int)offset + 3, uri);
+ return EINVAL;
+ }
+ offset += 3;
+
+ /* This is the start of the FQDN */
+ fqdn = (DiamId_t)uri + offset;
+ for ( ; offset < urisz ; offset++ ) {
+ /* Stop only when we find ':' or ';' */
+ if ((uri[offset] == (uint8_t)':') || (uri[offset] == (uint8_t)';'))
+ break;
+ }
+ fqdnlen = offset - (fqdn - (DiamId_t)uri);
+ CHECK_FCT(fd_os_validate_DiameterIdentity(&fqdn, &fqdnlen, 1));
+ if (diamid)
+ *diamid = fqdn;
+ else
+ free(fqdn);
+ if (diamidlen)
+ *diamidlen = fqdnlen;
+
+ if (offset == urisz)
+ return 0; /* Finished */
+
+ /* Is there a port ? */
+ if (uri[offset] == ':') {
+ uint16_t p = 0;
+ do {
+ offset++;
+
+ if (offset == urisz)
+ break;
+
+ uint32_t t = (uint32_t)((char)uri[offset] - '0');
+ if (t > 9)
+ break; /* we did not get a digit */
+
+ t += p * 10; /* the port is specified in decimal base */
+
+ if (t >= (1<<16)) {
+ TRACE_DEBUG(INFO, "Invalid DiameterURI: port value is too big.");
+ return EINVAL;
+ }
+
+ p = t;
+ } while (1);
+
+ if (port)
+ *port = p;
+ }
+
+ if (offset == urisz)
+ return 0; /* Finished */
+
+ /* Is there a transport? */
+ if ( (urisz - offset > CONSTSTRLEN(";transport="))
+ && !strncasecmp((char *)uri + offset, ";transport=", CONSTSTRLEN(";transport=")) ) {
+
+ offset += CONSTSTRLEN(";transport=");
+
+ if (urisz - offset < 3) {
+ TRACE_DEBUG(INFO, "Invalid DiameterURI: transport string is too short, ignored.");
+ return 0;
+ }
+ if (!strncasecmp((char *)uri + offset, "tcp", CONSTSTRLEN("tcp"))) {
+ if (transport)
+ *transport = IPPROTO_TCP;
+ offset += CONSTSTRLEN("tcp");
+ goto after_transport;
+ }
+ if (!strncasecmp((char *)uri + offset, "udp", CONSTSTRLEN("udp"))) {
+ if (transport)
+ *transport = IPPROTO_UDP;
+ offset += CONSTSTRLEN("udp");
+ goto after_transport;
+ }
+ if ((urisz - offset > 3) && !strncasecmp((char *)uri + offset, "sctp", CONSTSTRLEN("sctp"))) {
+ if (transport) {
+#ifndef DISABLE_SCTP
+ *transport = IPPROTO_SCTP;
+#else /* DISABLE_SCTP */
+ TRACE_DEBUG(INFO, "Received DiameterURI with 'transport=sctp' but DISABLE_SCTP was selected");
+ *transport = 0;
+#endif /* DISABLE_SCTP */
+ }
+ offset += CONSTSTRLEN("sctp");
+ goto after_transport;
+ }
+
+ TRACE_DEBUG(INFO, "Invalid DiameterURI: transport string is not recognized ('%.*s').", (int)(urisz - offset), uri + offset);
+ return EINVAL;
+ }
+after_transport:
+ if (offset == urisz)
+ return 0; /* Finished */
+
+ /* Is there a protocol? */
+ if ( ((urisz - offset) > CONSTSTRLEN(";protocol="))
+ && (!strncasecmp((char *)uri + offset, ";protocol=", CONSTSTRLEN(";protocol="))) ) {
+
+ offset += CONSTSTRLEN(";protocol=");
+
+ if ( ((urisz - offset) >= CONSTSTRLEN("diameter"))
+ && (!strncasecmp((char *)uri + offset, "diameter", CONSTSTRLEN("diameter"))) ) {
+ if (proto)
+ *proto = 'd';
+ offset += CONSTSTRLEN("diameter");
+ goto after_proto;
+ }
+
+ if ( ((urisz - offset) >= CONSTSTRLEN("radius"))
+ && (!strncasecmp((char *)uri + offset, "radius", CONSTSTRLEN("radius"))) ) {
+ if (proto)
+ *proto = 'r';
+ offset += CONSTSTRLEN("radius");
+ goto after_proto;
+ }
+
+ if ( ((urisz - offset) >= CONSTSTRLEN("tacacs+"))
+ && (!strncasecmp((char *)uri + offset, "tacacs+", CONSTSTRLEN("tacacs+"))) ) {
+ if (proto)
+ *proto = 't';
+ offset += CONSTSTRLEN("tacacs+");
+ goto after_proto;
+ }
+
+ TRACE_DEBUG(INFO, "Invalid DiameterURI: protocol string is not recognized ('%.*s').", (int)(urisz - offset), uri + offset);
+ return EINVAL;
+
+ }
+after_proto:
+ if (offset == urisz)
+ return 0; /* Finished */
+
+ TRACE_DEBUG(INFO, "Invalid DiameterURI: final part of string is not recognized ('%.*s').", (int)(urisz - offset), uri + offset);
+ return EINVAL;
+}
+
+
+/********************************************************************************************************/
+/* Hash function -- credits to Austin Appleby, thank you ^^ */
+/* See http://murmurhash.googlepages.com for more information on this function */
+
+/* the strings are NOT always aligned properly (ex: received in RADIUS message), so we use the aligned MurmurHash2 function as needed */
+#define _HASH_MIX(h,k,m) { k *= m; k ^= k >> r; k *= m; h *= m; h ^= k; }
+uint32_t fd_os_hash ( uint8_t * string, size_t len )
+{
+ uint32_t hash = len;
+ uint8_t * data = string;
+
+ const unsigned int m = 0x5bd1e995;
+ const int r = 24;
+ int align = (long)string & 3;
+
+ if (!align || (len < 4)) {
+ /* In case data is aligned, MurmurHash2 function */
+ while(len >= 4)
+ {
+ /* Mix 4 bytes at a time into the hash */
+ uint32_t k = *(uint32_t *)data; /* We don't care about the byte order */
+
+ _HASH_MIX(hash, k, m);
+
+ data += 4;
+ len -= 4;
+ }
+
+ /* Handle the last few bytes of the input */
+ switch(len) {
+ case 3: hash ^= data[2] << 16;
+ case 2: hash ^= data[1] << 8;
+ case 1: hash ^= data[0];
+ hash *= m;
+ }
+
+ } else {
+ /* Unaligned data, use alignment-safe slower version */
+
+ /* Pre-load the temp registers */
+ uint32_t t = 0, d = 0;
+ switch(align)
+ {
+ case 1: t |= data[2] << 16;
+ case 2: t |= data[1] << 8;
+ case 3: t |= data[0];
+ }
+ t <<= (8 * align);
+
+ data += 4-align;
+ len -= 4-align;
+
+ /* From this point, "data" can be read by chunks of 4 bytes */
+
+ int sl = 8 * (4-align);
+ int sr = 8 * align;
+
+ /* Mix */
+ while(len >= 4)
+ {
+ uint32_t k;
+
+ d = *(unsigned int *)data;
+ k = (t >> sr) | (d << sl);
+
+ _HASH_MIX(hash, k, m);
+
+ t = d;
+
+ data += 4;
+ len -= 4;
+ }
+
+ /* Handle leftover data in temp registers */
+ d = 0;
+ if(len >= align)
+ {
+ uint32_t k;
+
+ switch(align)
+ {
+ case 3: d |= data[2] << 16;
+ case 2: d |= data[1] << 8;
+ case 1: d |= data[0];
+ }
+
+ k = (t >> sr) | (d << sl);
+ _HASH_MIX(hash, k, m);
+
+ data += align;
+ len -= align;
+
+ /* Handle tail bytes */
+
+ switch(len)
+ {
+ case 3: hash ^= data[2] << 16;
+ case 2: hash ^= data[1] << 8;
+ case 1: hash ^= data[0];
+ hash *= m;
+ };
+ }
+ else
+ {
+ switch(len)
+ {
+ case 3: d |= data[2] << 16;
+ case 2: d |= data[1] << 8;
+ case 1: d |= data[0];
+ case 0: hash ^= (t >> sr) | (d << sl);
+ hash *= m;
+ }
+ }
+
+
+ }
+
+ /* Do a few final mixes of the hash to ensure the last few
+ bytes are well-incorporated. */
+ hash ^= hash >> 13;
+ hash *= m;
+ hash ^= hash >> 15;
+
+ return hash;
+}
+
diff --git a/libfdproto/portability.c b/libfdproto/portability.c
new file mode 100644
index 0000000..7111cc3
--- /dev/null
+++ b/libfdproto/portability.c
@@ -0,0 +1,70 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2012, 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. *
+*********************************************************************************************************/
+
+#include "fdproto-internal.h"
+
+/* Replacement for clock_gettime for the Mac OS */
+#ifndef HAVE_CLOCK_GETTIME
+int clock_gettime(int clk_id, struct timespec* ts)
+{
+ struct timeval tv;
+ gettimeofday (&tv, NULL);
+ ts->tv_sec = tv.tv_sec;
+ ts->tv_nsec = tv.tv_usec * 1000;
+ return 0;
+}
+#endif /* HAVE_CLOCK_GETTIME */
+
+/* Replacement for strndup for the Mac OS */
+#ifndef HAVE_STRNDUP
+char * strndup (char *str, size_t len)
+{
+ char * output;
+ size_t outlen;
+
+ output = memchr(str, 0, len);
+ if (output == NULL) {
+ outlen = len;
+ } else {
+ outlen = output - str;
+ }
+
+ CHECK_MALLOC_DO( output = malloc (outlen + 1), return NULL );
+
+ output[outlen] = '\0';
+ memcpy (output, str, outlen);
+ return output;
+}
+#endif /* HAVE_STRNDUP */
diff --git a/libfdproto/rt_data.c b/libfdproto/rt_data.c
new file mode 100644
index 0000000..f205ef3
--- /dev/null
+++ b/libfdproto/rt_data.c
@@ -0,0 +1,338 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2013, 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. *
+*********************************************************************************************************/
+
+/* Routing module helpers.
+ *
+ * This file provides support for the rt_data structure manipulation.
+ */
+
+#include "fdproto-internal.h"
+
+/* Structure that contains the routing data for a message */
+struct rt_data {
+ int extracted; /* if 0, candidates is ordered by diamid, otherwise the order is unspecified. This also counts the number of times the message was (re-)sent, as a side effect */
+ struct fd_list candidates; /* All the candidates. Items are struct rtd_candidate. */
+ struct fd_list errors; /* All errors received from other peers for this message */
+};
+
+/* Items of the errors list */
+struct rtd_error {
+ struct fd_list chain; /* link in the list, ordered by nexthop (fd_os_cmp) */
+ DiamId_t nexthop;/* the peer the message was sent to */
+ size_t nexthoplen; /* cached string length */
+ DiamId_t erh; /* the origin of the error */
+ size_t erhlen; /* cached string length */
+ uint32_t code; /* the error code */
+};
+
+/* Create a new structure to store routing data */
+int fd_rtd_init(struct rt_data ** rtd)
+{
+ struct rt_data *new;
+ TRACE_ENTRY("%p", rtd);
+ CHECK_PARAMS(rtd);
+
+ /* Alloc the structure */
+ CHECK_MALLOC( new = malloc(sizeof(struct rt_data)) );
+ memset(new, 0, sizeof(struct rt_data) );
+ fd_list_init(&new->candidates, new);
+ fd_list_init(&new->errors, new);
+
+ *rtd = new;
+ return 0;
+}
+
+/* Destroy the routing data */
+void fd_rtd_free(struct rt_data ** rtd)
+{
+ struct rt_data *old;
+
+ TRACE_ENTRY("%p", rtd);
+ CHECK_PARAMS_DO(rtd, return );
+
+ old = *rtd;
+ *rtd = NULL;
+
+ while (!FD_IS_LIST_EMPTY(&old->candidates)) {
+ struct rtd_candidate * c = (struct rtd_candidate *) old->candidates.next;
+
+ fd_list_unlink(&c->chain);
+ free(c->diamid);
+ free(c->realm);
+ free(c);
+ }
+
+ while (!FD_IS_LIST_EMPTY(&old->errors)) {
+ struct rtd_error * c = (struct rtd_error *) old->errors.next;
+
+ fd_list_unlink(&c->chain);
+ free(c->nexthop);
+ free(c->erh);
+ free(c);
+ }
+
+ free(old);
+
+ return;
+}
+
+/* Add a peer to the candidates list. The source is our local peer list, so no need to care for the case here. */
+int fd_rtd_candidate_add(struct rt_data * rtd, DiamId_t peerid, size_t peeridlen, DiamId_t realm, size_t realmlen)
+{
+ struct fd_list * prev;
+ struct rtd_candidate * new;
+
+ TRACE_ENTRY("%p %p %zd %p %zd", rtd, peerid, peeridlen, realm, realmlen);
+ CHECK_PARAMS(rtd && peerid && peeridlen);
+
+ /* Since the peers are ordered when they are added (fd_g_activ_peers) we search for the position from the end -- this should be efficient */
+ for (prev = rtd->candidates.prev; prev != &rtd->candidates; prev = prev->prev) {
+ struct rtd_candidate * cp = (struct rtd_candidate *) prev;
+ int cmp = fd_os_cmp(peerid, peeridlen, cp->diamid, cp->diamidlen);
+ if (cmp > 0)
+ break;
+ if (cmp == 0)
+ /* The candidate is already in the list */
+ return 0;
+ }
+
+ /* Create the new entry */
+ CHECK_MALLOC( new = malloc(sizeof(struct rtd_candidate)) );
+ memset(new, 0, sizeof(struct rtd_candidate) );
+ fd_list_init(&new->chain, new);
+ CHECK_MALLOC( new->diamid = os0dup(peerid, peeridlen) )
+ new->diamidlen = peeridlen;
+ if (realm) {
+ CHECK_MALLOC( new->realm = os0dup(realm, realmlen) )
+ new->realmlen = realmlen;
+ }
+
+ /* insert in the list at the correct position */
+ fd_list_insert_after(prev, &new->chain);
+
+ return 0;
+}
+
+/* Remove a peer from the candidates (if it is found). Case insensitive search since the names are received from other peers */
+void fd_rtd_candidate_del(struct rt_data * rtd, uint8_t * id, size_t idsz)
+{
+ struct fd_list * li;
+
+ TRACE_ENTRY("%p %p %zd", rtd, id, idsz);
+ CHECK_PARAMS_DO( rtd && id && idsz, return );
+
+ if (!fd_os_is_valid_DiameterIdentity(id, idsz))
+ /* it cannot be in the list */
+ return;
+
+ for (li = rtd->candidates.next; li != &rtd->candidates; li = li->next) {
+ struct rtd_candidate * c = (struct rtd_candidate *) li;
+ int cont;
+ int cmp = fd_os_almostcasesrch(id, idsz, c->diamid, c->diamidlen, &cont);
+
+ if (!cmp) {
+ /* Found it! Remove it */
+ fd_list_unlink(&c->chain);
+ free(c->diamid);
+ free(c->realm);
+ free(c);
+ break;
+ }
+
+ if (cont)
+ continue;
+
+ /* The list is guaranteed to be ordered only if not extracted */
+ if (! rtd->extracted)
+ break;
+ }
+
+ return;
+}
+
+/* If a peer returned a protocol error for this message, save it so that we don't try to send it there again.
+ Case insensitive search since the names are received from other peers*/
+int fd_rtd_error_add(struct rt_data * rtd, DiamId_t sentto, size_t senttolen, uint8_t * origin, size_t originsz, uint32_t rcode, struct fd_list ** candidates, int * sendingattemtps)
+{
+ struct fd_list * li;
+ int match = 0;
+
+ TRACE_ENTRY("%p %p %zd %p %zd %u %p %p", rtd, sentto, senttolen, origin, originsz, rcode, candidates, sendingattemtps);
+ CHECK_PARAMS( rtd && sentto && senttolen ); /* origin may be NULL */
+
+ /* First add the new error entry */
+ for (li = rtd->errors.next; li != &rtd->errors; li = li->next) {
+ struct rtd_error * e = (struct rtd_error *) li;
+ int cmp = fd_os_cmp(sentto, senttolen, e->nexthop, e->nexthoplen);
+ if (cmp > 0)
+ continue;
+ if (!cmp)
+ match = 1;
+ break;
+ }
+
+ /* If we already had this entry, we should not have sent the message again to this peer... anyway, let's close our eyes. */
+ /* in the normal case, we save the error */
+ if (!match) {
+ /* Add a new entry in the error list */
+ struct rtd_error * new;
+ CHECK_MALLOC( new = malloc(sizeof(struct rtd_error)) );
+ memset(new, 0, sizeof(struct rtd_error));
+ fd_list_init(&new->chain, NULL);
+
+ CHECK_MALLOC(new->nexthop = os0dup(sentto, senttolen));
+ new->nexthoplen = senttolen;
+
+ if (origin) {
+ if (!originsz) {
+ originsz=strlen((char *)origin);
+ } else {
+ if (!fd_os_is_valid_DiameterIdentity(origin, originsz)){
+ TRACE_DEBUG(FULL, "Received error %d from peer with invalid Origin-Host AVP, not saved", rcode);
+ origin = NULL;
+ goto after_origin;
+ }
+ }
+ CHECK_MALLOC( new->erh = (DiamId_t)os0dup(origin, originsz) );
+ new->erhlen = originsz;
+ }
+after_origin:
+ new->code = rcode;
+ fd_list_insert_before(li, &new->chain);
+ }
+
+ /* Finally, remove this (these) peers from the candidate list */
+ fd_rtd_candidate_del(rtd, (os0_t)sentto, senttolen);
+ if (origin)
+ fd_rtd_candidate_del(rtd, origin, originsz);
+
+ if (candidates)
+ *candidates = &rtd->candidates;
+
+ if (sendingattemtps)
+ *sendingattemtps = rtd->extracted;
+
+ /* Done! */
+ return 0;
+}
+
+/* Only retrieve the number of times this message has been processed by the routing-out mechanism (i.e. number of times it was failed over) */
+int fd_rtd_get_nb_attempts(struct rt_data * rtd, int * sendingattemtps)
+{
+ TRACE_ENTRY("%p %p", rtd, sendingattemtps);
+ CHECK_PARAMS( rtd && sendingattemtps );
+
+ *sendingattemtps = rtd->extracted;
+
+ /* Done! */
+ return 0;
+}
+
+/* Extract the list of valid candidates, and initialize their scores */
+void fd_rtd_candidate_extract(struct rt_data * rtd, struct fd_list ** candidates, int ini_score)
+{
+ struct fd_list * li;
+
+ TRACE_ENTRY("%p %p", rtd, candidates);
+ CHECK_PARAMS_DO( candidates, return );
+ CHECK_PARAMS_DO( rtd, { *candidates = NULL; return; } );
+
+ *candidates = &rtd->candidates;
+
+ /* Reset all scores to INITIAL score */
+ for (li = rtd->candidates.next; li != &rtd->candidates; li = li->next) {
+ struct rtd_candidate * c = (struct rtd_candidate *) li;
+ c->score = ini_score;
+ }
+
+ rtd->extracted += 1;
+ return;
+}
+
+/* Reorder the list of peers. If several peer have the same highest score, they are randomized. */
+int fd_rtd_candidate_reorder(struct fd_list * candidates)
+{
+ struct fd_list unordered = FD_LIST_INITIALIZER(unordered), *li;
+ struct fd_list highest = FD_LIST_INITIALIZER(highest);
+ int hs = -1;
+
+ TRACE_ENTRY("%p", candidates);
+ CHECK_PARAMS( candidates );
+
+ /* First, move all items from candidates to the undordered list */
+ fd_list_move_end(&unordered, candidates);
+
+ /* Now extract each element from unordered and add it back to list ordered by score */
+ while (!FD_IS_LIST_EMPTY(&unordered)) {
+ struct rtd_candidate * c = (struct rtd_candidate *) unordered.next;
+
+ fd_list_unlink(&c->chain);
+
+ /* If this candidate has a higher score than the previous ones */
+ if (c->score > hs) {
+ /* Then we move the previous high score items at end of the list */
+ fd_list_move_end(candidates, &highest);
+
+ /* And the new high score is set */
+ hs = c->score;
+ }
+
+ /* If this candidate equals the higher score, add it into highest list at a random place */
+ if (c->score == hs) {
+ if (rand() & 1) {
+ fd_list_insert_after(&highest, &c->chain);
+ } else {
+ fd_list_insert_before(&highest, &c->chain);
+ }
+ /* Otherwise, insert at normal place in the list */
+ } else {
+ /* Find the position in ordered candidates list */
+ for (li = candidates->next; li != candidates; li = li->next) {
+ struct rtd_candidate * cnext = (struct rtd_candidate *) li;
+ if (cnext->score >= c->score)
+ break;
+ }
+
+ /* Add the element there */
+ fd_list_insert_before(li, &c->chain);
+ }
+ }
+
+ /* Now simply move back all the "highest" candidates at the end of the list */
+ fd_list_move_end(candidates, &highest);
+
+ return 0;
+}
+
diff --git a/libfdproto/sessions.c b/libfdproto/sessions.c
new file mode 100644
index 0000000..b6c94fa
--- /dev/null
+++ b/libfdproto/sessions.c
@@ -0,0 +1,940 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2013, 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. *
+*********************************************************************************************************/
+
+/* Sessions module.
+ *
+ * Basic functionalities to help implementing User sessions state machines from RFC3588.
+ */
+
+#include "fdproto-internal.h"
+
+/*********************** Parameters **********************/
+
+/* Size of the hash table containing the session objects (pow of 2. ex: 6 => 2^6 = 64). must be between 0 and 31. */
+#ifndef SESS_HASH_SIZE
+#define SESS_HASH_SIZE 6
+#endif /* SESS_HASH_SIZE */
+
+/* Default lifetime of a session, in seconds. (31 days = 2678400 seconds) */
+#ifndef SESS_DEFAULT_LIFETIME
+#define SESS_DEFAULT_LIFETIME 2678400
+#endif /* SESS_DEFAULT_LIFETIME */
+
+/********************** /Parameters **********************/
+
+/* Eyescatchers definitions */
+#define SH_EYEC 0x53554AD1
+#define SD_EYEC 0x5355D474
+#define SI_EYEC 0x53551D
+
+/* Macro to check an object is valid */
+#define VALIDATE_SH( _obj ) ( ((_obj) != NULL) && ( ((struct session_handler *)(_obj))->eyec == SH_EYEC) )
+#define VALIDATE_SI( _obj ) ( ((_obj) != NULL) && ( ((struct session *)(_obj))->eyec == SI_EYEC) )
+
+
+/* Handlers registered by users of the session module */
+struct session_handler {
+ int eyec; /* An eye catcher also used to ensure the object is valid, must be SH_EYEC */
+ int id; /* A unique integer to identify this handler */
+ void (*cleanup)(struct sess_state *, os0_t, void *); /* The cleanup function to be called for cleaning a state */
+ session_state_dump state_dump; /* dumper function */
+ void *opaque; /* a value that is passed as is to the cleanup callback */
+};
+
+static int hdl_id = 0; /* A global counter to initialize the id field */
+static pthread_mutex_t hdl_lock = PTHREAD_MUTEX_INITIALIZER; /* lock to protect hdl_id; we could use atomic operations otherwise (less portable) */
+
+
+/* Data structures linked from the sessions, containing the applications states */
+struct state {
+ int eyec; /* Must be SD_EYEC */
+ struct sess_state *state; /* The state registered by the application, never NULL (or the whole object is deleted) */
+ struct fd_list chain; /* Chaining in the list of session's states ordered by hdl->id */
+ union {
+ struct session_handler *hdl; /* The handler for which this state was registered */
+ os0_t sid; /* For deleted state, the sid of the session it belong to */
+ };
+};
+
+/* Session object, one for each value of Session-Id AVP */
+struct session {
+ int eyec; /* Eyecatcher, SI_EYEC */
+
+ os0_t sid; /* The \0-terminated Session-Id */
+ size_t sidlen; /* cached length of sid */
+ uint32_t hash; /* computed hash of sid */
+ struct fd_list chain_h;/* chaining in the hash table of sessions. */
+
+ struct timespec timeout;/* Timeout date for the session */
+ struct fd_list expire; /* List of expiring sessions, ordered by timeouts. */
+
+ pthread_mutex_t stlock; /* A lock to protect the list of states associated with this session */
+ struct fd_list states; /* Sentinel for the list of states of this session. */
+ int msg_cnt;/* Reference counter for the messages pointing to this session */
+ int is_destroyed; /* boolean telling if fd_sess_detroy has been called on this */
+};
+
+/* Sessions hash table, to allow fast sid to session retrieval */
+static struct {
+ struct fd_list sentinel; /* sentinel element for this sublist. The sublist is ordered by hash value, then fd_os_cmp(sid). */
+ pthread_mutex_t lock; /* the mutex for this sublist -- we might probably change it to rwlock for a little optimization */
+} sess_hash [ 1 << SESS_HASH_SIZE ] ;
+#define H_MASK( __hash ) ((__hash) & (( 1 << SESS_HASH_SIZE ) - 1))
+#define H_LIST( _hash ) (&(sess_hash[H_MASK(_hash)].sentinel))
+#define H_LOCK( _hash ) (&(sess_hash[H_MASK(_hash)].lock ))
+
+static uint32_t sess_cnt = 0; /* counts all active session (that are in the expiry list) */
+
+/* The following are used to generate sid values that are eternaly unique */
+static uint32_t sid_h; /* initialized to the current time in fd_sess_init */
+static uint32_t sid_l; /* incremented each time a session id is created */
+static pthread_mutex_t sid_lock = PTHREAD_MUTEX_INITIALIZER;
+
+/* Expiring sessions management */
+static struct fd_list exp_sentinel = FD_LIST_INITIALIZER(exp_sentinel); /* list of sessions ordered by their timeout date */
+static pthread_mutex_t exp_lock = PTHREAD_MUTEX_INITIALIZER; /* lock protecting the list. */
+static pthread_cond_t exp_cond = PTHREAD_COND_INITIALIZER; /* condvar used by the expiry mecahinsm. */
+static pthread_t exp_thr = (pthread_t)NULL; /* The expiry thread that handles cleanup of expired sessions */
+
+/* Hierarchy of the locks, to avoid deadlocks:
+ * hash lock > state lock > expiry lock
+ * i.e. state lock can be taken while holding the hash lock, but not while holding the expiry lock.
+ * As well, the hash lock cannot be taken while holding a state lock.
+ */
+
+/********************************************************************************************************/
+
+/* Initialize a session object. It is not linked now. sid must be already malloc'ed. The hash has already been computed. */
+static struct session * new_session(os0_t sid, size_t sidlen, uint32_t hash)
+{
+ struct session * sess;
+
+ TRACE_ENTRY("%p %zd", sid, sidlen);
+ CHECK_PARAMS_DO( sid && sidlen, return NULL );
+
+ CHECK_MALLOC_DO( sess = malloc(sizeof(struct session)), return NULL );
+ memset(sess, 0, sizeof(struct session));
+
+ sess->eyec = SI_EYEC;
+
+ sess->sid = sid;
+ sess->sidlen = sidlen;
+ sess->hash = hash;
+ fd_list_init(&sess->chain_h, sess);
+
+ CHECK_SYS_DO( clock_gettime(CLOCK_REALTIME, &sess->timeout), return NULL );
+ sess->timeout.tv_sec += SESS_DEFAULT_LIFETIME;
+ fd_list_init(&sess->expire, sess);
+
+ CHECK_POSIX_DO( pthread_mutex_init(&sess->stlock, NULL), return NULL );
+ fd_list_init(&sess->states, sess);
+
+ return sess;
+}
+
+/* destroy the session object. It should really be already unlinked... */
+static void del_session(struct session * s)
+{
+ ASSERT(FD_IS_LIST_EMPTY(&s->states));
+ free(s->sid);
+ fd_list_unlink(&s->chain_h);
+ fd_list_unlink(&s->expire);
+ CHECK_POSIX_DO( pthread_mutex_destroy(&s->stlock), /* continue */ );
+ free(s);
+}
+
+/* The expiry thread */
+static void * exp_fct(void * arg)
+{
+ fd_log_threadname ( "Session/expire" );
+ TRACE_ENTRY( "" );
+
+
+ do {
+ struct timespec now;
+ struct session * first;
+
+ CHECK_POSIX_DO( pthread_mutex_lock(&exp_lock), break );
+ pthread_cleanup_push( fd_cleanup_mutex, &exp_lock );
+again:
+ /* Check if there are expiring sessions available */
+ if (FD_IS_LIST_EMPTY(&exp_sentinel)) {
+ /* Just wait for a change or cancelation */
+ CHECK_POSIX_DO( pthread_cond_wait( &exp_cond, &exp_lock ), break /* this might not pop the cleanup handler, but since we ASSERT(0), it is not the big issue... */ );
+ /* Restart the loop on wakeup */
+ goto again;
+ }
+
+ /* Get the pointer to the session that expires first */
+ first = (struct session *)(exp_sentinel.next->o);
+ ASSERT( VALIDATE_SI(first) );
+
+ /* Get the current time */
+ CHECK_SYS_DO( clock_gettime(CLOCK_REALTIME, &now), break );
+
+ /* If first session is not expired, we just wait until it happens */
+ if ( TS_IS_INFERIOR( &now, &first->timeout ) ) {
+
+ CHECK_POSIX_DO2( pthread_cond_timedwait( &exp_cond, &exp_lock, &first->timeout ),
+ ETIMEDOUT, /* ETIMEDOUT is a normal error, continue */,
+ /* on other error, */ break );
+
+ /* on wakeup, loop */
+ goto again;
+ }
+
+ /* Now, the first session in the list is expired; destroy it */
+ pthread_cleanup_pop( 0 );
+ CHECK_POSIX_DO( pthread_mutex_unlock(&exp_lock), break );
+
+ CHECK_FCT_DO( fd_sess_destroy( &first ), break );
+
+ } while (1);
+
+ TRACE_DEBUG(INFO, "A system error occurred in session module! Expiry thread is terminating...");
+ ASSERT(0);
+ return NULL;
+}
+
+
+
+/********************************************************************************************************/
+
+/* Initialize the session module */
+int fd_sess_init(void)
+{
+ int i;
+
+ TRACE_ENTRY( "" );
+
+ /* Initialize the global counters */
+ sid_h = (uint32_t) time(NULL);
+ sid_l = 0;
+
+ /* Initialize the hash table */
+ for (i = 0; i < sizeof(sess_hash) / sizeof(sess_hash[0]); i++) {
+ fd_list_init( &sess_hash[i].sentinel, NULL );
+ CHECK_POSIX( pthread_mutex_init(&sess_hash[i].lock, NULL) );
+ }
+
+ return 0;
+}
+
+/* Run this when initializations are complete. */
+int fd_sess_start(void)
+{
+ /* Start session garbage collector (expiry) */
+ CHECK_POSIX( pthread_create(&exp_thr, NULL, exp_fct, NULL) );
+
+ return 0;
+}
+
+/* Terminate */
+void fd_sess_fini(void)
+{
+ TRACE_ENTRY("");
+ CHECK_FCT_DO( fd_thr_term(&exp_thr), /* continue */ );
+
+ /* Destroy all sessions in the hash table, and the hash table itself? -- How to do it without a race condition ? */
+
+ return;
+}
+
+/* Create a new handler */
+int fd_sess_handler_create ( struct session_handler ** handler, void (*cleanup)(struct sess_state *, os0_t, void *), session_state_dump dumper, void * opaque )
+{
+ struct session_handler *new;
+
+ TRACE_ENTRY("%p %p", handler, cleanup);
+
+ CHECK_PARAMS( handler && cleanup );
+
+ CHECK_MALLOC( new = malloc(sizeof(struct session_handler)) );
+ memset(new, 0, sizeof(struct session_handler));
+
+ CHECK_POSIX( pthread_mutex_lock(&hdl_lock) );
+ new->id = ++hdl_id;
+ CHECK_POSIX( pthread_mutex_unlock(&hdl_lock) );
+
+ new->eyec = SH_EYEC;
+ new->cleanup = cleanup;
+ new->state_dump = dumper;
+ new->opaque = opaque;
+
+ *handler = new;
+ return 0;
+}
+
+/* Destroy a handler, and all states attached to this handler. This operation is very slow but we don't care since it's rarely used.
+ * Note that it's better to call this function after all sessions have been deleted... */
+int fd_sess_handler_destroy ( struct session_handler ** handler, void ** opaque )
+{
+ struct session_handler * del;
+ /* place to save the list of states to be cleaned up. We do it after finding them to avoid deadlocks. the "o" field becomes a copy of the sid. */
+ struct fd_list deleted_states = FD_LIST_INITIALIZER( deleted_states );
+ int i;
+
+ TRACE_ENTRY("%p", handler);
+ CHECK_PARAMS( handler && VALIDATE_SH(*handler) );
+
+ del = *handler;
+ *handler = NULL;
+
+ del->eyec = 0xdead; /* The handler is not valid anymore for any other operation */
+
+ /* Now find all sessions with data registered for this handler, and move this data to the deleted_states list. */
+ for (i = 0; i < sizeof(sess_hash) / sizeof(sess_hash[0]); i++) {
+ struct fd_list * li_si;
+ CHECK_POSIX( pthread_mutex_lock(&sess_hash[i].lock) );
+
+ for (li_si = sess_hash[i].sentinel.next; li_si != &sess_hash[i].sentinel; li_si = li_si->next) { /* for each session in the hash line */
+ struct fd_list * li_st;
+ struct session * sess = (struct session *)(li_si->o);
+ CHECK_POSIX( pthread_mutex_lock(&sess->stlock) );
+ for (li_st = sess->states.next; li_st != &sess->states; li_st = li_st->next) { /* for each state in this session */
+ struct state * st = (struct state *)(li_st->o);
+ /* The list is ordered */
+ if (st->hdl->id < del->id)
+ continue;
+ if (st->hdl->id == del->id) {
+ /* This state belongs to the handler we are deleting, move the item to the deleted_states list */
+ fd_list_unlink(&st->chain);
+ st->sid = sess->sid;
+ fd_list_insert_before(&deleted_states, &st->chain);
+ }
+ break;
+ }
+ CHECK_POSIX( pthread_mutex_unlock(&sess->stlock) );
+ }
+ CHECK_POSIX( pthread_mutex_unlock(&sess_hash[i].lock) );
+ }
+
+ /* Now, delete all states after calling their cleanup handler */
+ while (!FD_IS_LIST_EMPTY(&deleted_states)) {
+ struct state * st = (struct state *)(deleted_states.next->o);
+ TRACE_DEBUG(FULL, "Calling cleanup handler for session '%s' and data %p", st->sid, st->state);
+ (*del->cleanup)(st->state, st->sid, del->opaque);
+ fd_list_unlink(&st->chain);
+ free(st);
+ }
+
+ if (opaque)
+ *opaque = del->opaque;
+
+ /* Free the handler */
+ free(del);
+
+ return 0;
+}
+
+
+
+/* Create a new session object with the default timeout value, and link it. The refcount is increased by 1, whether the session existed or not */
+int fd_sess_new ( struct session ** session, DiamId_t diamid, size_t diamidlen, uint8_t * opt, size_t optlen )
+{
+ os0_t sid = NULL;
+ size_t sidlen;
+ uint32_t hash;
+ struct session * sess;
+ struct fd_list * li;
+ int found = 0;
+ int ret = 0;
+
+ TRACE_ENTRY("%p %p %zd %p %zd", session, diamid, diamidlen, opt, optlen);
+ CHECK_PARAMS( session && (diamid || opt) );
+
+ if (diamid) {
+ if (!diamidlen) {
+ diamidlen = strlen(diamid);
+ }
+ /* We check if the string is a valid DiameterIdentity */
+ CHECK_PARAMS( fd_os_is_valid_DiameterIdentity((uint8_t *)diamid, diamidlen) );
+ } else {
+ diamidlen = 0;
+ }
+ if (opt) {
+ if (!optlen) {
+ optlen = strlen((char *)opt);
+ } else {
+ CHECK_PARAMS( fd_os_is_valid_os0(opt, optlen) );
+ }
+ } else {
+ optlen = 0;
+ }
+
+ /* Ok, first create the identifier for the string */
+ if (diamid == NULL) {
+ /* opt is the full string */
+ CHECK_MALLOC( sid = os0dup(opt, optlen) );
+ sidlen = optlen;
+ } else {
+ uint32_t sid_h_cpy;
+ uint32_t sid_l_cpy;
+ /* "<diamId>;<high32>;<low32>[;opt]" */
+ sidlen = diamidlen;
+ sidlen += 22; /* max size of ';<high32>;<low32>' */
+ if (opt)
+ sidlen += 1 + optlen; /* ';opt' */
+ sidlen++; /* space for the final \0 also */
+ CHECK_MALLOC( sid = malloc(sidlen) );
+
+ CHECK_POSIX( pthread_mutex_lock(&sid_lock) );
+ if ( ++sid_l == 0 ) /* overflow */
+ ++sid_h;
+ sid_h_cpy = sid_h;
+ sid_l_cpy = sid_l;
+ CHECK_POSIX( pthread_mutex_unlock(&sid_lock) );
+
+ if (opt) {
+ sidlen = snprintf((char*)sid, sidlen, "%.*s;%u;%u;%.*s", (int)diamidlen, diamid, sid_h_cpy, sid_l_cpy, (int)optlen, opt);
+ } else {
+ sidlen = snprintf((char*)sid, sidlen, "%.*s;%u;%u", (int)diamidlen, diamid, sid_h_cpy, sid_l_cpy);
+ }
+ }
+
+ hash = fd_os_hash(sid, sidlen);
+
+ /* Now find the place to add this object in the hash table. */
+ CHECK_POSIX( pthread_mutex_lock( H_LOCK(hash) ) );
+ pthread_cleanup_push( fd_cleanup_mutex, H_LOCK(hash) );
+
+ for (li = H_LIST(hash)->next; li != H_LIST(hash); li = li->next) {
+ int cmp;
+ struct session * s = (struct session *)(li->o);
+
+ /* The list is ordered by hash and sid (in case of collisions) */
+ if (s->hash < hash)
+ continue;
+ if (s->hash > hash)
+ break;
+
+ cmp = fd_os_cmp(s->sid, s->sidlen, sid, sidlen);
+ if (cmp < 0)
+ continue;
+ if (cmp > 0)
+ break;
+
+ /* A session with the same sid was already in the hash table */
+ found = 1;
+ *session = s;
+ break;
+ }
+
+ /* If the session did not exist, we can create it & link it in global tables */
+ if (!found) {
+ CHECK_MALLOC_DO(sess = new_session(sid, sidlen, hash),
+ {
+ ret = ENOMEM;
+ free(sid);
+ goto out;
+ } );
+
+ fd_list_insert_before(li, &sess->chain_h); /* hash table */
+ sess->msg_cnt++;
+ } else {
+ free(sid);
+
+ CHECK_POSIX( pthread_mutex_lock(&(*session)->stlock) );
+ (*session)->msg_cnt++;
+ CHECK_POSIX( pthread_mutex_unlock(&(*session)->stlock) );
+
+ /* it was found: was it previously destroyed? */
+ if ((*session)->is_destroyed == 0) {
+ ret = EALREADY;
+ goto out;
+ } else {
+ /* the session was marked destroyed, let's re-activate it. */
+ sess = *session;
+ sess->is_destroyed = 0;
+
+ /* update the expiry time */
+ CHECK_SYS_DO( clock_gettime(CLOCK_REALTIME, &sess->timeout), { ASSERT(0); } );
+ sess->timeout.tv_sec += SESS_DEFAULT_LIFETIME;
+ }
+ }
+
+ /* We must insert in the expiry list */
+ CHECK_POSIX( pthread_mutex_lock( &exp_lock ) );
+ pthread_cleanup_push( fd_cleanup_mutex, &exp_lock );
+
+ /* Find the position in that list. We take it in reverse order */
+ for (li = exp_sentinel.prev; li != &exp_sentinel; li = li->prev) {
+ struct session * s = (struct session *)(li->o);
+ if (TS_IS_INFERIOR( &s->timeout, &sess->timeout ) )
+ break;
+ }
+ fd_list_insert_after( li, &sess->expire );
+ sess_cnt++;
+
+ /* We added a new expiring element, we must signal */
+ if (li == &exp_sentinel) {
+ CHECK_POSIX_DO( pthread_cond_signal(&exp_cond), { ASSERT(0); } ); /* if it fails, we might not pop the cleanup handlers, but this should not happen -- and we'd have a serious problem otherwise */
+ }
+
+ /* We're done with the locked part */
+ pthread_cleanup_pop(0);
+ CHECK_POSIX_DO( pthread_mutex_unlock( &exp_lock ), { ASSERT(0); } ); /* if it fails, we might not pop the cleanup handler, but this should not happen -- and we'd have a serious problem otherwise */
+
+out:
+ ;
+ pthread_cleanup_pop(0);
+ CHECK_POSIX( pthread_mutex_unlock( H_LOCK(hash) ) );
+
+ if (ret) /* in case of error */
+ return ret;
+
+ *session = sess;
+ return 0;
+}
+
+/* Find or create a session -- the msg refcount is increased */
+int fd_sess_fromsid_msg ( uint8_t * sid, size_t len, struct session ** session, int * new)
+{
+ int ret;
+
+ TRACE_ENTRY("%p %zd %p %p", sid, len, session, new);
+ CHECK_PARAMS( sid && session );
+
+ if (!fd_os_is_valid_os0(sid,len)) {
+ TRACE_DEBUG(INFO, "Warning: a Session-Id value contains \\0 chars... (len:%zd, begin:'%.*s') => Debug messages may be truncated.", len, (int)len, sid);
+ }
+
+ /* All the work is done in sess_new */
+ ret = fd_sess_new ( session, NULL, 0, sid, len );
+ switch (ret) {
+ case 0:
+ case EALREADY:
+ break;
+
+ default:
+ CHECK_FCT(ret);
+ }
+
+ if (new)
+ *new = ret ? 0 : 1;
+
+ return 0;
+}
+
+/* Get the sid of a session */
+int fd_sess_getsid ( struct session * session, os0_t * sid, size_t * sidlen )
+{
+ TRACE_ENTRY("%p %p", session, sid);
+
+ CHECK_PARAMS( VALIDATE_SI(session) && sid );
+
+ *sid = session->sid;
+ if (sidlen)
+ *sidlen = session->sidlen;
+
+ return 0;
+}
+
+/* Change the timeout value of a session */
+int fd_sess_settimeout( struct session * session, const struct timespec * timeout )
+{
+ struct fd_list * li;
+
+ TRACE_ENTRY("%p %p", session, timeout);
+ CHECK_PARAMS( VALIDATE_SI(session) && timeout );
+
+ /* Lock -- do we need to lock the hash table as well? I don't think so... */
+ CHECK_POSIX( pthread_mutex_lock( &exp_lock ) );
+ pthread_cleanup_push( fd_cleanup_mutex, &exp_lock );
+
+ /* Update the timeout */
+ fd_list_unlink(&session->expire);
+ memcpy(&session->timeout, timeout, sizeof(struct timespec));
+
+ /* Find the new position in expire list. We take it in normal order */
+ for (li = exp_sentinel.next; li != &exp_sentinel; li = li->next) {
+ struct session * s = (struct session *)(li->o);
+
+ if (TS_IS_INFERIOR( &s->timeout, &session->timeout ) )
+ continue;
+
+ break;
+ }
+ fd_list_insert_before( li, &session->expire );
+
+ /* We added a new expiring element, we must signal if it was in first position */
+ if (session->expire.prev == &exp_sentinel) {
+ CHECK_POSIX_DO( pthread_cond_signal(&exp_cond), { ASSERT(0); /* so that we don't have a pending cancellation handler */ } );
+ }
+
+ /* We're done */
+ pthread_cleanup_pop(0);
+ CHECK_POSIX( pthread_mutex_unlock( &exp_lock ) );
+
+ return 0;
+}
+
+/* Destroy the states associated to a session, and mark it destroyed. */
+int fd_sess_destroy ( struct session ** session )
+{
+ struct session * sess;
+ int destroy_now;
+ os0_t sid;
+ int ret = 0;
+
+ /* place to save the list of states to be cleaned up. We do it after finding them to avoid deadlocks. the "o" field becomes a copy of the sid. */
+ struct fd_list deleted_states = FD_LIST_INITIALIZER( deleted_states );
+
+ TRACE_ENTRY("%p", session);
+ CHECK_PARAMS( session && VALIDATE_SI(*session) );
+
+ sess = *session;
+ *session = NULL;
+
+ /* Lock the hash line */
+ CHECK_POSIX( pthread_mutex_lock( H_LOCK(sess->hash) ) );
+ pthread_cleanup_push( fd_cleanup_mutex, H_LOCK(sess->hash) );
+
+ /* Unlink from the expiry list */
+ CHECK_POSIX_DO( pthread_mutex_lock( &exp_lock ), { ASSERT(0); /* otherwise cleanup handler is not pop'd */ } );
+ if (!FD_IS_LIST_EMPTY(&sess->expire)) {
+ sess_cnt--;
+ fd_list_unlink( &sess->expire ); /* no need to signal the condition here */
+ }
+ CHECK_POSIX_DO( pthread_mutex_unlock( &exp_lock ), { ASSERT(0); /* otherwise cleanup handler is not pop'd */ } );
+
+ /* Now move all states associated to this session into deleted_states */
+ CHECK_POSIX_DO( pthread_mutex_lock( &sess->stlock ), { ASSERT(0); /* otherwise cleanup handler is not pop'd */ } );
+ while (!FD_IS_LIST_EMPTY(&sess->states)) {
+ struct state * st = (struct state *)(sess->states.next->o);
+ fd_list_unlink(&st->chain);
+ fd_list_insert_before(&deleted_states, &st->chain);
+ }
+ CHECK_POSIX_DO( pthread_mutex_unlock( &sess->stlock ), { ASSERT(0); /* otherwise cleanup handler is not pop'd */ } );
+
+ /* Mark the session as destroyed */
+ destroy_now = (sess->msg_cnt == 0);
+ if (destroy_now) {
+ fd_list_unlink( &sess->chain_h );
+ sid = sess->sid;
+ } else {
+ sess->is_destroyed = 1;
+ CHECK_MALLOC_DO( sid = os0dup(sess->sid, sess->sidlen), ret = ENOMEM );
+ }
+ pthread_cleanup_pop(0);
+ CHECK_POSIX( pthread_mutex_unlock( H_LOCK(sess->hash) ) );
+
+ if (ret)
+ return ret;
+
+ /* Now, really delete the states */
+ while (!FD_IS_LIST_EMPTY(&deleted_states)) {
+ struct state * st = (struct state *)(deleted_states.next->o);
+ fd_list_unlink(&st->chain);
+ TRACE_DEBUG(FULL, "Calling handler %p cleanup for state %p registered with session '%s'", st->hdl, st, sid);
+ (*st->hdl->cleanup)(st->state, sid, st->hdl->opaque);
+ free(st);
+ }
+
+ /* Finally, destroy the session itself, if it is not referrenced by any message anymore */
+ if (destroy_now) {
+ del_session(sess);
+ } else {
+ free(sid);
+ }
+
+ return 0;
+}
+
+/* Destroy a session if it is not used */
+int fd_sess_reclaim ( struct session ** session )
+{
+ struct session * sess;
+ uint32_t hash;
+ int destroy_now = 0;
+
+ TRACE_ENTRY("%p", session);
+ CHECK_PARAMS( session && VALIDATE_SI(*session) );
+
+ sess = *session;
+ hash = sess->hash;
+ *session = NULL;
+
+ CHECK_POSIX( pthread_mutex_lock( H_LOCK(hash) ) );
+ pthread_cleanup_push( fd_cleanup_mutex, H_LOCK(hash) );
+ CHECK_POSIX_DO( pthread_mutex_lock( &sess->stlock ), { ASSERT(0); /* otherwise, cleanup not poped on FreeBSD */ } );
+ pthread_cleanup_push( fd_cleanup_mutex, &sess->stlock );
+ CHECK_POSIX_DO( pthread_mutex_lock( &exp_lock ), { ASSERT(0); /* otherwise, cleanup not poped on FreeBSD */ } );
+
+ /* We only do something if the states list is empty */
+ if (FD_IS_LIST_EMPTY(&sess->states)) {
+ /* In this case, we do as in destroy */
+ fd_list_unlink( &sess->expire );
+ destroy_now = (sess->msg_cnt == 0);
+ if (destroy_now) {
+ fd_list_unlink(&sess->chain_h);
+ } else {
+ /* just mark it as destroyed, it will be freed when the last message stops referencing it */
+ sess->is_destroyed = 1;
+ }
+ }
+
+ CHECK_POSIX_DO( pthread_mutex_unlock( &exp_lock ), { ASSERT(0); /* otherwise, cleanup not poped on FreeBSD */ } );
+ pthread_cleanup_pop(0);
+ CHECK_POSIX_DO( pthread_mutex_unlock( &sess->stlock ), { ASSERT(0); /* otherwise, cleanup not poped on FreeBSD */ } );
+ pthread_cleanup_pop(0);
+ CHECK_POSIX( pthread_mutex_unlock( H_LOCK(hash) ) );
+
+ if (destroy_now)
+ del_session(sess);
+
+ return 0;
+}
+
+/* Save a state information with a session */
+int fd_sess_state_store ( struct session_handler * handler, struct session * session, struct sess_state ** state )
+{
+ struct state *new;
+ struct fd_list * li;
+ int already = 0;
+ int ret = 0;
+
+ TRACE_ENTRY("%p %p %p", handler, session, state);
+ CHECK_PARAMS( handler && VALIDATE_SH(handler) && session && VALIDATE_SI(session) && (!session->is_destroyed) && state );
+
+ /* Lock the session state list */
+ CHECK_POSIX( pthread_mutex_lock(&session->stlock) );
+ pthread_cleanup_push( fd_cleanup_mutex, &session->stlock );
+
+ /* Create the new state object */
+ CHECK_MALLOC_DO(new = malloc(sizeof(struct state)), { ret = ENOMEM; goto out; } );
+ memset(new, 0, sizeof(struct state));
+
+ new->eyec = SD_EYEC;
+ new->state= *state;
+ fd_list_init(&new->chain, new);
+ new->hdl = handler;
+
+ /* find place for this state in the list */
+ for (li = session->states.next; li != &session->states; li = li->next) {
+ struct state * st = (struct state *)(li->o);
+ /* The list is ordered by handler's id */
+ if (st->hdl->id < handler->id)
+ continue;
+
+ if (st->hdl->id == handler->id) {
+ TRACE_DEBUG(INFO, "A state was already stored for session '%s' and handler '%p', at location %p", session->sid, st->hdl, st->state);
+ already = EALREADY;
+ }
+
+ break;
+ }
+
+ if (!already) {
+ fd_list_insert_before(li, &new->chain);
+ *state = NULL;
+ } else {
+ free(new);
+ }
+out:
+ ;
+ pthread_cleanup_pop(0);
+ CHECK_POSIX( pthread_mutex_unlock(&session->stlock) );
+
+ return ret ?: already;
+}
+
+/* Get the data back */
+int fd_sess_state_retrieve ( struct session_handler * handler, struct session * session, struct sess_state ** state )
+{
+ struct fd_list * li;
+ struct state * st = NULL;
+
+ TRACE_ENTRY("%p %p %p", handler, session, state);
+ CHECK_PARAMS( handler && VALIDATE_SH(handler) && session && VALIDATE_SI(session) && state );
+
+ *state = NULL;
+
+ /* Lock the session state list */
+ CHECK_POSIX( pthread_mutex_lock(&session->stlock) );
+ pthread_cleanup_push( fd_cleanup_mutex, &session->stlock );
+
+ /* find the state in the list */
+ for (li = session->states.next; li != &session->states; li = li->next) {
+ st = (struct state *)(li->o);
+
+ /* The list is ordered by handler's id */
+ if (st->hdl->id > handler->id)
+ break;
+ }
+
+ /* If we found the state */
+ if (st && (st->hdl == handler)) {
+ fd_list_unlink(&st->chain);
+ *state = st->state;
+ free(st);
+ }
+
+ pthread_cleanup_pop(0);
+ CHECK_POSIX( pthread_mutex_unlock(&session->stlock) );
+
+ return 0;
+}
+
+/* For the messages module */
+int fd_sess_fromsid ( uint8_t * sid, size_t len, struct session ** session, int * new)
+{
+ TRACE_ENTRY("%p %zd %p %p", sid, len, session, new);
+ CHECK_PARAMS( sid && len && session );
+
+ /* Get the session object */
+ CHECK_FCT( fd_sess_fromsid_msg ( sid, len, session, new) );
+
+ /* Decrease the refcount */
+ CHECK_POSIX( pthread_mutex_lock(&(*session)->stlock) );
+ (*session)->msg_cnt--; /* was increased in fd_sess_new */
+ CHECK_POSIX( pthread_mutex_unlock(&(*session)->stlock) );
+
+ /* Done */
+ return 0;
+}
+
+int fd_sess_ref_msg ( struct session * session )
+{
+ TRACE_ENTRY("%p", session);
+ CHECK_PARAMS( VALIDATE_SI(session) );
+
+ /* Update the msg refcount */
+ CHECK_POSIX( pthread_mutex_lock(&session->stlock) );
+ session->msg_cnt++;
+ CHECK_POSIX( pthread_mutex_unlock(&session->stlock) );
+
+ return 0;
+}
+
+int fd_sess_reclaim_msg ( struct session ** session )
+{
+ int reclaim;
+ uint32_t hash;
+
+ TRACE_ENTRY("%p", session);
+ CHECK_PARAMS( session && VALIDATE_SI(*session) );
+
+ /* Lock the hash line to avoid possibility that session is freed while we are reclaiming */
+ hash = (*session)->hash;
+ CHECK_POSIX( pthread_mutex_lock( H_LOCK(hash)) );
+ pthread_cleanup_push( fd_cleanup_mutex, H_LOCK(hash) );
+
+ /* Update the msg refcount */
+ CHECK_POSIX( pthread_mutex_lock(&(*session)->stlock) );
+ reclaim = (*session)->msg_cnt;
+ (*session)->msg_cnt = reclaim - 1;
+ CHECK_POSIX( pthread_mutex_unlock(&(*session)->stlock) );
+
+ /* Ok, now unlock the hash line */
+ pthread_cleanup_pop( 0 );
+ CHECK_POSIX( pthread_mutex_unlock( H_LOCK(hash) ) );
+
+ /* and reclaim if no message references the session anymore */
+ if (reclaim == 1) {
+ CHECK_FCT(fd_sess_reclaim ( session ));
+ } else {
+ *session = NULL;
+ }
+ return 0;
+}
+
+
+
+/* Dump functions */
+DECLARE_FD_DUMP_PROTOTYPE(fd_sess_dump, struct session * session, int with_states)
+{
+ FD_DUMP_HANDLE_OFFSET();
+
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "{session}(@%p): ", session), return NULL);
+
+ if (!VALIDATE_SI(session)) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "INVALID/NULL"), return NULL);
+ } else {
+ char timebuf[30];
+ struct tm tm;
+
+ strftime(timebuf, sizeof(timebuf), "%D,%T", localtime_r( &session->timeout.tv_sec , &tm ));
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "'%s'(%zd) h:%x m:%d d:%d to:%s.%06ld",
+ session->sid, session->sidlen, session->hash, session->msg_cnt, session->is_destroyed,
+ timebuf, session->timeout.tv_nsec/1000),
+ return NULL);
+
+ if (with_states) {
+ struct fd_list * li;
+ CHECK_POSIX_DO( pthread_mutex_lock(&session->stlock), /* ignore */ );
+ pthread_cleanup_push( fd_cleanup_mutex, &session->stlock );
+
+ for (li = session->states.next; li != &session->states; li = li->next) {
+ struct state * st = (struct state *)(li->o);
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "\n {state i:%d}(@%p): ", st->hdl->id, st), return NULL);
+ if (st->hdl->state_dump) {
+ CHECK_MALLOC_DO( (*st->hdl->state_dump)( FD_DUMP_STD_PARAMS, st->state),
+ fd_dump_extend( FD_DUMP_STD_PARAMS, "[dumper error]"));
+ } else {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "<%p>", st->state), return NULL);
+ }
+ }
+
+ pthread_cleanup_pop(0);
+ CHECK_POSIX_DO( pthread_mutex_unlock(&session->stlock), /* ignore */ );
+ }
+ }
+
+ return *buf;
+}
+
+DECLARE_FD_DUMP_PROTOTYPE(fd_sess_dump_hdl, struct session_handler * handler)
+{
+ FD_DUMP_HANDLE_OFFSET();
+
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "{sesshdl}(@%p): ", handler), return NULL);
+
+ if (!VALIDATE_SH(handler)) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "INVALID/NULL"), return NULL);
+ } else {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "i:%d cl:%p d:%p o:%p", handler->id, handler->cleanup, handler->state_dump, handler->opaque), return NULL);
+ }
+ return *buf;
+}
+
+int fd_sess_getcount(uint32_t *cnt)
+{
+ CHECK_PARAMS(cnt);
+ CHECK_POSIX( pthread_mutex_lock( &exp_lock ) );
+ *cnt = sess_cnt;
+ CHECK_POSIX( pthread_mutex_unlock( &exp_lock ) );
+ return 0;
+}
diff --git a/libfdproto/utils.c b/libfdproto/utils.c
new file mode 100644
index 0000000..f2440cf
--- /dev/null
+++ b/libfdproto/utils.c
@@ -0,0 +1,84 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2013, 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. *
+*********************************************************************************************************/
+
+#include "fdproto-internal.h"
+
+DECLARE_FD_DUMP_PROTOTYPE(fd_sa_dump, sSA * sa, int flags)
+{
+ char addrbuf[INET6_ADDRSTRLEN];
+ char servbuf[32];
+ int rc;
+ FD_DUMP_HANDLE_OFFSET();
+
+ servbuf[0] = 0;
+
+ if (sa) {
+ if (sSAport(sa)) {
+ rc = getnameinfo(sa, sSAlen( sa ), addrbuf, sizeof(addrbuf), servbuf, sizeof(servbuf), flags);
+ } else {
+ rc = getnameinfo(sa, sSAlen( sa ), addrbuf, sizeof(addrbuf), NULL, 0, flags);
+ }
+ if (rc) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "%s", gai_strerror(rc)), return NULL);
+ } else {
+ if (servbuf[0]) {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "%s(%s)", &addrbuf[0], &servbuf[0]), return NULL);
+ } else {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "%s", &addrbuf[0]), return NULL);
+ }
+ }
+ } else {
+ CHECK_MALLOC_DO( fd_dump_extend( FD_DUMP_STD_PARAMS, "(NULL / ANY)"), return NULL);
+ }
+ return *buf;
+}
+
+void fd_sa_sdump_numeric(char * buf /* must be at least sSA_DUMP_STRLEN */, sSA * sa)
+{
+ char addrbuf[INET6_ADDRSTRLEN];
+ char servbuf[32];
+
+ if (sa) {
+ int rc = getnameinfo(sa, sSAlen( sa ), addrbuf, sizeof(addrbuf), servbuf, sizeof(servbuf), NI_NUMERICHOST | NI_NUMERICSERV);
+ if (rc) {
+ snprintf(buf, sSA_DUMP_STRLEN, "%s", gai_strerror(rc));
+ } else {
+ snprintf(buf, sSA_DUMP_STRLEN, "%s(%s)", addrbuf, servbuf);
+ }
+ } else {
+ snprintf(buf, sSA_DUMP_STRLEN, "(NULL / ANY)");
+ }
+
+}
diff --git a/libfdproto/version.c b/libfdproto/version.c
new file mode 100644
index 0000000..48dcf8f
--- /dev/null
+++ b/libfdproto/version.c
@@ -0,0 +1,47 @@
+/*********************************************************************************************************
+* Software License Agreement (BSD License) *
+* Author: Sebastien Decugis <sdecugis@freediameter.net> *
+* *
+* Copyright (c) 2013, 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. *
+*********************************************************************************************************/
+
+#include "fdproto-internal.h"
+#include <freeDiameter/version.h>
+
+#ifdef FD_PROJECT_VERSION_HG
+# define FD_LIBFDPROTO_VERSION \
+ _stringize(FD_PROJECT_VERSION_MAJOR) "." _stringize(FD_PROJECT_VERSION_MINOR) "." _stringize(FD_PROJECT_VERSION_REV) "-" FD_PROJECT_VERSION_HG_VAL
+#else
+# define FD_LIBFDPROTO_VERSION \
+ _stringize(FD_PROJECT_VERSION_MAJOR) "." _stringize(FD_PROJECT_VERSION_MINOR) "." _stringize(FD_PROJECT_VERSION_REV)
+#endif
+
+const char fd_libproto_version[] = FD_LIBFDPROTO_VERSION;