1 #define PETSC_DLL 2 /* 3 Low-level routines for managing dynamic link libraries (DLLs). 4 */ 5 6 #include "../src/sys/dll/dlimpl.h" 7 8 /* XXX Should be done better !!!*/ 9 #if !defined(PETSC_HAVE_DYNAMIC_LIBRARIES) 10 #undef PETSC_HAVE_WINDOWS_H 11 #undef PETSC_HAVE_DLFCN_H 12 #endif 13 14 #if defined(PETSC_HAVE_WINDOWS_H) 15 #include <windows.h> 16 #elif defined(PETSC_HAVE_DLFCN_H) 17 #include <dlfcn.h> 18 #endif 19 20 #if defined(PETSC_HAVE_WINDOWS_H) 21 typedef HMODULE dlhandle_t; 22 typedef FARPROC dlsymbol_t; 23 #elif defined(PETSC_HAVE_DLFCN_H) 24 typedef void* dlhandle_t; 25 typedef void* dlsymbol_t; 26 #else 27 typedef void* dlhandle_t; 28 typedef void* dlsymbol_t; 29 #endif 30 31 #undef __FUNCT__ 32 #define __FUNCT__ "PetscDLOpen" 33 /*@C 34 PetscDLOpen - opens dynamic library 35 36 Not Collective 37 38 Input Parameters: 39 + name - name of library 40 - flags - options on how to open library 41 42 Output Parameter: 43 . handle 44 45 Level: developer 46 47 @*/ 48 PetscErrorCode PETSCSYS_DLLEXPORT PetscDLOpen(const char name[],int flags,PetscDLHandle *handle) 49 { 50 int dlflags1,dlflags2; 51 dlhandle_t dlhandle; 52 53 PetscFunctionBegin; 54 PetscValidCharPointer(name,1); 55 PetscValidPointer(handle,3); 56 57 dlflags1 = 0; 58 dlflags2 = 0; 59 dlhandle = (dlhandle_t) 0; 60 *handle = (PetscDLHandle) 0; 61 62 /* 63 --- LoadLibrary --- 64 */ 65 #if defined(PETSC_HAVE_WINDOWS_H) && defined(PETSC_HAVE_LOADLIBRARY) 66 dlhandle = LoadLibrary(name); 67 if (!dlhandle) { 68 #if defined(PETSC_HAVE_GETLASTERROR) 69 PetscErrorCode ierr; 70 DWORD erc; 71 char *buff = NULL; 72 erc = GetLastError(); 73 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS, 74 NULL,erc,MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),(LPSTR)&buff,0,NULL); 75 ierr = PetscError(PETSC_COMM_SELF,__LINE__,__FUNCT__,__FILE__,__SDIR__,PETSC_ERR_FILE_OPEN,PETSC_ERROR_REPEAT, 76 "Unable to open dynamic library:\n %s\n Error message from LoadLibrary() %s\n",name,buff); 77 LocalFree(buff); 78 PetscFunctionReturn(ierr); 79 #else 80 SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open dynamic library:\n %s\n Error message from LoadLibrary() %s\n",name,"unavailable"); 81 #endif 82 } 83 84 /* 85 --- dlopen --- 86 */ 87 #elif defined(PETSC_HAVE_DLFCN_H) && defined(PETSC_HAVE_DLOPEN) 88 /* 89 Mode indicates symbols required by symbol loaded with dlsym() 90 are only loaded when required (not all together) also indicates 91 symbols required can be contained in other libraries also opened 92 with dlopen() 93 */ 94 #if defined(PETSC_HAVE_RTLD_LAZY) 95 dlflags1 = RTLD_LAZY; 96 #endif 97 #if defined(PETSC_HAVE_RTLD_NOW) 98 if (flags & PETSC_DL_NOW) 99 dlflags1 = RTLD_NOW; 100 #endif 101 #if defined(PETSC_HAVE_RTLD_GLOBAL) 102 dlflags2 = RTLD_GLOBAL; 103 #endif 104 #if defined(PETSC_HAVE_RTLD_LOCAL) 105 if (flags & PETSC_DL_LOCAL) 106 dlflags2 = RTLD_LOCAL; 107 #endif 108 #if defined(PETSC_HAVE_DLERROR) 109 dlerror(); /* clear any previous error */ 110 #endif 111 dlhandle = dlopen(name,dlflags1|dlflags2); 112 if (!dlhandle) { 113 #if defined(PETSC_HAVE_DLERROR) 114 const char *errmsg = dlerror(); 115 #else 116 const char *errmsg = "unavailable"; 117 #endif 118 SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open dynamic library:\n %s\n Error message from dlopen() %s\n",name,errmsg); 119 } 120 121 /* 122 --- unimplemented --- 123 */ 124 #else 125 SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP_SYS, "Cannot use dynamic libraries on this platform"); 126 #endif 127 128 *handle = (PetscDLHandle) dlhandle; 129 130 PetscFunctionReturn(0); 131 } 132 133 134 #undef __FUNCT__ 135 #define __FUNCT__ "PetscDLClose" 136 /*@C 137 PetscDLClose - closes a dynamic library 138 139 Not Collective 140 141 Input Parameter: 142 . handle - the handle for the library obtained with PetscDLOpen() 143 144 Level: developer 145 @*/ 146 PetscErrorCode PETSCSYS_DLLEXPORT PetscDLClose(PetscDLHandle *handle) 147 { 148 dlhandle_t dlhandle; 149 150 PetscFunctionBegin; 151 PetscValidPointer(handle,1); 152 153 dlhandle = (dlhandle_t) *handle; 154 155 /* 156 --- FreeLibrary --- 157 */ 158 #if defined(PETSC_HAVE_WINDOWS_H) 159 #if defined(PETSC_HAVE_FREELIBRARY) 160 if (FreeLibrary(dlhandle) == 0) { 161 #if defined(PETSC_HAVE_GETLASTERROR) 162 char *buff = NULL; 163 DWORD erc = GetLastError(); 164 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS, 165 NULL,erc,MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),(LPSTR)&buff,0,NULL); 166 PetscErrorPrintf("Error closing dynamic library:\n Error message from FreeLibrary() %s\n",buff); 167 LocalFree(buff); 168 #else 169 PetscErrorPrintf("Error closing dynamic library:\n Error message from FreeLibrary() %s\n","unavailable"); 170 #endif 171 } 172 #endif /* !PETSC_HAVE_FREELIBRARY */ 173 174 /* 175 --- dclose --- 176 */ 177 #elif defined(PETSC_HAVE_DLFCN_H) 178 #if defined(PETSC_HAVE_DLCLOSE) 179 #if defined(PETSC_HAVE_DLERROR) 180 dlerror(); /* clear any previous error */ 181 #endif 182 if (dlclose(dlhandle) < 0) { 183 #if defined(PETSC_HAVE_DLERROR) 184 const char *errmsg = dlerror(); 185 #else 186 const char *errmsg = "unavailable"; 187 #endif 188 PetscErrorPrintf("Error closing dynamic library:\n Error message from dlclose() %s\n", errmsg); 189 } 190 #endif /* !PETSC_HAVE_DLCLOSE */ 191 192 /* 193 --- unimplemented --- 194 */ 195 #else 196 SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP_SYS, "Cannot use dynamic libraries on this platform"); 197 #endif 198 199 *handle = PETSC_NULL; 200 201 PetscFunctionReturn(0); 202 } 203 204 205 #undef __FUNCT__ 206 #define __FUNCT__ "PetscDLSym" 207 /*@C 208 PetscDLSym - finds a symbol in a dynamic library 209 210 Not Collective 211 212 Input Parameters: 213 + handle - obtained with PetscDLOpen() or PETSC_NULL 214 - symbol - name of symbol 215 216 Output Parameter: 217 . value - pointer to the function 218 219 Level: developer 220 221 Notes: 222 If handle is PETSC_NULL, the symbol is looked for in the main executable's dynamic symbol table. 223 In order to be dynamically loadable, the symbol has to be exported as such. On many UNIX-like 224 systems this requires platform-specific linker flags. 225 226 @*/ 227 PetscErrorCode PETSCSYS_DLLEXPORT PetscDLSym(PetscDLHandle handle,const char symbol[],void **value) 228 { 229 dlhandle_t dlhandle; 230 dlsymbol_t dlsymbol; 231 232 PetscFunctionBegin; 233 PetscValidCharPointer(symbol,2); 234 PetscValidPointer(value,3); 235 236 dlhandle = (dlhandle_t) 0; 237 dlsymbol = (dlsymbol_t) 0; 238 239 *value = (void *) 0; 240 241 /* 242 --- GetProcAddress --- 243 */ 244 #if defined(PETSC_HAVE_WINDOWS_H) 245 #if defined(PETSC_HAVE_GETPROCADDRESS) 246 if (handle != PETSC_NULL) 247 dlhandle = (dlhandle_t) handle; 248 else 249 dlhandle = (dlhandle_t) GetCurrentProcess(); 250 dlsymbol = (dlsymbol_t) GetProcAddress(dlhandle,symbol); 251 #if defined(PETSC_HAVE_SETLASTERROR) 252 SetLastError((DWORD)0); /* clear any previous error */ 253 #endif 254 #endif /* !PETSC_HAVE_GETPROCADDRESS */ 255 256 /* 257 --- dlsym --- 258 */ 259 #elif defined(PETSC_HAVE_DLFCN_H) 260 #if defined(PETSC_HAVE_DLSYM) 261 if (handle != PETSC_NULL) { 262 dlhandle = (dlhandle_t) handle; 263 } 264 else { 265 dlhandle = (dlhandle_t) 0; 266 267 #if defined(PETSC_HAVE_DLOPEN) 268 /* Attempt to retrieve the main executable's dlhandle. */ 269 { int dlflags1 = 0, dlflags2 = 0; 270 #if defined(PETSC_HAVE_RTLD_LAZY) 271 dlflags1 = RTLD_LAZY; 272 #endif 273 if(!dlflags1) { 274 #if defined(PETSC_HAVE_RTLD_NOW) 275 dlflags1 = RTLD_NOW; 276 #endif 277 } 278 #if defined(PETSC_HAVE_RTLD_LOCAL) 279 dlflags2 = RTLD_LOCAL; 280 #endif 281 if(!dlflags2) { 282 #if defined(PETSC_HAVE_RTLD_GLOBAL) 283 dlflags2 = RTLD_GLOBAL; 284 #endif 285 } 286 #if defined(PETSC_HAVE_DLERROR) 287 dlerror(); /* clear any previous error */ 288 #endif 289 /* Attempt to open the main executable as a dynamic library. */ 290 dlhandle = dlopen(0, dlflags1|dlflags2); 291 } 292 #if defined(PETSC_HAVE_DLERROR) 293 { const char *e = (const char*) dlerror(); 294 if(e){ 295 SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Error opening main executable as a dynamic library:\n Error message from dlopen(): '%s'\n", e); 296 } 297 } 298 #endif 299 #endif /* PETSC_HAVE_DLOPEN */ 300 } 301 #if defined(PETSC_HAVE_DLERROR) 302 dlerror(); /* clear any previous error */ 303 #endif 304 dlsymbol = (dlsymbol_t) dlsym(dlhandle,symbol); 305 #if defined(PETSC_HAVE_DLERROR) 306 /* e = dlerror(); */ 307 /* if(e){ */ 308 /* SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG,"Error obtaining symbol '%s' from dynamic library:\n Error message from dlsym(): '%s'\n", symbol, e); */ 309 /* } */ 310 #endif 311 #endif /* !PETSC_HAVE_DLSYM */ 312 313 /* 314 --- unimplemented --- 315 */ 316 #else 317 SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP_SYS, "Cannot use dynamic libraries on this platform"); 318 #endif 319 320 *value = *((void**)&dlsymbol); 321 322 PetscFunctionReturn(0); 323 } 324