xref: /petsc/src/sys/dll/reg.c (revision 0700a8246d308f50502909ba325e6169d3ee27eb)
1e5c89e4eSSatish Balay #define PETSC_DLL
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 */
6d382aafbSBarry Smith #include "petscsys.h"           /*I "petscsys.h" I*/
7e5c89e4eSSatish Balay 
8e5c89e4eSSatish Balay #undef __FUNCT__
9e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListGetPathAndFunction"
10e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT 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;
16e5c89e4eSSatish Balay   ierr = PetscStrncpy(work,name,256);CHKERRQ(ierr);
17e5c89e4eSSatish Balay   ierr = PetscStrchr(work,':',&lfunction);CHKERRQ(ierr);
18e5c89e4eSSatish Balay   if (lfunction != work && lfunction && lfunction[1] != ':') {
19e5c89e4eSSatish Balay     lfunction[0] = 0;
20e5c89e4eSSatish Balay     ierr = PetscStrallocpy(work,path);CHKERRQ(ierr);
21e5c89e4eSSatish Balay     ierr = PetscStrallocpy(lfunction+1,function);CHKERRQ(ierr);
22e5c89e4eSSatish Balay   } else {
23e5c89e4eSSatish Balay     *path = 0;
24e5c89e4eSSatish Balay     ierr = PetscStrallocpy(name,function);CHKERRQ(ierr);
25e5c89e4eSSatish Balay   }
26e5c89e4eSSatish Balay   PetscFunctionReturn(0);
27e5c89e4eSSatish Balay }
28e5c89e4eSSatish Balay 
293fa76a5bSLisandro Dalcin /*
303fa76a5bSLisandro Dalcin     This is the default list used by PETSc with the PetscDLLibrary register routines
313fa76a5bSLisandro Dalcin */
323fa76a5bSLisandro Dalcin PetscDLLibrary DLLibrariesLoaded = 0;
333fa76a5bSLisandro Dalcin 
343fa76a5bSLisandro Dalcin 
35ebd79076SLisandro Dalcin #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
36ebd79076SLisandro Dalcin 
37e5c89e4eSSatish Balay #undef __FUNCT__
38487e5849SBarry Smith #define __FUNCT__ "PetscLoadDynamicLibrary"
39487e5849SBarry Smith static PetscErrorCode PETSC_DLLEXPORT PetscLoadDynamicLibrary(const char *name,PetscTruth *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 */
69e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT 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)
75e5c89e4eSSatish Balay   PetscTruth     found;
763fa76a5bSLisandro Dalcin #endif
77e5c89e4eSSatish Balay   PetscFunctionBegin;
78e5c89e4eSSatish Balay 
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   */
933fa76a5bSLisandro Dalcin   ierr = PetscInitializePackage(PETSC_NULL);CHKERRQ(ierr);
943fa76a5bSLisandro Dalcin #else
95487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("",&found);CHKERRQ(ierr);
96487e5849SBarry Smith   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc dynamic library \n You cannot move the dynamic libraries!");
97bb84e0fdSBarry Smith #if !defined(PETSC_USE_SINGLE_LIBRARY)
98487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("vec",&found);CHKERRQ(ierr);
995a0ac93eSMatthew Knepley   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc Vec dynamic library \n You cannot move the dynamic libraries!");
100487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("mat",&found);CHKERRQ(ierr);
1015a0ac93eSMatthew Knepley   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc Mat dynamic library \n You cannot move the dynamic libraries!");
102487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("dm",&found);CHKERRQ(ierr);
1035a0ac93eSMatthew Knepley   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc DM dynamic library \n You cannot move the dynamic libraries!");
104487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("ksp",&found);CHKERRQ(ierr);
1055a0ac93eSMatthew Knepley   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc KSP dynamic library \n You cannot move the dynamic libraries!");
106487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("snes",&found);CHKERRQ(ierr);
1075a0ac93eSMatthew Knepley   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc SNES dynamic library \n You cannot move the dynamic libraries!");
108487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("ts",&found);CHKERRQ(ierr);
1095a0ac93eSMatthew Knepley   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc TS dynamic library \n You cannot move the dynamic libraries!");
110bb84e0fdSBarry Smith #endif
111e5c89e4eSSatish Balay 
112487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("mesh",&found);CHKERRQ(ierr);
113487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("contrib",&found);CHKERRQ(ierr);
1143fa76a5bSLisandro Dalcin #endif
115e5c89e4eSSatish Balay 
116e5c89e4eSSatish Balay   nmax = 32;
117e5c89e4eSSatish Balay   ierr = PetscOptionsGetStringArray(PETSC_NULL,"-dll_append",libname,&nmax,PETSC_NULL);CHKERRQ(ierr);
118e5c89e4eSSatish Balay   for (i=0; i<nmax; i++) {
119e5c89e4eSSatish Balay     ierr = PetscDLLibraryAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,libname[i]);CHKERRQ(ierr);
120e5c89e4eSSatish Balay     ierr = PetscDLLibraryCCAAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,libname[i]);CHKERRQ(ierr);
121e5c89e4eSSatish Balay     ierr = PetscFree(libname[i]);CHKERRQ(ierr);
122e5c89e4eSSatish Balay   }
1233fa76a5bSLisandro Dalcin 
124e5c89e4eSSatish Balay   PetscFunctionReturn(0);
125e5c89e4eSSatish Balay }
126e5c89e4eSSatish Balay 
127e5c89e4eSSatish Balay #undef __FUNCT__
128e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize_DynamicLibraries"
129ebd79076SLisandro Dalcin /*
130ebd79076SLisandro Dalcin      PetscFinalize_DynamicLibraries - Closes the opened dynamic libraries.
131ebd79076SLisandro Dalcin */
132e5c89e4eSSatish Balay PetscErrorCode PetscFinalize_DynamicLibraries(void)
133e5c89e4eSSatish Balay {
134ebd79076SLisandro Dalcin   PetscErrorCode ierr;
13590d69ab7SBarry Smith   PetscTruth     flg = PETSC_FALSE;
136e5c89e4eSSatish Balay 
137ebd79076SLisandro Dalcin   PetscFunctionBegin;
13890d69ab7SBarry Smith   ierr = PetscOptionsGetTruth(PETSC_NULL,"-dll_view",&flg,PETSC_NULL);CHKERRQ(ierr);
1395673baf8SLisandro Dalcin   if (flg) { ierr = PetscDLLibraryPrintPath(DLLibrariesLoaded);CHKERRQ(ierr); }
1400f31fb7fSLisandro Dalcin   ierr = PetscDLLibraryClose(DLLibrariesLoaded);CHKERRQ(ierr);
1410f31fb7fSLisandro Dalcin   DLLibrariesLoaded = 0;
142e5c89e4eSSatish Balay   PetscFunctionReturn(0);
143e5c89e4eSSatish Balay }
144e5c89e4eSSatish Balay 
145e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
1462bb46157SSatish Balay struct _n_PetscFList {
147e5c89e4eSSatish Balay   void        (*routine)(void);   /* the routine */
148e5c89e4eSSatish Balay   char        *path;              /* path of link library containing routine */
149e5c89e4eSSatish Balay   char        *name;              /* string to identify routine */
150e5c89e4eSSatish Balay   char        *rname;             /* routine name in dynamic library */
151e5c89e4eSSatish Balay   PetscFList  next;               /* next pointer */
152e5c89e4eSSatish Balay   PetscFList  next_list;          /* used to maintain list of all lists for freeing */
153e5c89e4eSSatish Balay };
154e5c89e4eSSatish Balay 
155e5c89e4eSSatish Balay /*
156e5c89e4eSSatish Balay      Keep a linked list of PetscFLists so that we can destroy all the left-over ones.
157e5c89e4eSSatish Balay */
158e5c89e4eSSatish Balay static PetscFList   dlallhead = 0;
159e5c89e4eSSatish Balay 
160e5c89e4eSSatish Balay #undef __FUNCT__
161e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListAdd"
162e5c89e4eSSatish Balay /*@C
163e5c89e4eSSatish Balay    PetscFListAddDynamic - Given a routine and a string id, saves that routine in the
164e5c89e4eSSatish Balay    specified registry.
165e5c89e4eSSatish Balay 
166e5c89e4eSSatish Balay      Not Collective
167e5c89e4eSSatish Balay 
168e5c89e4eSSatish Balay    Input Parameters:
169e5c89e4eSSatish Balay +  fl    - pointer registry
170e5c89e4eSSatish Balay .  name  - string to identify routine
171e5c89e4eSSatish Balay .  rname - routine name in dynamic library
172e5c89e4eSSatish Balay -  fnc   - function pointer (optional if using dynamic libraries)
173e5c89e4eSSatish Balay 
174e5c89e4eSSatish Balay    Notes:
175e5c89e4eSSatish Balay    To remove a registered routine, pass in a PETSC_NULL rname and fnc().
176e5c89e4eSSatish Balay 
177e5c89e4eSSatish Balay    Users who wish to register new classes for use by a particular PETSc
178e5c89e4eSSatish Balay    component (e.g., SNES) should generally call the registration routine
179e5c89e4eSSatish Balay    for that particular component (e.g., SNESRegisterDynamic()) instead of
180e5c89e4eSSatish Balay    calling PetscFListAddDynamic() directly.
181e5c89e4eSSatish Balay 
182e5c89e4eSSatish Balay    ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, or ${any environmental variable}
183e5c89e4eSSatish Balay   occuring in pathname will be replaced with appropriate values.
184e5c89e4eSSatish Balay 
185e5c89e4eSSatish Balay    Level: developer
186e5c89e4eSSatish Balay 
187e5c89e4eSSatish Balay .seealso: PetscFListDestroy(), SNESRegisterDynamic(), KSPRegisterDynamic(),
188e5c89e4eSSatish Balay           PCRegisterDynamic(), TSRegisterDynamic(), PetscFList
189e5c89e4eSSatish Balay @*/
190e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscFListAdd(PetscFList *fl,const char name[],const char rname[],void (*fnc)(void))
191e5c89e4eSSatish Balay {
192e5c89e4eSSatish Balay   PetscFList     entry,ne;
193e5c89e4eSSatish Balay   PetscErrorCode ierr;
194e5c89e4eSSatish Balay   char           *fpath,*fname;
195e5c89e4eSSatish Balay 
196e5c89e4eSSatish Balay   PetscFunctionBegin;
197e5c89e4eSSatish Balay 
198e5c89e4eSSatish Balay   if (!*fl) {
1992bb46157SSatish Balay     ierr           = PetscNew(struct _n_PetscFList,&entry);CHKERRQ(ierr);
200e5c89e4eSSatish Balay     ierr           = PetscStrallocpy(name,&entry->name);CHKERRQ(ierr);
201e5c89e4eSSatish Balay     ierr           = PetscFListGetPathAndFunction(rname,&fpath,&fname);CHKERRQ(ierr);
202e5c89e4eSSatish Balay     entry->path    = fpath;
203e5c89e4eSSatish Balay     entry->rname   = fname;
204e5c89e4eSSatish Balay     entry->routine = fnc;
205e5c89e4eSSatish Balay     entry->next    = 0;
206e5c89e4eSSatish Balay     *fl = entry;
207e5c89e4eSSatish Balay 
208e5c89e4eSSatish Balay     /* add this new list to list of all lists */
209e5c89e4eSSatish Balay     if (!dlallhead) {
210e5c89e4eSSatish Balay       dlallhead        = *fl;
211e5c89e4eSSatish Balay       (*fl)->next_list = 0;
212e5c89e4eSSatish Balay     } else {
213e5c89e4eSSatish Balay       ne               = dlallhead;
214e5c89e4eSSatish Balay       dlallhead        = *fl;
215e5c89e4eSSatish Balay       (*fl)->next_list = ne;
216e5c89e4eSSatish Balay     }
217e5c89e4eSSatish Balay   } else {
218e5c89e4eSSatish Balay     /* search list to see if it is already there */
219e5c89e4eSSatish Balay     ne = *fl;
220e5c89e4eSSatish Balay     while (ne) {
221e5c89e4eSSatish Balay       PetscTruth founddup;
222e5c89e4eSSatish Balay 
223e5c89e4eSSatish Balay       ierr = PetscStrcmp(ne->name,name,&founddup);CHKERRQ(ierr);
224e5c89e4eSSatish Balay       if (founddup) { /* found duplicate */
225e5c89e4eSSatish Balay         ierr = PetscFListGetPathAndFunction(rname,&fpath,&fname);CHKERRQ(ierr);
226e5c89e4eSSatish Balay         ierr = PetscStrfree(ne->path);CHKERRQ(ierr);
227e5c89e4eSSatish Balay         ierr = PetscStrfree(ne->rname);CHKERRQ(ierr);
228e5c89e4eSSatish Balay         ne->path    = fpath;
229e5c89e4eSSatish Balay         ne->rname   = fname;
230e5c89e4eSSatish Balay         ne->routine = fnc;
231e5c89e4eSSatish Balay         PetscFunctionReturn(0);
232e5c89e4eSSatish Balay       }
233e5c89e4eSSatish Balay       if (ne->next) ne = ne->next; else break;
234e5c89e4eSSatish Balay     }
235e5c89e4eSSatish Balay     /* create new entry and add to end of list */
2362bb46157SSatish Balay     ierr           = PetscNew(struct _n_PetscFList,&entry);CHKERRQ(ierr);
237e5c89e4eSSatish Balay     ierr           = PetscStrallocpy(name,&entry->name);CHKERRQ(ierr);
238e5c89e4eSSatish Balay     ierr           = PetscFListGetPathAndFunction(rname,&fpath,&fname);CHKERRQ(ierr);
239e5c89e4eSSatish Balay     entry->path    = fpath;
240e5c89e4eSSatish Balay     entry->rname   = fname;
241e5c89e4eSSatish Balay     entry->routine = fnc;
242e5c89e4eSSatish Balay     entry->next    = 0;
243e5c89e4eSSatish Balay     ne->next       = entry;
244e5c89e4eSSatish Balay   }
245e5c89e4eSSatish Balay 
246e5c89e4eSSatish Balay   PetscFunctionReturn(0);
247e5c89e4eSSatish Balay }
248e5c89e4eSSatish Balay 
249e5c89e4eSSatish Balay #undef __FUNCT__
250e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListDestroy"
251e5c89e4eSSatish Balay /*@
252e5c89e4eSSatish Balay     PetscFListDestroy - Destroys a list of registered routines.
253e5c89e4eSSatish Balay 
254e5c89e4eSSatish Balay     Input Parameter:
255e5c89e4eSSatish Balay .   fl  - pointer to list
256e5c89e4eSSatish Balay 
257e5c89e4eSSatish Balay     Level: developer
258e5c89e4eSSatish Balay 
259e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFList
260e5c89e4eSSatish Balay @*/
2611441b1d3SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscFListDestroy(PetscFList *fl)
262e5c89e4eSSatish Balay {
263e5c89e4eSSatish Balay   PetscFList     next,entry,tmp = dlallhead;
264e5c89e4eSSatish Balay   PetscErrorCode ierr;
265e5c89e4eSSatish Balay 
266e5c89e4eSSatish Balay   PetscFunctionBegin;
2671441b1d3SBarry Smith   CHKMEMQ;
2681441b1d3SBarry Smith   if (!*fl) PetscFunctionReturn(0);
269e5c89e4eSSatish Balay 
270e5c89e4eSSatish Balay   if (!dlallhead) {
271e5c89e4eSSatish Balay     PetscFunctionReturn(0);
272e5c89e4eSSatish Balay   }
273e5c89e4eSSatish Balay 
274e5c89e4eSSatish Balay   /*
275e5c89e4eSSatish Balay        Remove this entry from the master DL list (if it is in it)
276e5c89e4eSSatish Balay   */
2771441b1d3SBarry Smith   if (dlallhead == *fl) {
278e5c89e4eSSatish Balay     if (dlallhead->next_list) {
279e5c89e4eSSatish Balay       dlallhead = dlallhead->next_list;
280e5c89e4eSSatish Balay     } else {
281e5c89e4eSSatish Balay       dlallhead = 0;
282e5c89e4eSSatish Balay     }
283e5c89e4eSSatish Balay   } else {
2841441b1d3SBarry Smith     while (tmp->next_list != *fl) {
285e5c89e4eSSatish Balay       tmp = tmp->next_list;
286e5c89e4eSSatish Balay       if (!tmp->next_list) break;
287e5c89e4eSSatish Balay     }
288e5c89e4eSSatish Balay     if (tmp->next_list) tmp->next_list = tmp->next_list->next_list;
289e5c89e4eSSatish Balay   }
290e5c89e4eSSatish Balay 
291e5c89e4eSSatish Balay   /* free this list */
2921441b1d3SBarry Smith   entry = *fl;
293e5c89e4eSSatish Balay   while (entry) {
294e5c89e4eSSatish Balay     next = entry->next;
295e5c89e4eSSatish Balay     ierr = PetscStrfree(entry->path);CHKERRQ(ierr);
296e5c89e4eSSatish Balay     ierr = PetscFree(entry->name);CHKERRQ(ierr);
297e5c89e4eSSatish Balay     ierr = PetscFree(entry->rname);CHKERRQ(ierr);
298e5c89e4eSSatish Balay     ierr = PetscFree(entry);CHKERRQ(ierr);
299e5c89e4eSSatish Balay     entry = next;
300e5c89e4eSSatish Balay   }
3011441b1d3SBarry Smith   *fl = 0;
302e5c89e4eSSatish Balay   PetscFunctionReturn(0);
303e5c89e4eSSatish Balay }
304e5c89e4eSSatish Balay 
305e5c89e4eSSatish Balay /*
306e5c89e4eSSatish Balay    Destroys all the function lists that anyone has every registered, such as KSPList, VecList, etc.
307e5c89e4eSSatish Balay */
308e5c89e4eSSatish Balay #undef __FUNCT__
309e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListDestroyAll"
310e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscFListDestroyAll(void)
311e5c89e4eSSatish Balay {
312e5c89e4eSSatish Balay   PetscFList     tmp2,tmp1 = dlallhead;
313e5c89e4eSSatish Balay   PetscErrorCode ierr;
314e5c89e4eSSatish Balay 
315e5c89e4eSSatish Balay   PetscFunctionBegin;
316e5c89e4eSSatish Balay   while (tmp1) {
317e5c89e4eSSatish Balay     tmp2 = tmp1->next_list;
3181441b1d3SBarry Smith     ierr = PetscFListDestroy(&tmp1);CHKERRQ(ierr);
319e5c89e4eSSatish Balay     tmp1 = tmp2;
320e5c89e4eSSatish Balay   }
321e5c89e4eSSatish Balay   dlallhead = 0;
322e5c89e4eSSatish Balay   PetscFunctionReturn(0);
323e5c89e4eSSatish Balay }
324e5c89e4eSSatish Balay 
325e5c89e4eSSatish Balay #undef __FUNCT__
326e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListFind"
327e5c89e4eSSatish Balay /*@C
328e5c89e4eSSatish Balay     PetscFListFind - Given a name, finds the matching routine.
329e5c89e4eSSatish Balay 
330e5c89e4eSSatish Balay     Input Parameters:
3311d280d73SBarry Smith +   fl   - pointer to list
3321d280d73SBarry Smith .   comm - processors looking for routine
333e5c89e4eSSatish Balay -   name - name string
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 @*/
3421d280d73SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscFListFind(PetscFList fl,MPI_Comm comm,const char name[],void (**r)(void))
343e5c89e4eSSatish Balay {
344e5c89e4eSSatish Balay   PetscFList     entry = fl;
345e5c89e4eSSatish Balay   PetscErrorCode ierr;
346e5c89e4eSSatish Balay   char           *function,*path;
347e5c89e4eSSatish Balay #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
348e5c89e4eSSatish Balay   char           *newpath;
349e5c89e4eSSatish Balay #endif
350e5c89e4eSSatish Balay   PetscTruth   flg,f1,f2,f3;
351e5c89e4eSSatish Balay 
352e5c89e4eSSatish Balay   PetscFunctionBegin;
353e5c89e4eSSatish Balay   if (!name) SETERRQ(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   */
361e5c89e4eSSatish Balay #if defined(PETSC_USE_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);
373e5c89e4eSSatish Balay       flg =  (PetscTruth) ((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);
377e5c89e4eSSatish Balay       flg =  (PetscTruth) (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 
390e5c89e4eSSatish Balay       if (entry->routine) {
391e5c89e4eSSatish Balay         *r   = entry->routine;
392e5c89e4eSSatish Balay         ierr = PetscStrfree(path);CHKERRQ(ierr);
393e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
394e5c89e4eSSatish Balay         PetscFunctionReturn(0);
395e5c89e4eSSatish Balay       }
396e5c89e4eSSatish Balay 
397e5c89e4eSSatish Balay       if ((path && entry->path && f3) || (!path && f1)) { /* convert name of function (alias) to actual function name */
398e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
399e5c89e4eSSatish Balay         ierr = PetscStrallocpy(entry->rname,&function);CHKERRQ(ierr);
400e5c89e4eSSatish Balay       }
401e5c89e4eSSatish Balay 
402e5c89e4eSSatish Balay       /* it is not yet in memory so load from dynamic library */
403e5c89e4eSSatish Balay #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
404e5c89e4eSSatish Balay       newpath = path;
405e5c89e4eSSatish Balay       if (!path) newpath = entry->path;
406e5c89e4eSSatish Balay       ierr = PetscDLLibrarySym(comm,&DLLibrariesLoaded,newpath,entry->rname,(void **)r);CHKERRQ(ierr);
407e5c89e4eSSatish Balay       if (*r) {
408e5c89e4eSSatish Balay         entry->routine = *r;
409e5c89e4eSSatish Balay         ierr = PetscStrfree(path);CHKERRQ(ierr);
410e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
411e5c89e4eSSatish Balay         PetscFunctionReturn(0);
412e5c89e4eSSatish Balay       } else {
4135673baf8SLisandro Dalcin         PetscErrorPrintf("Unable to find function. Search path:\n");
4145673baf8SLisandro Dalcin         ierr = PetscDLLibraryPrintPath(DLLibrariesLoaded);CHKERRQ(ierr);
415e5c89e4eSSatish Balay         SETERRQ1(PETSC_ERR_PLIB,"Unable to find function:%s: either it is mis-spelled or dynamic library is not in path",entry->rname);
416e5c89e4eSSatish Balay       }
417e5c89e4eSSatish Balay #endif
418e5c89e4eSSatish Balay     }
419e5c89e4eSSatish Balay     entry = entry->next;
420e5c89e4eSSatish Balay   }
421e5c89e4eSSatish Balay 
422e5c89e4eSSatish Balay #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
423e5c89e4eSSatish Balay   /* Function never registered; try for it anyway */
424e5c89e4eSSatish Balay   ierr = PetscDLLibrarySym(comm,&DLLibrariesLoaded,path,function,(void **)r);CHKERRQ(ierr);
425e5c89e4eSSatish Balay   ierr = PetscStrfree(path);CHKERRQ(ierr);
426e5c89e4eSSatish Balay   if (*r) {
427e5c89e4eSSatish Balay     ierr = PetscFListAdd(&fl,name,name,*r);CHKERRQ(ierr);
428e5c89e4eSSatish Balay   }
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 @*/
449e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscFListView(PetscFList list,PetscViewer viewer)
450e5c89e4eSSatish Balay {
451e5c89e4eSSatish Balay   PetscErrorCode ierr;
452e5c89e4eSSatish Balay   PetscTruth     iascii;
453e5c89e4eSSatish Balay 
454e5c89e4eSSatish Balay   PetscFunctionBegin;
455e5c89e4eSSatish Balay   if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF;
456e5c89e4eSSatish Balay   PetscValidPointer(list,1);
457*0700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
458e5c89e4eSSatish Balay 
459e5c89e4eSSatish Balay   ierr = PetscTypeCompare((PetscObject)viewer,PETSC_VIEWER_ASCII,&iascii);CHKERRQ(ierr);
460e5c89e4eSSatish Balay   if (!iascii) SETERRQ(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 @*/
497e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT 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 @*/
5423cc1e11dSBarry Smith PetscErrorCode PETSC_DLLEXPORT 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 @*/
581e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT 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 */
622e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT 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