2fe32064ed7281e3d24c30ac3d6fee5fc3986202
[vlc.git] / src / misc / objects.c
1 /*****************************************************************************
2  * objects.c: vlc_object_t handling
3  *****************************************************************************
4  * Copyright (C) 2004-2008 the VideoLAN team
5  *
6  * Authors: Samuel Hocevar <sam@zoy.org>
7  *
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.
12  *
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.
17  *
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  *****************************************************************************/
22
23 /**
24  * \file
25  * This file contains the functions to handle the vlc_object_t type
26  *
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.
29  */
30
31
32 /*****************************************************************************
33  * Preamble
34  *****************************************************************************/
35 #ifdef HAVE_CONFIG_H
36 # include "config.h"
37 #endif
38
39 #include <vlc_common.h>
40
41 #include "../libvlc.h"
42 #include <vlc_aout.h>
43 #include "audio_output/aout_internal.h"
44
45 #include "vlc_interface.h"
46 #include "vlc_codec.h"
47
48 #include "variables.h"
49 #ifndef WIN32
50 # include <unistd.h>
51 #else
52 # include <io.h>
53 # include <fcntl.h>
54 # include <errno.h> /* ENOSYS */
55 #endif
56
57 #include <assert.h>
58
59 #ifdef __linux__
60 # if defined (HAVE_SYS_EVENTFD_H)
61 #  include <sys/eventfd.h>
62 # else
63 #  include <sys/syscall.h>
64 static inline int eventfd (unsigned int initval, int flags)
65 {
66     return syscall (SYS_eventfd, initval, flags);
67 }
68 # endif
69 # define HAVE_EVENTFD 1
70 #endif
71
72
73 /*****************************************************************************
74  * Local prototypes
75  *****************************************************************************/
76 static int  DumpCommand( vlc_object_t *, char const *,
77                          vlc_value_t, vlc_value_t, void * );
78
79 static vlc_object_t * FindObject    ( vlc_object_t *, int, int );
80 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
81 static void           PrintObject   ( vlc_object_t *, const char * );
82 static void           DumpStructure ( vlc_object_t *, int, char * );
83
84 static vlc_list_t   * NewList       ( int );
85 static void           ListReplace   ( vlc_list_t *, vlc_object_t *, int );
86 /*static void           ListAppend    ( vlc_list_t *, vlc_object_t * );*/
87 static int            CountChildren ( vlc_object_t *, int );
88 static void           ListChildren  ( vlc_list_t *, vlc_object_t *, int );
89
90 static void vlc_object_destroy( vlc_object_t *p_this );
91 static void vlc_object_detach_unlocked (vlc_object_t *p_this);
92 #ifndef NDEBUG
93 static void vlc_object_dump( vlc_object_t *p_this );
94 #endif
95
96 /*****************************************************************************
97  * Local structure lock
98  *****************************************************************************/
99 static void libvlc_lock (libvlc_int_t *p_libvlc)
100 {
101     vlc_mutex_lock (&(libvlc_priv (p_libvlc)->structure_lock));
102 }
103
104 static void libvlc_unlock (libvlc_int_t *p_libvlc)
105 {
106     vlc_mutex_unlock (&(libvlc_priv (p_libvlc)->structure_lock));
107 }
108
109 void *__vlc_custom_create( vlc_object_t *p_this, size_t i_size,
110                            int i_type, const char *psz_type )
111 {
112     vlc_object_t *p_new;
113     vlc_object_internals_t *p_priv;
114
115     /* NOTE:
116      * VLC objects are laid out as follow:
117      * - first the LibVLC-private per-object data,
118      * - then VLC_COMMON members from vlc_object_t,
119      * - finally, the type-specific data (if any).
120      *
121      * This function initializes the LibVLC and common data,
122      * and zeroes the rest.
123      */
124     p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
125     if( p_priv == NULL )
126         return NULL;
127
128     assert (i_size >= sizeof (vlc_object_t));
129     p_new = (vlc_object_t *)(p_priv + 1);
130
131     p_priv->i_object_type = i_type;
132     p_new->psz_object_type = psz_type;
133     p_new->psz_object_name = NULL;
134
135     p_new->b_die = false;
136     p_new->b_error = false;
137     p_new->b_force = false;
138
139     p_new->psz_header = NULL;
140
141     if (p_this)
142         p_new->i_flags = p_this->i_flags
143             & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
144
145     p_priv->p_vars = calloc( 16, sizeof( variable_t ) );
146
147     if( !p_priv->p_vars )
148     {
149         free( p_priv );
150         return NULL;
151     }
152
153     if( p_this == NULL )
154     {
155         libvlc_int_t *self = (libvlc_int_t*)p_new;
156         p_new->p_libvlc = self;
157         vlc_mutex_init (&(libvlc_priv (self)->structure_lock));
158         p_this = p_priv->next = p_priv->prev = p_new;
159     }
160     else
161         p_new->p_libvlc = p_this->p_libvlc;
162
163     vlc_spin_init( &p_priv->ref_spin );
164     p_priv->i_refcount = 1;
165     p_priv->pf_destructor = NULL;
166     p_priv->b_thread = false;
167     p_new->p_parent = NULL;
168     p_priv->pp_children = NULL;
169     p_priv->i_children = 0;
170
171     p_new->p_private = NULL;
172
173     /* Initialize mutexes and condvars */
174     vlc_mutex_init( &p_priv->lock );
175     vlc_mutex_init( &p_priv->var_lock );
176     vlc_cond_init( &p_priv->var_wait );
177     p_priv->pipes[0] = p_priv->pipes[1] = -1;
178
179     p_priv->next = p_this;
180     libvlc_lock (p_new->p_libvlc);
181     p_priv->prev = vlc_internals (p_this)->prev;
182     vlc_internals (p_this)->prev = p_new;
183     vlc_internals (p_priv->prev)->next = p_new;
184     libvlc_unlock (p_new->p_libvlc);
185
186     if (p_new == VLC_OBJECT(p_new->p_libvlc))
187     {   /* TODO: should be in src/libvlc.c */
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);
196     }
197
198     return p_new;
199 }
200
201
202 /**
203  * Allocates and initializes a vlc object.
204  *
205  * @param i_type known object type (all of them are negative integer values),
206  *               or object byte size (always positive).
207  *
208  * @return the new object, or NULL on error.
209  */
210 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
211 {
212     const char   * psz_type;
213     size_t         i_size;
214
215     switch( i_type )
216     {
217         case VLC_OBJECT_INTF:
218             i_size = sizeof(intf_thread_t);
219             psz_type = "interface";
220             break;
221         case VLC_OBJECT_DECODER:
222             i_size = sizeof(decoder_t);
223             psz_type = "decoder";
224             break;
225         case VLC_OBJECT_PACKETIZER:
226             i_size = sizeof(decoder_t);
227             psz_type = "packetizer";
228             break;
229         case VLC_OBJECT_AOUT:
230             i_size = sizeof(aout_instance_t);
231             psz_type = "audio output";
232             break;
233         default:
234             assert( i_type > 0 ); /* unknown type?! */
235             i_size = i_type;
236             i_type = VLC_OBJECT_GENERIC;
237             psz_type = "generic";
238             break;
239     }
240
241     return vlc_custom_create( p_this, i_size, i_type, psz_type );
242 }
243
244
245 /**
246  ****************************************************************************
247  * Set the destructor of a vlc object
248  *
249  * This function sets the destructor of the vlc object. It will be called
250  * when the object is destroyed when the its refcount reaches 0.
251  * (It is called by the internal function vlc_object_destroy())
252  *****************************************************************************/
253 void __vlc_object_set_destructor( vlc_object_t *p_this,
254                                   vlc_destructor_t pf_destructor )
255 {
256     vlc_object_internals_t *p_priv = vlc_internals(p_this );
257     p_priv->pf_destructor = pf_destructor;
258 }
259
260 /**
261  ****************************************************************************
262  * Destroy a vlc object (Internal)
263  *
264  * This function destroys an object that has been previously allocated with
265  * vlc_object_create. The object's refcount must be zero and it must not be
266  * attached to other objects in any way.
267  *
268  * This function must be called with cancellation disabled (currently).
269  *****************************************************************************/
270 static void vlc_object_destroy( vlc_object_t *p_this )
271 {
272     vlc_object_internals_t *p_priv = vlc_internals( p_this );
273
274     /* Objects are always detached beforehand */
275     assert( !p_this->p_parent );
276
277     /* Send a kill to the object's thread if applicable */
278     vlc_object_kill( p_this );
279
280     /* Call the custom "subclass" destructor */
281     if( p_priv->pf_destructor )
282         p_priv->pf_destructor( p_this );
283
284     /* Any thread must have been cleaned up at this point. */
285     assert( !p_priv->b_thread );
286
287     /* Destroy the associated variables, starting from the end so that
288      * no memmove calls have to be done. */
289     while( p_priv->i_vars )
290     {
291         var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
292     }
293
294     free( p_priv->p_vars );
295     vlc_cond_destroy( &p_priv->var_wait );
296     vlc_mutex_destroy( &p_priv->var_lock );
297
298     free( p_this->psz_header );
299
300     FREENULL( p_this->psz_object_name );
301
302     vlc_spin_destroy( &p_priv->ref_spin );
303     vlc_mutex_destroy( &p_priv->lock );
304     if( p_priv->pipes[1] != -1 && p_priv->pipes[1] != p_priv->pipes[0] )
305         close( p_priv->pipes[1] );
306     if( p_priv->pipes[0] != -1 )
307         close( p_priv->pipes[0] );
308     if( VLC_OBJECT(p_this->p_libvlc) == p_this )
309         vlc_mutex_destroy (&(libvlc_priv ((libvlc_int_t *)p_this)->structure_lock));
310
311     free( p_priv );
312 }
313
314
315 /** Inter-object signaling */
316
317 void __vlc_object_lock( vlc_object_t *obj )
318 {
319     vlc_mutex_lock( &(vlc_internals(obj)->lock) );
320 }
321
322 void __vlc_object_unlock( vlc_object_t *obj )
323 {
324     vlc_assert_locked( &(vlc_internals(obj)->lock) );
325     vlc_mutex_unlock( &(vlc_internals(obj)->lock) );
326 }
327 void __vlc_object_assert_locked( vlc_object_t *obj )
328 {
329     vlc_assert_locked( &(vlc_internals(obj)->lock) );
330 }
331
332 #ifdef WIN32
333 # include <winsock2.h>
334 # include <ws2tcpip.h>
335
336 /**
337  * select()-able pipes emulated using Winsock
338  */
339 static int pipe (int fd[2])
340 {
341     SOCKADDR_IN addr;
342     int addrlen = sizeof (addr);
343
344     SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
345            c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
346     if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
347         goto error;
348
349     memset (&addr, 0, sizeof (addr));
350     addr.sin_family = AF_INET;
351     addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
352     if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
353      || getsockname (l, (PSOCKADDR)&addr, &addrlen)
354      || listen (l, 1)
355      || connect (c, (PSOCKADDR)&addr, addrlen))
356         goto error;
357
358     a = accept (l, NULL, NULL);
359     if (a == INVALID_SOCKET)
360         goto error;
361
362     closesocket (l);
363     //shutdown (a, 0);
364     //shutdown (c, 1);
365     fd[0] = c;
366     fd[1] = a;
367     return 0;
368
369 error:
370     if (l != INVALID_SOCKET)
371         closesocket (l);
372     if (c != INVALID_SOCKET)
373         closesocket (c);
374     return -1;
375 }
376
377 #undef  read
378 #define read( a, b, c )  recv (a, b, c, 0)
379 #undef  write
380 #define write( a, b, c ) send (a, b, c, 0)
381 #undef  close
382 #define close( a )       closesocket (a)
383 #endif /* WIN32 */
384
385 /**
386  * Returns the readable end of a pipe that becomes readable once termination
387  * of the object is requested (vlc_object_kill()).
388  * This can be used to wake-up out of a select() or poll() event loop, such
389  * typically when doing network I/O.
390  *
391  * Note that the pipe will remain the same for the lifetime of the object.
392  * DO NOT read the pipe nor close it yourself. Ever.
393  *
394  * @param obj object that would be "killed"
395  * @return a readable pipe descriptor, or -1 on error.
396  */
397 int vlc_object_waitpipe( vlc_object_t *obj )
398 {
399     vlc_object_internals_t *internals = vlc_internals( obj );
400
401     vlc_object_lock (obj);
402     if (internals->pipes[0] == -1)
403     {
404         /* This can only ever happen if someone killed us without locking: */
405         assert (internals->pipes[1] == -1);
406
407 #ifdef HAVE_EVENTFD
408         internals->pipes[0] = internals->pipes[1] = eventfd (0, 0);
409         if (internals->pipes[0] == -1)
410 #endif
411         {
412             if (pipe (internals->pipes))
413                 internals->pipes[0] = internals->pipes[1] = -1;
414         }
415
416         if (internals->pipes[0] != -1 && obj->b_die)
417         {   /* Race condition: vlc_object_kill() already invoked! */
418             msg_Dbg (obj, "waitpipe: object already dying");
419             write (internals->pipes[1], &(uint64_t){ 1 }, sizeof (uint64_t));
420         }
421     }
422     vlc_object_unlock (obj);
423     return internals->pipes[0];
424 }
425
426
427 /**
428  * Requests termination of an object, cancels the object thread, and make the
429  * object wait pipe (if it exists) readable. Not a cancellation point.
430  */
431 void __vlc_object_kill( vlc_object_t *p_this )
432 {
433     vlc_object_internals_t *priv = vlc_internals( p_this );
434     int fd = -1;
435
436     vlc_thread_cancel( p_this );
437     vlc_object_lock( p_this );
438     if( !p_this->b_die )
439     {
440         fd = priv->pipes[1];
441         p_this->b_die = true;
442     }
443
444     /* This also serves as a memory barrier toward vlc_object_alive(): */
445     vlc_object_unlock( p_this );
446
447     if (fd != -1)
448     {
449         int canc = vlc_savecancel ();
450
451         /* write _after_ setting b_die, so vlc_object_alive() returns false */
452         write (fd, &(uint64_t){ 1 }, sizeof (uint64_t));
453         msg_Dbg (p_this, "waitpipe: object killed");
454         vlc_restorecancel (canc);
455     }
456 }
457
458
459 /*****************************************************************************
460  * find a typed object and increment its refcount
461  *****************************************************************************
462  * This function recursively looks for a given object type. i_mode can be one
463  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
464  *****************************************************************************/
465 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
466 {
467     vlc_object_t *p_found;
468
469     /* If we are of the requested type ourselves, don't look further */
470     if( !(i_mode & FIND_STRICT)
471      && vlc_internals (p_this)->i_object_type == i_type )
472     {
473         vlc_object_hold( p_this );
474         return p_this;
475     }
476
477     /* Otherwise, recursively look for the object */
478     if ((i_mode & 0x000f) == FIND_ANYWHERE)
479         return vlc_object_find (p_this->p_libvlc, i_type,
480                                 (i_mode & ~0x000f)|FIND_CHILD);
481
482     libvlc_lock (p_this->p_libvlc);
483     p_found = FindObject( p_this, i_type, i_mode );
484     libvlc_unlock (p_this->p_libvlc);
485     return p_found;
486 }
487
488 #undef vlc_object_find_name
489 /**
490  * Finds a named object and increment its reference count.
491  * Beware that objects found in this manner can be "owned" by another thread,
492  * be of _any_ type, and be attached to any module (if any). With such an
493  * object reference, you can set or get object variables, emit log messages,
494  * and read write-once object parameters (psz_object_type, etc).
495  * You CANNOT cast the object to a more specific object type, and you
496  * definitely cannot invoke object type-specific callbacks with this.
497  *
498  * @param p_this object to search from
499  * @param psz_name name of the object to search for
500  * @param i_mode search direction: FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
501  *
502  * @return a matching object (must be released by the caller),
503  * or NULL on error.
504  */
505 vlc_object_t *vlc_object_find_name( vlc_object_t *p_this,
506                                     const char *psz_name, int i_mode )
507 {
508     vlc_object_t *p_found;
509
510     /* If have the requested name ourselves, don't look further */
511     if( !(i_mode & FIND_STRICT)
512         && p_this->psz_object_name
513         && !strcmp( p_this->psz_object_name, psz_name ) )
514     {
515         vlc_object_hold( p_this );
516         return p_this;
517     }
518
519     libvlc_lock (p_this->p_libvlc);
520
521     /* Otherwise, recursively look for the object */
522     if( (i_mode & 0x000f) == FIND_ANYWHERE )
523     {
524         vlc_object_t *p_root = p_this;
525
526         /* Find the root */
527         while( p_root->p_parent != NULL &&
528                p_root != VLC_OBJECT( p_this->p_libvlc ) )
529         {
530             p_root = p_root->p_parent;
531         }
532
533         p_found = FindObjectName( p_root, psz_name,
534                                  (i_mode & ~0x000f)|FIND_CHILD );
535         if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
536         {
537             p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
538                                       psz_name, (i_mode & ~0x000f)|FIND_CHILD );
539         }
540     }
541     else
542     {
543         p_found = FindObjectName( p_this, psz_name, i_mode );
544     }
545
546     libvlc_unlock (p_this->p_libvlc);
547     return p_found;
548 }
549
550 /**
551  * Increment an object reference counter.
552  */
553 void * __vlc_object_hold( vlc_object_t *p_this )
554 {
555     vlc_object_internals_t *internals = vlc_internals( p_this );
556
557     vlc_spin_lock( &internals->ref_spin );
558     /* Avoid obvious freed object uses */
559     assert( internals->i_refcount > 0 );
560     /* Increment the counter */
561     internals->i_refcount++;
562     vlc_spin_unlock( &internals->ref_spin );
563     return p_this;
564 }
565
566 /*****************************************************************************
567  * Decrement an object refcount
568  * And destroy the object if its refcount reach zero.
569  *****************************************************************************/
570 void __vlc_object_release( vlc_object_t *p_this )
571 {
572     vlc_object_internals_t *internals = vlc_internals( p_this );
573     vlc_object_t *parent = NULL;
574     bool b_should_destroy;
575
576     vlc_spin_lock( &internals->ref_spin );
577     assert( internals->i_refcount > 0 );
578
579     if( internals->i_refcount > 1 )
580     {
581         /* Fast path */
582         /* There are still other references to the object */
583         internals->i_refcount--;
584         vlc_spin_unlock( &internals->ref_spin );
585         return;
586     }
587     vlc_spin_unlock( &internals->ref_spin );
588
589     /* Slow path */
590     /* Remember that we cannot hold the spin while waiting on the mutex */
591     libvlc_lock (p_this->p_libvlc);
592     /* Take the spin again. Note that another thread may have held the
593      * object in the (very short) mean time. */
594     vlc_spin_lock( &internals->ref_spin );
595     b_should_destroy = --internals->i_refcount == 0;
596     vlc_spin_unlock( &internals->ref_spin );
597
598     if( b_should_destroy )
599     {
600         /* We have no children */
601         assert (internals->i_children == 0);
602         parent = p_this->p_parent;
603
604 #ifndef NDEBUG
605         if( VLC_OBJECT(p_this->p_libvlc) == p_this )
606         {
607             /* Test for leaks */
608             vlc_object_t *leaked = internals->next;
609             while( leaked != p_this )
610             {
611                 /* We are leaking this object */
612                 fprintf( stderr,
613                          "ERROR: leaking object (%p, type:%s, name:%s)\n",
614                          leaked, leaked->psz_object_type,
615                          leaked->psz_object_name );
616                 /* Dump object to ease debugging */
617                 vlc_object_dump( leaked );
618                 fflush(stderr);
619                 leaked = vlc_internals (leaked)->next;
620             }
621
622             if( internals->next != p_this )
623                 /* Dump libvlc object to ease debugging */
624                 vlc_object_dump( p_this );
625         }
626 #endif
627         /* Remove the object from object list
628          * so that it cannot be encountered by vlc_object_get() */
629         vlc_internals (internals->next)->prev = internals->prev;
630         vlc_internals (internals->prev)->next = internals->next;
631
632         if (parent)
633             /* Detach from parent to protect against FIND_CHILDREN */
634             vlc_object_detach_unlocked (p_this);
635     }
636     libvlc_unlock (p_this->p_libvlc);
637
638     if( b_should_destroy )
639     {
640         int canc;
641
642         canc = vlc_savecancel ();
643         vlc_object_destroy( p_this );
644         vlc_restorecancel (canc);
645         if (parent)
646             vlc_object_release (parent);
647     }
648 }
649
650 /**
651  ****************************************************************************
652  * attach object to a parent object
653  *****************************************************************************
654  * This function sets p_this as a child of p_parent, and p_parent as a parent
655  * of p_this. This link can be undone using vlc_object_detach.
656  *****************************************************************************/
657 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
658 {
659     if( !p_this ) return;
660
661     vlc_object_hold (p_parent);
662     libvlc_lock (p_this->p_libvlc);
663
664     /* Attach the parent to its child */
665     assert (!p_this->p_parent);
666     p_this->p_parent = p_parent;
667
668     /* Attach the child to its parent */
669     vlc_object_internals_t *priv = vlc_internals( p_parent );
670     INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
671                  p_this );
672     libvlc_unlock (p_this->p_libvlc);
673 }
674
675
676 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
677 {
678     if (p_this->p_parent == NULL)
679         return;
680
681     vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
682
683     int i_index, i;
684
685     /* Remove p_this's parent */
686     p_this->p_parent = NULL;
687
688     /* Remove all of p_parent's children which are p_this */
689     for( i_index = priv->i_children ; i_index-- ; )
690     {
691         if( priv->pp_children[i_index] == p_this )
692         {
693             priv->i_children--;
694             for( i = i_index ; i < priv->i_children ; i++ )
695                 priv->pp_children[i] = priv->pp_children[i+1];
696         }
697     }
698
699     if( priv->i_children )
700     {
701         vlc_object_t **pp_children = (vlc_object_t **)
702             realloc( priv->pp_children,
703                      priv->i_children * sizeof(vlc_object_t *) );
704         if( pp_children )
705             priv->pp_children = pp_children;
706     }
707     else
708     {
709         /* Special case - don't realloc() to zero to avoid leaking */
710         free( priv->pp_children );
711         priv->pp_children = NULL;
712     }
713 }
714
715
716 /**
717  ****************************************************************************
718  * detach object from its parent
719  *****************************************************************************
720  * This function removes all links between an object and its parent.
721  *****************************************************************************/
722 void __vlc_object_detach( vlc_object_t *p_this )
723 {
724     vlc_object_t *p_parent;
725     if( !p_this ) return;
726
727     libvlc_lock (p_this->p_libvlc);
728     p_parent = p_this->p_parent;
729     if (p_parent)
730         vlc_object_detach_unlocked( p_this );
731     libvlc_unlock (p_this->p_libvlc);
732
733     if (p_parent)
734         vlc_object_release (p_parent);
735 }
736
737
738 /**
739  ****************************************************************************
740  * find a list typed objects and increment their refcount
741  *****************************************************************************
742  * This function recursively looks for a given object type. i_mode can be one
743  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
744  *****************************************************************************/
745 vlc_list_t * vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
746 {
747     vlc_list_t *p_list;
748     int i_count = 0;
749
750     /* Look for the objects */
751     switch( i_mode & 0x000f )
752     {
753     case FIND_ANYWHERE:
754         return vlc_list_find (VLC_OBJECT(p_this->p_libvlc), i_type, FIND_CHILD);
755
756     case FIND_CHILD:
757         libvlc_lock (p_this->p_libvlc);
758         i_count = CountChildren( p_this, i_type );
759         p_list = NewList( i_count );
760
761         /* Check allocation was successful */
762         if( p_list->i_count != i_count )
763         {
764             libvlc_unlock (p_this->p_libvlc);
765             p_list->i_count = 0;
766             break;
767         }
768
769         p_list->i_count = 0;
770         ListChildren( p_list, p_this, i_type );
771         libvlc_unlock (p_this->p_libvlc);
772         break;
773
774     default:
775         msg_Err( p_this, "unimplemented!" );
776         p_list = NewList( 0 );
777         break;
778     }
779
780     return p_list;
781 }
782
783 /**
784  * Gets the list of children of an objects, and increment their reference
785  * count.
786  * @return a list (possibly empty) or NULL in case of error.
787  */
788 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
789 {
790     vlc_list_t *l;
791     vlc_object_internals_t *priv = vlc_internals( obj );
792
793     libvlc_lock (obj->p_libvlc);
794     l = NewList( priv->i_children );
795     for (int i = 0; i < l->i_count; i++)
796     {
797         vlc_object_hold( priv->pp_children[i] );
798         l->p_values[i].p_object = priv->pp_children[i];
799     }
800     libvlc_unlock (obj->p_libvlc);
801     return l;
802 }
803
804 /*****************************************************************************
805  * DumpCommand: print the current vlc structure
806  *****************************************************************************
807  * This function prints either an ASCII tree showing the connections between
808  * vlc objects, and additional information such as their refcount, thread ID,
809  * etc. (command "tree"), or the same data as a simple list (command "list").
810  *****************************************************************************/
811 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
812                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
813 {
814     libvlc_int_t *p_libvlc = p_this->p_libvlc;
815
816     (void)oldval; (void)p_data;
817     if( *psz_cmd == 'l' )
818     {
819         vlc_object_t *cur = VLC_OBJECT (p_libvlc);
820
821         libvlc_lock (p_this->p_libvlc);
822         do
823         {
824             PrintObject (cur, "");
825             cur = vlc_internals (cur)->next;
826         }
827         while (cur != VLC_OBJECT(p_libvlc));
828         libvlc_unlock (p_this->p_libvlc);
829     }
830     else
831     {
832         vlc_object_t *p_object = NULL;
833
834         if( *newval.psz_string )
835         {
836             /* try using the object's name to find it */
837             p_object = vlc_object_find_name( p_this, newval.psz_string,
838                                              FIND_ANYWHERE );
839             if( !p_object )
840             {
841                 return VLC_ENOOBJ;
842             }
843         }
844
845         libvlc_lock (p_this->p_libvlc);
846         if( *psz_cmd == 't' )
847         {
848             char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
849
850             if( !p_object )
851                 p_object = VLC_OBJECT(p_this->p_libvlc);
852
853             psz_foo[0] = '|';
854             DumpStructure( p_object, 0, psz_foo );
855         }
856         else if( *psz_cmd == 'v' )
857         {
858             int i;
859
860             if( !p_object )
861                 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
862
863             PrintObject( p_object, "" );
864
865             if( !vlc_internals( p_object )->i_vars )
866                 printf( " `-o No variables\n" );
867             for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
868             {
869                 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
870
871                 const char *psz_type = "unknown";
872                 switch( p_var->i_type & VLC_VAR_TYPE )
873                 {
874 #define MYCASE( type, nice )                \
875                     case VLC_VAR_ ## type:  \
876                         psz_type = nice;    \
877                         break;
878                     MYCASE( VOID, "void" );
879                     MYCASE( BOOL, "bool" );
880                     MYCASE( INTEGER, "integer" );
881                     MYCASE( HOTKEY, "hotkey" );
882                     MYCASE( STRING, "string" );
883                     MYCASE( MODULE, "module" );
884                     MYCASE( FILE, "file" );
885                     MYCASE( DIRECTORY, "directory" );
886                     MYCASE( VARIABLE, "variable" );
887                     MYCASE( FLOAT, "float" );
888                     MYCASE( TIME, "time" );
889                     MYCASE( ADDRESS, "address" );
890                     MYCASE( MUTEX, "mutex" );
891                     MYCASE( LIST, "list" );
892 #undef MYCASE
893                 }
894                 printf( " %c-o \"%s\" (%s",
895                         i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
896                         p_var->psz_name, psz_type );
897                 if( p_var->psz_text )
898                     printf( ", %s", p_var->psz_text );
899                 printf( ")" );
900                 if( p_var->i_type & VLC_VAR_HASCHOICE )
901                     printf( ", has choices" );
902                 if( p_var->i_type & VLC_VAR_ISCOMMAND )
903                     printf( ", command" );
904                 if( p_var->i_entries )
905                     printf( ", %d callbacks", p_var->i_entries );
906                 switch( p_var->i_type & VLC_VAR_CLASS )
907                 {
908                     case VLC_VAR_VOID:
909                     case VLC_VAR_MUTEX:
910                         break;
911                     case VLC_VAR_BOOL:
912                         printf( ": %s", p_var->val.b_bool ? "true" : "false" );
913                         break;
914                     case VLC_VAR_INTEGER:
915                         printf( ": %d", p_var->val.i_int );
916                         break;
917                     case VLC_VAR_STRING:
918                         printf( ": \"%s\"", p_var->val.psz_string );
919                         break;
920                     case VLC_VAR_FLOAT:
921                         printf( ": %f", p_var->val.f_float );
922                         break;
923                     case VLC_VAR_TIME:
924                         printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
925                         break;
926                     case VLC_VAR_ADDRESS:
927                         printf( ": %p", p_var->val.p_address );
928                         break;
929                     case VLC_VAR_LIST:
930                         printf( ": TODO" );
931                         break;
932                 }
933                 printf( "\n" );
934             }
935         }
936         libvlc_unlock (p_this->p_libvlc);
937
938         if( *newval.psz_string )
939         {
940             vlc_object_release( p_object );
941         }
942     }
943
944     return VLC_SUCCESS;
945 }
946
947 /*****************************************************************************
948  * vlc_list_release: free a list previously allocated by vlc_list_find
949  *****************************************************************************
950  * This function decreases the refcount of all objects in the list and
951  * frees the list.
952  *****************************************************************************/
953 void vlc_list_release( vlc_list_t *p_list )
954 {
955     int i_index;
956
957     for( i_index = 0; i_index < p_list->i_count; i_index++ )
958     {
959         vlc_object_release( p_list->p_values[i_index].p_object );
960     }
961
962     free( p_list->p_values );
963     free( p_list );
964 }
965
966 /*****************************************************************************
967  * dump an object. (Debug function)
968  *****************************************************************************/
969 #ifndef NDEBUG
970 static void vlc_object_dump( vlc_object_t *p_this )
971 {
972     char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
973     psz_foo[0] = '|';
974
975     DumpStructure( p_this, 0, psz_foo );
976 }
977 #endif
978
979 /* Following functions are local */
980
981 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
982 {
983     int i;
984     vlc_object_t *p_tmp;
985
986     switch( i_mode & 0x000f )
987     {
988     case FIND_PARENT:
989         p_tmp = p_this->p_parent;
990         if( p_tmp )
991         {
992             if( vlc_internals( p_tmp )->i_object_type == i_type )
993             {
994                 vlc_object_hold( p_tmp );
995                 return p_tmp;
996             }
997             else
998             {
999                 return FindObject( p_tmp, i_type, i_mode );
1000             }
1001         }
1002         break;
1003
1004     case FIND_CHILD:
1005         for( i = vlc_internals( p_this )->i_children; i--; )
1006         {
1007             p_tmp = vlc_internals( p_this )->pp_children[i];
1008             if( vlc_internals( p_tmp )->i_object_type == i_type )
1009             {
1010                 vlc_object_hold( p_tmp );
1011                 return p_tmp;
1012             }
1013             else if( vlc_internals( p_tmp )->i_children )
1014             {
1015                 p_tmp = FindObject( p_tmp, i_type, i_mode );
1016                 if( p_tmp )
1017                 {
1018                     return p_tmp;
1019                 }
1020             }
1021         }
1022         break;
1023
1024     case FIND_ANYWHERE:
1025         /* Handled in vlc_object_find */
1026         break;
1027     }
1028
1029     return NULL;
1030 }
1031
1032 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1033                                       const char *psz_name,
1034                                       int i_mode )
1035 {
1036     int i;
1037     vlc_object_t *p_tmp;
1038
1039     switch( i_mode & 0x000f )
1040     {
1041     case FIND_PARENT:
1042         p_tmp = p_this->p_parent;
1043         if( p_tmp )
1044         {
1045             if( p_tmp->psz_object_name
1046                 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1047             {
1048                 vlc_object_hold( p_tmp );
1049                 return p_tmp;
1050             }
1051             else
1052             {
1053                 return FindObjectName( p_tmp, psz_name, i_mode );
1054             }
1055         }
1056         break;
1057
1058     case FIND_CHILD:
1059         for( i = vlc_internals( p_this )->i_children; i--; )
1060         {
1061             p_tmp = vlc_internals( p_this )->pp_children[i];
1062             if( p_tmp->psz_object_name
1063                 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1064             {
1065                 vlc_object_hold( p_tmp );
1066                 return p_tmp;
1067             }
1068             else if( vlc_internals( p_tmp )->i_children )
1069             {
1070                 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1071                 if( p_tmp )
1072                 {
1073                     return p_tmp;
1074                 }
1075             }
1076         }
1077         break;
1078
1079     case FIND_ANYWHERE:
1080         /* Handled in vlc_object_find */
1081         break;
1082     }
1083
1084     return NULL;
1085 }
1086
1087
1088 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1089 {
1090     char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1091          psz_parent[20];
1092
1093     int canc = vlc_savecancel ();
1094     memset( &psz_name, 0, sizeof(psz_name) );
1095     if( p_this->psz_object_name )
1096     {
1097         snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1098         if( psz_name[48] )
1099             psz_name[48] = '\"';
1100     }
1101
1102     psz_children[0] = '\0';
1103     switch( vlc_internals( p_this )->i_children )
1104     {
1105         case 0:
1106             break;
1107         case 1:
1108             strcpy( psz_children, ", 1 child" );
1109             break;
1110         default:
1111             snprintf( psz_children, 19, ", %i children",
1112                       vlc_internals( p_this )->i_children );
1113             break;
1114     }
1115
1116     psz_refcount[0] = '\0';
1117     if( vlc_internals( p_this )->i_refcount > 0 )
1118         snprintf( psz_refcount, 19, ", refcount %u",
1119                   vlc_internals( p_this )->i_refcount );
1120
1121     psz_thread[0] = '\0';
1122     if( vlc_internals( p_this )->b_thread )
1123         snprintf( psz_thread, 29, " (thread %lu)",
1124                   (unsigned long)vlc_internals( p_this )->thread_id );
1125
1126     psz_parent[0] = '\0';
1127     if( p_this->p_parent )
1128         snprintf( psz_parent, 19, ", parent %p", p_this->p_parent );
1129
1130     printf( " %so %p %s%s%s%s%s%s\n", psz_prefix,
1131             p_this, p_this->psz_object_type,
1132             psz_name, psz_thread, psz_refcount, psz_children,
1133             psz_parent );
1134     vlc_restorecancel (canc);
1135 }
1136
1137 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1138 {
1139     int i;
1140     char i_back = psz_foo[i_level];
1141     psz_foo[i_level] = '\0';
1142
1143     PrintObject( p_this, psz_foo );
1144
1145     psz_foo[i_level] = i_back;
1146
1147     if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1148     {
1149         msg_Warn( p_this, "structure tree is too deep" );
1150         return;
1151     }
1152
1153     for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
1154     {
1155         if( i_level )
1156         {
1157             psz_foo[i_level-1] = ' ';
1158
1159             if( psz_foo[i_level-2] == '`' )
1160             {
1161                 psz_foo[i_level-2] = ' ';
1162             }
1163         }
1164
1165         if( i == vlc_internals( p_this )->i_children - 1 )
1166         {
1167             psz_foo[i_level] = '`';
1168         }
1169         else
1170         {
1171             psz_foo[i_level] = '|';
1172         }
1173
1174         psz_foo[i_level+1] = '-';
1175         psz_foo[i_level+2] = '\0';
1176
1177         DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
1178                        psz_foo );
1179     }
1180 }
1181
1182 static vlc_list_t * NewList( int i_count )
1183 {
1184     vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1185     if( p_list == NULL )
1186     {
1187         return NULL;
1188     }
1189
1190     p_list->i_count = i_count;
1191
1192     if( i_count == 0 )
1193     {
1194         p_list->p_values = NULL;
1195         return p_list;
1196     }
1197
1198     p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1199     if( p_list->p_values == NULL )
1200     {
1201         p_list->i_count = 0;
1202         return p_list;
1203     }
1204
1205     return p_list;
1206 }
1207
1208 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1209                          int i_index )
1210 {
1211     if( p_list == NULL || i_index >= p_list->i_count )
1212     {
1213         return;
1214     }
1215
1216     vlc_object_hold( p_object );
1217
1218     p_list->p_values[i_index].p_object = p_object;
1219
1220     return;
1221 }
1222
1223 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1224 {
1225     if( p_list == NULL )
1226     {
1227         return;
1228     }
1229
1230     p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1231                                 * sizeof( vlc_value_t ) );
1232     if( p_list->p_values == NULL )
1233     {
1234         p_list->i_count = 0;
1235         return;
1236     }
1237
1238     vlc_object_hold( p_object );
1239
1240     p_list->p_values[p_list->i_count].p_object = p_object;
1241     p_list->i_count++;
1242
1243     return;
1244 }*/
1245
1246 static int CountChildren( vlc_object_t *p_this, int i_type )
1247 {
1248     vlc_object_t *p_tmp;
1249     int i, i_count = 0;
1250
1251     for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1252     {
1253         p_tmp = vlc_internals( p_this )->pp_children[i];
1254
1255         if( vlc_internals( p_tmp )->i_object_type == i_type )
1256         {
1257             i_count++;
1258         }
1259         i_count += CountChildren( p_tmp, i_type );
1260     }
1261
1262     return i_count;
1263 }
1264
1265 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1266 {
1267     vlc_object_t *p_tmp;
1268     int i;
1269
1270     for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1271     {
1272         p_tmp = vlc_internals( p_this )->pp_children[i];
1273
1274         if( vlc_internals( p_tmp )->i_object_type == i_type )
1275             ListReplace( p_list, p_tmp, p_list->i_count++ );
1276
1277         ListChildren( p_list, p_tmp, i_type );
1278     }
1279 }