xref: /petsc/src/sys/dll/reg.c (revision fdad003c5891e62e9a9f7f62fc07fba0bd966a14)
17d0a6c19SBarry Smith 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay     Provides a general mechanism to allow one to register new routines in
4e5c89e4eSSatish Balay     dynamic libraries for many of the PETSc objects (including, e.g., KSP and PC).
5e5c89e4eSSatish Balay */
6c6db04a5SJed Brown #include <petscsys.h>           /*I "petscsys.h" I*/
7e5c89e4eSSatish Balay 
8e5c89e4eSSatish Balay #undef __FUNCT__
9e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListGetPathAndFunction"
107087cfbeSBarry Smith PetscErrorCode  PetscFListGetPathAndFunction(const char name[],char *path[],char *function[])
11e5c89e4eSSatish Balay {
12e5c89e4eSSatish Balay   PetscErrorCode ierr;
13e5c89e4eSSatish Balay   char           work[PETSC_MAX_PATH_LEN],*lfunction;
14e5c89e4eSSatish Balay 
15e5c89e4eSSatish Balay   PetscFunctionBegin;
16*fdad003cSJed Brown   ierr = PetscStrncpy(work,name,sizeof work);CHKERRQ(ierr);
17*fdad003cSJed Brown   work[sizeof work - 1] = 0;
18e5c89e4eSSatish Balay   ierr = PetscStrchr(work,':',&lfunction);CHKERRQ(ierr);
19e5c89e4eSSatish Balay   if (lfunction != work && lfunction && lfunction[1] != ':') {
20e5c89e4eSSatish Balay     lfunction[0] = 0;
21e5c89e4eSSatish Balay     ierr = PetscStrallocpy(work,path);CHKERRQ(ierr);
22e5c89e4eSSatish Balay     ierr = PetscStrallocpy(lfunction+1,function);CHKERRQ(ierr);
23e5c89e4eSSatish Balay   } else {
24e5c89e4eSSatish Balay     *path = 0;
25e5c89e4eSSatish Balay     ierr = PetscStrallocpy(name,function);CHKERRQ(ierr);
26e5c89e4eSSatish Balay   }
27e5c89e4eSSatish Balay   PetscFunctionReturn(0);
28e5c89e4eSSatish Balay }
29e5c89e4eSSatish Balay 
303fa76a5bSLisandro Dalcin /*
313fa76a5bSLisandro Dalcin     This is the default list used by PETSc with the PetscDLLibrary register routines
323fa76a5bSLisandro Dalcin */
333fa76a5bSLisandro Dalcin PetscDLLibrary DLLibrariesLoaded = 0;
343fa76a5bSLisandro Dalcin 
35ebd79076SLisandro Dalcin #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
36ebd79076SLisandro Dalcin 
37e5c89e4eSSatish Balay #undef __FUNCT__
38487e5849SBarry Smith #define __FUNCT__ "PetscLoadDynamicLibrary"
397087cfbeSBarry Smith static PetscErrorCode  PetscLoadDynamicLibrary(const char *name,PetscBool  *found)
40487e5849SBarry Smith {
41487e5849SBarry Smith   char           libs[PETSC_MAX_PATH_LEN],dlib[PETSC_MAX_PATH_LEN];
42487e5849SBarry Smith   PetscErrorCode ierr;
43487e5849SBarry Smith 
44487e5849SBarry Smith   PetscFunctionBegin;
45487e5849SBarry Smith   ierr = PetscStrcpy(libs,"${PETSC_LIB_DIR}/libpetsc");CHKERRQ(ierr);
46487e5849SBarry Smith   ierr = PetscStrcat(libs,name);CHKERRQ(ierr);
47487e5849SBarry Smith   ierr = PetscDLLibraryRetrieve(PETSC_COMM_WORLD,libs,dlib,1024,found);CHKERRQ(ierr);
48487e5849SBarry Smith   if (*found) {
49487e5849SBarry Smith     ierr = PetscDLLibraryAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,dlib);CHKERRQ(ierr);
50487e5849SBarry Smith   } else {
51487e5849SBarry Smith     ierr = PetscStrcpy(libs,"${PETSC_DIR}/${PETSC_ARCH}/lib/libpetsc");CHKERRQ(ierr);
52487e5849SBarry Smith     ierr = PetscStrcat(libs,name);CHKERRQ(ierr);
53487e5849SBarry Smith     ierr = PetscDLLibraryRetrieve(PETSC_COMM_WORLD,libs,dlib,1024,found);CHKERRQ(ierr);
54487e5849SBarry Smith     if (*found) {
55487e5849SBarry Smith       ierr = PetscDLLibraryAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,dlib);CHKERRQ(ierr);
56487e5849SBarry Smith     }
57487e5849SBarry Smith   }
58487e5849SBarry Smith   PetscFunctionReturn(0);
59487e5849SBarry Smith }
60487e5849SBarry Smith 
613fa76a5bSLisandro Dalcin #endif
623fa76a5bSLisandro Dalcin 
63487e5849SBarry Smith #undef __FUNCT__
64e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize_DynamicLibraries"
65e5c89e4eSSatish Balay /*
66e5c89e4eSSatish Balay     PetscInitialize_DynamicLibraries - Adds the default dynamic link libraries to the
67e5c89e4eSSatish Balay     search path.
68e5c89e4eSSatish Balay */
697087cfbeSBarry Smith PetscErrorCode  PetscInitialize_DynamicLibraries(void)
70e5c89e4eSSatish Balay {
71487e5849SBarry Smith   char           *libname[32];
72e5c89e4eSSatish Balay   PetscErrorCode ierr;
73e5c89e4eSSatish Balay   PetscInt       nmax,i;
743fa76a5bSLisandro Dalcin #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
75ace3abfcSBarry Smith   PetscBool      found;
763fa76a5bSLisandro Dalcin #endif
77e5c89e4eSSatish Balay 
7860154eb2SBarry Smith   PetscFunctionBegin;
79e5c89e4eSSatish Balay   nmax = 32;
80e5c89e4eSSatish Balay   ierr = PetscOptionsGetStringArray(PETSC_NULL,"-dll_prepend",libname,&nmax,PETSC_NULL);CHKERRQ(ierr);
81e5c89e4eSSatish Balay   for (i=0; i<nmax; i++) {
82e5c89e4eSSatish Balay     ierr = PetscDLLibraryPrepend(PETSC_COMM_WORLD,&DLLibrariesLoaded,libname[i]);CHKERRQ(ierr);
83e5c89e4eSSatish Balay     ierr = PetscFree(libname[i]);CHKERRQ(ierr);
84e5c89e4eSSatish Balay   }
85e5c89e4eSSatish Balay 
863fa76a5bSLisandro Dalcin #if !defined(PETSC_USE_DYNAMIC_LIBRARIES)
873fa76a5bSLisandro Dalcin   /*
883fa76a5bSLisandro Dalcin       This just initializes the most basic PETSc stuff.
893fa76a5bSLisandro Dalcin 
903fa76a5bSLisandro Dalcin     The classes, from PetscDraw to PetscTS, are initialized the first
913fa76a5bSLisandro Dalcin     time an XXCreate() is called.
923fa76a5bSLisandro Dalcin   */
9360154eb2SBarry Smith   ierr = PetscSysInitializePackage(PETSC_NULL);CHKERRQ(ierr);
943fa76a5bSLisandro Dalcin #else
9560154eb2SBarry Smith #if defined(PETSC_USE_SINGLE_LIBRARY)
96487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("",&found);CHKERRQ(ierr);
97e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc dynamic library \n You cannot move the dynamic libraries!");
9860154eb2SBarry Smith #else
9960154eb2SBarry Smith   ierr = PetscLoadDynamicLibrary("sys",&found);CHKERRQ(ierr);
10060154eb2SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc dynamic library \n You cannot move the dynamic libraries!");
101487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("vec",&found);CHKERRQ(ierr);
102e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc Vec dynamic library \n You cannot move the dynamic libraries!");
103487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("mat",&found);CHKERRQ(ierr);
104e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc Mat dynamic library \n You cannot move the dynamic libraries!");
105487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("dm",&found);CHKERRQ(ierr);
106e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc DM dynamic library \n You cannot move the dynamic libraries!");
10760154eb2SBarry Smith   ierr = PetscLoadDynamicLibrary("characteristic",&found);CHKERRQ(ierr);
10860154eb2SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc Characteristic dynamic library \n You cannot move the dynamic libraries!");
109487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("ksp",&found);CHKERRQ(ierr);
110e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc KSP dynamic library \n You cannot move the dynamic libraries!");
111487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("snes",&found);CHKERRQ(ierr);
112e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc SNES dynamic library \n You cannot move the dynamic libraries!");
113487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("ts",&found);CHKERRQ(ierr);
114e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc TS dynamic library \n You cannot move the dynamic libraries!");
115bb84e0fdSBarry Smith #endif
116e5c89e4eSSatish Balay 
117487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("mesh",&found);CHKERRQ(ierr);
118487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("contrib",&found);CHKERRQ(ierr);
1193fa76a5bSLisandro Dalcin #endif
120e5c89e4eSSatish Balay 
121e5c89e4eSSatish Balay   nmax = 32;
122e5c89e4eSSatish Balay   ierr = PetscOptionsGetStringArray(PETSC_NULL,"-dll_append",libname,&nmax,PETSC_NULL);CHKERRQ(ierr);
123e5c89e4eSSatish Balay   for (i=0; i<nmax; i++) {
124e5c89e4eSSatish Balay     ierr = PetscDLLibraryAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,libname[i]);CHKERRQ(ierr);
125e5c89e4eSSatish Balay     ierr = PetscDLLibraryCCAAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,libname[i]);CHKERRQ(ierr);
126e5c89e4eSSatish Balay     ierr = PetscFree(libname[i]);CHKERRQ(ierr);
127e5c89e4eSSatish Balay   }
1283fa76a5bSLisandro Dalcin 
129e5c89e4eSSatish Balay   PetscFunctionReturn(0);
130e5c89e4eSSatish Balay }
131e5c89e4eSSatish Balay 
132e5c89e4eSSatish Balay #undef __FUNCT__
133e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize_DynamicLibraries"
134ebd79076SLisandro Dalcin /*
135ebd79076SLisandro Dalcin      PetscFinalize_DynamicLibraries - Closes the opened dynamic libraries.
136ebd79076SLisandro Dalcin */
137e5c89e4eSSatish Balay PetscErrorCode PetscFinalize_DynamicLibraries(void)
138e5c89e4eSSatish Balay {
139ebd79076SLisandro Dalcin   PetscErrorCode ierr;
140ace3abfcSBarry Smith   PetscBool      flg = PETSC_FALSE;
141e5c89e4eSSatish Balay 
142ebd79076SLisandro Dalcin   PetscFunctionBegin;
143acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-dll_view",&flg,PETSC_NULL);CHKERRQ(ierr);
1445673baf8SLisandro Dalcin   if (flg) { ierr = PetscDLLibraryPrintPath(DLLibrariesLoaded);CHKERRQ(ierr); }
1450f31fb7fSLisandro Dalcin   ierr = PetscDLLibraryClose(DLLibrariesLoaded);CHKERRQ(ierr);
1460f31fb7fSLisandro Dalcin   DLLibrariesLoaded = 0;
147e5c89e4eSSatish Balay   PetscFunctionReturn(0);
148e5c89e4eSSatish Balay }
149e5c89e4eSSatish Balay 
150e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
1512bb46157SSatish Balay struct _n_PetscFList {
152e5c89e4eSSatish Balay   void        (*routine)(void);   /* the routine */
153e5c89e4eSSatish Balay   char        *path;              /* path of link library containing routine */
154e5c89e4eSSatish Balay   char        *name;              /* string to identify routine */
155e5c89e4eSSatish Balay   char        *rname;             /* routine name in dynamic library */
156e5c89e4eSSatish Balay   PetscFList  next;               /* next pointer */
157e5c89e4eSSatish Balay   PetscFList  next_list;          /* used to maintain list of all lists for freeing */
158e5c89e4eSSatish Balay };
159e5c89e4eSSatish Balay 
160e5c89e4eSSatish Balay /*
161e5c89e4eSSatish Balay      Keep a linked list of PetscFLists so that we can destroy all the left-over ones.
162e5c89e4eSSatish Balay */
163e5c89e4eSSatish Balay static PetscFList   dlallhead = 0;
164e5c89e4eSSatish Balay 
165e5c89e4eSSatish Balay #undef __FUNCT__
166e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListAdd"
167e5c89e4eSSatish Balay /*@C
168e5c89e4eSSatish Balay    PetscFListAddDynamic - Given a routine and a string id, saves that routine in the
169e5c89e4eSSatish Balay    specified registry.
170e5c89e4eSSatish Balay 
171e5c89e4eSSatish Balay      Not Collective
172e5c89e4eSSatish Balay 
173e5c89e4eSSatish Balay    Input Parameters:
174e5c89e4eSSatish Balay +  fl    - pointer registry
175e5c89e4eSSatish Balay .  name  - string to identify routine
176e5c89e4eSSatish Balay .  rname - routine name in dynamic library
177e5c89e4eSSatish Balay -  fnc   - function pointer (optional if using dynamic libraries)
178e5c89e4eSSatish Balay 
179e5c89e4eSSatish Balay    Notes:
180e5c89e4eSSatish Balay    To remove a registered routine, pass in a PETSC_NULL rname and fnc().
181e5c89e4eSSatish Balay 
182e5c89e4eSSatish Balay    Users who wish to register new classes for use by a particular PETSc
183e5c89e4eSSatish Balay    component (e.g., SNES) should generally call the registration routine
184e5c89e4eSSatish Balay    for that particular component (e.g., SNESRegisterDynamic()) instead of
185e5c89e4eSSatish Balay    calling PetscFListAddDynamic() directly.
186e5c89e4eSSatish Balay 
187e5c89e4eSSatish Balay    ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, or ${any environmental variable}
188e5c89e4eSSatish Balay   occuring in pathname will be replaced with appropriate values.
189e5c89e4eSSatish Balay 
190e5c89e4eSSatish Balay    Level: developer
191e5c89e4eSSatish Balay 
192e5c89e4eSSatish Balay .seealso: PetscFListDestroy(), SNESRegisterDynamic(), KSPRegisterDynamic(),
193e5c89e4eSSatish Balay           PCRegisterDynamic(), TSRegisterDynamic(), PetscFList
194e5c89e4eSSatish Balay @*/
1957087cfbeSBarry Smith PetscErrorCode  PetscFListAdd(PetscFList *fl,const char name[],const char rname[],void (*fnc)(void))
196e5c89e4eSSatish Balay {
197e5c89e4eSSatish Balay   PetscFList     entry,ne;
198e5c89e4eSSatish Balay   PetscErrorCode ierr;
199e5c89e4eSSatish Balay   char           *fpath,*fname;
200e5c89e4eSSatish Balay 
201e5c89e4eSSatish Balay   PetscFunctionBegin;
202e5c89e4eSSatish Balay   if (!*fl) {
2032bb46157SSatish Balay     ierr           = PetscNew(struct _n_PetscFList,&entry);CHKERRQ(ierr);
204e5c89e4eSSatish Balay     ierr           = PetscStrallocpy(name,&entry->name);CHKERRQ(ierr);
205e5c89e4eSSatish Balay     ierr           = PetscFListGetPathAndFunction(rname,&fpath,&fname);CHKERRQ(ierr);
206e5c89e4eSSatish Balay     entry->path    = fpath;
207e5c89e4eSSatish Balay     entry->rname   = fname;
208e5c89e4eSSatish Balay     entry->routine = fnc;
209e5c89e4eSSatish Balay     entry->next    = 0;
210e5c89e4eSSatish Balay     *fl = entry;
211e5c89e4eSSatish Balay 
212e5c89e4eSSatish Balay     /* add this new list to list of all lists */
213e5c89e4eSSatish Balay     if (!dlallhead) {
214e5c89e4eSSatish Balay       dlallhead        = *fl;
215e5c89e4eSSatish Balay       (*fl)->next_list = 0;
216e5c89e4eSSatish Balay     } else {
217e5c89e4eSSatish Balay       ne               = dlallhead;
218e5c89e4eSSatish Balay       dlallhead        = *fl;
219e5c89e4eSSatish Balay       (*fl)->next_list = ne;
220e5c89e4eSSatish Balay     }
221e5c89e4eSSatish Balay   } else {
222e5c89e4eSSatish Balay     /* search list to see if it is already there */
223e5c89e4eSSatish Balay     ne = *fl;
224e5c89e4eSSatish Balay     while (ne) {
225ace3abfcSBarry Smith       PetscBool  founddup;
226e5c89e4eSSatish Balay 
227e5c89e4eSSatish Balay       ierr = PetscStrcmp(ne->name,name,&founddup);CHKERRQ(ierr);
228e5c89e4eSSatish Balay       if (founddup) { /* found duplicate */
229e5c89e4eSSatish Balay         ierr = PetscFListGetPathAndFunction(rname,&fpath,&fname);CHKERRQ(ierr);
230503cfb0cSBarry Smith         ierr = PetscFree(ne->path);CHKERRQ(ierr);
231503cfb0cSBarry Smith         ierr = PetscFree(ne->rname);CHKERRQ(ierr);
232e5c89e4eSSatish Balay         ne->path    = fpath;
233e5c89e4eSSatish Balay         ne->rname   = fname;
234e5c89e4eSSatish Balay         ne->routine = fnc;
235e5c89e4eSSatish Balay         PetscFunctionReturn(0);
236e5c89e4eSSatish Balay       }
237e5c89e4eSSatish Balay       if (ne->next) ne = ne->next; else break;
238e5c89e4eSSatish Balay     }
239e5c89e4eSSatish Balay     /* create new entry and add to end of list */
2402bb46157SSatish Balay     ierr           = PetscNew(struct _n_PetscFList,&entry);CHKERRQ(ierr);
241e5c89e4eSSatish Balay     ierr           = PetscStrallocpy(name,&entry->name);CHKERRQ(ierr);
242e5c89e4eSSatish Balay     ierr           = PetscFListGetPathAndFunction(rname,&fpath,&fname);CHKERRQ(ierr);
243e5c89e4eSSatish Balay     entry->path    = fpath;
244e5c89e4eSSatish Balay     entry->rname   = fname;
245e5c89e4eSSatish Balay     entry->routine = fnc;
246e5c89e4eSSatish Balay     entry->next    = 0;
247e5c89e4eSSatish Balay     ne->next       = entry;
248e5c89e4eSSatish Balay   }
249e5c89e4eSSatish Balay   PetscFunctionReturn(0);
250e5c89e4eSSatish Balay }
251e5c89e4eSSatish Balay 
252e5c89e4eSSatish Balay #undef __FUNCT__
253e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListDestroy"
254e5c89e4eSSatish Balay /*@
255e5c89e4eSSatish Balay     PetscFListDestroy - Destroys a list of registered routines.
256e5c89e4eSSatish Balay 
257e5c89e4eSSatish Balay     Input Parameter:
258e5c89e4eSSatish Balay .   fl  - pointer to list
259e5c89e4eSSatish Balay 
260e5c89e4eSSatish Balay     Level: developer
261e5c89e4eSSatish Balay 
262e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFList
263e5c89e4eSSatish Balay @*/
2647087cfbeSBarry Smith PetscErrorCode  PetscFListDestroy(PetscFList *fl)
265e5c89e4eSSatish Balay {
266e5c89e4eSSatish Balay   PetscFList     next,entry,tmp = dlallhead;
267e5c89e4eSSatish Balay   PetscErrorCode ierr;
268e5c89e4eSSatish Balay 
269e5c89e4eSSatish Balay   PetscFunctionBegin;
2701441b1d3SBarry Smith   if (!*fl) PetscFunctionReturn(0);
27160154eb2SBarry Smith   if (!dlallhead) PetscFunctionReturn(0);
272e5c89e4eSSatish Balay 
273e5c89e4eSSatish Balay   /*
274e5c89e4eSSatish Balay        Remove this entry from the master DL list (if it is in it)
275e5c89e4eSSatish Balay   */
2761441b1d3SBarry Smith   if (dlallhead == *fl) {
277e5c89e4eSSatish Balay     if (dlallhead->next_list) {
278e5c89e4eSSatish Balay       dlallhead = dlallhead->next_list;
279e5c89e4eSSatish Balay     } else {
280e5c89e4eSSatish Balay       dlallhead = 0;
281e5c89e4eSSatish Balay     }
282e5c89e4eSSatish Balay   } else {
2831441b1d3SBarry Smith     while (tmp->next_list != *fl) {
284e5c89e4eSSatish Balay       tmp = tmp->next_list;
285e5c89e4eSSatish Balay       if (!tmp->next_list) break;
286e5c89e4eSSatish Balay     }
287e5c89e4eSSatish Balay     if (tmp->next_list) tmp->next_list = tmp->next_list->next_list;
288e5c89e4eSSatish Balay   }
289e5c89e4eSSatish Balay 
290e5c89e4eSSatish Balay   /* free this list */
2911441b1d3SBarry Smith   entry = *fl;
292e5c89e4eSSatish Balay   while (entry) {
293e5c89e4eSSatish Balay     next = entry->next;
294503cfb0cSBarry Smith     ierr = PetscFree(entry->path);CHKERRQ(ierr);
295e5c89e4eSSatish Balay     ierr = PetscFree(entry->name);CHKERRQ(ierr);
296e5c89e4eSSatish Balay     ierr = PetscFree(entry->rname);CHKERRQ(ierr);
297e5c89e4eSSatish Balay     ierr = PetscFree(entry);CHKERRQ(ierr);
298e5c89e4eSSatish Balay     entry = next;
299e5c89e4eSSatish Balay   }
3001441b1d3SBarry Smith   *fl = 0;
301e5c89e4eSSatish Balay   PetscFunctionReturn(0);
302e5c89e4eSSatish Balay }
303e5c89e4eSSatish Balay 
304e5c89e4eSSatish Balay /*
305e5c89e4eSSatish Balay    Destroys all the function lists that anyone has every registered, such as KSPList, VecList, etc.
306e5c89e4eSSatish Balay */
307e5c89e4eSSatish Balay #undef __FUNCT__
308e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListDestroyAll"
3097087cfbeSBarry Smith PetscErrorCode  PetscFListDestroyAll(void)
310e5c89e4eSSatish Balay {
311e5c89e4eSSatish Balay   PetscFList     tmp2,tmp1 = dlallhead;
312e5c89e4eSSatish Balay   PetscErrorCode ierr;
313e5c89e4eSSatish Balay 
314e5c89e4eSSatish Balay   PetscFunctionBegin;
315e5c89e4eSSatish Balay   while (tmp1) {
316e5c89e4eSSatish Balay     tmp2 = tmp1->next_list;
3171441b1d3SBarry Smith     ierr = PetscFListDestroy(&tmp1);CHKERRQ(ierr);
318e5c89e4eSSatish Balay     tmp1 = tmp2;
319e5c89e4eSSatish Balay   }
320e5c89e4eSSatish Balay   dlallhead = 0;
321e5c89e4eSSatish Balay   PetscFunctionReturn(0);
322e5c89e4eSSatish Balay }
323e5c89e4eSSatish Balay 
324e5c89e4eSSatish Balay #undef __FUNCT__
325e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListFind"
326e5c89e4eSSatish Balay /*@C
327e5c89e4eSSatish Balay     PetscFListFind - Given a name, finds the matching routine.
328e5c89e4eSSatish Balay 
329e5c89e4eSSatish Balay     Input Parameters:
3301d280d73SBarry Smith +   fl   - pointer to list
3311d280d73SBarry Smith .   comm - processors looking for routine
3324b91b6eaSBarry Smith .   name - name string
3334b91b6eaSBarry Smith -   searchlibraries - if not found in the list then search the dynamic libraries and executable for the symbol
334e5c89e4eSSatish Balay 
335e5c89e4eSSatish Balay     Output Parameters:
336e5c89e4eSSatish Balay .   r - the routine
337e5c89e4eSSatish Balay 
338e5c89e4eSSatish Balay     Level: developer
339e5c89e4eSSatish Balay 
340e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFList
341e5c89e4eSSatish Balay @*/
3424b91b6eaSBarry Smith PetscErrorCode  PetscFListFind(PetscFList fl,MPI_Comm comm,const char name[],PetscBool searchlibraries,void (**r)(void))
343e5c89e4eSSatish Balay {
344e5c89e4eSSatish Balay   PetscFList     entry = fl;
345e5c89e4eSSatish Balay   PetscErrorCode ierr;
346e5c89e4eSSatish Balay   char           *function,*path;
347ace3abfcSBarry Smith   PetscBool      flg,f1,f2,f3;
3480598bfebSBarry Smith #if defined(PETSC_HAVE_DYNAMIC_LIBRARIES)
349e5c89e4eSSatish Balay   char           *newpath;
350e5c89e4eSSatish Balay #endif
351e5c89e4eSSatish Balay 
352e5c89e4eSSatish Balay   PetscFunctionBegin;
353e32f2f54SBarry Smith   if (!name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to find routine with null name");
354e5c89e4eSSatish Balay 
355e5c89e4eSSatish Balay   *r = 0;
356e5c89e4eSSatish Balay   ierr = PetscFListGetPathAndFunction(name,&path,&function);CHKERRQ(ierr);
357e5c89e4eSSatish Balay 
358e5c89e4eSSatish Balay   /*
359e5c89e4eSSatish Balay         If path then append it to search libraries
360e5c89e4eSSatish Balay   */
3610598bfebSBarry Smith #if defined(PETSC_HAVE_DYNAMIC_LIBRARIES)
362e5c89e4eSSatish Balay   if (path) {
363e5c89e4eSSatish Balay     ierr = PetscDLLibraryAppend(comm,&DLLibrariesLoaded,path);CHKERRQ(ierr);
364e5c89e4eSSatish Balay   }
365e5c89e4eSSatish Balay #endif
366e5c89e4eSSatish Balay 
367e5c89e4eSSatish Balay   while (entry) {
368e5c89e4eSSatish Balay     flg = PETSC_FALSE;
369e5c89e4eSSatish Balay     if (path && entry->path) {
370e5c89e4eSSatish Balay       ierr = PetscStrcmp(path,entry->path,&f1);CHKERRQ(ierr);
371e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->rname,&f2);CHKERRQ(ierr);
372e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->name,&f3);CHKERRQ(ierr);
373ace3abfcSBarry Smith       flg =  (PetscBool) ((f1 && f2) || (f1 && f3));
374e5c89e4eSSatish Balay     } else if (!path) {
375e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->name,&f1);CHKERRQ(ierr);
376e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->rname,&f2);CHKERRQ(ierr);
377ace3abfcSBarry Smith       flg =  (PetscBool) (f1 || f2);
378e5c89e4eSSatish Balay     } else {
379e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->name,&flg);CHKERRQ(ierr);
380e5c89e4eSSatish Balay       if (flg) {
381e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
382e5c89e4eSSatish Balay         ierr = PetscStrallocpy(entry->rname,&function);CHKERRQ(ierr);
383e5c89e4eSSatish Balay       } else {
384e5c89e4eSSatish Balay         ierr = PetscStrcmp(function,entry->rname,&flg);CHKERRQ(ierr);
385e5c89e4eSSatish Balay       }
386e5c89e4eSSatish Balay     }
387e5c89e4eSSatish Balay 
388e5c89e4eSSatish Balay     if (flg) {
389e5c89e4eSSatish Balay       if (entry->routine) {
390e5c89e4eSSatish Balay         *r   = entry->routine;
391503cfb0cSBarry Smith         ierr = PetscFree(path);CHKERRQ(ierr);
392e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
393e5c89e4eSSatish Balay         PetscFunctionReturn(0);
394e5c89e4eSSatish Balay       }
3955629bde7SJed Brown       if (!(entry->rname && entry->rname[0])) { /* The entry has been cleared */
3965629bde7SJed Brown         ierr = PetscFree(function);CHKERRQ(ierr);
3975629bde7SJed Brown         PetscFunctionReturn(0);
3985629bde7SJed Brown       }
399e5c89e4eSSatish Balay       if ((path && entry->path && f3) || (!path && f1)) { /* convert name of function (alias) to actual function name */
400e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
401e5c89e4eSSatish Balay         ierr = PetscStrallocpy(entry->rname,&function);CHKERRQ(ierr);
402e5c89e4eSSatish Balay       }
403e5c89e4eSSatish Balay 
404e5c89e4eSSatish Balay       /* it is not yet in memory so load from dynamic library */
4050598bfebSBarry Smith #if defined(PETSC_HAVE_DYNAMIC_LIBRARIES)
406e5c89e4eSSatish Balay       newpath = path;
407e5c89e4eSSatish Balay       if (!path) newpath = entry->path;
408e5c89e4eSSatish Balay       ierr = PetscDLLibrarySym(comm,&DLLibrariesLoaded,newpath,entry->rname,(void **)r);CHKERRQ(ierr);
409e5c89e4eSSatish Balay       if (*r) {
410e5c89e4eSSatish Balay         entry->routine = *r;
411503cfb0cSBarry Smith         ierr = PetscFree(path);CHKERRQ(ierr);
412e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
413e5c89e4eSSatish Balay         PetscFunctionReturn(0);
414e5c89e4eSSatish Balay       }
415e5c89e4eSSatish Balay #endif
416e5c89e4eSSatish Balay     }
417e5c89e4eSSatish Balay     entry = entry->next;
418e5c89e4eSSatish Balay   }
419e5c89e4eSSatish Balay 
4200598bfebSBarry Smith #if defined(PETSC_HAVE_DYNAMIC_LIBRARIES)
4214b91b6eaSBarry Smith   if (searchlibraries) {
422e5c89e4eSSatish Balay     /* Function never registered; try for it anyway */
423e5c89e4eSSatish Balay     ierr = PetscDLLibrarySym(comm,&DLLibrariesLoaded,path,function,(void **)r);CHKERRQ(ierr);
424503cfb0cSBarry Smith     ierr = PetscFree(path);CHKERRQ(ierr);
425e5c89e4eSSatish Balay     if (*r) {
426e5c89e4eSSatish Balay       ierr = PetscFListAdd(&fl,name,name,*r);CHKERRQ(ierr);
427e5c89e4eSSatish Balay     }
4284b91b6eaSBarry Smith   }
429e5c89e4eSSatish Balay #endif
430e5c89e4eSSatish Balay   ierr = PetscFree(function);CHKERRQ(ierr);
431e5c89e4eSSatish Balay   PetscFunctionReturn(0);
432e5c89e4eSSatish Balay }
433e5c89e4eSSatish Balay 
434e5c89e4eSSatish Balay #undef __FUNCT__
435e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListView"
436e5c89e4eSSatish Balay /*@
437e5c89e4eSSatish Balay    PetscFListView - prints out contents of an PetscFList
438e5c89e4eSSatish Balay 
439e5c89e4eSSatish Balay    Collective over MPI_Comm
440e5c89e4eSSatish Balay 
441e5c89e4eSSatish Balay    Input Parameters:
442e5c89e4eSSatish Balay +  list - the list of functions
443e5c89e4eSSatish Balay -  viewer - currently ignored
444e5c89e4eSSatish Balay 
445e5c89e4eSSatish Balay    Level: developer
446e5c89e4eSSatish Balay 
447e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFListPrintTypes(), PetscFList
448e5c89e4eSSatish Balay @*/
4497087cfbeSBarry Smith PetscErrorCode  PetscFListView(PetscFList list,PetscViewer viewer)
450e5c89e4eSSatish Balay {
451e5c89e4eSSatish Balay   PetscErrorCode ierr;
452ace3abfcSBarry Smith   PetscBool      iascii;
453e5c89e4eSSatish Balay 
454e5c89e4eSSatish Balay   PetscFunctionBegin;
455e5c89e4eSSatish Balay   if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF;
456e5c89e4eSSatish Balay   PetscValidPointer(list,1);
4570700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
458e5c89e4eSSatish Balay 
4592692d6eeSBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
460e32f2f54SBarry Smith   if (!iascii) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Only ASCII viewer supported");
461e5c89e4eSSatish Balay 
462e5c89e4eSSatish Balay   while (list) {
463e5c89e4eSSatish Balay     if (list->path) {
464e5c89e4eSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer," %s %s %s\n",list->path,list->name,list->rname);CHKERRQ(ierr);
465e5c89e4eSSatish Balay     } else {
466e5c89e4eSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer," %s %s\n",list->name,list->rname);CHKERRQ(ierr);
467e5c89e4eSSatish Balay     }
468e5c89e4eSSatish Balay     list = list->next;
469e5c89e4eSSatish Balay   }
470e5c89e4eSSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
471e5c89e4eSSatish Balay   PetscFunctionReturn(0);
472e5c89e4eSSatish Balay }
473e5c89e4eSSatish Balay 
474e5c89e4eSSatish Balay #undef __FUNCT__
475e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListGet"
476e5c89e4eSSatish Balay /*@
477e5c89e4eSSatish Balay    PetscFListGet - Gets an array the contains the entries in PetscFList, this is used
478e5c89e4eSSatish Balay          by help etc.
479e5c89e4eSSatish Balay 
480e5c89e4eSSatish Balay    Collective over MPI_Comm
481e5c89e4eSSatish Balay 
482e5c89e4eSSatish Balay    Input Parameter:
483e5c89e4eSSatish Balay .  list   - list of types
484e5c89e4eSSatish Balay 
485e5c89e4eSSatish Balay    Output Parameter:
486e5c89e4eSSatish Balay +  array - array of names
487e5c89e4eSSatish Balay -  n - length of array
488e5c89e4eSSatish Balay 
489e5c89e4eSSatish Balay    Notes:
490e5c89e4eSSatish Balay        This allocates the array so that must be freed. BUT the individual entries are
491e5c89e4eSSatish Balay     not copied so should not be freed.
492e5c89e4eSSatish Balay 
493e5c89e4eSSatish Balay    Level: developer
494e5c89e4eSSatish Balay 
495e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFList
496e5c89e4eSSatish Balay @*/
4977087cfbeSBarry Smith PetscErrorCode  PetscFListGet(PetscFList list,char ***array,int *n)
498e5c89e4eSSatish Balay {
499e5c89e4eSSatish Balay   PetscErrorCode ierr;
500e5c89e4eSSatish Balay   PetscInt       count = 0;
501e5c89e4eSSatish Balay   PetscFList     klist = list;
502e5c89e4eSSatish Balay 
503e5c89e4eSSatish Balay   PetscFunctionBegin;
504e5c89e4eSSatish Balay   while (list) {
505e5c89e4eSSatish Balay     list = list->next;
506e5c89e4eSSatish Balay     count++;
507e5c89e4eSSatish Balay   }
508e5c89e4eSSatish Balay   ierr  = PetscMalloc((count+1)*sizeof(char *),array);CHKERRQ(ierr);
509e5c89e4eSSatish Balay   count = 0;
510e5c89e4eSSatish Balay   while (klist) {
511e5c89e4eSSatish Balay     (*array)[count] = klist->name;
512e5c89e4eSSatish Balay     klist = klist->next;
513e5c89e4eSSatish Balay     count++;
514e5c89e4eSSatish Balay   }
515e5c89e4eSSatish Balay   (*array)[count] = 0;
516e5c89e4eSSatish Balay   *n = count+1;
517e5c89e4eSSatish Balay   PetscFunctionReturn(0);
518e5c89e4eSSatish Balay }
519e5c89e4eSSatish Balay 
520e5c89e4eSSatish Balay 
521e5c89e4eSSatish Balay #undef __FUNCT__
522e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListPrintTypes"
523e5c89e4eSSatish Balay /*@C
524e5c89e4eSSatish Balay    PetscFListPrintTypes - Prints the methods available.
525e5c89e4eSSatish Balay 
526e5c89e4eSSatish Balay    Collective over MPI_Comm
527e5c89e4eSSatish Balay 
528e5c89e4eSSatish Balay    Input Parameters:
529e5c89e4eSSatish Balay +  comm   - the communicator (usually MPI_COMM_WORLD)
530e5c89e4eSSatish Balay .  fd     - file to print to, usually stdout
531e5c89e4eSSatish Balay .  prefix - prefix to prepend to name (optional)
532e5c89e4eSSatish Balay .  name   - option string (for example, "-ksp_type")
533e5c89e4eSSatish Balay .  text - short description of the object (for example, "Krylov solvers")
534e5c89e4eSSatish Balay .  man - name of manual page that discusses the object (for example, "KSPCreate")
5353cc1e11dSBarry Smith .  list   - list of types
5363cc1e11dSBarry Smith -  def - default (current) value
537e5c89e4eSSatish Balay 
538e5c89e4eSSatish Balay    Level: developer
539e5c89e4eSSatish Balay 
540e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFList
541e5c89e4eSSatish Balay @*/
5427087cfbeSBarry Smith PetscErrorCode  PetscFListPrintTypes(MPI_Comm comm,FILE *fd,const char prefix[],const char name[],const char text[],const char man[],PetscFList list,const char def[])
543e5c89e4eSSatish Balay {
544e5c89e4eSSatish Balay   PetscErrorCode ierr;
545e5c89e4eSSatish Balay   PetscInt       count = 0;
546e5c89e4eSSatish Balay   char           p[64];
547e5c89e4eSSatish Balay 
548e5c89e4eSSatish Balay   PetscFunctionBegin;
549da9f1d6bSBarry Smith   if (!fd) fd = PETSC_STDOUT;
550e5c89e4eSSatish Balay 
551e5c89e4eSSatish Balay   ierr = PetscStrcpy(p,"-");CHKERRQ(ierr);
552e5c89e4eSSatish Balay   if (prefix) {ierr = PetscStrcat(p,prefix);CHKERRQ(ierr);}
5533cc1e11dSBarry Smith   ierr = PetscFPrintf(comm,fd,"  %s%s <%s>: %s (one of)",p,name+1,def,text);CHKERRQ(ierr);
554e5c89e4eSSatish Balay 
555e5c89e4eSSatish Balay   while (list) {
556e5c89e4eSSatish Balay     ierr = PetscFPrintf(comm,fd," %s",list->name);CHKERRQ(ierr);
557e5c89e4eSSatish Balay     list = list->next;
558e5c89e4eSSatish Balay     count++;
559e5c89e4eSSatish Balay     if (count == 8) {ierr = PetscFPrintf(comm,fd,"\n     ");CHKERRQ(ierr);}
560e5c89e4eSSatish Balay   }
561e5c89e4eSSatish Balay   ierr = PetscFPrintf(comm,fd," (%s)\n",man);CHKERRQ(ierr);
562e5c89e4eSSatish Balay   PetscFunctionReturn(0);
563e5c89e4eSSatish Balay }
564e5c89e4eSSatish Balay 
565e5c89e4eSSatish Balay #undef __FUNCT__
566e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListDuplicate"
567e5c89e4eSSatish Balay /*@
568e5c89e4eSSatish Balay     PetscFListDuplicate - Creates a new list from a given object list.
569e5c89e4eSSatish Balay 
570e5c89e4eSSatish Balay     Input Parameters:
571e5c89e4eSSatish Balay .   fl   - pointer to list
572e5c89e4eSSatish Balay 
573e5c89e4eSSatish Balay     Output Parameters:
574e5c89e4eSSatish Balay .   nl - the new list (should point to 0 to start, otherwise appends)
575e5c89e4eSSatish Balay 
576e5c89e4eSSatish Balay     Level: developer
577e5c89e4eSSatish Balay 
578e5c89e4eSSatish Balay .seealso: PetscFList, PetscFListAdd(), PetscFlistDestroy()
579e5c89e4eSSatish Balay 
580e5c89e4eSSatish Balay @*/
5817087cfbeSBarry Smith PetscErrorCode  PetscFListDuplicate(PetscFList fl,PetscFList *nl)
582e5c89e4eSSatish Balay {
583e5c89e4eSSatish Balay   PetscErrorCode ierr;
584e5c89e4eSSatish Balay   char           path[PETSC_MAX_PATH_LEN];
585e5c89e4eSSatish Balay 
586e5c89e4eSSatish Balay   PetscFunctionBegin;
587e5c89e4eSSatish Balay   while (fl) {
588e5c89e4eSSatish Balay     /* this is silly, rebuild the complete pathname */
589e5c89e4eSSatish Balay     if (fl->path) {
590e5c89e4eSSatish Balay       ierr = PetscStrcpy(path,fl->path);CHKERRQ(ierr);
591e5c89e4eSSatish Balay       ierr = PetscStrcat(path,":");CHKERRQ(ierr);
592e5c89e4eSSatish Balay       ierr = PetscStrcat(path,fl->name);CHKERRQ(ierr);
593e5c89e4eSSatish Balay     } else {
594e5c89e4eSSatish Balay       ierr = PetscStrcpy(path,fl->name);CHKERRQ(ierr);
595e5c89e4eSSatish Balay     }
596e5c89e4eSSatish Balay     ierr = PetscFListAdd(nl,path,fl->rname,fl->routine);CHKERRQ(ierr);
597e5c89e4eSSatish Balay     fl   = fl->next;
598e5c89e4eSSatish Balay   }
599e5c89e4eSSatish Balay   PetscFunctionReturn(0);
600e5c89e4eSSatish Balay }
601e5c89e4eSSatish Balay 
602e5c89e4eSSatish Balay 
603e5c89e4eSSatish Balay #undef __FUNCT__
604e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListConcat"
605e5c89e4eSSatish Balay /*
606e5c89e4eSSatish Balay     PetscFListConcat - joins name of a libary, and the path where it is located
607e5c89e4eSSatish Balay     into a single string.
608e5c89e4eSSatish Balay 
609e5c89e4eSSatish Balay     Input Parameters:
610e5c89e4eSSatish Balay .   path   - path to the library name.
611e5c89e4eSSatish Balay .   name   - name of the library
612e5c89e4eSSatish Balay 
613e5c89e4eSSatish Balay     Output Parameters:
614e5c89e4eSSatish Balay .   fullname - the name that is the union of the path and the library name,
615e5c89e4eSSatish Balay                delimited by a semicolon, i.e., path:name
616e5c89e4eSSatish Balay 
617e5c89e4eSSatish Balay     Notes:
618e5c89e4eSSatish Balay     If the path is NULL, assumes that the name, specified also includes
619e5c89e4eSSatish Balay     the path as path:name
620e5c89e4eSSatish Balay 
621e5c89e4eSSatish Balay */
6227087cfbeSBarry Smith PetscErrorCode  PetscFListConcat(const char path[],const char name[],char fullname[])
623e5c89e4eSSatish Balay {
624e5c89e4eSSatish Balay   PetscErrorCode ierr;
625e5c89e4eSSatish Balay   PetscFunctionBegin;
626e5c89e4eSSatish Balay   if (path) {
627e5c89e4eSSatish Balay     ierr = PetscStrcpy(fullname,path);CHKERRQ(ierr);
628e5c89e4eSSatish Balay     ierr = PetscStrcat(fullname,":");CHKERRQ(ierr);
629e5c89e4eSSatish Balay     ierr = PetscStrcat(fullname,name);CHKERRQ(ierr);
630e5c89e4eSSatish Balay   } else {
631e5c89e4eSSatish Balay     ierr = PetscStrcpy(fullname,name);CHKERRQ(ierr);
632e5c89e4eSSatish Balay   }
633e5c89e4eSSatish Balay   PetscFunctionReturn(0);
634e5c89e4eSSatish Balay }
635