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