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