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