belle_sip_object.c 24.8 KB
Newer Older
Simon Morlat's avatar
Simon Morlat committed
1 2
/*
	belle-sip - SIP (RFC3261) library.
3
	Copyright (C) 2010  Belledonne Communications SARL
Simon Morlat's avatar
Simon Morlat committed
4

5 6
	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
7
	the Free Software Foundation, either version 2 of the License, or
8
	(at your option) any later version.
Simon Morlat's avatar
Simon Morlat committed
9

10 11 12 13
	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.
Simon Morlat's avatar
Simon Morlat committed
14

15 16
	You should have received a copy of the GNU General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
Simon Morlat's avatar
Simon Morlat committed
17 18 19 20
*/

#include "belle_sip_internal.h"

Simon Morlat's avatar
Simon Morlat committed
21
static void _belle_sip_object_pool_remove_from_stack(belle_sip_object_pool_t *pool);
22

23 24
static int _belle_sip_object_marshal_check_enabled = FALSE;

Simon Morlat's avatar
Simon Morlat committed
25 26
static int has_type(belle_sip_object_t *obj, belle_sip_type_id_t id){
	belle_sip_object_vptr_t *vptr=obj->vptr;
27

Simon Morlat's avatar
Simon Morlat committed
28 29
	while(vptr!=NULL){
		if (vptr->id==id) return TRUE;
30
		vptr=vptr->get_parent();
Simon Morlat's avatar
Simon Morlat committed
31
	}
Simon Morlat's avatar
Simon Morlat committed
32
	return FALSE;
Simon Morlat's avatar
Simon Morlat committed
33
}
34

35
int _belle_sip_object_is_instance_of(belle_sip_object_t * obj,belle_sip_type_id_t id) {
36 37
	return has_type(obj,id);
}
38

39 40 41 42
void belle_sip_object_enable_marshal_check(int enable) {
	_belle_sip_object_marshal_check_enabled = (enable) ? TRUE : FALSE;
}

43 44 45

static belle_sip_list_t *all_objects=NULL;
static int belle_sip_leak_detector_enabled=FALSE;
46
static int belle_sip_leak_detector_inhibited=FALSE;
47 48

static void add_new_object(belle_sip_object_t *obj){
49
	if (belle_sip_leak_detector_enabled && !belle_sip_leak_detector_inhibited){
50 51 52 53 54
		all_objects=belle_sip_list_prepend(all_objects,obj);
	}
}

static void remove_free_object(belle_sip_object_t *obj){
55 56
	if (belle_sip_leak_detector_enabled && !belle_sip_leak_detector_inhibited){
		all_objects=_belle_sip_list_remove(all_objects,obj,FALSE); /*it may fail if the leak detector was inhibitted at the time the object was created*/
57 58 59
	}
}

60 61 62 63
void belle_sip_object_inhibit_leak_detector(int yes){
	belle_sip_leak_detector_inhibited=yes ? TRUE : FALSE;
}

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
void belle_sip_object_enable_leak_detector(int enable){
	belle_sip_leak_detector_enabled=enable;
}

int belle_sip_object_get_object_count(void){
	return belle_sip_list_size(all_objects);
}

void belle_sip_object_dump_active_objects(void){
	belle_sip_list_t *elem;
	
	if (all_objects){
		belle_sip_message("List of leaked objects:");
		for(elem=all_objects;elem!=NULL;elem=elem->next){
			belle_sip_object_t *obj=(belle_sip_object_t*)elem->data;
			belle_sip_message("%s(%p) ref=%i",obj->vptr->type_name,obj,obj->ref);
		}
	}else belle_sip_message("No objects leaked.");
}

Simon Morlat's avatar
Simon Morlat committed
84
belle_sip_object_t * _belle_sip_object_new(size_t objsize, belle_sip_object_vptr_t *vptr){
85
	belle_sip_object_t *obj=(belle_sip_object_t *)belle_sip_malloc0(vptr->size);
86

Simon Morlat's avatar
Simon Morlat committed
87
	obj->ref=vptr->initially_unowned ? 0 : 1;
88
	obj->vptr=vptr;
89
	if (obj->ref==0){
90 91
		belle_sip_object_pool_t *pool=belle_sip_object_pool_get_current();
		if (pool) belle_sip_object_pool_add(pool,obj);
92
	}
93
	add_new_object(obj);
Simon Morlat's avatar
Simon Morlat committed
94 95 96
	return obj;
}

Simon Morlat's avatar
Simon Morlat committed
97 98
int belle_sip_object_is_initially_unowned(const belle_sip_object_t *obj){
	return obj->vptr->initially_unowned;
Simon Morlat's avatar
Simon Morlat committed
99 100
}

101
belle_sip_object_t * belle_sip_object_ref(void *obj){
102
	belle_sip_object_t *o=BELLE_SIP_OBJECT(obj);
103 104
	if (o->ref==0 && o->pool){
		belle_sip_object_pool_remove(o->pool,obj);
105 106
	}
	o->ref++;
jehan's avatar
jehan committed
107
	return obj;
Simon Morlat's avatar
Simon Morlat committed
108 109
}

110 111
void belle_sip_object_unref(void *ptr){
	belle_sip_object_t *obj=BELLE_SIP_OBJECT(ptr);
112 113 114
	if (obj->ref==-1) {
		belle_sip_error("Object [%p] freed twice !",obj);
		if (obj->vptr && obj->vptr->type_name) belle_sip_error("Object type might be [%s]",obj->vptr->type_name);
115
		if (obj->name) belle_sip_error("Object name might be [%s]",obj->name);
116 117 118
		belle_sip_fatal("Fatal object error encountered, aborting.");
		return;
	}
119 120
	if (obj->ref==0 && obj->pool){
		belle_sip_object_pool_remove(obj->pool,obj);
121
		obj->ref=-1;
Simon Morlat's avatar
Simon Morlat committed
122
		belle_sip_object_delete(obj);
Simon Morlat's avatar
Simon Morlat committed
123 124 125 126
		return;
	}
	obj->ref--;
	if (obj->ref==0){
127
		obj->ref=-1;
Simon Morlat's avatar
Simon Morlat committed
128
		belle_sip_object_delete(obj);
Simon Morlat's avatar
Simon Morlat committed
129 130 131
	}
}

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
static weak_ref_t *weak_ref_new(belle_sip_object_destroy_notify_t destroy_notify, void *userpointer){
	weak_ref_t *r=belle_sip_new(weak_ref_t);
	r->next=NULL;
	r->notify=destroy_notify;
	r->userpointer=userpointer;
	return r;
}

belle_sip_object_t *belle_sip_object_weak_ref(void *obj, belle_sip_object_destroy_notify_t destroy_notify, void *userpointer){
	belle_sip_object_t *o=BELLE_SIP_OBJECT(obj);
	weak_ref_t *old=o->weak_refs;
	o->weak_refs=weak_ref_new(destroy_notify,userpointer);
	o->weak_refs->next=old;
	return o;
}

void belle_sip_object_weak_unref(void *obj, belle_sip_object_destroy_notify_t destroy_notify, void *userpointer){
	belle_sip_object_t *o=BELLE_SIP_OBJECT(obj);
	weak_ref_t *ref,*prevref=NULL,*next=NULL;
151
	int found=FALSE;
152 153 154 155 156 157 158 159

	if (o->ref==-1) return; /*too late and avoid recursions*/
	for(ref=o->weak_refs;ref!=NULL;ref=next){
		next=ref->next;
		if (ref->notify==destroy_notify && ref->userpointer==userpointer){
			if (prevref==NULL) o->weak_refs=next;
			else prevref->next=next;
			belle_sip_free(ref);
160 161
			found=TRUE;
			/*do not break or return, someone could have put twice the same weak ref on the same object*/
162 163 164 165
		}else{
			prevref=ref;
		}
	}
166
	if (!found) belle_sip_fatal("Could not find weak_ref, you're a looser.");
167 168 169 170 171 172 173 174 175 176 177 178
}

static void belle_sip_object_loose_weak_refs(belle_sip_object_t *obj){
	weak_ref_t *ref,*next;
	for(ref=obj->weak_refs;ref!=NULL;ref=next){
		next=ref->next;
		ref->notify(ref->userpointer,obj);
		belle_sip_free(ref);
	}
	obj->weak_refs=NULL;
}

Simon Morlat's avatar
Simon Morlat committed
179 180 181 182 183 184 185 186 187
static void _belle_sip_object_uninit(belle_sip_object_t *obj){
	if (obj->name)
		belle_sip_free(obj->name);
}

static void _belle_sip_object_clone(belle_sip_object_t *obj, const belle_sip_object_t *orig){
	if (orig->name!=NULL) obj->name=belle_sip_strdup(obj->name);
}

188
static belle_sip_error_code _belle_object_marshal(belle_sip_object_t* obj, char* buff, size_t buff_size, size_t *offset) {
Ghislain MARY's avatar
Ghislain MARY committed
189
	return belle_sip_snprintf(buff,buff_size,offset,"{%s::%s %p}",obj->vptr->type_name,obj->name ? obj->name : "(no name)",obj);
Simon Morlat's avatar
Simon Morlat committed
190 191
}

192 193 194 195
static belle_sip_object_vptr_t *no_parent(void){
	return NULL;
}

Simon Morlat's avatar
Simon Morlat committed
196 197
belle_sip_object_vptr_t belle_sip_object_t_vptr={
	BELLE_SIP_TYPE_ID(belle_sip_object_t),
198
	sizeof(belle_sip_object_t),
Simon Morlat's avatar
Simon Morlat committed
199 200
	"belle_sip_object_t",
	FALSE,
201
	no_parent, /*no parent, it's god*/
Simon Morlat's avatar
Simon Morlat committed
202 203
	NULL,
	_belle_sip_object_uninit,
jehan's avatar
jehan committed
204
	_belle_sip_object_clone,
Ghislain MARY's avatar
Ghislain MARY committed
205
	_belle_object_marshal
Simon Morlat's avatar
Simon Morlat committed
206 207
};

208 209 210 211
belle_sip_object_vptr_t *belle_sip_object_t_vptr_get(void){
	return &belle_sip_object_t_vptr;
}

Simon Morlat's avatar
Simon Morlat committed
212
void belle_sip_object_delete(void *ptr){
213
	belle_sip_object_t *obj=BELLE_SIP_OBJECT(ptr);
Simon Morlat's avatar
Simon Morlat committed
214
	belle_sip_object_vptr_t *vptr;
215

216
	belle_sip_object_loose_weak_refs(obj);
217
	remove_free_object(obj);
218 219 220
	vptr=obj->vptr;
	while(vptr!=NULL){
		if (vptr->destroy) vptr->destroy(obj);
221
		vptr=vptr->get_parent();
222
	}
223
	belle_sip_object_data_clear(obj);
224
	belle_sip_free(obj);
Simon Morlat's avatar
Simon Morlat committed
225 226
}

Simon Morlat's avatar
Simon Morlat committed
227 228
static belle_sip_object_vptr_t *find_common_floor(belle_sip_object_vptr_t *vptr1, belle_sip_object_vptr_t *vptr2){
	belle_sip_object_vptr_t *it1,*it2;
229
	for (it1=vptr1;it1!=NULL;it1=it1->get_parent()){
Simon Morlat's avatar
Simon Morlat committed
230 231 232
		if (it1==vptr2)
			return vptr2;
	}
233
	for(it2=vptr2;it2!=NULL;it2=it2->get_parent()){
Simon Morlat's avatar
Simon Morlat committed
234 235 236
		if (vptr1==it2)
			return vptr1;
	}
237
	return find_common_floor(vptr1->get_parent(),vptr2);
Simon Morlat's avatar
Simon Morlat committed
238 239 240 241 242 243 244 245 246 247 248 249 250 251
}

/*copy the content of ref object to new object, for the part they have in common in their inheritence diagram*/
void _belle_sip_object_copy(belle_sip_object_t *newobj, const belle_sip_object_t *ref){
	belle_sip_object_vptr_t *vptr;
	vptr=find_common_floor(newobj->vptr,ref->vptr);
	if (vptr==NULL){
		belle_sip_fatal("Should not happen");
	}
	while(vptr!=NULL){
		if (vptr->clone==NULL){
			belle_sip_fatal("Object of type %s cannot be cloned, it does not provide a clone() implementation.",vptr->type_name);
			return;
		}else vptr->clone(newobj,ref);
252
		vptr=vptr->get_parent();
Simon Morlat's avatar
Simon Morlat committed
253 254 255
	}
}

Simon Morlat's avatar
Simon Morlat committed
256 257
belle_sip_object_t *belle_sip_object_clone(const belle_sip_object_t *obj){
	belle_sip_object_t *newobj;
258

259
	newobj=belle_sip_malloc0(obj->vptr->size);
jehan's avatar
jehan committed
260
	newobj->ref=obj->vptr->initially_unowned ? 0 : 1;
Simon Morlat's avatar
Simon Morlat committed
261
	newobj->vptr=obj->vptr;
Simon Morlat's avatar
Simon Morlat committed
262
	_belle_sip_object_copy(newobj,obj);
263
	if (newobj->ref==0){
264 265
		belle_sip_object_pool_t *pool=belle_sip_object_pool_get_current();
		if (pool) belle_sip_object_pool_add(pool,newobj);
266
	}
267
	add_new_object(newobj);
Simon Morlat's avatar
Simon Morlat committed
268 269 270
	return newobj;
}

271 272 273
belle_sip_object_t *belle_sip_object_clone_and_ref(const belle_sip_object_t *obj) {
	return belle_sip_object_ref(belle_sip_object_clone(obj));
}
Simon Morlat's avatar
Simon Morlat committed
274

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290

struct belle_sip_object_data{
	char* name;
	void* data;
	belle_sip_data_destroy destroy_func;
};

static int belle_sip_object_data_find(const void* a, const void* b)
{
	struct belle_sip_object_data* da = (struct belle_sip_object_data*)a;
	return strcmp(da->name, (const char*)b);
}

static void belle_sip_object_data_destroy(void* data)
{
	struct belle_sip_object_data* da = (struct belle_sip_object_data*)data;
291
	if (da->destroy_func) da->destroy_func(da->data);
292
	belle_sip_free(da->name);
293
	belle_sip_free(da);
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
}

int belle_sip_object_data_set( belle_sip_object_t *obj, const char* name, void* data, belle_sip_data_destroy destroy_func )
{
	int ret = 0;
	struct _belle_sip_list*  list_entry = belle_sip_list_find_custom(obj->data_store, belle_sip_object_data_find, name);
	struct belle_sip_object_data* entry = (list_entry)? list_entry->data : NULL;

	if( entry == NULL){
		entry = belle_sip_malloc0(sizeof( struct belle_sip_object_data));
		obj->data_store = belle_sip_list_append(obj->data_store, entry);
	}
	else {
		// clean previous data
		if( entry->destroy_func ) entry->destroy_func(entry->data);
		belle_sip_free(entry->name);
		ret = 1;
	}

	if( entry ){
		entry->data = data;
		entry->name = belle_sip_strdup(name);
		entry->destroy_func = destroy_func;
	} else {
		ret = -1;
	}
	return ret;
}

void* belle_sip_object_data_get( belle_sip_object_t *obj, const char* name )
{
	struct _belle_sip_list*  list_entry = belle_sip_list_find_custom(obj->data_store, belle_sip_object_data_find, name);
	struct belle_sip_object_data* entry = (list_entry)? list_entry->data : NULL;

	return entry? entry->data : NULL;
}

int belle_sip_object_data_remove( belle_sip_object_t *obj, const char* name)
{
	struct _belle_sip_list*  list_entry = belle_sip_list_find_custom(obj->data_store, belle_sip_object_data_find, name);
	struct belle_sip_object_data* entry = (list_entry)? list_entry->data : NULL;
	if( entry ){
		belle_sip_free(entry->name);
		if( entry->destroy_func ) entry->destroy_func(entry->data);
		belle_sip_free(entry);
	}
	if( list_entry ) obj->data_store = belle_sip_list_remove_link(obj->data_store, list_entry);
	return !(list_entry!= NULL);
}

344
int belle_sip_object_data_exists( const belle_sip_object_t *obj, const char* name )
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
{
	return (belle_sip_list_find_custom(obj->data_store, belle_sip_object_data_find, name) != NULL);
}


void* belle_sip_object_data_grab( belle_sip_object_t* obj, const char* name)
{
	struct _belle_sip_list*  list_entry = belle_sip_list_find_custom(obj->data_store, belle_sip_object_data_find, name);
	struct belle_sip_object_data* entry = (list_entry)? list_entry->data : NULL;
	void* data =NULL;

	if( entry ){
		belle_sip_free(entry->name);
		data = entry->data;
	}
	obj->data_store = belle_sip_list_remove_link(obj->data_store, list_entry);
	belle_sip_free(entry);

	return data;
}

void belle_sip_object_data_clear( belle_sip_object_t* obj )
{
	belle_sip_list_for_each(obj->data_store, belle_sip_object_data_destroy);
	obj->data_store = belle_sip_list_free(obj->data_store);
}

372
void belle_sip_object_data_clone( const belle_sip_object_t* src, belle_sip_object_t* dst, belle_sip_data_clone clone_func)
373 374 375 376 377
{
	belle_sip_object_data_clear(dst);
	belle_sip_object_data_merge(src, dst, clone_func);
}

378
void belle_sip_object_data_merge( const belle_sip_object_t* src, belle_sip_object_t* dst, belle_sip_data_clone clone_func)
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
{
	struct _belle_sip_list* list = src->data_store;
	struct belle_sip_object_data* it = NULL;
	void* cloned_data = NULL;

	while( list ){
		it = list->data;
		if( it ){
			cloned_data = (clone_func)? clone_func( it->name, it->data ) : it->data;
			belle_sip_object_data_set(dst, it->name, cloned_data, it->destroy_func);
		}
		list = list->next;
	}
}


395 396 397 398 399
struct belle_sip_object_foreach_data {
	void (*apply_func)(const char*, void*, void*);
	void* userdata;
};

400
static void belle_sip_object_for_each_cb(void* data, void* pvdata)
401
{
402 403
	struct belle_sip_object_data*         it = (struct belle_sip_object_data*)data;
	struct belle_sip_object_foreach_data* fd = (struct belle_sip_object_foreach_data*)pvdata;
404

405 406 407
	if( it && fd->apply_func ){
		fd->apply_func(it->name, it->data, fd->userdata);
	}
408 409 410 411 412 413 414
}

void belle_sip_object_data_foreach( const belle_sip_object_t* obj, void (*apply_func)(const char* key, void* data, void* userdata), void* userdata)
{
	struct belle_sip_object_foreach_data fd = { apply_func, userdata };
	belle_sip_list_for_each2(obj->data_store, belle_sip_object_for_each_cb, &fd);
}
415 416


Simon Morlat's avatar
Simon Morlat committed
417
void *belle_sip_object_cast(belle_sip_object_t *obj, belle_sip_type_id_t id, const char *castname, const char *file, int fileno){
418 419 420 421 422
	if (obj!=NULL){
		if (has_type(obj,id)==0){
			belle_sip_fatal("Bad cast to %s at %s:%i",castname,file,fileno);
			return NULL;
		}
Simon Morlat's avatar
Simon Morlat committed
423 424 425
	}
	return obj;
}
Simon Morlat's avatar
Simon Morlat committed
426

427 428 429
void *belle_sip_object_get_interface_methods(belle_sip_object_t *obj, belle_sip_interface_id_t ifid){
	if (obj!=NULL){
		belle_sip_object_vptr_t *vptr;
430
		for (vptr=obj->vptr;vptr!=NULL;vptr=vptr->get_parent()){
Simon Morlat's avatar
Simon Morlat committed
431
			belle_sip_interface_desc_t **ifaces=vptr->interfaces;
432 433
			if (ifaces!=NULL){
				for(;*ifaces!=0;++ifaces){
Simon Morlat's avatar
Simon Morlat committed
434
					if ((*ifaces)->id==ifid){
435 436 437 438 439 440 441 442 443 444 445 446 447
						return *ifaces;
					}
				}
			}
		}
	}
	return NULL;
}

int belle_sip_object_implements(belle_sip_object_t *obj, belle_sip_interface_id_t id){
	return belle_sip_object_get_interface_methods(obj,id)!=NULL;
}

Simon Morlat's avatar
Simon Morlat committed
448
void *belle_sip_object_interface_cast(belle_sip_object_t *obj, belle_sip_interface_id_t ifid, const char *castname, const char *file, int fileno){
449 450 451 452 453 454 455 456
	if (obj!=NULL){
		if (belle_sip_object_get_interface_methods(obj,ifid)==0){
			belle_sip_fatal("Bad cast to interface %s at %s:%i",castname,file,fileno);
			return NULL;
		}
	}
	return obj;
}
Simon Morlat's avatar
Simon Morlat committed
457

458
void belle_sip_object_set_name(belle_sip_object_t* object,const char* name) {
Simon Morlat's avatar
Simon Morlat committed
459 460 461 462 463 464
	if (object->name) {
		belle_sip_free(object->name);
		object->name=NULL;
	}
	if (name)
		object->name=belle_sip_strdup(name);
465
}
Simon Morlat's avatar
Simon Morlat committed
466

467 468 469
const char* belle_sip_object_get_name(belle_sip_object_t* object) {
	return object->name;
}
jehan's avatar
jehan committed
470

471 472
static belle_sip_error_code checked_marshal(belle_sip_object_vptr_t *vptr, belle_sip_object_t* obj, char* buff, size_t buff_size, size_t *offset){
	size_t tmp_buf_size=buff_size*2;
473
	char *p=(char*)belle_sip_malloc0(tmp_buf_size);
474 475
	size_t i;
	size_t initial_offset=*offset;
Ghislain MARY's avatar
Ghislain MARY committed
476
	belle_sip_error_code error=vptr->marshal(obj,p,buff_size,offset);
477 478 479 480 481 482
	size_t written;

	for (i=initial_offset;i<buff_size;++i){
		if (p[i]=='\0') break;
	}
	written=i-initial_offset;
Ghislain MARY's avatar
Ghislain MARY committed
483
	if (error==BELLE_SIP_BUFFER_OVERFLOW){
484
		belle_sip_error("Object of type %s commited a buffer overflow by marshalling %i bytes",
Simon Morlat's avatar
Simon Morlat committed
485
			vptr->type_name,(int)(*offset-initial_offset));
Ghislain MARY's avatar
Ghislain MARY committed
486
	} else if (error!=BELLE_SIP_OK){
487
		belle_sip_error("Object of type %s produced an error during marshalling: %i",
Ghislain MARY's avatar
Ghislain MARY committed
488
			vptr->type_name,error);
489
	}
490 491
	if (written!=(*offset-initial_offset) && written!=(buff_size-initial_offset-1)){ /*this is because snprintf won't allow you to write a non null character at the end of the buffer*/
		belle_sip_fatal("Object of type %s marshalled %i bytes but said it marshalled %i bytes !",
Simon Morlat's avatar
Simon Morlat committed
492
			vptr->type_name,(int)written,(int)(*offset-initial_offset));
493 494
	}
	memcpy(buff+initial_offset,p+initial_offset,*offset-initial_offset);
495
	belle_sip_free(p);
496
	return error;
497 498
}

499
belle_sip_error_code belle_sip_object_marshal(belle_sip_object_t* obj, char* buff, size_t buff_size, size_t *offset) {
jehan's avatar
jehan committed
500 501 502
	belle_sip_object_vptr_t *vptr=obj->vptr;
	while (vptr != NULL) {
		if (vptr->marshal != NULL) {
503 504 505 506
			if (_belle_sip_object_marshal_check_enabled == TRUE)
				return checked_marshal(vptr,obj,buff,buff_size,offset);
			else
				return vptr->marshal(obj,buff,buff_size,offset);
jehan's avatar
jehan committed
507
		} else {
508
			vptr=vptr->get_parent();
jehan's avatar
jehan committed
509 510
		}
	}
Ghislain MARY's avatar
Ghislain MARY committed
511
	return BELLE_SIP_NOT_IMPLEMENTED; /*no implementation found*/
jehan's avatar
jehan committed
512
}
Simon Morlat's avatar
Simon Morlat committed
513

514

515 516
static char * belle_sip_object_to_alloc_string(belle_sip_object_t *obj, int size_hint){
	char *buf=belle_sip_malloc(size_hint);
517
	size_t offset=0;
Ghislain MARY's avatar
Ghislain MARY committed
518
	belle_sip_error_code error = belle_sip_object_marshal(obj,buf,size_hint-1,&offset);
519
	obj->vptr->tostring_bufsize_hint=size_hint;
Ghislain MARY's avatar
Ghislain MARY committed
520
	if (error==BELLE_SIP_BUFFER_OVERFLOW){
521 522 523 524
		belle_sip_message("belle_sip_object_to_alloc_string(): hint buffer was too short while doing to_string() for %s, retrying", obj->vptr->type_name);
		belle_sip_free(buf);
		return belle_sip_object_to_alloc_string(obj,2*size_hint);
	}
Ghislain MARY's avatar
Ghislain MARY committed
525 526
	buf=belle_sip_realloc(buf,offset+1);
	buf[offset]='\0';
527 528
	return buf;
}
jehan's avatar
jehan committed
529

530 531 532 533 534 535
static int get_hint_size(int size){
	if (size<128)
		return 128;
	return size;
}

536 537 538 539 540 541
char* belle_sip_object_to_string(void* _obj) {
	belle_sip_object_t *obj=BELLE_SIP_OBJECT(_obj);
	if (obj->vptr->tostring_bufsize_hint!=0){
		return belle_sip_object_to_alloc_string(obj,obj->vptr->tostring_bufsize_hint);
	}else{
		char buff[BELLE_SIP_MAX_TO_STRING_SIZE];
542
		size_t offset=0;
Ghislain MARY's avatar
Ghislain MARY committed
543 544
		belle_sip_error_code error = belle_sip_object_marshal(obj,buff,sizeof(buff),&offset);
		if (error==BELLE_SIP_BUFFER_OVERFLOW){
545
			belle_sip_message("belle_sip_object_to_string(): temporary buffer is too short while doing to_string() for %s, retrying", obj->vptr->type_name);
Ghislain MARY's avatar
Ghislain MARY committed
546
			return belle_sip_object_to_alloc_string(obj,get_hint_size(2*offset));
547
		}
Ghislain MARY's avatar
Ghislain MARY committed
548 549
		buff[offset]='\0';
		obj->vptr->tostring_bufsize_hint=get_hint_size(2*offset);
550 551
		return belle_sip_strdup(buff);
	}
jehan's avatar
jehan committed
552
}
Simon Morlat's avatar
Simon Morlat committed
553 554 555 556 557

char * _belle_sip_object_describe_type(belle_sip_object_vptr_t *vptr){
	const int maxbufsize=2048;
	char *ret=belle_sip_malloc(maxbufsize);
	belle_sip_object_vptr_t *it;
Simon Morlat's avatar
Simon Morlat committed
558
	size_t pos=0;
Simon Morlat's avatar
Simon Morlat committed
559
	belle_sip_list_t *l=NULL,*elem;
Ghislain MARY's avatar
Ghislain MARY committed
560 561
	belle_sip_snprintf(ret,maxbufsize,&pos,"Ownership:\n");
	belle_sip_snprintf(ret,maxbufsize,&pos,"\t%s is created initially %s\n",vptr->type_name,
562
				  vptr->initially_unowned ? "unowned" : "owned");
Ghislain MARY's avatar
Ghislain MARY committed
563
	belle_sip_snprintf(ret,maxbufsize,&pos,"\nInheritance diagram:\n");
564
	for(it=vptr;it!=NULL;it=it->get_parent()){
Simon Morlat's avatar
Simon Morlat committed
565 566 567 568
		l=belle_sip_list_prepend(l,it);
	}
	for(elem=l;elem!=NULL;elem=elem->next){
		it=(belle_sip_object_vptr_t*)elem->data;
Ghislain MARY's avatar
Ghislain MARY committed
569
		belle_sip_snprintf(ret,maxbufsize,&pos,"\t%s\n",it->type_name);
Simon Morlat's avatar
Simon Morlat committed
570
		if (elem->next)
Ghislain MARY's avatar
Ghislain MARY committed
571
			belle_sip_snprintf(ret,maxbufsize,&pos,"\t        |\n");
Simon Morlat's avatar
Simon Morlat committed
572 573
	}
	belle_sip_list_free(l);
Ghislain MARY's avatar
Ghislain MARY committed
574
	belle_sip_snprintf(ret,maxbufsize,&pos,"\nImplemented interfaces:\n");
575
	for(it=vptr;it!=NULL;it=it->get_parent()){
Simon Morlat's avatar
Simon Morlat committed
576 577 578
		belle_sip_interface_desc_t **desc=it->interfaces;
		if (desc!=NULL){
			for(;*desc!=NULL;desc++){
Ghislain MARY's avatar
Ghislain MARY committed
579
				belle_sip_snprintf(ret,maxbufsize,&pos,"\t* %s\n",(*desc)->ifname);
Simon Morlat's avatar
Simon Morlat committed
580 581 582 583 584 585 586 587 588 589 590
			}
		}
	}
	return ret;
}

char *belle_sip_object_describe(void *obj){
	belle_sip_object_t *o=BELLE_SIP_OBJECT(obj);
	return _belle_sip_object_describe_type(o->vptr);
}

Simon Morlat's avatar
Simon Morlat committed
591 592
#if !defined(WIN32)

Simon Morlat's avatar
Simon Morlat committed
593 594 595 596 597 598
#include <dlfcn.h>

char *belle_sip_object_describe_type_from_name(const char *name){
	char *vptr_name;
	void *handle;
	void *symbol;
599
	belle_sip_object_get_vptr_t vptr_getter;
600

Simon Morlat's avatar
Simon Morlat committed
601 602 603 604 605
	handle=dlopen(NULL,RTLD_LAZY);
	if (handle==NULL){
		belle_sip_error("belle_sip_object_describe_type_from_name: dlopen() failed: %s",dlerror());
		return NULL;
	}
606
	vptr_name=belle_sip_strdup_printf("%s_vptr_get",name);
Simon Morlat's avatar
Simon Morlat committed
607 608 609 610 611 612 613
	symbol=dlsym(handle,vptr_name);
	belle_sip_free(vptr_name);
	dlclose(handle);
	if (symbol==NULL){
		belle_sip_error("belle_sip_object_describe_type_from_name: could not find vptr for type %s",name);
		return NULL;
	}
614 615
	vptr_getter=(belle_sip_object_get_vptr_t)symbol;
	return _belle_sip_object_describe_type(vptr_getter());
Simon Morlat's avatar
Simon Morlat committed
616
}
Simon Morlat's avatar
Simon Morlat committed
617 618 619 620 621 622 623 624 625

#else

char *belle_sip_object_describe_type_from_name(const char *name){
	return belle_sip_strdup_printf("Sorry belle_sip_object_describe_type_from_name() is not implemented on this platform.");
}

#endif

626 627 628
struct belle_sip_object_pool{
	belle_sip_object_t base;
	belle_sip_list_t *objects;
629
	unsigned long thread_id;
630 631 632 633
};

static void belle_sip_object_pool_destroy(belle_sip_object_pool_t *pool){
	belle_sip_object_pool_clean(pool);
Simon Morlat's avatar
Simon Morlat committed
634
	_belle_sip_object_pool_remove_from_stack(pool);
635 636 637 638 639 640 641
}

BELLE_SIP_DECLARE_NO_IMPLEMENTED_INTERFACES(belle_sip_object_pool_t);
BELLE_SIP_INSTANCIATE_VPTR(belle_sip_object_pool_t,belle_sip_object_t,belle_sip_object_pool_destroy,NULL,NULL,FALSE);

belle_sip_object_pool_t *belle_sip_object_pool_new(void){
	belle_sip_object_pool_t *pool=belle_sip_object_new(belle_sip_object_pool_t);
642
	pool->thread_id=belle_sip_thread_self_id();
643 644 645 646 647 648 649 650 651 652 653 654 655
	return pool;
}

void belle_sip_object_pool_add(belle_sip_object_pool_t *pool, belle_sip_object_t *obj){
	if (obj->pool!=NULL){
		belle_sip_fatal("It is not possible to add an object to multiple pools.");
	}
	pool->objects=belle_sip_list_prepend(pool->objects,obj);
	obj->pool_iterator=pool->objects;
	obj->pool=pool;
}

void belle_sip_object_pool_remove(belle_sip_object_pool_t *pool, belle_sip_object_t *obj){
656
	unsigned long tid=belle_sip_thread_self_id();
657 658 659 660 661 662 663 664 665 666 667 668 669
	if (obj->pool!=pool){
		belle_sip_fatal("Attempting to remove object from an incorrect pool: obj->pool=%p, pool=%p",obj->pool,pool);
		return;
	}
	if (tid!=pool->thread_id){
		belle_sip_fatal("It is forbidden (and unsafe()) to ref()/unref() an unowned object outside of the thread that created it.");
		return;
	}
	pool->objects=belle_sip_list_delete_link(pool->objects,obj->pool_iterator);
	obj->pool_iterator=NULL;
	obj->pool=NULL;
}

670
int belle_sip_object_pool_cleanable(belle_sip_object_pool_t *pool){
671
	return pool->thread_id!=0 && belle_sip_thread_self_id()==pool->thread_id;
672 673
}

674 675
void belle_sip_object_pool_clean(belle_sip_object_pool_t *pool){
	belle_sip_list_t *elem,*next;
676

677
	if (!belle_sip_object_pool_cleanable(pool)){
678
		belle_sip_warning("Thread pool [%p] cannot be cleaned from thread [%lu] because it was created for thread [%lu]",
679
				 pool,belle_sip_thread_self_id(),(unsigned long)pool->thread_id);
680 681
		return;
	}
682

683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
	for(elem=pool->objects;elem!=NULL;elem=next){
		belle_sip_object_t *obj=(belle_sip_object_t*)elem->data;
		if (obj->ref==0){
			belle_sip_message("Garbage collecting unowned object of type %s",obj->vptr->type_name);
			obj->ref=-1;
			belle_sip_object_delete(obj);
			next=elem->next;
			belle_sip_free(elem);
		}else {
			belle_sip_fatal("Object %p is in unowned list but with ref count %i, bug.",obj,obj->ref);
			next=elem->next;
		}
	}
	pool->objects=NULL;
}

699 700
static void belle_sip_object_pool_detach_from_thread(belle_sip_object_pool_t *pool){
	belle_sip_object_pool_clean(pool);
Simon Morlat's avatar
Simon Morlat committed
701
	pool->thread_id=(unsigned long)0;
702 703
}

704 705
static void cleanup_pool_stack(void *data){
	belle_sip_list_t **pool_stack=(belle_sip_list_t**)data;
706 707 708 709 710 711 712 713
	if (*pool_stack){
		/*
		 * We would expect the pool_stack to be empty when the thread terminates.
		 * Otherwise that means the management of object pool is not properly done by the application.
		 * Since the object pools might be still referenced by the application, we can't destroy them.
		 * Instead, we mark them as detached, so that when the thread that will attempt to destroy them will do it,
		 * we'll accept (since anyway these object pool are no longer needed.
		 */
714
		belle_sip_warning("There were still [%i] object pools for thread [%lu] while the thread exited. ",
715
				 belle_sip_list_size(*pool_stack),belle_sip_thread_self_id());
716 717
		belle_sip_list_free_with_data(*pool_stack,(void (*)(void*)) belle_sip_object_pool_detach_from_thread);
	}
718 719 720 721
	*pool_stack=NULL;
	belle_sip_free(pool_stack);
}

722
static belle_sip_list_t** get_current_pool_stack(int *first_time){
723 724 725
	static belle_sip_thread_key_t pools_key;
	static int pools_key_created=0;
	belle_sip_list_t **pool_stack;
726

727
	if (first_time) *first_time=0;
728

729 730 731 732 733 734 735 736 737 738 739
	if (!pools_key_created){
		pools_key_created=1;
		if (belle_sip_thread_key_create(&pools_key, cleanup_pool_stack)!=0){
			return NULL;
		}
	}
	pool_stack=(belle_sip_list_t**)belle_sip_thread_getspecific(pools_key);
	if (pool_stack==NULL){
		pool_stack=belle_sip_new(belle_sip_list_t*);
		*pool_stack=NULL;
		belle_sip_thread_setspecific(pools_key,pool_stack);
740
		if (first_time) *first_time=1;
741 742 743 744
	}
	return pool_stack;
}

Simon Morlat's avatar
Simon Morlat committed
745 746
static void _belle_sip_object_pool_remove_from_stack(belle_sip_object_pool_t *pool){
	belle_sip_list_t **pools=get_current_pool_stack(NULL);
747
	unsigned long tid=belle_sip_thread_self_id();
748

Simon Morlat's avatar
Simon Morlat committed
749
	if (tid!=pool->thread_id){
750
		belle_sip_fatal("It is forbidden to destroy a pool outside the thread that created it.");
Simon Morlat's avatar
Simon Morlat committed
751 752
		return;
	}
753

Simon Morlat's avatar
Simon Morlat committed
754 755 756 757 758 759 760 761 762 763 764
	if (pools==NULL) {
		belle_sip_fatal("Not possible to pop a pool.");
		return;
	}
	if (*pools==NULL){
		belle_sip_fatal("There is no current pool in stack.");
		return;
	}
	*pools=belle_sip_list_remove(*pools,pool);
}

765
belle_sip_object_pool_t * belle_sip_object_pool_push(void){
766
	belle_sip_list_t **pools=get_current_pool_stack(NULL);
767 768 769 770 771 772 773 774 775 776
	belle_sip_object_pool_t *pool;
	if (pools==NULL) {
		belle_sip_error("Not possible to create a pool.");
		return NULL;
	}
	pool=belle_sip_object_pool_new();
	*pools=belle_sip_list_prepend(*pools,pool);
	return pool;
}

Simon Morlat's avatar
Simon Morlat committed
777

778 779

belle_sip_object_pool_t *belle_sip_object_pool_get_current(void){
780 781
	int first_time;
	belle_sip_list_t **pools=get_current_pool_stack(&first_time);
782
	if (pools==NULL) return NULL;
783 784
	if (*pools==NULL ){
		if (first_time) {
785
			belle_sip_warning("There is no object pool created in thread [%lu]. "
786
			"Use belle_sip_object_pool_push() to create one. Unowned objects not unref'd will be leaked.",
787
			belle_sip_thread_self_id());
788
		}
789 790 791 792 793 794
		return NULL;
	}
	return (belle_sip_object_pool_t*)(*pools)->data;
}