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

   1 /*****************************************************************************
   2  * os.c : Low-level dynamic library handling
   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> /* MODULE_SUFFIX */
  33 #include "libvlc.h"
  34 #include "modules.h"
  35
  36 #include <stdlib.h>                                      /* free(), strtol() */
  37 #include <stdio.h>                                              /* sprintf() */
  38 #include <string.h>                                              /* strdup() */
  39
  40 #ifdef HAVE_SYS_TYPES_H
  41 #   include <sys/types.h>
  42 #endif
  43
  44 #if !defined(HAVE_DYNAMIC_PLUGINS)
  45     /* no support for plugins */
  46 #elif defined(HAVE_DL_DYLD)
  47 #   if defined(HAVE_MACH_O_DYLD_H)
  48 #       include <mach-o/dyld.h>
  49 #   endif
  50 #elif defined(HAVE_DL_BEOS)
  51 #   if defined(HAVE_IMAGE_H)
  52 #       include <image.h>
  53 #   endif
  54 #elif defined(HAVE_DL_WINDOWS)
  55 #   include <windows.h>
  56 #elif defined(HAVE_DL_DLOPEN)
  57 #   if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
  58 #       include <dlfcn.h>
  59 #   endif
  60 #   if defined(HAVE_SYS_DL_H)
  61 #       include <sys/dl.h>
  62 #   endif
  63 #elif defined(HAVE_DL_SHL_LOAD)
  64 #   if defined(HAVE_DL_H)
  65 #       include <dl.h>
  66 #   endif
  67 #endif
  68 #ifdef HAVE_VALGRIND_VALGRIND_H
  69 # include <valgrind/valgrind.h>
  70 #endif
  71
  72 /*****************************************************************************
  73  * Local prototypes
  74  *****************************************************************************/
  75 #ifdef HAVE_DYNAMIC_PLUGINS
  76 static void *module_Lookup( module_handle_t, const char * );
  77
  78 #if defined(HAVE_DL_WINDOWS)
  79 static char * GetWindowsError  ( void );
  80 #endif
  81
  82 /**
  83  * module Call
  84  *
  85  * Call a symbol given its name and a module structure. The symbol MUST
  86  * refer to a function returning int and taking a module_t* as an argument.
  87  * \param p_module the modules
  88  * \return 0 if it pass and -1 in case of a failure
  89  */
  90 int module_Call( vlc_object_t *obj, module_t *p_module )
  91 {
  92     static const char psz_name[] = "vlc_entry" MODULE_SUFFIX;
  93     int (* pf_symbol) ( module_t * p_module );
  94
  95     /* Try to resolve the symbol */
  96     pf_symbol = (int (*)(module_t *)) module_Lookup( p_module->handle,
  97                                                      psz_name );
  98
  99     if( pf_symbol == NULL )
 100     {
 101 #if defined(HAVE_DL_DYLD) || defined(HAVE_DL_BEOS)
 102         msg_Warn( obj, "cannot find symbol \"%s\" in file `%s'",
 103                   psz_name, p_module->psz_filename );
 104 #elif defined(HAVE_DL_WINDOWS)
 105         char *psz_error = GetWindowsError();
 106         msg_Warn( obj, "cannot find symbol \"%s\" in file `%s' (%s)",
 107                   psz_name, p_module->psz_filename, psz_error );
 108         free( psz_error );
 109 #elif defined(HAVE_DL_DLOPEN)
 110         msg_Warn( obj, "cannot find symbol \"%s\" in file `%s' (%s)",
 111                   psz_name, p_module->psz_filename, dlerror() );
 112 #elif defined(HAVE_DL_SHL_LOAD)
 113         msg_Warn( obj, "cannot find symbol \"%s\" in file `%s' (%m)",
 114                   psz_name, p_module->psz_filename );
 115 #else
 116 #   error "Something is wrong in modules.c"
 117 #endif
 118         return -1;
 119     }
 120
 121     /* We can now try to call the symbol */
 122     if( pf_symbol( p_module ) != 0 )
 123     {
 124         /* With a well-written module we shouldn't have to print an
 125          * additional error message here, but just make sure. */
 126         msg_Err( obj, "Failed to call symbol \"%s\" in file `%s'",
 127                  psz_name, p_module->psz_filename );
 128         return -1;
 129     }
 130
 131     /* Everything worked fine, we can return */
 132     return 0;
 133 }
 134
 135 /**
 136  * Load a dynamically linked library using a system dependent method.
 137  *
 138  * \param p_this vlc object
 139  * \param psz_file library file
 140  * \param p_handle the module handle returned
 141  * \return 0 on success as well as the module handle.
 142  */
 143 int module_Load( vlc_object_t *p_this, const char *psz_file,
 144                  module_handle_t *p_handle )
 145 {
 146     module_handle_t handle;
 147
 148 #if defined(HAVE_DL_DYLD)
 149     NSObjectFileImage image;
 150     NSObjectFileImageReturnCode ret;
 151
 152     ret = NSCreateObjectFileImageFromFile( psz_file, &image );
 153
 154     if( ret != NSObjectFileImageSuccess )
 155     {
 156         msg_Warn( p_this, "cannot create image from `%s'", psz_file );
 157         return -1;
 158     }
 159
 160     /* Open the dynamic module */
 161     handle = NSLinkModule( image, psz_file,
 162                            NSLINKMODULE_OPTION_RETURN_ON_ERROR );
 163
 164     if( !handle )
 165     {
 166         NSLinkEditErrors errors;
 167         const char *psz_file, *psz_err;
 168         int i_errnum;
 169         NSLinkEditError( &errors, &i_errnum, &psz_file, &psz_err );
 170         msg_Warn( p_this, "cannot link module `%s' (%s)", psz_file, psz_err );
 171         NSDestroyObjectFileImage( image );
 172         return -1;
 173     }
 174
 175     /* Destroy our image, we won't need it */
 176     NSDestroyObjectFileImage( image );
 177
 178 #elif defined(HAVE_DL_BEOS)
 179     handle = load_add_on( psz_file );
 180     if( handle < 0 )
 181     {
 182         msg_Warn( p_this, "cannot load module `%s'", psz_file );
 183         return -1;
 184     }
 185
 186 #elif defined(HAVE_DL_WINDOWS)
 187     wchar_t psz_wfile[MAX_PATH];
 188     MultiByteToWideChar( CP_ACP, 0, psz_file, -1, psz_wfile, MAX_PATH );
 189
 190 #ifndef UNDER_CE
 191     /* FIXME: this is not thread-safe -- Courmisch */
 192     UINT mode = SetErrorMode (SEM_FAILCRITICALERRORS);
 193     SetErrorMode (mode|SEM_FAILCRITICALERRORS);
 194 #endif
 195
 196     handle = LoadLibraryW( psz_wfile );
 197
 198 #ifndef UNDER_CE
 199     SetErrorMode (mode);
 200 #endif
 201
 202     if( handle == NULL )
 203     {
 204         char *psz_err = GetWindowsError();
 205         msg_Warn( p_this, "cannot load module `%s' (%s)", psz_file, psz_err );
 206         free( psz_err );
 207         return -1;
 208     }
 209
 210 #elif defined(HAVE_DL_DLOPEN)
 211
 212 # if defined (RTLD_NOW)
 213     const int flags = RTLD_NOW;
 214 # elif defined (DL_LAZY)
 215     const int flags = DL_LAZY;
 216 # else
 217     const int flags = 0;
 218 # endif
 219
 220     handle = dlopen( psz_file, flags );
 221     if( handle == NULL )
 222     {
 223         msg_Warn( p_this, "cannot load module `%s' (%s)",
 224                           psz_file, dlerror() );
 225         return -1;
 226     }
 227
 228 #elif defined(HAVE_DL_SHL_LOAD)
 229     handle = shl_load( psz_file, BIND_IMMEDIATE | BIND_NONFATAL, NULL );
 230     if( handle == NULL )
 231     {
 232         msg_Warn( p_this, "cannot load module `%s' (%m)", psz_file );
 233         return -1;
 234     }
 235
 236 #else
 237 #   error "Something is wrong in modules.c"
 238
 239 #endif
 240
 241     *p_handle = handle;
 242     return 0;
 243 }
 244
 245 /**
 246  * CloseModule: unload a dynamic library
 247  *
 248  * This function unloads a previously opened dynamically linked library
 249  * using a system dependent method. No return value is taken in consideration,
 250  * since some libraries sometimes refuse to close properly.
 251  * \param handle handle of the library
 252  * \return nothing
 253  */
 254 void module_Unload( module_handle_t handle )
 255 {
 256 #if defined(HAVE_DL_DYLD)
 257     NSUnLinkModule( handle, FALSE );
 258
 259 #elif defined(HAVE_DL_BEOS)
 260     unload_add_on( handle );
 261
 262 #elif defined(HAVE_DL_WINDOWS)
 263     FreeLibrary( handle );
 264
 265 #elif defined(HAVE_DL_DLOPEN)
 266 # ifdef HAVE_VALGRIND_VALGRIND_H
 267     if( RUNNING_ON_VALGRIND > 0 )
 268         return; /* do not dlclose() so that we get proper stack traces */
 269 # endif
 270     dlclose( handle );
 271
 272 #elif defined(HAVE_DL_SHL_LOAD)
 273     shl_unload( handle );
 274
 275 #endif
 276     return;
 277 }
 278
 279 /**
 280  * Looks up a symbol from a dynamically loaded library
 281  *
 282  * This function queries a loaded library for a symbol specified in a
 283  * string, and returns a pointer to it. We don't check for dlerror() or
 284  * similar functions, since we want a non-NULL symbol anyway.
 285  *
 286  * @param handle handle to the module
 287  * @param psz_function function name
 288  * @return NULL on error, or the address of the symbol
 289  */
 290 static void *module_Lookup( module_handle_t handle, const char *psz_function )
 291 {
 292 #if defined(HAVE_DL_DYLD)
 293     char psz_call[strlen( psz_function ) + 2];
 294     psz_call[0] = '_';
 295     memcpy( psz_call + 1, psz_function, sizeof( psz_call ) - 1 );
 296
 297     NSSymbol sym = NSLookupSymbolInModule( handle, psz_call );
 298     return NSAddressOfSymbol( sym );
 299
 300 #elif defined(HAVE_DL_BEOS)
 301     void * p_symbol;
 302     if( B_OK == get_image_symbol( handle, psz_function,
 303                                   B_SYMBOL_TYPE_TEXT, &p_symbol ) )
 304     {
 305         return p_symbol;
 306     }
 307     else
 308     {
 309         return NULL;
 310     }
 311
 312 #elif defined(HAVE_DL_WINDOWS) && defined(UNDER_CE)
 313     wchar_t wide[strlen( psz_function ) + 1];
 314     size_t i = 0;
 315     do
 316         wide[i] = psz_function[i]; /* UTF-16 <- ASCII */
 317     while( psz_function[i++] );
 318
 319     return (void *)GetProcAddress( handle, wide );
 320
 321 #elif defined(HAVE_DL_WINDOWS) && defined(WIN32)
 322     return (void *)GetProcAddress( handle, (char *)psz_function );
 323
 324 #elif defined(HAVE_DL_DLOPEN)
 325     return dlsym( handle, psz_function );
 326
 327 #elif defined(HAVE_DL_SHL_LOAD)
 328     void *p_sym;
 329     shl_findsym( &handle, psz_function, TYPE_UNDEFINED, &p_sym );
 330     return p_sym;
 331
 332 #endif
 333 }
 334
 335 #if defined(HAVE_DL_WINDOWS)
 336 static char * GetWindowsError( void )
 337 {
 338 #if defined(UNDER_CE)
 339     wchar_t psz_tmp[MAX_PATH];
 340     char * psz_buffer = malloc( MAX_PATH );
 341 #else
 342     char * psz_tmp = malloc( MAX_PATH );
 343 #endif
 344     int i = 0, i_error = GetLastError();
 345
 346     FormatMessage( FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
 347                    NULL, i_error, MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT),
 348                    (LPTSTR)psz_tmp, MAX_PATH, NULL );
 349
 350     /* Go to the end of the string */
 351     while( psz_tmp[i] && psz_tmp[i] != _T('\r') && psz_tmp[i] != _T('\n') )
 352     {
 353         i++;
 354     }
 355
 356     if( psz_tmp[i] )
 357     {
 358 #if defined(UNDER_CE)
 359         swprintf( psz_tmp + i, L" (error %i)", i_error );
 360         psz_tmp[ 255 ] = L'\0';
 361 #else
 362         snprintf( psz_tmp + i, 256 - i, " (error %i)", i_error );
 363         psz_tmp[ 255 ] = '\0';
 364 #endif
 365     }
 366
 367 #if defined(UNDER_CE)
 368     wcstombs( psz_buffer, psz_tmp, MAX_PATH );
 369     return psz_buffer;
 370 #else
 371     return psz_tmp;
 372 #endif
 373 }
 374 #endif /* HAVE_DL_WINDOWS */
 375 #endif /* HAVE_DYNAMIC_PLUGINS */