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;
98 static unsigned object_counter = 0;
100 void *__vlc_custom_create( vlc_object_t *p_this, size_t i_size,
101 int i_type, const char *psz_type )
104 vlc_object_internals_t *p_priv;
107 * VLC objects are laid out as follow:
108 * - first the LibVLC-private per-object data,
109 * - then VLC_COMMON members from vlc_object_t,
110 * - finally, the type-specific data (if any).
112 * This function initializes the LibVLC and common data,
113 * and zeroes the rest.
115 p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
119 assert (i_size >= sizeof (vlc_object_t));
120 p_new = (vlc_object_t *)(p_priv + 1);
122 p_new->i_object_type = i_type;
123 p_new->psz_object_type = psz_type;
124 p_new->psz_object_name = NULL;
126 p_new->b_die = false;
127 p_new->b_error = false;
128 p_new->b_dead = false;
129 p_new->b_force = false;
131 p_new->psz_header = NULL;
134 p_new->i_flags = p_this->i_flags
135 & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
137 p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
139 if( !p_priv->p_vars )
145 libvlc_global_data_t *p_libvlc_global;
148 /* Only the global root object is created out of the blue */
149 p_libvlc_global = (libvlc_global_data_t *)p_new;
150 p_new->p_libvlc = NULL;
152 object_counter = 0; /* reset */
153 p_priv->next = p_priv->prev = p_new;
154 vlc_mutex_init( &structure_lock );
155 #ifdef LIBVLC_REFCHECK
156 /* TODO: use the destruction callback to track ref leaks */
157 vlc_threadvar_create( &held_objects, held_objects_destroy );
162 p_libvlc_global = vlc_global();
163 if( i_type == VLC_OBJECT_LIBVLC )
164 p_new->p_libvlc = (libvlc_int_t*)p_new;
166 p_new->p_libvlc = p_this->p_libvlc;
169 vlc_spin_init( &p_priv->ref_spin );
170 p_priv->i_refcount = 1;
171 p_priv->pf_destructor = NULL;
172 p_priv->b_thread = false;
173 p_new->p_parent = NULL;
174 p_priv->pp_children = NULL;
175 p_priv->i_children = 0;
177 p_new->p_private = NULL;
179 /* Initialize mutexes and condvars */
180 vlc_mutex_init( &p_priv->lock );
181 vlc_cond_init( p_new, &p_priv->wait );
182 vlc_mutex_init( &p_priv->var_lock );
183 vlc_spin_init( &p_priv->spin );
184 p_priv->pipes[0] = p_priv->pipes[1] = -1;
186 p_priv->next = VLC_OBJECT (p_libvlc_global);
187 #if !defined (LIBVLC_REFCHECK)
189 #elif defined (LIBVLC_USE_PTHREAD)
190 p_priv->creator_id = pthread_self ();
191 #elif defined (WIN32)
192 p_priv->creator_id = GetCurrentThreadId ();
194 vlc_mutex_lock( &structure_lock );
195 p_priv->prev = vlc_internals (p_libvlc_global)->prev;
196 vlc_internals (p_libvlc_global)->prev = p_new;
197 vlc_internals (p_priv->prev)->next = p_new;
198 p_new->i_object_id = object_counter++; /* fetch THEN increment */
199 vlc_mutex_unlock( &structure_lock );
201 if( i_type == VLC_OBJECT_LIBVLC )
203 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
204 var_AddCallback( p_new, "list", DumpCommand, NULL );
205 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
206 var_AddCallback( p_new, "tree", DumpCommand, NULL );
207 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
208 var_AddCallback( p_new, "vars", DumpCommand, NULL );
216 * Allocates and initializes a vlc object.
218 * @param i_type known object type (all of them are negative integer values),
219 * or object byte size (always positive).
221 * @return the new object, or NULL on error.
223 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
225 const char * psz_type;
230 case VLC_OBJECT_INTF:
231 i_size = sizeof(intf_thread_t);
232 psz_type = "interface";
234 case VLC_OBJECT_DECODER:
235 i_size = sizeof(decoder_t);
236 psz_type = "decoder";
238 case VLC_OBJECT_PACKETIZER:
239 i_size = sizeof(decoder_t);
240 psz_type = "packetizer";
242 case VLC_OBJECT_ENCODER:
243 i_size = sizeof(encoder_t);
244 psz_type = "encoder";
246 case VLC_OBJECT_AOUT:
247 i_size = sizeof(aout_instance_t);
248 psz_type = "audio output";
250 case VLC_OBJECT_OPENGL:
251 i_size = sizeof( vout_thread_t );
254 case VLC_OBJECT_ANNOUNCE:
255 i_size = sizeof( announce_handler_t );
256 psz_type = "announce";
259 assert( i_type > 0 ); /* unknown type?! */
261 i_type = VLC_OBJECT_GENERIC;
262 psz_type = "generic";
266 return vlc_custom_create( p_this, i_size, i_type, psz_type );
271 ****************************************************************************
272 * Set the destructor of a vlc object
274 * This function sets the destructor of the vlc object. It will be called
275 * when the object is destroyed when the its refcount reaches 0.
276 * (It is called by the internal function vlc_object_destroy())
277 *****************************************************************************/
278 void __vlc_object_set_destructor( vlc_object_t *p_this,
279 vlc_destructor_t pf_destructor )
281 vlc_object_internals_t *p_priv = vlc_internals(p_this );
282 p_priv->pf_destructor = pf_destructor;
286 ****************************************************************************
287 * Destroy a vlc object (Internal)
289 * This function destroys an object that has been previously allocated with
290 * vlc_object_create. The object's refcount must be zero and it must not be
291 * attached to other objects in any way.
292 *****************************************************************************/
293 static void vlc_object_destroy( vlc_object_t *p_this )
295 vlc_object_internals_t *p_priv = vlc_internals( p_this );
297 /* Objects are always detached beforehand */
298 assert( !p_this->p_parent );
300 /* Send a kill to the object's thread if applicable */
301 vlc_object_kill( p_this );
303 /* If we are running on a thread, wait until it ends */
304 if( p_priv->b_thread )
306 msg_Warn (p_this->p_libvlc, /* do NOT use a dead object for logging! */
307 "%s %d destroyed while thread alive (VLC might crash)",
308 p_this->psz_object_type, p_this->i_object_id);
309 vlc_thread_join( p_this );
312 /* Call the custom "subclass" destructor */
313 if( p_priv->pf_destructor )
314 p_priv->pf_destructor( p_this );
316 /* Destroy the associated variables, starting from the end so that
317 * no memmove calls have to be done. */
318 while( p_priv->i_vars )
320 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
323 free( p_priv->p_vars );
324 vlc_mutex_destroy( &p_priv->var_lock );
326 free( p_this->psz_header );
328 if( p_this->p_libvlc == NULL )
331 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
333 assert( p_global == vlc_global() );
335 if (p_priv->next != p_this)
337 vlc_object_t *leaked = p_priv->next, *first = leaked;
340 /* We are leaking this object */
342 "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
343 leaked->i_object_id, leaked->psz_object_type,
344 leaked->psz_object_name );
345 /* Dump libvlc object to ease debugging */
346 vlc_object_dump( leaked );
348 leaked = vlc_internals (leaked)->next;
350 while (leaked != first);
352 /* Dump global object to ease debugging */
353 vlc_object_dump( p_this );
354 /* Strongly abort, cause we want these to be fixed */
359 /* We are the global object ... no need to lock. */
360 vlc_mutex_destroy( &structure_lock );
361 #ifdef LIBVLC_REFCHECK
362 held_objects_destroy( vlc_threadvar_get( &held_objects ) );
363 vlc_threadvar_delete( &held_objects );
367 FREENULL( p_this->psz_object_name );
369 #if defined(WIN32) || defined(UNDER_CE)
370 /* if object has an associated thread, close it now */
371 if( p_priv->thread_id )
372 CloseHandle(p_priv->thread_id);
375 vlc_spin_destroy( &p_priv->ref_spin );
376 vlc_mutex_destroy( &p_priv->lock );
377 vlc_cond_destroy( &p_priv->wait );
378 vlc_spin_destroy( &p_priv->spin );
379 if( p_priv->pipes[1] != -1 )
380 close( p_priv->pipes[1] );
381 if( p_priv->pipes[0] != -1 )
382 close( p_priv->pipes[0] );
388 /** Inter-object signaling */
390 void __vlc_object_lock( vlc_object_t *obj )
392 vlc_mutex_lock( &(vlc_internals(obj)->lock) );
395 void __vlc_object_unlock( vlc_object_t *obj )
397 vlc_assert_locked( &(vlc_internals(obj)->lock) );
398 vlc_mutex_unlock( &(vlc_internals(obj)->lock) );
402 # include <winsock2.h>
403 # include <ws2tcpip.h>
406 * select()-able pipes emulated using Winsock
408 static int pipe (int fd[2])
411 int addrlen = sizeof (addr);
413 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
414 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
415 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
418 memset (&addr, 0, sizeof (addr));
419 addr.sin_family = AF_INET;
420 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
421 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
422 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
424 || connect (c, (PSOCKADDR)&addr, addrlen))
427 a = accept (l, NULL, NULL);
428 if (a == INVALID_SOCKET)
439 if (l != INVALID_SOCKET)
441 if (c != INVALID_SOCKET)
447 #define read( a, b, c ) recv (a, b, c, 0)
449 #define write( a, b, c ) send (a, b, c, 0)
451 #define close( a ) closesocket (a)
455 * Returns the readable end of a pipe that becomes readable once termination
456 * of the object is requested (vlc_object_kill()).
457 * This can be used to wake-up out of a select() or poll() event loop, such
458 * typically when doing network I/O.
460 * Note that the pipe will remain the same for the lifetime of the object.
461 * DO NOT read the pipe nor close it yourself. Ever.
463 * @param obj object that would be "killed"
464 * @return a readable pipe descriptor, or -1 on error.
466 int __vlc_object_waitpipe( vlc_object_t *obj )
468 int pfd[2] = { -1, -1 };
469 vlc_object_internals_t *internals = vlc_internals( obj );
472 vlc_spin_lock (&internals->spin);
473 if (internals->pipes[0] == -1)
475 /* This can only ever happen if someone killed us without locking: */
476 assert (internals->pipes[1] == -1);
477 vlc_spin_unlock (&internals->spin);
482 vlc_spin_lock (&internals->spin);
483 if (internals->pipes[0] == -1)
485 internals->pipes[0] = pfd[0];
486 internals->pipes[1] = pfd[1];
487 pfd[0] = pfd[1] = -1;
491 vlc_spin_unlock (&internals->spin);
495 /* Race condition: vlc_object_kill() already invoked! */
498 vlc_spin_lock (&internals->spin);
499 fd = internals->pipes[1];
500 internals->pipes[1] = -1;
501 vlc_spin_unlock (&internals->spin);
503 msg_Dbg (obj, "waitpipe: object already dying");
508 /* Race condition: two threads call pipe() - unlikely */
514 return internals->pipes[0];
519 * Waits for the object to be signaled (using vlc_object_signal()).
520 * It is assumed that the caller has locked the object. This function will
521 * unlock the object, and lock it again before returning.
522 * If the object was signaled before the caller locked the object, it is
523 * undefined whether the signal will be lost or will wake the process.
525 * @return true if the object is dying and should terminate.
527 void __vlc_object_wait( vlc_object_t *obj )
529 vlc_object_internals_t *priv = vlc_internals( obj );
530 vlc_assert_locked( &priv->lock);
531 vlc_cond_wait( &priv->wait, &priv->lock );
536 * Waits for the object to be signaled (using vlc_object_signal()), or for
537 * a timer to expire. It is asserted that the caller holds the object lock.
539 * @return 0 if the object was signaled before the timer expiration, or
540 * ETIMEDOUT if the timer expired without any signal.
542 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
544 vlc_object_internals_t *priv = vlc_internals( obj );
545 vlc_assert_locked( &priv->lock);
546 return vlc_cond_timedwait( &priv->wait, &priv->lock, deadline );
551 * Signals an object for which the lock is held.
552 * At least one thread currently sleeping in vlc_object_wait() or
553 * vlc_object_timedwait() will wake up, assuming that there is at least one
554 * such thread in the first place. Otherwise, it is undefined whether the
555 * signal will be lost or will wake up one or more thread later.
557 void __vlc_object_signal_unlocked( vlc_object_t *obj )
559 vlc_assert_locked (&(vlc_internals(obj)->lock));
560 vlc_cond_signal( &(vlc_internals(obj)->wait) );
565 * Requests termination of an object.
566 * If the object is LibVLC, also request to terminate all its children.
568 void __vlc_object_kill( vlc_object_t *p_this )
570 vlc_object_internals_t *priv = vlc_internals( p_this );
573 vlc_object_lock( p_this );
574 p_this->b_die = true;
576 vlc_spin_lock (&priv->spin);
579 vlc_spin_unlock (&priv->spin);
583 msg_Dbg (p_this, "waitpipe: object killed");
587 vlc_object_signal_unlocked( p_this );
588 /* This also serves as a memory barrier toward vlc_object_alive(): */
589 vlc_object_unlock( p_this );
594 * Find an object given its ID.
596 * This function looks for the object whose i_object_id field is i_id.
597 * This function is slow, and often used to hide bugs. Do not use it.
598 * If you need to retain reference to an object, yield the object pointer with
599 * vlc_object_yield(), use the pointer as your reference, and call
600 * vlc_object_release() when you're done.
602 void * vlc_object_get( int i_id )
604 libvlc_global_data_t *p_libvlc_global = vlc_global();
605 vlc_object_t *obj = NULL;
607 vlc_object_t *caller = vlc_threadobj ();
610 msg_Dbg (caller, "uses deprecated vlc_object_get(%d)", i_id);
612 fprintf (stderr, "main thread uses deprecated vlc_object_get(%d)\n",
615 vlc_mutex_lock( &structure_lock );
617 for( obj = vlc_internals (p_libvlc_global)->next;
618 obj != VLC_OBJECT (p_libvlc_global);
619 obj = vlc_internals (obj)->next )
621 if( obj->i_object_id == i_id )
623 vlc_object_yield( obj );
630 msg_Warn (caller, "wants non-existing object %d", i_id);
632 fprintf (stderr, "main thread wants non-existing object %d\n", i_id);
635 vlc_mutex_unlock( &structure_lock );
640 ****************************************************************************
641 * find a typed object and increment its refcount
642 *****************************************************************************
643 * This function recursively looks for a given object type. i_mode can be one
644 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
645 *****************************************************************************/
646 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
648 vlc_object_t *p_found;
650 /* If we are of the requested type ourselves, don't look further */
651 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
653 vlc_object_yield( p_this );
657 /* Otherwise, recursively look for the object */
658 if ((i_mode & 0x000f) == FIND_ANYWHERE)
661 if (i_type == VLC_OBJECT_PLAYLIST)
662 msg_Err (p_this, "using vlc_object_find(VLC_OBJECT_PLAYLIST) "
663 "instead of pl_Yield()");
665 return vlc_object_find (p_this->p_libvlc, i_type,
666 (i_mode & ~0x000f)|FIND_CHILD);
669 vlc_mutex_lock( &structure_lock );
670 p_found = FindObject( p_this, i_type, i_mode );
671 vlc_mutex_unlock( &structure_lock );
676 ****************************************************************************
677 * find a named object and increment its refcount
678 *****************************************************************************
679 * This function recursively looks for a given object name. i_mode can be one
680 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
681 *****************************************************************************/
682 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
685 vlc_object_t *p_found;
687 /* If have the requested name ourselves, don't look further */
688 if( !(i_mode & FIND_STRICT)
689 && p_this->psz_object_name
690 && !strcmp( p_this->psz_object_name, psz_name ) )
692 vlc_object_yield( p_this );
696 vlc_mutex_lock( &structure_lock );
698 /* Otherwise, recursively look for the object */
699 if( (i_mode & 0x000f) == FIND_ANYWHERE )
701 vlc_object_t *p_root = p_this;
704 while( p_root->p_parent != NULL &&
705 p_root != VLC_OBJECT( p_this->p_libvlc ) )
707 p_root = p_root->p_parent;
710 p_found = FindObjectName( p_root, psz_name,
711 (i_mode & ~0x000f)|FIND_CHILD );
712 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
714 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
715 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
720 p_found = FindObjectName( p_this, psz_name, i_mode );
723 vlc_mutex_unlock( &structure_lock );
729 * Increment an object reference counter.
731 void __vlc_object_yield( vlc_object_t *p_this )
733 vlc_object_internals_t *internals = vlc_internals( p_this );
735 vlc_spin_lock( &internals->ref_spin );
736 /* Avoid obvious freed object uses */
737 assert( internals->i_refcount > 0 );
738 /* Increment the counter */
739 internals->i_refcount++;
740 vlc_spin_unlock( &internals->ref_spin );
741 #ifdef LIBVLC_REFCHECK
742 /* Update the list of referenced objects */
743 /* Using TLS, so no need to lock */
744 /* The following line may leak memory if a thread leaks objects. */
745 held_list_t *newhead = malloc (sizeof (*newhead));
746 held_list_t *oldhead = vlc_threadvar_get (&held_objects);
747 newhead->next = oldhead;
748 newhead->obj = p_this;
749 vlc_threadvar_set (&held_objects, newhead);
753 /*****************************************************************************
754 * decrement an object refcount
755 * And destroy the object if its refcount reach zero.
756 *****************************************************************************/
757 void __vlc_object_release( vlc_object_t *p_this )
759 vlc_object_internals_t *internals = vlc_internals( p_this );
760 bool b_should_destroy;
762 #ifdef LIBVLC_REFCHECK
763 /* Update the list of referenced objects */
764 /* Using TLS, so no need to lock */
765 for (held_list_t *hlcur = vlc_threadvar_get (&held_objects),
768 hlprev = hlcur, hlcur = hlcur->next)
770 if (hlcur->obj == p_this)
773 vlc_threadvar_set (&held_objects, hlcur->next);
775 hlprev->next = hlcur->next;
780 /* TODO: what if releasing without references? */
783 vlc_spin_lock( &internals->ref_spin );
784 assert( internals->i_refcount > 0 );
786 if( internals->i_refcount > 1 )
789 /* There are still other references to the object */
790 internals->i_refcount--;
791 vlc_spin_unlock( &internals->ref_spin );
794 vlc_spin_unlock( &internals->ref_spin );
797 /* Remember that we cannot hold the spin while waiting on the mutex */
798 vlc_mutex_lock( &structure_lock );
799 /* Take the spin again. Note that another thread may have yielded the
800 * object in the (very short) mean time. */
801 vlc_spin_lock( &internals->ref_spin );
802 b_should_destroy = --internals->i_refcount == 0;
803 vlc_spin_unlock( &internals->ref_spin );
805 if( b_should_destroy )
807 /* Remove the object from object list
808 * so that it cannot be encountered by vlc_object_get() */
809 vlc_internals (internals->next)->prev = internals->prev;
810 vlc_internals (internals->prev)->next = internals->next;
812 /* Detach from parent to protect against FIND_CHILDREN */
813 vlc_object_detach_unlocked (p_this);
814 /* Detach from children to protect against FIND_PARENT */
815 for (int i = 0; i < internals->i_children; i++)
816 internals->pp_children[i]->p_parent = NULL;
819 vlc_mutex_unlock( &structure_lock );
821 if( b_should_destroy )
823 free( internals->pp_children );
824 internals->pp_children = NULL;
825 internals->i_children = 0;
826 vlc_object_destroy( p_this );
831 ****************************************************************************
832 * attach object to a parent object
833 *****************************************************************************
834 * This function sets p_this as a child of p_parent, and p_parent as a parent
835 * of p_this. This link can be undone using vlc_object_detach.
836 *****************************************************************************/
837 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
839 if( !p_this ) return;
841 vlc_mutex_lock( &structure_lock );
843 /* Attach the parent to its child */
844 assert (!p_this->p_parent);
845 p_this->p_parent = p_parent;
847 /* Attach the child to its parent */
848 vlc_object_internals_t *priv = vlc_internals( p_parent );
849 INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
852 vlc_mutex_unlock( &structure_lock );
856 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
858 vlc_assert_locked (&structure_lock);
860 if (p_this->p_parent == NULL)
863 vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
867 /* Remove p_this's parent */
868 p_this->p_parent = NULL;
870 /* Remove all of p_parent's children which are p_this */
871 for( i_index = priv->i_children ; i_index-- ; )
873 if( priv->pp_children[i_index] == p_this )
876 for( i = i_index ; i < priv->i_children ; i++ )
877 priv->pp_children[i] = priv->pp_children[i+1];
881 if( priv->i_children )
883 priv->pp_children = (vlc_object_t **)realloc( priv->pp_children,
884 priv->i_children * sizeof(vlc_object_t *) );
888 /* Special case - don't realloc() to zero to avoid leaking */
889 free( priv->pp_children );
890 priv->pp_children = NULL;
896 ****************************************************************************
897 * detach object from its parent
898 *****************************************************************************
899 * This function removes all links between an object and its parent.
900 *****************************************************************************/
901 void __vlc_object_detach( vlc_object_t *p_this )
903 if( !p_this ) return;
905 vlc_mutex_lock( &structure_lock );
906 if( !p_this->p_parent )
907 msg_Err( p_this, "object is not attached" );
909 vlc_object_detach_unlocked( p_this );
910 vlc_mutex_unlock( &structure_lock );
915 ****************************************************************************
916 * find a list typed objects and increment their refcount
917 *****************************************************************************
918 * This function recursively looks for a given object type. i_mode can be one
919 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
920 *****************************************************************************/
921 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
926 /* Look for the objects */
927 switch( i_mode & 0x000f )
930 /* Modules should probably not be object, and the module should perhaps
931 * not be shared across LibVLC instances. In the mean time, this ugly
932 * hack is brought to you by Courmisch. */
933 if (i_type == VLC_OBJECT_MODULE)
934 return vlc_list_find ((vlc_object_t *)vlc_global ()->p_module_bank,
936 return vlc_list_find (p_this->p_libvlc, i_type, FIND_CHILD);
939 vlc_mutex_lock( &structure_lock );
940 i_count = CountChildren( p_this, i_type );
941 p_list = NewList( i_count );
943 /* Check allocation was successful */
944 if( p_list->i_count != i_count )
946 vlc_mutex_unlock( &structure_lock );
947 msg_Err( p_this, "list allocation failed!" );
953 ListChildren( p_list, p_this, i_type );
954 vlc_mutex_unlock( &structure_lock );
958 msg_Err( p_this, "unimplemented!" );
959 p_list = NewList( 0 );
967 * Gets the list of children of an objects, and increment their reference
969 * @return a list (possibly empty) or NULL in case of error.
971 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
974 vlc_object_internals_t *priv = vlc_internals( obj );
976 vlc_mutex_lock( &structure_lock );
977 l = NewList( priv->i_children );
978 for (int i = 0; i < l->i_count; i++)
980 vlc_object_yield( priv->pp_children[i] );
981 l->p_values[i].p_object = priv->pp_children[i];
983 vlc_mutex_unlock( &structure_lock );
987 /*****************************************************************************
988 * DumpCommand: print the current vlc structure
989 *****************************************************************************
990 * This function prints either an ASCII tree showing the connections between
991 * vlc objects, and additional information such as their refcount, thread ID,
992 * etc. (command "tree"), or the same data as a simple list (command "list").
993 *****************************************************************************/
994 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
995 vlc_value_t oldval, vlc_value_t newval, void *p_data )
997 (void)oldval; (void)p_data;
998 if( *psz_cmd == 'l' )
1000 vlc_object_t *root = VLC_OBJECT (vlc_global ()), *cur = root;
1002 vlc_mutex_lock( &structure_lock );
1005 PrintObject (cur, "");
1006 cur = vlc_internals (cur)->next;
1008 while (cur != root);
1009 vlc_mutex_unlock( &structure_lock );
1013 vlc_object_t *p_object = NULL;
1015 if( *newval.psz_string )
1018 int i_id = strtol( newval.psz_string, &end, 0 );
1019 if( end != newval.psz_string )
1020 p_object = vlc_object_get( i_id );
1022 /* try using the object's name to find it */
1023 p_object = vlc_object_find_name( p_this, newval.psz_string,
1032 vlc_mutex_lock( &structure_lock );
1034 if( *psz_cmd == 't' )
1036 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1039 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1042 DumpStructure( p_object, 0, psz_foo );
1044 else if( *psz_cmd == 'v' )
1049 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1051 PrintObject( p_object, "" );
1053 if( !vlc_internals( p_object )->i_vars )
1054 printf( " `-o No variables\n" );
1055 for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
1057 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
1059 const char *psz_type = "unknown";
1060 switch( p_var->i_type & VLC_VAR_TYPE )
1062 #define MYCASE( type, nice ) \
1063 case VLC_VAR_ ## type: \
1066 MYCASE( VOID, "void" );
1067 MYCASE( BOOL, "bool" );
1068 MYCASE( INTEGER, "integer" );
1069 MYCASE( HOTKEY, "hotkey" );
1070 MYCASE( STRING, "string" );
1071 MYCASE( MODULE, "module" );
1072 MYCASE( FILE, "file" );
1073 MYCASE( DIRECTORY, "directory" );
1074 MYCASE( VARIABLE, "variable" );
1075 MYCASE( FLOAT, "float" );
1076 MYCASE( TIME, "time" );
1077 MYCASE( ADDRESS, "address" );
1078 MYCASE( MUTEX, "mutex" );
1079 MYCASE( LIST, "list" );
1082 printf( " %c-o \"%s\" (%s",
1083 i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
1084 p_var->psz_name, psz_type );
1085 if( p_var->psz_text )
1086 printf( ", %s", p_var->psz_text );
1088 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1089 printf( ", command" );
1090 if( p_var->i_entries )
1091 printf( ", %d callbacks", p_var->i_entries );
1092 switch( p_var->i_type & 0x00f0 )
1098 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1100 case VLC_VAR_INTEGER:
1101 printf( ": %d", p_var->val.i_int );
1103 case VLC_VAR_STRING:
1104 printf( ": \"%s\"", p_var->val.psz_string );
1107 printf( ": %f", p_var->val.f_float );
1110 printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
1112 case VLC_VAR_ADDRESS:
1113 printf( ": %p", p_var->val.p_address );
1123 vlc_mutex_unlock( &structure_lock );
1125 if( *newval.psz_string )
1127 vlc_object_release( p_object );
1134 /*****************************************************************************
1135 * vlc_list_release: free a list previously allocated by vlc_list_find
1136 *****************************************************************************
1137 * This function decreases the refcount of all objects in the list and
1139 *****************************************************************************/
1140 void vlc_list_release( vlc_list_t *p_list )
1144 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1146 vlc_object_release( p_list->p_values[i_index].p_object );
1149 free( p_list->p_values );
1153 /*****************************************************************************
1154 * dump an object. (Debug function)
1155 *****************************************************************************/
1156 void __vlc_object_dump( vlc_object_t *p_this )
1158 vlc_mutex_lock( &structure_lock );
1159 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1161 DumpStructure( p_this, 0, psz_foo );
1162 vlc_mutex_unlock( &structure_lock );
1165 /* Following functions are local */
1167 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1170 vlc_object_t *p_tmp;
1172 switch( i_mode & 0x000f )
1175 p_tmp = p_this->p_parent;
1178 if( p_tmp->i_object_type == i_type )
1180 vlc_object_yield( p_tmp );
1185 return FindObject( p_tmp, i_type, i_mode );
1191 for( i = vlc_internals( p_this )->i_children; i--; )
1193 p_tmp = vlc_internals( p_this )->pp_children[i];
1194 if( p_tmp->i_object_type == i_type )
1196 vlc_object_yield( p_tmp );
1199 else if( vlc_internals( p_tmp )->i_children )
1201 p_tmp = FindObject( p_tmp, i_type, i_mode );
1211 /* Handled in vlc_object_find */
1218 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1219 const char *psz_name,
1223 vlc_object_t *p_tmp;
1225 switch( i_mode & 0x000f )
1228 p_tmp = p_this->p_parent;
1231 if( p_tmp->psz_object_name
1232 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1234 vlc_object_yield( p_tmp );
1239 return FindObjectName( p_tmp, psz_name, i_mode );
1245 for( i = vlc_internals( p_this )->i_children; i--; )
1247 p_tmp = vlc_internals( p_this )->pp_children[i];
1248 if( p_tmp->psz_object_name
1249 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1251 vlc_object_yield( p_tmp );
1254 else if( vlc_internals( p_tmp )->i_children )
1256 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1266 /* Handled in vlc_object_find */
1274 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1276 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1279 memset( &psz_name, 0, sizeof(psz_name) );
1280 if( p_this->psz_object_name )
1282 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1284 psz_name[48] = '\"';
1287 psz_children[0] = '\0';
1288 switch( vlc_internals( p_this )->i_children )
1293 strcpy( psz_children, ", 1 child" );
1296 snprintf( psz_children, 19, ", %i children",
1297 vlc_internals( p_this )->i_children );
1301 psz_refcount[0] = '\0';
1302 if( vlc_internals( p_this )->i_refcount > 0 )
1303 snprintf( psz_refcount, 19, ", refcount %u",
1304 vlc_internals( p_this )->i_refcount );
1306 psz_thread[0] = '\0';
1307 if( vlc_internals( p_this )->b_thread )
1308 snprintf( psz_thread, 29, " (thread %lu)",
1309 (unsigned long)vlc_internals( p_this )->thread_id );
1311 psz_parent[0] = '\0';
1312 if( p_this->p_parent )
1313 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1315 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1316 p_this->i_object_id, p_this->psz_object_type,
1317 psz_name, psz_thread, psz_refcount, psz_children,
1321 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1324 char i_back = psz_foo[i_level];
1325 psz_foo[i_level] = '\0';
1327 PrintObject( p_this, psz_foo );
1329 psz_foo[i_level] = i_back;
1331 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1333 msg_Warn( p_this, "structure tree is too deep" );
1337 for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
1341 psz_foo[i_level-1] = ' ';
1343 if( psz_foo[i_level-2] == '`' )
1345 psz_foo[i_level-2] = ' ';
1349 if( i == vlc_internals( p_this )->i_children - 1 )
1351 psz_foo[i_level] = '`';
1355 psz_foo[i_level] = '|';
1358 psz_foo[i_level+1] = '-';
1359 psz_foo[i_level+2] = '\0';
1361 DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
1366 static vlc_list_t * NewList( int i_count )
1368 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1369 if( p_list == NULL )
1374 p_list->i_count = i_count;
1378 p_list->p_values = NULL;
1382 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1383 if( p_list->p_values == NULL )
1385 p_list->i_count = 0;
1392 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1395 if( p_list == NULL || i_index >= p_list->i_count )
1400 vlc_object_yield( p_object );
1402 p_list->p_values[i_index].p_object = p_object;
1407 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1409 if( p_list == NULL )
1414 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1415 * sizeof( vlc_value_t ) );
1416 if( p_list->p_values == NULL )
1418 p_list->i_count = 0;
1422 vlc_object_yield( p_object );
1424 p_list->p_values[p_list->i_count].p_object = p_object;
1430 static int CountChildren( vlc_object_t *p_this, int i_type )
1432 vlc_object_t *p_tmp;
1435 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1437 p_tmp = vlc_internals( p_this )->pp_children[i];
1439 if( p_tmp->i_object_type == i_type )
1443 i_count += CountChildren( p_tmp, i_type );
1449 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1451 vlc_object_t *p_tmp;
1454 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1456 p_tmp = vlc_internals( p_this )->pp_children[i];
1458 if( p_tmp->i_object_type == i_type )
1459 ListReplace( p_list, p_tmp, p_list->i_count++ );
1461 ListChildren( p_list, p_tmp, i_type );
1465 #ifdef LIBVLC_REFCHECK
1466 # if defined(HAVE_EXECINFO_H) && defined(HAVE_BACKTRACE)
1467 # include <execinfo.h>
1470 void vlc_refcheck (vlc_object_t *obj)
1472 static unsigned errors = 0;
1476 /* Anyone can use the root object (though it should not exist) */
1477 if (obj == VLC_OBJECT (vlc_global ()))
1480 /* Anyone can use its libvlc instance object */
1481 if (obj == VLC_OBJECT (obj->p_libvlc))
1484 /* The thread that created the object holds the initial reference */
1485 vlc_object_internals_t *priv = vlc_internals (obj);
1486 #if defined (LIBVLC_USE_PTHREAD)
1487 if (pthread_equal (priv->creator_id, pthread_self ()))
1489 if (priv->creator_id == GetCurrentThreadId ())
1495 /* A thread can use its own object without references! */
1496 vlc_object_t *caller = vlc_threadobj ();
1500 /* The calling thread is younger than the object.
1501 * Access could be valid through cross-thread synchronization;
1502 * we would need better accounting. */
1503 if (caller && (caller->i_object_id > obj->i_object_id))
1507 vlc_spin_lock (&priv->ref_spin);
1508 refs = priv->i_refcount;
1509 vlc_spin_unlock (&priv->ref_spin);
1511 for (held_list_t *hlcur = vlc_threadvar_get (&held_objects);
1512 hlcur != NULL; hlcur = hlcur->next)
1513 if (hlcur->obj == obj)
1516 fprintf (stderr, "The %s %s thread object is accessing...\n"
1517 "the %s %s object without references.\n",
1518 caller && caller->psz_object_name
1519 ? caller->psz_object_name : "unnamed",
1520 caller ? caller->psz_object_type : "main",
1521 obj->psz_object_name ? obj->psz_object_name : "unnamed",
1522 obj->psz_object_type);
1525 #ifdef HAVE_BACKTRACE
1527 int stackdepth = backtrace (stack, sizeof (stack) / sizeof (stack[0]));
1528 backtrace_symbols_fd (stack, stackdepth, 2);
1531 if (++errors == 100)
1532 fprintf (stderr, "Too many reference errors!\n");
1535 static void held_objects_destroy (void *data)
1538 held_list_t *hl = vlc_threadvar_get (&held_objects);
1539 vlc_object_t *caller = vlc_threadobj ();
1543 held_list_t *buf = hl->next;
1544 vlc_object_t *obj = hl->obj;
1546 fprintf (stderr, "The %s %s thread object leaked a reference to...\n"
1547 "the %s %s object.\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);