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