1 #include <petscsys.h> /*I "petscsys.h" I*/ 2 3 /* ---------------------------------------------------------------- */ 4 5 #if !defined(PETSC_PYTHON_EXE) 6 #define PETSC_PYTHON_EXE "python" 7 #endif 8 9 #undef __FUNCT__ 10 #define __FUNCT__ "PetscPythonFindExecutable" 11 static PetscErrorCode PetscPythonFindExecutable(char pythonexe[PETSC_MAX_PATH_LEN]) 12 { 13 PetscBool flag; 14 PetscErrorCode ierr; 15 PetscFunctionBegin; 16 /* get the path for the Python interpreter executable */ 17 ierr = PetscStrncpy(pythonexe,PETSC_PYTHON_EXE,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 18 ierr = PetscOptionsGetString(PETSC_NULL,"-python",pythonexe,PETSC_MAX_PATH_LEN,&flag);CHKERRQ(ierr); 19 if (!flag || pythonexe[0]==0) { 20 ierr = PetscStrncpy(pythonexe,PETSC_PYTHON_EXE,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 21 } 22 PetscFunctionReturn(0); 23 } 24 25 #undef __FUNCT__ 26 #define __FUNCT__ "PetscPythonFindLibrary" 27 static PetscErrorCode PetscPythonFindLibrary(char pythonexe[PETSC_MAX_PATH_LEN], 28 char pythonlib[PETSC_MAX_PATH_LEN]) 29 { 30 const char cmdline[] = "-c 'import sys; print(sys.exec_prefix); print(sys.version[:3])'"; 31 char command[PETSC_MAX_PATH_LEN+1+sizeof(cmdline)+1]; 32 char prefix[PETSC_MAX_PATH_LEN],version[8],sep[2]={PETSC_DIR_SEPARATOR, 0},*eol; 33 FILE* fp = NULL; 34 char path[PETSC_MAX_PATH_LEN+1]; 35 PetscBool found = PETSC_FALSE; 36 PetscErrorCode ierr; 37 PetscFunctionBegin; 38 39 #if defined(PETSC_PYTHON_LIB) 40 ierr = PetscStrcpy(pythonlib,PETSC_PYTHON_LIB);CHKERRQ(ierr); 41 PetscFunctionReturn(0); 42 #endif 43 44 /* call Python to find out the name of the Python dynamic library */ 45 ierr = PetscStrncpy(command,pythonexe,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 46 ierr = PetscStrcat(command," ");CHKERRQ(ierr); 47 ierr = PetscStrcat(command,cmdline);CHKERRQ(ierr); 48 #if defined(PETSC_HAVE_POPEN) 49 ierr = PetscPOpen(PETSC_COMM_SELF,PETSC_NULL,command,"r",&fp);CHKERRQ(ierr); 50 if (!fgets(prefix,sizeof(prefix),fp)) 51 { SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Python: bad output from executable: %s",pythonexe); } 52 if (!fgets(version,sizeof(version),fp)) 53 { SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Python: bad output from executable: %s",pythonexe); } 54 ierr = PetscPClose(PETSC_COMM_SELF,fp,PETSC_NULL);CHKERRQ(ierr); 55 #else 56 SETERRQ(PETSC_COMM_SELF,1,"Python: Aborted due to missing popen()"); 57 #endif 58 /* remove newlines */ 59 ierr = PetscStrchr(prefix,'\n',&eol);CHKERRQ(ierr); 60 if (eol) eol[0] = 0; 61 ierr = PetscStrchr(version,'\n',&eol);CHKERRQ(ierr); 62 if (eol) eol[0] = 0; 63 64 /* test for $prefix/lib64/libpythonX.X[.so]*/ 65 ierr = PetscStrcpy(pythonlib,prefix);CHKERRQ(ierr); 66 ierr = PetscStrcat(pythonlib,sep);CHKERRQ(ierr); 67 ierr = PetscStrcat(pythonlib,"lib64");CHKERRQ(ierr); 68 ierr = PetscTestDirectory(pythonlib,'r',&found);CHKERRQ(ierr); 69 if (found) { 70 ierr = PetscStrcat(pythonlib,sep);CHKERRQ(ierr); 71 ierr = PetscStrcat(pythonlib,"libpython");CHKERRQ(ierr); 72 ierr = PetscStrcat(pythonlib,version);CHKERRQ(ierr); 73 ierr = PetscDLLibraryRetrieve(PETSC_COMM_SELF,pythonlib,path,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr); 74 if (found) PetscFunctionReturn(0); 75 } 76 77 /* test for $prefix/lib/libpythonX.X[.so]*/ 78 ierr = PetscStrcpy(pythonlib,prefix);CHKERRQ(ierr); 79 ierr = PetscStrcat(pythonlib,sep);CHKERRQ(ierr); 80 ierr = PetscStrcat(pythonlib,"lib");CHKERRQ(ierr); 81 ierr = PetscTestDirectory(pythonlib,'r',&found);CHKERRQ(ierr); 82 if (found) { 83 ierr = PetscStrcat(pythonlib,sep);CHKERRQ(ierr); 84 ierr = PetscStrcat(pythonlib,"libpython");CHKERRQ(ierr); 85 ierr = PetscStrcat(pythonlib,version);CHKERRQ(ierr); 86 ierr = PetscDLLibraryRetrieve(PETSC_COMM_SELF,pythonlib,path,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr); 87 if (found) PetscFunctionReturn(0); 88 } 89 90 /* nothing good found */ 91 ierr = PetscMemzero(pythonlib,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 92 ierr = PetscInfo(0,"Python dynamic library not found\n");CHKERRQ(ierr); 93 94 PetscFunctionReturn(0); 95 } 96 97 /* ---------------------------------------------------------------- */ 98 99 typedef struct _Py_object_t PyObject; /* fake definition */ 100 101 static PyObject* Py_None = 0; 102 103 static const char* (*Py_GetVersion)(void); 104 105 static int (*Py_IsInitialized)(void); 106 static void (*Py_InitializeEx)(int); 107 static void (*Py_Finalize)(void); 108 109 static void (*PySys_SetArgv)(int, char **); 110 static PyObject* (*PySys_GetObject)(const char *); 111 static PyObject* (*PyObject_CallMethod)(PyObject *, const char *, const char *, ...); 112 static PyObject* (*PyImport_ImportModule)(const char *); 113 114 static void (*Py_IncRef)(PyObject *); 115 static void (*Py_DecRef)(PyObject *); 116 117 static void (*PyErr_Clear)(void); 118 static PyObject* (*PyErr_Occurred)(void); 119 static void (*PyErr_Fetch)(PyObject **, PyObject **, PyObject **); 120 static void (*PyErr_NormalizeException)(PyObject **, PyObject **, PyObject **); 121 static void (*PyErr_Display)(PyObject *, PyObject *, PyObject *); 122 static void (*PyErr_Restore)(PyObject *, PyObject *, PyObject *); 123 124 125 #define PetscDLPyLibOpen(libname) \ 126 PetscDLLibraryAppend(PETSC_COMM_SELF,&PetscDLLibrariesLoaded,libname) 127 #define PetscDLPyLibSym(symbol, value) \ 128 PetscDLLibrarySym(PETSC_COMM_SELF,&PetscDLLibrariesLoaded,PETSC_NULL,symbol,(void**)value) 129 #define PetscDLPyLibClose(comm) \ 130 do { } while(0) 131 132 #undef __FUNCT__ 133 #define __FUNCT__ "PetscPythonLoadLibrary" 134 static PetscErrorCode PetscPythonLoadLibrary(const char pythonlib[]) 135 { 136 PetscErrorCode ierr; 137 PetscFunctionBegin; 138 139 /* open the Python dynamic library */ 140 ierr = PetscDLPyLibOpen(pythonlib);CHKERRQ(ierr); 141 ierr = PetscInfo1(0,"Python: loaded dynamic library %s\n", pythonlib);CHKERRQ(ierr); 142 /* look required symbols from the Python C-API */ 143 ierr = PetscDLPyLibSym("_Py_NoneStruct" , &Py_None );CHKERRQ(ierr); 144 ierr = PetscDLPyLibSym("Py_GetVersion" , &Py_GetVersion );CHKERRQ(ierr); 145 ierr = PetscDLPyLibSym("Py_IsInitialized" , &Py_IsInitialized );CHKERRQ(ierr); 146 ierr = PetscDLPyLibSym("Py_InitializeEx" , &Py_InitializeEx );CHKERRQ(ierr); 147 ierr = PetscDLPyLibSym("Py_Finalize" , &Py_Finalize );CHKERRQ(ierr); 148 ierr = PetscDLPyLibSym("PySys_GetObject" , &PySys_GetObject );CHKERRQ(ierr); 149 ierr = PetscDLPyLibSym("PySys_SetArgv" , &PySys_SetArgv );CHKERRQ(ierr); 150 ierr = PetscDLPyLibSym("PyObject_CallMethod" , &PyObject_CallMethod );CHKERRQ(ierr); 151 ierr = PetscDLPyLibSym("PyImport_ImportModule" , &PyImport_ImportModule );CHKERRQ(ierr); 152 ierr = PetscDLPyLibSym("Py_IncRef" , &Py_IncRef );CHKERRQ(ierr); 153 ierr = PetscDLPyLibSym("Py_DecRef" , &Py_DecRef );CHKERRQ(ierr); 154 ierr = PetscDLPyLibSym("PyErr_Clear" , &PyErr_Clear );CHKERRQ(ierr); 155 ierr = PetscDLPyLibSym("PyErr_Occurred" , &PyErr_Occurred );CHKERRQ(ierr); 156 ierr = PetscDLPyLibSym("PyErr_Fetch" , &PyErr_Fetch );CHKERRQ(ierr); 157 ierr = PetscDLPyLibSym("PyErr_NormalizeException", &PyErr_NormalizeException);CHKERRQ(ierr); 158 ierr = PetscDLPyLibSym("PyErr_Display", &PyErr_Display );CHKERRQ(ierr); 159 ierr = PetscDLPyLibSym("PyErr_Restore", &PyErr_Restore );CHKERRQ(ierr); 160 /* XXX TODO: check that ALL symbols were there !!! */ 161 if (!Py_None) SETERRQ(PETSC_COMM_SELF,1,"Python: failed to load symbols from dynamic library"); 162 if (!Py_GetVersion) SETERRQ(PETSC_COMM_SELF,1,"Python: failed to load symbols from dynamic library"); 163 if (!Py_IsInitialized) SETERRQ(PETSC_COMM_SELF,1,"Python: failed to load symbols from dynamic library"); 164 if (!Py_InitializeEx) SETERRQ(PETSC_COMM_SELF,1,"Python: failed to load symbols from dynamic library"); 165 if (!Py_Finalize) SETERRQ(PETSC_COMM_SELF,1,"Python: failed to load symbols from dynamic library"); 166 ierr = PetscInfo(0,"Python: all required symbols loaded from Python dynamic library\n");CHKERRQ(ierr); 167 168 PetscFunctionReturn(0); 169 } 170 171 /* ---------------------------------------------------------------- */ 172 173 static char PetscPythonExe[PETSC_MAX_PATH_LEN] = { 0 }; 174 static char PetscPythonLib[PETSC_MAX_PATH_LEN] = { 0 }; 175 static PetscBool PetscBeganPython = PETSC_FALSE; 176 177 #undef __FUNCT__ 178 #define __FUNCT__ "PetscPythonFinalize" 179 /*@C 180 PetscPythonFinalize - Finalize Python. 181 182 Level: intermediate 183 184 .keywords: Python 185 @*/ 186 PetscErrorCode PetscPythonFinalize(void) 187 { 188 PetscFunctionBegin; 189 if (PetscBeganPython) { if (Py_IsInitialized()) Py_Finalize(); } 190 PetscBeganPython = PETSC_FALSE; 191 PetscFunctionReturn(0); 192 } 193 194 #undef __FUNCT__ 195 #define __FUNCT__ "PetscPythonInitialize" 196 /*@C 197 PetscPythonInitialize - Initialize Python and import petsc4py. 198 199 Input Parameter: 200 + pyexe - path to the Python interpreter executable, or PETSC_NULL. 201 - pylib - full path to the Python dynamic library, or PETSC_NULL. 202 203 Level: intermediate 204 205 .keywords: Python 206 207 @*/ 208 PetscErrorCode PetscPythonInitialize(const char pyexe[],const char pylib[]) 209 { 210 PyObject *module = 0; 211 PetscErrorCode ierr; 212 PetscFunctionBegin; 213 if (PetscBeganPython) PetscFunctionReturn(0); 214 /* Python executable */ 215 if (pyexe && pyexe[0] != 0) { 216 ierr = PetscStrncpy(PetscPythonExe,pyexe,sizeof(PetscPythonExe));CHKERRQ(ierr); 217 } else { 218 ierr = PetscPythonFindExecutable(PetscPythonExe);CHKERRQ(ierr); 219 } 220 /* Python dynamic library */ 221 if (pylib && pylib[0] != 0) { 222 ierr = PetscStrncpy(PetscPythonLib,pylib,sizeof(PetscPythonLib));CHKERRQ(ierr); 223 } else { 224 ierr = PetscPythonFindLibrary(PetscPythonExe,PetscPythonLib);CHKERRQ(ierr); 225 } 226 /* dynamically load Python library */ 227 ierr = PetscPythonLoadLibrary(PetscPythonLib);CHKERRQ(ierr); 228 /* initialize Python */ 229 PetscBeganPython = PETSC_FALSE; 230 if (!Py_IsInitialized()) { 231 static PetscBool registered = PETSC_FALSE; 232 const char *py_version; 233 PyObject *sys_path; 234 char path[PETSC_MAX_PATH_LEN] = { 0 }; 235 /* initialize Python */ 236 Py_InitializeEx(0); /* 0: do not install signal handlers */ 237 /* build 'sys.argv' list */ 238 py_version = Py_GetVersion(); 239 if (py_version[0] == '2') { 240 int argc = 0; char **argv = 0; 241 ierr = PetscGetArgs(&argc,&argv);CHKERRQ(ierr); 242 PySys_SetArgv(argc,argv); 243 } 244 if (py_version[0] == '3') { 245 /* XXX 'argv' is type 'wchar_t**' */ 246 PySys_SetArgv(0,PETSC_NULL); 247 } 248 /* add PETSC_LIB_DIR in front of 'sys.path' */ 249 sys_path = PySys_GetObject("path"); 250 if (sys_path) { 251 ierr = PetscStrreplace(PETSC_COMM_SELF,"${PETSC_LIB_DIR}",path,sizeof(path));CHKERRQ(ierr); 252 Py_DecRef(PyObject_CallMethod(sys_path,"insert","is",(int)0,(char*)path)); 253 } 254 /* register finalizer */ 255 if (!registered) { 256 ierr = PetscRegisterFinalize(PetscPythonFinalize);CHKERRQ(ierr); 257 registered = PETSC_TRUE; 258 } 259 PetscBeganPython = PETSC_TRUE; 260 } 261 /* import 'petsc4py.PETSc' module */ 262 module = PyImport_ImportModule("petsc4py.PETSc"); 263 if (module) { 264 ierr = PetscInfo(0,"Python: successfully imported module 'petsc4py.PETSc'\n");CHKERRQ(ierr); 265 Py_DecRef(module); module = 0; 266 } else { 267 PetscPythonPrintError(); 268 SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Python: could not import module 'petsc4py.PETSc', perhaps your PYTHONPATH does not contain it\n"); 269 } 270 PetscFunctionReturn(0); 271 } 272 273 #undef __FUNCT__ 274 #define __FUNCT__ "PetscPythonPrintError" 275 /*@C 276 PetscPythonPrintError - Print Python errors. 277 278 Level: developer 279 280 .keywords: Python 281 282 @*/ 283 PetscErrorCode PetscPythonPrintError(void) 284 { 285 PyObject *exc=0, *val=0, *tb=0; 286 PetscFunctionBegin; 287 if (!PetscBeganPython) PetscFunctionReturn(0); 288 if (!PyErr_Occurred()) PetscFunctionReturn(0); 289 PyErr_Fetch(&exc,&val,&tb); 290 PyErr_NormalizeException(&exc,&val,&tb); 291 PyErr_Display(exc ? exc : Py_None, 292 val ? val : Py_None, 293 tb ? tb : Py_None); 294 PyErr_Restore(exc,val,tb); 295 PetscFunctionReturn(0); 296 } 297 298 /* ---------------------------------------------------------------- */ 299 300 EXTERN_C_BEGIN 301 extern PetscErrorCode (*PetscPythonMonitorSet_C)(PetscObject,const char[]); 302 PetscErrorCode (*PetscPythonMonitorSet_C)(PetscObject,const char[]) = PETSC_NULL; 303 EXTERN_C_END 304 305 #undef __FUNCT__ 306 #define __FUNCT__ "PetscPythonMonitorSet" 307 /*@C 308 PetscPythonMonitorSet - Set Python monitor 309 310 Level: developer 311 312 .keywords: Python 313 314 @*/ 315 PetscErrorCode PetscPythonMonitorSet(PetscObject obj, const char url[]) 316 { 317 PetscErrorCode ierr; 318 PetscFunctionBegin; 319 PetscValidHeader(obj,1); 320 PetscValidCharPointer(url,2); 321 if(PetscPythonMonitorSet_C == PETSC_NULL) { 322 ierr = PetscPythonInitialize(PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 323 if(PetscPythonMonitorSet_C == PETSC_NULL) 324 SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Couldn't initialize Python support for monitors"); 325 } 326 ierr = PetscPythonMonitorSet_C(obj,url);CHKERRQ(ierr); 327 PetscFunctionReturn(0); 328 } 329 330 /* ---------------------------------------------------------------- */ 331