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_DECODER:
234 i_size = sizeof(decoder_t);
235 psz_type = "decoder";
237 case VLC_OBJECT_PACKETIZER:
238 i_size = sizeof(decoder_t);
239 psz_type = "packetizer";
241 case VLC_OBJECT_ENCODER:
242 i_size = sizeof(encoder_t);
243 psz_type = "encoder";
245 case VLC_OBJECT_AOUT:
246 i_size = sizeof(aout_instance_t);
247 psz_type = "audio output";
249 case VLC_OBJECT_OPENGL:
250 i_size = sizeof( vout_thread_t );
253 case VLC_OBJECT_ANNOUNCE:
254 i_size = sizeof( announce_handler_t );
255 psz_type = "announce";
258 assert( i_type > 0 ); /* unknown type?! */
260 i_type = VLC_OBJECT_GENERIC;
261 psz_type = "generic";
265 return vlc_custom_create( p_this, i_size, i_type, psz_type );
270 ****************************************************************************
271 * Set the destructor of a vlc object
273 * This function sets the destructor of the vlc object. It will be called
274 * when the object is destroyed when the its refcount reaches 0.
275 * (It is called by the internal function vlc_object_destroy())
276 *****************************************************************************/
277 void __vlc_object_set_destructor( vlc_object_t *p_this,
278 vlc_destructor_t pf_destructor )
280 vlc_object_internals_t *p_priv = vlc_internals(p_this );
281 p_priv->pf_destructor = pf_destructor;
285 ****************************************************************************
286 * Destroy a vlc object (Internal)
288 * This function destroys an object that has been previously allocated with
289 * vlc_object_create. The object's refcount must be zero and it must not be
290 * attached to other objects in any way.
291 *****************************************************************************/
292 static void vlc_object_destroy( vlc_object_t *p_this )
294 vlc_object_internals_t *p_priv = vlc_internals( p_this );
296 /* Objects are always detached beforehand */
297 assert( !p_this->p_parent );
299 /* Send a kill to the object's thread if applicable */
300 vlc_object_kill( p_this );
302 /* If we are running on a thread, wait until it ends */
303 if( p_priv->b_thread )
304 vlc_thread_join( p_this );
306 /* Call the custom "subclass" destructor */
307 if( p_priv->pf_destructor )
308 p_priv->pf_destructor( p_this );
310 /* Destroy the associated variables, starting from the end so that
311 * no memmove calls have to be done. */
312 while( p_priv->i_vars )
314 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
317 free( p_priv->p_vars );
318 vlc_mutex_destroy( &p_priv->var_lock );
320 free( p_this->psz_header );
322 if( p_this->p_libvlc == NULL )
324 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
327 assert( p_global == vlc_global() );
329 if (p_priv->next != p_this)
331 vlc_object_t *leaked = p_priv->next, *first = leaked;
334 /* We are leaking this object */
336 "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
337 leaked->i_object_id, leaked->psz_object_type,
338 leaked->psz_object_name );
339 /* Dump libvlc object to ease debugging */
340 vlc_object_dump( leaked );
342 leaked = vlc_internals (leaked)->next;
344 while (leaked != first);
346 /* Dump global object to ease debugging */
347 vlc_object_dump( p_this );
348 /* Strongly abort, cause we want these to be fixed */
353 /* We are the global object ... no need to lock. */
354 vlc_mutex_destroy( &structure_lock );
355 #ifdef LIBVLC_REFCHECK
356 held_objects_destroy( vlc_threadvar_get( &held_objects ) );
357 vlc_threadvar_delete( &held_objects );
361 FREENULL( p_this->psz_object_name );
363 #if defined(WIN32) || defined(UNDER_CE)
364 /* if object has an associated thread, close it now */
365 if( p_priv->thread_id )
366 CloseHandle(p_priv->thread_id);
369 vlc_spin_destroy( &p_priv->ref_spin );
370 vlc_mutex_destroy( &p_priv->lock );
371 vlc_cond_destroy( &p_priv->wait );
372 vlc_spin_destroy( &p_priv->spin );
373 if( p_priv->pipes[1] != -1 )
374 close( p_priv->pipes[1] );
375 if( p_priv->pipes[0] != -1 )
376 close( p_priv->pipes[0] );
382 /** Inter-object signaling */
384 void __vlc_object_lock( vlc_object_t *obj )
386 vlc_mutex_lock( &(vlc_internals(obj)->lock) );
389 void __vlc_object_unlock( vlc_object_t *obj )
391 vlc_assert_locked( &(vlc_internals(obj)->lock) );
392 vlc_mutex_unlock( &(vlc_internals(obj)->lock) );
396 # include <winsock2.h>
397 # include <ws2tcpip.h>
400 * select()-able pipes emulated using Winsock
402 static int pipe (int fd[2])
405 int addrlen = sizeof (addr);
407 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
408 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
409 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
412 memset (&addr, 0, sizeof (addr));
413 addr.sin_family = AF_INET;
414 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
415 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
416 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
418 || connect (c, (PSOCKADDR)&addr, addrlen))
421 a = accept (l, NULL, NULL);
422 if (a == INVALID_SOCKET)
433 if (l != INVALID_SOCKET)
435 if (c != INVALID_SOCKET)
441 #define read( a, b, c ) recv (a, b, c, 0)
443 #define write( a, b, c ) send (a, b, c, 0)
445 #define close( a ) closesocket (a)
449 * Returns the readable end of a pipe that becomes readable once termination
450 * of the object is requested (vlc_object_kill()).
451 * This can be used to wake-up out of a select() or poll() event loop, such
452 * typically when doing network I/O.
454 * Note that the pipe will remain the same for the lifetime of the object.
455 * DO NOT read the pipe nor close it yourself. Ever.
457 * @param obj object that would be "killed"
458 * @return a readable pipe descriptor, or -1 on error.
460 int __vlc_object_waitpipe( vlc_object_t *obj )
462 int pfd[2] = { -1, -1 };
463 vlc_object_internals_t *internals = vlc_internals( obj );
466 vlc_spin_lock (&internals->spin);
467 if (internals->pipes[0] == -1)
469 /* This can only ever happen if someone killed us without locking: */
470 assert (internals->pipes[1] == -1);
471 vlc_spin_unlock (&internals->spin);
476 vlc_spin_lock (&internals->spin);
477 if (internals->pipes[0] == -1)
479 internals->pipes[0] = pfd[0];
480 internals->pipes[1] = pfd[1];
481 pfd[0] = pfd[1] = -1;
485 vlc_spin_unlock (&internals->spin);
489 /* Race condition: vlc_object_kill() already invoked! */
492 vlc_spin_lock (&internals->spin);
493 fd = internals->pipes[1];
494 internals->pipes[1] = -1;
495 vlc_spin_unlock (&internals->spin);
497 msg_Dbg (obj, "waitpipe: object already dying");
502 /* Race condition: two threads call pipe() - unlikely */
508 return internals->pipes[0];
513 * Waits for the object to be signaled (using vlc_object_signal()).
514 * It is assumed that the caller has locked the object. This function will
515 * unlock the object, and lock it again before returning.
516 * If the object was signaled before the caller locked the object, it is
517 * undefined whether the signal will be lost or will wake the process.
519 * @return true if the object is dying and should terminate.
521 void __vlc_object_wait( vlc_object_t *obj )
523 vlc_object_internals_t *priv = vlc_internals( obj );
524 vlc_assert_locked( &priv->lock);
525 vlc_cond_wait( &priv->wait, &priv->lock );
530 * Waits for the object to be signaled (using vlc_object_signal()), or for
531 * a timer to expire. It is asserted that the caller holds the object lock.
533 * @return 0 if the object was signaled before the timer expiration, or
534 * ETIMEDOUT if the timer expired without any signal.
536 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
538 vlc_object_internals_t *priv = vlc_internals( obj );
539 vlc_assert_locked( &priv->lock);
540 return vlc_cond_timedwait( &priv->wait, &priv->lock, deadline );
545 * Checks whether an object has been "killed".
546 * The object lock must be held.
548 * Typical code for an object thread could be:
550 vlc_object_lock (self);
552 while (vlc_object_alive (self))
556 vlc_object_wait (self);
560 ...deinitialization...
561 vlc_object_unlock (self);
564 * @return true iff the object has not been killed yet
566 bool __vlc_object_alive( vlc_object_t *obj )
568 vlc_assert_locked( &(vlc_internals(obj)->lock) );
574 * Signals an object for which the lock is held.
575 * At least one thread currently sleeping in vlc_object_wait() or
576 * vlc_object_timedwait() will wake up, assuming that there is at least one
577 * such thread in the first place. Otherwise, it is undefined whether the
578 * signal will be lost or will wake up one or more thread later.
580 void __vlc_object_signal_unlocked( vlc_object_t *obj )
582 vlc_assert_locked (&(vlc_internals(obj)->lock));
583 vlc_cond_signal( &(vlc_internals(obj)->wait) );
588 * Requests termination of an object.
589 * If the object is LibVLC, also request to terminate all its children.
591 void __vlc_object_kill( vlc_object_t *p_this )
593 vlc_object_internals_t *priv = vlc_internals( p_this );
596 vlc_object_lock( p_this );
597 p_this->b_die = true;
599 vlc_spin_lock (&priv->spin);
602 vlc_spin_unlock (&priv->spin);
606 msg_Dbg (p_this, "waitpipe: object killed");
610 vlc_object_signal_unlocked( p_this );
611 vlc_object_unlock( p_this );
616 * Find an object given its ID.
618 * This function looks for the object whose i_object_id field is i_id.
619 * This function is slow, and often used to hide bugs. Do not use it.
620 * If you need to retain reference to an object, yield the object pointer with
621 * vlc_object_yield(), use the pointer as your reference, and call
622 * vlc_object_release() when you're done.
624 void * vlc_object_get( int i_id )
626 libvlc_global_data_t *p_libvlc_global = vlc_global();
627 vlc_object_t *obj = NULL;
629 vlc_object_t *caller = vlc_threadobj ();
632 msg_Dbg (caller, "uses deprecated vlc_object_get(%d)", i_id);
634 fprintf (stderr, "main thread uses deprecated vlc_object_get(%d)\n",
637 vlc_mutex_lock( &structure_lock );
639 for( obj = vlc_internals (p_libvlc_global)->next;
640 obj != VLC_OBJECT (p_libvlc_global);
641 obj = vlc_internals (obj)->next )
643 if( obj->i_object_id == i_id )
645 vlc_object_yield( obj );
652 msg_Warn (caller, "wants non-existing object %d", i_id);
654 fprintf (stderr, "main thread wants non-existing object %d\n", i_id);
657 vlc_mutex_unlock( &structure_lock );
662 ****************************************************************************
663 * find a typed object and increment its refcount
664 *****************************************************************************
665 * This function recursively looks for a given object type. i_mode can be one
666 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
667 *****************************************************************************/
668 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
670 vlc_object_t *p_found;
672 /* If we are of the requested type ourselves, don't look further */
673 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
675 vlc_object_yield( p_this );
679 /* Otherwise, recursively look for the object */
680 if ((i_mode & 0x000f) == FIND_ANYWHERE)
683 if (i_type == VLC_OBJECT_PLAYLIST)
684 msg_Err (p_this, "using vlc_object_find(VLC_OBJECT_PLAYLIST) "
685 "instead of pl_Yield()");
687 return vlc_object_find (p_this->p_libvlc, i_type,
688 (i_mode & ~0x000f)|FIND_CHILD);
691 vlc_mutex_lock( &structure_lock );
692 p_found = FindObject( p_this, i_type, i_mode );
693 vlc_mutex_unlock( &structure_lock );
698 ****************************************************************************
699 * find a named object and increment its refcount
700 *****************************************************************************
701 * This function recursively looks for a given object name. i_mode can be one
702 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
703 *****************************************************************************/
704 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
707 vlc_object_t *p_found;
709 /* If have the requested name ourselves, don't look further */
710 if( !(i_mode & FIND_STRICT)
711 && p_this->psz_object_name
712 && !strcmp( p_this->psz_object_name, psz_name ) )
714 vlc_object_yield( p_this );
718 vlc_mutex_lock( &structure_lock );
720 /* Otherwise, recursively look for the object */
721 if( (i_mode & 0x000f) == FIND_ANYWHERE )
723 vlc_object_t *p_root = p_this;
726 while( p_root->p_parent != NULL &&
727 p_root != VLC_OBJECT( p_this->p_libvlc ) )
729 p_root = p_root->p_parent;
732 p_found = FindObjectName( p_root, psz_name,
733 (i_mode & ~0x000f)|FIND_CHILD );
734 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
736 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
737 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
742 p_found = FindObjectName( p_this, psz_name, i_mode );
745 vlc_mutex_unlock( &structure_lock );
751 * Increment an object reference counter.
753 void __vlc_object_yield( vlc_object_t *p_this )
755 vlc_object_internals_t *internals = vlc_internals( p_this );
757 vlc_spin_lock( &internals->ref_spin );
758 /* Avoid obvious freed object uses */
759 assert( internals->i_refcount > 0 );
760 /* Increment the counter */
761 internals->i_refcount++;
762 vlc_spin_unlock( &internals->ref_spin );
763 #ifdef LIBVLC_REFCHECK
764 /* Update the list of referenced objects */
765 /* Using TLS, so no need to lock */
766 /* The following line may leak memory if a thread leaks objects. */
767 held_list_t *newhead = malloc (sizeof (*newhead));
768 held_list_t *oldhead = vlc_threadvar_get (&held_objects);
769 newhead->next = oldhead;
770 newhead->obj = p_this;
771 vlc_threadvar_set (&held_objects, newhead);
775 /*****************************************************************************
776 * decrement an object refcount
777 * And destroy the object if its refcount reach zero.
778 *****************************************************************************/
779 void __vlc_object_release( vlc_object_t *p_this )
781 vlc_object_internals_t *internals = vlc_internals( p_this );
782 bool b_should_destroy;
784 #ifdef LIBVLC_REFCHECK
785 /* Update the list of referenced objects */
786 /* Using TLS, so no need to lock */
787 for (held_list_t *hlcur = vlc_threadvar_get (&held_objects),
790 hlprev = hlcur, hlcur = hlcur->next)
792 if (hlcur->obj == p_this)
795 vlc_threadvar_set (&held_objects, hlcur->next);
797 hlprev->next = hlcur->next;
802 /* TODO: what if releasing without references? */
805 vlc_spin_lock( &internals->ref_spin );
806 assert( internals->i_refcount > 0 );
808 if( internals->i_refcount > 1 )
811 /* There are still other references to the object */
812 internals->i_refcount--;
813 vlc_spin_unlock( &internals->ref_spin );
816 vlc_spin_unlock( &internals->ref_spin );
819 /* Remember that we cannot hold the spin while waiting on the mutex */
820 vlc_mutex_lock( &structure_lock );
821 /* Take the spin again. Note that another thread may have yielded the
822 * object in the (very short) mean time. */
823 vlc_spin_lock( &internals->ref_spin );
824 b_should_destroy = --internals->i_refcount == 0;
825 vlc_spin_unlock( &internals->ref_spin );
827 if( b_should_destroy )
829 /* Remove the object from object list
830 * so that it cannot be encountered by vlc_object_get() */
831 vlc_internals (internals->next)->prev = internals->prev;
832 vlc_internals (internals->prev)->next = internals->next;
834 /* Detach from parent to protect against FIND_CHILDREN */
835 vlc_object_detach_unlocked (p_this);
836 /* Detach from children to protect against FIND_PARENT */
837 for (int i = 0; i < internals->i_children; i++)
838 internals->pp_children[i]->p_parent = NULL;
841 vlc_mutex_unlock( &structure_lock );
843 if( b_should_destroy )
845 free( internals->pp_children );
846 internals->pp_children = NULL;
847 internals->i_children = 0;
848 vlc_object_destroy( p_this );
853 ****************************************************************************
854 * attach object to a parent object
855 *****************************************************************************
856 * This function sets p_this as a child of p_parent, and p_parent as a parent
857 * of p_this. This link can be undone using vlc_object_detach.
858 *****************************************************************************/
859 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
861 if( !p_this ) return;
863 vlc_mutex_lock( &structure_lock );
865 /* Attach the parent to its child */
866 assert (!p_this->p_parent);
867 p_this->p_parent = p_parent;
869 /* Attach the child to its parent */
870 vlc_object_internals_t *priv = vlc_internals( p_parent );
871 INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
874 vlc_mutex_unlock( &structure_lock );
878 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
880 vlc_assert_locked (&structure_lock);
882 if (p_this->p_parent == NULL)
885 vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
889 /* Remove p_this's parent */
890 p_this->p_parent = NULL;
892 /* Remove all of p_parent's children which are p_this */
893 for( i_index = priv->i_children ; i_index-- ; )
895 if( priv->pp_children[i_index] == p_this )
898 for( i = i_index ; i < priv->i_children ; i++ )
899 priv->pp_children[i] = priv->pp_children[i+1];
903 if( priv->i_children )
905 priv->pp_children = (vlc_object_t **)realloc( priv->pp_children,
906 priv->i_children * sizeof(vlc_object_t *) );
910 /* Special case - don't realloc() to zero to avoid leaking */
911 free( priv->pp_children );
912 priv->pp_children = NULL;
918 ****************************************************************************
919 * detach object from its parent
920 *****************************************************************************
921 * This function removes all links between an object and its parent.
922 *****************************************************************************/
923 void __vlc_object_detach( vlc_object_t *p_this )
925 if( !p_this ) return;
927 vlc_mutex_lock( &structure_lock );
928 if( !p_this->p_parent )
929 msg_Err( p_this, "object is not attached" );
931 vlc_object_detach_unlocked( p_this );
932 vlc_mutex_unlock( &structure_lock );
937 ****************************************************************************
938 * find a list typed objects and increment their refcount
939 *****************************************************************************
940 * This function recursively looks for a given object type. i_mode can be one
941 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
942 *****************************************************************************/
943 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
948 /* Look for the objects */
949 switch( i_mode & 0x000f )
952 /* Modules should probably not be object, and the module should perhaps
953 * not be shared across LibVLC instances. In the mean time, this ugly
954 * hack is brought to you by Courmisch. */
955 if (i_type == VLC_OBJECT_MODULE)
956 return vlc_list_find ((vlc_object_t *)vlc_global ()->p_module_bank,
958 return vlc_list_find (p_this->p_libvlc, i_type, FIND_CHILD);
961 vlc_mutex_lock( &structure_lock );
962 i_count = CountChildren( p_this, i_type );
963 p_list = NewList( i_count );
965 /* Check allocation was successful */
966 if( p_list->i_count != i_count )
968 vlc_mutex_unlock( &structure_lock );
969 msg_Err( p_this, "list allocation failed!" );
975 ListChildren( p_list, p_this, i_type );
976 vlc_mutex_unlock( &structure_lock );
980 msg_Err( p_this, "unimplemented!" );
981 p_list = NewList( 0 );
989 * Gets the list of children of an objects, and increment their reference
991 * @return a list (possibly empty) or NULL in case of error.
993 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
996 vlc_object_internals_t *priv = vlc_internals( obj );
998 vlc_mutex_lock( &structure_lock );
999 l = NewList( priv->i_children );
1000 for (int i = 0; i < l->i_count; i++)
1002 vlc_object_yield( priv->pp_children[i] );
1003 l->p_values[i].p_object = priv->pp_children[i];
1005 vlc_mutex_unlock( &structure_lock );
1009 /*****************************************************************************
1010 * DumpCommand: print the current vlc structure
1011 *****************************************************************************
1012 * This function prints either an ASCII tree showing the connections between
1013 * vlc objects, and additional information such as their refcount, thread ID,
1014 * etc. (command "tree"), or the same data as a simple list (command "list").
1015 *****************************************************************************/
1016 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
1017 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1019 (void)oldval; (void)p_data;
1020 if( *psz_cmd == 'l' )
1022 vlc_object_t *root = VLC_OBJECT (vlc_global ()), *cur = root;
1024 vlc_mutex_lock( &structure_lock );
1027 PrintObject (cur, "");
1028 cur = vlc_internals (cur)->next;
1030 while (cur != root);
1031 vlc_mutex_unlock( &structure_lock );
1035 vlc_object_t *p_object = NULL;
1037 if( *newval.psz_string )
1040 int i_id = strtol( newval.psz_string, &end, 0 );
1041 if( end != newval.psz_string )
1042 p_object = vlc_object_get( i_id );
1044 /* try using the object's name to find it */
1045 p_object = vlc_object_find_name( p_this, newval.psz_string,
1054 vlc_mutex_lock( &structure_lock );
1056 if( *psz_cmd == 't' )
1058 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1061 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1064 DumpStructure( p_object, 0, psz_foo );
1066 else if( *psz_cmd == 'v' )
1071 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1073 PrintObject( p_object, "" );
1075 if( !vlc_internals( p_object )->i_vars )
1076 printf( " `-o No variables\n" );
1077 for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
1079 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
1081 const char *psz_type = "unknown";
1082 switch( p_var->i_type & VLC_VAR_TYPE )
1084 #define MYCASE( type, nice ) \
1085 case VLC_VAR_ ## type: \
1088 MYCASE( VOID, "void" );
1089 MYCASE( BOOL, "bool" );
1090 MYCASE( INTEGER, "integer" );
1091 MYCASE( HOTKEY, "hotkey" );
1092 MYCASE( STRING, "string" );
1093 MYCASE( MODULE, "module" );
1094 MYCASE( FILE, "file" );
1095 MYCASE( DIRECTORY, "directory" );
1096 MYCASE( VARIABLE, "variable" );
1097 MYCASE( FLOAT, "float" );
1098 MYCASE( TIME, "time" );
1099 MYCASE( ADDRESS, "address" );
1100 MYCASE( MUTEX, "mutex" );
1101 MYCASE( LIST, "list" );
1104 printf( " %c-o \"%s\" (%s",
1105 i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
1106 p_var->psz_name, psz_type );
1107 if( p_var->psz_text )
1108 printf( ", %s", p_var->psz_text );
1110 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1111 printf( ", command" );
1112 if( p_var->i_entries )
1113 printf( ", %d callbacks", p_var->i_entries );
1114 switch( p_var->i_type & 0x00f0 )
1120 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1122 case VLC_VAR_INTEGER:
1123 printf( ": %d", p_var->val.i_int );
1125 case VLC_VAR_STRING:
1126 printf( ": \"%s\"", p_var->val.psz_string );
1129 printf( ": %f", p_var->val.f_float );
1132 printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
1134 case VLC_VAR_ADDRESS:
1135 printf( ": %p", p_var->val.p_address );
1145 vlc_mutex_unlock( &structure_lock );
1147 if( *newval.psz_string )
1149 vlc_object_release( p_object );
1156 /*****************************************************************************
1157 * vlc_list_release: free a list previously allocated by vlc_list_find
1158 *****************************************************************************
1159 * This function decreases the refcount of all objects in the list and
1161 *****************************************************************************/
1162 void vlc_list_release( vlc_list_t *p_list )
1166 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1168 vlc_object_release( p_list->p_values[i_index].p_object );
1171 free( p_list->p_values );
1175 /*****************************************************************************
1176 * dump an object. (Debug function)
1177 *****************************************************************************/
1178 void __vlc_object_dump( vlc_object_t *p_this )
1180 vlc_mutex_lock( &structure_lock );
1181 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1183 DumpStructure( p_this, 0, psz_foo );
1184 vlc_mutex_unlock( &structure_lock );
1187 /* Following functions are local */
1189 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1192 vlc_object_t *p_tmp;
1194 switch( i_mode & 0x000f )
1197 p_tmp = p_this->p_parent;
1200 if( p_tmp->i_object_type == i_type )
1202 vlc_object_yield( p_tmp );
1207 return FindObject( p_tmp, i_type, i_mode );
1213 for( i = vlc_internals( p_this )->i_children; i--; )
1215 p_tmp = vlc_internals( p_this )->pp_children[i];
1216 if( p_tmp->i_object_type == i_type )
1218 vlc_object_yield( p_tmp );
1221 else if( vlc_internals( p_tmp )->i_children )
1223 p_tmp = FindObject( p_tmp, i_type, i_mode );
1233 /* Handled in vlc_object_find */
1240 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1241 const char *psz_name,
1245 vlc_object_t *p_tmp;
1247 switch( i_mode & 0x000f )
1250 p_tmp = p_this->p_parent;
1253 if( p_tmp->psz_object_name
1254 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1256 vlc_object_yield( p_tmp );
1261 return FindObjectName( p_tmp, psz_name, i_mode );
1267 for( i = vlc_internals( p_this )->i_children; i--; )
1269 p_tmp = vlc_internals( p_this )->pp_children[i];
1270 if( p_tmp->psz_object_name
1271 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1273 vlc_object_yield( p_tmp );
1276 else if( vlc_internals( p_tmp )->i_children )
1278 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1288 /* Handled in vlc_object_find */
1296 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1298 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1301 memset( &psz_name, 0, sizeof(psz_name) );
1302 if( p_this->psz_object_name )
1304 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1306 psz_name[48] = '\"';
1309 psz_children[0] = '\0';
1310 switch( vlc_internals( p_this )->i_children )
1315 strcpy( psz_children, ", 1 child" );
1318 snprintf( psz_children, 19, ", %i children",
1319 vlc_internals( p_this )->i_children );
1323 psz_refcount[0] = '\0';
1324 if( vlc_internals( p_this )->i_refcount > 0 )
1325 snprintf( psz_refcount, 19, ", refcount %u",
1326 vlc_internals( p_this )->i_refcount );
1328 psz_thread[0] = '\0';
1329 if( vlc_internals( p_this )->b_thread )
1330 snprintf( psz_thread, 29, " (thread %lu)",
1331 (unsigned long)vlc_internals( p_this )->thread_id );
1333 psz_parent[0] = '\0';
1334 if( p_this->p_parent )
1335 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1337 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1338 p_this->i_object_id, p_this->psz_object_type,
1339 psz_name, psz_thread, psz_refcount, psz_children,
1343 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1346 char i_back = psz_foo[i_level];
1347 psz_foo[i_level] = '\0';
1349 PrintObject( p_this, psz_foo );
1351 psz_foo[i_level] = i_back;
1353 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1355 msg_Warn( p_this, "structure tree is too deep" );
1359 for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
1363 psz_foo[i_level-1] = ' ';
1365 if( psz_foo[i_level-2] == '`' )
1367 psz_foo[i_level-2] = ' ';
1371 if( i == vlc_internals( p_this )->i_children - 1 )
1373 psz_foo[i_level] = '`';
1377 psz_foo[i_level] = '|';
1380 psz_foo[i_level+1] = '-';
1381 psz_foo[i_level+2] = '\0';
1383 DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
1388 static vlc_list_t * NewList( int i_count )
1390 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1391 if( p_list == NULL )
1396 p_list->i_count = i_count;
1400 p_list->p_values = NULL;
1404 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1405 if( p_list->p_values == NULL )
1407 p_list->i_count = 0;
1414 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1417 if( p_list == NULL || i_index >= p_list->i_count )
1422 vlc_object_yield( p_object );
1424 p_list->p_values[i_index].p_object = p_object;
1429 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1431 if( p_list == NULL )
1436 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1437 * sizeof( vlc_value_t ) );
1438 if( p_list->p_values == NULL )
1440 p_list->i_count = 0;
1444 vlc_object_yield( p_object );
1446 p_list->p_values[p_list->i_count].p_object = p_object;
1452 static int CountChildren( vlc_object_t *p_this, int i_type )
1454 vlc_object_t *p_tmp;
1457 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1459 p_tmp = vlc_internals( p_this )->pp_children[i];
1461 if( p_tmp->i_object_type == i_type )
1465 i_count += CountChildren( p_tmp, i_type );
1471 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1473 vlc_object_t *p_tmp;
1476 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1478 p_tmp = vlc_internals( p_this )->pp_children[i];
1480 if( p_tmp->i_object_type == i_type )
1481 ListReplace( p_list, p_tmp, p_list->i_count++ );
1483 ListChildren( p_list, p_tmp, i_type );
1487 #ifdef LIBVLC_REFCHECK
1488 # if defined(HAVE_EXECINFO_H) && defined(HAVE_BACKTRACE)
1489 # include <execinfo.h>
1492 void vlc_refcheck (vlc_object_t *obj)
1494 static unsigned errors = 0;
1498 /* Anyone can use the root object (though it should not exist) */
1499 if (obj == VLC_OBJECT (vlc_global ()))
1502 /* Anyone can use its libvlc instance object */
1503 if (obj == VLC_OBJECT (obj->p_libvlc))
1506 /* The thread that created the object holds the initial reference */
1507 vlc_object_internals_t *priv = vlc_internals (obj);
1508 #if defined (LIBVLC_USE_PTHREAD)
1509 if (pthread_equal (priv->creator_id, pthread_self ()))
1511 if (priv->creator_id == GetCurrentThreadId ())
1517 /* A thread can use its own object without references! */
1518 vlc_object_t *caller = vlc_threadobj ();
1522 /* The calling thread is younger than the object.
1523 * Access could be valid through cross-thread synchronization;
1524 * we would need better accounting. */
1525 if (caller && (caller->i_object_id > obj->i_object_id))
1529 vlc_spin_lock (&priv->ref_spin);
1530 refs = priv->i_refcount;
1531 vlc_spin_unlock (&priv->ref_spin);
1533 for (held_list_t *hlcur = vlc_threadvar_get (&held_objects);
1534 hlcur != NULL; hlcur = hlcur->next)
1535 if (hlcur->obj == obj)
1538 fprintf (stderr, "The %s %s thread object is accessing...\n"
1539 "the %s %s object without references.\n",
1540 caller && caller->psz_object_name
1541 ? caller->psz_object_name : "unnamed",
1542 caller ? caller->psz_object_type : "main",
1543 obj->psz_object_name ? obj->psz_object_name : "unnamed",
1544 obj->psz_object_type);
1547 #ifdef HAVE_BACKTRACE
1549 int stackdepth = backtrace (stack, sizeof (stack) / sizeof (stack[0]));
1550 backtrace_symbols_fd (stack, stackdepth, 2);
1553 if (++errors == 100)
1554 fprintf (stderr, "Too many reference errors!\n");
1557 static void held_objects_destroy (void *data)
1560 held_list_t *hl = vlc_threadvar_get (&held_objects);
1561 vlc_object_t *caller = vlc_threadobj ();
1565 held_list_t *buf = hl->next;
1566 vlc_object_t *obj = hl->obj;
1568 fprintf (stderr, "The %s %s thread object leaked a reference to...\n"
1569 "the %s %s object.\n",
1570 caller && caller->psz_object_name
1571 ? caller->psz_object_name : "unnamed",
1572 caller ? caller->psz_object_type : "main",
1573 obj->psz_object_name ? obj->psz_object_name : "unnamed",
1574 obj->psz_object_type);