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