sessions.c 29.4 KB
Newer Older
1
2
/*********************************************************************************************************
* Software License Agreement (BSD License)                                                               *
Sebastien Decugis's avatar
Sebastien Decugis committed
3
* Author: Sebastien Decugis <sdecugis@freediameter.net>							 *
4
*													 *
5
* Copyright (c) 2011, WIDE Project and NICT								 *
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
* 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.
 */

Sebastien Decugis's avatar
Sebastien Decugis committed
41
#include "fdproto-internal.h"
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

/*********************** 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 */
71
	void 		(*cleanup)(session_state *, os0_t, void *); /* The cleanup function to be called for cleaning a state */
72
	void             *opaque; /* a value that is passed as is to the cleanup callback */
73
74
75
76
77
78
79
80
81
82
83
84
85
};

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 */
	session_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 */
86
		os0_t 			 sid;	/* For deleted state, the sid of the session it belong to */
87
88
89
90
91
92
93
	};
};

/* Session object, one for each value of Session-Id AVP */
struct session {
	int 		eyec;	/* Eyecatcher, SI_EYEC */
	
94
95
	os0_t		sid;	/* The \0-terminated Session-Id */
	size_t		sidlen; /* cached length of sid */
96
97
98
99
100
101
102
103
	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. */
Sebastien Decugis's avatar
Sebastien Decugis committed
104
	int		msg_cnt;/* Reference counter for the messages pointing to this session */
105
	int		is_destroyed; /* boolean telling if fd_sess_detroy has been called on this */
106
107
108
109
};

/* Sessions hash table, to allow fast sid to session retrieval */
static struct {
110
	struct fd_list	sentinel;	/* sentinel element for this sublist. The sublist is ordered by hash value, then fd_os_cmp(sid). */
Sebastien Decugis's avatar
Sebastien Decugis committed
111
	pthread_mutex_t lock;		/* the mutex for this sublist -- we might probably change it to rwlock for a little optimization */
112
113
} sess_hash [ 1 << SESS_HASH_SIZE ] ;
#define H_MASK( __hash ) ((__hash) & (( 1 << SESS_HASH_SIZE ) - 1))
Sebastien Decugis's avatar
Sebastien Decugis committed
114
115
#define H_LIST( _hash ) (&(sess_hash[H_MASK(_hash)].sentinel))
#define H_LOCK( _hash ) (&(sess_hash[H_MASK(_hash)].lock    ))
116

117
118
static uint32_t		sess_cnt = 0; /* counts all active session (that are in the expiry list) */

119
120
/* 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 */
121
static uint32_t   	sid_l;	/* incremented each time a session id is created */
122
123
124
static pthread_mutex_t 	sid_lock = PTHREAD_MUTEX_INITIALIZER;

/* Expiring sessions management */
125
static struct fd_list	exp_sentinel = FD_LIST_INITIALIZER(exp_sentinel);	/* list of sessions ordered by their timeout date */
126
127
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. */
128
static pthread_t	exp_thr = (pthread_t)NULL; 	/* The expiry thread that handles cleanup of expired sessions */
129
130
131
132
133
134
135
136
137

/* 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.
 */

/********************************************************************************************************/

138
139
/* 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)
140
141
142
{
	struct session * sess;
	
143
	TRACE_ENTRY("%p %zd", sid, sidlen);
144
145
146
147
148
149
150
151
	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;
152
153
	sess->sidlen = sidlen;
	sess->hash = hash;
154
155
156
157
158
159
160
161
162
163
164
	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;
}
165
166
167
168
169
170
171
172
173
174
175

/* 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);
}
176
177
178
179
180
181
182
183
184
185
186
187
	
/* The expiry thread */
static void * exp_fct(void * arg)
{
	fd_log_threadname ( "Session/expire" );
	TRACE_ENTRY( "" );
	
	
	do {
		struct timespec	now;
		struct session * first;
		
188
189
190
		CHECK_POSIX_DO( pthread_mutex_lock(&exp_lock),  break );
		pthread_cleanup_push( fd_cleanup_mutex, &exp_lock );
again:		
191
192
193
		/* Check if there are expiring sessions available */
		if (FD_IS_LIST_EMPTY(&exp_sentinel)) {
			/* Just wait for a change or cancelation */
194
			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... */ );
195
			/* Restart the loop on wakeup */
196
			goto again;
197
198
199
200
201
202
203
		}
		
		/* Get the pointer to the session that expires first */
		first = (struct session *)(exp_sentinel.next->o);
		ASSERT( VALIDATE_SI(first) );
		
		/* Get the current time */
204
		CHECK_SYS_DO(  clock_gettime(CLOCK_REALTIME, &now),  break  );
205
206
207
208
209
210

		/* 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 */,
211
					/* on other error, */ break );
212
213
	
			/* on wakeup, loop */
214
			goto again;
215
216
217
		}
		
		/* Now, the first session in the list is expired; destroy it */
218
219
220
221
		pthread_cleanup_pop( 0 );
		CHECK_POSIX_DO( pthread_mutex_unlock(&exp_lock),  break );
		
		CHECK_FCT_DO( fd_sess_destroy( &first ), break );
222
223
224
		
	} while (1);
	
225
	TRACE_DEBUG(INFO, "A system error occurred in session module! Expiry thread is terminating...");
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
	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)  );
	}
	
251
252
253
254
255
256
	return 0;
}

/* Run this when initializations are complete. */
int fd_sess_start(void)
{
257
	/* Start session garbage collector (expiry) */
258
259
260
261
262
	CHECK_POSIX(  pthread_create(&exp_thr, NULL, exp_fct, NULL)  );
	
	return 0;
}

263
264
265
266
267
/* Terminate */
void fd_sess_fini(void)
{
	TRACE_ENTRY("");
	CHECK_FCT_DO( fd_thr_term(&exp_thr), /* continue */ );
268
269
270
	
	/* Destroy all sessions in the hash table, and the hash table itself? -- How to do it without a race condition ? */
	
271
272
273
	return;
}

274
/* Create a new handler */
275
int fd_sess_handler_create_internal ( struct session_handler ** handler, void (*cleanup)(session_state *, os0_t, void *), void * opaque )
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
{
	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;
292
	new->opaque = opaque;
293
294
295
296
297
298
299
	
	*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... */
300
int fd_sess_handler_destroy ( struct session_handler ** handler, void ** opaque )
301
302
{
	struct session_handler * del;
303
304
	/* 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 );
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
	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)  );
		
320
		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 */
321
322
323
			struct fd_list * li_st;
			struct session * sess = (struct session *)(li_si->o);
			CHECK_POSIX(  pthread_mutex_lock(&sess->stlock)  );
324
			for (li_st = sess->states.next; li_st != &sess->states; li_st = li_st->next) { /* for each state in this session */
325
326
327
328
				struct state * st = (struct state *)(li_st->o);
				/* The list is ordered */
				if (st->hdl->id < del->id)
					continue;
329
330
331
				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);
332
					st->sid = sess->sid;
333
334
335
					fd_list_insert_before(&deleted_states, &st->chain);
				}
				break;
336
337
338
339
340
341
342
343
344
345
			}
			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);
346
		(*del->cleanup)(st->state, st->sid, del->opaque);
347
348
349
350
		fd_list_unlink(&st->chain);
		free(st);
	}
	
351
352
353
	if (opaque)
		*opaque = del->opaque;
	
Sebastien Decugis's avatar
Sebastien Decugis committed
354
355
356
	/* Free the handler */
	free(del);
	
357
358
359
360
361
362
	return 0;
}



/* Create a new session object with the default timeout value, and link it */
363
int fd_sess_new ( struct session ** session, DiamId_t diamid, size_t diamidlen, uint8_t * opt, size_t optlen )
364
{
365
	os0_t  sid = NULL;
366
	size_t sidlen;
367
	uint32_t hash;
368
369
370
	struct session * sess;
	struct fd_list * li;
	int found = 0;
371
	int ret = 0;
372
	
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
	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);
388
		} else {
389
			CHECK_PARAMS( fd_os_is_valid_os0(opt, optlen) );
390
		}
391
392
393
394
395
396
397
398
399
	} 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;
400
	} else {
401
402
		uint32_t sid_h_cpy;
		uint32_t sid_l_cpy;
403
		/* "<diamId>;<high32>;<low32>[;opt]" */
404
		sidlen = diamidlen;
405
406
		sidlen += 22; /* max size of ';<high32>;<low32>' */
		if (opt)
407
			sidlen += 1 + optlen; /* ';opt' */
408
409
		sidlen++; /* space for the final \0 also */
		CHECK_MALLOC( sid = malloc(sidlen) );
410
		
411
412
413
		CHECK_POSIX( pthread_mutex_lock(&sid_lock) );
		if ( ++sid_l == 0 ) /* overflow */
			++sid_h;
414
415
416
		sid_h_cpy = sid_h;
		sid_l_cpy = sid_l;
		CHECK_POSIX( pthread_mutex_unlock(&sid_lock) );
417
418
		
		if (opt) {
419
			sidlen = snprintf((char*)sid, sidlen, "%.*s;%u;%u;%.*s", (int)diamidlen, diamid, sid_h_cpy, sid_l_cpy, (int)optlen, opt);
420
		} else {
421
			sidlen = snprintf((char*)sid, sidlen, "%.*s;%u;%u", (int)diamidlen, diamid, sid_h_cpy, sid_l_cpy);
422
423
424
		}
	}
	
425
	hash = fd_os_hash(sid, sidlen);
426
427
	
	/* Now find the place to add this object in the hash table. */
428
429
	CHECK_POSIX( pthread_mutex_lock( H_LOCK(hash) ) );
	pthread_cleanup_push( fd_cleanup_mutex, H_LOCK(hash) );
430
	
431
	for (li = H_LIST(hash)->next; li != H_LIST(hash); li = li->next) {
432
433
434
435
		int cmp;
		struct session * s = (struct session *)(li->o);
		
		/* The list is ordered by hash and sid (in case of collisions) */
436
		if (s->hash < hash)
437
			continue;
438
		if (s->hash > hash)
439
440
			break;
		
441
		cmp = fd_os_cmp(s->sid, s->sidlen, sid, sidlen);
442
443
444
445
446
447
448
449
450
451
452
		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;
	}
	
453
	/* If the session did not exist, we can create it & link it in global tables */
454
	if (!found) {
455
456
457
		CHECK_MALLOC_DO(sess = new_session(sid, sidlen, hash),
			{
				ret = ENOMEM;
Sebastien Decugis's avatar
Sebastien Decugis committed
458
				free(sid);
459
460
461
				goto out;
			} );
	
462
		fd_list_insert_before(li, &sess->chain_h); /* hash table */
463
	} else {
Sebastien Decugis's avatar
Sebastien Decugis committed
464
		free(sid);
465
466
467
468
469
470
471
472
473
474
475
476
		/* 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. */
			TODO("Re-creating a deleted session. Should investigate if this can lead to an issue... (need more feedback)");
			sess = *session;
			
			/* update the expiry time */
			CHECK_SYS_DO( clock_gettime(CLOCK_REALTIME, &sess->timeout), { ASSERT(0); } );
			sess->timeout.tv_sec += SESS_DEFAULT_LIFETIME;
477
		}
478
	}
479
		
480
481
482
483
484
485
486
487
488
	/* 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;
489
	}
490
	fd_list_insert_after( li, &sess->expire );
491
	sess_cnt++;
492
493
494
495
496
497
498

	/* 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 */
499
	pthread_cleanup_pop(0);
500
501
502
503
504
505
	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) ) );
506
	
507
508
	if (ret) /* in case of error */
		return ret;
509
510
511
512
513
514
	
	*session = sess;
	return 0;
}

/* Find or create a session */
515
int fd_sess_fromsid ( uint8_t * sid, size_t len, struct session ** session, int * new)
516
517
518
519
520
521
{
	int ret;
	
	TRACE_ENTRY("%p %d %p %p", sid, len, session, new);
	CHECK_PARAMS( sid && session );
	
522
523
524
525
	if (!fd_os_is_valid_os0(sid,len)) {
		TRACE_DEBUG(INFO, "Warning: a Session-Id value contains \\0 chars... (len:%zd, begin:'%.*s')\n => Debug messages may be truncated.", len, len, sid);
	}
	
526
	/* All the work is done in sess_new */
527
	ret = fd_sess_new ( session, NULL, 0, sid, len );
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
	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 */
544
int fd_sess_getsid ( struct session * session, os0_t * sid, size_t * sidlen )
545
546
547
548
549
550
{
	TRACE_ENTRY("%p %p", session, sid);
	
	CHECK_PARAMS( VALIDATE_SI(session) && sid );
	
	*sid = session->sid;
551
552
	if (sidlen)
		*sidlen = session->sidlen;
553
554
555
556
557
558
559
560
561
562
563
564
565
566
	
	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 ) );
567
	pthread_cleanup_push( fd_cleanup_mutex, &exp_lock );
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
	
	/* 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 );

584
585
	/* We added a new expiring element, we must signal if it was in first position */
	if (session->expire.prev == &exp_sentinel) {
586
		CHECK_POSIX_DO( pthread_cond_signal(&exp_cond), { ASSERT(0); /* so that we don't have a pending cancellation handler */ } );
587
	}
588
589

	/* We're done */
590
	pthread_cleanup_pop(0);
591
592
593
594
595
	CHECK_POSIX( pthread_mutex_unlock( &exp_lock ) );
	
	return 0;
}

596
/* Destroy the states associated to a session, and mark it destroyed. */
597
598
599
int fd_sess_destroy ( struct session ** session )
{
	struct session * sess;
600
601
602
603
604
605
	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 );
606
607
608
609
610
611
612
	
	TRACE_ENTRY("%p", session);
	CHECK_PARAMS( session && VALIDATE_SI(*session) );
	
	sess = *session;
	*session = NULL;
	
613
	/* Lock the hash line */
614
	CHECK_POSIX( pthread_mutex_lock( H_LOCK(sess->hash) ) );
615
	pthread_cleanup_push( fd_cleanup_mutex, H_LOCK(sess->hash) );
616
617
	
	/* Unlink from the expiry list */
618
	CHECK_POSIX_DO( pthread_mutex_lock( &exp_lock ), { ASSERT(0); /* otherwise cleanup handler is not pop'd */ } );
619
620
621
622
	if (!FD_IS_LIST_EMPTY(&sess->expire)) {
		sess_cnt--;
		fd_list_unlink( &sess->expire ); /* no need to signal the condition here */
	}
623
	CHECK_POSIX_DO( pthread_mutex_unlock( &exp_lock ), { ASSERT(0); /* otherwise cleanup handler is not pop'd */ } );
624
	
625
626
	/* 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 */ } );
627
628
629
	while (!FD_IS_LIST_EMPTY(&sess->states)) {
		struct state * st = (struct state *)(sess->states.next->o);
		fd_list_unlink(&st->chain);
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
		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);
655
656
657
		free(st);
	}
	
658
659
660
661
662
663
	/* Finally, destroy the session itself, if it is not referrenced by any message anymore */
	if (destroy_now) {
		del_session(sess);
	} else {
		free(sid);
	}
664
665
666
667
	
	return 0;
}

668
669
670
671
/* Destroy a session if it is not used */
int fd_sess_reclaim ( struct session ** session )
{
	struct session * sess;
672
	uint32_t hash;
673
	int destroy_now = 0;
674
675
676
677
678
	
	TRACE_ENTRY("%p", session);
	CHECK_PARAMS( session && VALIDATE_SI(*session) );
	
	sess = *session;
679
	hash = sess->hash;
680
681
	*session = NULL;
	
682
683
684
685
	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 );
686
	CHECK_POSIX_DO( pthread_mutex_lock( &exp_lock ), { ASSERT(0); /* otherwise, cleanup not poped on FreeBSD */ } );
687
688
	
	/* We only do something if the states list is empty */
689
	if (FD_IS_LIST_EMPTY(&sess->states)) {
690
		/* In this case, we do as in destroy */
691
		fd_list_unlink( &sess->expire );
692
693
694
695
696
697
698
		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;
		}
699
	}
700
	
701
	CHECK_POSIX_DO( pthread_mutex_unlock( &exp_lock ), { ASSERT(0); /* otherwise, cleanup not poped on FreeBSD */ } );
702
	pthread_cleanup_pop(0);
703
704
	CHECK_POSIX_DO( pthread_mutex_unlock( &sess->stlock ), { ASSERT(0); /* otherwise, cleanup not poped on FreeBSD */ } );
	pthread_cleanup_pop(0);
705
	CHECK_POSIX( pthread_mutex_unlock( H_LOCK(hash) ) );
706
	
707
708
709
	if (destroy_now)
		del_session(sess);
	
710
711
712
	return 0;
}

713
/* Save a state information with a session */
714
int fd_sess_state_store_internal ( struct session_handler * handler, struct session * session, session_state ** state )
715
716
717
718
{
	struct state *new;
	struct fd_list * li;
	int already = 0;
719
	int ret = 0;
720
721
	
	TRACE_ENTRY("%p %p %p", handler, session, state);
722
	CHECK_PARAMS( handler && VALIDATE_SH(handler) && session && VALIDATE_SI(session) && (!session->is_destroyed) && state );
723
724
725
	
	/* Lock the session state list */
	CHECK_POSIX( pthread_mutex_lock(&session->stlock) );
726
	pthread_cleanup_push( fd_cleanup_mutex, &session->stlock );
727
728
			
	/* Create the new state object */
729
	CHECK_MALLOC_DO(new = malloc(sizeof(struct state)), { ret = ENOMEM; goto out; } );
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
	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);
746
			already = EALREADY;
747
748
749
750
751
752
753
754
755
756
757
		}
		
		break;
	}
	
	if (!already) {
		fd_list_insert_before(li, &new->chain);
		*state = NULL;
	} else {
		free(new);
	}
758
759
out:
	;	
760
	pthread_cleanup_pop(0);
761
762
	CHECK_POSIX( pthread_mutex_unlock(&session->stlock) );
	
763
	return ret ?: already;
764
765
766
}

/* Get the data back */
767
int fd_sess_state_retrieve_internal ( struct session_handler * handler, struct session * session, session_state ** state )
768
769
770
771
772
773
774
775
776
777
778
{
	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) );
779
	pthread_cleanup_push( fd_cleanup_mutex, &session->stlock );
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
	
	/* 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);
	}
	
797
	pthread_cleanup_pop(0);
798
799
800
801
802
	CHECK_POSIX( pthread_mutex_unlock(&session->stlock) );
	
	return 0;
}

803
/* For the messages module */
804
int fd_sess_fromsid_msg ( uint8_t * sid, size_t len, struct session ** session, int * new)
805
806
{
	TRACE_ENTRY("%p %zd %p %p", sid, len, session, new);
Sebastien Decugis's avatar
Sebastien Decugis committed
807
	CHECK_PARAMS( sid && len && session );
808
809
	
	/* Get the session object */
810
	CHECK_FCT( fd_sess_fromsid ( sid, len, session, new) );
811
	
812
813
	/* Increase count */
	CHECK_FCT( fd_sess_ref_msg ( *session ) );
814
815
816
817
818
	
	/* Done */
	return 0;
}

819
820
821
822
823
824
825
826
827
828
829
830
831
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;
}

832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
int fd_sess_reclaim_msg ( struct session ** session )
{
	int reclaim;
	
	TRACE_ENTRY("%p", session);
	CHECK_PARAMS( session && VALIDATE_SI(*session) );
	
	/* 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) );
	
	if (reclaim == 1) {
		CHECK_FCT(fd_sess_reclaim ( session ));
	} else {
		*session = NULL;
	}
	return 0;
}


854
855
856
857
858

/* Dump functions */
void fd_sess_dump(int level, struct session * session)
{
	struct fd_list * li;
859
860
861
	char buf[30];
	struct tm tm;
	
862
863
864
	if (!TRACE_BOOL(level))
		return;
	
865
	fd_log_debug("\t  %*s -- Session @%p --\n", level, "", session);
866
	if (!VALIDATE_SI(session)) {
867
868
		fd_log_debug("\t  %*s  Invalid session object\n", level, "");
	} else {
869
		
870
		fd_log_debug("\t  %*s  sid '%s'(%zd), hash %x\n", level, "", session->sid, session->sidlen, session->hash);
871
872
873
874
875

		strftime(buf, sizeof(buf), "%D,%T", localtime_r( &session->timeout.tv_sec , &tm ));
		fd_log_debug("\t  %*s  timeout %s.%09ld\n", level, "", buf, session->timeout.tv_nsec);

		CHECK_POSIX_DO( pthread_mutex_lock(&session->stlock), /* ignore */ );
876
		pthread_cleanup_push( fd_cleanup_mutex, &session->stlock );
877
878
879
880
		for (li = session->states.next; li != &session->states; li = li->next) {
			struct state * st = (struct state *)(li->o);
			fd_log_debug("\t  %*s    handler %d registered data %p\n", level, "", st->hdl->id, st->state);
		}
881
		pthread_cleanup_pop(0);
882
		CHECK_POSIX_DO( pthread_mutex_unlock(&session->stlock), /* ignore */ );
883
	}
884
	fd_log_debug("\t  %*s -- end of session @%p --\n", level, "", session);
885
886
887
888
889
890
891
}

void fd_sess_dump_hdl(int level, struct session_handler * handler)
{
	if (!TRACE_BOOL(level))
		return;
	
892
	fd_log_debug("\t  %*s -- Handler @%p --\n", level, "", handler);
893
	if (!VALIDATE_SH(handler)) {
894
895
		fd_log_debug("\t  %*s  Invalid session handler object\n", level, "");
	} else {
896
		fd_log_debug("\t  %*s  id %d, cleanup %p, opaque %p\n", level, "", handler->id, handler->cleanup, handler->opaque);
897
	}
898
	fd_log_debug("\t  %*s -- end of handler @%p --\n", level, "", handler);
899
}	
900
901
902
903
904
905
906
907
908

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;
}