1 /*****************************************************************************
2 * objects.c: vlc_object_t handling
3 *****************************************************************************
4 * Copyright (C) 2004-2008 the VideoLAN team
6 * Authors: Samuel Hocevar <sam@zoy.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 *****************************************************************************/
25 * This file contains the functions to handle the vlc_object_t type
29 /*****************************************************************************
31 *****************************************************************************/
36 #include <vlc_common.h>
38 #include "../libvlc.h"
41 #include "audio_output/aout_internal.h"
43 #include <vlc_access.h>
44 #include <vlc_demux.h>
45 #include <vlc_stream.h>
48 #include "stream_output/stream_output.h"
50 #include "vlc_interface.h"
51 #include "vlc_codec.h"
52 #include "vlc_filter.h"
54 #include "variables.h"
60 # include <errno.h> /* ENOSYS */
64 /*****************************************************************************
66 *****************************************************************************/
67 static int DumpCommand( vlc_object_t *, char const *,
68 vlc_value_t, vlc_value_t, void * );
70 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
71 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
72 static void PrintObject ( vlc_object_t *, const char * );
73 static void DumpStructure ( vlc_object_t *, int, char * );
75 static vlc_list_t * NewList ( int );
76 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
77 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
78 static int CountChildren ( vlc_object_t *, int );
79 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
81 static void vlc_object_destroy( vlc_object_t *p_this );
82 static void vlc_object_detach_unlocked (vlc_object_t *p_this);
84 #ifdef LIBVLC_REFCHECK
85 static vlc_threadvar_t held_objects;
86 typedef struct held_list_t
88 struct held_list_t *next;
91 static void held_objects_destroy (void *);
94 /*****************************************************************************
95 * Local structure lock
96 *****************************************************************************/
97 static vlc_mutex_t structure_lock;
99 void *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
100 int i_type, const char *psz_type )
103 vlc_object_internals_t *p_priv;
106 * VLC objects are laid out as follow:
107 * - first the LibVLC-private per-object data,
108 * - then VLC_COMMON members from vlc_object_t,
109 * - finally, the type-specific data (if any).
111 * This function initializes the LibVLC and common data,
112 * and zeroes the rest.
114 p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
118 assert (i_size >= sizeof (vlc_object_t));
119 p_new = (vlc_object_t *)(p_priv + 1);
121 p_new->i_object_type = i_type;
122 p_new->psz_object_type = psz_type;
123 p_new->psz_object_name = NULL;
125 p_new->b_die = false;
126 p_new->b_error = false;
127 p_new->b_dead = false;
128 p_new->b_force = false;
130 p_new->psz_header = NULL;
133 p_new->i_flags = p_this->i_flags
134 & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
136 p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
138 if( !p_priv->p_vars )
144 libvlc_global_data_t *p_libvlc_global;
147 /* Only the global root object is created out of the blue */
148 p_libvlc_global = (libvlc_global_data_t *)p_new;
149 p_new->p_libvlc = NULL;
151 p_libvlc_global->i_counter = 0;
152 p_priv->next = p_priv->prev = p_new;
153 vlc_mutex_init( &structure_lock );
154 #ifdef LIBVLC_REFCHECK
155 /* TODO: use the destruction callback to track ref leaks */
156 vlc_threadvar_create( &held_objects, held_objects_destroy );
161 p_libvlc_global = vlc_global();
162 if( i_type == VLC_OBJECT_LIBVLC )
163 p_new->p_libvlc = (libvlc_int_t*)p_new;
165 p_new->p_libvlc = p_this->p_libvlc;
168 vlc_spin_init( &p_priv->ref_spin );
169 p_priv->i_refcount = 1;
170 p_priv->pf_destructor = NULL;
171 p_priv->b_thread = false;
172 p_new->p_parent = NULL;
173 p_priv->pp_children = NULL;
174 p_priv->i_children = 0;
176 p_new->p_private = NULL;
178 /* Initialize mutexes and condvars */
179 vlc_mutex_init( &p_priv->lock );
180 vlc_cond_init( p_new, &p_priv->wait );
181 vlc_mutex_init( &p_priv->var_lock );
182 vlc_spin_init( &p_priv->spin );
183 p_priv->pipes[0] = p_priv->pipes[1] = -1;
185 p_priv->next = VLC_OBJECT (p_libvlc_global);
186 #if !defined (LIBVLC_REFCHECK)
188 #elif defined (LIBVLC_USE_PTHREAD)
189 p_priv->creator_id = pthread_self ();
190 #elif defined (WIN32)
191 p_priv->creator_id = GetCurrentThreadId ();
193 vlc_mutex_lock( &structure_lock );
194 p_priv->prev = vlc_internals (p_libvlc_global)->prev;
195 vlc_internals (p_libvlc_global)->prev = p_new;
196 vlc_internals (p_priv->prev)->next = p_new;
197 p_new->i_object_id = p_libvlc_global->i_counter++;
198 vlc_mutex_unlock( &structure_lock );
200 if( i_type == VLC_OBJECT_LIBVLC )
202 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
203 var_AddCallback( p_new, "list", DumpCommand, NULL );
204 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
205 var_AddCallback( p_new, "tree", DumpCommand, NULL );
206 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
207 var_AddCallback( p_new, "vars", DumpCommand, NULL );
215 * Allocates and initializes a vlc object.
217 * @param i_type known object type (all of them are negative integer values),
218 * or object byte size (always positive).
220 * @return the new object, or NULL on error.
222 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
224 const char * psz_type;
229 case VLC_OBJECT_INTF:
230 i_size = sizeof(intf_thread_t);
231 psz_type = "interface";
233 case VLC_OBJECT_DIALOGS:
234 i_size = sizeof(intf_thread_t);
235 psz_type = "dialogs";
237 case VLC_OBJECT_DECODER:
238 i_size = sizeof(decoder_t);
239 psz_type = "decoder";
241 case VLC_OBJECT_PACKETIZER:
242 i_size = sizeof(decoder_t);
243 psz_type = "packetizer";
245 case VLC_OBJECT_ENCODER:
246 i_size = sizeof(encoder_t);
247 psz_type = "encoder";
249 case VLC_OBJECT_FILTER:
250 i_size = sizeof(filter_t);
253 case VLC_OBJECT_AOUT:
254 i_size = sizeof(aout_instance_t);
255 psz_type = "audio output";
257 case VLC_OBJECT_OPENGL:
258 i_size = sizeof( vout_thread_t );
261 case VLC_OBJECT_ANNOUNCE:
262 i_size = sizeof( announce_handler_t );
263 psz_type = "announce";
266 i_size = i_type > (int)sizeof(vlc_object_t)
267 ? i_type : (int)sizeof(vlc_object_t);
268 i_type = VLC_OBJECT_GENERIC;
269 psz_type = "generic";
273 return vlc_custom_create( p_this, i_size, i_type, psz_type );
278 ****************************************************************************
279 * Set the destructor of a vlc object
281 * This function sets the destructor of the vlc object. It will be called
282 * when the object is destroyed when the its refcount reaches 0.
283 * (It is called by the internal function vlc_object_destroy())
284 *****************************************************************************/
285 void __vlc_object_set_destructor( vlc_object_t *p_this,
286 vlc_destructor_t pf_destructor )
288 vlc_object_internals_t *p_priv = vlc_internals(p_this );
289 p_priv->pf_destructor = pf_destructor;
293 ****************************************************************************
294 * Destroy a vlc object (Internal)
296 * This function destroys an object that has been previously allocated with
297 * vlc_object_create. The object's refcount must be zero and it must not be
298 * attached to other objects in any way.
299 *****************************************************************************/
300 static void vlc_object_destroy( vlc_object_t *p_this )
302 vlc_object_internals_t *p_priv = vlc_internals( p_this );
304 /* Objects are always detached beforehand */
305 assert( !p_this->p_parent );
307 /* Send a kill to the object's thread if applicable */
308 vlc_object_kill( p_this );
310 /* If we are running on a thread, wait until it ends */
311 if( p_priv->b_thread )
312 vlc_thread_join( p_this );
314 /* Call the custom "subclass" destructor */
315 if( p_priv->pf_destructor )
316 p_priv->pf_destructor( p_this );
318 /* Destroy the associated variables, starting from the end so that
319 * no memmove calls have to be done. */
320 while( p_priv->i_vars )
322 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
325 free( p_priv->p_vars );
326 vlc_mutex_destroy( &p_priv->var_lock );
328 free( p_this->psz_header );
330 if( p_this->p_libvlc == NULL )
332 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
335 assert( p_global == vlc_global() );
337 if (p_priv->next != p_this)
339 vlc_object_t *leaked = p_priv->next, *first = leaked;
342 /* We are leaking this object */
344 "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
345 leaked->i_object_id, leaked->psz_object_type,
346 leaked->psz_object_name );
347 /* Dump libvlc object to ease debugging */
348 vlc_object_dump( leaked );
350 leaked = vlc_internals (leaked)->next;
352 while (leaked != first);
354 /* Dump global object to ease debugging */
355 vlc_object_dump( p_this );
356 /* Strongly abort, cause we want these to be fixed */
361 /* We are the global object ... no need to lock. */
362 vlc_mutex_destroy( &structure_lock );
363 #ifdef LIBVLC_REFCHECK
364 held_objects_destroy( vlc_threadvar_get( &held_objects ) );
365 vlc_threadvar_delete( &held_objects );
369 FREENULL( p_this->psz_object_name );
371 #if defined(WIN32) || defined(UNDER_CE)
372 /* if object has an associated thread, close it now */
373 if( p_priv->thread_id )
374 CloseHandle(p_priv->thread_id);
377 vlc_spin_destroy( &p_priv->ref_spin );
378 vlc_mutex_destroy( &p_priv->lock );
379 vlc_cond_destroy( &p_priv->wait );
380 vlc_spin_destroy( &p_priv->spin );
381 if( p_priv->pipes[1] != -1 )
382 close( p_priv->pipes[1] );
383 if( p_priv->pipes[0] != -1 )
384 close( p_priv->pipes[0] );
390 /** Inter-object signaling */
392 void __vlc_object_lock( vlc_object_t *obj )
394 vlc_mutex_lock( &(vlc_internals(obj)->lock) );
397 void __vlc_object_unlock( vlc_object_t *obj )
399 vlc_assert_locked( &(vlc_internals(obj)->lock) );
400 vlc_mutex_unlock( &(vlc_internals(obj)->lock) );
404 # include <winsock2.h>
405 # include <ws2tcpip.h>
408 * select()-able pipes emulated using Winsock
410 static int pipe (int fd[2])
413 int addrlen = sizeof (addr);
415 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
416 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
417 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
420 memset (&addr, 0, sizeof (addr));
421 addr.sin_family = AF_INET;
422 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
423 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
424 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
426 || connect (c, (PSOCKADDR)&addr, addrlen))
429 a = accept (l, NULL, NULL);
430 if (a == INVALID_SOCKET)
441 if (l != INVALID_SOCKET)
443 if (c != INVALID_SOCKET)
449 #define read( a, b, c ) recv (a, b, c, 0)
451 #define write( a, b, c ) send (a, b, c, 0)
453 #define close( a ) closesocket (a)
457 * Returns the readable end of a pipe that becomes readable once termination
458 * of the object is requested (vlc_object_kill()).
459 * This can be used to wake-up out of a select() or poll() event loop, such
460 * typically when doing network I/O.
462 * Note that the pipe will remain the same for the lifetime of the object.
463 * DO NOT read the pipe nor close it yourself. Ever.
465 * @param obj object that would be "killed"
466 * @return a readable pipe descriptor, or -1 on error.
468 int __vlc_object_waitpipe( vlc_object_t *obj )
470 int pfd[2] = { -1, -1 };
471 vlc_object_internals_t *internals = vlc_internals( obj );
474 vlc_spin_lock (&internals->spin);
475 if (internals->pipes[0] == -1)
477 /* This can only ever happen if someone killed us without locking: */
478 assert (internals->pipes[1] == -1);
479 vlc_spin_unlock (&internals->spin);
484 vlc_spin_lock (&internals->spin);
485 if (internals->pipes[0] == -1)
487 internals->pipes[0] = pfd[0];
488 internals->pipes[1] = pfd[1];
489 pfd[0] = pfd[1] = -1;
493 vlc_spin_unlock (&internals->spin);
497 /* Race condition: vlc_object_kill() already invoked! */
500 vlc_spin_lock (&internals->spin);
501 fd = internals->pipes[1];
502 internals->pipes[1] = -1;
503 vlc_spin_unlock (&internals->spin);
505 msg_Dbg (obj, "waitpipe: object already dying");
510 /* Race condition: two threads call pipe() - unlikely */
516 return internals->pipes[0];
521 * Waits for the object to be signaled (using vlc_object_signal()).
522 * It is assumed that the caller has locked the object. This function will
523 * unlock the object, and lock it again before returning.
524 * If the object was signaled before the caller locked the object, it is
525 * undefined whether the signal will be lost or will wake the process.
527 * @return true if the object is dying and should terminate.
529 void __vlc_object_wait( vlc_object_t *obj )
531 vlc_object_internals_t *priv = vlc_internals( obj );
532 vlc_assert_locked( &priv->lock);
533 vlc_cond_wait( &priv->wait, &priv->lock );
538 * Waits for the object to be signaled (using vlc_object_signal()), or for
539 * a timer to expire. It is asserted that the caller holds the object lock.
541 * @return 0 if the object was signaled before the timer expiration, or
542 * ETIMEDOUT if the timer expired without any signal.
544 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
546 vlc_object_internals_t *priv = vlc_internals( obj );
547 vlc_assert_locked( &priv->lock);
548 return vlc_cond_timedwait( &priv->wait, &priv->lock, deadline );
553 * Checks whether an object has been "killed".
554 * The object lock must be held.
556 * Typical code for an object thread could be:
558 vlc_object_lock (self);
560 while (vlc_object_alive (self))
564 vlc_object_wait (self);
568 ...deinitialization...
569 vlc_object_unlock (self);
572 * @return true iff the object has not been killed yet
574 bool __vlc_object_alive( vlc_object_t *obj )
576 vlc_assert_locked( &(vlc_internals(obj)->lock) );
582 * Signals an object for which the lock is held.
583 * At least one thread currently sleeping in vlc_object_wait() or
584 * vlc_object_timedwait() will wake up, assuming that there is at least one
585 * such thread in the first place. Otherwise, it is undefined whether the
586 * signal will be lost or will wake up one or more thread later.
588 void __vlc_object_signal_unlocked( vlc_object_t *obj )
590 vlc_assert_locked (&(vlc_internals(obj)->lock));
591 vlc_cond_signal( &(vlc_internals(obj)->wait) );
596 * Requests termination of an object.
597 * If the object is LibVLC, also request to terminate all its children.
599 void __vlc_object_kill( vlc_object_t *p_this )
601 vlc_object_internals_t *priv = vlc_internals( p_this );
604 vlc_object_lock( p_this );
605 p_this->b_die = true;
607 vlc_spin_lock (&priv->spin);
610 vlc_spin_unlock (&priv->spin);
614 msg_Dbg (p_this, "waitpipe: object killed");
618 vlc_object_signal_unlocked( p_this );
619 vlc_object_unlock( p_this );
624 * Find an object given its ID.
626 * This function looks for the object whose i_object_id field is i_id.
627 * This function is slow, and often used to hide bugs. Do not use it.
628 * If you need to retain reference to an object, yield the object pointer with
629 * vlc_object_yield(), use the pointer as your reference, and call
630 * vlc_object_release() when you're done.
632 void * vlc_object_get( int i_id )
634 libvlc_global_data_t *p_libvlc_global = vlc_global();
635 vlc_object_t *obj = NULL;
637 vlc_object_t *caller = vlc_threadobj ();
640 msg_Dbg (caller, "uses deprecated vlc_object_get(%d)", i_id);
642 fprintf (stderr, "main thread uses deprecated vlc_object_get(%d)\n",
645 vlc_mutex_lock( &structure_lock );
647 for( obj = vlc_internals (p_libvlc_global)->next;
648 obj != VLC_OBJECT (p_libvlc_global);
649 obj = vlc_internals (obj)->next )
651 if( obj->i_object_id == i_id )
653 vlc_object_yield( obj );
660 msg_Warn (caller, "wants non-existing object %d", i_id);
662 fprintf (stderr, "main thread wants non-existing object %d\n", i_id);
665 vlc_mutex_unlock( &structure_lock );
670 ****************************************************************************
671 * find a typed object and increment its refcount
672 *****************************************************************************
673 * This function recursively looks for a given object type. i_mode can be one
674 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
675 *****************************************************************************/
676 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
678 vlc_object_t *p_found;
680 /* If we are of the requested type ourselves, don't look further */
681 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
683 vlc_object_yield( p_this );
687 /* Otherwise, recursively look for the object */
688 if ((i_mode & 0x000f) == FIND_ANYWHERE)
691 if (i_type == VLC_OBJECT_PLAYLIST)
692 msg_Err (p_this, "using vlc_object_find(VLC_OBJECT_PLAYLIST) "
693 "instead of pl_Yield()");
695 return vlc_object_find (p_this->p_libvlc, i_type,
696 (i_mode & ~0x000f)|FIND_CHILD);
699 vlc_mutex_lock( &structure_lock );
700 p_found = FindObject( p_this, i_type, i_mode );
701 vlc_mutex_unlock( &structure_lock );
706 ****************************************************************************
707 * find a named object and increment its refcount
708 *****************************************************************************
709 * This function recursively looks for a given object name. i_mode can be one
710 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
711 *****************************************************************************/
712 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
715 vlc_object_t *p_found;
717 /* If have the requested name ourselves, don't look further */
718 if( !(i_mode & FIND_STRICT)
719 && p_this->psz_object_name
720 && !strcmp( p_this->psz_object_name, psz_name ) )
722 vlc_object_yield( p_this );
726 vlc_mutex_lock( &structure_lock );
728 /* Otherwise, recursively look for the object */
729 if( (i_mode & 0x000f) == FIND_ANYWHERE )
731 vlc_object_t *p_root = p_this;
734 while( p_root->p_parent != NULL &&
735 p_root != VLC_OBJECT( p_this->p_libvlc ) )
737 p_root = p_root->p_parent;
740 p_found = FindObjectName( p_root, psz_name,
741 (i_mode & ~0x000f)|FIND_CHILD );
742 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
744 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
745 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
750 p_found = FindObjectName( p_this, psz_name, i_mode );
753 vlc_mutex_unlock( &structure_lock );
759 * Increment an object reference counter.
761 void __vlc_object_yield( vlc_object_t *p_this )
763 vlc_object_internals_t *internals = vlc_internals( p_this );
765 vlc_spin_lock( &internals->ref_spin );
766 /* Avoid obvious freed object uses */
767 assert( internals->i_refcount > 0 );
768 /* Increment the counter */
769 internals->i_refcount++;
770 vlc_spin_unlock( &internals->ref_spin );
771 #ifdef LIBVLC_REFCHECK
772 /* Update the list of referenced objects */
773 /* Using TLS, so no need to lock */
774 /* The following line may leak memory if a thread leaks objects. */
775 held_list_t *newhead = malloc (sizeof (*newhead));
776 held_list_t *oldhead = vlc_threadvar_get (&held_objects);
777 newhead->next = oldhead;
778 newhead->obj = p_this;
779 vlc_threadvar_set (&held_objects, newhead);
783 /*****************************************************************************
784 * decrement an object refcount
785 * And destroy the object if its refcount reach zero.
786 *****************************************************************************/
787 void __vlc_object_release( vlc_object_t *p_this )
789 vlc_object_internals_t *internals = vlc_internals( p_this );
790 bool b_should_destroy;
792 #ifdef LIBVLC_REFCHECK
793 /* Update the list of referenced objects */
794 /* Using TLS, so no need to lock */
795 for (held_list_t *hlcur = vlc_threadvar_get (&held_objects),
798 hlprev = hlcur, hlcur = hlcur->next)
800 if (hlcur->obj == p_this)
803 vlc_threadvar_set (&held_objects, hlcur->next);
805 hlprev->next = hlcur->next;
810 /* TODO: what if releasing without references? */
813 vlc_spin_lock( &internals->ref_spin );
814 assert( internals->i_refcount > 0 );
816 if( internals->i_refcount > 1 )
819 /* There are still other references to the object */
820 internals->i_refcount--;
821 vlc_spin_unlock( &internals->ref_spin );
824 vlc_spin_unlock( &internals->ref_spin );
827 /* Remember that we cannot hold the spin while waiting on the mutex */
828 vlc_mutex_lock( &structure_lock );
829 /* Take the spin again. Note that another thread may have yielded the
830 * object in the (very short) mean time. */
831 vlc_spin_lock( &internals->ref_spin );
832 b_should_destroy = --internals->i_refcount == 0;
833 vlc_spin_unlock( &internals->ref_spin );
835 if( b_should_destroy )
837 /* Remove the object from object list
838 * so that it cannot be encountered by vlc_object_get() */
839 vlc_internals (internals->next)->prev = internals->prev;
840 vlc_internals (internals->prev)->next = internals->next;
842 /* Detach from parent to protect against FIND_CHILDREN */
843 vlc_object_detach_unlocked (p_this);
844 /* Detach from children to protect against FIND_PARENT */
845 for (int i = 0; i < internals->i_children; i++)
846 internals->pp_children[i]->p_parent = NULL;
849 vlc_mutex_unlock( &structure_lock );
851 if( b_should_destroy )
853 free( internals->pp_children );
854 internals->pp_children = NULL;
855 internals->i_children = 0;
856 vlc_object_destroy( p_this );
861 ****************************************************************************
862 * attach object to a parent object
863 *****************************************************************************
864 * This function sets p_this as a child of p_parent, and p_parent as a parent
865 * of p_this. This link can be undone using vlc_object_detach.
866 *****************************************************************************/
867 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
869 if( !p_this ) return;
871 vlc_mutex_lock( &structure_lock );
873 /* Attach the parent to its child */
874 assert (!p_this->p_parent);
875 p_this->p_parent = p_parent;
877 /* Attach the child to its parent */
878 vlc_object_internals_t *priv = vlc_internals( p_parent );
879 INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
882 vlc_mutex_unlock( &structure_lock );
886 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
888 vlc_assert_locked (&structure_lock);
890 if (p_this->p_parent == NULL)
893 vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
897 /* Remove p_this's parent */
898 p_this->p_parent = NULL;
900 /* Remove all of p_parent's children which are p_this */
901 for( i_index = priv->i_children ; i_index-- ; )
903 if( priv->pp_children[i_index] == p_this )
906 for( i = i_index ; i < priv->i_children ; i++ )
907 priv->pp_children[i] = priv->pp_children[i+1];
911 if( priv->i_children )
913 priv->pp_children = (vlc_object_t **)realloc( priv->pp_children,
914 priv->i_children * sizeof(vlc_object_t *) );
918 /* Special case - don't realloc() to zero to avoid leaking */
919 free( priv->pp_children );
920 priv->pp_children = NULL;
926 ****************************************************************************
927 * detach object from its parent
928 *****************************************************************************
929 * This function removes all links between an object and its parent.
930 *****************************************************************************/
931 void __vlc_object_detach( vlc_object_t *p_this )
933 if( !p_this ) return;
935 vlc_mutex_lock( &structure_lock );
936 if( !p_this->p_parent )
937 msg_Err( p_this, "object is not attached" );
939 vlc_object_detach_unlocked( p_this );
940 vlc_mutex_unlock( &structure_lock );
945 ****************************************************************************
946 * find a list typed objects and increment their refcount
947 *****************************************************************************
948 * This function recursively looks for a given object type. i_mode can be one
949 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
950 *****************************************************************************/
951 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
956 /* Look for the objects */
957 switch( i_mode & 0x000f )
960 /* Modules should probably not be object, and the module should perhaps
961 * not be shared across LibVLC instances. In the mean time, this ugly
962 * hack is brought to you by Courmisch. */
963 if (i_type == VLC_OBJECT_MODULE)
964 return vlc_list_find ((vlc_object_t *)vlc_global ()->p_module_bank,
966 return vlc_list_find (p_this->p_libvlc, i_type, FIND_CHILD);
969 vlc_mutex_lock( &structure_lock );
970 i_count = CountChildren( p_this, i_type );
971 p_list = NewList( i_count );
973 /* Check allocation was successful */
974 if( p_list->i_count != i_count )
976 vlc_mutex_unlock( &structure_lock );
977 msg_Err( p_this, "list allocation failed!" );
983 ListChildren( p_list, p_this, i_type );
984 vlc_mutex_unlock( &structure_lock );
988 msg_Err( p_this, "unimplemented!" );
989 p_list = NewList( 0 );
997 * Gets the list of children of an objects, and increment their reference
999 * @return a list (possibly empty) or NULL in case of error.
1001 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
1004 vlc_object_internals_t *priv = vlc_internals( obj );
1006 vlc_mutex_lock( &structure_lock );
1007 l = NewList( priv->i_children );
1008 for (int i = 0; i < l->i_count; i++)
1010 vlc_object_yield( priv->pp_children[i] );
1011 l->p_values[i].p_object = priv->pp_children[i];
1013 vlc_mutex_unlock( &structure_lock );
1017 /*****************************************************************************
1018 * DumpCommand: print the current vlc structure
1019 *****************************************************************************
1020 * This function prints either an ASCII tree showing the connections between
1021 * vlc objects, and additional information such as their refcount, thread ID,
1022 * etc. (command "tree"), or the same data as a simple list (command "list").
1023 *****************************************************************************/
1024 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
1025 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1027 (void)oldval; (void)p_data;
1028 if( *psz_cmd == 'l' )
1030 vlc_object_t *root = VLC_OBJECT (vlc_global ()), *cur = root;
1032 vlc_mutex_lock( &structure_lock );
1035 PrintObject (cur, "");
1036 cur = vlc_internals (cur)->next;
1038 while (cur != root);
1039 vlc_mutex_unlock( &structure_lock );
1043 vlc_object_t *p_object = NULL;
1045 if( *newval.psz_string )
1048 int i_id = strtol( newval.psz_string, &end, 0 );
1049 if( end != newval.psz_string )
1050 p_object = vlc_object_get( i_id );
1052 /* try using the object's name to find it */
1053 p_object = vlc_object_find_name( p_this, newval.psz_string,
1062 vlc_mutex_lock( &structure_lock );
1064 if( *psz_cmd == 't' )
1066 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1069 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1072 DumpStructure( p_object, 0, psz_foo );
1074 else if( *psz_cmd == 'v' )
1079 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1081 PrintObject( p_object, "" );
1083 if( !vlc_internals( p_object )->i_vars )
1084 printf( " `-o No variables\n" );
1085 for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
1087 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
1089 const char *psz_type = "unknown";
1090 switch( p_var->i_type & VLC_VAR_TYPE )
1092 #define MYCASE( type, nice ) \
1093 case VLC_VAR_ ## type: \
1096 MYCASE( VOID, "void" );
1097 MYCASE( BOOL, "bool" );
1098 MYCASE( INTEGER, "integer" );
1099 MYCASE( HOTKEY, "hotkey" );
1100 MYCASE( STRING, "string" );
1101 MYCASE( MODULE, "module" );
1102 MYCASE( FILE, "file" );
1103 MYCASE( DIRECTORY, "directory" );
1104 MYCASE( VARIABLE, "variable" );
1105 MYCASE( FLOAT, "float" );
1106 MYCASE( TIME, "time" );
1107 MYCASE( ADDRESS, "address" );
1108 MYCASE( MUTEX, "mutex" );
1109 MYCASE( LIST, "list" );
1112 printf( " %c-o \"%s\" (%s",
1113 i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
1114 p_var->psz_name, psz_type );
1115 if( p_var->psz_text )
1116 printf( ", %s", p_var->psz_text );
1118 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1119 printf( ", command" );
1120 if( p_var->i_entries )
1121 printf( ", %d callbacks", p_var->i_entries );
1122 switch( p_var->i_type & 0x00f0 )
1128 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1130 case VLC_VAR_INTEGER:
1131 printf( ": %d", p_var->val.i_int );
1133 case VLC_VAR_STRING:
1134 printf( ": \"%s\"", p_var->val.psz_string );
1137 printf( ": %f", p_var->val.f_float );
1140 printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
1142 case VLC_VAR_ADDRESS:
1143 printf( ": %p", p_var->val.p_address );
1153 vlc_mutex_unlock( &structure_lock );
1155 if( *newval.psz_string )
1157 vlc_object_release( p_object );
1164 /*****************************************************************************
1165 * vlc_list_release: free a list previously allocated by vlc_list_find
1166 *****************************************************************************
1167 * This function decreases the refcount of all objects in the list and
1169 *****************************************************************************/
1170 void vlc_list_release( vlc_list_t *p_list )
1174 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1176 vlc_object_release( p_list->p_values[i_index].p_object );
1179 free( p_list->p_values );
1183 /*****************************************************************************
1184 * dump an object. (Debug function)
1185 *****************************************************************************/
1186 void __vlc_object_dump( vlc_object_t *p_this )
1188 vlc_mutex_lock( &structure_lock );
1189 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1191 DumpStructure( p_this, 0, psz_foo );
1192 vlc_mutex_unlock( &structure_lock );
1195 /* Following functions are local */
1197 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1200 vlc_object_t *p_tmp;
1202 switch( i_mode & 0x000f )
1205 p_tmp = p_this->p_parent;
1208 if( p_tmp->i_object_type == i_type )
1210 vlc_object_yield( p_tmp );
1215 return FindObject( p_tmp, i_type, i_mode );
1221 for( i = vlc_internals( p_this )->i_children; i--; )
1223 p_tmp = vlc_internals( p_this )->pp_children[i];
1224 if( p_tmp->i_object_type == i_type )
1226 vlc_object_yield( p_tmp );
1229 else if( vlc_internals( p_tmp )->i_children )
1231 p_tmp = FindObject( p_tmp, i_type, i_mode );
1241 /* Handled in vlc_object_find */
1248 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1249 const char *psz_name,
1253 vlc_object_t *p_tmp;
1255 switch( i_mode & 0x000f )
1258 p_tmp = p_this->p_parent;
1261 if( p_tmp->psz_object_name
1262 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1264 vlc_object_yield( p_tmp );
1269 return FindObjectName( p_tmp, psz_name, i_mode );
1275 for( i = vlc_internals( p_this )->i_children; i--; )
1277 p_tmp = vlc_internals( p_this )->pp_children[i];
1278 if( p_tmp->psz_object_name
1279 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1281 vlc_object_yield( p_tmp );
1284 else if( vlc_internals( p_tmp )->i_children )
1286 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1296 /* Handled in vlc_object_find */
1304 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1306 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1309 memset( &psz_name, 0, sizeof(psz_name) );
1310 if( p_this->psz_object_name )
1312 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1314 psz_name[48] = '\"';
1317 psz_children[0] = '\0';
1318 switch( vlc_internals( p_this )->i_children )
1323 strcpy( psz_children, ", 1 child" );
1326 snprintf( psz_children, 19, ", %i children",
1327 vlc_internals( p_this )->i_children );
1331 psz_refcount[0] = '\0';
1332 if( vlc_internals( p_this )->i_refcount > 0 )
1333 snprintf( psz_refcount, 19, ", refcount %u",
1334 vlc_internals( p_this )->i_refcount );
1336 psz_thread[0] = '\0';
1337 if( vlc_internals( p_this )->b_thread )
1338 snprintf( psz_thread, 29, " (thread %lu)",
1339 (unsigned long)vlc_internals( p_this )->thread_id );
1341 psz_parent[0] = '\0';
1342 if( p_this->p_parent )
1343 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1345 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1346 p_this->i_object_id, p_this->psz_object_type,
1347 psz_name, psz_thread, psz_refcount, psz_children,
1351 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1354 char i_back = psz_foo[i_level];
1355 psz_foo[i_level] = '\0';
1357 PrintObject( p_this, psz_foo );
1359 psz_foo[i_level] = i_back;
1361 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1363 msg_Warn( p_this, "structure tree is too deep" );
1367 for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
1371 psz_foo[i_level-1] = ' ';
1373 if( psz_foo[i_level-2] == '`' )
1375 psz_foo[i_level-2] = ' ';
1379 if( i == vlc_internals( p_this )->i_children - 1 )
1381 psz_foo[i_level] = '`';
1385 psz_foo[i_level] = '|';
1388 psz_foo[i_level+1] = '-';
1389 psz_foo[i_level+2] = '\0';
1391 DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
1396 static vlc_list_t * NewList( int i_count )
1398 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1399 if( p_list == NULL )
1404 p_list->i_count = i_count;
1408 p_list->p_values = NULL;
1412 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1413 if( p_list->p_values == NULL )
1415 p_list->i_count = 0;
1422 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1425 if( p_list == NULL || i_index >= p_list->i_count )
1430 vlc_object_yield( p_object );
1432 p_list->p_values[i_index].p_object = p_object;
1437 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1439 if( p_list == NULL )
1444 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1445 * sizeof( vlc_value_t ) );
1446 if( p_list->p_values == NULL )
1448 p_list->i_count = 0;
1452 vlc_object_yield( p_object );
1454 p_list->p_values[p_list->i_count].p_object = p_object;
1460 static int CountChildren( vlc_object_t *p_this, int i_type )
1462 vlc_object_t *p_tmp;
1465 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1467 p_tmp = vlc_internals( p_this )->pp_children[i];
1469 if( p_tmp->i_object_type == i_type )
1473 i_count += CountChildren( p_tmp, i_type );
1479 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1481 vlc_object_t *p_tmp;
1484 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1486 p_tmp = vlc_internals( p_this )->pp_children[i];
1488 if( p_tmp->i_object_type == i_type )
1489 ListReplace( p_list, p_tmp, p_list->i_count++ );
1491 ListChildren( p_list, p_tmp, i_type );
1495 #ifdef LIBVLC_REFCHECK
1496 # if defined(HAVE_EXECINFO_H) && defined(HAVE_BACKTRACE)
1497 # include <execinfo.h>
1500 void vlc_refcheck (vlc_object_t *obj)
1502 static unsigned errors = 0;
1506 /* Anyone can use the root object (though it should not exist) */
1507 if (obj == VLC_OBJECT (vlc_global ()))
1510 /* Anyone can use its libvlc instance object */
1511 if (obj == VLC_OBJECT (obj->p_libvlc))
1514 /* The thread that created the object holds the initial reference */
1515 vlc_object_internals_t *priv = vlc_internals (obj);
1516 #if defined (LIBVLC_USE_PTHREAD)
1517 if (pthread_equal (priv->creator_id, pthread_self ()))
1519 if (priv->creator_id == GetCurrentThreadId ())
1525 /* A thread can use its own object without references! */
1526 vlc_object_t *caller = vlc_threadobj ();
1530 /* The calling thread is younger than the object.
1531 * Access could be valid through cross-thread synchronization;
1532 * we would need better accounting. */
1533 if (caller && (caller->i_object_id > obj->i_object_id))
1537 vlc_spin_lock (&priv->ref_spin);
1538 refs = priv->i_refcount;
1539 vlc_spin_unlock (&priv->ref_spin);
1541 for (held_list_t *hlcur = vlc_threadvar_get (&held_objects);
1542 hlcur != NULL; hlcur = hlcur->next)
1543 if (hlcur->obj == obj)
1546 fprintf (stderr, "The %s %s thread object is accessing...\n"
1547 "the %s %s object without references.\n",
1548 caller && caller->psz_object_name
1549 ? caller->psz_object_name : "unnamed",
1550 caller ? caller->psz_object_type : "main",
1551 obj->psz_object_name ? obj->psz_object_name : "unnamed",
1552 obj->psz_object_type);
1555 #ifdef HAVE_BACKTRACE
1557 int stackdepth = backtrace (stack, sizeof (stack) / sizeof (stack[0]));
1558 backtrace_symbols_fd (stack, stackdepth, 2);
1561 if (++errors == 100)
1562 fprintf (stderr, "Too many reference errors!\n");
1565 static void held_objects_destroy (void *data)
1568 held_list_t *hl = vlc_threadvar_get (&held_objects);
1569 vlc_object_t *caller = vlc_threadobj ();
1573 held_list_t *buf = hl->next;
1574 vlc_object_t *obj = hl->obj;
1576 fprintf (stderr, "The %s %s thread object leaked a reference to...\n"
1577 "the %s %s object.\n",
1578 caller && caller->psz_object_name
1579 ? caller->psz_object_name : "unnamed",
1580 caller ? caller->psz_object_type : "main",
1581 obj->psz_object_name ? obj->psz_object_name : "unnamed",
1582 obj->psz_object_type);