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