xref: /petsc/src/sys/dll/reg.c (revision 3cc1e11d8f9fde4baf751b7ed00bff93d3fc59f1)
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 */
6e5c89e4eSSatish Balay #include "petsc.h"           /*I "petsc.h" I*/
7e5c89e4eSSatish Balay #include "petscsys.h"
8e5c89e4eSSatish Balay 
9e5c89e4eSSatish Balay #undef __FUNCT__
10e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListGetPathAndFunction"
11e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscFListGetPathAndFunction(const char name[],char *path[],char *function[])
12e5c89e4eSSatish Balay {
13e5c89e4eSSatish Balay   PetscErrorCode ierr;
14e5c89e4eSSatish Balay   char work[PETSC_MAX_PATH_LEN],*lfunction;
15e5c89e4eSSatish Balay 
16e5c89e4eSSatish Balay   PetscFunctionBegin;
17e5c89e4eSSatish Balay   ierr = PetscStrncpy(work,name,256);CHKERRQ(ierr);
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 
353fa76a5bSLisandro Dalcin 
36ebd79076SLisandro Dalcin #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
37ebd79076SLisandro Dalcin 
38e5c89e4eSSatish Balay #undef __FUNCT__
39487e5849SBarry Smith #define __FUNCT__ "PetscLoadDynamicLibrary"
40487e5849SBarry Smith static PetscErrorCode PETSC_DLLEXPORT PetscLoadDynamicLibrary(const char *name,PetscTruth *found)
41487e5849SBarry Smith {
42487e5849SBarry Smith   char           libs[PETSC_MAX_PATH_LEN],dlib[PETSC_MAX_PATH_LEN];
43487e5849SBarry Smith   PetscErrorCode ierr;
44487e5849SBarry Smith 
45487e5849SBarry Smith   PetscFunctionBegin;
46487e5849SBarry Smith   ierr = PetscStrcpy(libs,"${PETSC_LIB_DIR}/libpetsc");CHKERRQ(ierr);
47487e5849SBarry Smith   ierr = PetscStrcat(libs,name);CHKERRQ(ierr);
48487e5849SBarry Smith   ierr = PetscDLLibraryRetrieve(PETSC_COMM_WORLD,libs,dlib,1024,found);CHKERRQ(ierr);
49487e5849SBarry Smith   if (*found) {
50487e5849SBarry Smith     ierr = PetscDLLibraryAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,dlib);CHKERRQ(ierr);
51487e5849SBarry Smith   } else {
52487e5849SBarry Smith     ierr = PetscStrcpy(libs,"${PETSC_DIR}/${PETSC_ARCH}/lib/libpetsc");CHKERRQ(ierr);
53487e5849SBarry Smith     ierr = PetscStrcat(libs,name);CHKERRQ(ierr);
54487e5849SBarry Smith     ierr = PetscDLLibraryRetrieve(PETSC_COMM_WORLD,libs,dlib,1024,found);CHKERRQ(ierr);
55487e5849SBarry Smith     if (*found) {
56487e5849SBarry Smith       ierr = PetscDLLibraryAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,dlib);CHKERRQ(ierr);
57487e5849SBarry Smith     }
58487e5849SBarry Smith   }
59487e5849SBarry Smith   PetscFunctionReturn(0);
60487e5849SBarry Smith }
61487e5849SBarry Smith 
623fa76a5bSLisandro Dalcin #endif
633fa76a5bSLisandro Dalcin 
64487e5849SBarry Smith #undef __FUNCT__
65e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize_DynamicLibraries"
66e5c89e4eSSatish Balay /*
67e5c89e4eSSatish Balay     PetscInitialize_DynamicLibraries - Adds the default dynamic link libraries to the
68e5c89e4eSSatish Balay     search path.
69e5c89e4eSSatish Balay */
70e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscInitialize_DynamicLibraries(void)
71e5c89e4eSSatish Balay {
72487e5849SBarry Smith   char           *libname[32];
73e5c89e4eSSatish Balay   PetscErrorCode ierr;
74e5c89e4eSSatish Balay   PetscInt       nmax,i;
753fa76a5bSLisandro Dalcin #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
76e5c89e4eSSatish Balay   PetscTruth     found;
773fa76a5bSLisandro Dalcin #endif
78e5c89e4eSSatish Balay   PetscFunctionBegin;
79e5c89e4eSSatish Balay 
80e5c89e4eSSatish Balay   nmax = 32;
81e5c89e4eSSatish Balay   ierr = PetscOptionsGetStringArray(PETSC_NULL,"-dll_prepend",libname,&nmax,PETSC_NULL);CHKERRQ(ierr);
82e5c89e4eSSatish Balay   for (i=0; i<nmax; i++) {
83e5c89e4eSSatish Balay     ierr = PetscDLLibraryPrepend(PETSC_COMM_WORLD,&DLLibrariesLoaded,libname[i]);CHKERRQ(ierr);
84e5c89e4eSSatish Balay     ierr = PetscFree(libname[i]);CHKERRQ(ierr);
85e5c89e4eSSatish Balay   }
86e5c89e4eSSatish Balay 
873fa76a5bSLisandro Dalcin #if !defined(PETSC_USE_DYNAMIC_LIBRARIES)
883fa76a5bSLisandro Dalcin   /*
893fa76a5bSLisandro Dalcin       This just initializes the most basic PETSc stuff.
903fa76a5bSLisandro Dalcin 
913fa76a5bSLisandro Dalcin     The classes, from PetscDraw to PetscTS, are initialized the first
923fa76a5bSLisandro Dalcin     time an XXCreate() is called.
933fa76a5bSLisandro Dalcin   */
943fa76a5bSLisandro Dalcin   ierr = PetscInitializePackage(PETSC_NULL);CHKERRQ(ierr);
953fa76a5bSLisandro Dalcin #else
96487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("",&found);CHKERRQ(ierr);
97487e5849SBarry Smith   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc dynamic library \n You cannot move the dynamic libraries!");
98bb84e0fdSBarry Smith #if !defined(PETSC_USE_SINGLE_LIBRARY)
99487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("vec",&found);CHKERRQ(ierr);
1005a0ac93eSMatthew Knepley   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc Vec dynamic library \n You cannot move the dynamic libraries!");
101487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("mat",&found);CHKERRQ(ierr);
1025a0ac93eSMatthew Knepley   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc Mat dynamic library \n You cannot move the dynamic libraries!");
103487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("dm",&found);CHKERRQ(ierr);
1045a0ac93eSMatthew Knepley   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc DM dynamic library \n You cannot move the dynamic libraries!");
105487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("ksp",&found);CHKERRQ(ierr);
1065a0ac93eSMatthew Knepley   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc KSP dynamic library \n You cannot move the dynamic libraries!");
107487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("snes",&found);CHKERRQ(ierr);
1085a0ac93eSMatthew Knepley   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc SNES dynamic library \n You cannot move the dynamic libraries!");
109487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("ts",&found);CHKERRQ(ierr);
1105a0ac93eSMatthew Knepley   if (!found) SETERRQ(PETSC_ERR_FILE_OPEN,"Unable to locate PETSc TS dynamic library \n You cannot move the dynamic libraries!");
111bb84e0fdSBarry Smith #endif
112e5c89e4eSSatish Balay 
113487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("mesh",&found);CHKERRQ(ierr);
114487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("contrib",&found);CHKERRQ(ierr);
1153fa76a5bSLisandro Dalcin #endif
116e5c89e4eSSatish Balay 
117e5c89e4eSSatish Balay   nmax = 32;
118e5c89e4eSSatish Balay   ierr = PetscOptionsGetStringArray(PETSC_NULL,"-dll_append",libname,&nmax,PETSC_NULL);CHKERRQ(ierr);
119e5c89e4eSSatish Balay   for (i=0; i<nmax; i++) {
120e5c89e4eSSatish Balay     ierr = PetscDLLibraryAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,libname[i]);CHKERRQ(ierr);
121e5c89e4eSSatish Balay     ierr = PetscDLLibraryCCAAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,libname[i]);CHKERRQ(ierr);
122e5c89e4eSSatish Balay     ierr = PetscFree(libname[i]);CHKERRQ(ierr);
123e5c89e4eSSatish Balay   }
1243fa76a5bSLisandro Dalcin 
125e5c89e4eSSatish Balay   PetscFunctionReturn(0);
126e5c89e4eSSatish Balay }
127e5c89e4eSSatish Balay 
128e5c89e4eSSatish Balay #undef __FUNCT__
129e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize_DynamicLibraries"
130ebd79076SLisandro Dalcin /*
131ebd79076SLisandro Dalcin      PetscFinalize_DynamicLibraries - Closes the opened dynamic libraries.
132ebd79076SLisandro Dalcin */
133e5c89e4eSSatish Balay PetscErrorCode PetscFinalize_DynamicLibraries(void)
134e5c89e4eSSatish Balay {
135ebd79076SLisandro Dalcin   PetscErrorCode ierr;
13690d69ab7SBarry Smith   PetscTruth     flg = PETSC_FALSE;
137e5c89e4eSSatish Balay 
138ebd79076SLisandro Dalcin   PetscFunctionBegin;
13990d69ab7SBarry Smith   ierr = PetscOptionsGetTruth(PETSC_NULL,"-dll_view",&flg,PETSC_NULL);CHKERRQ(ierr);
1405673baf8SLisandro Dalcin   if (flg) { ierr = PetscDLLibraryPrintPath(DLLibrariesLoaded);CHKERRQ(ierr); }
1410f31fb7fSLisandro Dalcin   ierr = PetscDLLibraryClose(DLLibrariesLoaded);CHKERRQ(ierr);
1420f31fb7fSLisandro Dalcin   DLLibrariesLoaded = 0;
143e5c89e4eSSatish Balay   PetscFunctionReturn(0);
144e5c89e4eSSatish Balay }
145e5c89e4eSSatish Balay 
146e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
1472bb46157SSatish Balay struct _n_PetscFList {
148e5c89e4eSSatish Balay   void        (*routine)(void);   /* the routine */
149e5c89e4eSSatish Balay   char        *path;              /* path of link library containing routine */
150e5c89e4eSSatish Balay   char        *name;              /* string to identify routine */
151e5c89e4eSSatish Balay   char        *rname;             /* routine name in dynamic library */
152e5c89e4eSSatish Balay   PetscFList  next;               /* next pointer */
153e5c89e4eSSatish Balay   PetscFList  next_list;          /* used to maintain list of all lists for freeing */
154e5c89e4eSSatish Balay };
155e5c89e4eSSatish Balay 
156e5c89e4eSSatish Balay /*
157e5c89e4eSSatish Balay      Keep a linked list of PetscFLists so that we can destroy all the left-over ones.
158e5c89e4eSSatish Balay */
159e5c89e4eSSatish Balay static PetscFList   dlallhead = 0;
160e5c89e4eSSatish Balay 
161e5c89e4eSSatish Balay #undef __FUNCT__
162e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListAdd"
163e5c89e4eSSatish Balay /*@C
164e5c89e4eSSatish Balay    PetscFListAddDynamic - Given a routine and a string id, saves that routine in the
165e5c89e4eSSatish Balay    specified registry.
166e5c89e4eSSatish Balay 
167e5c89e4eSSatish Balay      Not Collective
168e5c89e4eSSatish Balay 
169e5c89e4eSSatish Balay    Input Parameters:
170e5c89e4eSSatish Balay +  fl    - pointer registry
171e5c89e4eSSatish Balay .  name  - string to identify routine
172e5c89e4eSSatish Balay .  rname - routine name in dynamic library
173e5c89e4eSSatish Balay -  fnc   - function pointer (optional if using dynamic libraries)
174e5c89e4eSSatish Balay 
175e5c89e4eSSatish Balay    Notes:
176e5c89e4eSSatish Balay    To remove a registered routine, pass in a PETSC_NULL rname and fnc().
177e5c89e4eSSatish Balay 
178e5c89e4eSSatish Balay    Users who wish to register new classes for use by a particular PETSc
179e5c89e4eSSatish Balay    component (e.g., SNES) should generally call the registration routine
180e5c89e4eSSatish Balay    for that particular component (e.g., SNESRegisterDynamic()) instead of
181e5c89e4eSSatish Balay    calling PetscFListAddDynamic() directly.
182e5c89e4eSSatish Balay 
183e5c89e4eSSatish Balay    ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, or ${any environmental variable}
184e5c89e4eSSatish Balay   occuring in pathname will be replaced with appropriate values.
185e5c89e4eSSatish Balay 
186e5c89e4eSSatish Balay    Level: developer
187e5c89e4eSSatish Balay 
188e5c89e4eSSatish Balay .seealso: PetscFListDestroy(), SNESRegisterDynamic(), KSPRegisterDynamic(),
189e5c89e4eSSatish Balay           PCRegisterDynamic(), TSRegisterDynamic(), PetscFList
190e5c89e4eSSatish Balay @*/
191e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscFListAdd(PetscFList *fl,const char name[],const char rname[],void (*fnc)(void))
192e5c89e4eSSatish Balay {
193e5c89e4eSSatish Balay   PetscFList     entry,ne;
194e5c89e4eSSatish Balay   PetscErrorCode ierr;
195e5c89e4eSSatish Balay   char           *fpath,*fname;
196e5c89e4eSSatish Balay 
197e5c89e4eSSatish Balay   PetscFunctionBegin;
198e5c89e4eSSatish Balay 
199e5c89e4eSSatish Balay   if (!*fl) {
2002bb46157SSatish Balay     ierr           = PetscNew(struct _n_PetscFList,&entry);CHKERRQ(ierr);
201e5c89e4eSSatish Balay     ierr           = PetscStrallocpy(name,&entry->name);CHKERRQ(ierr);
202e5c89e4eSSatish Balay     ierr           = PetscFListGetPathAndFunction(rname,&fpath,&fname);CHKERRQ(ierr);
203e5c89e4eSSatish Balay     entry->path    = fpath;
204e5c89e4eSSatish Balay     entry->rname   = fname;
205e5c89e4eSSatish Balay     entry->routine = fnc;
206e5c89e4eSSatish Balay     entry->next    = 0;
207e5c89e4eSSatish Balay     *fl = entry;
208e5c89e4eSSatish Balay 
209e5c89e4eSSatish Balay     /* add this new list to list of all lists */
210e5c89e4eSSatish Balay     if (!dlallhead) {
211e5c89e4eSSatish Balay       dlallhead        = *fl;
212e5c89e4eSSatish Balay       (*fl)->next_list = 0;
213e5c89e4eSSatish Balay     } else {
214e5c89e4eSSatish Balay       ne               = dlallhead;
215e5c89e4eSSatish Balay       dlallhead        = *fl;
216e5c89e4eSSatish Balay       (*fl)->next_list = ne;
217e5c89e4eSSatish Balay     }
218e5c89e4eSSatish Balay   } else {
219e5c89e4eSSatish Balay     /* search list to see if it is already there */
220e5c89e4eSSatish Balay     ne = *fl;
221e5c89e4eSSatish Balay     while (ne) {
222e5c89e4eSSatish Balay       PetscTruth founddup;
223e5c89e4eSSatish Balay 
224e5c89e4eSSatish Balay       ierr = PetscStrcmp(ne->name,name,&founddup);CHKERRQ(ierr);
225e5c89e4eSSatish Balay       if (founddup) { /* found duplicate */
226e5c89e4eSSatish Balay         ierr = PetscFListGetPathAndFunction(rname,&fpath,&fname);CHKERRQ(ierr);
227e5c89e4eSSatish Balay         ierr = PetscStrfree(ne->path);CHKERRQ(ierr);
228e5c89e4eSSatish Balay         ierr = PetscStrfree(ne->rname);CHKERRQ(ierr);
229e5c89e4eSSatish Balay         ne->path    = fpath;
230e5c89e4eSSatish Balay         ne->rname   = fname;
231e5c89e4eSSatish Balay         ne->routine = fnc;
232e5c89e4eSSatish Balay         PetscFunctionReturn(0);
233e5c89e4eSSatish Balay       }
234e5c89e4eSSatish Balay       if (ne->next) ne = ne->next; else break;
235e5c89e4eSSatish Balay     }
236e5c89e4eSSatish Balay     /* create new entry and add to end of list */
2372bb46157SSatish Balay     ierr           = PetscNew(struct _n_PetscFList,&entry);CHKERRQ(ierr);
238e5c89e4eSSatish Balay     ierr           = PetscStrallocpy(name,&entry->name);CHKERRQ(ierr);
239e5c89e4eSSatish Balay     ierr           = PetscFListGetPathAndFunction(rname,&fpath,&fname);CHKERRQ(ierr);
240e5c89e4eSSatish Balay     entry->path    = fpath;
241e5c89e4eSSatish Balay     entry->rname   = fname;
242e5c89e4eSSatish Balay     entry->routine = fnc;
243e5c89e4eSSatish Balay     entry->next    = 0;
244e5c89e4eSSatish Balay     ne->next       = entry;
245e5c89e4eSSatish Balay   }
246e5c89e4eSSatish Balay 
247e5c89e4eSSatish Balay   PetscFunctionReturn(0);
248e5c89e4eSSatish Balay }
249e5c89e4eSSatish Balay 
250e5c89e4eSSatish Balay #undef __FUNCT__
251e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListDestroy"
252e5c89e4eSSatish Balay /*@
253e5c89e4eSSatish Balay     PetscFListDestroy - Destroys a list of registered routines.
254e5c89e4eSSatish Balay 
255e5c89e4eSSatish Balay     Input Parameter:
256e5c89e4eSSatish Balay .   fl  - pointer to list
257e5c89e4eSSatish Balay 
258e5c89e4eSSatish Balay     Level: developer
259e5c89e4eSSatish Balay 
260e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFList
261e5c89e4eSSatish Balay @*/
2621441b1d3SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscFListDestroy(PetscFList *fl)
263e5c89e4eSSatish Balay {
264e5c89e4eSSatish Balay   PetscFList     next,entry,tmp = dlallhead;
265e5c89e4eSSatish Balay   PetscErrorCode ierr;
266e5c89e4eSSatish Balay 
267e5c89e4eSSatish Balay   PetscFunctionBegin;
2681441b1d3SBarry Smith   CHKMEMQ;
2691441b1d3SBarry Smith   if (!*fl) PetscFunctionReturn(0);
270e5c89e4eSSatish Balay 
271e5c89e4eSSatish Balay   if (!dlallhead) {
272e5c89e4eSSatish Balay     PetscFunctionReturn(0);
273e5c89e4eSSatish Balay   }
274e5c89e4eSSatish Balay 
275e5c89e4eSSatish Balay   /*
276e5c89e4eSSatish Balay        Remove this entry from the master DL list (if it is in it)
277e5c89e4eSSatish Balay   */
2781441b1d3SBarry Smith   if (dlallhead == *fl) {
279e5c89e4eSSatish Balay     if (dlallhead->next_list) {
280e5c89e4eSSatish Balay       dlallhead = dlallhead->next_list;
281e5c89e4eSSatish Balay     } else {
282e5c89e4eSSatish Balay       dlallhead = 0;
283e5c89e4eSSatish Balay     }
284e5c89e4eSSatish Balay   } else {
2851441b1d3SBarry Smith     while (tmp->next_list != *fl) {
286e5c89e4eSSatish Balay       tmp = tmp->next_list;
287e5c89e4eSSatish Balay       if (!tmp->next_list) break;
288e5c89e4eSSatish Balay     }
289e5c89e4eSSatish Balay     if (tmp->next_list) tmp->next_list = tmp->next_list->next_list;
290e5c89e4eSSatish Balay   }
291e5c89e4eSSatish Balay 
292e5c89e4eSSatish Balay   /* free this list */
2931441b1d3SBarry Smith   entry = *fl;
294e5c89e4eSSatish Balay   while (entry) {
295e5c89e4eSSatish Balay     next = entry->next;
296e5c89e4eSSatish Balay     ierr = PetscStrfree(entry->path);CHKERRQ(ierr);
297e5c89e4eSSatish Balay     ierr = PetscFree(entry->name);CHKERRQ(ierr);
298e5c89e4eSSatish Balay     ierr = PetscFree(entry->rname);CHKERRQ(ierr);
299e5c89e4eSSatish Balay     ierr = PetscFree(entry);CHKERRQ(ierr);
300e5c89e4eSSatish Balay     entry = next;
301e5c89e4eSSatish Balay   }
3021441b1d3SBarry Smith   *fl = 0;
303e5c89e4eSSatish Balay   PetscFunctionReturn(0);
304e5c89e4eSSatish Balay }
305e5c89e4eSSatish Balay 
306e5c89e4eSSatish Balay /*
307e5c89e4eSSatish Balay    Destroys all the function lists that anyone has every registered, such as KSPList, VecList, etc.
308e5c89e4eSSatish Balay */
309e5c89e4eSSatish Balay #undef __FUNCT__
310e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListDestroyAll"
311e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscFListDestroyAll(void)
312e5c89e4eSSatish Balay {
313e5c89e4eSSatish Balay   PetscFList     tmp2,tmp1 = dlallhead;
314e5c89e4eSSatish Balay   PetscErrorCode ierr;
315e5c89e4eSSatish Balay 
316e5c89e4eSSatish Balay   PetscFunctionBegin;
317e5c89e4eSSatish Balay   while (tmp1) {
318e5c89e4eSSatish Balay     tmp2 = tmp1->next_list;
3191441b1d3SBarry Smith     ierr = PetscFListDestroy(&tmp1);CHKERRQ(ierr);
320e5c89e4eSSatish Balay     tmp1 = tmp2;
321e5c89e4eSSatish Balay   }
322e5c89e4eSSatish Balay   dlallhead = 0;
323e5c89e4eSSatish Balay   PetscFunctionReturn(0);
324e5c89e4eSSatish Balay }
325e5c89e4eSSatish Balay 
326e5c89e4eSSatish Balay #undef __FUNCT__
327e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListFind"
328e5c89e4eSSatish Balay /*@C
329e5c89e4eSSatish Balay     PetscFListFind - Given a name, finds the matching routine.
330e5c89e4eSSatish Balay 
331e5c89e4eSSatish Balay     Input Parameters:
3321d280d73SBarry Smith +   fl   - pointer to list
3331d280d73SBarry Smith .   comm - processors looking for routine
334e5c89e4eSSatish Balay -   name - name string
335e5c89e4eSSatish Balay 
336e5c89e4eSSatish Balay     Output Parameters:
337e5c89e4eSSatish Balay .   r - the routine
338e5c89e4eSSatish Balay 
339e5c89e4eSSatish Balay     Level: developer
340e5c89e4eSSatish Balay 
341e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFList
342e5c89e4eSSatish Balay @*/
3431d280d73SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscFListFind(PetscFList fl,MPI_Comm comm,const char name[],void (**r)(void))
344e5c89e4eSSatish Balay {
345e5c89e4eSSatish Balay   PetscFList     entry = fl;
346e5c89e4eSSatish Balay   PetscErrorCode ierr;
347e5c89e4eSSatish Balay   char           *function,*path;
348e5c89e4eSSatish Balay #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
349e5c89e4eSSatish Balay   char           *newpath;
350e5c89e4eSSatish Balay #endif
351e5c89e4eSSatish Balay   PetscTruth   flg,f1,f2,f3;
352e5c89e4eSSatish Balay 
353e5c89e4eSSatish Balay   PetscFunctionBegin;
354e5c89e4eSSatish Balay   if (!name) SETERRQ(PETSC_ERR_ARG_NULL,"Trying to find routine with null name");
355e5c89e4eSSatish Balay 
356e5c89e4eSSatish Balay   *r = 0;
357e5c89e4eSSatish Balay   ierr = PetscFListGetPathAndFunction(name,&path,&function);CHKERRQ(ierr);
358e5c89e4eSSatish Balay 
359e5c89e4eSSatish Balay   /*
360e5c89e4eSSatish Balay         If path then append it to search libraries
361e5c89e4eSSatish Balay   */
362e5c89e4eSSatish Balay #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
363e5c89e4eSSatish Balay   if (path) {
364e5c89e4eSSatish Balay     ierr = PetscDLLibraryAppend(comm,&DLLibrariesLoaded,path);CHKERRQ(ierr);
365e5c89e4eSSatish Balay   }
366e5c89e4eSSatish Balay #endif
367e5c89e4eSSatish Balay 
368e5c89e4eSSatish Balay   while (entry) {
369e5c89e4eSSatish Balay     flg = PETSC_FALSE;
370e5c89e4eSSatish Balay     if (path && entry->path) {
371e5c89e4eSSatish Balay       ierr = PetscStrcmp(path,entry->path,&f1);CHKERRQ(ierr);
372e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->rname,&f2);CHKERRQ(ierr);
373e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->name,&f3);CHKERRQ(ierr);
374e5c89e4eSSatish Balay       flg =  (PetscTruth) ((f1 && f2) || (f1 && f3));
375e5c89e4eSSatish Balay     } else if (!path) {
376e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->name,&f1);CHKERRQ(ierr);
377e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->rname,&f2);CHKERRQ(ierr);
378e5c89e4eSSatish Balay       flg =  (PetscTruth) (f1 || f2);
379e5c89e4eSSatish Balay     } else {
380e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->name,&flg);CHKERRQ(ierr);
381e5c89e4eSSatish Balay       if (flg) {
382e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
383e5c89e4eSSatish Balay         ierr = PetscStrallocpy(entry->rname,&function);CHKERRQ(ierr);
384e5c89e4eSSatish Balay       } else {
385e5c89e4eSSatish Balay         ierr = PetscStrcmp(function,entry->rname,&flg);CHKERRQ(ierr);
386e5c89e4eSSatish Balay       }
387e5c89e4eSSatish Balay     }
388e5c89e4eSSatish Balay 
389e5c89e4eSSatish Balay     if (flg) {
390e5c89e4eSSatish Balay 
391e5c89e4eSSatish Balay       if (entry->routine) {
392e5c89e4eSSatish Balay         *r   = entry->routine;
393e5c89e4eSSatish Balay         ierr = PetscStrfree(path);CHKERRQ(ierr);
394e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
395e5c89e4eSSatish Balay         PetscFunctionReturn(0);
396e5c89e4eSSatish Balay       }
397e5c89e4eSSatish Balay 
398e5c89e4eSSatish Balay       if ((path && entry->path && f3) || (!path && f1)) { /* convert name of function (alias) to actual function name */
399e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
400e5c89e4eSSatish Balay         ierr = PetscStrallocpy(entry->rname,&function);CHKERRQ(ierr);
401e5c89e4eSSatish Balay       }
402e5c89e4eSSatish Balay 
403e5c89e4eSSatish Balay       /* it is not yet in memory so load from dynamic library */
404e5c89e4eSSatish Balay #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
405e5c89e4eSSatish Balay       newpath = path;
406e5c89e4eSSatish Balay       if (!path) newpath = entry->path;
407e5c89e4eSSatish Balay       ierr = PetscDLLibrarySym(comm,&DLLibrariesLoaded,newpath,entry->rname,(void **)r);CHKERRQ(ierr);
408e5c89e4eSSatish Balay       if (*r) {
409e5c89e4eSSatish Balay         entry->routine = *r;
410e5c89e4eSSatish Balay         ierr = PetscStrfree(path);CHKERRQ(ierr);
411e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
412e5c89e4eSSatish Balay         PetscFunctionReturn(0);
413e5c89e4eSSatish Balay       } else {
4145673baf8SLisandro Dalcin         PetscErrorPrintf("Unable to find function. Search path:\n");
4155673baf8SLisandro Dalcin         ierr = PetscDLLibraryPrintPath(DLLibrariesLoaded);CHKERRQ(ierr);
416e5c89e4eSSatish Balay         SETERRQ1(PETSC_ERR_PLIB,"Unable to find function:%s: either it is mis-spelled or dynamic library is not in path",entry->rname);
417e5c89e4eSSatish Balay       }
418e5c89e4eSSatish Balay #endif
419e5c89e4eSSatish Balay     }
420e5c89e4eSSatish Balay     entry = entry->next;
421e5c89e4eSSatish Balay   }
422e5c89e4eSSatish Balay 
423e5c89e4eSSatish Balay #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
424e5c89e4eSSatish Balay   /* Function never registered; try for it anyway */
425e5c89e4eSSatish Balay   ierr = PetscDLLibrarySym(comm,&DLLibrariesLoaded,path,function,(void **)r);CHKERRQ(ierr);
426e5c89e4eSSatish Balay   ierr = PetscStrfree(path);CHKERRQ(ierr);
427e5c89e4eSSatish Balay   if (*r) {
428e5c89e4eSSatish Balay     ierr = PetscFListAdd(&fl,name,name,*r);CHKERRQ(ierr);
429e5c89e4eSSatish Balay   }
430e5c89e4eSSatish Balay #endif
431e5c89e4eSSatish Balay   ierr = PetscFree(function);CHKERRQ(ierr);
432e5c89e4eSSatish Balay   PetscFunctionReturn(0);
433e5c89e4eSSatish Balay }
434e5c89e4eSSatish Balay 
435e5c89e4eSSatish Balay #undef __FUNCT__
436e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListView"
437e5c89e4eSSatish Balay /*@
438e5c89e4eSSatish Balay    PetscFListView - prints out contents of an PetscFList
439e5c89e4eSSatish Balay 
440e5c89e4eSSatish Balay    Collective over MPI_Comm
441e5c89e4eSSatish Balay 
442e5c89e4eSSatish Balay    Input Parameters:
443e5c89e4eSSatish Balay +  list - the list of functions
444e5c89e4eSSatish Balay -  viewer - currently ignored
445e5c89e4eSSatish Balay 
446e5c89e4eSSatish Balay    Level: developer
447e5c89e4eSSatish Balay 
448e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFListPrintTypes(), PetscFList
449e5c89e4eSSatish Balay @*/
450e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscFListView(PetscFList list,PetscViewer viewer)
451e5c89e4eSSatish Balay {
452e5c89e4eSSatish Balay   PetscErrorCode ierr;
453e5c89e4eSSatish Balay   PetscTruth     iascii;
454e5c89e4eSSatish Balay 
455e5c89e4eSSatish Balay   PetscFunctionBegin;
456e5c89e4eSSatish Balay   if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF;
457e5c89e4eSSatish Balay   PetscValidPointer(list,1);
458e5c89e4eSSatish Balay   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_COOKIE,2);
459e5c89e4eSSatish Balay 
460e5c89e4eSSatish Balay   ierr = PetscTypeCompare((PetscObject)viewer,PETSC_VIEWER_ASCII,&iascii);CHKERRQ(ierr);
461e5c89e4eSSatish Balay   if (!iascii) SETERRQ(PETSC_ERR_SUP,"Only ASCII viewer supported");
462e5c89e4eSSatish Balay 
463e5c89e4eSSatish Balay   while (list) {
464e5c89e4eSSatish Balay     if (list->path) {
465e5c89e4eSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer," %s %s %s\n",list->path,list->name,list->rname);CHKERRQ(ierr);
466e5c89e4eSSatish Balay     } else {
467e5c89e4eSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer," %s %s\n",list->name,list->rname);CHKERRQ(ierr);
468e5c89e4eSSatish Balay     }
469e5c89e4eSSatish Balay     list = list->next;
470e5c89e4eSSatish Balay   }
471e5c89e4eSSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
472e5c89e4eSSatish Balay   PetscFunctionReturn(0);
473e5c89e4eSSatish Balay }
474e5c89e4eSSatish Balay 
475e5c89e4eSSatish Balay #undef __FUNCT__
476e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListGet"
477e5c89e4eSSatish Balay /*@
478e5c89e4eSSatish Balay    PetscFListGet - Gets an array the contains the entries in PetscFList, this is used
479e5c89e4eSSatish Balay          by help etc.
480e5c89e4eSSatish Balay 
481e5c89e4eSSatish Balay    Collective over MPI_Comm
482e5c89e4eSSatish Balay 
483e5c89e4eSSatish Balay    Input Parameter:
484e5c89e4eSSatish Balay .  list   - list of types
485e5c89e4eSSatish Balay 
486e5c89e4eSSatish Balay    Output Parameter:
487e5c89e4eSSatish Balay +  array - array of names
488e5c89e4eSSatish Balay -  n - length of array
489e5c89e4eSSatish Balay 
490e5c89e4eSSatish Balay    Notes:
491e5c89e4eSSatish Balay        This allocates the array so that must be freed. BUT the individual entries are
492e5c89e4eSSatish Balay     not copied so should not be freed.
493e5c89e4eSSatish Balay 
494e5c89e4eSSatish Balay    Level: developer
495e5c89e4eSSatish Balay 
496e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFList
497e5c89e4eSSatish Balay @*/
498e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscFListGet(PetscFList list,char ***array,int *n)
499e5c89e4eSSatish Balay {
500e5c89e4eSSatish Balay   PetscErrorCode ierr;
501e5c89e4eSSatish Balay   PetscInt       count = 0;
502e5c89e4eSSatish Balay   PetscFList     klist = list;
503e5c89e4eSSatish Balay 
504e5c89e4eSSatish Balay   PetscFunctionBegin;
505e5c89e4eSSatish Balay   while (list) {
506e5c89e4eSSatish Balay     list = list->next;
507e5c89e4eSSatish Balay     count++;
508e5c89e4eSSatish Balay   }
509e5c89e4eSSatish Balay   ierr  = PetscMalloc((count+1)*sizeof(char *),array);CHKERRQ(ierr);
510e5c89e4eSSatish Balay   count = 0;
511e5c89e4eSSatish Balay   while (klist) {
512e5c89e4eSSatish Balay     (*array)[count] = klist->name;
513e5c89e4eSSatish Balay     klist = klist->next;
514e5c89e4eSSatish Balay     count++;
515e5c89e4eSSatish Balay   }
516e5c89e4eSSatish Balay   (*array)[count] = 0;
517e5c89e4eSSatish Balay   *n = count+1;
518e5c89e4eSSatish Balay   PetscFunctionReturn(0);
519e5c89e4eSSatish Balay }
520e5c89e4eSSatish Balay 
521e5c89e4eSSatish Balay 
522e5c89e4eSSatish Balay #undef __FUNCT__
523e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListPrintTypes"
524e5c89e4eSSatish Balay /*@C
525e5c89e4eSSatish Balay    PetscFListPrintTypes - Prints the methods available.
526e5c89e4eSSatish Balay 
527e5c89e4eSSatish Balay    Collective over MPI_Comm
528e5c89e4eSSatish Balay 
529e5c89e4eSSatish Balay    Input Parameters:
530e5c89e4eSSatish Balay +  comm   - the communicator (usually MPI_COMM_WORLD)
531e5c89e4eSSatish Balay .  fd     - file to print to, usually stdout
532e5c89e4eSSatish Balay .  prefix - prefix to prepend to name (optional)
533e5c89e4eSSatish Balay .  name   - option string (for example, "-ksp_type")
534e5c89e4eSSatish Balay .  text - short description of the object (for example, "Krylov solvers")
535e5c89e4eSSatish Balay .  man - name of manual page that discusses the object (for example, "KSPCreate")
536*3cc1e11dSBarry Smith .  list   - list of types
537*3cc1e11dSBarry Smith -  def - default (current) value
538e5c89e4eSSatish Balay 
539e5c89e4eSSatish Balay    Level: developer
540e5c89e4eSSatish Balay 
541e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFList
542e5c89e4eSSatish Balay @*/
543*3cc1e11dSBarry 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[])
544e5c89e4eSSatish Balay {
545e5c89e4eSSatish Balay   PetscErrorCode ierr;
546e5c89e4eSSatish Balay   PetscInt       count = 0;
547e5c89e4eSSatish Balay   char           p[64];
548e5c89e4eSSatish Balay 
549e5c89e4eSSatish Balay   PetscFunctionBegin;
550da9f1d6bSBarry Smith   if (!fd) fd = PETSC_STDOUT;
551e5c89e4eSSatish Balay 
552e5c89e4eSSatish Balay   ierr = PetscStrcpy(p,"-");CHKERRQ(ierr);
553e5c89e4eSSatish Balay   if (prefix) {ierr = PetscStrcat(p,prefix);CHKERRQ(ierr);}
554*3cc1e11dSBarry Smith   ierr = PetscFPrintf(comm,fd,"  %s%s <%s>: %s (one of)",p,name+1,def,text);CHKERRQ(ierr);
555e5c89e4eSSatish Balay 
556e5c89e4eSSatish Balay   while (list) {
557e5c89e4eSSatish Balay     ierr = PetscFPrintf(comm,fd," %s",list->name);CHKERRQ(ierr);
558e5c89e4eSSatish Balay     list = list->next;
559e5c89e4eSSatish Balay     count++;
560e5c89e4eSSatish Balay     if (count == 8) {ierr = PetscFPrintf(comm,fd,"\n     ");CHKERRQ(ierr);}
561e5c89e4eSSatish Balay   }
562e5c89e4eSSatish Balay   ierr = PetscFPrintf(comm,fd," (%s)\n",man);CHKERRQ(ierr);
563e5c89e4eSSatish Balay   PetscFunctionReturn(0);
564e5c89e4eSSatish Balay }
565e5c89e4eSSatish Balay 
566e5c89e4eSSatish Balay #undef __FUNCT__
567e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListDuplicate"
568e5c89e4eSSatish Balay /*@
569e5c89e4eSSatish Balay     PetscFListDuplicate - Creates a new list from a given object list.
570e5c89e4eSSatish Balay 
571e5c89e4eSSatish Balay     Input Parameters:
572e5c89e4eSSatish Balay .   fl   - pointer to list
573e5c89e4eSSatish Balay 
574e5c89e4eSSatish Balay     Output Parameters:
575e5c89e4eSSatish Balay .   nl - the new list (should point to 0 to start, otherwise appends)
576e5c89e4eSSatish Balay 
577e5c89e4eSSatish Balay     Level: developer
578e5c89e4eSSatish Balay 
579e5c89e4eSSatish Balay .seealso: PetscFList, PetscFListAdd(), PetscFlistDestroy()
580e5c89e4eSSatish Balay 
581e5c89e4eSSatish Balay @*/
582e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscFListDuplicate(PetscFList fl,PetscFList *nl)
583e5c89e4eSSatish Balay {
584e5c89e4eSSatish Balay   PetscErrorCode ierr;
585e5c89e4eSSatish Balay   char           path[PETSC_MAX_PATH_LEN];
586e5c89e4eSSatish Balay 
587e5c89e4eSSatish Balay   PetscFunctionBegin;
588e5c89e4eSSatish Balay   while (fl) {
589e5c89e4eSSatish Balay     /* this is silly, rebuild the complete pathname */
590e5c89e4eSSatish Balay     if (fl->path) {
591e5c89e4eSSatish Balay       ierr = PetscStrcpy(path,fl->path);CHKERRQ(ierr);
592e5c89e4eSSatish Balay       ierr = PetscStrcat(path,":");CHKERRQ(ierr);
593e5c89e4eSSatish Balay       ierr = PetscStrcat(path,fl->name);CHKERRQ(ierr);
594e5c89e4eSSatish Balay     } else {
595e5c89e4eSSatish Balay       ierr = PetscStrcpy(path,fl->name);CHKERRQ(ierr);
596e5c89e4eSSatish Balay     }
597e5c89e4eSSatish Balay     ierr = PetscFListAdd(nl,path,fl->rname,fl->routine);CHKERRQ(ierr);
598e5c89e4eSSatish Balay     fl   = fl->next;
599e5c89e4eSSatish Balay   }
600e5c89e4eSSatish Balay   PetscFunctionReturn(0);
601e5c89e4eSSatish Balay }
602e5c89e4eSSatish Balay 
603e5c89e4eSSatish Balay 
604e5c89e4eSSatish Balay #undef __FUNCT__
605e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListConcat"
606e5c89e4eSSatish Balay /*
607e5c89e4eSSatish Balay     PetscFListConcat - joins name of a libary, and the path where it is located
608e5c89e4eSSatish Balay     into a single string.
609e5c89e4eSSatish Balay 
610e5c89e4eSSatish Balay     Input Parameters:
611e5c89e4eSSatish Balay .   path   - path to the library name.
612e5c89e4eSSatish Balay .   name   - name of the library
613e5c89e4eSSatish Balay 
614e5c89e4eSSatish Balay     Output Parameters:
615e5c89e4eSSatish Balay .   fullname - the name that is the union of the path and the library name,
616e5c89e4eSSatish Balay                delimited by a semicolon, i.e., path:name
617e5c89e4eSSatish Balay 
618e5c89e4eSSatish Balay     Notes:
619e5c89e4eSSatish Balay     If the path is NULL, assumes that the name, specified also includes
620e5c89e4eSSatish Balay     the path as path:name
621e5c89e4eSSatish Balay 
622e5c89e4eSSatish Balay */
623e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscFListConcat(const char path[],const char name[],char fullname[])
624e5c89e4eSSatish Balay {
625e5c89e4eSSatish Balay   PetscErrorCode ierr;
626e5c89e4eSSatish Balay   PetscFunctionBegin;
627e5c89e4eSSatish Balay   if (path) {
628e5c89e4eSSatish Balay     ierr = PetscStrcpy(fullname,path);CHKERRQ(ierr);
629e5c89e4eSSatish Balay     ierr = PetscStrcat(fullname,":");CHKERRQ(ierr);
630e5c89e4eSSatish Balay     ierr = PetscStrcat(fullname,name);CHKERRQ(ierr);
631e5c89e4eSSatish Balay   } else {
632e5c89e4eSSatish Balay     ierr = PetscStrcpy(fullname,name);CHKERRQ(ierr);
633e5c89e4eSSatish Balay   }
634e5c89e4eSSatish Balay   PetscFunctionReturn(0);
635e5c89e4eSSatish Balay }
636