1 /*****************************************************************************
2 * objects.c: vlc_object_t handling
3 *****************************************************************************
4 * Copyright (C) 2004-2008 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
26 * This file contains the functions to handle the vlc_object_t type
30 /*****************************************************************************
32 *****************************************************************************/
39 #include "../libvlc.h"
42 #include "audio_output/aout_internal.h"
44 #include <vlc_access.h>
45 #include <vlc_demux.h>
46 #include <vlc_stream.h>
49 #include "stream_output/stream_output.h"
51 #include "vlc_interface.h"
52 #include "vlc_codec.h"
53 #include "vlc_filter.h"
55 #include "variables.h"
61 # include <errno.h> /* ENOSYS */
65 /*****************************************************************************
67 *****************************************************************************/
68 static int DumpCommand( vlc_object_t *, char const *,
69 vlc_value_t, vlc_value_t, void * );
71 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
72 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
73 static void PrintObject ( vlc_object_t *, const char * );
74 static void DumpStructure ( vlc_object_t *, int, char * );
76 static vlc_list_t * NewList ( int );
77 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
78 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
79 static int CountChildren ( vlc_object_t *, int );
80 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
82 static void vlc_object_destroy( vlc_object_t *p_this );
83 static void vlc_object_detach_unlocked (vlc_object_t *p_this);
85 /*****************************************************************************
86 * Local structure lock
87 *****************************************************************************/
88 static vlc_mutex_t structure_lock;
89 static vlc_threadvar_t thread_object;
91 void *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
92 int i_type, const char *psz_type )
95 vlc_object_internals_t *p_priv;
98 * VLC objects are laid out as follow:
99 * - first the LibVLC-private per-object data,
100 * - then VLC_COMMON members from vlc_object_t,
101 * - finally, the type-specific data (if any).
103 * This function initializes the LibVLC and common data,
104 * and zeroes the rest.
106 p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
110 assert (i_size >= sizeof (vlc_object_t));
111 p_new = (vlc_object_t *)(p_priv + 1);
113 p_new->i_object_type = i_type;
114 p_new->psz_object_type = psz_type;
115 p_new->psz_object_name = NULL;
117 p_new->b_die = false;
118 p_new->b_error = false;
119 p_new->b_dead = false;
120 p_new->b_force = false;
122 p_new->psz_header = NULL;
125 p_new->i_flags = p_this->i_flags
126 & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
128 p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
130 if( !p_priv->p_vars )
136 libvlc_global_data_t *p_libvlc_global;
139 /* Only the global root object is created out of the blue */
140 p_libvlc_global = (libvlc_global_data_t *)p_new;
141 p_new->p_libvlc = NULL;
143 p_libvlc_global->i_counter = 0;
144 p_priv->next = p_priv->prev = p_new;
145 vlc_mutex_init( &structure_lock );
149 p_libvlc_global = vlc_global();
150 if( i_type == VLC_OBJECT_LIBVLC )
151 p_new->p_libvlc = (libvlc_int_t*)p_new;
153 p_new->p_libvlc = p_this->p_libvlc;
156 vlc_spin_init( &p_priv->ref_spin );
157 p_priv->i_refcount = 1;
158 p_priv->pf_destructor = NULL;
159 p_priv->b_thread = false;
160 p_new->p_parent = NULL;
161 p_priv->pp_children = NULL;
162 p_priv->i_children = 0;
164 p_new->p_private = NULL;
166 /* Initialize mutexes and condvars */
167 vlc_mutex_init( &p_new->object_lock );
168 vlc_cond_init( p_new, &p_new->object_wait );
169 vlc_mutex_init( &p_priv->var_lock );
170 vlc_spin_init( &p_priv->spin );
171 p_priv->pipes[0] = p_priv->pipes[1] = -1;
173 p_priv->next = VLC_OBJECT (p_libvlc_global);
174 vlc_mutex_lock( &structure_lock );
175 p_priv->prev = vlc_internals (p_libvlc_global)->prev;
176 vlc_internals (p_libvlc_global)->prev = p_new;
177 vlc_internals (p_priv->prev)->next = p_new;
178 p_new->i_object_id = p_libvlc_global->i_counter++;
179 vlc_mutex_unlock( &structure_lock );
181 if( i_type == VLC_OBJECT_LIBVLC )
183 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
184 var_AddCallback( p_new, "list", DumpCommand, NULL );
185 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
186 var_AddCallback( p_new, "tree", DumpCommand, NULL );
187 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
188 var_AddCallback( p_new, "vars", DumpCommand, NULL );
196 * Allocates and initializes a vlc object.
198 * @param i_type known object type (all of them are negative integer values),
199 * or object byte size (always positive).
201 * @return the new object, or NULL on error.
203 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
205 const char * psz_type;
210 case VLC_OBJECT_LIBVLC:
211 i_size = sizeof(libvlc_int_t);
214 case VLC_OBJECT_INTF:
215 i_size = sizeof(intf_thread_t);
216 psz_type = "interface";
218 case VLC_OBJECT_DIALOGS:
219 i_size = sizeof(intf_thread_t);
220 psz_type = "dialogs";
222 case VLC_OBJECT_DEMUX:
223 i_size = sizeof(demux_t);
226 case VLC_OBJECT_ACCESS:
227 i_size = sizeof(access_t);
230 case VLC_OBJECT_DECODER:
231 i_size = sizeof(decoder_t);
232 psz_type = "decoder";
234 case VLC_OBJECT_PACKETIZER:
235 i_size = sizeof(decoder_t);
236 psz_type = "packetizer";
238 case VLC_OBJECT_ENCODER:
239 i_size = sizeof(encoder_t);
240 psz_type = "encoder";
242 case VLC_OBJECT_FILTER:
243 i_size = sizeof(filter_t);
246 case VLC_OBJECT_VOUT:
247 i_size = sizeof(vout_thread_t);
248 psz_type = "video output";
250 case VLC_OBJECT_AOUT:
251 i_size = sizeof(aout_instance_t);
252 psz_type = "audio output";
254 case VLC_OBJECT_SOUT:
255 i_size = sizeof(sout_instance_t);
256 psz_type = "stream output";
258 case VLC_OBJECT_OPENGL:
259 i_size = sizeof( vout_thread_t );
262 case VLC_OBJECT_ANNOUNCE:
263 i_size = sizeof( announce_handler_t );
264 psz_type = "announce";
266 case VLC_OBJECT_INTERACTION:
267 i_size = sizeof( interaction_t );
268 psz_type = "interaction";
271 i_size = i_type > (int)sizeof(vlc_object_t)
272 ? i_type : (int)sizeof(vlc_object_t);
273 i_type = VLC_OBJECT_GENERIC;
274 psz_type = "generic";
278 return vlc_custom_create( p_this, i_size, i_type, psz_type );
283 ****************************************************************************
284 * Set the destructor of a vlc object
286 * This function sets the destructor of the vlc object. It will be called
287 * when the object is destroyed when the its refcount reaches 0.
288 * (It is called by the internal function vlc_object_destroy())
289 *****************************************************************************/
290 void __vlc_object_set_destructor( vlc_object_t *p_this,
291 vlc_destructor_t pf_destructor )
293 vlc_object_internals_t *p_priv = vlc_internals(p_this );
294 p_priv->pf_destructor = pf_destructor;
298 ****************************************************************************
299 * Destroy a vlc object (Internal)
301 * This function destroys an object that has been previously allocated with
302 * vlc_object_create. The object's refcount must be zero and it must not be
303 * attached to other objects in any way.
304 *****************************************************************************/
305 static void vlc_object_destroy( vlc_object_t *p_this )
307 vlc_object_internals_t *p_priv = vlc_internals( p_this );
309 /* Objects are always detached beforehand */
310 assert( !p_this->p_parent );
312 /* Send a kill to the object's thread if applicable */
313 vlc_object_kill( p_this );
315 /* If we are running on a thread, wait until it ends */
316 if( p_priv->b_thread )
317 vlc_thread_join( p_this );
319 /* Call the custom "subclass" destructor */
320 if( p_priv->pf_destructor )
321 p_priv->pf_destructor( p_this );
323 /* Destroy the associated variables, starting from the end so that
324 * no memmove calls have to be done. */
325 while( p_priv->i_vars )
327 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
330 free( p_priv->p_vars );
331 vlc_mutex_destroy( &p_priv->var_lock );
333 free( p_this->psz_header );
335 if( p_this->p_libvlc == NULL )
337 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
340 assert( p_global == vlc_global() );
342 for( vlc_object_t *leaked = p_priv->next;
344 leaked = vlc_internals (leaked)->next )
346 /* We are leaking this object */
348 "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
349 leaked->i_object_id, leaked->psz_object_type,
350 leaked->psz_object_name );
351 /* Dump libvlc object to ease debugging */
352 vlc_object_dump( leaked );
356 if( p_priv->next != p_this )
358 /* Dump libvlc object to ease debugging */
359 vlc_object_dump( p_this );
360 /* Strongly abort, cause we want these to be fixed */
365 /* We are the global object ... no need to lock. */
366 vlc_mutex_destroy( &structure_lock );
369 FREENULL( p_this->psz_object_name );
371 #if defined(WIN32) || defined(UNDER_CE)
372 /* if object has an associated thread, close it now */
373 if( p_priv->thread_id )
374 CloseHandle(p_priv->thread_id);
377 vlc_spin_destroy( &p_priv->ref_spin );
378 vlc_mutex_destroy( &p_this->object_lock );
379 vlc_cond_destroy( &p_this->object_wait );
380 vlc_spin_destroy( &p_priv->spin );
381 if( p_priv->pipes[1] != -1 )
382 close( p_priv->pipes[1] );
383 if( p_priv->pipes[0] != -1 )
384 close( p_priv->pipes[0] );
390 /** Inter-object signaling */
392 void __vlc_object_lock( vlc_object_t *obj )
394 vlc_mutex_lock( &obj->object_lock );
397 void __vlc_object_unlock( vlc_object_t *obj )
399 vlc_assert_locked( &obj->object_lock );
400 vlc_mutex_unlock( &obj->object_lock );
404 # include <winsock2.h>
405 # include <ws2tcpip.h>
408 * select()-able pipes emulated using Winsock
410 static int pipe (int fd[2])
413 int addrlen = sizeof (addr);
415 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
416 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
417 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
420 memset (&addr, 0, sizeof (addr));
421 addr.sin_family = AF_INET;
422 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
423 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
424 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
426 || connect (c, (PSOCKADDR)&addr, addrlen))
429 a = accept (l, NULL, NULL);
430 if (a == INVALID_SOCKET)
441 if (l != INVALID_SOCKET)
443 if (c != INVALID_SOCKET)
449 #define read( a, b, c ) recv (a, b, c, 0)
451 #define write( a, b, c ) send (a, b, c, 0)
453 #define close( a ) closesocket (a)
457 * Returns the readable end of a pipe that becomes readable once termination
458 * of the object is requested (vlc_object_kill()).
459 * This can be used to wake-up out of a select() or poll() event loop, such
460 * typically when doing network I/O.
462 * Note that the pipe will remain the same for the lifetime of the object.
463 * DO NOT read the pipe nor close it yourself. Ever.
465 * @param obj object that would be "killed"
466 * @return a readable pipe descriptor, or -1 on error.
468 int __vlc_object_waitpipe( vlc_object_t *obj )
470 int pfd[2] = { -1, -1 };
471 vlc_object_internals_t *internals = vlc_internals( obj );
474 vlc_spin_lock (&internals->spin);
475 if (internals->pipes[0] == -1)
477 /* This can only ever happen if someone killed us without locking: */
478 assert (internals->pipes[1] == -1);
479 vlc_spin_unlock (&internals->spin);
484 vlc_spin_lock (&internals->spin);
485 if (internals->pipes[0] == -1)
487 internals->pipes[0] = pfd[0];
488 internals->pipes[1] = pfd[1];
489 pfd[0] = pfd[1] = -1;
493 vlc_spin_unlock (&internals->spin);
497 /* Race condition: vlc_object_kill() already invoked! */
500 vlc_spin_lock (&internals->spin);
501 fd = internals->pipes[1];
502 internals->pipes[1] = -1;
503 vlc_spin_unlock (&internals->spin);
505 msg_Dbg (obj, "waitpipe: object already dying");
510 /* Race condition: two threads call pipe() - unlikely */
516 return internals->pipes[0];
521 * Waits for the object to be signaled (using vlc_object_signal()).
522 * If the object already has a signal pending, this function will return
523 * immediately. It is asserted that the caller holds the object lock.
525 * @return true if the object is dying and should terminate.
527 bool __vlc_object_wait( vlc_object_t *obj )
529 vlc_assert_locked( &obj->object_lock );
530 vlc_cond_wait( &obj->object_wait, &obj->object_lock );
536 * Waits for the object to be signaled (using vlc_object_signal()), or for
538 * If the object already has a signal pending, this function will return
539 * immediately. It is asserted that the caller holds the object lock.
541 * @return negative if the object is dying and should terminate,
542 * positive if the the object has been signaled but is not dying,
543 * 0 if timeout has been reached.
545 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
549 vlc_assert_locked( &obj->object_lock );
550 v = vlc_cond_timedwait( &obj->object_wait, &obj->object_lock, deadline );
551 if( v == 0 ) /* signaled */
552 return obj->b_die ? -1 : 1;
558 * Checks whether an object has been "killed".
559 * The object lock must be held.
561 * Typical code for an object thread could be:
563 vlc_object_lock (self);
565 while (vlc_object_alive (self))
569 if (vlc_object_wait (self))
574 ...deinitialization...
575 vlc_object_unlock (self);
578 * @return true iff the object has not been killed yet
580 bool __vlc_object_alive( vlc_object_t *obj )
582 vlc_assert_locked( &obj->object_lock );
588 * Signals an object for which the lock is held.
590 void __vlc_object_signal_unlocked( vlc_object_t *obj )
592 vlc_assert_locked (&obj->object_lock);
593 vlc_cond_signal( &obj->object_wait );
598 * Requests termination of an object.
599 * If the object is LibVLC, also request to terminate all its children.
601 void __vlc_object_kill( vlc_object_t *p_this )
603 vlc_object_internals_t *internals = vlc_internals( p_this );
606 vlc_mutex_lock( &p_this->object_lock );
607 p_this->b_die = true;
609 vlc_spin_lock (&internals->spin);
610 fd = internals->pipes[1];
611 internals->pipes[1] = -1;
612 vlc_spin_unlock (&internals->spin);
616 msg_Dbg (p_this, "waitpipe: object killed");
620 if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
621 for( int i = 0; i < internals->i_children ; i++ )
622 vlc_object_kill( internals->pp_children[i] );
624 vlc_object_signal_unlocked( p_this );
625 vlc_mutex_unlock( &p_this->object_lock );
630 * Find an object given its ID.
632 * This function looks for the object whose i_object_id field is i_id.
633 * This function is slow, and often used to hide bugs. Do not use it.
634 * If you need to retain reference to an object, yield the object pointer with
635 * vlc_object_yield(), use the pointer as your reference, and call
636 * vlc_object_release() when you're done.
638 void * vlc_object_get( int i_id )
640 libvlc_global_data_t *p_libvlc_global = vlc_global();
641 vlc_object_t *obj = NULL;
643 vlc_mutex_lock( &structure_lock );
645 for( obj = vlc_internals (p_libvlc_global)->next;
646 obj != VLC_OBJECT (p_libvlc_global);
647 obj = vlc_internals (obj)->next )
649 if( obj->i_object_id == i_id )
651 vlc_object_yield( obj );
658 vlc_mutex_unlock( &structure_lock );
663 ****************************************************************************
664 * find a typed object and increment its refcount
665 *****************************************************************************
666 * This function recursively looks for a given object type. i_mode can be one
667 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
668 *****************************************************************************/
669 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
671 vlc_object_t *p_found;
673 /* If we are of the requested type ourselves, don't look further */
674 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
676 vlc_object_yield( p_this );
680 /* Otherwise, recursively look for the object */
681 if ((i_mode & 0x000f) == FIND_ANYWHERE)
684 if (i_type == VLC_OBJECT_PLAYLIST)
685 msg_Warn (p_this, "using vlc_object_find(VLC_OBJECT_PLAYLIST) "
686 "instead of pl_Yield()");
688 return vlc_object_find (p_this->p_libvlc, i_type,
689 (i_mode & ~0x000f)|FIND_CHILD);
692 vlc_mutex_lock( &structure_lock );
693 p_found = FindObject( p_this, i_type, i_mode );
694 vlc_mutex_unlock( &structure_lock );
699 ****************************************************************************
700 * find a named object and increment its refcount
701 *****************************************************************************
702 * This function recursively looks for a given object name. i_mode can be one
703 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
704 *****************************************************************************/
705 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
708 vlc_object_t *p_found;
710 /* If have the requested name ourselves, don't look further */
711 if( !(i_mode & FIND_STRICT)
712 && p_this->psz_object_name
713 && !strcmp( p_this->psz_object_name, psz_name ) )
715 vlc_object_yield( p_this );
719 vlc_mutex_lock( &structure_lock );
721 /* Otherwise, recursively look for the object */
722 if( (i_mode & 0x000f) == FIND_ANYWHERE )
724 vlc_object_t *p_root = p_this;
727 while( p_root->p_parent != NULL &&
728 p_root != VLC_OBJECT( p_this->p_libvlc ) )
730 p_root = p_root->p_parent;
733 p_found = FindObjectName( p_root, psz_name,
734 (i_mode & ~0x000f)|FIND_CHILD );
735 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
737 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
738 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
743 p_found = FindObjectName( p_this, psz_name, i_mode );
746 vlc_mutex_unlock( &structure_lock );
752 * Increment an object reference counter.
754 void __vlc_object_yield( vlc_object_t *p_this )
756 vlc_object_internals_t *internals = vlc_internals( p_this );
758 vlc_spin_lock( &internals->ref_spin );
759 /* Avoid obvious freed object uses */
760 assert( internals->i_refcount > 0 );
761 /* Increment the counter */
762 internals->i_refcount++;
763 vlc_spin_unlock( &internals->ref_spin );
766 /*****************************************************************************
767 * decrement an object refcount
768 * And destroy the object if its refcount reach zero.
769 *****************************************************************************/
770 void __vlc_object_release( vlc_object_t *p_this )
772 vlc_object_internals_t *internals = vlc_internals( p_this );
773 bool b_should_destroy;
775 vlc_spin_lock( &internals->ref_spin );
776 assert( internals->i_refcount > 0 );
778 if( internals->i_refcount > 1 )
781 /* There are still other references to the object */
782 internals->i_refcount--;
783 vlc_spin_unlock( &internals->ref_spin );
786 vlc_spin_unlock( &internals->ref_spin );
789 /* Remember that we cannot hold the spin while waiting on the mutex */
790 vlc_mutex_lock( &structure_lock );
791 /* Take the spin again. Note that another thread may have yielded the
792 * object in the (very short) mean time. */
793 vlc_spin_lock( &internals->ref_spin );
794 b_should_destroy = --internals->i_refcount == 0;
795 vlc_spin_unlock( &internals->ref_spin );
797 if( b_should_destroy )
799 /* Remove the object from object list
800 * so that it cannot be encountered by vlc_object_get() */
801 vlc_internals (internals->next)->prev = internals->prev;
802 vlc_internals (internals->prev)->next = internals->next;
804 /* Detach from parent to protect against FIND_CHILDREN */
805 vlc_object_detach_unlocked (p_this);
806 /* Detach from children to protect against FIND_PARENT */
807 for (int i = 0; i < internals->i_children; i++)
808 internals->pp_children[i]->p_parent = NULL;
811 vlc_mutex_unlock( &structure_lock );
813 if( b_should_destroy )
815 free( internals->pp_children );
816 internals->pp_children = NULL;
817 internals->i_children = 0;
818 vlc_object_destroy( p_this );
823 ****************************************************************************
824 * attach object to a parent object
825 *****************************************************************************
826 * This function sets p_this as a child of p_parent, and p_parent as a parent
827 * of p_this. This link can be undone using vlc_object_detach.
828 *****************************************************************************/
829 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
831 if( !p_this ) return;
833 vlc_mutex_lock( &structure_lock );
835 /* Attach the parent to its child */
836 assert (!p_this->p_parent);
837 p_this->p_parent = p_parent;
839 /* Attach the child to its parent */
840 vlc_object_internals_t *priv = vlc_internals( p_parent );
841 INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
844 vlc_mutex_unlock( &structure_lock );
848 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
850 vlc_assert_locked (&structure_lock);
852 if (p_this->p_parent == NULL)
855 vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
859 /* Remove p_this's parent */
860 p_this->p_parent = NULL;
862 /* Remove all of p_parent's children which are p_this */
863 for( i_index = priv->i_children ; i_index-- ; )
865 if( priv->pp_children[i_index] == p_this )
868 for( i = i_index ; i < priv->i_children ; i++ )
869 priv->pp_children[i] = priv->pp_children[i+1];
873 if( priv->i_children )
875 priv->pp_children = (vlc_object_t **)realloc( priv->pp_children,
876 priv->i_children * sizeof(vlc_object_t *) );
880 /* Special case - don't realloc() to zero to avoid leaking */
881 free( priv->pp_children );
882 priv->pp_children = NULL;
888 ****************************************************************************
889 * detach object from its parent
890 *****************************************************************************
891 * This function removes all links between an object and its parent.
892 *****************************************************************************/
893 void __vlc_object_detach( vlc_object_t *p_this )
895 if( !p_this ) return;
897 vlc_mutex_lock( &structure_lock );
898 if( !p_this->p_parent )
899 msg_Err( p_this, "object is not attached" );
901 vlc_object_detach_unlocked( p_this );
902 vlc_mutex_unlock( &structure_lock );
907 ****************************************************************************
908 * find a list typed objects and increment their refcount
909 *****************************************************************************
910 * This function recursively looks for a given object type. i_mode can be one
911 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
912 *****************************************************************************/
913 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
918 /* Look for the objects */
919 switch( i_mode & 0x000f )
922 /* Modules should probably not be object, and the module should perhaps
923 * not be shared across LibVLC instances. In the mean time, this ugly
924 * hack is brought to you by Courmisch. */
925 if (i_type == VLC_OBJECT_MODULE)
926 return vlc_list_find ((vlc_object_t *)vlc_global ()->p_module_bank,
928 return vlc_list_find (p_this->p_libvlc, i_type, FIND_CHILD);
931 vlc_mutex_lock( &structure_lock );
932 i_count = CountChildren( p_this, i_type );
933 p_list = NewList( i_count );
935 /* Check allocation was successful */
936 if( p_list->i_count != i_count )
938 vlc_mutex_unlock( &structure_lock );
939 msg_Err( p_this, "list allocation failed!" );
945 ListChildren( p_list, p_this, i_type );
946 vlc_mutex_unlock( &structure_lock );
950 msg_Err( p_this, "unimplemented!" );
951 p_list = NewList( 0 );
959 * Gets the list of children of an objects, and increment their reference
961 * @return a list (possibly empty) or NULL in case of error.
963 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
966 vlc_object_internals_t *priv = vlc_internals( obj );
968 vlc_mutex_lock( &structure_lock );
969 l = NewList( priv->i_children );
970 for (int i = 0; i < l->i_count; i++)
972 vlc_object_yield( priv->pp_children[i] );
973 l->p_values[i].p_object = priv->pp_children[i];
975 vlc_mutex_unlock( &structure_lock );
979 /*****************************************************************************
980 * DumpCommand: print the current vlc structure
981 *****************************************************************************
982 * This function prints either an ASCII tree showing the connections between
983 * vlc objects, and additional information such as their refcount, thread ID,
984 * etc. (command "tree"), or the same data as a simple list (command "list").
985 *****************************************************************************/
986 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
987 vlc_value_t oldval, vlc_value_t newval, void *p_data )
989 (void)oldval; (void)p_data;
990 if( *psz_cmd == 'l' )
992 vlc_object_t *root = VLC_OBJECT (vlc_global ()), *cur = root;
994 vlc_mutex_lock( &structure_lock );
997 PrintObject (cur, "");
998 cur = vlc_internals (cur)->next;
1000 while (cur != root);
1001 vlc_mutex_unlock( &structure_lock );
1005 vlc_object_t *p_object = NULL;
1007 if( *newval.psz_string )
1010 int i_id = strtol( newval.psz_string, &end, 0 );
1011 if( end != newval.psz_string )
1012 p_object = vlc_object_get( i_id );
1015 /* try using the object's name to find it */
1016 vlc_object_t *p_libvlc = vlc_object_get( 1 );
1019 /* Look in p_libvlc's children tree */
1020 p_object = vlc_object_find_name( p_libvlc,
1023 vlc_object_release( p_libvlc );
1027 /* If it's not in libvlc, look in libvlc_global (== p_this) */
1028 p_object = vlc_object_find_name( p_this,
1040 vlc_mutex_lock( &structure_lock );
1042 if( *psz_cmd == 't' )
1044 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1047 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1050 DumpStructure( p_object, 0, psz_foo );
1052 else if( *psz_cmd == 'v' )
1057 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1059 PrintObject( p_object, "" );
1061 if( !vlc_internals( p_object )->i_vars )
1062 printf( " `-o No variables\n" );
1063 for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
1065 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
1067 const char *psz_type = "unknown";
1068 switch( p_var->i_type & VLC_VAR_TYPE )
1070 #define MYCASE( type, nice ) \
1071 case VLC_VAR_ ## type: \
1074 MYCASE( VOID, "void" );
1075 MYCASE( BOOL, "bool" );
1076 MYCASE( INTEGER, "integer" );
1077 MYCASE( HOTKEY, "hotkey" );
1078 MYCASE( STRING, "string" );
1079 MYCASE( MODULE, "module" );
1080 MYCASE( FILE, "file" );
1081 MYCASE( DIRECTORY, "directory" );
1082 MYCASE( VARIABLE, "variable" );
1083 MYCASE( FLOAT, "float" );
1084 MYCASE( TIME, "time" );
1085 MYCASE( ADDRESS, "address" );
1086 MYCASE( MUTEX, "mutex" );
1087 MYCASE( LIST, "list" );
1090 printf( " %c-o \"%s\" (%s",
1091 i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
1092 p_var->psz_name, psz_type );
1093 if( p_var->psz_text )
1094 printf( ", %s", p_var->psz_text );
1096 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1097 printf( ", command" );
1098 if( p_var->i_entries )
1099 printf( ", %d callbacks", p_var->i_entries );
1100 switch( p_var->i_type & 0x00f0 )
1106 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1108 case VLC_VAR_INTEGER:
1109 printf( ": %d", p_var->val.i_int );
1111 case VLC_VAR_STRING:
1112 printf( ": \"%s\"", p_var->val.psz_string );
1115 printf( ": %f", p_var->val.f_float );
1118 printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
1120 case VLC_VAR_ADDRESS:
1121 printf( ": %p", p_var->val.p_address );
1131 vlc_mutex_unlock( &structure_lock );
1133 if( *newval.psz_string )
1135 vlc_object_release( p_object );
1142 /*****************************************************************************
1143 * vlc_list_release: free a list previously allocated by vlc_list_find
1144 *****************************************************************************
1145 * This function decreases the refcount of all objects in the list and
1147 *****************************************************************************/
1148 void vlc_list_release( vlc_list_t *p_list )
1152 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1154 vlc_object_release( p_list->p_values[i_index].p_object );
1157 free( p_list->p_values );
1161 /*****************************************************************************
1162 * dump an object. (Debug function)
1163 *****************************************************************************/
1164 void __vlc_object_dump( vlc_object_t *p_this )
1166 vlc_mutex_lock( &structure_lock );
1167 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1169 DumpStructure( p_this, 0, psz_foo );
1170 vlc_mutex_unlock( &structure_lock );
1173 /* Following functions are local */
1175 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1178 vlc_object_t *p_tmp;
1180 switch( i_mode & 0x000f )
1183 p_tmp = p_this->p_parent;
1186 if( p_tmp->i_object_type == i_type )
1188 vlc_object_yield( p_tmp );
1193 return FindObject( p_tmp, i_type, i_mode );
1199 for( i = vlc_internals( p_this )->i_children; i--; )
1201 p_tmp = vlc_internals( p_this )->pp_children[i];
1202 if( p_tmp->i_object_type == i_type )
1204 vlc_object_yield( p_tmp );
1207 else if( vlc_internals( p_tmp )->i_children )
1209 p_tmp = FindObject( p_tmp, i_type, i_mode );
1219 /* Handled in vlc_object_find */
1226 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1227 const char *psz_name,
1231 vlc_object_t *p_tmp;
1233 switch( i_mode & 0x000f )
1236 p_tmp = p_this->p_parent;
1239 if( p_tmp->psz_object_name
1240 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1242 vlc_object_yield( p_tmp );
1247 return FindObjectName( p_tmp, psz_name, i_mode );
1253 for( i = vlc_internals( p_this )->i_children; i--; )
1255 p_tmp = vlc_internals( p_this )->pp_children[i];
1256 if( p_tmp->psz_object_name
1257 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1259 vlc_object_yield( p_tmp );
1262 else if( vlc_internals( p_tmp )->i_children )
1264 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1274 /* Handled in vlc_object_find */
1282 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1284 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1287 memset( &psz_name, 0, sizeof(psz_name) );
1288 if( p_this->psz_object_name )
1290 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1292 psz_name[48] = '\"';
1295 psz_children[0] = '\0';
1296 switch( vlc_internals( p_this )->i_children )
1301 strcpy( psz_children, ", 1 child" );
1304 snprintf( psz_children, 19, ", %i children",
1305 vlc_internals( p_this )->i_children );
1309 psz_refcount[0] = '\0';
1310 if( vlc_internals( p_this )->i_refcount > 0 )
1311 snprintf( psz_refcount, 19, ", refcount %u",
1312 vlc_internals( p_this )->i_refcount );
1314 psz_thread[0] = '\0';
1315 if( vlc_internals( p_this )->b_thread )
1316 snprintf( psz_thread, 29, " (thread %lu)",
1317 (unsigned long)vlc_internals( p_this )->thread_id );
1319 psz_parent[0] = '\0';
1320 if( p_this->p_parent )
1321 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1323 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1324 p_this->i_object_id, p_this->psz_object_type,
1325 psz_name, psz_thread, psz_refcount, psz_children,
1329 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1332 char i_back = psz_foo[i_level];
1333 psz_foo[i_level] = '\0';
1335 PrintObject( p_this, psz_foo );
1337 psz_foo[i_level] = i_back;
1339 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1341 msg_Warn( p_this, "structure tree is too deep" );
1345 for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
1349 psz_foo[i_level-1] = ' ';
1351 if( psz_foo[i_level-2] == '`' )
1353 psz_foo[i_level-2] = ' ';
1357 if( i == vlc_internals( p_this )->i_children - 1 )
1359 psz_foo[i_level] = '`';
1363 psz_foo[i_level] = '|';
1366 psz_foo[i_level+1] = '-';
1367 psz_foo[i_level+2] = '\0';
1369 DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
1374 static vlc_list_t * NewList( int i_count )
1376 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1377 if( p_list == NULL )
1382 p_list->i_count = i_count;
1386 p_list->p_values = NULL;
1390 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1391 if( p_list->p_values == NULL )
1393 p_list->i_count = 0;
1400 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1403 if( p_list == NULL || i_index >= p_list->i_count )
1408 vlc_object_yield( p_object );
1410 p_list->p_values[i_index].p_object = p_object;
1415 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1417 if( p_list == NULL )
1422 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1423 * sizeof( vlc_value_t ) );
1424 if( p_list->p_values == NULL )
1426 p_list->i_count = 0;
1430 vlc_object_yield( p_object );
1432 p_list->p_values[p_list->i_count].p_object = p_object;
1438 static int CountChildren( vlc_object_t *p_this, int i_type )
1440 vlc_object_t *p_tmp;
1443 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1445 p_tmp = vlc_internals( p_this )->pp_children[i];
1447 if( p_tmp->i_object_type == i_type )
1451 i_count += CountChildren( p_tmp, i_type );
1457 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1459 vlc_object_t *p_tmp;
1462 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1464 p_tmp = vlc_internals( p_this )->pp_children[i];
1466 if( p_tmp->i_object_type == i_type )
1467 ListReplace( p_list, p_tmp, p_list->i_count++ );
1469 ListChildren( p_list, p_tmp, i_type );
1474 void vlc_refcheck (vlc_object_t *obj)
1476 static unsigned errors = 0;
1477 vlc_object_t *caller = vlc_threadobj ();
1478 vlc_object_internals_t *priv = vlc_internals (obj);
1485 return; /* main thread, not sure how to handle it */
1487 /* An object can always access itself without reference! */
1491 /* The calling thread is younger than the object.
1492 * Access could be valid, we would need more accounting. */
1493 if (caller->i_object_id > obj->i_object_id)
1496 vlc_spin_lock (&priv->ref_spin);
1497 refs = priv->i_refcount;
1498 vlc_spin_unlock (&priv->ref_spin);
1500 /* Object has more than one reference.
1501 * The current thread could be holding a valid reference. */
1505 /* The parent of an object normally holds the unique reference.
1506 * As not all objects are threads, it could also be an ancestor. */
1507 vlc_mutex_lock (&structure_lock);
1508 for (vlc_object_t *cur = obj; cur != NULL; cur = cur->p_parent)
1511 vlc_mutex_unlock (&structure_lock);
1514 vlc_mutex_unlock (&structure_lock);
1517 if (caller->i_object_type == VLC_OBJECT_PLAYLIST)
1518 return; /* Playlist is too clever, or hopelessly broken. */
1520 msg_Err (caller, "This thread is accessing...");
1521 msg_Err (obj, "...this object in a suspicious manner.");
1523 if (++errors == 100)
1524 msg_Err (caller, "Too many reference errors");