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);
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 );
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_new->object_lock );
180 vlc_cond_init( p_new, &p_new->object_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);
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_LIBVLC:
230 i_size = sizeof(libvlc_int_t);
233 case VLC_OBJECT_INTF:
234 i_size = sizeof(intf_thread_t);
235 psz_type = "interface";
237 case VLC_OBJECT_DIALOGS:
238 i_size = sizeof(intf_thread_t);
239 psz_type = "dialogs";
241 case VLC_OBJECT_DEMUX:
242 i_size = sizeof(demux_t);
245 case VLC_OBJECT_ACCESS:
246 i_size = sizeof(access_t);
249 case VLC_OBJECT_DECODER:
250 i_size = sizeof(decoder_t);
251 psz_type = "decoder";
253 case VLC_OBJECT_PACKETIZER:
254 i_size = sizeof(decoder_t);
255 psz_type = "packetizer";
257 case VLC_OBJECT_ENCODER:
258 i_size = sizeof(encoder_t);
259 psz_type = "encoder";
261 case VLC_OBJECT_FILTER:
262 i_size = sizeof(filter_t);
265 case VLC_OBJECT_VOUT:
266 i_size = sizeof(vout_thread_t);
267 psz_type = "video output";
269 case VLC_OBJECT_AOUT:
270 i_size = sizeof(aout_instance_t);
271 psz_type = "audio output";
273 case VLC_OBJECT_SOUT:
274 i_size = sizeof(sout_instance_t);
275 psz_type = "stream output";
277 case VLC_OBJECT_OPENGL:
278 i_size = sizeof( vout_thread_t );
281 case VLC_OBJECT_ANNOUNCE:
282 i_size = sizeof( announce_handler_t );
283 psz_type = "announce";
285 case VLC_OBJECT_INTERACTION:
286 i_size = sizeof( interaction_t );
287 psz_type = "interaction";
290 i_size = i_type > (int)sizeof(vlc_object_t)
291 ? i_type : (int)sizeof(vlc_object_t);
292 i_type = VLC_OBJECT_GENERIC;
293 psz_type = "generic";
297 return vlc_custom_create( p_this, i_size, i_type, psz_type );
302 ****************************************************************************
303 * Set the destructor of a vlc object
305 * This function sets the destructor of the vlc object. It will be called
306 * when the object is destroyed when the its refcount reaches 0.
307 * (It is called by the internal function vlc_object_destroy())
308 *****************************************************************************/
309 void __vlc_object_set_destructor( vlc_object_t *p_this,
310 vlc_destructor_t pf_destructor )
312 vlc_object_internals_t *p_priv = vlc_internals(p_this );
313 p_priv->pf_destructor = pf_destructor;
317 ****************************************************************************
318 * Destroy a vlc object (Internal)
320 * This function destroys an object that has been previously allocated with
321 * vlc_object_create. The object's refcount must be zero and it must not be
322 * attached to other objects in any way.
323 *****************************************************************************/
324 static void vlc_object_destroy( vlc_object_t *p_this )
326 vlc_object_internals_t *p_priv = vlc_internals( p_this );
328 /* Objects are always detached beforehand */
329 assert( !p_this->p_parent );
331 /* Send a kill to the object's thread if applicable */
332 vlc_object_kill( p_this );
334 /* If we are running on a thread, wait until it ends */
335 if( p_priv->b_thread )
336 vlc_thread_join( p_this );
338 /* Call the custom "subclass" destructor */
339 if( p_priv->pf_destructor )
340 p_priv->pf_destructor( p_this );
342 /* Destroy the associated variables, starting from the end so that
343 * no memmove calls have to be done. */
344 while( p_priv->i_vars )
346 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
349 free( p_priv->p_vars );
350 vlc_mutex_destroy( &p_priv->var_lock );
352 free( p_this->psz_header );
354 if( p_this->p_libvlc == NULL )
356 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
359 assert( p_global == vlc_global() );
361 if (p_priv->next != p_this)
363 vlc_object_t *leaked = p_priv->next, *first = leaked;
366 /* We are leaking this object */
368 "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
369 leaked->i_object_id, leaked->psz_object_type,
370 leaked->psz_object_name );
371 /* Dump libvlc object to ease debugging */
372 vlc_object_dump( leaked );
374 leaked = vlc_internals (leaked)->next;
376 while (leaked != first);
378 /* Dump global object to ease debugging */
379 vlc_object_dump( p_this );
380 /* Strongly abort, cause we want these to be fixed */
385 /* We are the global object ... no need to lock. */
386 vlc_mutex_destroy( &structure_lock );
388 held_objects_destroy( vlc_threadvar_get( &held_objects ) );
389 vlc_threadvar_delete( &held_objects );
393 FREENULL( p_this->psz_object_name );
395 #if defined(WIN32) || defined(UNDER_CE)
396 /* if object has an associated thread, close it now */
397 if( p_priv->thread_id )
398 CloseHandle(p_priv->thread_id);
401 vlc_spin_destroy( &p_priv->ref_spin );
402 vlc_mutex_destroy( &p_this->object_lock );
403 vlc_cond_destroy( &p_this->object_wait );
404 vlc_spin_destroy( &p_priv->spin );
405 if( p_priv->pipes[1] != -1 )
406 close( p_priv->pipes[1] );
407 if( p_priv->pipes[0] != -1 )
408 close( p_priv->pipes[0] );
414 /** Inter-object signaling */
416 void __vlc_object_lock( vlc_object_t *obj )
418 vlc_mutex_lock( &obj->object_lock );
421 void __vlc_object_unlock( vlc_object_t *obj )
423 vlc_assert_locked( &obj->object_lock );
424 vlc_mutex_unlock( &obj->object_lock );
428 # include <winsock2.h>
429 # include <ws2tcpip.h>
432 * select()-able pipes emulated using Winsock
434 static int pipe (int fd[2])
437 int addrlen = sizeof (addr);
439 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
440 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
441 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
444 memset (&addr, 0, sizeof (addr));
445 addr.sin_family = AF_INET;
446 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
447 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
448 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
450 || connect (c, (PSOCKADDR)&addr, addrlen))
453 a = accept (l, NULL, NULL);
454 if (a == INVALID_SOCKET)
465 if (l != INVALID_SOCKET)
467 if (c != INVALID_SOCKET)
473 #define read( a, b, c ) recv (a, b, c, 0)
475 #define write( a, b, c ) send (a, b, c, 0)
477 #define close( a ) closesocket (a)
481 * Returns the readable end of a pipe that becomes readable once termination
482 * of the object is requested (vlc_object_kill()).
483 * This can be used to wake-up out of a select() or poll() event loop, such
484 * typically when doing network I/O.
486 * Note that the pipe will remain the same for the lifetime of the object.
487 * DO NOT read the pipe nor close it yourself. Ever.
489 * @param obj object that would be "killed"
490 * @return a readable pipe descriptor, or -1 on error.
492 int __vlc_object_waitpipe( vlc_object_t *obj )
494 int pfd[2] = { -1, -1 };
495 vlc_object_internals_t *internals = vlc_internals( obj );
498 vlc_spin_lock (&internals->spin);
499 if (internals->pipes[0] == -1)
501 /* This can only ever happen if someone killed us without locking: */
502 assert (internals->pipes[1] == -1);
503 vlc_spin_unlock (&internals->spin);
508 vlc_spin_lock (&internals->spin);
509 if (internals->pipes[0] == -1)
511 internals->pipes[0] = pfd[0];
512 internals->pipes[1] = pfd[1];
513 pfd[0] = pfd[1] = -1;
517 vlc_spin_unlock (&internals->spin);
521 /* Race condition: vlc_object_kill() already invoked! */
524 vlc_spin_lock (&internals->spin);
525 fd = internals->pipes[1];
526 internals->pipes[1] = -1;
527 vlc_spin_unlock (&internals->spin);
529 msg_Dbg (obj, "waitpipe: object already dying");
534 /* Race condition: two threads call pipe() - unlikely */
540 return internals->pipes[0];
545 * Waits for the object to be signaled (using vlc_object_signal()).
546 * It is assumed that the caller has locked the object. This function will
547 * unlock the object, and lock it again before returning.
548 * If the object was signaled before the caller locked the object, it is
549 * undefined whether the signal will be lost or will wake the process.
551 * @return true if the object is dying and should terminate.
553 void __vlc_object_wait( vlc_object_t *obj )
555 vlc_assert_locked( &obj->object_lock );
556 vlc_cond_wait( &obj->object_wait, &obj->object_lock );
561 * Waits for the object to be signaled (using vlc_object_signal()), or for
562 * a timer to expire. It is asserted that the caller holds the object lock.
564 * @return 0 if the object was signaled before the timer expiration, or
565 * ETIMEDOUT if the timer expired without any signal.
567 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
569 vlc_assert_locked( &obj->object_lock );
570 return vlc_cond_timedwait( &obj->object_wait, &obj->object_lock, deadline );
575 * Checks whether an object has been "killed".
576 * The object lock must be held.
578 * Typical code for an object thread could be:
580 vlc_object_lock (self);
582 while (vlc_object_alive (self))
586 vlc_object_wait (self);
590 ...deinitialization...
591 vlc_object_unlock (self);
594 * @return true iff the object has not been killed yet
596 bool __vlc_object_alive( vlc_object_t *obj )
598 vlc_assert_locked( &obj->object_lock );
604 * Signals an object for which the lock is held.
605 * At least one thread currently sleeping in vlc_object_wait() or
606 * vlc_object_timedwait() will wake up, assuming that there is at least one
607 * such thread in the first place. Otherwise, it is undefined whether the
608 * signal will be lost or will wake up one or more thread later.
610 void __vlc_object_signal_unlocked( vlc_object_t *obj )
612 vlc_assert_locked (&obj->object_lock);
613 vlc_cond_signal( &obj->object_wait );
618 * Requests termination of an object.
619 * If the object is LibVLC, also request to terminate all its children.
621 void __vlc_object_kill( vlc_object_t *p_this )
623 vlc_object_internals_t *internals = vlc_internals( p_this );
626 vlc_mutex_lock( &p_this->object_lock );
627 p_this->b_die = true;
629 vlc_spin_lock (&internals->spin);
630 fd = internals->pipes[1];
631 internals->pipes[1] = -1;
632 vlc_spin_unlock (&internals->spin);
636 msg_Dbg (p_this, "waitpipe: object killed");
640 vlc_object_signal_unlocked( p_this );
641 vlc_mutex_unlock( &p_this->object_lock );
643 if (p_this->i_object_type == VLC_OBJECT_LIBVLC)
645 vlc_list_t *children = vlc_list_children (p_this);
646 for (int i = 0; i < children->i_count; i++)
647 vlc_object_kill (children->p_values[i].p_object);
648 vlc_list_release (children);
654 * Find an object given its ID.
656 * This function looks for the object whose i_object_id field is i_id.
657 * This function is slow, and often used to hide bugs. Do not use it.
658 * If you need to retain reference to an object, yield the object pointer with
659 * vlc_object_yield(), use the pointer as your reference, and call
660 * vlc_object_release() when you're done.
662 void * vlc_object_get( int i_id )
664 libvlc_global_data_t *p_libvlc_global = vlc_global();
665 vlc_object_t *obj = NULL;
666 vlc_object_t *caller = vlc_threadobj ();
669 msg_Dbg (caller, "uses deprecated vlc_object_get(%d)", i_id);
671 fprintf (stderr, "main thread uses deprecated vlc_object_get(%d)\n",
674 vlc_mutex_lock( &structure_lock );
676 for( obj = vlc_internals (p_libvlc_global)->next;
677 obj != VLC_OBJECT (p_libvlc_global);
678 obj = vlc_internals (obj)->next )
680 if( obj->i_object_id == i_id )
682 vlc_object_yield( obj );
688 msg_Warn (caller, "wants non-existing object %d", i_id);
690 fprintf (stderr, "main thread wants non-existing object %d\n", i_id);
692 vlc_mutex_unlock( &structure_lock );
697 ****************************************************************************
698 * find a typed object and increment its refcount
699 *****************************************************************************
700 * This function recursively looks for a given object type. i_mode can be one
701 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
702 *****************************************************************************/
703 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
705 vlc_object_t *p_found;
707 /* If we are of the requested type ourselves, don't look further */
708 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
710 vlc_object_yield( p_this );
714 /* Otherwise, recursively look for the object */
715 if ((i_mode & 0x000f) == FIND_ANYWHERE)
718 if (i_type == VLC_OBJECT_PLAYLIST)
719 msg_Warn (p_this, "using vlc_object_find(VLC_OBJECT_PLAYLIST) "
720 "instead of pl_Yield()");
722 return vlc_object_find (p_this->p_libvlc, i_type,
723 (i_mode & ~0x000f)|FIND_CHILD);
726 vlc_mutex_lock( &structure_lock );
727 p_found = FindObject( p_this, i_type, i_mode );
728 vlc_mutex_unlock( &structure_lock );
733 ****************************************************************************
734 * find a named object and increment its refcount
735 *****************************************************************************
736 * This function recursively looks for a given object name. i_mode can be one
737 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
738 *****************************************************************************/
739 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
742 vlc_object_t *p_found;
744 /* If have the requested name ourselves, don't look further */
745 if( !(i_mode & FIND_STRICT)
746 && p_this->psz_object_name
747 && !strcmp( p_this->psz_object_name, psz_name ) )
749 vlc_object_yield( p_this );
753 vlc_mutex_lock( &structure_lock );
755 /* Otherwise, recursively look for the object */
756 if( (i_mode & 0x000f) == FIND_ANYWHERE )
758 vlc_object_t *p_root = p_this;
761 while( p_root->p_parent != NULL &&
762 p_root != VLC_OBJECT( p_this->p_libvlc ) )
764 p_root = p_root->p_parent;
767 p_found = FindObjectName( p_root, psz_name,
768 (i_mode & ~0x000f)|FIND_CHILD );
769 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
771 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
772 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
777 p_found = FindObjectName( p_this, psz_name, i_mode );
780 vlc_mutex_unlock( &structure_lock );
786 * Increment an object reference counter.
788 void __vlc_object_yield( vlc_object_t *p_this )
790 vlc_object_internals_t *internals = vlc_internals( p_this );
792 vlc_spin_lock( &internals->ref_spin );
793 /* Avoid obvious freed object uses */
794 assert( internals->i_refcount > 0 );
795 /* Increment the counter */
796 internals->i_refcount++;
797 vlc_spin_unlock( &internals->ref_spin );
799 /* Update the list of referenced objects */
800 /* Using TLS, so no need to lock */
801 /* The following line may leak memory if a thread leaks objects. */
802 held_list_t *newhead = malloc (sizeof (*newhead));
803 held_list_t *oldhead = vlc_threadvar_get (&held_objects);
804 newhead->next = oldhead;
805 newhead->obj = p_this;
806 vlc_threadvar_set (&held_objects, newhead);
810 /*****************************************************************************
811 * decrement an object refcount
812 * And destroy the object if its refcount reach zero.
813 *****************************************************************************/
814 void __vlc_object_release( vlc_object_t *p_this )
816 vlc_object_internals_t *internals = vlc_internals( p_this );
817 bool b_should_destroy;
820 /* Update the list of referenced objects */
821 /* Using TLS, so no need to lock */
822 for (held_list_t *hlcur = vlc_threadvar_get (&held_objects),
825 hlprev = hlcur, hlcur = hlcur->next)
827 if (hlcur->obj == p_this)
830 vlc_threadvar_set (&held_objects, hlcur->next);
832 hlprev->next = hlcur->next;
837 /* TODO: what if releasing without references? */
840 vlc_spin_lock( &internals->ref_spin );
841 assert( internals->i_refcount > 0 );
843 if( internals->i_refcount > 1 )
846 /* There are still other references to the object */
847 internals->i_refcount--;
848 vlc_spin_unlock( &internals->ref_spin );
851 vlc_spin_unlock( &internals->ref_spin );
854 /* Remember that we cannot hold the spin while waiting on the mutex */
855 vlc_mutex_lock( &structure_lock );
856 /* Take the spin again. Note that another thread may have yielded the
857 * object in the (very short) mean time. */
858 vlc_spin_lock( &internals->ref_spin );
859 b_should_destroy = --internals->i_refcount == 0;
860 vlc_spin_unlock( &internals->ref_spin );
862 if( b_should_destroy )
864 /* Remove the object from object list
865 * so that it cannot be encountered by vlc_object_get() */
866 vlc_internals (internals->next)->prev = internals->prev;
867 vlc_internals (internals->prev)->next = internals->next;
869 /* Detach from parent to protect against FIND_CHILDREN */
870 vlc_object_detach_unlocked (p_this);
871 /* Detach from children to protect against FIND_PARENT */
872 for (int i = 0; i < internals->i_children; i++)
873 internals->pp_children[i]->p_parent = NULL;
876 vlc_mutex_unlock( &structure_lock );
878 if( b_should_destroy )
880 free( internals->pp_children );
881 internals->pp_children = NULL;
882 internals->i_children = 0;
883 vlc_object_destroy( p_this );
888 ****************************************************************************
889 * attach object to a parent object
890 *****************************************************************************
891 * This function sets p_this as a child of p_parent, and p_parent as a parent
892 * of p_this. This link can be undone using vlc_object_detach.
893 *****************************************************************************/
894 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
896 if( !p_this ) return;
898 vlc_mutex_lock( &structure_lock );
900 /* Attach the parent to its child */
901 assert (!p_this->p_parent);
902 p_this->p_parent = p_parent;
904 /* Attach the child to its parent */
905 vlc_object_internals_t *priv = vlc_internals( p_parent );
906 INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
909 /* Kill the object if parent is already dead.
910 * Note: We should surely lock parent here, but that would
911 * create quite a few dead lock case. Hopefully, it
912 * is perfectly safe to do it that way. We only risk
913 * receiving kill event twice. But given current API
915 if( p_this->p_parent->b_die )
916 vlc_object_kill( p_this );
918 vlc_mutex_unlock( &structure_lock );
922 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
924 vlc_assert_locked (&structure_lock);
926 if (p_this->p_parent == NULL)
929 vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
933 /* Remove p_this's parent */
934 p_this->p_parent = NULL;
936 /* Remove all of p_parent's children which are p_this */
937 for( i_index = priv->i_children ; i_index-- ; )
939 if( priv->pp_children[i_index] == p_this )
942 for( i = i_index ; i < priv->i_children ; i++ )
943 priv->pp_children[i] = priv->pp_children[i+1];
947 if( priv->i_children )
949 priv->pp_children = (vlc_object_t **)realloc( priv->pp_children,
950 priv->i_children * sizeof(vlc_object_t *) );
954 /* Special case - don't realloc() to zero to avoid leaking */
955 free( priv->pp_children );
956 priv->pp_children = NULL;
962 ****************************************************************************
963 * detach object from its parent
964 *****************************************************************************
965 * This function removes all links between an object and its parent.
966 *****************************************************************************/
967 void __vlc_object_detach( vlc_object_t *p_this )
969 if( !p_this ) return;
971 vlc_mutex_lock( &structure_lock );
972 if( !p_this->p_parent )
973 msg_Err( p_this, "object is not attached" );
975 vlc_object_detach_unlocked( p_this );
976 vlc_mutex_unlock( &structure_lock );
981 ****************************************************************************
982 * find a list typed objects and increment their refcount
983 *****************************************************************************
984 * This function recursively looks for a given object type. i_mode can be one
985 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
986 *****************************************************************************/
987 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
992 /* Look for the objects */
993 switch( i_mode & 0x000f )
996 /* Modules should probably not be object, and the module should perhaps
997 * not be shared across LibVLC instances. In the mean time, this ugly
998 * hack is brought to you by Courmisch. */
999 if (i_type == VLC_OBJECT_MODULE)
1000 return vlc_list_find ((vlc_object_t *)vlc_global ()->p_module_bank,
1001 i_type, FIND_CHILD);
1002 return vlc_list_find (p_this->p_libvlc, i_type, FIND_CHILD);
1005 vlc_mutex_lock( &structure_lock );
1006 i_count = CountChildren( p_this, i_type );
1007 p_list = NewList( i_count );
1009 /* Check allocation was successful */
1010 if( p_list->i_count != i_count )
1012 vlc_mutex_unlock( &structure_lock );
1013 msg_Err( p_this, "list allocation failed!" );
1014 p_list->i_count = 0;
1018 p_list->i_count = 0;
1019 ListChildren( p_list, p_this, i_type );
1020 vlc_mutex_unlock( &structure_lock );
1024 msg_Err( p_this, "unimplemented!" );
1025 p_list = NewList( 0 );
1033 * Gets the list of children of an objects, and increment their reference
1035 * @return a list (possibly empty) or NULL in case of error.
1037 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
1040 vlc_object_internals_t *priv = vlc_internals( obj );
1042 vlc_mutex_lock( &structure_lock );
1043 l = NewList( priv->i_children );
1044 for (int i = 0; i < l->i_count; i++)
1046 vlc_object_yield( priv->pp_children[i] );
1047 l->p_values[i].p_object = priv->pp_children[i];
1049 vlc_mutex_unlock( &structure_lock );
1053 /*****************************************************************************
1054 * DumpCommand: print the current vlc structure
1055 *****************************************************************************
1056 * This function prints either an ASCII tree showing the connections between
1057 * vlc objects, and additional information such as their refcount, thread ID,
1058 * etc. (command "tree"), or the same data as a simple list (command "list").
1059 *****************************************************************************/
1060 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
1061 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1063 (void)oldval; (void)p_data;
1064 if( *psz_cmd == 'l' )
1066 vlc_object_t *root = VLC_OBJECT (vlc_global ()), *cur = root;
1068 vlc_mutex_lock( &structure_lock );
1071 PrintObject (cur, "");
1072 cur = vlc_internals (cur)->next;
1074 while (cur != root);
1075 vlc_mutex_unlock( &structure_lock );
1079 vlc_object_t *p_object = NULL;
1081 if( *newval.psz_string )
1084 int i_id = strtol( newval.psz_string, &end, 0 );
1085 if( end != newval.psz_string )
1086 p_object = vlc_object_get( i_id );
1088 /* try using the object's name to find it */
1089 p_object = vlc_object_find_name( p_this, newval.psz_string,
1098 vlc_mutex_lock( &structure_lock );
1100 if( *psz_cmd == 't' )
1102 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1105 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1108 DumpStructure( p_object, 0, psz_foo );
1110 else if( *psz_cmd == 'v' )
1115 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1117 PrintObject( p_object, "" );
1119 if( !vlc_internals( p_object )->i_vars )
1120 printf( " `-o No variables\n" );
1121 for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
1123 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
1125 const char *psz_type = "unknown";
1126 switch( p_var->i_type & VLC_VAR_TYPE )
1128 #define MYCASE( type, nice ) \
1129 case VLC_VAR_ ## type: \
1132 MYCASE( VOID, "void" );
1133 MYCASE( BOOL, "bool" );
1134 MYCASE( INTEGER, "integer" );
1135 MYCASE( HOTKEY, "hotkey" );
1136 MYCASE( STRING, "string" );
1137 MYCASE( MODULE, "module" );
1138 MYCASE( FILE, "file" );
1139 MYCASE( DIRECTORY, "directory" );
1140 MYCASE( VARIABLE, "variable" );
1141 MYCASE( FLOAT, "float" );
1142 MYCASE( TIME, "time" );
1143 MYCASE( ADDRESS, "address" );
1144 MYCASE( MUTEX, "mutex" );
1145 MYCASE( LIST, "list" );
1148 printf( " %c-o \"%s\" (%s",
1149 i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
1150 p_var->psz_name, psz_type );
1151 if( p_var->psz_text )
1152 printf( ", %s", p_var->psz_text );
1154 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1155 printf( ", command" );
1156 if( p_var->i_entries )
1157 printf( ", %d callbacks", p_var->i_entries );
1158 switch( p_var->i_type & 0x00f0 )
1164 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1166 case VLC_VAR_INTEGER:
1167 printf( ": %d", p_var->val.i_int );
1169 case VLC_VAR_STRING:
1170 printf( ": \"%s\"", p_var->val.psz_string );
1173 printf( ": %f", p_var->val.f_float );
1176 printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
1178 case VLC_VAR_ADDRESS:
1179 printf( ": %p", p_var->val.p_address );
1189 vlc_mutex_unlock( &structure_lock );
1191 if( *newval.psz_string )
1193 vlc_object_release( p_object );
1200 /*****************************************************************************
1201 * vlc_list_release: free a list previously allocated by vlc_list_find
1202 *****************************************************************************
1203 * This function decreases the refcount of all objects in the list and
1205 *****************************************************************************/
1206 void vlc_list_release( vlc_list_t *p_list )
1210 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1212 vlc_object_release( p_list->p_values[i_index].p_object );
1215 free( p_list->p_values );
1219 /*****************************************************************************
1220 * dump an object. (Debug function)
1221 *****************************************************************************/
1222 void __vlc_object_dump( vlc_object_t *p_this )
1224 vlc_mutex_lock( &structure_lock );
1225 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1227 DumpStructure( p_this, 0, psz_foo );
1228 vlc_mutex_unlock( &structure_lock );
1231 /* Following functions are local */
1233 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1236 vlc_object_t *p_tmp;
1238 switch( i_mode & 0x000f )
1241 p_tmp = p_this->p_parent;
1244 if( p_tmp->i_object_type == i_type )
1246 vlc_object_yield( p_tmp );
1251 return FindObject( p_tmp, i_type, i_mode );
1257 for( i = vlc_internals( p_this )->i_children; i--; )
1259 p_tmp = vlc_internals( p_this )->pp_children[i];
1260 if( p_tmp->i_object_type == i_type )
1262 vlc_object_yield( p_tmp );
1265 else if( vlc_internals( p_tmp )->i_children )
1267 p_tmp = FindObject( p_tmp, i_type, i_mode );
1277 /* Handled in vlc_object_find */
1284 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1285 const char *psz_name,
1289 vlc_object_t *p_tmp;
1291 switch( i_mode & 0x000f )
1294 p_tmp = p_this->p_parent;
1297 if( p_tmp->psz_object_name
1298 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1300 vlc_object_yield( p_tmp );
1305 return FindObjectName( p_tmp, psz_name, i_mode );
1311 for( i = vlc_internals( p_this )->i_children; i--; )
1313 p_tmp = vlc_internals( p_this )->pp_children[i];
1314 if( p_tmp->psz_object_name
1315 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1317 vlc_object_yield( p_tmp );
1320 else if( vlc_internals( p_tmp )->i_children )
1322 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1332 /* Handled in vlc_object_find */
1340 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1342 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1345 memset( &psz_name, 0, sizeof(psz_name) );
1346 if( p_this->psz_object_name )
1348 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1350 psz_name[48] = '\"';
1353 psz_children[0] = '\0';
1354 switch( vlc_internals( p_this )->i_children )
1359 strcpy( psz_children, ", 1 child" );
1362 snprintf( psz_children, 19, ", %i children",
1363 vlc_internals( p_this )->i_children );
1367 psz_refcount[0] = '\0';
1368 if( vlc_internals( p_this )->i_refcount > 0 )
1369 snprintf( psz_refcount, 19, ", refcount %u",
1370 vlc_internals( p_this )->i_refcount );
1372 psz_thread[0] = '\0';
1373 if( vlc_internals( p_this )->b_thread )
1374 snprintf( psz_thread, 29, " (thread %lu)",
1375 (unsigned long)vlc_internals( p_this )->thread_id );
1377 psz_parent[0] = '\0';
1378 if( p_this->p_parent )
1379 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1381 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1382 p_this->i_object_id, p_this->psz_object_type,
1383 psz_name, psz_thread, psz_refcount, psz_children,
1387 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1390 char i_back = psz_foo[i_level];
1391 psz_foo[i_level] = '\0';
1393 PrintObject( p_this, psz_foo );
1395 psz_foo[i_level] = i_back;
1397 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1399 msg_Warn( p_this, "structure tree is too deep" );
1403 for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
1407 psz_foo[i_level-1] = ' ';
1409 if( psz_foo[i_level-2] == '`' )
1411 psz_foo[i_level-2] = ' ';
1415 if( i == vlc_internals( p_this )->i_children - 1 )
1417 psz_foo[i_level] = '`';
1421 psz_foo[i_level] = '|';
1424 psz_foo[i_level+1] = '-';
1425 psz_foo[i_level+2] = '\0';
1427 DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
1432 static vlc_list_t * NewList( int i_count )
1434 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1435 if( p_list == NULL )
1440 p_list->i_count = i_count;
1444 p_list->p_values = NULL;
1448 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1449 if( p_list->p_values == NULL )
1451 p_list->i_count = 0;
1458 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1461 if( p_list == NULL || i_index >= p_list->i_count )
1466 vlc_object_yield( p_object );
1468 p_list->p_values[i_index].p_object = p_object;
1473 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1475 if( p_list == NULL )
1480 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1481 * sizeof( vlc_value_t ) );
1482 if( p_list->p_values == NULL )
1484 p_list->i_count = 0;
1488 vlc_object_yield( p_object );
1490 p_list->p_values[p_list->i_count].p_object = p_object;
1496 static int CountChildren( vlc_object_t *p_this, int i_type )
1498 vlc_object_t *p_tmp;
1501 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1503 p_tmp = vlc_internals( p_this )->pp_children[i];
1505 if( p_tmp->i_object_type == i_type )
1509 i_count += CountChildren( p_tmp, i_type );
1515 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1517 vlc_object_t *p_tmp;
1520 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1522 p_tmp = vlc_internals( p_this )->pp_children[i];
1524 if( p_tmp->i_object_type == i_type )
1525 ListReplace( p_list, p_tmp, p_list->i_count++ );
1527 ListChildren( p_list, p_tmp, i_type );
1532 # if defined(HAVE_EXECINFO_H) && defined(HAVE_BACKTRACE)
1533 # include <execinfo.h>
1536 void vlc_refcheck (vlc_object_t *obj)
1538 static unsigned errors = 0;
1542 /* Anyone can use the root object (though it should not exist) */
1543 if (obj == VLC_OBJECT (vlc_global ()))
1546 /* Anyone can use its libvlc instance object */
1547 if (obj == VLC_OBJECT (obj->p_libvlc))
1550 /* The thread that created the object holds the initial reference */
1551 vlc_object_internals_t *priv = vlc_internals (obj);
1552 #if defined (LIBVLC_USE_PTHREAD)
1553 if (pthread_equal (priv->creator_id, pthread_self ()))
1555 if (priv->creator_id == GetCurrentThreadId ())
1561 /* A thread can use its own object without references! */
1562 vlc_object_t *caller = vlc_threadobj ();
1566 /* The calling thread is younger than the object.
1567 * Access could be valid through cross-thread synchronization;
1568 * we would need better accounting. */
1569 if (caller && (caller->i_object_id > obj->i_object_id))
1573 vlc_spin_lock (&priv->ref_spin);
1574 refs = priv->i_refcount;
1575 vlc_spin_unlock (&priv->ref_spin);
1577 for (held_list_t *hlcur = vlc_threadvar_get (&held_objects);
1578 hlcur != NULL; hlcur = hlcur->next)
1579 if (hlcur->obj == obj)
1582 fprintf (stderr, "The %s %s thread object is accessing...\n"
1583 "the %s %s object without references.\n",
1584 caller && caller->psz_object_name
1585 ? caller->psz_object_name : "unnamed",
1586 caller ? caller->psz_object_type : "main",
1587 obj->psz_object_name ? obj->psz_object_name : "unnamed",
1588 obj->psz_object_type);
1591 #ifdef HAVE_BACKTRACE
1593 int stackdepth = backtrace (stack, sizeof (stack) / sizeof (stack[0]));
1594 backtrace_symbols_fd (stack, stackdepth, 2);
1597 if (++errors == 100)
1598 fprintf (stderr, "Too many reference errors!\n");
1601 static void held_objects_destroy (void *data)
1604 held_list_t *hl = vlc_threadvar_get (&held_objects);
1605 vlc_object_t *caller = vlc_threadobj ();
1609 held_list_t *buf = hl->next;
1610 vlc_object_t *obj = hl->obj;
1612 fprintf (stderr, "The %s %s thread object leaked a reference to...\n"
1613 "the %s %s object.\n",
1614 caller && caller->psz_object_name
1615 ? caller->psz_object_name : "unnamed",
1616 caller ? caller->psz_object_type : "main",
1617 obj->psz_object_name ? obj->psz_object_name : "unnamed",
1618 obj->psz_object_type);