xref: /petsc/src/sys/dll/reg.c (revision 7d0a6c19129e7069c8a40e210b34ed62989173db)
1*7d0a6c19SBarry Smith 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay     Provides a general mechanism to allow one to register new routines in
4e5c89e4eSSatish Balay     dynamic libraries for many of the PETSc objects (including, e.g., KSP and PC).
5e5c89e4eSSatish Balay */
6d382aafbSBarry Smith #include "petscsys.h"           /*I "petscsys.h" I*/
7e5c89e4eSSatish Balay 
8e5c89e4eSSatish Balay #undef __FUNCT__
9e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListGetPathAndFunction"
107087cfbeSBarry Smith PetscErrorCode  PetscFListGetPathAndFunction(const char name[],char *path[],char *function[])
11e5c89e4eSSatish Balay {
12e5c89e4eSSatish Balay   PetscErrorCode ierr;
13e5c89e4eSSatish Balay   char           work[PETSC_MAX_PATH_LEN],*lfunction;
14e5c89e4eSSatish Balay 
15e5c89e4eSSatish Balay   PetscFunctionBegin;
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 
34ebd79076SLisandro Dalcin #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
35ebd79076SLisandro Dalcin 
36e5c89e4eSSatish Balay #undef __FUNCT__
37487e5849SBarry Smith #define __FUNCT__ "PetscLoadDynamicLibrary"
387087cfbeSBarry Smith static PetscErrorCode  PetscLoadDynamicLibrary(const char *name,PetscBool  *found)
39487e5849SBarry Smith {
40487e5849SBarry Smith   char           libs[PETSC_MAX_PATH_LEN],dlib[PETSC_MAX_PATH_LEN];
41487e5849SBarry Smith   PetscErrorCode ierr;
42487e5849SBarry Smith 
43487e5849SBarry Smith   PetscFunctionBegin;
44487e5849SBarry Smith   ierr = PetscStrcpy(libs,"${PETSC_LIB_DIR}/libpetsc");CHKERRQ(ierr);
45487e5849SBarry Smith   ierr = PetscStrcat(libs,name);CHKERRQ(ierr);
46487e5849SBarry Smith   ierr = PetscDLLibraryRetrieve(PETSC_COMM_WORLD,libs,dlib,1024,found);CHKERRQ(ierr);
47487e5849SBarry Smith   if (*found) {
48487e5849SBarry Smith     ierr = PetscDLLibraryAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,dlib);CHKERRQ(ierr);
49487e5849SBarry Smith   } else {
50487e5849SBarry Smith     ierr = PetscStrcpy(libs,"${PETSC_DIR}/${PETSC_ARCH}/lib/libpetsc");CHKERRQ(ierr);
51487e5849SBarry Smith     ierr = PetscStrcat(libs,name);CHKERRQ(ierr);
52487e5849SBarry Smith     ierr = PetscDLLibraryRetrieve(PETSC_COMM_WORLD,libs,dlib,1024,found);CHKERRQ(ierr);
53487e5849SBarry Smith     if (*found) {
54487e5849SBarry Smith       ierr = PetscDLLibraryAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,dlib);CHKERRQ(ierr);
55487e5849SBarry Smith     }
56487e5849SBarry Smith   }
57487e5849SBarry Smith   PetscFunctionReturn(0);
58487e5849SBarry Smith }
59487e5849SBarry Smith 
603fa76a5bSLisandro Dalcin #endif
613fa76a5bSLisandro Dalcin 
62487e5849SBarry Smith #undef __FUNCT__
63e5c89e4eSSatish Balay #define __FUNCT__ "PetscInitialize_DynamicLibraries"
64e5c89e4eSSatish Balay /*
65e5c89e4eSSatish Balay     PetscInitialize_DynamicLibraries - Adds the default dynamic link libraries to the
66e5c89e4eSSatish Balay     search path.
67e5c89e4eSSatish Balay */
687087cfbeSBarry Smith PetscErrorCode  PetscInitialize_DynamicLibraries(void)
69e5c89e4eSSatish Balay {
70487e5849SBarry Smith   char           *libname[32];
71e5c89e4eSSatish Balay   PetscErrorCode ierr;
72e5c89e4eSSatish Balay   PetscInt       nmax,i;
733fa76a5bSLisandro Dalcin #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
74ace3abfcSBarry Smith   PetscBool      found;
753fa76a5bSLisandro Dalcin #endif
76e5c89e4eSSatish Balay 
7760154eb2SBarry Smith   PetscFunctionBegin;
78e5c89e4eSSatish Balay   nmax = 32;
79e5c89e4eSSatish Balay   ierr = PetscOptionsGetStringArray(PETSC_NULL,"-dll_prepend",libname,&nmax,PETSC_NULL);CHKERRQ(ierr);
80e5c89e4eSSatish Balay   for (i=0; i<nmax; i++) {
81e5c89e4eSSatish Balay     ierr = PetscDLLibraryPrepend(PETSC_COMM_WORLD,&DLLibrariesLoaded,libname[i]);CHKERRQ(ierr);
82e5c89e4eSSatish Balay     ierr = PetscFree(libname[i]);CHKERRQ(ierr);
83e5c89e4eSSatish Balay   }
84e5c89e4eSSatish Balay 
853fa76a5bSLisandro Dalcin #if !defined(PETSC_USE_DYNAMIC_LIBRARIES)
863fa76a5bSLisandro Dalcin   /*
873fa76a5bSLisandro Dalcin       This just initializes the most basic PETSc stuff.
883fa76a5bSLisandro Dalcin 
893fa76a5bSLisandro Dalcin     The classes, from PetscDraw to PetscTS, are initialized the first
903fa76a5bSLisandro Dalcin     time an XXCreate() is called.
913fa76a5bSLisandro Dalcin   */
9260154eb2SBarry Smith   ierr = PetscSysInitializePackage(PETSC_NULL);CHKERRQ(ierr);
933fa76a5bSLisandro Dalcin #else
9460154eb2SBarry Smith #if defined(PETSC_USE_SINGLE_LIBRARY)
95487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("",&found);CHKERRQ(ierr);
96e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc dynamic library \n You cannot move the dynamic libraries!");
9760154eb2SBarry Smith #else
9860154eb2SBarry Smith   ierr = PetscLoadDynamicLibrary("sys",&found);CHKERRQ(ierr);
9960154eb2SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc dynamic library \n You cannot move the dynamic libraries!");
100487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("vec",&found);CHKERRQ(ierr);
101e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc Vec dynamic library \n You cannot move the dynamic libraries!");
102487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("mat",&found);CHKERRQ(ierr);
103e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc Mat dynamic library \n You cannot move the dynamic libraries!");
104487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("dm",&found);CHKERRQ(ierr);
105e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc DM dynamic library \n You cannot move the dynamic libraries!");
10660154eb2SBarry Smith   ierr = PetscLoadDynamicLibrary("characteristic",&found);CHKERRQ(ierr);
10760154eb2SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc Characteristic dynamic library \n You cannot move the dynamic libraries!");
108487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("ksp",&found);CHKERRQ(ierr);
109e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc KSP dynamic library \n You cannot move the dynamic libraries!");
110487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("snes",&found);CHKERRQ(ierr);
111e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc SNES dynamic library \n You cannot move the dynamic libraries!");
112487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("ts",&found);CHKERRQ(ierr);
113e32f2f54SBarry Smith   if (!found) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to locate PETSc TS dynamic library \n You cannot move the dynamic libraries!");
114bb84e0fdSBarry Smith #endif
115e5c89e4eSSatish Balay 
116487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("mesh",&found);CHKERRQ(ierr);
117487e5849SBarry Smith   ierr = PetscLoadDynamicLibrary("contrib",&found);CHKERRQ(ierr);
1183fa76a5bSLisandro Dalcin #endif
119e5c89e4eSSatish Balay 
120e5c89e4eSSatish Balay   nmax = 32;
121e5c89e4eSSatish Balay   ierr = PetscOptionsGetStringArray(PETSC_NULL,"-dll_append",libname,&nmax,PETSC_NULL);CHKERRQ(ierr);
122e5c89e4eSSatish Balay   for (i=0; i<nmax; i++) {
123e5c89e4eSSatish Balay     ierr = PetscDLLibraryAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,libname[i]);CHKERRQ(ierr);
124e5c89e4eSSatish Balay     ierr = PetscDLLibraryCCAAppend(PETSC_COMM_WORLD,&DLLibrariesLoaded,libname[i]);CHKERRQ(ierr);
125e5c89e4eSSatish Balay     ierr = PetscFree(libname[i]);CHKERRQ(ierr);
126e5c89e4eSSatish Balay   }
1273fa76a5bSLisandro Dalcin 
128e5c89e4eSSatish Balay   PetscFunctionReturn(0);
129e5c89e4eSSatish Balay }
130e5c89e4eSSatish Balay 
131e5c89e4eSSatish Balay #undef __FUNCT__
132e5c89e4eSSatish Balay #define __FUNCT__ "PetscFinalize_DynamicLibraries"
133ebd79076SLisandro Dalcin /*
134ebd79076SLisandro Dalcin      PetscFinalize_DynamicLibraries - Closes the opened dynamic libraries.
135ebd79076SLisandro Dalcin */
136e5c89e4eSSatish Balay PetscErrorCode PetscFinalize_DynamicLibraries(void)
137e5c89e4eSSatish Balay {
138ebd79076SLisandro Dalcin   PetscErrorCode ierr;
139ace3abfcSBarry Smith   PetscBool      flg = PETSC_FALSE;
140e5c89e4eSSatish Balay 
141ebd79076SLisandro Dalcin   PetscFunctionBegin;
142acfcf0e5SJed Brown   ierr = PetscOptionsGetBool(PETSC_NULL,"-dll_view",&flg,PETSC_NULL);CHKERRQ(ierr);
1435673baf8SLisandro Dalcin   if (flg) { ierr = PetscDLLibraryPrintPath(DLLibrariesLoaded);CHKERRQ(ierr); }
1440f31fb7fSLisandro Dalcin   ierr = PetscDLLibraryClose(DLLibrariesLoaded);CHKERRQ(ierr);
1450f31fb7fSLisandro Dalcin   DLLibrariesLoaded = 0;
146e5c89e4eSSatish Balay   PetscFunctionReturn(0);
147e5c89e4eSSatish Balay }
148e5c89e4eSSatish Balay 
149e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
1502bb46157SSatish Balay struct _n_PetscFList {
151e5c89e4eSSatish Balay   void        (*routine)(void);   /* the routine */
152e5c89e4eSSatish Balay   char        *path;              /* path of link library containing routine */
153e5c89e4eSSatish Balay   char        *name;              /* string to identify routine */
154e5c89e4eSSatish Balay   char        *rname;             /* routine name in dynamic library */
155e5c89e4eSSatish Balay   PetscFList  next;               /* next pointer */
156e5c89e4eSSatish Balay   PetscFList  next_list;          /* used to maintain list of all lists for freeing */
157e5c89e4eSSatish Balay };
158e5c89e4eSSatish Balay 
159e5c89e4eSSatish Balay /*
160e5c89e4eSSatish Balay      Keep a linked list of PetscFLists so that we can destroy all the left-over ones.
161e5c89e4eSSatish Balay */
162e5c89e4eSSatish Balay static PetscFList   dlallhead = 0;
163e5c89e4eSSatish Balay 
164e5c89e4eSSatish Balay #undef __FUNCT__
165e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListAdd"
166e5c89e4eSSatish Balay /*@C
167e5c89e4eSSatish Balay    PetscFListAddDynamic - Given a routine and a string id, saves that routine in the
168e5c89e4eSSatish Balay    specified registry.
169e5c89e4eSSatish Balay 
170e5c89e4eSSatish Balay      Not Collective
171e5c89e4eSSatish Balay 
172e5c89e4eSSatish Balay    Input Parameters:
173e5c89e4eSSatish Balay +  fl    - pointer registry
174e5c89e4eSSatish Balay .  name  - string to identify routine
175e5c89e4eSSatish Balay .  rname - routine name in dynamic library
176e5c89e4eSSatish Balay -  fnc   - function pointer (optional if using dynamic libraries)
177e5c89e4eSSatish Balay 
178e5c89e4eSSatish Balay    Notes:
179e5c89e4eSSatish Balay    To remove a registered routine, pass in a PETSC_NULL rname and fnc().
180e5c89e4eSSatish Balay 
181e5c89e4eSSatish Balay    Users who wish to register new classes for use by a particular PETSc
182e5c89e4eSSatish Balay    component (e.g., SNES) should generally call the registration routine
183e5c89e4eSSatish Balay    for that particular component (e.g., SNESRegisterDynamic()) instead of
184e5c89e4eSSatish Balay    calling PetscFListAddDynamic() directly.
185e5c89e4eSSatish Balay 
186e5c89e4eSSatish Balay    ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, or ${any environmental variable}
187e5c89e4eSSatish Balay   occuring in pathname will be replaced with appropriate values.
188e5c89e4eSSatish Balay 
189e5c89e4eSSatish Balay    Level: developer
190e5c89e4eSSatish Balay 
191e5c89e4eSSatish Balay .seealso: PetscFListDestroy(), SNESRegisterDynamic(), KSPRegisterDynamic(),
192e5c89e4eSSatish Balay           PCRegisterDynamic(), TSRegisterDynamic(), PetscFList
193e5c89e4eSSatish Balay @*/
1947087cfbeSBarry Smith PetscErrorCode  PetscFListAdd(PetscFList *fl,const char name[],const char rname[],void (*fnc)(void))
195e5c89e4eSSatish Balay {
196e5c89e4eSSatish Balay   PetscFList     entry,ne;
197e5c89e4eSSatish Balay   PetscErrorCode ierr;
198e5c89e4eSSatish Balay   char           *fpath,*fname;
199e5c89e4eSSatish Balay 
200e5c89e4eSSatish Balay   PetscFunctionBegin;
201e5c89e4eSSatish Balay   if (!*fl) {
2022bb46157SSatish Balay     ierr           = PetscNew(struct _n_PetscFList,&entry);CHKERRQ(ierr);
203e5c89e4eSSatish Balay     ierr           = PetscStrallocpy(name,&entry->name);CHKERRQ(ierr);
204e5c89e4eSSatish Balay     ierr           = PetscFListGetPathAndFunction(rname,&fpath,&fname);CHKERRQ(ierr);
205e5c89e4eSSatish Balay     entry->path    = fpath;
206e5c89e4eSSatish Balay     entry->rname   = fname;
207e5c89e4eSSatish Balay     entry->routine = fnc;
208e5c89e4eSSatish Balay     entry->next    = 0;
209e5c89e4eSSatish Balay     *fl = entry;
210e5c89e4eSSatish Balay 
211e5c89e4eSSatish Balay     /* add this new list to list of all lists */
212e5c89e4eSSatish Balay     if (!dlallhead) {
213e5c89e4eSSatish Balay       dlallhead        = *fl;
214e5c89e4eSSatish Balay       (*fl)->next_list = 0;
215e5c89e4eSSatish Balay     } else {
216e5c89e4eSSatish Balay       ne               = dlallhead;
217e5c89e4eSSatish Balay       dlallhead        = *fl;
218e5c89e4eSSatish Balay       (*fl)->next_list = ne;
219e5c89e4eSSatish Balay     }
220e5c89e4eSSatish Balay   } else {
221e5c89e4eSSatish Balay     /* search list to see if it is already there */
222e5c89e4eSSatish Balay     ne = *fl;
223e5c89e4eSSatish Balay     while (ne) {
224ace3abfcSBarry Smith       PetscBool  founddup;
225e5c89e4eSSatish Balay 
226e5c89e4eSSatish Balay       ierr = PetscStrcmp(ne->name,name,&founddup);CHKERRQ(ierr);
227e5c89e4eSSatish Balay       if (founddup) { /* found duplicate */
228e5c89e4eSSatish Balay         ierr = PetscFListGetPathAndFunction(rname,&fpath,&fname);CHKERRQ(ierr);
229503cfb0cSBarry Smith         ierr = PetscFree(ne->path);CHKERRQ(ierr);
230503cfb0cSBarry Smith         ierr = PetscFree(ne->rname);CHKERRQ(ierr);
231e5c89e4eSSatish Balay         ne->path    = fpath;
232e5c89e4eSSatish Balay         ne->rname   = fname;
233e5c89e4eSSatish Balay         ne->routine = fnc;
234e5c89e4eSSatish Balay         PetscFunctionReturn(0);
235e5c89e4eSSatish Balay       }
236e5c89e4eSSatish Balay       if (ne->next) ne = ne->next; else break;
237e5c89e4eSSatish Balay     }
238e5c89e4eSSatish Balay     /* create new entry and add to end of list */
2392bb46157SSatish Balay     ierr           = PetscNew(struct _n_PetscFList,&entry);CHKERRQ(ierr);
240e5c89e4eSSatish Balay     ierr           = PetscStrallocpy(name,&entry->name);CHKERRQ(ierr);
241e5c89e4eSSatish Balay     ierr           = PetscFListGetPathAndFunction(rname,&fpath,&fname);CHKERRQ(ierr);
242e5c89e4eSSatish Balay     entry->path    = fpath;
243e5c89e4eSSatish Balay     entry->rname   = fname;
244e5c89e4eSSatish Balay     entry->routine = fnc;
245e5c89e4eSSatish Balay     entry->next    = 0;
246e5c89e4eSSatish Balay     ne->next       = entry;
247e5c89e4eSSatish Balay   }
248e5c89e4eSSatish Balay   PetscFunctionReturn(0);
249e5c89e4eSSatish Balay }
250e5c89e4eSSatish Balay 
251e5c89e4eSSatish Balay #undef __FUNCT__
252e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListDestroy"
253e5c89e4eSSatish Balay /*@
254e5c89e4eSSatish Balay     PetscFListDestroy - Destroys a list of registered routines.
255e5c89e4eSSatish Balay 
256e5c89e4eSSatish Balay     Input Parameter:
257e5c89e4eSSatish Balay .   fl  - pointer to list
258e5c89e4eSSatish Balay 
259e5c89e4eSSatish Balay     Level: developer
260e5c89e4eSSatish Balay 
261e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFList
262e5c89e4eSSatish Balay @*/
2637087cfbeSBarry Smith PetscErrorCode  PetscFListDestroy(PetscFList *fl)
264e5c89e4eSSatish Balay {
265e5c89e4eSSatish Balay   PetscFList     next,entry,tmp = dlallhead;
266e5c89e4eSSatish Balay   PetscErrorCode ierr;
267e5c89e4eSSatish Balay 
268e5c89e4eSSatish Balay   PetscFunctionBegin;
2691441b1d3SBarry Smith   if (!*fl) PetscFunctionReturn(0);
27060154eb2SBarry Smith   if (!dlallhead) PetscFunctionReturn(0);
271e5c89e4eSSatish Balay 
272e5c89e4eSSatish Balay   /*
273e5c89e4eSSatish Balay        Remove this entry from the master DL list (if it is in it)
274e5c89e4eSSatish Balay   */
2751441b1d3SBarry Smith   if (dlallhead == *fl) {
276e5c89e4eSSatish Balay     if (dlallhead->next_list) {
277e5c89e4eSSatish Balay       dlallhead = dlallhead->next_list;
278e5c89e4eSSatish Balay     } else {
279e5c89e4eSSatish Balay       dlallhead = 0;
280e5c89e4eSSatish Balay     }
281e5c89e4eSSatish Balay   } else {
2821441b1d3SBarry Smith     while (tmp->next_list != *fl) {
283e5c89e4eSSatish Balay       tmp = tmp->next_list;
284e5c89e4eSSatish Balay       if (!tmp->next_list) break;
285e5c89e4eSSatish Balay     }
286e5c89e4eSSatish Balay     if (tmp->next_list) tmp->next_list = tmp->next_list->next_list;
287e5c89e4eSSatish Balay   }
288e5c89e4eSSatish Balay 
289e5c89e4eSSatish Balay   /* free this list */
2901441b1d3SBarry Smith   entry = *fl;
291e5c89e4eSSatish Balay   while (entry) {
292e5c89e4eSSatish Balay     next = entry->next;
293503cfb0cSBarry Smith     ierr = PetscFree(entry->path);CHKERRQ(ierr);
294e5c89e4eSSatish Balay     ierr = PetscFree(entry->name);CHKERRQ(ierr);
295e5c89e4eSSatish Balay     ierr = PetscFree(entry->rname);CHKERRQ(ierr);
296e5c89e4eSSatish Balay     ierr = PetscFree(entry);CHKERRQ(ierr);
297e5c89e4eSSatish Balay     entry = next;
298e5c89e4eSSatish Balay   }
2991441b1d3SBarry Smith   *fl = 0;
300e5c89e4eSSatish Balay   PetscFunctionReturn(0);
301e5c89e4eSSatish Balay }
302e5c89e4eSSatish Balay 
303e5c89e4eSSatish Balay /*
304e5c89e4eSSatish Balay    Destroys all the function lists that anyone has every registered, such as KSPList, VecList, etc.
305e5c89e4eSSatish Balay */
306e5c89e4eSSatish Balay #undef __FUNCT__
307e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListDestroyAll"
3087087cfbeSBarry Smith PetscErrorCode  PetscFListDestroyAll(void)
309e5c89e4eSSatish Balay {
310e5c89e4eSSatish Balay   PetscFList     tmp2,tmp1 = dlallhead;
311e5c89e4eSSatish Balay   PetscErrorCode ierr;
312e5c89e4eSSatish Balay 
313e5c89e4eSSatish Balay   PetscFunctionBegin;
314e5c89e4eSSatish Balay   while (tmp1) {
315e5c89e4eSSatish Balay     tmp2 = tmp1->next_list;
3161441b1d3SBarry Smith     ierr = PetscFListDestroy(&tmp1);CHKERRQ(ierr);
317e5c89e4eSSatish Balay     tmp1 = tmp2;
318e5c89e4eSSatish Balay   }
319e5c89e4eSSatish Balay   dlallhead = 0;
320e5c89e4eSSatish Balay   PetscFunctionReturn(0);
321e5c89e4eSSatish Balay }
322e5c89e4eSSatish Balay 
323e5c89e4eSSatish Balay #undef __FUNCT__
324e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListFind"
325e5c89e4eSSatish Balay /*@C
326e5c89e4eSSatish Balay     PetscFListFind - Given a name, finds the matching routine.
327e5c89e4eSSatish Balay 
328e5c89e4eSSatish Balay     Input Parameters:
3291d280d73SBarry Smith +   fl   - pointer to list
3301d280d73SBarry Smith .   comm - processors looking for routine
331e5c89e4eSSatish Balay -   name - name string
332e5c89e4eSSatish Balay 
333e5c89e4eSSatish Balay     Output Parameters:
334e5c89e4eSSatish Balay .   r - the routine
335e5c89e4eSSatish Balay 
336e5c89e4eSSatish Balay     Level: developer
337e5c89e4eSSatish Balay 
338e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFList
339e5c89e4eSSatish Balay @*/
3407087cfbeSBarry Smith PetscErrorCode  PetscFListFind(PetscFList fl,MPI_Comm comm,const char name[],void (**r)(void))
341e5c89e4eSSatish Balay {
342e5c89e4eSSatish Balay   PetscFList     entry = fl;
343e5c89e4eSSatish Balay   PetscErrorCode ierr;
344e5c89e4eSSatish Balay   char           *function,*path;
345ace3abfcSBarry Smith   PetscBool      flg,f1,f2,f3;
3460598bfebSBarry Smith #if defined(PETSC_HAVE_DYNAMIC_LIBRARIES)
347e5c89e4eSSatish Balay   char           *newpath;
348e5c89e4eSSatish Balay #endif
349e5c89e4eSSatish Balay 
350e5c89e4eSSatish Balay   PetscFunctionBegin;
351e32f2f54SBarry Smith   if (!name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to find routine with null name");
352e5c89e4eSSatish Balay 
353e5c89e4eSSatish Balay   *r = 0;
354e5c89e4eSSatish Balay   ierr = PetscFListGetPathAndFunction(name,&path,&function);CHKERRQ(ierr);
355e5c89e4eSSatish Balay 
356e5c89e4eSSatish Balay   /*
357e5c89e4eSSatish Balay         If path then append it to search libraries
358e5c89e4eSSatish Balay   */
3590598bfebSBarry Smith #if defined(PETSC_HAVE_DYNAMIC_LIBRARIES)
360e5c89e4eSSatish Balay   if (path) {
361e5c89e4eSSatish Balay     ierr = PetscDLLibraryAppend(comm,&DLLibrariesLoaded,path);CHKERRQ(ierr);
362e5c89e4eSSatish Balay   }
363e5c89e4eSSatish Balay #endif
364e5c89e4eSSatish Balay 
365e5c89e4eSSatish Balay   while (entry) {
366e5c89e4eSSatish Balay     flg = PETSC_FALSE;
367e5c89e4eSSatish Balay     if (path && entry->path) {
368e5c89e4eSSatish Balay       ierr = PetscStrcmp(path,entry->path,&f1);CHKERRQ(ierr);
369e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->rname,&f2);CHKERRQ(ierr);
370e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->name,&f3);CHKERRQ(ierr);
371ace3abfcSBarry Smith       flg =  (PetscBool) ((f1 && f2) || (f1 && f3));
372e5c89e4eSSatish Balay     } else if (!path) {
373e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->name,&f1);CHKERRQ(ierr);
374e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->rname,&f2);CHKERRQ(ierr);
375ace3abfcSBarry Smith       flg =  (PetscBool) (f1 || f2);
376e5c89e4eSSatish Balay     } else {
377e5c89e4eSSatish Balay       ierr = PetscStrcmp(function,entry->name,&flg);CHKERRQ(ierr);
378e5c89e4eSSatish Balay       if (flg) {
379e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
380e5c89e4eSSatish Balay         ierr = PetscStrallocpy(entry->rname,&function);CHKERRQ(ierr);
381e5c89e4eSSatish Balay       } else {
382e5c89e4eSSatish Balay         ierr = PetscStrcmp(function,entry->rname,&flg);CHKERRQ(ierr);
383e5c89e4eSSatish Balay       }
384e5c89e4eSSatish Balay     }
385e5c89e4eSSatish Balay 
386e5c89e4eSSatish Balay     if (flg) {
387e5c89e4eSSatish Balay       if (entry->routine) {
388e5c89e4eSSatish Balay         *r   = entry->routine;
389503cfb0cSBarry Smith         ierr = PetscFree(path);CHKERRQ(ierr);
390e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
391e5c89e4eSSatish Balay         PetscFunctionReturn(0);
392e5c89e4eSSatish Balay       }
3935629bde7SJed Brown       if (!(entry->rname && entry->rname[0])) { /* The entry has been cleared */
3945629bde7SJed Brown         ierr = PetscFree(function);CHKERRQ(ierr);
3955629bde7SJed Brown         PetscFunctionReturn(0);
3965629bde7SJed Brown       }
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 */
4030598bfebSBarry Smith #if defined(PETSC_HAVE_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;
409503cfb0cSBarry Smith         ierr = PetscFree(path);CHKERRQ(ierr);
410e5c89e4eSSatish Balay         ierr = PetscFree(function);CHKERRQ(ierr);
411e5c89e4eSSatish Balay         PetscFunctionReturn(0);
412e5c89e4eSSatish Balay       }
413e5c89e4eSSatish Balay #endif
414e5c89e4eSSatish Balay     }
415e5c89e4eSSatish Balay     entry = entry->next;
416e5c89e4eSSatish Balay   }
417e5c89e4eSSatish Balay 
4180598bfebSBarry Smith #if defined(PETSC_HAVE_DYNAMIC_LIBRARIES)
419e5c89e4eSSatish Balay   /* Function never registered; try for it anyway */
420e5c89e4eSSatish Balay   ierr = PetscDLLibrarySym(comm,&DLLibrariesLoaded,path,function,(void **)r);CHKERRQ(ierr);
421503cfb0cSBarry Smith   ierr = PetscFree(path);CHKERRQ(ierr);
422e5c89e4eSSatish Balay   if (*r) {
423e5c89e4eSSatish Balay     ierr = PetscFListAdd(&fl,name,name,*r);CHKERRQ(ierr);
424e5c89e4eSSatish Balay   }
425e5c89e4eSSatish Balay #endif
426e5c89e4eSSatish Balay   ierr = PetscFree(function);CHKERRQ(ierr);
427e5c89e4eSSatish Balay   PetscFunctionReturn(0);
428e5c89e4eSSatish Balay }
429e5c89e4eSSatish Balay 
430e5c89e4eSSatish Balay #undef __FUNCT__
431e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListView"
432e5c89e4eSSatish Balay /*@
433e5c89e4eSSatish Balay    PetscFListView - prints out contents of an PetscFList
434e5c89e4eSSatish Balay 
435e5c89e4eSSatish Balay    Collective over MPI_Comm
436e5c89e4eSSatish Balay 
437e5c89e4eSSatish Balay    Input Parameters:
438e5c89e4eSSatish Balay +  list - the list of functions
439e5c89e4eSSatish Balay -  viewer - currently ignored
440e5c89e4eSSatish Balay 
441e5c89e4eSSatish Balay    Level: developer
442e5c89e4eSSatish Balay 
443e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFListPrintTypes(), PetscFList
444e5c89e4eSSatish Balay @*/
4457087cfbeSBarry Smith PetscErrorCode  PetscFListView(PetscFList list,PetscViewer viewer)
446e5c89e4eSSatish Balay {
447e5c89e4eSSatish Balay   PetscErrorCode ierr;
448ace3abfcSBarry Smith   PetscBool      iascii;
449e5c89e4eSSatish Balay 
450e5c89e4eSSatish Balay   PetscFunctionBegin;
451e5c89e4eSSatish Balay   if (!viewer) viewer = PETSC_VIEWER_STDOUT_SELF;
452e5c89e4eSSatish Balay   PetscValidPointer(list,1);
4530700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
454e5c89e4eSSatish Balay 
4552692d6eeSBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
456e32f2f54SBarry Smith   if (!iascii) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Only ASCII viewer supported");
457e5c89e4eSSatish Balay 
458e5c89e4eSSatish Balay   while (list) {
459e5c89e4eSSatish Balay     if (list->path) {
460e5c89e4eSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer," %s %s %s\n",list->path,list->name,list->rname);CHKERRQ(ierr);
461e5c89e4eSSatish Balay     } else {
462e5c89e4eSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer," %s %s\n",list->name,list->rname);CHKERRQ(ierr);
463e5c89e4eSSatish Balay     }
464e5c89e4eSSatish Balay     list = list->next;
465e5c89e4eSSatish Balay   }
466e5c89e4eSSatish Balay   ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
467e5c89e4eSSatish Balay   PetscFunctionReturn(0);
468e5c89e4eSSatish Balay }
469e5c89e4eSSatish Balay 
470e5c89e4eSSatish Balay #undef __FUNCT__
471e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListGet"
472e5c89e4eSSatish Balay /*@
473e5c89e4eSSatish Balay    PetscFListGet - Gets an array the contains the entries in PetscFList, this is used
474e5c89e4eSSatish Balay          by help etc.
475e5c89e4eSSatish Balay 
476e5c89e4eSSatish Balay    Collective over MPI_Comm
477e5c89e4eSSatish Balay 
478e5c89e4eSSatish Balay    Input Parameter:
479e5c89e4eSSatish Balay .  list   - list of types
480e5c89e4eSSatish Balay 
481e5c89e4eSSatish Balay    Output Parameter:
482e5c89e4eSSatish Balay +  array - array of names
483e5c89e4eSSatish Balay -  n - length of array
484e5c89e4eSSatish Balay 
485e5c89e4eSSatish Balay    Notes:
486e5c89e4eSSatish Balay        This allocates the array so that must be freed. BUT the individual entries are
487e5c89e4eSSatish Balay     not copied so should not be freed.
488e5c89e4eSSatish Balay 
489e5c89e4eSSatish Balay    Level: developer
490e5c89e4eSSatish Balay 
491e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFList
492e5c89e4eSSatish Balay @*/
4937087cfbeSBarry Smith PetscErrorCode  PetscFListGet(PetscFList list,char ***array,int *n)
494e5c89e4eSSatish Balay {
495e5c89e4eSSatish Balay   PetscErrorCode ierr;
496e5c89e4eSSatish Balay   PetscInt       count = 0;
497e5c89e4eSSatish Balay   PetscFList     klist = list;
498e5c89e4eSSatish Balay 
499e5c89e4eSSatish Balay   PetscFunctionBegin;
500e5c89e4eSSatish Balay   while (list) {
501e5c89e4eSSatish Balay     list = list->next;
502e5c89e4eSSatish Balay     count++;
503e5c89e4eSSatish Balay   }
504e5c89e4eSSatish Balay   ierr  = PetscMalloc((count+1)*sizeof(char *),array);CHKERRQ(ierr);
505e5c89e4eSSatish Balay   count = 0;
506e5c89e4eSSatish Balay   while (klist) {
507e5c89e4eSSatish Balay     (*array)[count] = klist->name;
508e5c89e4eSSatish Balay     klist = klist->next;
509e5c89e4eSSatish Balay     count++;
510e5c89e4eSSatish Balay   }
511e5c89e4eSSatish Balay   (*array)[count] = 0;
512e5c89e4eSSatish Balay   *n = count+1;
513e5c89e4eSSatish Balay   PetscFunctionReturn(0);
514e5c89e4eSSatish Balay }
515e5c89e4eSSatish Balay 
516e5c89e4eSSatish Balay 
517e5c89e4eSSatish Balay #undef __FUNCT__
518e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListPrintTypes"
519e5c89e4eSSatish Balay /*@C
520e5c89e4eSSatish Balay    PetscFListPrintTypes - Prints the methods available.
521e5c89e4eSSatish Balay 
522e5c89e4eSSatish Balay    Collective over MPI_Comm
523e5c89e4eSSatish Balay 
524e5c89e4eSSatish Balay    Input Parameters:
525e5c89e4eSSatish Balay +  comm   - the communicator (usually MPI_COMM_WORLD)
526e5c89e4eSSatish Balay .  fd     - file to print to, usually stdout
527e5c89e4eSSatish Balay .  prefix - prefix to prepend to name (optional)
528e5c89e4eSSatish Balay .  name   - option string (for example, "-ksp_type")
529e5c89e4eSSatish Balay .  text - short description of the object (for example, "Krylov solvers")
530e5c89e4eSSatish Balay .  man - name of manual page that discusses the object (for example, "KSPCreate")
5313cc1e11dSBarry Smith .  list   - list of types
5323cc1e11dSBarry Smith -  def - default (current) value
533e5c89e4eSSatish Balay 
534e5c89e4eSSatish Balay    Level: developer
535e5c89e4eSSatish Balay 
536e5c89e4eSSatish Balay .seealso: PetscFListAddDynamic(), PetscFList
537e5c89e4eSSatish Balay @*/
5387087cfbeSBarry Smith PetscErrorCode  PetscFListPrintTypes(MPI_Comm comm,FILE *fd,const char prefix[],const char name[],const char text[],const char man[],PetscFList list,const char def[])
539e5c89e4eSSatish Balay {
540e5c89e4eSSatish Balay   PetscErrorCode ierr;
541e5c89e4eSSatish Balay   PetscInt       count = 0;
542e5c89e4eSSatish Balay   char           p[64];
543e5c89e4eSSatish Balay 
544e5c89e4eSSatish Balay   PetscFunctionBegin;
545da9f1d6bSBarry Smith   if (!fd) fd = PETSC_STDOUT;
546e5c89e4eSSatish Balay 
547e5c89e4eSSatish Balay   ierr = PetscStrcpy(p,"-");CHKERRQ(ierr);
548e5c89e4eSSatish Balay   if (prefix) {ierr = PetscStrcat(p,prefix);CHKERRQ(ierr);}
5493cc1e11dSBarry Smith   ierr = PetscFPrintf(comm,fd,"  %s%s <%s>: %s (one of)",p,name+1,def,text);CHKERRQ(ierr);
550e5c89e4eSSatish Balay 
551e5c89e4eSSatish Balay   while (list) {
552e5c89e4eSSatish Balay     ierr = PetscFPrintf(comm,fd," %s",list->name);CHKERRQ(ierr);
553e5c89e4eSSatish Balay     list = list->next;
554e5c89e4eSSatish Balay     count++;
555e5c89e4eSSatish Balay     if (count == 8) {ierr = PetscFPrintf(comm,fd,"\n     ");CHKERRQ(ierr);}
556e5c89e4eSSatish Balay   }
557e5c89e4eSSatish Balay   ierr = PetscFPrintf(comm,fd," (%s)\n",man);CHKERRQ(ierr);
558e5c89e4eSSatish Balay   PetscFunctionReturn(0);
559e5c89e4eSSatish Balay }
560e5c89e4eSSatish Balay 
561e5c89e4eSSatish Balay #undef __FUNCT__
562e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListDuplicate"
563e5c89e4eSSatish Balay /*@
564e5c89e4eSSatish Balay     PetscFListDuplicate - Creates a new list from a given object list.
565e5c89e4eSSatish Balay 
566e5c89e4eSSatish Balay     Input Parameters:
567e5c89e4eSSatish Balay .   fl   - pointer to list
568e5c89e4eSSatish Balay 
569e5c89e4eSSatish Balay     Output Parameters:
570e5c89e4eSSatish Balay .   nl - the new list (should point to 0 to start, otherwise appends)
571e5c89e4eSSatish Balay 
572e5c89e4eSSatish Balay     Level: developer
573e5c89e4eSSatish Balay 
574e5c89e4eSSatish Balay .seealso: PetscFList, PetscFListAdd(), PetscFlistDestroy()
575e5c89e4eSSatish Balay 
576e5c89e4eSSatish Balay @*/
5777087cfbeSBarry Smith PetscErrorCode  PetscFListDuplicate(PetscFList fl,PetscFList *nl)
578e5c89e4eSSatish Balay {
579e5c89e4eSSatish Balay   PetscErrorCode ierr;
580e5c89e4eSSatish Balay   char           path[PETSC_MAX_PATH_LEN];
581e5c89e4eSSatish Balay 
582e5c89e4eSSatish Balay   PetscFunctionBegin;
583e5c89e4eSSatish Balay   while (fl) {
584e5c89e4eSSatish Balay     /* this is silly, rebuild the complete pathname */
585e5c89e4eSSatish Balay     if (fl->path) {
586e5c89e4eSSatish Balay       ierr = PetscStrcpy(path,fl->path);CHKERRQ(ierr);
587e5c89e4eSSatish Balay       ierr = PetscStrcat(path,":");CHKERRQ(ierr);
588e5c89e4eSSatish Balay       ierr = PetscStrcat(path,fl->name);CHKERRQ(ierr);
589e5c89e4eSSatish Balay     } else {
590e5c89e4eSSatish Balay       ierr = PetscStrcpy(path,fl->name);CHKERRQ(ierr);
591e5c89e4eSSatish Balay     }
592e5c89e4eSSatish Balay     ierr = PetscFListAdd(nl,path,fl->rname,fl->routine);CHKERRQ(ierr);
593e5c89e4eSSatish Balay     fl   = fl->next;
594e5c89e4eSSatish Balay   }
595e5c89e4eSSatish Balay   PetscFunctionReturn(0);
596e5c89e4eSSatish Balay }
597e5c89e4eSSatish Balay 
598e5c89e4eSSatish Balay 
599e5c89e4eSSatish Balay #undef __FUNCT__
600e5c89e4eSSatish Balay #define __FUNCT__ "PetscFListConcat"
601e5c89e4eSSatish Balay /*
602e5c89e4eSSatish Balay     PetscFListConcat - joins name of a libary, and the path where it is located
603e5c89e4eSSatish Balay     into a single string.
604e5c89e4eSSatish Balay 
605e5c89e4eSSatish Balay     Input Parameters:
606e5c89e4eSSatish Balay .   path   - path to the library name.
607e5c89e4eSSatish Balay .   name   - name of the library
608e5c89e4eSSatish Balay 
609e5c89e4eSSatish Balay     Output Parameters:
610e5c89e4eSSatish Balay .   fullname - the name that is the union of the path and the library name,
611e5c89e4eSSatish Balay                delimited by a semicolon, i.e., path:name
612e5c89e4eSSatish Balay 
613e5c89e4eSSatish Balay     Notes:
614e5c89e4eSSatish Balay     If the path is NULL, assumes that the name, specified also includes
615e5c89e4eSSatish Balay     the path as path:name
616e5c89e4eSSatish Balay 
617e5c89e4eSSatish Balay */
6187087cfbeSBarry Smith PetscErrorCode  PetscFListConcat(const char path[],const char name[],char fullname[])
619e5c89e4eSSatish Balay {
620e5c89e4eSSatish Balay   PetscErrorCode ierr;
621e5c89e4eSSatish Balay   PetscFunctionBegin;
622e5c89e4eSSatish Balay   if (path) {
623e5c89e4eSSatish Balay     ierr = PetscStrcpy(fullname,path);CHKERRQ(ierr);
624e5c89e4eSSatish Balay     ierr = PetscStrcat(fullname,":");CHKERRQ(ierr);
625e5c89e4eSSatish Balay     ierr = PetscStrcat(fullname,name);CHKERRQ(ierr);
626e5c89e4eSSatish Balay   } else {
627e5c89e4eSSatish Balay     ierr = PetscStrcpy(fullname,name);CHKERRQ(ierr);
628e5c89e4eSSatish Balay   }
629e5c89e4eSSatish Balay   PetscFunctionReturn(0);
630e5c89e4eSSatish Balay }
631