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
27 * Unless otherwise stated, functions in this file are not cancellation point.
28 * All functions in this file are safe w.r.t. deferred cancellation.
32 /*****************************************************************************
34 *****************************************************************************/
39 #include <vlc_common.h>
41 #include "../libvlc.h"
44 #include "audio_output/aout_internal.h"
46 #include <vlc_access.h>
47 #include <vlc_demux.h>
48 #include <vlc_stream.h>
51 #include "stream_output/stream_output.h"
53 #include "vlc_interface.h"
54 #include "vlc_codec.h"
55 #include "vlc_filter.h"
57 #include "variables.h"
63 # include <errno.h> /* ENOSYS */
67 /*****************************************************************************
69 *****************************************************************************/
70 static int DumpCommand( vlc_object_t *, char const *,
71 vlc_value_t, vlc_value_t, void * );
73 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
74 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
75 static void PrintObject ( vlc_object_t *, const char * );
76 static void DumpStructure ( vlc_object_t *, int, char * );
78 static vlc_list_t * NewList ( int );
79 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
80 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
81 static int CountChildren ( vlc_object_t *, int );
82 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
84 static void vlc_object_destroy( vlc_object_t *p_this );
85 static void vlc_object_detach_unlocked (vlc_object_t *p_this);
86 static void vlc_object_dump( vlc_object_t *p_this );
88 /*****************************************************************************
89 * Local structure lock
90 *****************************************************************************/
91 static vlc_mutex_t structure_lock;
92 static unsigned object_counter = 0;
94 static void close_nocancel (int fd)
96 int canc = vlc_savecancel ();
98 vlc_restorecancel (canc);
101 void *__vlc_custom_create( vlc_object_t *p_this, size_t i_size,
102 int i_type, const char *psz_type )
105 vlc_object_internals_t *p_priv;
108 * VLC objects are laid out as follow:
109 * - first the LibVLC-private per-object data,
110 * - then VLC_COMMON members from vlc_object_t,
111 * - finally, the type-specific data (if any).
113 * This function initializes the LibVLC and common data,
114 * and zeroes the rest.
116 p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
120 assert (i_size >= sizeof (vlc_object_t));
121 p_new = (vlc_object_t *)(p_priv + 1);
123 p_new->i_object_type = i_type;
124 p_new->psz_object_type = psz_type;
125 p_new->psz_object_name = NULL;
127 p_new->b_die = false;
128 p_new->b_error = false;
129 p_new->b_dead = false;
130 p_new->b_force = false;
132 p_new->psz_header = NULL;
135 p_new->i_flags = p_this->i_flags
136 & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
138 p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
140 if( !p_priv->p_vars )
148 if( i_type == VLC_OBJECT_LIBVLC )
149 p_new->p_libvlc = (libvlc_int_t*)p_new;
152 p_new->p_libvlc = NULL;
153 vlc_mutex_init( &structure_lock );
156 p_this = p_priv->next = p_priv->prev = p_new;
159 p_new->p_libvlc = p_this->p_libvlc;
161 vlc_spin_init( &p_priv->ref_spin );
162 p_priv->i_refcount = 1;
163 p_priv->pf_destructor = NULL;
164 p_priv->b_thread = false;
165 p_new->p_parent = NULL;
166 p_priv->pp_children = NULL;
167 p_priv->i_children = 0;
169 p_new->p_private = NULL;
171 /* Initialize mutexes and condvars */
172 vlc_mutex_init( &p_priv->lock );
173 vlc_cond_init( &p_priv->wait );
174 vlc_mutex_init( &p_priv->var_lock );
175 vlc_spin_init( &p_priv->spin );
176 p_priv->pipes[0] = p_priv->pipes[1] = -1;
178 p_priv->next = p_this;
179 vlc_mutex_lock( &structure_lock );
180 p_priv->prev = vlc_internals (p_this)->prev;
181 vlc_internals (p_this)->prev = p_new;
182 vlc_internals (p_priv->prev)->next = p_new;
183 p_new->i_object_id = object_counter++; /* fetch THEN increment */
184 vlc_mutex_unlock( &structure_lock );
186 if( i_type == VLC_OBJECT_LIBVLC )
188 int canc = vlc_savecancel ();
189 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
190 var_AddCallback( p_new, "list", DumpCommand, NULL );
191 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
192 var_AddCallback( p_new, "tree", DumpCommand, NULL );
193 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
194 var_AddCallback( p_new, "vars", DumpCommand, NULL );
195 vlc_restorecancel (canc);
203 * Allocates and initializes a vlc object.
205 * @param i_type known object type (all of them are negative integer values),
206 * or object byte size (always positive).
208 * @return the new object, or NULL on error.
210 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
212 const char * psz_type;
217 case VLC_OBJECT_INTF:
218 i_size = sizeof(intf_thread_t);
219 psz_type = "interface";
221 case VLC_OBJECT_DECODER:
222 i_size = sizeof(decoder_t);
223 psz_type = "decoder";
225 case VLC_OBJECT_PACKETIZER:
226 i_size = sizeof(decoder_t);
227 psz_type = "packetizer";
229 case VLC_OBJECT_ENCODER:
230 i_size = sizeof(encoder_t);
231 psz_type = "encoder";
233 case VLC_OBJECT_AOUT:
234 i_size = sizeof(aout_instance_t);
235 psz_type = "audio output";
237 case VLC_OBJECT_OPENGL:
238 i_size = sizeof( vout_thread_t );
242 assert( i_type > 0 ); /* unknown type?! */
244 i_type = VLC_OBJECT_GENERIC;
245 psz_type = "generic";
249 return vlc_custom_create( p_this, i_size, i_type, psz_type );
254 ****************************************************************************
255 * Set the destructor of a vlc object
257 * This function sets the destructor of the vlc object. It will be called
258 * when the object is destroyed when the its refcount reaches 0.
259 * (It is called by the internal function vlc_object_destroy())
260 *****************************************************************************/
261 void __vlc_object_set_destructor( vlc_object_t *p_this,
262 vlc_destructor_t pf_destructor )
264 vlc_object_internals_t *p_priv = vlc_internals(p_this );
265 p_priv->pf_destructor = pf_destructor;
269 ****************************************************************************
270 * Destroy a vlc object (Internal)
272 * This function destroys an object that has been previously allocated with
273 * vlc_object_create. The object's refcount must be zero and it must not be
274 * attached to other objects in any way.
276 * This function must be called with cancellation disabled (currently).
277 *****************************************************************************/
278 static void vlc_object_destroy( vlc_object_t *p_this )
280 vlc_object_internals_t *p_priv = vlc_internals( p_this );
282 /* Objects are always detached beforehand */
283 assert( !p_this->p_parent );
285 /* Send a kill to the object's thread if applicable */
286 vlc_object_kill( p_this );
288 /* Call the custom "subclass" destructor */
289 if( p_priv->pf_destructor )
290 p_priv->pf_destructor( p_this );
292 /* Any thread must have been cleaned up at this point. */
293 assert( !p_priv->b_thread );
295 /* Destroy the associated variables, starting from the end so that
296 * no memmove calls have to be done. */
297 while( p_priv->i_vars )
299 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
302 free( p_priv->p_vars );
303 vlc_mutex_destroy( &p_priv->var_lock );
305 free( p_this->psz_header );
307 if( p_this->p_libvlc == NULL )
308 /* We are the global object ... no need to lock. */
309 vlc_mutex_destroy( &structure_lock );
311 FREENULL( p_this->psz_object_name );
313 vlc_spin_destroy( &p_priv->ref_spin );
314 vlc_mutex_destroy( &p_priv->lock );
315 vlc_cond_destroy( &p_priv->wait );
316 vlc_spin_destroy( &p_priv->spin );
317 if( p_priv->pipes[1] != -1 )
318 close( p_priv->pipes[1] );
319 if( p_priv->pipes[0] != -1 )
320 close( p_priv->pipes[0] );
326 /** Inter-object signaling */
328 void __vlc_object_lock( vlc_object_t *obj )
330 vlc_mutex_lock( &(vlc_internals(obj)->lock) );
333 void __vlc_object_unlock( vlc_object_t *obj )
335 vlc_assert_locked( &(vlc_internals(obj)->lock) );
336 vlc_mutex_unlock( &(vlc_internals(obj)->lock) );
340 # include <winsock2.h>
341 # include <ws2tcpip.h>
344 * select()-able pipes emulated using Winsock
346 static int pipe (int fd[2])
349 int addrlen = sizeof (addr);
351 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
352 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
353 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
356 memset (&addr, 0, sizeof (addr));
357 addr.sin_family = AF_INET;
358 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
359 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
360 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
362 || connect (c, (PSOCKADDR)&addr, addrlen))
365 a = accept (l, NULL, NULL);
366 if (a == INVALID_SOCKET)
377 if (l != INVALID_SOCKET)
379 if (c != INVALID_SOCKET)
385 #define read( a, b, c ) recv (a, b, c, 0)
387 #define write( a, b, c ) send (a, b, c, 0)
389 #define close( a ) closesocket (a)
393 * Returns the readable end of a pipe that becomes readable once termination
394 * of the object is requested (vlc_object_kill()).
395 * This can be used to wake-up out of a select() or poll() event loop, such
396 * typically when doing network I/O.
398 * Note that the pipe will remain the same for the lifetime of the object.
399 * DO NOT read the pipe nor close it yourself. Ever.
401 * @param obj object that would be "killed"
402 * @return a readable pipe descriptor, or -1 on error.
404 int __vlc_object_waitpipe( vlc_object_t *obj )
406 int pfd[2] = { -1, -1 };
407 vlc_object_internals_t *internals = vlc_internals( obj );
410 vlc_spin_lock (&internals->spin);
411 if (internals->pipes[0] == -1)
413 /* This can only ever happen if someone killed us without locking: */
414 assert (internals->pipes[1] == -1);
415 vlc_spin_unlock (&internals->spin);
420 vlc_spin_lock (&internals->spin);
421 if (internals->pipes[0] == -1)
423 internals->pipes[0] = pfd[0];
424 internals->pipes[1] = pfd[1];
425 pfd[0] = pfd[1] = -1;
429 vlc_spin_unlock (&internals->spin);
433 /* Race condition: vlc_object_kill() already invoked! */
436 vlc_spin_lock (&internals->spin);
437 fd = internals->pipes[1];
438 internals->pipes[1] = -1;
439 vlc_spin_unlock (&internals->spin);
441 msg_Dbg (obj, "waitpipe: object already dying");
446 /* Race condition: two threads call pipe() - unlikely */
452 return internals->pipes[0];
457 * Suspends until another thread calls vlc_object_signal_unlocked().
458 * The thread may be woken up earlier due to limitations of the underlying
461 * In new code, please use vlc_cond_wait() instead.
463 * This function is a cancellation point. In case of cancellation, the object
464 * will be in locked state.
466 void __vlc_object_wait( vlc_object_t *obj )
468 vlc_object_internals_t *priv = vlc_internals( obj );
469 vlc_assert_locked( &priv->lock);
470 vlc_cond_wait( &priv->wait, &priv->lock );
475 * Wakes up one thread waiting on the object. If no thread are (yet) waiting,
478 * Please do not use this function in new code as we are trying to untangle
479 * objects and threads. Use vlc_cond_wait() instead.
481 void __vlc_object_signal_unlocked( vlc_object_t *obj )
483 vlc_assert_locked (&(vlc_internals(obj)->lock));
484 vlc_cond_signal( &(vlc_internals(obj)->wait) );
489 * Requests termination of an object.
490 * If the object is LibVLC, also request to terminate all its children.
492 void __vlc_object_kill( vlc_object_t *p_this )
494 vlc_object_internals_t *priv = vlc_internals( p_this );
497 vlc_thread_cancel( p_this );
498 vlc_object_lock( p_this );
499 p_this->b_die = true;
501 vlc_spin_lock (&priv->spin);
504 vlc_spin_unlock (&priv->spin);
508 msg_Dbg (p_this, "waitpipe: object killed");
512 vlc_cond_broadcast (&priv->wait);
513 /* This also serves as a memory barrier toward vlc_object_alive(): */
514 vlc_object_unlock( p_this );
519 * Find an object given its ID.
521 * This function looks for the object whose i_object_id field is i_id.
522 * This function is slow, and often used to hide bugs. Do not use it.
523 * If you need to retain reference to an object, yield the object pointer with
524 * vlc_object_yield(), use the pointer as your reference, and call
525 * vlc_object_release() when you're done.
527 void * vlc_object_get( libvlc_int_t *p_anchor, int i_id )
529 vlc_object_t *obj = NULL;
531 int canc = vlc_savecancel ();
532 fprintf (stderr, "Use of deprecated vlc_object_get(%d) ", i_id);
534 vlc_restorecancel (canc);
536 vlc_mutex_lock( &structure_lock );
538 for( obj = vlc_internals (p_anchor)->next;
539 obj != VLC_OBJECT (p_anchor);
540 obj = vlc_internals (obj)->next )
542 if( obj->i_object_id == i_id )
544 vlc_object_yield( obj );
550 fprintf (stderr, "Object %d does not exist\n", i_id);
553 vlc_mutex_unlock( &structure_lock );
558 ****************************************************************************
559 * find a typed object and increment its refcount
560 *****************************************************************************
561 * This function recursively looks for a given object type. i_mode can be one
562 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
563 *****************************************************************************/
564 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
566 vlc_object_t *p_found;
568 /* If we are of the requested type ourselves, don't look further */
569 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
571 vlc_object_yield( p_this );
575 /* Otherwise, recursively look for the object */
576 if ((i_mode & 0x000f) == FIND_ANYWHERE)
579 if (i_type == VLC_OBJECT_PLAYLIST)
580 msg_Err (p_this, "using vlc_object_find(VLC_OBJECT_PLAYLIST) "
581 "instead of pl_Yield()");
583 return vlc_object_find (p_this->p_libvlc, i_type,
584 (i_mode & ~0x000f)|FIND_CHILD);
587 vlc_mutex_lock( &structure_lock );
588 p_found = FindObject( p_this, i_type, i_mode );
589 vlc_mutex_unlock( &structure_lock );
593 #undef vlc_object_find_name
595 * Finds a named object and increment its reference count.
596 * Beware that objects found in this manner can be "owned" by another thread,
597 * be of _any_ type, and be attached to any module (if any). With such an
598 * object reference, you can set or get object variables, emit log messages,
599 * and read write-once object parameters (i_object_id, psz_object_type, etc).
600 * You CANNOT cast the object to a more specific object type, and you
601 * definitely cannot invoke object type-specific callbacks with this.
603 * @param p_this object to search from
604 * @param psz_name name of the object to search for
605 * @param i_mode search direction: FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
607 * @return a matching object (must be released by the caller),
610 vlc_object_t *vlc_object_find_name( vlc_object_t *p_this,
611 const char *psz_name, int i_mode )
613 vlc_object_t *p_found;
615 /* If have the requested name ourselves, don't look further */
616 if( !(i_mode & FIND_STRICT)
617 && p_this->psz_object_name
618 && !strcmp( p_this->psz_object_name, psz_name ) )
620 vlc_object_yield( p_this );
624 vlc_mutex_lock( &structure_lock );
626 /* Otherwise, recursively look for the object */
627 if( (i_mode & 0x000f) == FIND_ANYWHERE )
629 vlc_object_t *p_root = p_this;
632 while( p_root->p_parent != NULL &&
633 p_root != VLC_OBJECT( p_this->p_libvlc ) )
635 p_root = p_root->p_parent;
638 p_found = FindObjectName( p_root, psz_name,
639 (i_mode & ~0x000f)|FIND_CHILD );
640 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
642 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
643 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
648 p_found = FindObjectName( p_this, psz_name, i_mode );
651 vlc_mutex_unlock( &structure_lock );
657 * Increment an object reference counter.
659 void __vlc_object_yield( vlc_object_t *p_this )
661 vlc_object_internals_t *internals = vlc_internals( p_this );
663 vlc_spin_lock( &internals->ref_spin );
664 /* Avoid obvious freed object uses */
665 assert( internals->i_refcount > 0 );
666 /* Increment the counter */
667 internals->i_refcount++;
668 vlc_spin_unlock( &internals->ref_spin );
671 /*****************************************************************************
672 * Decrement an object refcount
673 * And destroy the object if its refcount reach zero.
674 *****************************************************************************/
675 void __vlc_object_release( vlc_object_t *p_this )
677 vlc_object_internals_t *internals = vlc_internals( p_this );
678 bool b_should_destroy;
680 vlc_spin_lock( &internals->ref_spin );
681 assert( internals->i_refcount > 0 );
683 if( internals->i_refcount > 1 )
686 /* There are still other references to the object */
687 internals->i_refcount--;
688 vlc_spin_unlock( &internals->ref_spin );
691 vlc_spin_unlock( &internals->ref_spin );
694 /* Remember that we cannot hold the spin while waiting on the mutex */
695 vlc_mutex_lock( &structure_lock );
696 /* Take the spin again. Note that another thread may have yielded the
697 * object in the (very short) mean time. */
698 vlc_spin_lock( &internals->ref_spin );
699 b_should_destroy = --internals->i_refcount == 0;
700 vlc_spin_unlock( &internals->ref_spin );
702 if( b_should_destroy )
705 if( VLC_OBJECT(p_this->p_libvlc) == p_this )
708 vlc_object_t *leaked = internals->next;
709 while( leaked != p_this )
711 /* We are leaking this object */
713 "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
714 leaked->i_object_id, leaked->psz_object_type,
715 leaked->psz_object_name );
716 /* Dump object to ease debugging */
717 vlc_object_dump( leaked );
719 leaked = vlc_internals (leaked)->next;
722 if( internals->next != p_this )
723 /* Dump libvlc object to ease debugging */
724 vlc_object_dump( p_this );
727 /* Remove the object from object list
728 * so that it cannot be encountered by vlc_object_get() */
729 vlc_internals (internals->next)->prev = internals->prev;
730 vlc_internals (internals->prev)->next = internals->next;
732 /* Detach from parent to protect against FIND_CHILDREN */
733 vlc_object_detach_unlocked (p_this);
734 /* Detach from children to protect against FIND_PARENT */
735 for (int i = 0; i < internals->i_children; i++)
736 internals->pp_children[i]->p_parent = NULL;
739 vlc_mutex_unlock( &structure_lock );
741 if( b_should_destroy )
745 free( internals->pp_children );
746 internals->pp_children = NULL;
747 internals->i_children = 0;
748 canc = vlc_savecancel ();
749 vlc_object_destroy( p_this );
750 vlc_restorecancel (canc);
755 ****************************************************************************
756 * attach object to a parent object
757 *****************************************************************************
758 * This function sets p_this as a child of p_parent, and p_parent as a parent
759 * of p_this. This link can be undone using vlc_object_detach.
760 *****************************************************************************/
761 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
763 if( !p_this ) return;
765 vlc_mutex_lock( &structure_lock );
767 /* Attach the parent to its child */
768 assert (!p_this->p_parent);
769 p_this->p_parent = p_parent;
771 /* Attach the child to its parent */
772 vlc_object_internals_t *priv = vlc_internals( p_parent );
773 INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
776 vlc_mutex_unlock( &structure_lock );
780 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
782 vlc_assert_locked (&structure_lock);
784 if (p_this->p_parent == NULL)
787 vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
791 /* Remove p_this's parent */
792 p_this->p_parent = NULL;
794 /* Remove all of p_parent's children which are p_this */
795 for( i_index = priv->i_children ; i_index-- ; )
797 if( priv->pp_children[i_index] == p_this )
800 for( i = i_index ; i < priv->i_children ; i++ )
801 priv->pp_children[i] = priv->pp_children[i+1];
805 if( priv->i_children )
807 priv->pp_children = (vlc_object_t **)realloc( priv->pp_children,
808 priv->i_children * sizeof(vlc_object_t *) );
812 /* Special case - don't realloc() to zero to avoid leaking */
813 free( priv->pp_children );
814 priv->pp_children = NULL;
820 ****************************************************************************
821 * detach object from its parent
822 *****************************************************************************
823 * This function removes all links between an object and its parent.
824 *****************************************************************************/
825 void __vlc_object_detach( vlc_object_t *p_this )
827 if( !p_this ) return;
829 vlc_mutex_lock( &structure_lock );
830 if( !p_this->p_parent )
831 msg_Err( p_this, "object is not attached" );
833 vlc_object_detach_unlocked( p_this );
834 vlc_mutex_unlock( &structure_lock );
839 ****************************************************************************
840 * find a list typed objects and increment their refcount
841 *****************************************************************************
842 * This function recursively looks for a given object type. i_mode can be one
843 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
844 *****************************************************************************/
845 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
850 /* Look for the objects */
851 switch( i_mode & 0x000f )
854 /* Modules should probably not be object, and the module should perhaps
855 * not be shared across LibVLC instances. In the mean time, this ugly
856 * hack is brought to you by Courmisch. */
857 if (i_type == VLC_OBJECT_MODULE)
858 return vlc_list_find ((vlc_object_t *)p_module_bank,
860 return vlc_list_find (p_this->p_libvlc, i_type, FIND_CHILD);
863 vlc_mutex_lock( &structure_lock );
864 i_count = CountChildren( p_this, i_type );
865 p_list = NewList( i_count );
867 /* Check allocation was successful */
868 if( p_list->i_count != i_count )
870 vlc_mutex_unlock( &structure_lock );
871 msg_Err( p_this, "list allocation failed!" );
877 ListChildren( p_list, p_this, i_type );
878 vlc_mutex_unlock( &structure_lock );
882 msg_Err( p_this, "unimplemented!" );
883 p_list = NewList( 0 );
891 * Gets the list of children of an objects, and increment their reference
893 * @return a list (possibly empty) or NULL in case of error.
895 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
898 vlc_object_internals_t *priv = vlc_internals( obj );
900 vlc_mutex_lock( &structure_lock );
901 l = NewList( priv->i_children );
902 for (int i = 0; i < l->i_count; i++)
904 vlc_object_yield( priv->pp_children[i] );
905 l->p_values[i].p_object = priv->pp_children[i];
907 vlc_mutex_unlock( &structure_lock );
911 /*****************************************************************************
912 * DumpCommand: print the current vlc structure
913 *****************************************************************************
914 * This function prints either an ASCII tree showing the connections between
915 * vlc objects, and additional information such as their refcount, thread ID,
916 * etc. (command "tree"), or the same data as a simple list (command "list").
917 *****************************************************************************/
918 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
919 vlc_value_t oldval, vlc_value_t newval, void *p_data )
921 libvlc_int_t *p_libvlc = p_this->p_libvlc;
923 (void)oldval; (void)p_data;
924 if( *psz_cmd == 'l' )
926 vlc_object_t *cur = VLC_OBJECT (p_libvlc);
928 vlc_mutex_lock( &structure_lock );
931 PrintObject (cur, "");
932 cur = vlc_internals (cur)->next;
934 while (cur != VLC_OBJECT(p_libvlc));
935 vlc_mutex_unlock( &structure_lock );
939 vlc_object_t *p_object = NULL;
941 if( *newval.psz_string )
944 int i_id = strtol( newval.psz_string, &end, 0 );
946 p_object = vlc_object_get( p_libvlc, i_id );
948 /* try using the object's name to find it */
949 p_object = vlc_object_find_name( p_this, newval.psz_string,
958 vlc_mutex_lock( &structure_lock );
960 if( *psz_cmd == 't' )
962 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
965 p_object = VLC_OBJECT(p_this->p_libvlc);
968 DumpStructure( p_object, 0, psz_foo );
970 else if( *psz_cmd == 'v' )
975 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
977 PrintObject( p_object, "" );
979 if( !vlc_internals( p_object )->i_vars )
980 printf( " `-o No variables\n" );
981 for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
983 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
985 const char *psz_type = "unknown";
986 switch( p_var->i_type & VLC_VAR_TYPE )
988 #define MYCASE( type, nice ) \
989 case VLC_VAR_ ## type: \
992 MYCASE( VOID, "void" );
993 MYCASE( BOOL, "bool" );
994 MYCASE( INTEGER, "integer" );
995 MYCASE( HOTKEY, "hotkey" );
996 MYCASE( STRING, "string" );
997 MYCASE( MODULE, "module" );
998 MYCASE( FILE, "file" );
999 MYCASE( DIRECTORY, "directory" );
1000 MYCASE( VARIABLE, "variable" );
1001 MYCASE( FLOAT, "float" );
1002 MYCASE( TIME, "time" );
1003 MYCASE( ADDRESS, "address" );
1004 MYCASE( MUTEX, "mutex" );
1005 MYCASE( LIST, "list" );
1008 printf( " %c-o \"%s\" (%s",
1009 i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
1010 p_var->psz_name, psz_type );
1011 if( p_var->psz_text )
1012 printf( ", %s", p_var->psz_text );
1014 if( p_var->i_type & VLC_VAR_HASCHOICE )
1015 printf( ", has choices" );
1016 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1017 printf( ", command" );
1018 if( p_var->i_entries )
1019 printf( ", %d callbacks", p_var->i_entries );
1020 switch( p_var->i_type & 0x00f0 )
1026 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1028 case VLC_VAR_INTEGER:
1029 printf( ": %d", p_var->val.i_int );
1031 case VLC_VAR_STRING:
1032 printf( ": \"%s\"", p_var->val.psz_string );
1035 printf( ": %f", p_var->val.f_float );
1038 printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
1040 case VLC_VAR_ADDRESS:
1041 printf( ": %p", p_var->val.p_address );
1051 vlc_mutex_unlock( &structure_lock );
1053 if( *newval.psz_string )
1055 vlc_object_release( p_object );
1062 /*****************************************************************************
1063 * vlc_list_release: free a list previously allocated by vlc_list_find
1064 *****************************************************************************
1065 * This function decreases the refcount of all objects in the list and
1067 *****************************************************************************/
1068 void vlc_list_release( vlc_list_t *p_list )
1072 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1074 vlc_object_release( p_list->p_values[i_index].p_object );
1077 free( p_list->p_values );
1081 /*****************************************************************************
1082 * dump an object. (Debug function)
1083 *****************************************************************************/
1084 static void vlc_object_dump( vlc_object_t *p_this )
1086 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1089 vlc_assert_locked( &structure_lock );
1090 DumpStructure( p_this, 0, psz_foo );
1093 /* Following functions are local */
1095 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1098 vlc_object_t *p_tmp;
1100 switch( i_mode & 0x000f )
1103 p_tmp = p_this->p_parent;
1106 if( p_tmp->i_object_type == i_type )
1108 vlc_object_yield( p_tmp );
1113 return FindObject( p_tmp, i_type, i_mode );
1119 for( i = vlc_internals( p_this )->i_children; i--; )
1121 p_tmp = vlc_internals( p_this )->pp_children[i];
1122 if( p_tmp->i_object_type == i_type )
1124 vlc_object_yield( p_tmp );
1127 else if( vlc_internals( p_tmp )->i_children )
1129 p_tmp = FindObject( p_tmp, i_type, i_mode );
1139 /* Handled in vlc_object_find */
1146 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1147 const char *psz_name,
1151 vlc_object_t *p_tmp;
1153 switch( i_mode & 0x000f )
1156 p_tmp = p_this->p_parent;
1159 if( p_tmp->psz_object_name
1160 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1162 vlc_object_yield( p_tmp );
1167 return FindObjectName( p_tmp, psz_name, i_mode );
1173 for( i = vlc_internals( p_this )->i_children; i--; )
1175 p_tmp = vlc_internals( p_this )->pp_children[i];
1176 if( p_tmp->psz_object_name
1177 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1179 vlc_object_yield( p_tmp );
1182 else if( vlc_internals( p_tmp )->i_children )
1184 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1194 /* Handled in vlc_object_find */
1202 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1204 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1207 int canc = vlc_savecancel ();
1208 memset( &psz_name, 0, sizeof(psz_name) );
1209 if( p_this->psz_object_name )
1211 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1213 psz_name[48] = '\"';
1216 psz_children[0] = '\0';
1217 switch( vlc_internals( p_this )->i_children )
1222 strcpy( psz_children, ", 1 child" );
1225 snprintf( psz_children, 19, ", %i children",
1226 vlc_internals( p_this )->i_children );
1230 psz_refcount[0] = '\0';
1231 if( vlc_internals( p_this )->i_refcount > 0 )
1232 snprintf( psz_refcount, 19, ", refcount %u",
1233 vlc_internals( p_this )->i_refcount );
1235 psz_thread[0] = '\0';
1236 if( vlc_internals( p_this )->b_thread )
1237 snprintf( psz_thread, 29, " (thread %lu)",
1238 (unsigned long)vlc_internals( p_this )->thread_id );
1240 psz_parent[0] = '\0';
1241 if( p_this->p_parent )
1242 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1244 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1245 p_this->i_object_id, p_this->psz_object_type,
1246 psz_name, psz_thread, psz_refcount, psz_children,
1248 vlc_restorecancel (canc);
1251 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1254 char i_back = psz_foo[i_level];
1255 psz_foo[i_level] = '\0';
1257 PrintObject( p_this, psz_foo );
1259 psz_foo[i_level] = i_back;
1261 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1263 msg_Warn( p_this, "structure tree is too deep" );
1267 for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
1271 psz_foo[i_level-1] = ' ';
1273 if( psz_foo[i_level-2] == '`' )
1275 psz_foo[i_level-2] = ' ';
1279 if( i == vlc_internals( p_this )->i_children - 1 )
1281 psz_foo[i_level] = '`';
1285 psz_foo[i_level] = '|';
1288 psz_foo[i_level+1] = '-';
1289 psz_foo[i_level+2] = '\0';
1291 DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
1296 static vlc_list_t * NewList( int i_count )
1298 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1299 if( p_list == NULL )
1304 p_list->i_count = i_count;
1308 p_list->p_values = NULL;
1312 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1313 if( p_list->p_values == NULL )
1315 p_list->i_count = 0;
1322 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1325 if( p_list == NULL || i_index >= p_list->i_count )
1330 vlc_object_yield( p_object );
1332 p_list->p_values[i_index].p_object = p_object;
1337 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1339 if( p_list == NULL )
1344 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1345 * sizeof( vlc_value_t ) );
1346 if( p_list->p_values == NULL )
1348 p_list->i_count = 0;
1352 vlc_object_yield( p_object );
1354 p_list->p_values[p_list->i_count].p_object = p_object;
1360 static int CountChildren( vlc_object_t *p_this, int i_type )
1362 vlc_object_t *p_tmp;
1365 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1367 p_tmp = vlc_internals( p_this )->pp_children[i];
1369 if( p_tmp->i_object_type == i_type )
1373 i_count += CountChildren( p_tmp, i_type );
1379 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1381 vlc_object_t *p_tmp;
1384 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1386 p_tmp = vlc_internals( p_this )->pp_children[i];
1388 if( p_tmp->i_object_type == i_type )
1389 ListReplace( p_list, p_tmp, p_list->i_count++ );
1391 ListChildren( p_list, p_tmp, i_type );