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