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