1e5c89e4eSSatish Balay #define PETSC_DLL 2e5c89e4eSSatish Balay /* 3e5c89e4eSSatish Balay Routines for opening dynamic link libraries (DLLs), keeping a searchable 4e5c89e4eSSatish Balay path of DLLs, obtaining remote DLLs via a URL and opening them locally. 5e5c89e4eSSatish Balay */ 6e5c89e4eSSatish Balay 7e5c89e4eSSatish Balay #include "petsc.h" 8e5c89e4eSSatish Balay #include "petscsys.h" 9b3bb0f5eSLisandro Dalcin #include "src/sys/dll/dlimpl.h" 10e5c89e4eSSatish Balay 11e5c89e4eSSatish Balay /* 12e5c89e4eSSatish Balay Contains the list of registered CCA components 13e5c89e4eSSatish Balay */ 14e5c89e4eSSatish Balay PetscFList CCAList = 0; 15e5c89e4eSSatish Balay 16e5c89e4eSSatish Balay 17e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/ 18e5c89e4eSSatish Balay /* 19e5c89e4eSSatish Balay Code to maintain a list of opened dynamic libraries and load symbols 20e5c89e4eSSatish Balay */ 21e5bd5246SBarry Smith struct _n_PetscDLLibrary { 22e5bd5246SBarry Smith PetscDLLibrary next; 23ebd79076SLisandro Dalcin PetscDLHandle handle; 24e5c89e4eSSatish Balay char libname[PETSC_MAX_PATH_LEN]; 25e5c89e4eSSatish Balay }; 26e5c89e4eSSatish Balay 27b3bb0f5eSLisandro Dalcin /* 28b3bb0f5eSLisandro Dalcin This is the list used by the PetscDLLibrary register routines 29b3bb0f5eSLisandro Dalcin */ 30b3bb0f5eSLisandro Dalcin PetscDLLibrary DLLibrariesLoaded = 0; 31b3bb0f5eSLisandro Dalcin 32b3bb0f5eSLisandro Dalcin 33e5c89e4eSSatish Balay #undef __FUNCT__ 34e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryPrintPath" 355673baf8SLisandro Dalcin PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryPrintPath(PetscDLLibrary libs) 36e5c89e4eSSatish Balay { 37e5c89e4eSSatish Balay PetscFunctionBegin; 38e5c89e4eSSatish Balay while (libs) { 39e5c89e4eSSatish Balay PetscErrorPrintf(" %s\n",libs->libname); 40e5c89e4eSSatish Balay libs = libs->next; 41e5c89e4eSSatish Balay } 42e5c89e4eSSatish Balay PetscFunctionReturn(0); 43e5c89e4eSSatish Balay } 44e5c89e4eSSatish Balay 45e5c89e4eSSatish Balay #undef __FUNCT__ 46e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryRetrieve" 47e5c89e4eSSatish Balay /*@C 48e5c89e4eSSatish Balay PetscDLLibraryRetrieve - Copies a PETSc dynamic library from a remote location 49e5c89e4eSSatish Balay (if it is remote), indicates if it exits and its local name. 50e5c89e4eSSatish Balay 51e5c89e4eSSatish Balay Collective on MPI_Comm 52e5c89e4eSSatish Balay 53e5c89e4eSSatish Balay Input Parameters: 54e5c89e4eSSatish Balay + comm - processors that are opening the library 55e5c89e4eSSatish Balay - libname - name of the library, can be relative or absolute 56e5c89e4eSSatish Balay 57e5c89e4eSSatish Balay Output Parameter: 58e5c89e4eSSatish Balay . handle - library handle 59e5c89e4eSSatish Balay 60e5c89e4eSSatish Balay Level: developer 61e5c89e4eSSatish Balay 62e5c89e4eSSatish Balay Notes: 63e5c89e4eSSatish Balay [[<http,ftp>://hostname]/directoryname/]filename[.so.1.0] 64e5c89e4eSSatish Balay 65e5c89e4eSSatish Balay ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, or ${any environmental variable} 66e5c89e4eSSatish Balay occuring in directoryname and filename will be replaced with appropriate values. 67e5c89e4eSSatish Balay @*/ 68300a7f5bSBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryRetrieve(MPI_Comm comm,const char libname[],char *lname,size_t llen,PetscTruth *found) 69e5c89e4eSSatish Balay { 70*d46cf212SLisandro Dalcin char *buf,*par2,suffix[16],*gz,*so; 71*d46cf212SLisandro Dalcin size_t len; 72*d46cf212SLisandro Dalcin PetscTruth match; 73e5c89e4eSSatish Balay PetscErrorCode ierr; 74e5c89e4eSSatish Balay 75e5c89e4eSSatish Balay PetscFunctionBegin; 76e5c89e4eSSatish Balay /* 77a523d312SBarry Smith make copy of library name and replace $PETSC_ARCH etc 78e5c89e4eSSatish Balay so we can add to the end of it to look for something like .so.1.0 etc. 79e5c89e4eSSatish Balay */ 80e5c89e4eSSatish Balay ierr = PetscStrlen(libname,&len);CHKERRQ(ierr); 81e5c89e4eSSatish Balay len = PetscMax(4*len,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 82*d46cf212SLisandro Dalcin ierr = PetscMalloc(len*sizeof(char),&buf);CHKERRQ(ierr); 83*d46cf212SLisandro Dalcin par2 = buf; 84e5c89e4eSSatish Balay ierr = PetscStrreplace(comm,libname,par2,len);CHKERRQ(ierr); 85e5c89e4eSSatish Balay 86*d46cf212SLisandro Dalcin /* remove any file: header */ 87*d46cf212SLisandro Dalcin ierr = PetscStrncmp(par2,"file:",5,&match);CHKERRQ(ierr); 88*d46cf212SLisandro Dalcin if (match) { par2 = par2 + 5; } 89e5c89e4eSSatish Balay 90e5c89e4eSSatish Balay /* strip out .a from it if user put it in by mistake */ 91e5c89e4eSSatish Balay ierr = PetscStrlen(par2,&len);CHKERRQ(ierr); 92e5c89e4eSSatish Balay if (par2[len-1] == 'a' && par2[len-2] == '.') par2[len-2] = 0; 93e5c89e4eSSatish Balay 94*d46cf212SLisandro Dalcin /* temporarily remove .gz if it ends library name */ 95*d46cf212SLisandro Dalcin ierr = PetscStrrstr(par2,".gz",&gz);CHKERRQ(ierr); 96e5c89e4eSSatish Balay if (gz) { 97e5c89e4eSSatish Balay ierr = PetscStrlen(gz,&len);CHKERRQ(ierr); 98*d46cf212SLisandro Dalcin if (len != 3) gz = 0; /* do not end (exactly) with .gz */ 99*d46cf212SLisandro Dalcin else *gz = 0; /* ends with .gz, so remove it */ 100e5c89e4eSSatish Balay } 101e5c89e4eSSatish Balay 102e5c89e4eSSatish Balay /* see if library name does already not have suffix attached */ 103b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy(suffix,".");CHKERRQ(ierr); 104b3bb0f5eSLisandro Dalcin ierr = PetscStrcat(suffix,PETSC_SLSUFFIX);CHKERRQ(ierr); 105b3bb0f5eSLisandro Dalcin ierr = PetscStrrstr(par2,suffix,&so);CHKERRQ(ierr); 106*d46cf212SLisandro Dalcin /* and attach the suffix if it is not there */ 107*d46cf212SLisandro Dalcin if (!so) { ierr = PetscStrcat(par2,suffix);CHKERRQ(ierr); } 108e5c89e4eSSatish Balay 109*d46cf212SLisandro Dalcin /* restore the .gz suffix if it was there */ 110*d46cf212SLisandro Dalcin if (gz) { ierr = PetscStrcat(par2,".gz");CHKERRQ(ierr); } 111*d46cf212SLisandro Dalcin 112*d46cf212SLisandro Dalcin /* and finally retrieve the file */ 113e5c89e4eSSatish Balay ierr = PetscFileRetrieve(comm,par2,lname,llen,found);CHKERRQ(ierr); 114*d46cf212SLisandro Dalcin 115*d46cf212SLisandro Dalcin ierr = PetscFree(buf);CHKERRQ(ierr); 116e5c89e4eSSatish Balay PetscFunctionReturn(0); 117e5c89e4eSSatish Balay } 118e5c89e4eSSatish Balay 119e5c89e4eSSatish Balay 120e5c89e4eSSatish Balay #undef __FUNCT__ 121e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryOpen" 122e5c89e4eSSatish Balay /*@C 123ebd79076SLisandro Dalcin PetscDLLibraryOpen - Opens a PETSc dynamic link library 124e5c89e4eSSatish Balay 125e5c89e4eSSatish Balay Collective on MPI_Comm 126e5c89e4eSSatish Balay 127e5c89e4eSSatish Balay Input Parameters: 128e5c89e4eSSatish Balay + comm - processors that are opening the library 129e5c89e4eSSatish Balay - libname - name of the library, can be relative or absolute 130e5c89e4eSSatish Balay 131e5c89e4eSSatish Balay Output Parameter: 132e5c89e4eSSatish Balay . handle - library handle 133e5c89e4eSSatish Balay 134e5c89e4eSSatish Balay Level: developer 135e5c89e4eSSatish Balay 136e5c89e4eSSatish Balay Notes: 137e5c89e4eSSatish Balay [[<http,ftp>://hostname]/directoryname/]filename[.so.1.0] 138e5c89e4eSSatish Balay 139e5c89e4eSSatish Balay ${PETSC_ARCH} occuring in directoryname and filename 140e5c89e4eSSatish Balay will be replaced with the appropriate value. 141e5c89e4eSSatish Balay @*/ 142b3bb0f5eSLisandro Dalcin PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryOpen(MPI_Comm comm,const char path[],PetscDLLibrary *entry) 143e5c89e4eSSatish Balay { 144e5c89e4eSSatish Balay PetscErrorCode ierr; 145b3bb0f5eSLisandro Dalcin PetscTruth foundlibrary,match; 146b3bb0f5eSLisandro Dalcin char libname[PETSC_MAX_PATH_LEN],par2[PETSC_MAX_PATH_LEN],suffix[16],*s; 147b3bb0f5eSLisandro Dalcin char *basename,registername[128]; 1485673baf8SLisandro Dalcin PetscDLHandle handle; 149e5c89e4eSSatish Balay PetscErrorCode (*func)(const char*) = NULL; 150e5c89e4eSSatish Balay size_t len; 151e5c89e4eSSatish Balay 152e5c89e4eSSatish Balay PetscFunctionBegin; 1535673baf8SLisandro Dalcin PetscValidCharPointer(libname,2); 1545673baf8SLisandro Dalcin PetscValidPointer(entry,3); 155ebd79076SLisandro Dalcin 1565673baf8SLisandro Dalcin *entry = PETSC_NULL; 157e5c89e4eSSatish Balay 158b3bb0f5eSLisandro Dalcin /* retrieve the library */ 159b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Retrieving %s\n",path);CHKERRQ(ierr); 160b3bb0f5eSLisandro Dalcin ierr = PetscDLLibraryRetrieve(comm,path,par2,PETSC_MAX_PATH_LEN,&foundlibrary);CHKERRQ(ierr); 161b3bb0f5eSLisandro Dalcin if (!foundlibrary) SETERRQ1(PETSC_ERR_FILE_OPEN,"Unable to locate dynamic library:\n %s\n",path); 162e5c89e4eSSatish Balay /* Eventually config/configure.py should determine if the system needs an executable dynamic library */ 163e5c89e4eSSatish Balay #define PETSC_USE_NONEXECUTABLE_SO 164e5c89e4eSSatish Balay #if !defined(PETSC_USE_NONEXECUTABLE_SO) 165e5c89e4eSSatish Balay ierr = PetscTestFile(par2,'x',&foundlibrary);CHKERRQ(ierr); 166b3bb0f5eSLisandro Dalcin if (!foundlibrary) SETERRQ2(PETSC_ERR_FILE_OPEN,"Dynamic library is not executable:\n %s\n %s\n",path,par2); 167e5c89e4eSSatish Balay #endif 168e5c89e4eSSatish Balay 169b3bb0f5eSLisandro Dalcin /* copy path and remove suffix from libname */ 170b3bb0f5eSLisandro Dalcin ierr = PetscStrncpy(libname,path,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 171b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy(suffix,".");CHKERRQ(ierr); 172b3bb0f5eSLisandro Dalcin ierr = PetscStrcat(suffix,PETSC_SLSUFFIX);CHKERRQ(ierr); 173b3bb0f5eSLisandro Dalcin ierr = PetscStrrstr(libname,suffix,&s);CHKERRQ(ierr); 174b3bb0f5eSLisandro Dalcin if (s) s[0] = 0; 175b3bb0f5eSLisandro Dalcin 1765673baf8SLisandro Dalcin /* open the dynamic library */ 177b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Opening dynamic library %s\n",libname);CHKERRQ(ierr); 178b3bb0f5eSLisandro Dalcin ierr = PetscDLOpen(par2,PETSC_DL_DECIDE,&handle);CHKERRQ(ierr); 179b3bb0f5eSLisandro Dalcin 180b3bb0f5eSLisandro Dalcin /* look for [path/]libXXXXX.YYY and extract out the XXXXXX */ 181b3bb0f5eSLisandro Dalcin ierr = PetscStrrchr(libname,'/',&basename);CHKERRQ(ierr); /* XXX Windows ??? */ 182b3bb0f5eSLisandro Dalcin if (!basename) basename = libname; 183b3bb0f5eSLisandro Dalcin ierr = PetscStrncmp(basename,"lib",3,&match);CHKERRQ(ierr); 184b3bb0f5eSLisandro Dalcin if (match) { 185b3bb0f5eSLisandro Dalcin basename = basename + 3; 186b3bb0f5eSLisandro Dalcin } else { 187b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Dynamic library %s do not have lib prefix\n",libname);CHKERRQ(ierr); 188e5c89e4eSSatish Balay } 189b3bb0f5eSLisandro Dalcin ierr = PetscStrlen(basename,&len);CHKERRQ(ierr); 190b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy(registername,"PetscDLLibraryRegister_");CHKERRQ(ierr); 191b3bb0f5eSLisandro Dalcin ierr = PetscStrncat(registername,basename,len);CHKERRQ(ierr); 192b3bb0f5eSLisandro Dalcin ierr = PetscDLSym(handle,registername,(void**)&func);CHKERRQ(ierr); 193b3bb0f5eSLisandro Dalcin if (func) { 1945673baf8SLisandro Dalcin ierr = PetscInfo1(0,"Loading registered routines from %s\n",libname);CHKERRQ(ierr); 1955673baf8SLisandro Dalcin ierr = (*func)(libname);CHKERRQ(ierr); 196b3bb0f5eSLisandro Dalcin } else { 197b3bb0f5eSLisandro Dalcin ierr = PetscInfo2(0,"Dynamic library %s do not have symbol %s\n",libname,registername);CHKERRQ(ierr); 198b3bb0f5eSLisandro Dalcin } 1995673baf8SLisandro Dalcin 2005673baf8SLisandro Dalcin ierr = PetscNew(struct _n_PetscDLLibrary,entry);CHKERRQ(ierr); 2015673baf8SLisandro Dalcin (*entry)->next = 0; 202b3bb0f5eSLisandro Dalcin (*entry)->handle = handle; 203b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy((*entry)->libname,libname);CHKERRQ(ierr); 2045673baf8SLisandro Dalcin 205e5c89e4eSSatish Balay PetscFunctionReturn(0); 206e5c89e4eSSatish Balay } 207e5c89e4eSSatish Balay 208e5c89e4eSSatish Balay #undef __FUNCT__ 209e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibrarySym" 210e5c89e4eSSatish Balay /*@C 211e5c89e4eSSatish Balay PetscDLLibrarySym - Load a symbol from the dynamic link libraries. 212e5c89e4eSSatish Balay 213e5c89e4eSSatish Balay Collective on MPI_Comm 214e5c89e4eSSatish Balay 215e5c89e4eSSatish Balay Input Parameter: 216e5bd5246SBarry Smith + comm - communicator that will open the library 217e5bd5246SBarry Smith . inlist - list of already open libraries that may contain symbol (checks here before path) 218e5bd5246SBarry Smith . path - optional complete library name 219e5c89e4eSSatish Balay - insymbol - name of symbol 220e5c89e4eSSatish Balay 221e5c89e4eSSatish Balay Output Parameter: 222e5c89e4eSSatish Balay . value 223e5c89e4eSSatish Balay 224e5c89e4eSSatish Balay Level: developer 225e5c89e4eSSatish Balay 226e5c89e4eSSatish Balay Notes: Symbol can be of the form 227e5c89e4eSSatish Balay [/path/libname[.so.1.0]:]functionname[()] where items in [] denote optional 228e5c89e4eSSatish Balay 229e5c89e4eSSatish Balay Will attempt to (retrieve and) open the library if it is not yet been opened. 230e5c89e4eSSatish Balay 231e5c89e4eSSatish Balay @*/ 232b3bb0f5eSLisandro Dalcin PetscErrorCode PETSC_DLLEXPORT PetscDLLibrarySym(MPI_Comm comm,PetscDLLibrary *outlist,const char path[],const char insymbol[],void **value) 233e5c89e4eSSatish Balay { 234b3bb0f5eSLisandro Dalcin char libname[PETSC_MAX_PATH_LEN],suffix[16],*symbol,*s; 235e5c89e4eSSatish Balay size_t len; 236e5bd5246SBarry Smith PetscDLLibrary nlist,prev,list; 237b3bb0f5eSLisandro Dalcin PetscErrorCode ierr; 238e5c89e4eSSatish Balay 239e5c89e4eSSatish Balay PetscFunctionBegin; 240b3bb0f5eSLisandro Dalcin PetscValidPointer(outlist,2); 2415673baf8SLisandro Dalcin if (path) PetscValidCharPointer(path,3); 2425673baf8SLisandro Dalcin PetscValidCharPointer(insymbol,4); 2435673baf8SLisandro Dalcin PetscValidPointer(value,5); 2445673baf8SLisandro Dalcin 245b3bb0f5eSLisandro Dalcin list = *outlist; 246e5c89e4eSSatish Balay *value = 0; 247e5c89e4eSSatish Balay 248e5c89e4eSSatish Balay /* make copy of symbol so we can edit it in place */ 249e5c89e4eSSatish Balay ierr = PetscStrlen(insymbol,&len);CHKERRQ(ierr); 250e5c89e4eSSatish Balay ierr = PetscMalloc((len+1)*sizeof(char),&symbol);CHKERRQ(ierr); 251e5c89e4eSSatish Balay ierr = PetscStrcpy(symbol,insymbol);CHKERRQ(ierr); 252b3bb0f5eSLisandro Dalcin /* If symbol contains () then replace with a NULL, to support functionname() */ 253b3bb0f5eSLisandro Dalcin ierr = PetscStrchr(symbol,'(',&s);CHKERRQ(ierr); 254b3bb0f5eSLisandro Dalcin if (s) s[0] = 0; 255e5c89e4eSSatish Balay 256e5c89e4eSSatish Balay /* 257e5c89e4eSSatish Balay Function name does include library 258e5c89e4eSSatish Balay ------------------------------------- 259e5c89e4eSSatish Balay */ 260e5c89e4eSSatish Balay if (path && path[0] != '\0') { 261b3bb0f5eSLisandro Dalcin /* copy path and remove suffix from libname */ 262b3bb0f5eSLisandro Dalcin ierr = PetscStrncpy(libname,path,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 263b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy(suffix,".");CHKERRQ(ierr); 264b3bb0f5eSLisandro Dalcin ierr = PetscStrcat(suffix,PETSC_SLSUFFIX);CHKERRQ(ierr); 265b3bb0f5eSLisandro Dalcin ierr = PetscStrrstr(libname,suffix,&s);CHKERRQ(ierr); 266b3bb0f5eSLisandro Dalcin if (s) s[0] = 0; 2675673baf8SLisandro Dalcin /* Look if library is already opened and in path */ 268e5c89e4eSSatish Balay prev = 0; 269b3bb0f5eSLisandro Dalcin nlist = list; 270e5c89e4eSSatish Balay while (nlist) { 271e5c89e4eSSatish Balay PetscTruth match; 272b3bb0f5eSLisandro Dalcin ierr = PetscStrcmp(nlist->libname,libname,&match);CHKERRQ(ierr); 2735673baf8SLisandro Dalcin if (match) goto done; 274e5c89e4eSSatish Balay prev = nlist; 275e5c89e4eSSatish Balay nlist = nlist->next; 276e5c89e4eSSatish Balay } 277b3bb0f5eSLisandro Dalcin /* open the library and append it to path */ 2785673baf8SLisandro Dalcin ierr = PetscDLLibraryOpen(comm,path,&nlist);CHKERRQ(ierr); 279ae15b995SBarry Smith ierr = PetscInfo1(0,"Appending %s to dynamic library search path\n",path);CHKERRQ(ierr); 2805673baf8SLisandro Dalcin if (prev) { prev->next = nlist; } 281b3bb0f5eSLisandro Dalcin else { *outlist = nlist; } 282e5c89e4eSSatish Balay 283e5c89e4eSSatish Balay done:; 2845673baf8SLisandro Dalcin ierr = PetscDLSym(nlist->handle,symbol,value);CHKERRQ(ierr); 285e5c89e4eSSatish Balay if (!*value) { 286e5c89e4eSSatish Balay SETERRQ2(PETSC_ERR_PLIB,"Unable to locate function %s in dynamic library %s",insymbol,path); 287e5c89e4eSSatish Balay } 288ae15b995SBarry Smith ierr = PetscInfo2(0,"Loading function %s from dynamic library %s\n",insymbol,path);CHKERRQ(ierr); 289e5c89e4eSSatish Balay 290e5c89e4eSSatish Balay /* 291e5c89e4eSSatish Balay Function name does not include library so search path 292e5c89e4eSSatish Balay ----------------------------------------------------- 293e5c89e4eSSatish Balay */ 294e5c89e4eSSatish Balay } else { 295e5c89e4eSSatish Balay while (list) { 296ebd79076SLisandro Dalcin ierr = PetscDLSym(list->handle,symbol,value);CHKERRQ(ierr); 297e5c89e4eSSatish Balay if (*value) { 298b3bb0f5eSLisandro Dalcin ierr = PetscInfo2(0,"Loading symbol %s from dynamic library %s\n",symbol,list->libname);CHKERRQ(ierr); 299e5c89e4eSSatish Balay break; 300e5c89e4eSSatish Balay } 301e5c89e4eSSatish Balay list = list->next; 302e5c89e4eSSatish Balay } 303e5c89e4eSSatish Balay if (!*value) { 304ebd79076SLisandro Dalcin ierr = PetscDLSym(PETSC_NULL,symbol,value);CHKERRQ(ierr); 305e5c89e4eSSatish Balay if (*value) { 306b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Loading symbol %s from object code\n",symbol);CHKERRQ(ierr); 307e5c89e4eSSatish Balay } 308e5c89e4eSSatish Balay } 309e5c89e4eSSatish Balay } 310e5c89e4eSSatish Balay 311e5c89e4eSSatish Balay ierr = PetscFree(symbol);CHKERRQ(ierr); 312e5c89e4eSSatish Balay PetscFunctionReturn(0); 313e5c89e4eSSatish Balay } 314e5c89e4eSSatish Balay 315e5c89e4eSSatish Balay #undef __FUNCT__ 316e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryAppend" 317e5c89e4eSSatish Balay /*@C 318e5c89e4eSSatish Balay PetscDLLibraryAppend - Appends another dynamic link library to the seach list, to the end 319e5c89e4eSSatish Balay of the search path. 320e5c89e4eSSatish Balay 321e5c89e4eSSatish Balay Collective on MPI_Comm 322e5c89e4eSSatish Balay 323e5c89e4eSSatish Balay Input Parameters: 324e5c89e4eSSatish Balay + comm - MPI communicator 325e5c89e4eSSatish Balay - libname - name of the library 326e5c89e4eSSatish Balay 327e5c89e4eSSatish Balay Output Parameter: 328e5c89e4eSSatish Balay . outlist - list of libraries 329e5c89e4eSSatish Balay 330e5c89e4eSSatish Balay Level: developer 331e5c89e4eSSatish Balay 332e5c89e4eSSatish Balay Notes: if library is already in path will not add it. 333e5c89e4eSSatish Balay @*/ 334b3bb0f5eSLisandro Dalcin PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryAppend(MPI_Comm comm,PetscDLLibrary *outlist,const char path[]) 335e5c89e4eSSatish Balay { 336e5bd5246SBarry Smith PetscDLLibrary list,prev; 337e5c89e4eSSatish Balay PetscErrorCode ierr; 338e5c89e4eSSatish Balay size_t len; 339e5c89e4eSSatish Balay PetscTruth match,dir; 340b3bb0f5eSLisandro Dalcin char program[PETSC_MAX_PATH_LEN],found[8*PETSC_MAX_PATH_LEN]; 341b3bb0f5eSLisandro Dalcin char *libname,suffix[16],*s; 3429c9d3cfdSBarry Smith PetscToken token; 343e5c89e4eSSatish Balay 344e5c89e4eSSatish Balay PetscFunctionBegin; 345b3bb0f5eSLisandro Dalcin PetscValidPointer(outlist,2); 346e5c89e4eSSatish Balay 347b3bb0f5eSLisandro Dalcin /* is path a directory? */ 348b3bb0f5eSLisandro Dalcin ierr = PetscTestDirectory(path,'r',&dir);CHKERRQ(ierr); 349e5c89e4eSSatish Balay if (dir) { 350b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Checking directory %s for dynamic libraries\n",path);CHKERRQ(ierr); 351b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy(program,path);CHKERRQ(ierr); 352e5c89e4eSSatish Balay ierr = PetscStrlen(program,&len);CHKERRQ(ierr); 353e5c89e4eSSatish Balay if (program[len-1] == '/') { 354e5c89e4eSSatish Balay ierr = PetscStrcat(program,"*.");CHKERRQ(ierr); 355e5c89e4eSSatish Balay } else { 356e5c89e4eSSatish Balay ierr = PetscStrcat(program,"/*.");CHKERRQ(ierr); 357e5c89e4eSSatish Balay } 358e5c89e4eSSatish Balay ierr = PetscStrcat(program,PETSC_SLSUFFIX);CHKERRQ(ierr); 359e5c89e4eSSatish Balay 360b3bb0f5eSLisandro Dalcin ierr = PetscLs(comm,program,found,8*PETSC_MAX_PATH_LEN,&dir);CHKERRQ(ierr); 361e5c89e4eSSatish Balay if (!dir) PetscFunctionReturn(0); 362e5c89e4eSSatish Balay } else { 363b3bb0f5eSLisandro Dalcin ierr = PetscStrncpy(found,path,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 364e5c89e4eSSatish Balay } 365e5c89e4eSSatish Balay ierr = PetscStrcpy(suffix,".");CHKERRQ(ierr); 366e5c89e4eSSatish Balay ierr = PetscStrcat(suffix,PETSC_SLSUFFIX);CHKERRQ(ierr); 367e5c89e4eSSatish Balay 368e5c89e4eSSatish Balay ierr = PetscTokenCreate(found,'\n',&token);CHKERRQ(ierr); 369b3bb0f5eSLisandro Dalcin ierr = PetscTokenFind(token,&libname);CHKERRQ(ierr); 370b3bb0f5eSLisandro Dalcin while (libname) { 371b3bb0f5eSLisandro Dalcin /* remove suffix from libname */ 372b3bb0f5eSLisandro Dalcin ierr = PetscStrrstr(libname,suffix,&s);CHKERRQ(ierr); 373e5c89e4eSSatish Balay if (s) s[0] = 0; 374e5c89e4eSSatish Balay /* see if library was already open then we are done */ 375e5c89e4eSSatish Balay list = prev = *outlist; 376e5c89e4eSSatish Balay match = PETSC_FALSE; 377e5c89e4eSSatish Balay while (list) { 378b3bb0f5eSLisandro Dalcin ierr = PetscStrcmp(list->libname,libname,&match);CHKERRQ(ierr); 379e5c89e4eSSatish Balay if (match) break; 380e5c89e4eSSatish Balay prev = list; 381e5c89e4eSSatish Balay list = list->next; 382e5c89e4eSSatish Balay } 383b3bb0f5eSLisandro Dalcin /* restore suffix from libname */ 384b3bb0f5eSLisandro Dalcin if (s) s[0] = '.'; 385e5c89e4eSSatish Balay if (!match) { 3865673baf8SLisandro Dalcin /* open the library and add to end of list */ 387b3bb0f5eSLisandro Dalcin ierr = PetscDLLibraryOpen(comm,libname,&list);CHKERRQ(ierr); 388b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Appending %s to dynamic library search path\n",libname);CHKERRQ(ierr); 389e5c89e4eSSatish Balay if (!*outlist) { 390e5c89e4eSSatish Balay *outlist = list; 391e5c89e4eSSatish Balay } else { 392e5c89e4eSSatish Balay prev->next = list; 393e5c89e4eSSatish Balay } 394e5c89e4eSSatish Balay } 395b3bb0f5eSLisandro Dalcin ierr = PetscTokenFind(token,&libname);CHKERRQ(ierr); 396e5c89e4eSSatish Balay } 397e5c89e4eSSatish Balay ierr = PetscTokenDestroy(token);CHKERRQ(ierr); 398e5c89e4eSSatish Balay PetscFunctionReturn(0); 399e5c89e4eSSatish Balay } 400e5c89e4eSSatish Balay 401e5c89e4eSSatish Balay #undef __FUNCT__ 402e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryPrepend" 403e5c89e4eSSatish Balay /*@C 404e5c89e4eSSatish Balay PetscDLLibraryPrepend - Add another dynamic library to search for symbols to the beginning of 405e5c89e4eSSatish Balay the search path. 406e5c89e4eSSatish Balay 407e5c89e4eSSatish Balay Collective on MPI_Comm 408e5c89e4eSSatish Balay 409e5c89e4eSSatish Balay Input Parameters: 410e5c89e4eSSatish Balay + comm - MPI communicator 411e5c89e4eSSatish Balay - libname - name of the library 412e5c89e4eSSatish Balay 413e5c89e4eSSatish Balay Output Parameter: 414e5c89e4eSSatish Balay . outlist - list of libraries 415e5c89e4eSSatish Balay 416e5c89e4eSSatish Balay Level: developer 417e5c89e4eSSatish Balay 418e5c89e4eSSatish Balay Notes: If library is already in path will remove old reference. 419e5c89e4eSSatish Balay 420e5c89e4eSSatish Balay @*/ 421b3bb0f5eSLisandro Dalcin PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryPrepend(MPI_Comm comm,PetscDLLibrary *outlist,const char path[]) 422e5c89e4eSSatish Balay { 423e5bd5246SBarry Smith PetscDLLibrary list,prev; 424e5c89e4eSSatish Balay PetscErrorCode ierr; 425e5c89e4eSSatish Balay size_t len; 426e5c89e4eSSatish Balay PetscTruth match,dir; 427b3bb0f5eSLisandro Dalcin char program[PETSC_MAX_PATH_LEN],found[8*PETSC_MAX_PATH_LEN]; 428b3bb0f5eSLisandro Dalcin char *libname,suffix[16],*s; 4295b096c79SMatthew Knepley PetscToken token; 430e5c89e4eSSatish Balay 431e5c89e4eSSatish Balay PetscFunctionBegin; 432b3bb0f5eSLisandro Dalcin PetscValidPointer(outlist,2); 433e5c89e4eSSatish Balay 434b3bb0f5eSLisandro Dalcin /* is path a directory? */ 435b3bb0f5eSLisandro Dalcin ierr = PetscTestDirectory(path,'r',&dir);CHKERRQ(ierr); 436e5c89e4eSSatish Balay if (dir) { 437b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Checking directory %s for dynamic libraries\n",path);CHKERRQ(ierr); 438b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy(program,path);CHKERRQ(ierr); 439e5c89e4eSSatish Balay ierr = PetscStrlen(program,&len);CHKERRQ(ierr); 440e5c89e4eSSatish Balay if (program[len-1] == '/') { 441e5c89e4eSSatish Balay ierr = PetscStrcat(program,"*.");CHKERRQ(ierr); 442e5c89e4eSSatish Balay } else { 443e5c89e4eSSatish Balay ierr = PetscStrcat(program,"/*.");CHKERRQ(ierr); 444e5c89e4eSSatish Balay } 445e5c89e4eSSatish Balay ierr = PetscStrcat(program,PETSC_SLSUFFIX);CHKERRQ(ierr); 446e5c89e4eSSatish Balay 447b3bb0f5eSLisandro Dalcin ierr = PetscLs(comm,program,found,8*PETSC_MAX_PATH_LEN,&dir);CHKERRQ(ierr); 448e5c89e4eSSatish Balay if (!dir) PetscFunctionReturn(0); 449e5c89e4eSSatish Balay } else { 450b3bb0f5eSLisandro Dalcin ierr = PetscStrncpy(found,path,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 451e5c89e4eSSatish Balay } 452e5c89e4eSSatish Balay 453e5c89e4eSSatish Balay ierr = PetscStrcpy(suffix,".");CHKERRQ(ierr); 454e5c89e4eSSatish Balay ierr = PetscStrcat(suffix,PETSC_SLSUFFIX);CHKERRQ(ierr); 455e5c89e4eSSatish Balay 456e5c89e4eSSatish Balay ierr = PetscTokenCreate(found,'\n',&token);CHKERRQ(ierr); 457b3bb0f5eSLisandro Dalcin ierr = PetscTokenFind(token,&libname);CHKERRQ(ierr); 458b3bb0f5eSLisandro Dalcin while (libname) { 459b3bb0f5eSLisandro Dalcin /* remove suffix from libname */ 460b3bb0f5eSLisandro Dalcin ierr = PetscStrstr(libname,suffix,&s);CHKERRQ(ierr); 461e5c89e4eSSatish Balay if (s) s[0] = 0; 462e5c89e4eSSatish Balay /* see if library was already open and move it to the front */ 463e5c89e4eSSatish Balay prev = 0; 464b3bb0f5eSLisandro Dalcin list = *outlist; 465e5c89e4eSSatish Balay match = PETSC_FALSE; 466e5c89e4eSSatish Balay while (list) { 467b3bb0f5eSLisandro Dalcin ierr = PetscStrcmp(list->libname,libname,&match);CHKERRQ(ierr); 468e5c89e4eSSatish Balay if (match) { 469b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Moving %s to begin of dynamic library search path\n",libname);CHKERRQ(ierr); 470e5c89e4eSSatish Balay if (prev) prev->next = list->next; 471b3bb0f5eSLisandro Dalcin if (prev) list->next = *outlist; 472e5c89e4eSSatish Balay *outlist = list; 473e5c89e4eSSatish Balay break; 474e5c89e4eSSatish Balay } 475e5c89e4eSSatish Balay prev = list; 476e5c89e4eSSatish Balay list = list->next; 477e5c89e4eSSatish Balay } 478b3bb0f5eSLisandro Dalcin /* restore suffix from libname */ 479b3bb0f5eSLisandro Dalcin if (s) s[0] = '.'; 480e5c89e4eSSatish Balay if (!match) { 4815673baf8SLisandro Dalcin /* open the library and add to front of list */ 482b3bb0f5eSLisandro Dalcin ierr = PetscDLLibraryOpen(comm,libname,&list);CHKERRQ(ierr); 483b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Prepending %s to dynamic library search path\n",libname);CHKERRQ(ierr); 484ebd79076SLisandro Dalcin list->next = *outlist; 485e5c89e4eSSatish Balay *outlist = list; 486e5c89e4eSSatish Balay } 487b3bb0f5eSLisandro Dalcin ierr = PetscTokenFind(token,&libname);CHKERRQ(ierr); 488e5c89e4eSSatish Balay } 489e5c89e4eSSatish Balay ierr = PetscTokenDestroy(token);CHKERRQ(ierr); 490e5c89e4eSSatish Balay PetscFunctionReturn(0); 491e5c89e4eSSatish Balay } 492e5c89e4eSSatish Balay 493e5c89e4eSSatish Balay #undef __FUNCT__ 494e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryClose" 495e5c89e4eSSatish Balay /*@C 496e5c89e4eSSatish Balay PetscDLLibraryClose - Destroys the search path of dynamic libraries and closes the libraries. 497e5c89e4eSSatish Balay 498e5c89e4eSSatish Balay Collective on PetscDLLibrary 499e5c89e4eSSatish Balay 500e5c89e4eSSatish Balay Input Parameter: 501e5c89e4eSSatish Balay . next - library list 502e5c89e4eSSatish Balay 503e5c89e4eSSatish Balay Level: developer 504e5c89e4eSSatish Balay 505e5c89e4eSSatish Balay @*/ 506e5bd5246SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryClose(PetscDLLibrary next) 507e5c89e4eSSatish Balay { 508e5bd5246SBarry Smith PetscDLLibrary prev; 509e5c89e4eSSatish Balay PetscErrorCode ierr; 510e5c89e4eSSatish Balay 511e5c89e4eSSatish Balay PetscFunctionBegin; 512e5c89e4eSSatish Balay while (next) { 513e5c89e4eSSatish Balay prev = next; 514e5c89e4eSSatish Balay next = next->next; 515ebd79076SLisandro Dalcin /* close the dynamic library */ 516ebd79076SLisandro Dalcin ierr = PetscDLClose(&prev->handle);CHKERRQ(ierr); 517e5c89e4eSSatish Balay /* free the space in the prev data-structure */ 518e5c89e4eSSatish Balay ierr = PetscFree(prev);CHKERRQ(ierr); 519e5c89e4eSSatish Balay } 520e5c89e4eSSatish Balay PetscFunctionReturn(0); 521e5c89e4eSSatish Balay } 522e5c89e4eSSatish Balay 523e5c89e4eSSatish Balay #undef __FUNCT__ 524e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryCCAAppend" 525e5c89e4eSSatish Balay /*@C 526e5c89e4eSSatish Balay PetscDLLibraryCCAAppend - Appends another CCA dynamic link library to the seach list, to the end 527e5c89e4eSSatish Balay of the search path. 528e5c89e4eSSatish Balay 529e5c89e4eSSatish Balay Collective on MPI_Comm 530e5c89e4eSSatish Balay 531e5c89e4eSSatish Balay Input Parameters: 532e5c89e4eSSatish Balay + comm - MPI communicator 533e5c89e4eSSatish Balay - libname - name of directory to check 534e5c89e4eSSatish Balay 535e5c89e4eSSatish Balay Output Parameter: 536e5c89e4eSSatish Balay . outlist - list of libraries 537e5c89e4eSSatish Balay 538e5c89e4eSSatish Balay Level: developer 539e5c89e4eSSatish Balay 540e5c89e4eSSatish Balay Notes: if library is already in path will not add it. 541e5c89e4eSSatish Balay @*/ 542e5bd5246SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryCCAAppend(MPI_Comm comm,PetscDLLibrary *outlist,const char dirname[]) 543e5c89e4eSSatish Balay { 544e5c89e4eSSatish Balay PetscErrorCode ierr; 545e5c89e4eSSatish Balay size_t l; 546e5c89e4eSSatish Balay PetscTruth dir; 547e5c89e4eSSatish Balay char program[PETSC_MAX_PATH_LEN],buf[8*PETSC_MAX_PATH_LEN],*libname1,fbuf[PETSC_MAX_PATH_LEN],*found,suffix[16],*f2; 548e5c89e4eSSatish Balay char *func,*funcname,libname[PETSC_MAX_PATH_LEN],*lib; 549e5c89e4eSSatish Balay FILE *fp; 5505b096c79SMatthew Knepley PetscToken token1, token2; 551ed9cf6e9SBarry Smith int err; 552e5c89e4eSSatish Balay 553e5c89e4eSSatish Balay PetscFunctionBegin; 554e5c89e4eSSatish Balay /* is dirname a directory? */ 555e5c89e4eSSatish Balay ierr = PetscTestDirectory(dirname,'r',&dir);CHKERRQ(ierr); 556e5c89e4eSSatish Balay if (!dir) PetscFunctionReturn(0); 557e5c89e4eSSatish Balay 558ae15b995SBarry Smith ierr = PetscInfo1(0,"Checking directory %s for CCA components\n",dirname);CHKERRQ(ierr); 559e5c89e4eSSatish Balay ierr = PetscStrcpy(program,dirname);CHKERRQ(ierr); 560e5c89e4eSSatish Balay ierr = PetscStrcat(program,"/*.cca");CHKERRQ(ierr); 561e5c89e4eSSatish Balay 562e5c89e4eSSatish Balay ierr = PetscLs(comm,program,buf,8*PETSC_MAX_PATH_LEN,&dir);CHKERRQ(ierr); 563e5c89e4eSSatish Balay if (!dir) PetscFunctionReturn(0); 564e5c89e4eSSatish Balay 565e5c89e4eSSatish Balay ierr = PetscStrcpy(suffix,".");CHKERRQ(ierr); 566e5c89e4eSSatish Balay ierr = PetscStrcat(suffix,PETSC_SLSUFFIX);CHKERRQ(ierr); 567e5c89e4eSSatish Balay ierr = PetscTokenCreate(buf,'\n',&token1);CHKERRQ(ierr); 568e5c89e4eSSatish Balay ierr = PetscTokenFind(token1,&libname1);CHKERRQ(ierr); 569e5c89e4eSSatish Balay while (libname1) { 570e5c89e4eSSatish Balay fp = fopen(libname1,"r"); if (!fp) continue; 571e5c89e4eSSatish Balay while ((found = fgets(fbuf,PETSC_MAX_PATH_LEN,fp))) { 572e5c89e4eSSatish Balay if (found[0] == '!') continue; 573e5c89e4eSSatish Balay ierr = PetscStrstr(found,suffix,&f2);CHKERRQ(ierr); 574e5c89e4eSSatish Balay if (f2) { /* found library name */ 575e5c89e4eSSatish Balay if (found[0] == '/') { 576e5c89e4eSSatish Balay lib = found; 577e5c89e4eSSatish Balay } else { 578e5c89e4eSSatish Balay ierr = PetscStrcpy(libname,dirname);CHKERRQ(ierr); 579e5c89e4eSSatish Balay ierr = PetscStrlen(libname,&l);CHKERRQ(ierr); 580e5c89e4eSSatish Balay if (libname[l-1] != '/') {ierr = PetscStrcat(libname,"/");CHKERRQ(ierr);} 581e5c89e4eSSatish Balay ierr = PetscStrcat(libname,found);CHKERRQ(ierr); 582e5c89e4eSSatish Balay lib = libname; 583e5c89e4eSSatish Balay } 584e5c89e4eSSatish Balay ierr = PetscDLLibraryAppend(comm,outlist,lib);CHKERRQ(ierr); 585e5c89e4eSSatish Balay } else { 586ae15b995SBarry Smith ierr = PetscInfo2(0,"CCA Component function and name: %s from %s\n",found,libname1);CHKERRQ(ierr); 587e5c89e4eSSatish Balay ierr = PetscTokenCreate(found,' ',&token2);CHKERRQ(ierr); 588e5c89e4eSSatish Balay ierr = PetscTokenFind(token2,&func);CHKERRQ(ierr); 589e5c89e4eSSatish Balay ierr = PetscTokenFind(token2,&funcname);CHKERRQ(ierr); 590e5c89e4eSSatish Balay ierr = PetscFListAdd(&CCAList,funcname,func,PETSC_NULL);CHKERRQ(ierr); 591e5c89e4eSSatish Balay ierr = PetscTokenDestroy(token2);CHKERRQ(ierr); 592e5c89e4eSSatish Balay } 593e5c89e4eSSatish Balay } 594ed9cf6e9SBarry Smith err = fclose(fp); 595ed9cf6e9SBarry Smith if (err) SETERRQ(PETSC_ERR_SYS,"fclose() failed on file"); 596e5c89e4eSSatish Balay ierr = PetscTokenFind(token1,&libname1);CHKERRQ(ierr); 597e5c89e4eSSatish Balay } 598e5c89e4eSSatish Balay ierr = PetscTokenDestroy(token1);CHKERRQ(ierr); 599e5c89e4eSSatish Balay PetscFunctionReturn(0); 600e5c89e4eSSatish Balay } 601