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