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