Changeset 1101:40b48a3997a2 in freeDiameter

Timestamp:

May 9, 2013, 1:06:03 PM (11 years ago)

Author:

Sebastien Decugis <sdecugis@freediameter.net>

Branch:

default

Parents:

1098:f38d77f9cfd3 (diff), 1100:4b7192d0ffde (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Phase:

public

Message:

Merged

Files:

• include/freeDiameter/libfdcore.h (modified) (2 diffs)
• include/freeDiameter/libfdcore.h (modified) (11 diffs)
• include/freeDiameter/libfdproto.h (modified) (1 diff)
• include/freeDiameter/libfdproto.h (modified) (1 diff)
• libfdcore/cnxctx.c (modified) (1 diff)
• libfdcore/cnxctx.c (modified) (1 diff)
• libfdproto/messages.c (modified) (1 diff)
• libfdproto/messages.c (modified) (3 diffs)

include/freeDiameter/libfdcore.h

@@ -950 +950 @@
         
         HOOK_MESSAGE_FAILOVER,
-                /* Hook called when a message that was sent to a peer is being requeued, because e.g. the connection was teared down.
+                /* Hook called when a message that was sent to a peer is being requeued, because e.g. the connection was torn down.
                    In that case the message will go again through the routing process.
                  - {msg} points to the corresponding request message (the answer is discarded). Again, the objects may not have been dictionary resolved. If you
@@ -1019 +1019 @@
 
 
-/* Type if the {permsgdata}. It is up to each extension to define its own structure. This is opaque for the framework. */
+/* Type of the {permsgdata} pointer. It is up to each extension to define its own structure. This is opaque for the framework. */
 struct fd_hook_permsgdata;
 

include/freeDiameter/libfdcore.h

@@ -879 +879 @@
 /* These functions allow an extension to collect state information about the
  * framework, as well as being hooked at some key checkpoints in the processing
- * for logging / statistics purpose.
+ * for logging or statistics purpose.
  */
  
@@ -887 +887 @@
  * PARAMETERS:
  *  type        : The type of hook that triggered this call, in case same cb is registered for several hooks.
- *  msg         : If relevant, the pointer to the message trigging the call. NULL otherwise.
+ *  msg         : If relevant, the pointer to the message triggering the call. NULL otherwise.
  *  peer        : If relevant, the pointer to the peer associated with the call. NULL otherwise.
  *  other       : For some callbacks, the remaining information is passed in this parameter. See each hook detail.
  *  permsgdata  : Structure associated with a given message, across several hooks. 
- *                 Same structure is associated with requests and corresponding answers. 
+ *                 A different structure is associated with requests and corresponding answers. 
  *                 See fd_hook_data_hdl below for details.
  *                 If no fd_hook_data_hdl is registered with this callback, this parameter is always NULL
@@ -916 +916 @@
                  - {msg} is NULL.
                  - {peer} is NULL.
-                 - {*other} is NULL, {other} points to a valid location where you can store a pointer. 
-                    This same pointer will then passed to the next hook, once message is processed.
-                    IMPORTANT: free() will be called on this pointer if any problem, so this pointer must be malloc'd.
-                 - {permsgdata} is NULL.
+                 - {other} is a pointer to a structure { size_t len; uint8_t * buf; } containing the received buffer.
+                 - {permsgdata} points to either a new empty structure allocated for this message (cf. fd_hook_data_hdl), or NULL if no hdl is registered.
                  */
                  
@@ -928 +926 @@
                  - {peer} is set if the message is received from a peer's connection, and NULL if the message is from a new client
                    connected and not yet identified
-                 - {*other} contains the pointer stored with the HOOK_DATA_RECEIVED hook if any, NULL otherwise. After this hook returns, free(*other) is called if not NULL.
-                 - {permsgdata} points to either a new empty structure allocated for this request (cf. fd_hook_data_hdl), or the request's existing structure if the message is an answer.
+                 - {other} is NULL.
+                 - {permsgdata} points to either a new empty structure allocated for this message or the one passed to HOOK_DATA_RECEIVED if used.
                  */
         
@@ -946 +944 @@
                    try to call fd_msg_parse_dict, it will slow down the operation of a relay agent.
                  - {peer} is set if the message is sent to a peer's connection, and NULL if the message is sent to a new client
-                   connected and not yet identified / being rejected
+                   connected and not yet identified, or being rejected
                  - {other} is NULL.
                  - {permsgdata} points to existing structure if any, or a new structure otherwise. 
-                    If the message is an answer, the structure is shared with the corresponding request.
                  */
         
@@ -959 +956 @@
                  - {peer} is the peer this message was previously sent to.
                  - {other} is NULL.
-                 - {permsgdata} points to existing structure associated with this request. 
+                 - {permsgdata} points to existing structure if any, or a new structure otherwise. 
                  */
         
@@ -994 +991 @@
         
         HOOK_MESSAGE_DROPPED,
-                /* Hook called when a message is being discarded by the framework because of some error.
-                   It is probably a good idea to log this for analysis.
+                /* Hook called when a message is being discarded by the framework because of some error condition (normal or abnormal).
+                   It is probably a good idea to log this for analysis / backup.
                  - {msg} points to the message, which will be freed as soon as the hook returns.
                  - {peer} is NULL.
@@ -1035 +1032 @@
  *
  * PARAMETERS:
- *  permsgdata_new_cb     : function called to initialize a new empty fd_hook_permsgdata structure, when a hook will be called for a message with no structure yet. If the function returns NULL, it will be called again for the next hook.
- *  permsgdata_destroy_cb : function called when a message is being disposed. It should free the resources associated with the fd_hook_permsgdata.
- *  new_handle            : On success, a handler to the registered callback is stored here. 
+ *  permsgdata_size     : the size of the fd_hook_permsgdata structure. 
+ *  permsgdata_init_cb  : function called to initialize a new fd_hook_permsgdata structure, when a hook will be called for a message that does not have such structure yet. 
+ *                           The memory is already allocated and blanked, so you can pass NULL if no further handling is required.
+ *  permsgdata_fini_cb  : function called when a message is being disposed. It should free the resources associated with the fd_hook_permsgdata. 
+ *                           You can pass NULL if no special handling is required. The memory of the permsgdata structure itself will be freed by the framework.
+ *  new_handle          : On success, a handler to the registered callback is stored here. 
  *                           This handler will be used to unregister the cb.
  *
  * DESCRIPTION: 
  *   Register a new fd_hook_data_hdl. This handle is used during hooks registration (see below) in order to associate data with the messages, to allow keeping tracking of the message easily.
- *  Note that these handlers are statically allocated and cannot be unregistered.
+ *  Note that these handlers are statically allocated and cannot be unregistered. FD_HOOK_HANDLE_LIMIT handlers can be registered at maximum (recompile libfdproto if you change this value)
  *
  * RETURN VALUE:
@@ -1050 +1050 @@
  */
 int fd_hook_data_register(
-        struct fd_hook_permsgdata * (*permsgdata_new_cb)     (void),
-        void (*permsgdata_destroy_cb) (struct fd_hook_permsgdata *),
-        struct fd_hook_data_hdl **    new_handle
+        size_t permsgdata_size,
+        void (*permsgdata_init_cb) (struct fd_hook_permsgdata *),
+        void (*permsgdata_fini_cb) (struct fd_hook_permsgdata *),
+        struct fd_hook_data_hdl **new_handle
 );
-
 
 /* A handler associated with a registered hook callback (for cleanup) */
@@ -1063 +1063 @@
  *
  * PARAMETERS:
- *  type          : The fd_hook_type for which this cb is registered. Call several times if you want to register for several hooks.
+ *  type_mask     : A bitmask of fd_hook_type bits for which this cb is registered, e.g. ((1 << HOOK_MESSAGE_RECEIVED) || (1 << HOOK_MESSAGE_SENT))
  *  fd_hook_cb    : The callback function to register (see prototype above).
  *  regdata       : Pointer to pass to the callback when it is called. The data is opaque to the daemon.
@@ -1079 +1079 @@
  *  ENOMEM      : Not enough memory to complete the operation
  */
-int fd_hook_register (  enum fd_hook_type type, 
-                        void (*fd_hook_cb)(enum fd_hook_type type, struct msg * msg, struct peer_hdr * peer, void * other, void * regdata), 
-                        void * regdata, 
+int fd_hook_register (  uint32_t type_mask, 
+                        void (*fd_hook_cb)(enum fd_hook_type type, struct msg * msg, struct peer_hdr * peer, void * other, struct fd_hook_permsgdata *pmd, void * regdata), 
+                        void  *regdata, 
                         struct fd_hook_data_hdl *data_hdl,
                         struct fd_hook_hdl ** handler );

include/freeDiameter/libfdproto.h

@@ -80 +80 @@
 #include <stdarg.h>
 
-#ifdef DEBUG
-#include <libgen.h>     /* for basename if --dbg_file is specified */
-#endif /* DEBUG */
+#include <libgen.h>     /* for basename */
 
 #ifdef SWIG

include/freeDiameter/libfdproto.h

@@ -2548 +2548 @@
 
 
+/* Helper for the hooks mechanism, for use from libfdcore */
+struct fd_msg_pmdl {
+        struct fd_list sentinel; /* if the sentinel.o field is NULL, the structure is not initialized. Otherwise it points to the cleanup function in libfdcore. */
+        pthread_mutex_t lock;
+};
+#define FD_MSG_PMDL_INITIALIZER(pmdl_ptr)        { FD_LIST_INITIALIZER(  (pmdl_ptr)->sentinel       ), PTHREAD_MUTEX_INITIALIZER }
+struct fd_msg_pmdl * fd_msg_pmdl_get(struct msg * msg);
+
 /***************************************/
 /*   Manage AVP values                 */

libfdcore/cnxctx.c

@@ -1758 +1758 @@
         
                 default:
-                        TRACE_DEBUG(INFO, "Unknwon protocol: %d", conn->cc_proto);
+                        TRACE_DEBUG(INFO, "Unknown protocol: %d", conn->cc_proto);
                         ASSERT(0);
                         return ENOTSUP; /* or EINVAL... */

libfdcore/cnxctx.c

@@ -736 +736 @@
                 }
                 
+                // fd_msg_log(....)
+                
                 /* We have received a complete message, pass it to the daemon */
                 CHECK_FCT_DO( fd_event_send( fd_cnx_target_queue(conn), FDEVP_CNX_MSG_RECV, length, newmsg), /* continue or destroy everything? */);

libfdproto/messages.c

@@ -1255 +1255 @@
                 return anscb ? EINVAL : 0; /* we associate with requests only */
         
-        CHECK_PARAMS( (anscb == NULL)    || (msg->msg_cb.anscb == NULL) ); /* We are not overwritting a cb */
-        CHECK_PARAMS( (expirecb == NULL) || (msg->msg_cb.expirecb == NULL) ); /* We are not overwritting a cb */
+        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 */

libfdproto/messages.c

@@ -137 +137 @@
         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. */
 };
 
@@ -674 +674 @@
         }
         
+        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);
@@ -1496 +1500 @@
         
         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;
 }