git.sesse.net Git - vlc/blob - src/modules/modules.c

   1 /*****************************************************************************
   2  * modules.c : Builtin and plugin modules management functions
   3  *****************************************************************************
   4  * Copyright (C) 2001-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Sam Hocevar <sam@zoy.org>
   8  *          Ethan C. Baldridge <BaldridgeE@cadmus.com>
   9  *          Hans-Peter Jansen <hpj@urpla.net>
  10  *          Gildas Bazin <gbazin@videolan.org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc_common.h>
  32 #include <vlc_plugin.h>
  33 #include <vlc_memory.h>
  34 #include <vlc_modules.h>
  35 #include "libvlc.h"
  36
  37 #include <stdlib.h>                                      /* free(), strtol() */
  38 #include <stdio.h>                                              /* sprintf() */
  39 #include <string.h>                                              /* strdup() */
  40 #include <assert.h>
  41
  42 #include <sys/types.h>
  43 #ifdef HAVE_SYS_STAT_H
  44 #   include <sys/stat.h>
  45 #endif
  46 #ifdef HAVE_UNISTD_H
  47 #   include <unistd.h>
  48 #endif
  49 #ifdef ENABLE_NLS
  50 # include <libintl.h>
  51 #endif
  52
  53 #include "config/configuration.h"
  54
  55 #include <vlc_fs.h>
  56 #include "vlc_arrays.h"
  57
  58 #include "modules/modules.h"
  59
  60 static module_bank_t *p_module_bank = NULL;
  61 static vlc_mutex_t module_lock = VLC_STATIC_MUTEX;
  62
  63 int vlc_entry__main( module_t * );
  64
  65 /*****************************************************************************
  66  * Local prototypes
  67  *****************************************************************************/
  68 #ifdef HAVE_DYNAMIC_PLUGINS
  69 static void AllocateAllPlugins( vlc_object_t *, module_bank_t * );
  70 static void AllocatePluginDir( vlc_object_t *, module_bank_t *, const char *,
  71                                unsigned );
  72 static int  AllocatePluginFile( vlc_object_t *, module_bank_t *, const char *,
  73                                 int64_t, int64_t );
  74 static module_t * AllocatePlugin( vlc_object_t *, const char * );
  75 #endif
  76 static int  AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
  77 static void DeleteModule ( module_bank_t *, module_t * );
  78 #ifdef HAVE_DYNAMIC_PLUGINS
  79 static void   DupModule        ( module_t * );
  80 static void   UndupModule      ( module_t * );
  81 #endif
  82
  83 #undef module_InitBank
  84 /**
  85  * Init bank
  86  *
  87  * Creates a module bank structure which will be filled later
  88  * on with all the modules found.
  89  * \param p_this vlc object structure
  90  * \return nothing
  91  */
  92 void module_InitBank( vlc_object_t *p_this )
  93 {
  94     module_bank_t *p_bank = NULL;
  95
  96     vlc_mutex_lock( &module_lock );
  97
  98     if( p_module_bank == NULL )
  99     {
 100         p_bank = calloc (1, sizeof(*p_bank));
 101         p_bank->i_usage = 1;
 102         p_bank->i_cache = p_bank->i_loaded_cache = 0;
 103         p_bank->pp_cache = p_bank->pp_loaded_cache = NULL;
 104         p_bank->b_cache = p_bank->b_cache_dirty = false;
 105         p_bank->head = NULL;
 106
 107         /* Everything worked, attach the object */
 108         p_module_bank = p_bank;
 109
 110         /* Fills the module bank structure with the main module infos.
 111          * This is very useful as it will allow us to consider the main
 112          * library just as another module, and for instance the configuration
 113          * options of main will be available in the module bank structure just
 114          * as for every other module. */
 115         AllocateBuiltinModule( p_this, vlc_entry__main );
 116         vlc_rwlock_init (&config_lock);
 117         config_SortConfig ();
 118     }
 119     else
 120         p_module_bank->i_usage++;
 121
 122     /* We do retain the module bank lock until the plugins are loaded as well.
 123      * This is ugly, this staged loading approach is needed: LibVLC gets
 124      * some configuration parameters relevant to loading the plugins from
 125      * the main (builtin) module. The module bank becomes shared read-only data
 126      * once it is ready, so we need to fully serialize initialization.
 127      * DO NOT UNCOMMENT the following line unless you managed to squeeze
 128      * module_LoadPlugins() before you unlock the mutex. */
 129     /*vlc_mutex_unlock( &module_lock );*/
 130 }
 131
 132 #undef module_EndBank
 133 /**
 134  * Unloads all unused plugin modules and empties the module
 135  * bank in case of success.
 136  * \param p_this vlc object structure
 137  * \return nothing
 138  */
 139 void module_EndBank( vlc_object_t *p_this, bool b_plugins )
 140 {
 141     module_bank_t *p_bank = p_module_bank;
 142
 143     assert (p_bank != NULL);
 144
 145     /* Save the configuration */
 146     if( !var_InheritBool( p_this, "ignore-config" ) )
 147         config_AutoSaveConfigFile( p_this );
 148
 149     /* If plugins were _not_ loaded, then the caller still has the bank lock
 150      * from module_InitBank(). */
 151     if( b_plugins )
 152         vlc_mutex_lock( &module_lock );
 153     /*else
 154         vlc_assert_locked( &module_lock ); not for static mutexes :( */
 155
 156     if( --p_bank->i_usage > 0 )
 157     {
 158         vlc_mutex_unlock( &module_lock );
 159         return;
 160     }
 161
 162     config_UnsortConfig ();
 163     vlc_rwlock_destroy (&config_lock);
 164     p_module_bank = NULL;
 165     vlc_mutex_unlock( &module_lock );
 166
 167 #ifdef HAVE_DYNAMIC_PLUGINS
 168     while( p_bank->i_loaded_cache-- )
 169     {
 170         if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
 171         {
 172             DeleteModule( p_bank,
 173                     p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module );
 174             free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
 175             free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
 176         }
 177     }
 178     free( p_bank->pp_loaded_cache );
 179     while( p_bank->i_cache-- )
 180     {
 181         free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
 182         free( p_bank->pp_cache[p_bank->i_cache] );
 183     }
 184     free( p_bank->pp_cache );
 185 #endif
 186
 187     while( p_bank->head != NULL )
 188         DeleteModule( p_bank, p_bank->head );
 189
 190     free( p_bank );
 191 }
 192
 193 #undef module_LoadPlugins
 194 /**
 195  * Loads module descriptions for all available plugins.
 196  * Fills the module bank structure with the plugin modules.
 197  *
 198  * \param p_this vlc object structure
 199  * \return nothing
 200  */
 201 void module_LoadPlugins( vlc_object_t * p_this )
 202 {
 203     module_bank_t *p_bank = p_module_bank;
 204
 205     assert( p_bank );
 206     /*vlc_assert_locked( &module_lock ); not for static mutexes :( */
 207
 208 #ifdef HAVE_DYNAMIC_PLUGINS
 209     if( p_bank->i_usage == 1 )
 210     {
 211         msg_Dbg( p_this, "checking plugin modules" );
 212         p_module_bank->b_cache = var_InheritBool( p_this, "plugins-cache" );
 213
 214         AllocateAllPlugins( p_this, p_module_bank );
 215         config_UnsortConfig ();
 216         config_SortConfig ();
 217     }
 218 #endif
 219     vlc_mutex_unlock( &module_lock );
 220 }
 221
 222 /**
 223  * Checks whether a module implements a capability.
 224  *
 225  * \param m the module
 226  * \param cap the capability to check
 227  * \return TRUE if the module have the capability
 228  */
 229 bool module_provides( const module_t *m, const char *cap )
 230 {
 231     return !strcmp( m->psz_capability, cap );
 232 }
 233
 234 /**
 235  * Get the internal name of a module
 236  *
 237  * \param m the module
 238  * \return the module name
 239  */
 240 const char *module_get_object( const module_t *m )
 241 {
 242     return m->psz_object_name;
 243 }
 244
 245 /**
 246  * Get the human-friendly name of a module.
 247  *
 248  * \param m the module
 249  * \param long_name TRUE to have the long name of the module
 250  * \return the short or long name of the module
 251  */
 252 const char *module_get_name( const module_t *m, bool long_name )
 253 {
 254     if( long_name && ( m->psz_longname != NULL) )
 255         return m->psz_longname;
 256
 257     return m->psz_shortname ? m->psz_shortname : m->psz_object_name;
 258 }
 259
 260 /**
 261  * Get the help for a module
 262  *
 263  * \param m the module
 264  * \return the help
 265  */
 266 const char *module_get_help( const module_t *m )
 267 {
 268     return m->psz_help;
 269 }
 270
 271 /**
 272  * Get the capability for a module
 273  *
 274  * \param m the module
 275  * return the capability
 276  */
 277 const char *module_get_capability( const module_t *m )
 278 {
 279     return m->psz_capability;
 280 }
 281
 282 /**
 283  * Get the score for a module
 284  *
 285  * \param m the module
 286  * return the score for the capability
 287  */
 288 int module_get_score( const module_t *m )
 289 {
 290     return m->i_score;
 291 }
 292
 293 /**
 294  * Translate a string using the module's text domain
 295  *
 296  * \param m the module
 297  * \param str the American English ASCII string to localize
 298  * \return the gettext-translated string
 299  */
 300 const char *module_gettext (const module_t *m, const char *str)
 301 {
 302 #ifdef ENABLE_NLS
 303     const char *domain = m->domain ? m->domain : PACKAGE_NAME;
 304     return dgettext (domain, str);
 305 #else
 306     (void)m;
 307     return str;
 308 #endif
 309 }
 310
 311 module_t *module_hold (module_t *m)
 312 {
 313     vlc_hold (&m->vlc_gc_data);
 314     return m;
 315 }
 316
 317 void module_release (module_t *m)
 318 {
 319     vlc_release (&m->vlc_gc_data);
 320 }
 321
 322 #undef module_start
 323 int module_start (vlc_object_t *obj, module_t *m)
 324 {
 325    return m->pf_activate ? (m->pf_activate (obj)) : VLC_SUCCESS;
 326 }
 327
 328 #undef module_stop
 329 void module_stop (vlc_object_t *obj, module_t *m)
 330 {
 331     if (m->pf_deactivate)
 332         m->pf_deactivate (obj);
 333 }
 334
 335 /**
 336  * Frees the flat list of VLC modules.
 337  * @param list list obtained by module_list_get()
 338  * @param length number of items on the list
 339  * @return nothing.
 340  */
 341 void module_list_free (module_t **list)
 342 {
 343     if (list == NULL)
 344         return;
 345
 346     for (size_t i = 0; list[i] != NULL; i++)
 347          module_release (list[i]);
 348     free (list);
 349 }
 350
 351 /**
 352  * Gets the flat list of VLC modules.
 353  * @param n [OUT] pointer to the number of modules or NULL
 354  * @return NULL-terminated table of module pointers
 355  *         (release with module_list_free()), or NULL in case of error.
 356  */
 357 module_t **module_list_get (size_t *n)
 358 {
 359     /* TODO: this whole module lookup is quite inefficient */
 360     /* Remove this and improve module_need */
 361     module_t **tab = NULL;
 362     size_t i = 0;
 363
 364     assert (p_module_bank);
 365     for (module_t *mod = p_module_bank->head; mod; mod = mod->next)
 366     {
 367          module_t **nt;
 368          nt  = realloc (tab, (i + 2 + mod->submodule_count) * sizeof (*tab));
 369          if (nt == NULL)
 370          {
 371              module_list_free (tab);
 372              return NULL;
 373          }
 374
 375          tab = nt;
 376          tab[i++] = module_hold (mod);
 377          for (module_t *subm = mod->submodule; subm; subm = subm->next)
 378              tab[i++] = module_hold (subm);
 379          tab[i] = NULL;
 380     }
 381     if (n != NULL)
 382         *n = i;
 383     return tab;
 384 }
 385
 386 typedef struct module_list_t
 387 {
 388     module_t *p_module;
 389     int16_t  i_score;
 390     bool     b_force;
 391 } module_list_t;
 392
 393 static int modulecmp (const void *a, const void *b)
 394 {
 395     const module_list_t *la = a, *lb = b;
 396     /* Note that qsort() uses _ascending_ order,
 397      * so the smallest module is the one with the biggest score. */
 398     return lb->i_score - la->i_score;
 399 }
 400
 401 #undef module_need
 402 /**
 403  * module Need
 404  *
 405  * Return the best module function, given a capability list.
 406  *
 407  * \param p_this the vlc object
 408  * \param psz_capability list of capabilities needed
 409  * \param psz_name name of the module asked
 410  * \param b_strict if true, do not fallback to plugin with a different name
 411  *                 but the same capability
 412  * \return the module or NULL in case of a failure
 413  */
 414 module_t * module_need( vlc_object_t *p_this, const char *psz_capability,
 415                         const char *psz_name, bool b_strict )
 416 {
 417     stats_TimerStart( p_this, "module_need()", STATS_TIMER_MODULE_NEED );
 418
 419     module_list_t *p_list;
 420     module_t *p_module;
 421     int i_shortcuts = 0;
 422     char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
 423     bool b_force_backup = p_this->b_force;
 424
 425     /* Deal with variables */
 426     if( psz_name && psz_name[0] == '$' )
 427     {
 428         psz_name = psz_var = var_CreateGetString( p_this, psz_name + 1 );
 429     }
 430
 431     /* Count how many different shortcuts were asked for */
 432     if( psz_name && *psz_name )
 433     {
 434         char *psz_parser, *psz_last_shortcut;
 435
 436         /* If the user wants none, give him none. */
 437         if( !strcmp( psz_name, "none" ) )
 438         {
 439             free( psz_var );
 440             stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
 441             stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
 442             stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
 443             return NULL;
 444         }
 445
 446         i_shortcuts++;
 447         psz_parser = psz_shortcuts = psz_last_shortcut = strdup( psz_name );
 448
 449         while( ( psz_parser = strchr( psz_parser, ',' ) ) )
 450         {
 451              *psz_parser = '\0';
 452              i_shortcuts++;
 453              psz_last_shortcut = ++psz_parser;
 454         }
 455
 456         /* Check if the user wants to override the "strict" mode */
 457         if( psz_last_shortcut )
 458         {
 459             if( !strcmp(psz_last_shortcut, "none") )
 460             {
 461                 b_strict = true;
 462                 i_shortcuts--;
 463             }
 464             else if( !strcmp(psz_last_shortcut, "any") )
 465             {
 466                 b_strict = false;
 467                 i_shortcuts--;
 468             }
 469         }
 470     }
 471
 472     /* Sort the modules and test them */
 473     size_t count;
 474     module_t **p_all = module_list_get (&count);
 475     p_list = malloc( count * sizeof( module_list_t ) );
 476
 477     /* Parse the module list for capabilities and probe each of them */
 478     count = 0;
 479     for (size_t i = 0; (p_module = p_all[i]) != NULL; i++)
 480     {
 481         int i_shortcut_bonus = 0;
 482
 483         /* Test that this module can do what we need */
 484         if( !module_provides( p_module, psz_capability ) )
 485             continue;
 486
 487         /* If we required a shortcut, check this plugin provides it. */
 488         if( i_shortcuts > 0 )
 489         {
 490             const char *name = psz_shortcuts;
 491
 492             for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
 493             {
 494                 for( unsigned i = 0; i < p_module->i_shortcuts; i++ )
 495                 {
 496                     char *c;
 497                     if( ( c = strchr( name, '@' ) )
 498                         ? !strncasecmp( name, p_module->pp_shortcuts[i],
 499                                         c-name )
 500                         : !strcasecmp( name, p_module->pp_shortcuts[i] ) )
 501                     {
 502                         /* Found it */
 503                         if( c && c[1] )
 504                             psz_alias = c+1;
 505                         i_shortcut_bonus = i_short * 10000;
 506                         goto found_shortcut;
 507                     }
 508                 }
 509
 510                 /* Go to the next shortcut... This is so lame! */
 511                 name += strlen( name ) + 1;
 512             }
 513
 514             /* If we are in "strict" mode and we couldn't
 515              * find the module in the list of provided shortcuts,
 516              * then kick the bastard out of here!!! */
 517             if( b_strict )
 518                 continue;
 519         }
 520
 521         /* Trash <= 0 scored plugins (they can only be selected by shortcut) */
 522         if( p_module->i_score <= 0 )
 523             continue;
 524
 525 found_shortcut:
 526         /* Store this new module */
 527         p_list[count].p_module = module_hold (p_module);
 528         p_list[count].i_score = p_module->i_score + i_shortcut_bonus;
 529         p_list[count].b_force = i_shortcut_bonus && b_strict;
 530         count++;
 531     }
 532
 533     /* We can release the list, interesting modules are held */
 534     module_list_free (p_all);
 535
 536     /* Sort candidates by descending score */
 537     qsort (p_list, count, sizeof (p_list[0]), modulecmp);
 538     msg_Dbg( p_this, "looking for %s module: %zu candidate%s", psz_capability,
 539              count, count == 1 ? "" : "s" );
 540
 541     /* Parse the linked list and use the first successful module */
 542     p_module = NULL;
 543     for (size_t i = 0; (i < count) && (p_module == NULL); i++)
 544     {
 545         module_t *p_cand = p_list[i].p_module;
 546 #ifdef HAVE_DYNAMIC_PLUGINS
 547         /* Make sure the module is loaded in mem */
 548         module_t *p_real = p_cand->b_submodule ? p_cand->parent : p_cand;
 549
 550         if( !p_real->b_builtin && !p_real->b_loaded )
 551         {
 552             module_t *p_new_module =
 553                 AllocatePlugin( p_this, p_real->psz_filename );
 554             if( p_new_module == NULL )
 555             {   /* Corrupted module */
 556                 msg_Err( p_this, "possibly corrupt module cache" );
 557                 module_release( p_cand );
 558                 continue;
 559             }
 560             CacheMerge( p_this, p_real, p_new_module );
 561             DeleteModule( p_module_bank, p_new_module );
 562         }
 563 #endif
 564
 565         p_this->b_force = p_list[i].b_force;
 566
 567         switch( module_start( p_this, p_cand ) )
 568         {
 569         case VLC_SUCCESS:
 570             /* good module! */
 571             p_module = p_cand;
 572             break;
 573
 574         case VLC_ETIMEOUT:
 575             /* good module, but aborted */
 576             module_release( p_cand );
 577             break;
 578
 579         default: /* bad module */
 580             module_release( p_cand );
 581             continue;
 582         }
 583
 584         /* Release the remaining modules */
 585         while (++i < count)
 586             module_release (p_list[i].p_module);
 587     }
 588
 589     free( p_list );
 590     p_this->b_force = b_force_backup;
 591
 592     if( p_module != NULL )
 593     {
 594         msg_Dbg( p_this, "using %s module \"%s\"",
 595                  psz_capability, p_module->psz_object_name );
 596         vlc_object_set_name( p_this, psz_alias ? psz_alias
 597                                                : p_module->psz_object_name );
 598     }
 599     else if( count == 0 )
 600         msg_Dbg( p_this, "no %s module matched \"%s\"",
 601                  psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 602     else
 603         msg_Dbg( p_this, "no %s module matching \"%s\" could be loaded",
 604                   psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
 605
 606     free( psz_shortcuts );
 607     free( psz_var );
 608
 609     stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
 610     stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
 611     stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
 612
 613     /* Don't forget that the module is still locked */
 614     return p_module;
 615 }
 616
 617 #undef module_unneed
 618 /**
 619  * Module unneed
 620  *
 621  * This function must be called by the thread that called module_need, to
 622  * decrease the reference count and allow for hiding of modules.
 623  * \param p_this vlc object structure
 624  * \param p_module the module structure
 625  * \return nothing
 626  */
 627 void module_unneed( vlc_object_t * p_this, module_t * p_module )
 628 {
 629     msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
 630     module_stop( p_this, p_module );
 631     module_release( p_module );
 632 }
 633
 634 /**
 635  * Get a pointer to a module_t given it's name.
 636  *
 637  * \param psz_name the name of the module
 638  * \return a pointer to the module or NULL in case of a failure
 639  */
 640 module_t *module_find( const char * psz_name )
 641 {
 642     module_t **list, *module;
 643
 644     list = module_list_get (NULL);
 645     if (!list)
 646         return NULL;
 647
 648     for (size_t i = 0; (module = list[i]) != NULL; i++)
 649     {
 650         const char *psz_module_name = module->psz_object_name;
 651
 652         if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
 653         {
 654             module_hold (module);
 655             break;
 656         }
 657     }
 658     module_list_free (list);
 659     return module;
 660 }
 661
 662 /**
 663  * Tell if a module exists and release it in thic case
 664  *
 665  * \param psz_name th name of the module
 666  * \return TRUE if the module exists
 667  */
 668 bool module_exists (const char * psz_name)
 669 {
 670     module_t *p_module = module_find (psz_name);
 671     if( p_module )
 672         module_release (p_module);
 673     return p_module != NULL;
 674 }
 675
 676 /**
 677  * Get a pointer to a module_t that matches a shortcut.
 678  * This is a temporary hack for SD. Do not re-use (generally multiple modules
 679  * can have the same shortcut, so this is *broken* - use module_need()!).
 680  *
 681  * \param psz_shortcut shortcut of the module
 682  * \param psz_cap capability of the module
 683  * \return a pointer to the module or NULL in case of a failure
 684  */
 685 module_t *module_find_by_shortcut (const char *psz_shortcut)
 686 {
 687     module_t **list, *module;
 688
 689     list = module_list_get (NULL);
 690     if (!list)
 691         return NULL;
 692
 693     for (size_t i = 0; (module = list[i]) != NULL; i++)
 694     {
 695         for (size_t j = 0; j < module->i_shortcuts; j++)
 696         {
 697             if (!strcmp (module->pp_shortcuts[j], psz_shortcut))
 698             {
 699                 module_hold (module);
 700                 goto out;
 701              }
 702         }
 703     }
 704 out:
 705     module_list_free (list);
 706     return module;
 707 }
 708
 709 /**
 710  * Get the configuration of a module
 711  *
 712  * \param module the module
 713  * \param psize the size of the configuration returned
 714  * \return the configuration as an array
 715  */
 716 module_config_t *module_config_get( const module_t *module, unsigned *restrict psize )
 717 {
 718     unsigned i,j;
 719     unsigned size = module->confsize;
 720     module_config_t *config = malloc( size * sizeof( *config ) );
 721
 722     assert( psize != NULL );
 723     *psize = 0;
 724
 725     if( !config )
 726         return NULL;
 727
 728     for( i = 0, j = 0; i < size; i++ )
 729     {
 730         const module_config_t *item = module->p_config + i;
 731         if( item->b_internal /* internal option */
 732          || item->b_removed /* removed option */ )
 733             continue;
 734
 735         memcpy( config + j, item, sizeof( *config ) );
 736         j++;
 737     }
 738     *psize = j;
 739
 740     return config;
 741 }
 742
 743 /**
 744  * Release the configuration
 745  *
 746  * \param the configuration
 747  * \return nothing
 748  */
 749 void module_config_free( module_config_t *config )
 750 {
 751     free( config );
 752 }
 753
 754 /*****************************************************************************
 755  * Following functions are local.
 756  *****************************************************************************/
 757
 758  /*****************************************************************************
 759  * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
 760  * return first path.
 761  *****************************************************************************/
 762 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
 763 {
 764     char * path;
 765     int i, done;
 766     bool escaped = false;
 767
 768     assert( paths );
 769
 770     /* Alloc a buffer to store the path */
 771     path = malloc( strlen( paths ) + 1 );
 772     if( !path ) return NULL;
 773
 774     /* Look for PATH_SEP_CHAR (a ':' or a ';') */
 775     for( i = 0, done = 0 ; paths[i]; i++ )
 776     {
 777         /* Take care of \\ and \: or \; escapement */
 778         if( escaped )
 779         {
 780             escaped = false;
 781             path[done++] = paths[i];
 782         }
 783 #ifdef WIN32
 784         else if( paths[i] == '/' )
 785             escaped = true;
 786 #else
 787         else if( paths[i] == '\\' )
 788             escaped = true;
 789 #endif
 790         else if( paths[i] == PATH_SEP_CHAR )
 791             break;
 792         else
 793             path[done++] = paths[i];
 794     }
 795     path[done] = 0;
 796
 797     /* Return the remaining paths */
 798     if( remaining_paths ) {
 799         *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
 800     }
 801
 802     return path;
 803 }
 804
 805 char *psz_vlcpath = NULL;
 806
 807 /*****************************************************************************
 808  * AllocateAllPlugins: load all plugin modules we can find.
 809  *****************************************************************************/
 810 #ifdef HAVE_DYNAMIC_PLUGINS
 811 static void AllocateAllPlugins( vlc_object_t *p_this, module_bank_t *p_bank )
 812 {
 813     const char *vlcpath = psz_vlcpath;
 814     int count,i;
 815     char * path;
 816     vlc_array_t *arraypaths = vlc_array_new();
 817     const bool b_reset = var_InheritBool( p_this, "reset-plugins-cache" );
 818
 819     /* Contruct the special search path for system that have a relocatable
 820      * executable. Set it to <vlc path>/plugins. */
 821     assert( vlcpath );
 822
 823     if( asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
 824         vlc_array_append( arraypaths, path );
 825
 826     /* If the user provided a plugin path, we add it to the list */
 827     char *userpaths = var_InheritString( p_this, "plugin-path" );
 828     char *paths_iter;
 829
 830     for( paths_iter = userpaths; paths_iter; )
 831     {
 832         path = copy_next_paths_token( paths_iter, &paths_iter );
 833         if( path )
 834             vlc_array_append( arraypaths, path );
 835     }
 836
 837     count = vlc_array_count( arraypaths );
 838     for( i = 0 ; i < count ; i++ )
 839     {
 840         path = vlc_array_item_at_index( arraypaths, i );
 841         if( !path )
 842             continue;
 843
 844         size_t offset = p_module_bank->i_cache;
 845         if( b_reset )
 846             CacheDelete( p_this, path );
 847         else
 848             CacheLoad( p_this, p_module_bank, path );
 849
 850         msg_Dbg( p_this, "recursively browsing `%s'", path );
 851
 852         /* Don't go deeper than 5 subdirectories */
 853         AllocatePluginDir( p_this, p_bank, path, 5 );
 854
 855
 856         CacheSave( p_this, path, p_module_bank->pp_cache + offset,
 857                    p_module_bank->i_cache - offset );
 858         free( path );
 859     }
 860
 861     vlc_array_destroy( arraypaths );
 862     free( userpaths );
 863 }
 864
 865 /*****************************************************************************
 866  * AllocatePluginDir: recursively parse a directory to look for plugins
 867  *****************************************************************************/
 868 static void AllocatePluginDir( vlc_object_t *p_this, module_bank_t *p_bank,
 869                                const char *psz_dir, unsigned i_maxdepth )
 870 {
 871     if( i_maxdepth == 0 )
 872         return;
 873
 874     DIR *dh = vlc_opendir (psz_dir);
 875     if (dh == NULL)
 876         return;
 877
 878     /* Parse the directory and try to load all files it contains. */
 879     for (;;)
 880     {
 881         char *file = vlc_readdir (dh), *path;
 882         struct stat st;
 883
 884         if (file == NULL)
 885             break;
 886
 887         /* Skip ".", ".." */
 888         if (!strcmp (file, ".") || !strcmp (file, "..")
 889         /* Skip directories for unsupported optimizations */
 890          || !vlc_CPU_CheckPluginDir (file))
 891         {
 892             free (file);
 893             continue;
 894         }
 895
 896         const int pathlen = asprintf (&path, "%s"DIR_SEP"%s", psz_dir, file);
 897         free (file);
 898         if (pathlen == -1 || vlc_stat (path, &st))
 899             continue;
 900
 901         if (S_ISDIR (st.st_mode))
 902             /* Recurse into another directory */
 903             AllocatePluginDir (p_this, p_bank, path, i_maxdepth - 1);
 904         else
 905         if (S_ISREG (st.st_mode)
 906          && strncmp (path, "lib", 3)
 907          && ((size_t)pathlen >= sizeof ("_plugin"LIBEXT))
 908          && !strncasecmp (path + pathlen - strlen ("_plugin"LIBEXT),
 909                           "_plugin"LIBEXT, strlen ("_plugni"LIBEXT)))
 910             /* ^^ We only load files matching "lib*_plugin"LIBEXT */
 911             AllocatePluginFile (p_this, p_bank, path, st.st_mtime, st.st_size);
 912
 913         free (path);
 914     }
 915     closedir (dh);
 916 }
 917
 918 /*****************************************************************************
 919  * AllocatePluginFile: load a module into memory and initialize it.
 920  *****************************************************************************
 921  * This function loads a dynamically loadable module and allocates a structure
 922  * for its information data. The module can then be handled by module_need
 923  * and module_unneed. It can be removed by DeleteModule.
 924  *****************************************************************************/
 925 static int AllocatePluginFile( vlc_object_t * p_this, module_bank_t *p_bank,
 926                                const char *psz_file,
 927                                int64_t i_file_time, int64_t i_file_size )
 928 {
 929     module_t * p_module = NULL;
 930     module_cache_t *p_cache_entry = NULL;
 931
 932     /*
 933      * Check our plugins cache first then load plugin if needed
 934      */
 935     p_cache_entry = CacheFind( p_bank, psz_file, i_file_time, i_file_size );
 936     if( !p_cache_entry )
 937     {
 938         p_module = AllocatePlugin( p_this, psz_file );
 939     }
 940     else
 941     {
 942         module_config_t *p_item = NULL, *p_end = NULL;
 943
 944         p_module = p_cache_entry->p_module;
 945         p_module->b_loaded = false;
 946
 947         /* If plugin-path contains duplicate entries... */
 948         if( p_module->next != NULL )
 949             return 0; /* already taken care of that one */
 950
 951         /* For now we force loading if the module's config contains
 952          * callbacks or actions.
 953          * Could be optimized by adding an API call.*/
 954         for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
 955              p_item < p_end; p_item++ )
 956         {
 957             if( p_item->pf_callback || p_item->i_action )
 958             {
 959                 p_module = AllocatePlugin( p_this, psz_file );
 960                 break;
 961             }
 962         }
 963     }
 964
 965     if( p_module == NULL )
 966         return -1;
 967
 968     /* We have not already scanned and inserted this module */
 969     assert( p_module->next == NULL );
 970
 971     /* Everything worked fine !
 972      * The module is ready to be added to the list. */
 973     p_module->b_builtin = false;
 974
 975     /* msg_Dbg( p_this, "plugin \"%s\", %s",
 976                 p_module->psz_object_name, p_module->psz_longname ); */
 977     p_module->next = p_bank->head;
 978     p_bank->head = p_module;
 979     assert( p_module->next != NULL ); /* Insertion done */
 980
 981     if( !p_module_bank->b_cache )
 982         return 0;
 983
 984     /* Add entry to cache */
 985     module_cache_t **pp_cache = p_bank->pp_cache;
 986
 987     pp_cache = realloc_or_free( pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
 988     if( pp_cache == NULL )
 989         return -1;
 990     pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
 991     if( pp_cache[p_bank->i_cache] == NULL )
 992         return -1;
 993     pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
 994     pp_cache[p_bank->i_cache]->i_time = i_file_time;
 995     pp_cache[p_bank->i_cache]->i_size = i_file_size;
 996     pp_cache[p_bank->i_cache]->p_module = p_module;
 997     p_bank->pp_cache = pp_cache;
 998     p_bank->i_cache++;
 999     return  0;
1000 }
1001
1002 /*****************************************************************************
1003  * AllocatePlugin: load a module into memory and initialize it.
1004  *****************************************************************************
1005  * This function loads a dynamically loadable module and allocates a structure
1006  * for its information data. The module can then be handled by module_need
1007  * and module_unneed. It can be removed by DeleteModule.
1008  *****************************************************************************/
1009 static module_t * AllocatePlugin( vlc_object_t * p_this, const char *psz_file )
1010 {
1011     module_t * p_module = NULL;
1012     module_handle_t handle;
1013
1014     if( module_Load( p_this, psz_file, &handle ) )
1015         return NULL;
1016
1017     /* Now that we have successfully loaded the module, we can
1018      * allocate a structure for it */
1019     p_module = vlc_module_create( p_this );
1020     if( p_module == NULL )
1021     {
1022         module_Unload( handle );
1023         return NULL;
1024     }
1025
1026     p_module->psz_filename = strdup( psz_file );
1027     p_module->handle = handle;
1028     p_module->b_loaded = true;
1029
1030     /* Initialize the module: fill p_module, default config */
1031     if( module_Call( p_this, p_module ) != 0 )
1032     {
1033         /* We couldn't call module_init() */
1034         free( p_module->psz_filename );
1035         module_release( p_module );
1036         module_Unload( handle );
1037         return NULL;
1038     }
1039
1040     DupModule( p_module );
1041
1042     /* Everything worked fine ! The module is ready to be added to the list. */
1043     p_module->b_builtin = false;
1044
1045     return p_module;
1046 }
1047
1048 /*****************************************************************************
1049  * DupModule: make a plugin module standalone.
1050  *****************************************************************************
1051  * This function duplicates all strings in the module, so that the dynamic
1052  * object can be unloaded. It acts recursively on submodules.
1053  *****************************************************************************/
1054 static void DupModule( module_t *p_module )
1055 {
1056     char **pp_shortcuts = p_module->pp_shortcuts;
1057     for( unsigned i = 0; i < p_module->i_shortcuts; i++ )
1058         pp_shortcuts[i] = strdup( p_module->pp_shortcuts[i] );
1059
1060     /* We strdup() these entries so that they are still valid when the
1061      * module is unloaded. */
1062     p_module->psz_capability = strdup( p_module->psz_capability );
1063     p_module->psz_shortname = p_module->psz_shortname ?
1064                                  strdup( p_module->psz_shortname ) : NULL;
1065     p_module->psz_longname = strdup( p_module->psz_longname );
1066     p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1067                                             : NULL;
1068     p_module->domain = p_module->domain ? strdup( p_module->domain ) : NULL;
1069
1070     for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1071         DupModule (subm);
1072 }
1073
1074 /*****************************************************************************
1075  * UndupModule: free a duplicated module.
1076  *****************************************************************************
1077  * This function frees the allocations done in DupModule().
1078  *****************************************************************************/
1079 static void UndupModule( module_t *p_module )
1080 {
1081     char **pp_shortcuts = p_module->pp_shortcuts;
1082
1083     for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1084         UndupModule (subm);
1085
1086     for( unsigned i = 0; i < p_module->i_shortcuts; i++ )
1087         free( pp_shortcuts[i] );
1088
1089     free( p_module->psz_capability );
1090     FREENULL( p_module->psz_shortname );
1091     free( p_module->psz_longname );
1092     FREENULL( p_module->psz_help );
1093     free( p_module->domain );
1094 }
1095
1096 #endif /* HAVE_DYNAMIC_PLUGINS */
1097
1098 /*****************************************************************************
1099  * AllocateBuiltinModule: initialize a builtin module.
1100  *****************************************************************************
1101  * This function registers a builtin module and allocates a structure
1102  * for its information data. The module can then be handled by module_need
1103  * and module_unneed. It can be removed by DeleteModule.
1104  *****************************************************************************/
1105 static int AllocateBuiltinModule( vlc_object_t * p_this,
1106                                   int ( *pf_entry ) ( module_t * ) )
1107 {
1108     module_t * p_module;
1109
1110     /* Now that we have successfully loaded the module, we can
1111      * allocate a structure for it */
1112     p_module = vlc_module_create( p_this );
1113     if( p_module == NULL )
1114         return -1;
1115
1116     /* Initialize the module : fill p_module->psz_object_name, etc. */
1117     if( pf_entry( p_module ) != 0 )
1118     {
1119         /* With a well-written module we shouldn't have to print an
1120          * additional error message here, but just make sure. */
1121         msg_Err( p_this, "failed calling entry point in builtin module" );
1122         module_release( p_module );
1123         return -1;
1124     }
1125
1126     /* Everything worked fine ! The module is ready to be added to the list. */
1127     p_module->b_builtin = true;
1128     /* LOCK */
1129     p_module->next = p_module_bank->head;
1130     p_module_bank->head = p_module;
1131     /* UNLOCK */
1132
1133     /* msg_Dbg( p_this, "builtin \"%s\", %s",
1134                 p_module->psz_object_name, p_module->psz_longname ); */
1135
1136     return 0;
1137 }
1138
1139 /*****************************************************************************
1140  * DeleteModule: delete a module and its structure.
1141  *****************************************************************************
1142  * This function can only be called if the module isn't being used.
1143  *****************************************************************************/
1144 static void DeleteModule( module_bank_t *p_bank, module_t * p_module )
1145 {
1146     assert( p_module );
1147
1148     /* Unlist the module (if it is in the list) */
1149     module_t **pp_self = &p_bank->head;
1150     while (*pp_self != NULL && *pp_self != p_module)
1151         pp_self = &((*pp_self)->next);
1152     if (*pp_self)
1153         *pp_self = p_module->next;
1154
1155     /* We free the structures that we strdup()ed in Allocate*Module(). */
1156 #ifdef HAVE_DYNAMIC_PLUGINS
1157     if( !p_module->b_builtin )
1158     {
1159         if( p_module->b_loaded && p_module->b_unloadable )
1160         {
1161             module_Unload( p_module->handle );
1162         }
1163         UndupModule( p_module );
1164         free( p_module->psz_filename );
1165     }
1166 #endif
1167
1168     /* Free and detach the object's children */
1169     while (p_module->submodule)
1170     {
1171         module_t *submodule = p_module->submodule;
1172         p_module->submodule = submodule->next;
1173         module_release (submodule);
1174     }
1175
1176     config_Free( p_module );
1177     module_release( p_module );
1178 }