afb-session: Use clock insensitive to time changes
[src/app-framework-binder.git] / src / afb-session.c
index c941eef..01e9bfc 100644 (file)
 #define COOKEYCOUNT    8
 #define COOKEYMASK     (COOKEYCOUNT - 1)
 
-#define NOW (time(NULL))
+#define _MAXEXP_       ((time_t)(~(time_t)0))
+#define _MAXEXP2_      ((time_t)((((unsigned long long)_MAXEXP_) >> 1)))
+#define MAX_EXPIRATION (_MAXEXP_ >= 0 ? _MAXEXP_ : _MAXEXP2_)
+#define NOW            (time_now())
 
 struct cookie
 {
@@ -53,10 +56,11 @@ struct afb_session
        int timeout;
        time_t expiration;      // expiration time of the token
        pthread_mutex_t mutex;
+       struct cookie *cookies[COOKEYCOUNT];
+       char autoclose;
        char idx;
        char uuid[SIZEUUID];    // long term authentication of remote client
        char token[SIZEUUID];   // short term authentication of remote client
-       struct cookie *cookies[COOKEYCOUNT];
 };
 
 // Session UUID are store in a simple array [for 10 sessions this should be enough]
@@ -69,6 +73,14 @@ static struct {
        char initok[SIZEUUID];
 } sessions;
 
+/* Get the actual raw time */
+static inline time_t time_now()
+{
+       struct timespec ts;
+       clock_gettime(CLOCK_MONOTONIC_RAW, &ts);
+       return ts.tv_sec;
+}
+
 /* generate a uuid */
 static void new_uuid(char uuid[SIZEUUID])
 {
@@ -88,21 +100,18 @@ static inline void unlock(struct afb_session *session)
 }
 
 // Free context [XXXX Should be protected again memory abort XXXX]
-static void remove_all_cookies(struct afb_session *session)
+static void close_session(struct afb_session *session)
 {
        int idx;
-       struct cookie *cookie, *next;
+       struct cookie *cookie;
 
-       // free cookies
+       /* free cookies */
        for (idx = 0 ; idx < COOKEYCOUNT ; idx++) {
-               cookie = session->cookies[idx];
-               session->cookies[idx] = NULL;
-               while (cookie != NULL) {
-                       next = cookie->next;
+               while ((cookie = session->cookies[idx])) {
+                       session->cookies[idx] = cookie->next;
                        if (cookie->freecb != NULL)
                                cookie->freecb(cookie->value);
                        free(cookie);
-                       cookie = next;
                }
        }
 }
@@ -162,7 +171,7 @@ static void destroy (struct afb_session *session)
 
        assert (session != NULL);
 
-       remove_all_cookies(session);
+       close_session(session);
        pthread_mutex_lock(&sessions.mutex);
        prv = &sessions.heads[(int)session->idx];
        while (*prv)
@@ -178,20 +187,6 @@ static void destroy (struct afb_session *session)
        pthread_mutex_unlock(&sessions.mutex);
 }
 
-// Check if context timeout or not
-static int is_expired (struct afb_session *ctx, time_t now)
-{
-       assert (ctx != NULL);
-       return ctx->expiration < now;
-}
-
-// Check if context is active or not
-static int is_active (struct afb_session *ctx, time_t now)
-{
-       assert (ctx != NULL);
-       return ctx->uuid[0] != 0 && ctx->expiration >= now;
-}
-
 // Loop on every entry and remove old context sessions.hash
 static time_t cleanup ()
 {
@@ -205,7 +200,7 @@ static time_t cleanup ()
                session = sessions.heads[idx];
                while (session) {
                        next = session->next;
-                       if (is_expired(session, now))
+                       if (session->expiration < now)
                                afb_session_close(session);
                        session = next;
                }
@@ -213,10 +208,35 @@ static time_t cleanup ()
        return now;
 }
 
+static void update_timeout(struct afb_session *session, time_t now, int timeout)
+{
+       time_t expiration;
+
+       /* compute expiration */
+       if (timeout == AFB_SESSION_TIMEOUT_INFINITE)
+               expiration = MAX_EXPIRATION;
+       else {
+               if (timeout == AFB_SESSION_TIMEOUT_DEFAULT)
+                       expiration = now + sessions.timeout;
+               else
+                       expiration = now + timeout;
+               if (expiration < 0)
+                       expiration = MAX_EXPIRATION;
+       }
+
+       /* record the values */
+       session->timeout = timeout;
+       session->expiration = expiration;
+}
+
+static void update_expiration(struct afb_session *session, time_t now)
+{
+       update_timeout(session, now, session->timeout);
+}
+
 static struct afb_session *add_session (const char *uuid, int timeout, time_t now, int idx)
 {
        struct afb_session *session;
-       time_t expiration;
 
        /* check arguments */
        if (!AFB_SESSION_TIMEOUT_IS_VALID(timeout)
@@ -231,16 +251,6 @@ static struct afb_session *add_session (const char *uuid, int timeout, time_t no
                return NULL;
        }
 
-       /* compute expiration */
-       if (timeout == AFB_SESSION_TIMEOUT_DEFAULT)
-               timeout = sessions.timeout;
-       expiration = now + timeout;
-       if (timeout == AFB_SESSION_TIMEOUT_INFINITE || expiration < 0) {
-               expiration = (time_t)(~(time_t)0);
-               if (expiration < 0)
-                       expiration = (time_t)(((unsigned long long)expiration) >> 1);
-       }
-
        /* allocates a new one */
        session = calloc(1, sizeof *session);
        if (session == NULL) {
@@ -253,8 +263,9 @@ static struct afb_session *add_session (const char *uuid, int timeout, time_t no
        session->refcount = 1;
        strcpy(session->uuid, uuid);
        strcpy(session->token, sessions.initok);
-       session->timeout = timeout;
-       session->expiration = expiration;
+       update_timeout(session, now, timeout);
+
+       /* link */
        session->idx = (char)idx;
        session->next = sessions.heads[idx];
        sessions.heads[idx] = session;
@@ -356,7 +367,7 @@ void afb_session_unref(struct afb_session *session)
                assert(session->refcount != 0);
                if (!__atomic_sub_fetch(&session->refcount, 1, __ATOMIC_RELAXED)) {
                        pthread_mutex_lock(&session->mutex);
-                       if (session->uuid[0] == 0)
+                       if (session->autoclose || session->uuid[0] == 0)
                                destroy (session);
                        else
                                pthread_mutex_unlock(&session->mutex);
@@ -364,15 +375,16 @@ void afb_session_unref(struct afb_session *session)
        }
 }
 
-// Free Client Session Context
+// close Client Session Context
 void afb_session_close (struct afb_session *session)
 {
        assert(session != NULL);
        pthread_mutex_lock(&session->mutex);
        if (session->uuid[0] != 0) {
                session->uuid[0] = 0;
-               remove_all_cookies(session);
-               if (session->refcount == 0) {
+               if (session->refcount)
+                       close_session(session);
+               else {
                        destroy (session);
                        return;
                }
@@ -380,14 +392,37 @@ void afb_session_close (struct afb_session *session)
        pthread_mutex_unlock(&session->mutex);
 }
 
+/* set the autoclose flag */
+void afb_session_set_autoclose(struct afb_session *session, int autoclose)
+{
+       assert(session != NULL);
+       session->autoclose = (char)!!autoclose;
+}
+
+// is the session active?
+int afb_session_is_active (struct afb_session *session)
+{
+       assert(session != NULL);
+       return !!session->uuid[0];
+}
+
+// is the session closed?
+int afb_session_is_closed (struct afb_session *session)
+{
+       assert(session != NULL);
+       return !session->uuid[0];
+}
+
 // Sample Generic Ping Debug API
 int afb_session_check_token (struct afb_session *session, const char *token)
 {
        assert(session != NULL);
        assert(token != NULL);
 
-       // compare current token with previous one
-       if (!is_active (session, NOW))
+       if (!session->uuid[0])
+               return 0;
+
+       if (session->expiration < NOW)
                return 0;
 
        if (session->token[0] && strcmp (token, session->token) != 0)
@@ -405,8 +440,7 @@ void afb_session_new_token (struct afb_session *session)
        new_uuid(session->token);
 
        // keep track of time for session timeout and further clean up
-       if (session->timeout != 0)
-               session->expiration = NOW + session->timeout;
+       update_expiration(session, NOW);
 }
 
 /* Returns the uuid of 'session' */