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 7d382aafbSBarry Smith #include "petscsys.h" 87c4f633dSBarry Smith #include "../src/sys/dll/dlimpl.h" 9e5c89e4eSSatish Balay 10e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/ 11e5c89e4eSSatish Balay /* 12e5c89e4eSSatish Balay Code to maintain a list of opened dynamic libraries and load symbols 13e5c89e4eSSatish Balay */ 14e5bd5246SBarry Smith struct _n_PetscDLLibrary { 15e5bd5246SBarry Smith PetscDLLibrary next; 16ebd79076SLisandro Dalcin PetscDLHandle handle; 17e5c89e4eSSatish Balay char libname[PETSC_MAX_PATH_LEN]; 18e5c89e4eSSatish Balay }; 19e5c89e4eSSatish Balay 20e5c89e4eSSatish Balay #undef __FUNCT__ 21e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryPrintPath" 228738c821SJed Brown PetscErrorCode PETSCSYS_DLLEXPORT PetscDLLibraryPrintPath(PetscDLLibrary libs) 23e5c89e4eSSatish Balay { 24e5c89e4eSSatish Balay PetscFunctionBegin; 25e5c89e4eSSatish Balay while (libs) { 26e5c89e4eSSatish Balay PetscErrorPrintf(" %s\n",libs->libname); 27e5c89e4eSSatish Balay libs = libs->next; 28e5c89e4eSSatish Balay } 29e5c89e4eSSatish Balay PetscFunctionReturn(0); 30e5c89e4eSSatish Balay } 31e5c89e4eSSatish Balay 32e5c89e4eSSatish Balay #undef __FUNCT__ 33e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryRetrieve" 34e5c89e4eSSatish Balay /*@C 35e5c89e4eSSatish Balay PetscDLLibraryRetrieve - Copies a PETSc dynamic library from a remote location 36e5c89e4eSSatish Balay (if it is remote), indicates if it exits and its local name. 37e5c89e4eSSatish Balay 38e5c89e4eSSatish Balay Collective on MPI_Comm 39e5c89e4eSSatish Balay 40e5c89e4eSSatish Balay Input Parameters: 41e5c89e4eSSatish Balay + comm - processors that are opening the library 42e5c89e4eSSatish Balay - libname - name of the library, can be relative or absolute 43e5c89e4eSSatish Balay 44e5c89e4eSSatish Balay Output Parameter: 45e5c89e4eSSatish Balay . handle - library handle 46e5c89e4eSSatish Balay 47e5c89e4eSSatish Balay Level: developer 48e5c89e4eSSatish Balay 49e5c89e4eSSatish Balay Notes: 50e5c89e4eSSatish Balay [[<http,ftp>://hostname]/directoryname/]filename[.so.1.0] 51e5c89e4eSSatish Balay 52e5c89e4eSSatish Balay ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, or ${any environmental variable} 53e5c89e4eSSatish Balay occuring in directoryname and filename will be replaced with appropriate values. 54e5c89e4eSSatish Balay @*/ 55ace3abfcSBarry Smith PetscErrorCode PETSCSYS_DLLEXPORT PetscDLLibraryRetrieve(MPI_Comm comm,const char libname[],char *lname,size_t llen,PetscBool *found) 56e5c89e4eSSatish Balay { 57d46cf212SLisandro Dalcin char *buf,*par2,suffix[16],*gz,*so; 58d46cf212SLisandro Dalcin size_t len; 59e5c89e4eSSatish Balay PetscErrorCode ierr; 60e5c89e4eSSatish Balay 61e5c89e4eSSatish Balay PetscFunctionBegin; 62e5c89e4eSSatish Balay /* 63a523d312SBarry Smith make copy of library name and replace $PETSC_ARCH etc 64e5c89e4eSSatish Balay so we can add to the end of it to look for something like .so.1.0 etc. 65e5c89e4eSSatish Balay */ 66e5c89e4eSSatish Balay ierr = PetscStrlen(libname,&len);CHKERRQ(ierr); 67e5c89e4eSSatish Balay len = PetscMax(4*len,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 68d46cf212SLisandro Dalcin ierr = PetscMalloc(len*sizeof(char),&buf);CHKERRQ(ierr); 69d46cf212SLisandro Dalcin par2 = buf; 70e5c89e4eSSatish Balay ierr = PetscStrreplace(comm,libname,par2,len);CHKERRQ(ierr); 71e5c89e4eSSatish Balay 72d46cf212SLisandro Dalcin /* temporarily remove .gz if it ends library name */ 73d46cf212SLisandro Dalcin ierr = PetscStrrstr(par2,".gz",&gz);CHKERRQ(ierr); 74e5c89e4eSSatish Balay if (gz) { 75e5c89e4eSSatish Balay ierr = PetscStrlen(gz,&len);CHKERRQ(ierr); 76d46cf212SLisandro Dalcin if (len != 3) gz = 0; /* do not end (exactly) with .gz */ 77d46cf212SLisandro Dalcin else *gz = 0; /* ends with .gz, so remove it */ 78e5c89e4eSSatish Balay } 793fa76a5bSLisandro Dalcin /* strip out .a from it if user put it in by mistake */ 803fa76a5bSLisandro Dalcin ierr = PetscStrlen(par2,&len);CHKERRQ(ierr); 813fa76a5bSLisandro Dalcin if (par2[len-1] == 'a' && par2[len-2] == '.') par2[len-2] = 0; 823fa76a5bSLisandro Dalcin 83e5c89e4eSSatish Balay 84e5c89e4eSSatish Balay /* see if library name does already not have suffix attached */ 85b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy(suffix,".");CHKERRQ(ierr); 86b3bb0f5eSLisandro Dalcin ierr = PetscStrcat(suffix,PETSC_SLSUFFIX);CHKERRQ(ierr); 87b3bb0f5eSLisandro Dalcin ierr = PetscStrrstr(par2,suffix,&so);CHKERRQ(ierr); 88d46cf212SLisandro Dalcin /* and attach the suffix if it is not there */ 89d46cf212SLisandro Dalcin if (!so) { ierr = PetscStrcat(par2,suffix);CHKERRQ(ierr); } 90e5c89e4eSSatish Balay 91d46cf212SLisandro Dalcin /* restore the .gz suffix if it was there */ 92d46cf212SLisandro Dalcin if (gz) { ierr = PetscStrcat(par2,".gz");CHKERRQ(ierr); } 93d46cf212SLisandro Dalcin 94d46cf212SLisandro Dalcin /* and finally retrieve the file */ 95e5c89e4eSSatish Balay ierr = PetscFileRetrieve(comm,par2,lname,llen,found);CHKERRQ(ierr); 96d46cf212SLisandro Dalcin 97d46cf212SLisandro Dalcin ierr = PetscFree(buf);CHKERRQ(ierr); 98e5c89e4eSSatish Balay PetscFunctionReturn(0); 99e5c89e4eSSatish Balay } 100e5c89e4eSSatish Balay 101e5c89e4eSSatish Balay 102e5c89e4eSSatish Balay #undef __FUNCT__ 103e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryOpen" 104e5c89e4eSSatish Balay /*@C 105ebd79076SLisandro Dalcin PetscDLLibraryOpen - Opens a PETSc dynamic link library 106e5c89e4eSSatish Balay 107e5c89e4eSSatish Balay Collective on MPI_Comm 108e5c89e4eSSatish Balay 109e5c89e4eSSatish Balay Input Parameters: 110e5c89e4eSSatish Balay + comm - processors that are opening the library 1110f31fb7fSLisandro Dalcin - path - name of the library, can be relative or absolute 112e5c89e4eSSatish Balay 113e5c89e4eSSatish Balay Output Parameter: 1140f31fb7fSLisandro Dalcin . entry - a PETSc dynamic link library entry 115e5c89e4eSSatish Balay 116e5c89e4eSSatish Balay Level: developer 117e5c89e4eSSatish Balay 118e5c89e4eSSatish Balay Notes: 119bb84e0fdSBarry Smith [[<http,ftp>://hostname]/directoryname/]libbasename[.so.1.0] 120bb84e0fdSBarry Smith 121bb84e0fdSBarry Smith If the library has the symbol PetscDLLibraryRegister_basename() in it then that function is automatically run 122bb84e0fdSBarry Smith when the library is opened. 123e5c89e4eSSatish Balay 124e5c89e4eSSatish Balay ${PETSC_ARCH} occuring in directoryname and filename 125e5c89e4eSSatish Balay will be replaced with the appropriate value. 126bb84e0fdSBarry Smith 127bb84e0fdSBarry Smith .seealso: PetscLoadDynamicLibrary(), PetscDLLibraryAppend() 128e5c89e4eSSatish Balay @*/ 1298738c821SJed Brown PetscErrorCode PETSCSYS_DLLEXPORT PetscDLLibraryOpen(MPI_Comm comm,const char path[],PetscDLLibrary *entry) 130e5c89e4eSSatish Balay { 131e5c89e4eSSatish Balay PetscErrorCode ierr; 132ace3abfcSBarry Smith PetscBool foundlibrary,match; 133b3bb0f5eSLisandro Dalcin char libname[PETSC_MAX_PATH_LEN],par2[PETSC_MAX_PATH_LEN],suffix[16],*s; 134b3bb0f5eSLisandro Dalcin char *basename,registername[128]; 1355673baf8SLisandro Dalcin PetscDLHandle handle; 136e5c89e4eSSatish Balay PetscErrorCode (*func)(const char*) = NULL; 137e5c89e4eSSatish Balay size_t len; 138e5c89e4eSSatish Balay 139e5c89e4eSSatish Balay PetscFunctionBegin; 14082a51d08SSatish Balay PetscValidCharPointer(path,2); 1415673baf8SLisandro Dalcin PetscValidPointer(entry,3); 142ebd79076SLisandro Dalcin 1435673baf8SLisandro Dalcin *entry = PETSC_NULL; 144e5c89e4eSSatish Balay 145b3bb0f5eSLisandro Dalcin /* retrieve the library */ 146b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Retrieving %s\n",path);CHKERRQ(ierr); 147b3bb0f5eSLisandro Dalcin ierr = PetscDLLibraryRetrieve(comm,path,par2,PETSC_MAX_PATH_LEN,&foundlibrary);CHKERRQ(ierr); 148e32f2f54SBarry Smith if (!foundlibrary) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate dynamic library:\n %s\n",path); 149e2e64c6bSBarry Smith /* Eventually ./configure should determine if the system needs an executable dynamic library */ 150e5c89e4eSSatish Balay #define PETSC_USE_NONEXECUTABLE_SO 151e5c89e4eSSatish Balay #if !defined(PETSC_USE_NONEXECUTABLE_SO) 152e5c89e4eSSatish Balay ierr = PetscTestFile(par2,'x',&foundlibrary);CHKERRQ(ierr); 153e32f2f54SBarry Smith if (!foundlibrary) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Dynamic library is not executable:\n %s\n %s\n",path,par2); 154e5c89e4eSSatish Balay #endif 155e5c89e4eSSatish Balay 1563fa76a5bSLisandro Dalcin /* copy path and setup shared library suffix */ 157b3bb0f5eSLisandro Dalcin ierr = PetscStrncpy(libname,path,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 158b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy(suffix,".");CHKERRQ(ierr); 159b3bb0f5eSLisandro Dalcin ierr = PetscStrcat(suffix,PETSC_SLSUFFIX);CHKERRQ(ierr); 1603fa76a5bSLisandro Dalcin /* remove wrong suffixes from libname */ 1613fa76a5bSLisandro Dalcin ierr = PetscStrrstr(libname,".gz",&s);CHKERRQ(ierr); 1623fa76a5bSLisandro Dalcin if (s && s[3] == 0) s[0] = 0; 1633fa76a5bSLisandro Dalcin ierr = PetscStrrstr(libname,".a",&s);CHKERRQ(ierr); 1643fa76a5bSLisandro Dalcin if (s && s[2] == 0) s[0] = 0; 1653fa76a5bSLisandro Dalcin /* remove shared suffix from libname */ 166b3bb0f5eSLisandro Dalcin ierr = PetscStrrstr(libname,suffix,&s);CHKERRQ(ierr); 167b3bb0f5eSLisandro Dalcin if (s) s[0] = 0; 168b3bb0f5eSLisandro Dalcin 1695673baf8SLisandro Dalcin /* open the dynamic library */ 170b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Opening dynamic library %s\n",libname);CHKERRQ(ierr); 171b3bb0f5eSLisandro Dalcin ierr = PetscDLOpen(par2,PETSC_DL_DECIDE,&handle);CHKERRQ(ierr); 172b3bb0f5eSLisandro Dalcin 173b3bb0f5eSLisandro Dalcin /* look for [path/]libXXXXX.YYY and extract out the XXXXXX */ 174b3bb0f5eSLisandro Dalcin ierr = PetscStrrchr(libname,'/',&basename);CHKERRQ(ierr); /* XXX Windows ??? */ 175b3bb0f5eSLisandro Dalcin if (!basename) basename = libname; 176b3bb0f5eSLisandro Dalcin ierr = PetscStrncmp(basename,"lib",3,&match);CHKERRQ(ierr); 177b3bb0f5eSLisandro Dalcin if (match) { 178b3bb0f5eSLisandro Dalcin basename = basename + 3; 179b3bb0f5eSLisandro Dalcin } else { 180bb84e0fdSBarry Smith ierr = PetscInfo1(0,"Dynamic library %s does not have lib prefix\n",libname);CHKERRQ(ierr); 181e5c89e4eSSatish Balay } 182b3bb0f5eSLisandro Dalcin ierr = PetscStrlen(basename,&len);CHKERRQ(ierr); 183b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy(registername,"PetscDLLibraryRegister_");CHKERRQ(ierr); 184b3bb0f5eSLisandro Dalcin ierr = PetscStrncat(registername,basename,len);CHKERRQ(ierr); 185b3bb0f5eSLisandro Dalcin ierr = PetscDLSym(handle,registername,(void**)&func);CHKERRQ(ierr); 186b3bb0f5eSLisandro Dalcin if (func) { 1875673baf8SLisandro Dalcin ierr = PetscInfo1(0,"Loading registered routines from %s\n",libname);CHKERRQ(ierr); 1885673baf8SLisandro Dalcin ierr = (*func)(libname);CHKERRQ(ierr); 189b3bb0f5eSLisandro Dalcin } else { 190bb84e0fdSBarry Smith ierr = PetscInfo2(0,"Dynamic library %s does not have symbol %s\n",libname,registername);CHKERRQ(ierr); 191b3bb0f5eSLisandro Dalcin } 1925673baf8SLisandro Dalcin 1935673baf8SLisandro Dalcin ierr = PetscNew(struct _n_PetscDLLibrary,entry);CHKERRQ(ierr); 1945673baf8SLisandro Dalcin (*entry)->next = 0; 195b3bb0f5eSLisandro Dalcin (*entry)->handle = handle; 196b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy((*entry)->libname,libname);CHKERRQ(ierr); 1975673baf8SLisandro Dalcin 198e5c89e4eSSatish Balay PetscFunctionReturn(0); 199e5c89e4eSSatish Balay } 200e5c89e4eSSatish Balay 201e5c89e4eSSatish Balay #undef __FUNCT__ 202e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibrarySym" 203e5c89e4eSSatish Balay /*@C 204e5c89e4eSSatish Balay PetscDLLibrarySym - Load a symbol from the dynamic link libraries. 205e5c89e4eSSatish Balay 206e5c89e4eSSatish Balay Collective on MPI_Comm 207e5c89e4eSSatish Balay 208e5c89e4eSSatish Balay Input Parameter: 209e5bd5246SBarry Smith + comm - communicator that will open the library 210*30a1dd1fSBarry Smith . outlist - list of already open libraries that may contain symbol 211*30a1dd1fSBarry Smith . path - optional complete library name (if provided checks here before checking outlist) 212e5c89e4eSSatish Balay - insymbol - name of symbol 213e5c89e4eSSatish Balay 214e5c89e4eSSatish Balay Output Parameter: 215*30a1dd1fSBarry Smith . value - if symbol not found then this value is set to PETSC_NULL 216e5c89e4eSSatish Balay 217e5c89e4eSSatish Balay Level: developer 218e5c89e4eSSatish Balay 219e5c89e4eSSatish Balay Notes: Symbol can be of the form 220e5c89e4eSSatish Balay [/path/libname[.so.1.0]:]functionname[()] where items in [] denote optional 221e5c89e4eSSatish Balay 222e5c89e4eSSatish Balay Will attempt to (retrieve and) open the library if it is not yet been opened. 223e5c89e4eSSatish Balay 224e5c89e4eSSatish Balay @*/ 2258738c821SJed Brown PetscErrorCode PETSCSYS_DLLEXPORT PetscDLLibrarySym(MPI_Comm comm,PetscDLLibrary *outlist,const char path[],const char insymbol[],void **value) 226e5c89e4eSSatish Balay { 227b3bb0f5eSLisandro Dalcin char libname[PETSC_MAX_PATH_LEN],suffix[16],*symbol,*s; 228e5c89e4eSSatish Balay size_t len; 229e5bd5246SBarry Smith PetscDLLibrary nlist,prev,list; 230b3bb0f5eSLisandro Dalcin PetscErrorCode ierr; 231e5c89e4eSSatish Balay 232e5c89e4eSSatish Balay PetscFunctionBegin; 233b3bb0f5eSLisandro Dalcin PetscValidPointer(outlist,2); 2345673baf8SLisandro Dalcin if (path) PetscValidCharPointer(path,3); 2355673baf8SLisandro Dalcin PetscValidCharPointer(insymbol,4); 2365673baf8SLisandro Dalcin PetscValidPointer(value,5); 2375673baf8SLisandro Dalcin 238b3bb0f5eSLisandro Dalcin list = *outlist; 239e5c89e4eSSatish Balay *value = 0; 240e5c89e4eSSatish Balay 241e5c89e4eSSatish Balay /* make copy of symbol so we can edit it in place */ 242e5c89e4eSSatish Balay ierr = PetscStrlen(insymbol,&len);CHKERRQ(ierr); 243e5c89e4eSSatish Balay ierr = PetscMalloc((len+1)*sizeof(char),&symbol);CHKERRQ(ierr); 244e5c89e4eSSatish Balay ierr = PetscStrcpy(symbol,insymbol);CHKERRQ(ierr); 245b3bb0f5eSLisandro Dalcin /* If symbol contains () then replace with a NULL, to support functionname() */ 246b3bb0f5eSLisandro Dalcin ierr = PetscStrchr(symbol,'(',&s);CHKERRQ(ierr); 247b3bb0f5eSLisandro Dalcin if (s) s[0] = 0; 248e5c89e4eSSatish Balay 249e5c89e4eSSatish Balay /* 250e5c89e4eSSatish Balay Function name does include library 251e5c89e4eSSatish Balay ------------------------------------- 252e5c89e4eSSatish Balay */ 253e5c89e4eSSatish Balay if (path && path[0] != '\0') { 254b3bb0f5eSLisandro Dalcin /* copy path and remove suffix from libname */ 255b3bb0f5eSLisandro Dalcin ierr = PetscStrncpy(libname,path,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 256b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy(suffix,".");CHKERRQ(ierr); 257b3bb0f5eSLisandro Dalcin ierr = PetscStrcat(suffix,PETSC_SLSUFFIX);CHKERRQ(ierr); 258b3bb0f5eSLisandro Dalcin ierr = PetscStrrstr(libname,suffix,&s);CHKERRQ(ierr); 259b3bb0f5eSLisandro Dalcin if (s) s[0] = 0; 2605673baf8SLisandro Dalcin /* Look if library is already opened and in path */ 261e5c89e4eSSatish Balay prev = 0; 262b3bb0f5eSLisandro Dalcin nlist = list; 263e5c89e4eSSatish Balay while (nlist) { 264ace3abfcSBarry Smith PetscBool match; 265b3bb0f5eSLisandro Dalcin ierr = PetscStrcmp(nlist->libname,libname,&match);CHKERRQ(ierr); 2665673baf8SLisandro Dalcin if (match) goto done; 267e5c89e4eSSatish Balay prev = nlist; 268e5c89e4eSSatish Balay nlist = nlist->next; 269e5c89e4eSSatish Balay } 270b3bb0f5eSLisandro Dalcin /* open the library and append it to path */ 2715673baf8SLisandro Dalcin ierr = PetscDLLibraryOpen(comm,path,&nlist);CHKERRQ(ierr); 272ae15b995SBarry Smith ierr = PetscInfo1(0,"Appending %s to dynamic library search path\n",path);CHKERRQ(ierr); 2735673baf8SLisandro Dalcin if (prev) { prev->next = nlist; } 274b3bb0f5eSLisandro Dalcin else { *outlist = nlist; } 275e5c89e4eSSatish Balay 276e5c89e4eSSatish Balay done:; 2775673baf8SLisandro Dalcin ierr = PetscDLSym(nlist->handle,symbol,value);CHKERRQ(ierr); 278*30a1dd1fSBarry Smith if (*value) { 279ae15b995SBarry Smith ierr = PetscInfo2(0,"Loading function %s from dynamic library %s\n",insymbol,path);CHKERRQ(ierr); 280*30a1dd1fSBarry Smith } 281e5c89e4eSSatish Balay 282e5c89e4eSSatish Balay /* 283e5c89e4eSSatish Balay Function name does not include library so search path 284e5c89e4eSSatish Balay ----------------------------------------------------- 285e5c89e4eSSatish Balay */ 286e5c89e4eSSatish Balay } else { 287e5c89e4eSSatish Balay while (list) { 288ebd79076SLisandro Dalcin ierr = PetscDLSym(list->handle,symbol,value);CHKERRQ(ierr); 289e5c89e4eSSatish Balay if (*value) { 290b3bb0f5eSLisandro Dalcin ierr = PetscInfo2(0,"Loading symbol %s from dynamic library %s\n",symbol,list->libname);CHKERRQ(ierr); 291e5c89e4eSSatish Balay break; 292e5c89e4eSSatish Balay } 293e5c89e4eSSatish Balay list = list->next; 294e5c89e4eSSatish Balay } 295e5c89e4eSSatish Balay if (!*value) { 296ebd79076SLisandro Dalcin ierr = PetscDLSym(PETSC_NULL,symbol,value);CHKERRQ(ierr); 297e5c89e4eSSatish Balay if (*value) { 298b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Loading symbol %s from object code\n",symbol);CHKERRQ(ierr); 299e5c89e4eSSatish Balay } 300e5c89e4eSSatish Balay } 301e5c89e4eSSatish Balay } 302e5c89e4eSSatish Balay 303e5c89e4eSSatish Balay ierr = PetscFree(symbol);CHKERRQ(ierr); 304e5c89e4eSSatish Balay PetscFunctionReturn(0); 305e5c89e4eSSatish Balay } 306e5c89e4eSSatish Balay 307e5c89e4eSSatish Balay #undef __FUNCT__ 308e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryAppend" 309e5c89e4eSSatish Balay /*@C 310e5c89e4eSSatish Balay PetscDLLibraryAppend - Appends another dynamic link library to the seach list, to the end 311e5c89e4eSSatish Balay of the search path. 312e5c89e4eSSatish Balay 313e5c89e4eSSatish Balay Collective on MPI_Comm 314e5c89e4eSSatish Balay 315e5c89e4eSSatish Balay Input Parameters: 316e5c89e4eSSatish Balay + comm - MPI communicator 3170f31fb7fSLisandro Dalcin - path - name of the library 318e5c89e4eSSatish Balay 319e5c89e4eSSatish Balay Output Parameter: 320e5c89e4eSSatish Balay . outlist - list of libraries 321e5c89e4eSSatish Balay 322e5c89e4eSSatish Balay Level: developer 323e5c89e4eSSatish Balay 324e5c89e4eSSatish Balay Notes: if library is already in path will not add it. 325bb84e0fdSBarry Smith 326bb84e0fdSBarry Smith If the library has the symbol PetscDLLibraryRegister_basename() in it then that function is automatically run 327bb84e0fdSBarry Smith when the library is opened. 328bb84e0fdSBarry Smith 329bb84e0fdSBarry Smith .seealso: PetscDLLibraryOpen() 330e5c89e4eSSatish Balay @*/ 3318738c821SJed Brown PetscErrorCode PETSCSYS_DLLEXPORT PetscDLLibraryAppend(MPI_Comm comm,PetscDLLibrary *outlist,const char path[]) 332e5c89e4eSSatish Balay { 333e5bd5246SBarry Smith PetscDLLibrary list,prev; 334e5c89e4eSSatish Balay PetscErrorCode ierr; 335e5c89e4eSSatish Balay size_t len; 336ace3abfcSBarry Smith PetscBool match,dir; 337b3bb0f5eSLisandro Dalcin char program[PETSC_MAX_PATH_LEN],found[8*PETSC_MAX_PATH_LEN]; 338b3bb0f5eSLisandro Dalcin char *libname,suffix[16],*s; 3399c9d3cfdSBarry Smith PetscToken token; 340e5c89e4eSSatish Balay 341e5c89e4eSSatish Balay PetscFunctionBegin; 342b3bb0f5eSLisandro Dalcin PetscValidPointer(outlist,2); 343e5c89e4eSSatish Balay 344b3bb0f5eSLisandro Dalcin /* is path a directory? */ 345b3bb0f5eSLisandro Dalcin ierr = PetscTestDirectory(path,'r',&dir);CHKERRQ(ierr); 346e5c89e4eSSatish Balay if (dir) { 347b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Checking directory %s for dynamic libraries\n",path);CHKERRQ(ierr); 348b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy(program,path);CHKERRQ(ierr); 349e5c89e4eSSatish Balay ierr = PetscStrlen(program,&len);CHKERRQ(ierr); 350e5c89e4eSSatish Balay if (program[len-1] == '/') { 351e5c89e4eSSatish Balay ierr = PetscStrcat(program,"*.");CHKERRQ(ierr); 352e5c89e4eSSatish Balay } else { 353e5c89e4eSSatish Balay ierr = PetscStrcat(program,"/*.");CHKERRQ(ierr); 354e5c89e4eSSatish Balay } 355e5c89e4eSSatish Balay ierr = PetscStrcat(program,PETSC_SLSUFFIX);CHKERRQ(ierr); 356e5c89e4eSSatish Balay 357b3bb0f5eSLisandro Dalcin ierr = PetscLs(comm,program,found,8*PETSC_MAX_PATH_LEN,&dir);CHKERRQ(ierr); 358e5c89e4eSSatish Balay if (!dir) PetscFunctionReturn(0); 359e5c89e4eSSatish Balay } else { 360b3bb0f5eSLisandro Dalcin ierr = PetscStrncpy(found,path,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 361e5c89e4eSSatish Balay } 362e5c89e4eSSatish Balay ierr = PetscStrcpy(suffix,".");CHKERRQ(ierr); 363e5c89e4eSSatish Balay ierr = PetscStrcat(suffix,PETSC_SLSUFFIX);CHKERRQ(ierr); 364e5c89e4eSSatish Balay 365e5c89e4eSSatish Balay ierr = PetscTokenCreate(found,'\n',&token);CHKERRQ(ierr); 366b3bb0f5eSLisandro Dalcin ierr = PetscTokenFind(token,&libname);CHKERRQ(ierr); 367b3bb0f5eSLisandro Dalcin while (libname) { 368b3bb0f5eSLisandro Dalcin /* remove suffix from libname */ 369b3bb0f5eSLisandro Dalcin ierr = PetscStrrstr(libname,suffix,&s);CHKERRQ(ierr); 370e5c89e4eSSatish Balay if (s) s[0] = 0; 371e5c89e4eSSatish Balay /* see if library was already open then we are done */ 372e5c89e4eSSatish Balay list = prev = *outlist; 373e5c89e4eSSatish Balay match = PETSC_FALSE; 374e5c89e4eSSatish Balay while (list) { 375b3bb0f5eSLisandro Dalcin ierr = PetscStrcmp(list->libname,libname,&match);CHKERRQ(ierr); 376e5c89e4eSSatish Balay if (match) break; 377e5c89e4eSSatish Balay prev = list; 378e5c89e4eSSatish Balay list = list->next; 379e5c89e4eSSatish Balay } 380b3bb0f5eSLisandro Dalcin /* restore suffix from libname */ 381b3bb0f5eSLisandro Dalcin if (s) s[0] = '.'; 382e5c89e4eSSatish Balay if (!match) { 3835673baf8SLisandro Dalcin /* open the library and add to end of list */ 384b3bb0f5eSLisandro Dalcin ierr = PetscDLLibraryOpen(comm,libname,&list);CHKERRQ(ierr); 385b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Appending %s to dynamic library search path\n",libname);CHKERRQ(ierr); 386e5c89e4eSSatish Balay if (!*outlist) { 387e5c89e4eSSatish Balay *outlist = list; 388e5c89e4eSSatish Balay } else { 389e5c89e4eSSatish Balay prev->next = list; 390e5c89e4eSSatish Balay } 391e5c89e4eSSatish Balay } 392b3bb0f5eSLisandro Dalcin ierr = PetscTokenFind(token,&libname);CHKERRQ(ierr); 393e5c89e4eSSatish Balay } 394e5c89e4eSSatish Balay ierr = PetscTokenDestroy(token);CHKERRQ(ierr); 395e5c89e4eSSatish Balay PetscFunctionReturn(0); 396e5c89e4eSSatish Balay } 397e5c89e4eSSatish Balay 398e5c89e4eSSatish Balay #undef __FUNCT__ 399e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryPrepend" 400e5c89e4eSSatish Balay /*@C 401e5c89e4eSSatish Balay PetscDLLibraryPrepend - Add another dynamic library to search for symbols to the beginning of 402e5c89e4eSSatish Balay the search path. 403e5c89e4eSSatish Balay 404e5c89e4eSSatish Balay Collective on MPI_Comm 405e5c89e4eSSatish Balay 406e5c89e4eSSatish Balay Input Parameters: 407e5c89e4eSSatish Balay + comm - MPI communicator 4080f31fb7fSLisandro Dalcin - path - name of the library 409e5c89e4eSSatish Balay 410e5c89e4eSSatish Balay Output Parameter: 411e5c89e4eSSatish Balay . outlist - list of libraries 412e5c89e4eSSatish Balay 413e5c89e4eSSatish Balay Level: developer 414e5c89e4eSSatish Balay 415e5c89e4eSSatish Balay Notes: If library is already in path will remove old reference. 416e5c89e4eSSatish Balay 417e5c89e4eSSatish Balay @*/ 4188738c821SJed Brown PetscErrorCode PETSCSYS_DLLEXPORT PetscDLLibraryPrepend(MPI_Comm comm,PetscDLLibrary *outlist,const char path[]) 419e5c89e4eSSatish Balay { 420e5bd5246SBarry Smith PetscDLLibrary list,prev; 421e5c89e4eSSatish Balay PetscErrorCode ierr; 422e5c89e4eSSatish Balay size_t len; 423ace3abfcSBarry Smith PetscBool match,dir; 424b3bb0f5eSLisandro Dalcin char program[PETSC_MAX_PATH_LEN],found[8*PETSC_MAX_PATH_LEN]; 425b3bb0f5eSLisandro Dalcin char *libname,suffix[16],*s; 4265b096c79SMatthew Knepley PetscToken token; 427e5c89e4eSSatish Balay 428e5c89e4eSSatish Balay PetscFunctionBegin; 429b3bb0f5eSLisandro Dalcin PetscValidPointer(outlist,2); 430e5c89e4eSSatish Balay 431b3bb0f5eSLisandro Dalcin /* is path a directory? */ 432b3bb0f5eSLisandro Dalcin ierr = PetscTestDirectory(path,'r',&dir);CHKERRQ(ierr); 433e5c89e4eSSatish Balay if (dir) { 434b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Checking directory %s for dynamic libraries\n",path);CHKERRQ(ierr); 435b3bb0f5eSLisandro Dalcin ierr = PetscStrcpy(program,path);CHKERRQ(ierr); 436e5c89e4eSSatish Balay ierr = PetscStrlen(program,&len);CHKERRQ(ierr); 437e5c89e4eSSatish Balay if (program[len-1] == '/') { 438e5c89e4eSSatish Balay ierr = PetscStrcat(program,"*.");CHKERRQ(ierr); 439e5c89e4eSSatish Balay } else { 440e5c89e4eSSatish Balay ierr = PetscStrcat(program,"/*.");CHKERRQ(ierr); 441e5c89e4eSSatish Balay } 442e5c89e4eSSatish Balay ierr = PetscStrcat(program,PETSC_SLSUFFIX);CHKERRQ(ierr); 443e5c89e4eSSatish Balay 444b3bb0f5eSLisandro Dalcin ierr = PetscLs(comm,program,found,8*PETSC_MAX_PATH_LEN,&dir);CHKERRQ(ierr); 445e5c89e4eSSatish Balay if (!dir) PetscFunctionReturn(0); 446e5c89e4eSSatish Balay } else { 447b3bb0f5eSLisandro Dalcin ierr = PetscStrncpy(found,path,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 448e5c89e4eSSatish Balay } 449e5c89e4eSSatish Balay 450e5c89e4eSSatish Balay ierr = PetscStrcpy(suffix,".");CHKERRQ(ierr); 451e5c89e4eSSatish Balay ierr = PetscStrcat(suffix,PETSC_SLSUFFIX);CHKERRQ(ierr); 452e5c89e4eSSatish Balay 453e5c89e4eSSatish Balay ierr = PetscTokenCreate(found,'\n',&token);CHKERRQ(ierr); 454b3bb0f5eSLisandro Dalcin ierr = PetscTokenFind(token,&libname);CHKERRQ(ierr); 455b3bb0f5eSLisandro Dalcin while (libname) { 456b3bb0f5eSLisandro Dalcin /* remove suffix from libname */ 457b3bb0f5eSLisandro Dalcin ierr = PetscStrstr(libname,suffix,&s);CHKERRQ(ierr); 458e5c89e4eSSatish Balay if (s) s[0] = 0; 459e5c89e4eSSatish Balay /* see if library was already open and move it to the front */ 460e5c89e4eSSatish Balay prev = 0; 461b3bb0f5eSLisandro Dalcin list = *outlist; 462e5c89e4eSSatish Balay match = PETSC_FALSE; 463e5c89e4eSSatish Balay while (list) { 464b3bb0f5eSLisandro Dalcin ierr = PetscStrcmp(list->libname,libname,&match);CHKERRQ(ierr); 465e5c89e4eSSatish Balay if (match) { 466b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Moving %s to begin of dynamic library search path\n",libname);CHKERRQ(ierr); 467e5c89e4eSSatish Balay if (prev) prev->next = list->next; 468b3bb0f5eSLisandro Dalcin if (prev) list->next = *outlist; 469e5c89e4eSSatish Balay *outlist = list; 470e5c89e4eSSatish Balay break; 471e5c89e4eSSatish Balay } 472e5c89e4eSSatish Balay prev = list; 473e5c89e4eSSatish Balay list = list->next; 474e5c89e4eSSatish Balay } 475b3bb0f5eSLisandro Dalcin /* restore suffix from libname */ 476b3bb0f5eSLisandro Dalcin if (s) s[0] = '.'; 477e5c89e4eSSatish Balay if (!match) { 4785673baf8SLisandro Dalcin /* open the library and add to front of list */ 479b3bb0f5eSLisandro Dalcin ierr = PetscDLLibraryOpen(comm,libname,&list);CHKERRQ(ierr); 480b3bb0f5eSLisandro Dalcin ierr = PetscInfo1(0,"Prepending %s to dynamic library search path\n",libname);CHKERRQ(ierr); 481ebd79076SLisandro Dalcin list->next = *outlist; 482e5c89e4eSSatish Balay *outlist = list; 483e5c89e4eSSatish Balay } 484b3bb0f5eSLisandro Dalcin ierr = PetscTokenFind(token,&libname);CHKERRQ(ierr); 485e5c89e4eSSatish Balay } 486e5c89e4eSSatish Balay ierr = PetscTokenDestroy(token);CHKERRQ(ierr); 487e5c89e4eSSatish Balay PetscFunctionReturn(0); 488e5c89e4eSSatish Balay } 489e5c89e4eSSatish Balay 490e5c89e4eSSatish Balay #undef __FUNCT__ 491e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryClose" 492e5c89e4eSSatish Balay /*@C 493e5c89e4eSSatish Balay PetscDLLibraryClose - Destroys the search path of dynamic libraries and closes the libraries. 494e5c89e4eSSatish Balay 495e5c89e4eSSatish Balay Collective on PetscDLLibrary 496e5c89e4eSSatish Balay 497e5c89e4eSSatish Balay Input Parameter: 4983fa76a5bSLisandro Dalcin . head - library list 499e5c89e4eSSatish Balay 500e5c89e4eSSatish Balay Level: developer 501e5c89e4eSSatish Balay 502e5c89e4eSSatish Balay @*/ 5038738c821SJed Brown PetscErrorCode PETSCSYS_DLLEXPORT PetscDLLibraryClose(PetscDLLibrary list) 504e5c89e4eSSatish Balay { 505ace3abfcSBarry Smith PetscBool done = PETSC_FALSE; 5060f31fb7fSLisandro Dalcin PetscDLLibrary prev,tail; 507e5c89e4eSSatish Balay PetscErrorCode ierr; 508e5c89e4eSSatish Balay 509e5c89e4eSSatish Balay PetscFunctionBegin; 5100f31fb7fSLisandro Dalcin if (!list) PetscFunctionReturn(0); 5113fa76a5bSLisandro Dalcin /* traverse the list in reverse order */ 5123fa76a5bSLisandro Dalcin while (!done) { 5130f31fb7fSLisandro Dalcin if (!list->next) done = PETSC_TRUE; 5140f31fb7fSLisandro Dalcin prev = tail = list; 5153fa76a5bSLisandro Dalcin while (tail->next) { 5163fa76a5bSLisandro Dalcin prev = tail; 5173fa76a5bSLisandro Dalcin tail = tail->next; 518e5c89e4eSSatish Balay } 5193fa76a5bSLisandro Dalcin prev->next = 0; 5203fa76a5bSLisandro Dalcin /* close the dynamic library and free the space in entry data-structure*/ 5213fa76a5bSLisandro Dalcin ierr = PetscInfo1(0,"Closing dynamic library %s\n",tail->libname);CHKERRQ(ierr); 5223fa76a5bSLisandro Dalcin ierr = PetscDLClose(&tail->handle);CHKERRQ(ierr); 5233fa76a5bSLisandro Dalcin ierr = PetscFree(tail);CHKERRQ(ierr); 5243fa76a5bSLisandro Dalcin }; 525e5c89e4eSSatish Balay PetscFunctionReturn(0); 526e5c89e4eSSatish Balay } 527e5c89e4eSSatish Balay 5283fa76a5bSLisandro Dalcin /* ------------------------------------------------------------------------------*/ 5293fa76a5bSLisandro Dalcin 5303fa76a5bSLisandro Dalcin /* 5313fa76a5bSLisandro Dalcin Contains the list of registered CCA components 5323fa76a5bSLisandro Dalcin */ 5333fa76a5bSLisandro Dalcin PetscFList CCAList = 0; 5343fa76a5bSLisandro Dalcin 535e5c89e4eSSatish Balay #undef __FUNCT__ 536e5c89e4eSSatish Balay #define __FUNCT__ "PetscDLLibraryCCAAppend" 537e5c89e4eSSatish Balay /*@C 538e5c89e4eSSatish Balay PetscDLLibraryCCAAppend - Appends another CCA dynamic link library to the seach list, to the end 539e5c89e4eSSatish Balay of the search path. 540e5c89e4eSSatish Balay 541e5c89e4eSSatish Balay Collective on MPI_Comm 542e5c89e4eSSatish Balay 543e5c89e4eSSatish Balay Input Parameters: 544e5c89e4eSSatish Balay + comm - MPI communicator 5450f31fb7fSLisandro Dalcin - dirname - name of directory to check 546e5c89e4eSSatish Balay 547e5c89e4eSSatish Balay Output Parameter: 548e5c89e4eSSatish Balay . outlist - list of libraries 549e5c89e4eSSatish Balay 550e5c89e4eSSatish Balay Level: developer 551e5c89e4eSSatish Balay 552e5c89e4eSSatish Balay Notes: if library is already in path will not add it. 553e5c89e4eSSatish Balay @*/ 5548738c821SJed Brown PetscErrorCode PETSCSYS_DLLEXPORT PetscDLLibraryCCAAppend(MPI_Comm comm,PetscDLLibrary *outlist,const char dirname[]) 555e5c89e4eSSatish Balay { 556e5c89e4eSSatish Balay PetscErrorCode ierr; 557e5c89e4eSSatish Balay size_t l; 558ace3abfcSBarry Smith PetscBool dir; 559e5c89e4eSSatish Balay char program[PETSC_MAX_PATH_LEN],buf[8*PETSC_MAX_PATH_LEN],*libname1,fbuf[PETSC_MAX_PATH_LEN],*found,suffix[16],*f2; 560e5c89e4eSSatish Balay char *func,*funcname,libname[PETSC_MAX_PATH_LEN],*lib; 561e5c89e4eSSatish Balay FILE *fp; 5625b096c79SMatthew Knepley PetscToken token1, token2; 563ed9cf6e9SBarry Smith int err; 564e5c89e4eSSatish Balay 565e5c89e4eSSatish Balay PetscFunctionBegin; 566e5c89e4eSSatish Balay /* is dirname a directory? */ 567e5c89e4eSSatish Balay ierr = PetscTestDirectory(dirname,'r',&dir);CHKERRQ(ierr); 568e5c89e4eSSatish Balay if (!dir) PetscFunctionReturn(0); 569e5c89e4eSSatish Balay 570ae15b995SBarry Smith ierr = PetscInfo1(0,"Checking directory %s for CCA components\n",dirname);CHKERRQ(ierr); 571e5c89e4eSSatish Balay ierr = PetscStrcpy(program,dirname);CHKERRQ(ierr); 572e5c89e4eSSatish Balay ierr = PetscStrcat(program,"/*.cca");CHKERRQ(ierr); 573e5c89e4eSSatish Balay 574e5c89e4eSSatish Balay ierr = PetscLs(comm,program,buf,8*PETSC_MAX_PATH_LEN,&dir);CHKERRQ(ierr); 575e5c89e4eSSatish Balay if (!dir) PetscFunctionReturn(0); 576e5c89e4eSSatish Balay 577e5c89e4eSSatish Balay ierr = PetscStrcpy(suffix,".");CHKERRQ(ierr); 578e5c89e4eSSatish Balay ierr = PetscStrcat(suffix,PETSC_SLSUFFIX);CHKERRQ(ierr); 579e5c89e4eSSatish Balay ierr = PetscTokenCreate(buf,'\n',&token1);CHKERRQ(ierr); 580e5c89e4eSSatish Balay ierr = PetscTokenFind(token1,&libname1);CHKERRQ(ierr); 581e5c89e4eSSatish Balay while (libname1) { 582e5c89e4eSSatish Balay fp = fopen(libname1,"r"); if (!fp) continue; 583e5c89e4eSSatish Balay while ((found = fgets(fbuf,PETSC_MAX_PATH_LEN,fp))) { 584e5c89e4eSSatish Balay if (found[0] == '!') continue; 585e5c89e4eSSatish Balay ierr = PetscStrstr(found,suffix,&f2);CHKERRQ(ierr); 586e5c89e4eSSatish Balay if (f2) { /* found library name */ 587e5c89e4eSSatish Balay if (found[0] == '/') { 588e5c89e4eSSatish Balay lib = found; 589e5c89e4eSSatish Balay } else { 590e5c89e4eSSatish Balay ierr = PetscStrcpy(libname,dirname);CHKERRQ(ierr); 591e5c89e4eSSatish Balay ierr = PetscStrlen(libname,&l);CHKERRQ(ierr); 592e5c89e4eSSatish Balay if (libname[l-1] != '/') {ierr = PetscStrcat(libname,"/");CHKERRQ(ierr);} 593e5c89e4eSSatish Balay ierr = PetscStrcat(libname,found);CHKERRQ(ierr); 594e5c89e4eSSatish Balay lib = libname; 595e5c89e4eSSatish Balay } 596e5c89e4eSSatish Balay ierr = PetscDLLibraryAppend(comm,outlist,lib);CHKERRQ(ierr); 597e5c89e4eSSatish Balay } else { 598ae15b995SBarry Smith ierr = PetscInfo2(0,"CCA Component function and name: %s from %s\n",found,libname1);CHKERRQ(ierr); 599e5c89e4eSSatish Balay ierr = PetscTokenCreate(found,' ',&token2);CHKERRQ(ierr); 600e5c89e4eSSatish Balay ierr = PetscTokenFind(token2,&func);CHKERRQ(ierr); 601e5c89e4eSSatish Balay ierr = PetscTokenFind(token2,&funcname);CHKERRQ(ierr); 602e5c89e4eSSatish Balay ierr = PetscFListAdd(&CCAList,funcname,func,PETSC_NULL);CHKERRQ(ierr); 603e5c89e4eSSatish Balay ierr = PetscTokenDestroy(token2);CHKERRQ(ierr); 604e5c89e4eSSatish Balay } 605e5c89e4eSSatish Balay } 606ed9cf6e9SBarry Smith err = fclose(fp); 607e32f2f54SBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 608e5c89e4eSSatish Balay ierr = PetscTokenFind(token1,&libname1);CHKERRQ(ierr); 609e5c89e4eSSatish Balay } 610e5c89e4eSSatish Balay ierr = PetscTokenDestroy(token1);CHKERRQ(ierr); 611e5c89e4eSSatish Balay PetscFunctionReturn(0); 612e5c89e4eSSatish Balay } 613