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