Changeset 649:5e5d8152c229 in freeDiameter

Timestamp:

Jan 5, 2011, 5:13:34 PM (13 years ago)

Author:

Sebastien Decugis <sdecugis@nict.go.jp>

Branch:

default

Phase:

public

Message:

Implemented fd_msg_send_timeout to close #10. Not tested yet.

Files:

• contrib/debian/changelog (modified) (1 diff)
• doc/dbg_interactive.py.sample (modified) (2 diffs)
• extensions/dbg_interactive/messages.i (modified) (4 diffs)
• freeDiameter/fD.h (modified) (2 diffs)
• freeDiameter/p_sr.c (modified) (8 diffs)
• freeDiameter/peers.c (modified) (2 diffs)
• freeDiameter/routing_dispatch.c (modified) (1 diff)
• include/freeDiameter/libfreeDiameter.h (modified) (1 diff)
• libfreeDiameter/messages.c (modified) (2 diffs)

contrib/debian/changelog

@@ -1 +1 @@
 freediameter (1.0.4) UNRELEASED; urgency=low
 
-  * Added new option to specify timeout on receiving answer (#10) 
+  * Added new API to specify timeout on receiving answer (#10) 
   * Bumped API version number accordingly.
 

doc/dbg_interactive.py.sample

@@ -464 +464 @@
 mydwr.send()
 
-# Optionaly, a callback can be registered when a message is sent, with an optional object.
+# Optionaly, a callback can be registered when a request is sent, with an optional object.
 # This callback takes the answer message as parameter and should return None or a message. (cf. fd_msg_send)
 def send_callback(msg, obj):
@@ -475 +475 @@
 mydwr = msg(buf)
 mydwr.send(send_callback, some_object)
+
+# Again optionaly, a time limit can be specified in this case as follow:
+mydwr.send(send_callback, some_object, 10)
+# In that case, if no answer / error is received after 10 seconds (the value specified), 
+# the callback is called with the request as parameter.
+# Testing for timeout case is done by using msg.is_request()
+def send_callback(msg, obj):
+    if (msg.is_request()):
+        print "Request timed out without answer:"
+    else:
+        print "Received answer:"
+    msg.dump()
+    print "Associated data:"
+    obj
+    return None
 
 

extensions/dbg_interactive/messages.i

@@ -55 +55 @@
         }
         
-        SWIG_PYTHON_THREAD_BEGIN_BLOCK;
-        
-        if (!msg || !*msg) {
-                PyMsg = Py_None;
-        } else {
-                PyMsg = SWIG_NewPointerObj((void *)*msg,     SWIGTYPE_p_msg,     0 );
-        }
-        
-        result = PyEval_CallFunction(l->cb, "(OO)", PyMsg, l->data);
-        Py_XDECREF(l->cb);
-        Py_XDECREF(l->data);
-        free(l);
-        
-        /* The callback is supposed to return a message or NULL */
-        if (!SWIG_IsOK(SWIG_ConvertPtr(result, (void *)msg, SWIGTYPE_p_msg, SWIG_POINTER_DISOWN))) {
-                fd_log_debug("Error: Cannot convert the return value to message.\n");
-                *msg = NULL;
-        }
-        
-        Py_XDECREF(result);
-        
-        SWIG_PYTHON_THREAD_END_BLOCK;
-        
+        if (l->cb) {
+        
+                SWIG_PYTHON_THREAD_BEGIN_BLOCK;
+
+                if (!msg || !*msg) {
+                        PyMsg = Py_None;
+                } else {
+                        PyMsg = SWIG_NewPointerObj((void *)*msg,     SWIGTYPE_p_msg,     0 );
+                }
+
+                result = PyEval_CallFunction(l->cb, "(OO)", PyMsg, l->data);
+                Py_XDECREF(l->cb);
+                Py_XDECREF(l->data);
+                free(l);
+
+                /* The callback is supposed to return a message or NULL */
+                if (!SWIG_IsOK(SWIG_ConvertPtr(result, (void *)msg, SWIGTYPE_p_msg, SWIG_POINTER_DISOWN))) {
+                        fd_log_debug("Error: Cannot convert the return value to message.\n");
+                        *msg = NULL;
+                }
+
+                Py_XDECREF(result);
+
+                SWIG_PYTHON_THREAD_END_BLOCK;
+                
+        }
+        /* else */
+                /* Only the timeout was specified, without a callback */
+                /* in this case, just delete the message */
+                /* it actually happens automatically when we do nothing. */
 }
 %}
@@ -121 +128 @@
         /* SEND THE MESSAGE */
         %delobject send; /* when this has been called, the msg must not be freed anymore */
-        void send(PyObject * PyCb = NULL, PyObject * data = NULL) {
+        void send(PyObject * PyCb = NULL, PyObject * data = NULL, unsigned int timeout = 0) {
                 int ret;
                 struct msg * m = $self;
                 struct anscb_py_layer * l = NULL;
                 
-                if (PyCb) {
+                if (PyCb || timeout) {
                         l = malloc(sizeof(struct anscb_py_layer));
                         if (!l) {
@@ -139 +146 @@
                 }
                 
-                ret = fd_msg_send(&m, PyCb ? anscb_python : NULL, l);
+                if (timeout) {
+                        struct timespec ts;
+                        (void) clock_gettime(CLOCK_REALTIME, &ts);
+                        ts.tv_sec += timeout;
+                        ret = fd_msg_send_timeout(&m, anscb_python, l, &ts);
+                } else {
+                        ret = fd_msg_send(&m, PyCb ? anscb_python : NULL, l);
+                }
                 if (ret != 0) {
                         DI_ERROR(ret, NULL, NULL);
@@ -303 +317 @@
         }
         
+        /* Is request? (shortcut) */
+        PyObject * is_request() {
+                PyObject * r;
+                int ret;
+                struct msg_hdr * h;
+                
+                ret = fd_msg_hdr($self, &h);
+                if (ret != 0) {
+                        DI_ERROR(ret, NULL, NULL);
+                }
+                if (h->msg_flags & CMD_FLAG_REQUEST) 
+                        r = Py_True;
+                else
+                        r = Py_False;
+                Py_XINCREF(r);
+                return r;
+        }
+        
         /* Get the source */
         char *source() {

freeDiameter/fD.h

@@ -118 +118 @@
 /* Sentinel for the sent requests list */
 struct sr_list {
-        struct fd_list  srs;
-        pthread_mutex_t mtx;
+        struct fd_list  srs; /* requests ordered by hop-by-hop id */
+        struct fd_list  exp; /* requests that have a timeout set, ordered by timeout */
+        pthread_mutex_t mtx; /* mutex to protect these lists */
+        pthread_cond_t  cnd; /* cond var used by the thread that handles timeouts */
+        pthread_t       thr; /* the thread that handles timeouts (and calls the anscb) */
 };
 
@@ -290 +293 @@
 int fd_p_sr_store(struct sr_list * srlist, struct msg **req, uint32_t *hbhloc, uint32_t hbh_restore);
 int fd_p_sr_fetch(struct sr_list * srlist, uint32_t hbh, struct msg **req);
+int fd_p_sr_start(struct sr_list * srlist);
+int fd_p_sr_stop(struct sr_list * srlist);
 void fd_p_sr_failover(struct sr_list * srlist);
 

freeDiameter/p_sr.c

@@ -45 +45 @@
         struct msg      *req;   /* A request that was sent and not yet answered. */
         uint32_t        prevhbh;/* The value to set in the hbh header when the message is retrieved */
+        struct fd_list  expire; /* the list of expiring requests */
+        struct timespec added_on; /* the time the request was added */
 };
 
-/* Find an element in the list, or the following one */
+/* Find an element in the hbh list, or the following one */
 static struct fd_list * find_or_next(struct fd_list * srlist, uint32_t hbh, int * match)
 {
@@ -66 +68 @@
 {
         struct fd_list * li;
+        struct timespec now;
         if (!TRACE_BOOL(SR_DEBUG_LVL))
                 return;
+        CHECK_SYS_DO( clock_gettime(CLOCK_REALTIME, &now), );
         fd_log_debug("%sSentReq list @%p:\n", text, srlist);
         for (li = srlist->next; li != srlist; li = li->next) {
                 struct sentreq * sr = (struct sentreq *)li;
                 uint32_t * nexthbh = li->o;
-                fd_log_debug(" - Next req (%x):\n", *nexthbh);
+                fd_log_debug(" - Next req (%x): [since %ld.%06ld sec]\n", *nexthbh, 
+                        (now.tv_nsec >= sr->added_on.tv_nsec) ? (now.tv_sec - sr->added_on.tv_sec) : (now.tv_sec - sr->added_on.tv_sec - 1),
+                        (now.tv_nsec >= sr->added_on.tv_nsec) ? (now.tv_nsec - sr->added_on.tv_nsec) / 1000 : (now.tv_nsec - sr->added_on.tv_nsec + 1000000000) / 1000);
                 fd_msg_dump_one(SR_DEBUG_LVL + 1, sr->req);
         }
 }
+
+/* (detached) thread that calls the anscb on expired messages. 
+  We do it in a separate thread to avoid blocking the reception of new messages during this time */
+static void * call_anscb_expire(void * arg) {
+        struct msg * expired_req = arg;
+        
+        void (*anscb)(void *, struct msg **);
+        void * data;
+        
+        TRACE_ENTRY("%p", arg);
+        CHECK_PARAMS_DO( arg, return NULL );
+        
+        /* Set the thread name */
+        fd_log_threadname ( "Expired req cb." );
+        
+        /* Log */
+        TRACE_DEBUG(INFO, "The expiration timer for a request has been reached, abording this attempt now & calling cb...");
+        
+        /* Retrieve callback in the message */
+        CHECK_FCT_DO( fd_msg_anscb_get( expired_req, &anscb, &data ), return NULL);
+        ASSERT(anscb);
+
+        /* Call it */
+        (*anscb)(data, &expired_req);
+        
+        /* If the callback did not dispose of the message, do it now */
+        if (expired_req) {
+                CHECK_FCT_DO( fd_msg_free(expired_req), /* ignore */ );
+        }
+        
+        /* Finish */
+        return NULL;
+}
+
+/* thread that handles messages expiring. The thread is started / stopped only when needed */
+static void * sr_expiry_th(void * arg) {
+        struct sr_list * srlist = arg;
+        struct msg * expired_req;
+        pthread_attr_t detached;
+        
+        TRACE_ENTRY("%p", arg);
+        CHECK_PARAMS_DO( arg, return NULL );
+        
+        /* Set the thread name */
+        {
+                char buf[48];
+                sprintf(buf, "ReqExp/%.*s", (int)sizeof(buf) - 8, ((struct fd_peer *)(srlist->exp.o))->p_hdr.info.pi_diamid);
+                fd_log_threadname ( buf );
+        }
+        
+        CHECK_POSIX_DO( pthread_attr_init(&detached), return NULL );
+        CHECK_POSIX_DO( pthread_attr_setdetachstate(&detached, PTHREAD_CREATE_DETACHED), return NULL );
+        
+        CHECK_POSIX_DO( pthread_mutex_lock(&srlist->mtx),  return NULL );
+        pthread_cleanup_push( fd_cleanup_mutex, &srlist->mtx );
+        
+        do {
+                struct timespec now, *t;
+                struct sentreq * first;
+                pthread_t th;
+                
+                /* Check if there are expiring requests available */
+                if (FD_IS_LIST_EMPTY(&srlist->exp)) {
+                        /* Just wait for a change or cancelation */
+                        CHECK_POSIX_DO( pthread_cond_wait( &srlist->cnd, &srlist->mtx ), goto error );
+                        /* Restart the loop on wakeup */
+                        continue;
+                }
+                
+                /* Get the pointer to the request that expires first */
+                first = (struct sentreq *)(srlist->exp.next->o);
+                t = fd_msg_anscb_gettimeout( first->req );
+                ASSERT(t);
+                
+                /* Get the current time */
+                CHECK_SYS_DO(  clock_gettime(CLOCK_REALTIME, &now),  goto error  );
+
+                /* If first request is not expired, we just wait until it happens */
+                if ( TS_IS_INFERIOR( &now, t ) ) {
+                        
+                        CHECK_POSIX_DO2(  pthread_cond_timedwait( &srlist->cnd, &srlist->mtx, t ),  
+                                        ETIMEDOUT, /* ETIMEDOUT is a normal return value, continue */,
+                                        /* on other error, */ goto error );
+        
+                        /* on wakeup, loop */
+                        continue;
+                }
+                
+                /* Now, the first request in the list is expired; remove it and call the anscb for it in a new thread */
+                fd_list_unlink(&first->chain);
+                fd_list_unlink(&first->expire);
+                expired_req = first->req;
+                free(first);
+                
+                CHECK_POSIX_DO( pthread_create( &th, &detached, call_anscb_expire, expired_req ), goto error );
+
+                /* loop */
+        } while (1);
+error:  
+        pthread_cleanup_pop( 1 );
+        return NULL;
+}
+
 
 /* Store a new sent request */
@@ -83 +192 @@
         struct fd_list * next;
         int match;
+        struct timespec * ts;
         
         TRACE_ENTRY("%p %p %p %x", srlist, req, hbhloc, hbh_restore);
@@ -92 +202 @@
         sr->req = *req;
         sr->prevhbh = hbh_restore;
+        fd_list_init(&sr->expire, sr);
+        CHECK_SYS( clock_gettime(CLOCK_REALTIME, &sr->added_on) );
         
         /* Search the place in the list */
@@ -107 +219 @@
         fd_list_insert_before(next, &sr->chain);
         srl_dump("Saved new request, ", &srlist->srs);
+        
+        /* In case of request with a timeout, also store in the timeout list */
+        ts = fd_msg_anscb_gettimeout( sr->req );
+        if (ts) {
+                struct fd_list * li;
+                struct timespec * t;
+                
+                /* browse srlist->exp from the end */
+                for (li = srlist->exp.prev; li != &srlist->exp; li = li->prev) {
+                        struct sentreq * s = (struct sentreq *)(li->o);
+                        t = fd_msg_anscb_gettimeout( s->req );
+                        ASSERT( t ); /* sanity */
+                        if (TS_IS_INFERIOR(t, ts))
+                                break;
+                }
+                
+                fd_list_insert_after(li, &sr->expire);
+        
+                /* if the thread does not exist yet, create it */
+                if (srlist->thr == (pthread_t)NULL) {
+                        CHECK_POSIX_DO( pthread_create(&srlist->thr, NULL, sr_expiry_th, srlist), /* continue anyway */);
+                } else {
+                        /* or, if added in first position, signal the condvar to update the sleep time of the thread */
+                        if (li == &srlist->exp) {
+                                CHECK_POSIX_DO( pthread_cond_signal(&srlist->cnd), /* continue anyway */);
+                        }
+                }
+        }
+        
         CHECK_POSIX( pthread_mutex_unlock(&srlist->mtx) );
         return 0;
@@ -132 +273 @@
                 /* Unlink */
                 fd_list_unlink(&sr->chain);
+                fd_list_unlink(&sr->expire);
                 *req = sr->req;
                 free(sr);
         }
         CHECK_POSIX( pthread_mutex_unlock(&srlist->mtx) );
+        
+        /* do not stop the expire thread here, it might cause creating/destroying it very often otherwise */
 
         /* Done */
@@ -148 +292 @@
                 struct sentreq * sr = (struct sentreq *)(srlist->srs.next);
                 fd_list_unlink(&sr->chain);
+                fd_list_unlink(&sr->expire);
                 if (fd_msg_is_routable(sr->req)) {
                         struct msg_hdr * hdr = NULL;
@@ -165 +310 @@
                 free(sr);
         }
+        /* The list of expiring requests must be empty now */
+        ASSERT( FD_IS_LIST_EMPTY(&srlist->exp) );
+        
         CHECK_POSIX_DO( pthread_mutex_unlock(&srlist->mtx), /* continue anyway */ );
-}
-
+        
+        /* Terminate the expiry thread (must be done when the lock can be taken) */
+        CHECK_FCT_DO( fd_thr_term(&srlist->thr), /* ignore error */ );
+}
+

freeDiameter/peers.c

@@ -79 +79 @@
         
         fd_list_init(&p->p_sr.srs, p);
+        fd_list_init(&p->p_sr.exp, p);
         CHECK_POSIX( pthread_mutex_init(&p->p_sr.mtx, NULL) );
+        CHECK_POSIX( pthread_cond_init(&p->p_sr.cnd, NULL) );
         
         fd_list_init(&p->p_connparams, p);
@@ -251 +253 @@
         CHECK_FCT_DO( fd_fifo_del(&p->p_tosend), /* continue */ );
         CHECK_POSIX_DO( pthread_mutex_destroy(&p->p_sr.mtx), /* continue */);
+        CHECK_POSIX_DO( pthread_cond_destroy(&p->p_sr.cnd), /* continue */);
         
         /* If the callback is still around... */

freeDiameter/routing_dispatch.c

@@ -799 +799 @@
         CHECK_FCT( fd_msg_hdr(*pmsg, &hdr) );
         is_req = hdr->msg_flags & CMD_FLAG_REQUEST;
-                
+        
         /* For answers, the routing is very easy */
         if ( ! is_req ) {

include/freeDiameter/libfreeDiameter.h

@@ -2147 +2147 @@
 int fd_msg_anscb_associate( struct msg * msg, void ( *anscb)(void *, struct msg **), void  * data, const struct timespec *timeout );
 int fd_msg_anscb_get      ( struct msg * msg, void (**anscb)(void *, struct msg **), void ** data );
+struct timespec *fd_msg_anscb_gettimeout( struct msg * msg ); /* returns NULL or a valid non-0 timespec */
 
 /*

libfreeDiameter/messages.c

@@ -919 +919 @@
         if (timeout) {
                 memcpy(&msg->msg_cb.timeout, timeout, sizeof(struct timespec));
-        } else {
-                memset(&msg->msg_cb.timeout, 0, sizeof(struct timespec)); /* clear the area */
         }
         
@@ -938 +936 @@
         
         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 */