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 * );
75 static int FindIndex ( vlc_object_t *, vlc_object_t **, int );
77 static vlc_list_t * NewList ( int );
78 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
79 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
80 static int CountChildren ( vlc_object_t *, int );
81 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
83 static void vlc_object_destroy( vlc_object_t *p_this );
84 static void vlc_object_detach_unlocked (vlc_object_t *p_this);
86 /*****************************************************************************
87 * Local structure lock
88 *****************************************************************************/
89 static vlc_mutex_t structure_lock;
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_libvlc_global->i_objects = 0;
145 p_libvlc_global->pp_objects = NULL;
146 vlc_mutex_init( &structure_lock );
150 p_libvlc_global = vlc_global();
151 if( i_type == VLC_OBJECT_LIBVLC )
152 p_new->p_libvlc = (libvlc_int_t*)p_new;
154 p_new->p_libvlc = p_this->p_libvlc;
157 vlc_spin_init( &p_priv->ref_spin );
158 p_priv->i_refcount = 1;
159 p_priv->pf_destructor = NULL;
160 p_priv->b_thread = false;
161 p_new->p_parent = NULL;
162 p_new->pp_children = NULL;
163 p_new->i_children = 0;
165 p_new->p_private = NULL;
167 /* Initialize mutexes and condvars */
168 vlc_mutex_init( &p_new->object_lock );
169 vlc_cond_init( p_new, &p_new->object_wait );
170 vlc_mutex_init( &p_priv->var_lock );
171 vlc_spin_init( &p_priv->spin );
172 p_priv->pipes[0] = p_priv->pipes[1] = -1;
174 vlc_mutex_lock( &structure_lock );
175 p_new->i_object_id = p_libvlc_global->i_counter++;
176 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
177 * useless to try and recover anything if pp_objects gets smashed. */
178 TAB_APPEND( p_libvlc_global->i_objects, p_libvlc_global->pp_objects,
180 vlc_mutex_unlock( &structure_lock );
182 if( i_type == VLC_OBJECT_LIBVLC )
184 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
185 var_AddCallback( p_new, "list", DumpCommand, NULL );
186 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
187 var_AddCallback( p_new, "tree", DumpCommand, NULL );
188 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
189 var_AddCallback( p_new, "vars", DumpCommand, NULL );
197 * Allocates and initializes a vlc object.
199 * @param i_type known object type (all of them are negative integer values),
200 * or object byte size (always positive).
202 * @return the new object, or NULL on error.
204 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
206 const char * psz_type;
211 case VLC_OBJECT_LIBVLC:
212 i_size = sizeof(libvlc_int_t);
215 case VLC_OBJECT_INTF:
216 i_size = sizeof(intf_thread_t);
217 psz_type = "interface";
219 case VLC_OBJECT_DIALOGS:
220 i_size = sizeof(intf_thread_t);
221 psz_type = "dialogs";
223 case VLC_OBJECT_DEMUX:
224 i_size = sizeof(demux_t);
227 case VLC_OBJECT_ACCESS:
228 i_size = sizeof(access_t);
231 case VLC_OBJECT_DECODER:
232 i_size = sizeof(decoder_t);
233 psz_type = "decoder";
235 case VLC_OBJECT_PACKETIZER:
236 i_size = sizeof(decoder_t);
237 psz_type = "packetizer";
239 case VLC_OBJECT_ENCODER:
240 i_size = sizeof(encoder_t);
241 psz_type = "encoder";
243 case VLC_OBJECT_FILTER:
244 i_size = sizeof(filter_t);
247 case VLC_OBJECT_VOUT:
248 i_size = sizeof(vout_thread_t);
249 psz_type = "video output";
251 case VLC_OBJECT_AOUT:
252 i_size = sizeof(aout_instance_t);
253 psz_type = "audio output";
255 case VLC_OBJECT_SOUT:
256 i_size = sizeof(sout_instance_t);
257 psz_type = "stream output";
259 case VLC_OBJECT_OPENGL:
260 i_size = sizeof( vout_thread_t );
263 case VLC_OBJECT_ANNOUNCE:
264 i_size = sizeof( announce_handler_t );
265 psz_type = "announce";
267 case VLC_OBJECT_INTERACTION:
268 i_size = sizeof( interaction_t );
269 psz_type = "interaction";
272 i_size = i_type > (int)sizeof(vlc_object_t)
273 ? i_type : (int)sizeof(vlc_object_t);
274 i_type = VLC_OBJECT_GENERIC;
275 psz_type = "generic";
279 return vlc_custom_create( p_this, i_size, i_type, psz_type );
284 ****************************************************************************
285 * Set the destructor of a vlc object
287 * This function sets the destructor of the vlc object. It will be called
288 * when the object is destroyed when the its refcount reaches 0.
289 * (It is called by the internal function vlc_object_destroy())
290 *****************************************************************************/
291 void __vlc_object_set_destructor( vlc_object_t *p_this,
292 vlc_destructor_t pf_destructor )
294 vlc_object_internals_t *p_priv = vlc_internals(p_this );
295 p_priv->pf_destructor = pf_destructor;
299 ****************************************************************************
300 * Destroy a vlc object (Internal)
302 * This function destroys an object that has been previously allocated with
303 * vlc_object_create. The object's refcount must be zero and it must not be
304 * attached to other objects in any way.
305 *****************************************************************************/
306 static void vlc_object_destroy( vlc_object_t *p_this )
308 vlc_object_internals_t *p_priv = vlc_internals( p_this );
310 /* Objects are always detached beforehand */
311 assert( !p_this->p_parent );
313 /* Send a kill to the object's thread if applicable */
314 vlc_object_kill( p_this );
316 /* If we are running on a thread, wait until it ends */
317 if( p_priv->b_thread )
318 vlc_thread_join( p_this );
320 /* Call the custom "subclass" destructor */
321 if( p_priv->pf_destructor )
322 p_priv->pf_destructor( p_this );
325 if( p_this->i_children )
330 "ERROR: cannot delete object (%i, %s) with %d children\n",
331 p_this->i_object_id, p_this->psz_object_name,
332 p_this->i_children );
334 for( i = 0; i < p_this->i_children; i++ )
337 "ERROR: Remaining children object "
338 "(id:%i, type:%s, name:%s)\n",
339 p_this->pp_children[i]->i_object_id,
340 p_this->pp_children[i]->psz_object_type,
341 p_this->pp_children[i]->psz_object_name );
345 /* Dump libvlc object to ease debugging */
346 vlc_object_dump( p_this->p_libvlc );
351 /* Destroy the associated variables, starting from the end so that
352 * no memmove calls have to be done. */
353 while( p_priv->i_vars )
355 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
358 free( p_priv->p_vars );
359 vlc_mutex_destroy( &p_priv->var_lock );
361 free( p_this->psz_header );
363 if( p_this->p_libvlc == NULL )
365 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
368 assert( p_global == vlc_global() );
370 if( p_global->i_objects > 0 )
373 for( i = 0; i < p_global->i_objects; i++ )
375 /* We are leaking this object */
377 "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
378 p_global->pp_objects[i]->i_object_id,
379 p_global->pp_objects[i]->psz_object_type,
380 p_global->pp_objects[i]->psz_object_name );
382 /* Dump libvlc object to ease debugging */
383 vlc_object_dump( p_global->pp_objects[i] );
388 /* Dump libvlc object to ease debugging */
389 vlc_object_dump( p_this );
391 /* Strongly abort, cause we want these to be fixed */
396 /* We are the global object ... no need to lock. */
397 free( p_global->pp_objects );
398 p_global->pp_objects = NULL;
400 vlc_mutex_destroy( &structure_lock );
403 FREENULL( p_this->psz_object_name );
405 #if defined(WIN32) || defined(UNDER_CE)
406 /* if object has an associated thread, close it now */
407 if( p_priv->thread_id )
408 CloseHandle(p_priv->thread_id);
411 vlc_spin_destroy( &p_priv->ref_spin );
412 vlc_mutex_destroy( &p_this->object_lock );
413 vlc_cond_destroy( &p_this->object_wait );
414 vlc_spin_destroy( &p_priv->spin );
415 if( p_priv->pipes[1] != -1 )
416 close( p_priv->pipes[1] );
417 if( p_priv->pipes[0] != -1 )
418 close( p_priv->pipes[0] );
424 /** Inter-object signaling */
426 void __vlc_object_lock( vlc_object_t *obj )
428 vlc_mutex_lock( &obj->object_lock );
431 void __vlc_object_unlock( vlc_object_t *obj )
433 vlc_assert_locked( &obj->object_lock );
434 vlc_mutex_unlock( &obj->object_lock );
438 # include <winsock2.h>
439 # include <ws2tcpip.h>
442 * select()-able pipes emulated using Winsock
444 static int pipe (int fd[2])
447 int addrlen = sizeof (addr);
449 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
450 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
451 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
454 memset (&addr, 0, sizeof (addr));
455 addr.sin_family = AF_INET;
456 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
457 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
458 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
460 || connect (c, (PSOCKADDR)&addr, addrlen))
463 a = accept (l, NULL, NULL);
464 if (a == INVALID_SOCKET)
475 if (l != INVALID_SOCKET)
477 if (c != INVALID_SOCKET)
483 #define read( a, b, c ) recv (a, b, c, 0)
485 #define write( a, b, c ) send (a, b, c, 0)
487 #define close( a ) closesocket (a)
491 * Returns the readable end of a pipe that becomes readable once termination
492 * of the object is requested (vlc_object_kill()).
493 * This can be used to wake-up out of a select() or poll() event loop, such
494 * typically when doing network I/O.
496 * Note that the pipe will remain the same for the lifetime of the object.
497 * DO NOT read the pipe nor close it yourself. Ever.
499 * @param obj object that would be "killed"
500 * @return a readable pipe descriptor, or -1 on error.
502 int __vlc_object_waitpipe( vlc_object_t *obj )
504 int pfd[2] = { -1, -1 };
505 vlc_object_internals_t *internals = vlc_internals( obj );
508 vlc_spin_lock (&internals->spin);
509 if (internals->pipes[0] == -1)
511 /* This can only ever happen if someone killed us without locking: */
512 assert (internals->pipes[1] == -1);
513 vlc_spin_unlock (&internals->spin);
518 vlc_spin_lock (&internals->spin);
519 if (internals->pipes[0] == -1)
521 internals->pipes[0] = pfd[0];
522 internals->pipes[1] = pfd[1];
523 pfd[0] = pfd[1] = -1;
527 vlc_spin_unlock (&internals->spin);
531 /* Race condition: vlc_object_kill() already invoked! */
534 vlc_spin_lock (&internals->spin);
535 fd = internals->pipes[1];
536 internals->pipes[1] = -1;
537 vlc_spin_unlock (&internals->spin);
539 msg_Dbg (obj, "waitpipe: object already dying");
544 /* Race condition: two threads call pipe() - unlikely */
550 return internals->pipes[0];
555 * Waits for the object to be signaled (using vlc_object_signal()).
556 * If the object already has a signal pending, this function will return
557 * immediately. It is asserted that the caller holds the object lock.
559 * @return true if the object is dying and should terminate.
561 bool __vlc_object_wait( vlc_object_t *obj )
563 vlc_assert_locked( &obj->object_lock );
564 vlc_cond_wait( &obj->object_wait, &obj->object_lock );
570 * Waits for the object to be signaled (using vlc_object_signal()), or for
572 * If the object already has a signal pending, this function will return
573 * immediately. It is asserted that the caller holds the object lock.
575 * @return negative if the object is dying and should terminate,
576 * positive if the the object has been signaled but is not dying,
577 * 0 if timeout has been reached.
579 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
583 vlc_assert_locked( &obj->object_lock );
584 v = vlc_cond_timedwait( &obj->object_wait, &obj->object_lock, deadline );
585 if( v == 0 ) /* signaled */
586 return obj->b_die ? -1 : 1;
592 * Checks whether an object has been "killed".
593 * The object lock must be held.
595 * Typical code for an object thread could be:
597 vlc_object_lock (self);
599 while (vlc_object_alive (self))
603 if (vlc_object_wait (self))
608 ...deinitialization...
609 vlc_object_unlock (self);
612 * @return true iff the object has not been killed yet
614 bool __vlc_object_alive( vlc_object_t *obj )
616 vlc_assert_locked( &obj->object_lock );
622 * Signals an object for which the lock is held.
624 void __vlc_object_signal_unlocked( vlc_object_t *obj )
626 vlc_assert_locked (&obj->object_lock);
627 vlc_cond_signal( &obj->object_wait );
632 * Requests termination of an object.
633 * If the object is LibVLC, also request to terminate all its children.
635 void __vlc_object_kill( vlc_object_t *p_this )
637 vlc_object_internals_t *internals = vlc_internals( p_this );
640 vlc_mutex_lock( &p_this->object_lock );
641 p_this->b_die = true;
643 vlc_spin_lock (&internals->spin);
644 fd = internals->pipes[1];
645 internals->pipes[1] = -1;
646 vlc_spin_unlock (&internals->spin);
650 msg_Dbg (p_this, "waitpipe: object killed");
654 if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
655 for( int i = 0; i < p_this->i_children ; i++ )
656 vlc_object_kill( p_this->pp_children[i] );
658 vlc_object_signal_unlocked( p_this );
659 vlc_mutex_unlock( &p_this->object_lock );
664 * find an object given its ID
666 * This function looks for the object whose i_object_id field is i_id. We
667 * use a dichotomy so that lookups are in log2(n).
668 *****************************************************************************/
669 void * vlc_object_get( int i_id )
672 vlc_object_t **pp_objects;
673 libvlc_global_data_t *p_libvlc_global = vlc_global();
674 vlc_object_t *obj = NULL;
676 vlc_mutex_lock( &structure_lock );
678 pp_objects = p_libvlc_global->pp_objects;
680 /* Perform our dichotomy */
681 for( i_max = p_libvlc_global->i_objects - 1 ; ; )
683 i_middle = i_max / 2;
685 if( pp_objects[i_middle]->i_object_id > i_id )
689 else if( pp_objects[i_middle]->i_object_id < i_id )
693 pp_objects += i_middle;
698 /* This happens when there are only two remaining objects */
699 if( pp_objects[i_middle+1]->i_object_id == i_id )
701 vlc_object_yield( pp_objects[i_middle+1] );
702 obj = pp_objects[i_middle+1];
709 vlc_object_yield( pp_objects[i_middle] );
710 obj = pp_objects[i_middle];
715 vlc_mutex_unlock( &structure_lock );
720 ****************************************************************************
721 * find a typed object and increment its refcount
722 *****************************************************************************
723 * This function recursively looks for a given object type. i_mode can be one
724 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
725 *****************************************************************************/
726 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
728 vlc_object_t *p_found;
730 /* If we are of the requested type ourselves, don't look further */
731 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
733 vlc_object_yield( p_this );
737 vlc_mutex_lock( &structure_lock );
739 /* Otherwise, recursively look for the object */
740 if( (i_mode & 0x000f) == FIND_ANYWHERE )
742 vlc_object_t *p_root = p_this;
745 while( p_root->p_parent != NULL &&
746 p_root != VLC_OBJECT( p_this->p_libvlc ) )
748 p_root = p_root->p_parent;
751 p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
752 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
754 p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
755 i_type, (i_mode & ~0x000f)|FIND_CHILD );
760 p_found = FindObject( p_this, i_type, i_mode );
763 vlc_mutex_unlock( &structure_lock );
769 ****************************************************************************
770 * find a named object and increment its refcount
771 *****************************************************************************
772 * This function recursively looks for a given object name. i_mode can be one
773 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
774 *****************************************************************************/
775 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
778 vlc_object_t *p_found;
780 /* If have the requested name ourselves, don't look further */
781 if( !(i_mode & FIND_STRICT)
782 && p_this->psz_object_name
783 && !strcmp( p_this->psz_object_name, psz_name ) )
785 vlc_object_yield( p_this );
789 vlc_mutex_lock( &structure_lock );
791 /* Otherwise, recursively look for the object */
792 if( (i_mode & 0x000f) == FIND_ANYWHERE )
794 vlc_object_t *p_root = p_this;
797 while( p_root->p_parent != NULL &&
798 p_root != VLC_OBJECT( p_this->p_libvlc ) )
800 p_root = p_root->p_parent;
803 p_found = FindObjectName( p_root, psz_name,
804 (i_mode & ~0x000f)|FIND_CHILD );
805 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
807 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
808 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
813 p_found = FindObjectName( p_this, psz_name, i_mode );
816 vlc_mutex_unlock( &structure_lock );
822 * Increment an object reference counter.
824 void __vlc_object_yield( vlc_object_t *p_this )
826 vlc_object_internals_t *internals = vlc_internals( p_this );
828 vlc_spin_lock( &internals->ref_spin );
829 /* Avoid obvious freed object uses */
830 assert( internals->i_refcount > 0 );
831 /* Increment the counter */
832 internals->i_refcount++;
833 vlc_spin_unlock( &internals->ref_spin );
836 /*****************************************************************************
837 * decrement an object refcount
838 * And destroy the object if its refcount reach zero.
839 *****************************************************************************/
840 void __vlc_object_release( vlc_object_t *p_this )
842 vlc_object_internals_t *internals = vlc_internals( p_this );
843 bool b_should_destroy;
845 vlc_spin_lock( &internals->ref_spin );
846 assert( internals->i_refcount > 0 );
848 if( internals->i_refcount > 1 )
851 /* There are still other references to the object */
852 internals->i_refcount--;
853 vlc_spin_unlock( &internals->ref_spin );
856 vlc_spin_unlock( &internals->ref_spin );
859 /* Remember that we cannot hold the spin while waiting on the mutex */
860 vlc_mutex_lock( &structure_lock );
861 /* Take the spin again. Note that another thread may have yielded the
862 * object in the (very short) mean time. */
863 vlc_spin_lock( &internals->ref_spin );
864 b_should_destroy = --internals->i_refcount == 0;
865 vlc_spin_unlock( &internals->ref_spin );
867 if( b_should_destroy )
869 /* Remove the object from the table
870 * so that it cannot be encountered by vlc_object_get() */
871 libvlc_global_data_t *p_libvlc_global = vlc_global();
874 i_index = FindIndex( p_this, p_libvlc_global->pp_objects,
875 p_libvlc_global->i_objects );
876 REMOVE_ELEM( p_libvlc_global->pp_objects,
877 p_libvlc_global->i_objects, i_index );
879 /* Detach from parent to protect against FIND_CHILDREN */
880 if (p_this->p_parent)
881 vlc_object_detach_unlocked (p_this);
882 /* Detach from children to protect against FIND_PARENT */
883 for (int i = 0; i < p_this->i_children; i++)
884 p_this->pp_children[i]->p_parent = NULL;
887 vlc_mutex_unlock( &structure_lock );
889 if( b_should_destroy )
890 vlc_object_destroy( p_this );
894 ****************************************************************************
895 * attach object to a parent object
896 *****************************************************************************
897 * This function sets p_this as a child of p_parent, and p_parent as a parent
898 * of p_this. This link can be undone using vlc_object_detach.
899 *****************************************************************************/
900 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
902 if( !p_this ) return;
904 vlc_mutex_lock( &structure_lock );
906 /* Attach the parent to its child */
907 assert (!p_this->p_parent);
908 p_this->p_parent = p_parent;
910 /* Attach the child to its parent */
911 INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
912 p_parent->i_children, p_this );
914 vlc_mutex_unlock( &structure_lock );
918 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
920 assert (p_this->p_parent);
922 vlc_object_t *p_parent = p_this->p_parent;
925 /* Remove p_this's parent */
926 p_this->p_parent = NULL;
928 /* Remove all of p_parent's children which are p_this */
929 for( i_index = p_parent->i_children ; i_index-- ; )
931 if( p_parent->pp_children[i_index] == p_this )
933 p_parent->i_children--;
934 for( i = i_index ; i < p_parent->i_children ; i++ )
936 p_parent->pp_children[i] = p_parent->pp_children[i+1];
941 if( p_parent->i_children )
943 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
944 p_parent->i_children * sizeof(vlc_object_t *) );
948 /* Special case - don't realloc() to zero to avoid leaking */
949 free( p_parent->pp_children );
950 p_parent->pp_children = NULL;
956 ****************************************************************************
957 * detach object from its parent
958 *****************************************************************************
959 * This function removes all links between an object and its parent.
960 *****************************************************************************/
961 void __vlc_object_detach( vlc_object_t *p_this )
963 if( !p_this ) return;
965 vlc_mutex_lock( &structure_lock );
967 if( !p_this->p_parent )
969 msg_Err( p_this, "object is not attached" );
970 vlc_mutex_unlock( &structure_lock );
974 vlc_object_detach_unlocked( p_this );
975 vlc_mutex_unlock( &structure_lock );
980 ****************************************************************************
981 * find a list typed objects and increment their refcount
982 *****************************************************************************
983 * This function recursively looks for a given object type. i_mode can be one
984 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
985 *****************************************************************************/
986 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
991 /* Look for the objects */
992 switch( i_mode & 0x000f )
995 return vlc_list_find (vlc_global (), i_type, FIND_CHILD);
998 vlc_mutex_lock( &structure_lock );
999 i_count = CountChildren( p_this, i_type );
1000 p_list = NewList( i_count );
1002 /* Check allocation was successful */
1003 if( p_list->i_count != i_count )
1005 msg_Err( p_this, "list allocation failed!" );
1006 p_list->i_count = 0;
1010 p_list->i_count = 0;
1011 ListChildren( p_list, p_this, i_type );
1012 vlc_mutex_unlock( &structure_lock );
1016 msg_Err( p_this, "unimplemented!" );
1017 p_list = NewList( 0 );
1025 * Gets the list of children of an objects, and increment their reference
1027 * @return a list (possibly empty) or NULL in case of error.
1029 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
1033 vlc_mutex_lock( &structure_lock );
1034 l = NewList( obj->i_children );
1035 for (int i = 0; i < l->i_count; i++)
1037 vlc_object_yield( obj->pp_children[i] );
1038 l->p_values[i].p_object = obj->pp_children[i];
1040 vlc_mutex_unlock( &structure_lock );
1044 /*****************************************************************************
1045 * DumpCommand: print the current vlc structure
1046 *****************************************************************************
1047 * This function prints either an ASCII tree showing the connections between
1048 * vlc objects, and additional information such as their refcount, thread ID,
1049 * etc. (command "tree"), or the same data as a simple list (command "list").
1050 *****************************************************************************/
1051 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
1052 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1054 libvlc_global_data_t *p_libvlc_global = vlc_global();
1056 (void)oldval; (void)p_data;
1057 if( *psz_cmd == 'l' )
1059 vlc_mutex_lock( &structure_lock );
1061 vlc_object_t **pp_current, **pp_end;
1063 pp_current = p_libvlc_global->pp_objects;
1064 pp_end = pp_current + p_libvlc_global->i_objects;
1066 for( ; pp_current < pp_end ; pp_current++ )
1067 PrintObject( *pp_current, "" );
1069 vlc_mutex_unlock( &structure_lock );
1073 vlc_object_t *p_object = NULL;
1075 if( *newval.psz_string )
1078 int i_id = strtol( newval.psz_string, &end, 0 );
1079 if( end != newval.psz_string )
1080 p_object = vlc_object_get( i_id );
1083 /* try using the object's name to find it */
1084 vlc_object_t *p_libvlc = vlc_object_get( 1 );
1087 /* Look in p_libvlc's children tree */
1088 p_object = vlc_object_find_name( p_libvlc,
1091 vlc_object_release( p_libvlc );
1095 /* If it's not in libvlc, look in libvlc_global (== p_this) */
1096 p_object = vlc_object_find_name( p_this,
1108 vlc_mutex_lock( &structure_lock );
1110 if( *psz_cmd == 't' )
1112 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1115 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1118 DumpStructure( p_object, 0, psz_foo );
1120 else if( *psz_cmd == 'v' )
1125 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1127 PrintObject( p_object, "" );
1129 if( !vlc_internals( p_object )->i_vars )
1130 printf( " `-o No variables\n" );
1131 for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
1133 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
1135 const char *psz_type = "unknown";
1136 switch( p_var->i_type & VLC_VAR_TYPE )
1138 #define MYCASE( type, nice ) \
1139 case VLC_VAR_ ## type: \
1142 MYCASE( VOID, "void" );
1143 MYCASE( BOOL, "bool" );
1144 MYCASE( INTEGER, "integer" );
1145 MYCASE( HOTKEY, "hotkey" );
1146 MYCASE( STRING, "string" );
1147 MYCASE( MODULE, "module" );
1148 MYCASE( FILE, "file" );
1149 MYCASE( DIRECTORY, "directory" );
1150 MYCASE( VARIABLE, "variable" );
1151 MYCASE( FLOAT, "float" );
1152 MYCASE( TIME, "time" );
1153 MYCASE( ADDRESS, "address" );
1154 MYCASE( MUTEX, "mutex" );
1155 MYCASE( LIST, "list" );
1158 printf( " %c-o \"%s\" (%s",
1159 i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
1160 p_var->psz_name, psz_type );
1161 if( p_var->psz_text )
1162 printf( ", %s", p_var->psz_text );
1164 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1165 printf( ", command" );
1166 if( p_var->i_entries )
1167 printf( ", %d callbacks", p_var->i_entries );
1168 switch( p_var->i_type & 0x00f0 )
1174 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1176 case VLC_VAR_INTEGER:
1177 printf( ": %d", p_var->val.i_int );
1179 case VLC_VAR_STRING:
1180 printf( ": \"%s\"", p_var->val.psz_string );
1183 printf( ": %f", p_var->val.f_float );
1186 printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
1188 case VLC_VAR_ADDRESS:
1189 printf( ": %p", p_var->val.p_address );
1199 vlc_mutex_unlock( &structure_lock );
1201 if( *newval.psz_string )
1203 vlc_object_release( p_object );
1210 /*****************************************************************************
1211 * vlc_list_release: free a list previously allocated by vlc_list_find
1212 *****************************************************************************
1213 * This function decreases the refcount of all objects in the list and
1215 *****************************************************************************/
1216 void vlc_list_release( vlc_list_t *p_list )
1220 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1222 vlc_object_release( p_list->p_values[i_index].p_object );
1225 free( p_list->p_values );
1229 /*****************************************************************************
1230 * dump an object. (Debug function)
1231 *****************************************************************************/
1232 void __vlc_object_dump( vlc_object_t *p_this )
1234 vlc_mutex_lock( &structure_lock );
1235 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1237 DumpStructure( p_this, 0, psz_foo );
1238 vlc_mutex_unlock( &structure_lock );
1241 /* Following functions are local */
1243 /*****************************************************************************
1244 * FindIndex: find the index of an object in an array of objects
1245 *****************************************************************************
1246 * This function assumes that p_this can be found in pp_objects. It will not
1247 * crash if p_this cannot be found, but will return a wrong value. It is your
1248 * duty to check the return value if you are not certain that the object could
1249 * be found for sure.
1250 *****************************************************************************/
1251 static int FindIndex( vlc_object_t *p_this,
1252 vlc_object_t **pp_objects, int i_count )
1254 int i_middle = i_count / 2;
1261 if( pp_objects[i_middle] == p_this )
1271 /* We take advantage of the sorted array */
1272 if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
1274 return i_middle + FindIndex( p_this, pp_objects + i_middle,
1275 i_count - i_middle );
1279 return FindIndex( p_this, pp_objects, i_middle );
1283 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1286 vlc_object_t *p_tmp;
1288 switch( i_mode & 0x000f )
1291 p_tmp = p_this->p_parent;
1294 if( p_tmp->i_object_type == i_type )
1296 vlc_object_yield( p_tmp );
1301 return FindObject( p_tmp, i_type, i_mode );
1307 for( i = p_this->i_children; i--; )
1309 p_tmp = p_this->pp_children[i];
1310 if( p_tmp->i_object_type == i_type )
1312 vlc_object_yield( p_tmp );
1315 else if( p_tmp->i_children )
1317 p_tmp = FindObject( p_tmp, i_type, i_mode );
1327 /* Handled in vlc_object_find */
1334 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1335 const char *psz_name,
1339 vlc_object_t *p_tmp;
1341 switch( i_mode & 0x000f )
1344 p_tmp = p_this->p_parent;
1347 if( p_tmp->psz_object_name
1348 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1350 vlc_object_yield( p_tmp );
1355 return FindObjectName( p_tmp, psz_name, i_mode );
1361 for( i = p_this->i_children; i--; )
1363 p_tmp = p_this->pp_children[i];
1364 if( p_tmp->psz_object_name
1365 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1367 vlc_object_yield( p_tmp );
1370 else if( p_tmp->i_children )
1372 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1382 /* Handled in vlc_object_find */
1390 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1392 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1395 memset( &psz_name, 0, sizeof(psz_name) );
1396 if( p_this->psz_object_name )
1398 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1400 psz_name[48] = '\"';
1403 psz_children[0] = '\0';
1404 switch( p_this->i_children )
1409 strcpy( psz_children, ", 1 child" );
1412 snprintf( psz_children, 19, ", %i children", p_this->i_children );
1416 psz_refcount[0] = '\0';
1417 if( vlc_internals( p_this )->i_refcount > 0 )
1418 snprintf( psz_refcount, 19, ", refcount %u",
1419 vlc_internals( p_this )->i_refcount );
1421 psz_thread[0] = '\0';
1422 if( vlc_internals( p_this )->b_thread )
1423 snprintf( psz_thread, 29, " (thread %lu)",
1424 (unsigned long)vlc_internals( p_this )->thread_id );
1426 psz_parent[0] = '\0';
1427 if( p_this->p_parent )
1428 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1430 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1431 p_this->i_object_id, p_this->psz_object_type,
1432 psz_name, psz_thread, psz_refcount, psz_children,
1436 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1439 char i_back = psz_foo[i_level];
1440 psz_foo[i_level] = '\0';
1442 PrintObject( p_this, psz_foo );
1444 psz_foo[i_level] = i_back;
1446 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1448 msg_Warn( p_this, "structure tree is too deep" );
1452 for( i = 0 ; i < p_this->i_children ; i++ )
1456 psz_foo[i_level-1] = ' ';
1458 if( psz_foo[i_level-2] == '`' )
1460 psz_foo[i_level-2] = ' ';
1464 if( i == p_this->i_children - 1 )
1466 psz_foo[i_level] = '`';
1470 psz_foo[i_level] = '|';
1473 psz_foo[i_level+1] = '-';
1474 psz_foo[i_level+2] = '\0';
1476 DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
1480 static vlc_list_t * NewList( int i_count )
1482 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1483 if( p_list == NULL )
1488 p_list->i_count = i_count;
1492 p_list->p_values = NULL;
1496 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1497 if( p_list->p_values == NULL )
1499 p_list->i_count = 0;
1506 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1509 if( p_list == NULL || i_index >= p_list->i_count )
1514 vlc_object_yield( p_object );
1516 p_list->p_values[i_index].p_object = p_object;
1521 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1523 if( p_list == NULL )
1528 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1529 * sizeof( vlc_value_t ) );
1530 if( p_list->p_values == NULL )
1532 p_list->i_count = 0;
1536 vlc_object_yield( p_object );
1538 p_list->p_values[p_list->i_count].p_object = p_object;
1544 static int CountChildren( vlc_object_t *p_this, int i_type )
1546 vlc_object_t *p_tmp;
1549 for( i = 0; i < p_this->i_children; i++ )
1551 p_tmp = p_this->pp_children[i];
1553 if( p_tmp->i_object_type == i_type )
1558 if( p_tmp->i_children )
1560 i_count += CountChildren( p_tmp, i_type );
1567 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1569 vlc_object_t *p_tmp;
1572 for( i = 0; i < p_this->i_children; i++ )
1574 p_tmp = p_this->pp_children[i];
1576 if( p_tmp->i_object_type == i_type )
1578 ListReplace( p_list, p_tmp, p_list->i_count++ );
1581 if( p_tmp->i_children )
1583 ListChildren( p_list, p_tmp, i_type );