Actual source code: fortranimpl.h
2: /* This file contains info for the use of PETSc Fortran interface stubs */
3: #ifndef PETSCFORTRANIMPL_H
4: #define PETSCFORTRANIMPL_H
6: #include <petsc/private/petscimpl.h>
7: PETSC_INTERN PetscErrorCode PETScParseFortranArgs_Private(int *, char ***);
8: PETSC_EXTERN PetscErrorCode PetscMPIFortranDatatypeToC(MPI_Fint, MPI_Datatype *);
10: PETSC_EXTERN PetscErrorCode PetscScalarAddressToFortran(PetscObject, PetscInt, PetscScalar *, PetscScalar *, PetscInt, size_t *);
11: PETSC_EXTERN PetscErrorCode PetscScalarAddressFromFortran(PetscObject, PetscScalar *, size_t, PetscInt, PetscScalar **);
12: PETSC_EXTERN size_t PetscIntAddressToFortran(const PetscInt *, const PetscInt *);
13: PETSC_EXTERN PetscInt *PetscIntAddressFromFortran(const PetscInt *, size_t);
14: PETSC_EXTERN char *PETSC_NULL_CHARACTER_Fortran;
15: PETSC_EXTERN void *PETSC_NULL_INTEGER_Fortran;
16: PETSC_EXTERN void *PETSC_NULL_SCALAR_Fortran;
17: PETSC_EXTERN void *PETSC_NULL_DOUBLE_Fortran;
18: PETSC_EXTERN void *PETSC_NULL_REAL_Fortran;
19: PETSC_EXTERN void *PETSC_NULL_BOOL_Fortran;
20: PETSC_EXTERN void (*PETSC_NULL_FUNCTION_Fortran)(void);
21: PETSC_EXTERN void *PETSC_NULL_MPI_COMM_Fortran;
23: PETSC_INTERN PetscErrorCode PetscInitFortran_Private(PetscBool, const char *, PetscInt);
25: /* ----------------------------------------------------------------------*/
26: /*
27: PETSc object C pointers are stored directly as
28: Fortran integer*4 or *8 depending on the size of pointers.
29: */
31: /* --------------------------------------------------------------------*/
32: /*
33: Since Fortran does not null terminate strings we need to insure the string is null terminated before passing it
34: to C. This may require a memory allocation which is then freed with FREECHAR().
35: */
36: #define FIXCHAR(a, n, b) \
37: { \
38: if ((a) == PETSC_NULL_CHARACTER_Fortran) { \
39: (b) = (a) = NULL; \
40: } else { \
41: while (((n) > 0) && ((a)[(n)-1] == ' ')) (n)--; \
42: *ierr = PetscMalloc1((n) + 1, &(b)); \
43: if (*ierr) return; \
44: *ierr = PetscMemcpy((b), (a), (n)); \
45: (b)[n] = '\0'; \
46: if (*ierr) return; \
47: } \
48: }
49: #define FREECHAR(a, b) \
50: if (a != b) *ierr = PetscFree(b);
52: /*
53: Fortran expects any unneeded characters at the end of its strings to be filled with the blank character.
54: */
55: #define FIXRETURNCHAR(flg, a, n) \
56: if (flg) { \
57: PETSC_FORTRAN_CHARLEN_T __i; \
58: for (__i = 0; __i < n && a[__i] != 0; __i++) { }; \
59: for (; __i < n; __i++) a[__i] = ' '; \
60: }
62: /*
63: The cast through PETSC_UINTPTR_T is so that compilers that warn about casting to/from void * to void(*)(void)
64: will not complain about these comparisons. It is not know if this works for all compilers
65: */
66: #define FORTRANNULLINTEGER(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_INTEGER_Fortran)
67: #define FORTRANNULLSCALAR(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_SCALAR_Fortran)
68: #define FORTRANNULLDOUBLE(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_DOUBLE_Fortran)
69: #define FORTRANNULLREAL(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_REAL_Fortran)
70: #define FORTRANNULLBOOL(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_BOOL_Fortran)
71: #define FORTRANNULLCHARACTER(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_CHARACTER_Fortran)
72: #define FORTRANNULLFUNCTION(a) (((void (*)(void))(PETSC_UINTPTR_T)a) == PETSC_NULL_FUNCTION_Fortran)
73: #define FORTRANNULLOBJECT(a) (*(void **)(PETSC_UINTPTR_T)a == (void *)0)
74: #define FORTRANNULLMPICOMM(a) (((void *)(PETSC_UINTPTR_T)a) == PETSC_NULL_MPI_COMM_Fortran)
76: #define CHKFORTRANNULLINTEGER(a) \
77: if (FORTRANNULLINTEGER(a)) { \
78: a = NULL; \
79: } else if (FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
80: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, "fortran_interface_unknown_file", __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_INTEGER"); \
81: *ierr = PETSC_ERR_ARG_BADPTR; \
82: return; \
83: }
85: #define CHKFORTRANNULLSCALAR(a) \
86: if (FORTRANNULLSCALAR(a)) { \
87: a = NULL; \
88: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
89: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, "fortran_interface_unknown_file", __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_SCALAR"); \
90: *ierr = PETSC_ERR_ARG_BADPTR; \
91: return; \
92: }
94: #define CHKFORTRANNULLDOUBLE(a) \
95: if (FORTRANNULLDOUBLE(a)) { \
96: a = NULL; \
97: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
98: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, "fortran_interface_unknown_file", __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_DOUBLE"); \
99: *ierr = PETSC_ERR_ARG_BADPTR; \
100: return; \
101: }
103: #define CHKFORTRANNULLREAL(a) \
104: if (FORTRANNULLREAL(a)) { \
105: a = NULL; \
106: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
107: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, "fortran_interface_unknown_file", __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_REAL"); \
108: *ierr = PETSC_ERR_ARG_BADPTR; \
109: return; \
110: }
112: #define CHKFORTRANNULLOBJECT(a) \
113: if (*(void **)a == (void *)0) { \
114: a = NULL; \
115: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
116: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, "fortran_interface_unknown_file", __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_XXX where XXX is the name of a particular object class"); \
117: *ierr = PETSC_ERR_ARG_BADPTR; \
118: return; \
119: }
121: #define CHKFORTRANNULLBOOL(a) \
122: if (FORTRANNULLBOOL(a)) { \
123: a = NULL; \
124: } else if (FORTRANNULLSCALAR(a) || FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
125: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, "fortran_interface_unknown_file", __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_BOOL"); \
126: *ierr = PETSC_ERR_ARG_BADPTR; \
127: return; \
128: }
130: #define CHKFORTRANNULLFUNCTION(a) \
131: if (FORTRANNULLFUNCTION(a)) { \
132: a = NULL; \
133: } else if (FORTRANNULLOBJECT(a) || FORTRANNULLSCALAR(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLREAL(a) || FORTRANNULLINTEGER(a) || FORTRANNULLBOOL(a) || FORTRANNULLCHARACTER(a) || FORTRANNULLMPICOMM(a)) { \
134: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, "fortran_interface_unknown_file", __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_FUNCTION"); \
135: *ierr = PETSC_ERR_ARG_BADPTR; \
136: return; \
137: }
139: #define CHKFORTRANNULLMPICOMM(a) \
140: if (FORTRANNULLMPICOMM(a)) { \
141: a = NULL; \
142: } else if (FORTRANNULLINTEGER(a) || FORTRANNULLDOUBLE(a) || FORTRANNULLSCALAR(a) || FORTRANNULLREAL(a) || FORTRANNULLBOOL(a) || FORTRANNULLFUNCTION(a) || FORTRANNULLCHARACTER(a)) { \
143: *ierr = PetscError(PETSC_COMM_SELF, __LINE__, "fortran_interface_unknown_file", __FILE__, PETSC_ERR_ARG_WRONG, PETSC_ERROR_INITIAL, "Use PETSC_NULL_MPI_COMM"); \
144: *ierr = PETSC_ERR_ARG_BADPTR; \
145: return; \
146: }
148: /* The two macros are used at the beginning and end of PETSc object Fortran destroy routines XxxDestroy(). -2 is in consistent with
149: the one used in checkFortranTypeInitialize() at compilersFortran.py.
150: */
152: /* In the beginning of Fortran XxxDestroy(a), if the input object was destroyed, change it to a petsc C NULL object so that it won't crash C XxxDestory() */
153: #define PETSC_FORTRAN_OBJECT_F_DESTROYED_TO_C_NULL(a) \
154: do { \
155: if (*((void **)(a)) == (void *)-2) *(a) = NULL; \
156: } while (0)
158: /* After C XxxDestroy(a) is called, change a's state from NULL to destroyed, so that it can be used/destroyed again by Fortran.
159: E.g., in VecScatterCreateToAll(x,vscat,seq,ierr), if seq = PETSC_NULL_VEC, petsc won't create seq. But if seq is a
160: destroyed object (e.g., as a result of a previous Fortran VecDestroy), petsc will create seq.
161: */
162: #define PETSC_FORTRAN_OBJECT_C_NULL_TO_F_DESTROYED(a) \
163: do { \
164: *((void **)(a)) = (void *)-2; \
165: } while (0)
167: /*
168: Variable type where we stash PETSc object pointers in Fortran.
169: */
170: typedef PETSC_UINTPTR_T PetscFortranAddr;
172: /*
173: These are used to support the default viewers that are
174: created at run time, in C using the , trick.
176: The numbers here must match the numbers in include/petsc/finclude/petscsys.h
177: */
178: #define PETSC_VIEWER_DRAW_WORLD_FORTRAN 4
179: #define PETSC_VIEWER_DRAW_SELF_FORTRAN 5
180: #define PETSC_VIEWER_SOCKET_WORLD_FORTRAN 6
181: #define PETSC_VIEWER_SOCKET_SELF_FORTRAN 7
182: #define PETSC_VIEWER_STDOUT_WORLD_FORTRAN 8
183: #define PETSC_VIEWER_STDOUT_SELF_FORTRAN 9
184: #define PETSC_VIEWER_STDERR_WORLD_FORTRAN 10
185: #define PETSC_VIEWER_STDERR_SELF_FORTRAN 11
186: #define PETSC_VIEWER_BINARY_WORLD_FORTRAN 12
187: #define PETSC_VIEWER_BINARY_SELF_FORTRAN 13
188: #define PETSC_VIEWER_MATLAB_WORLD_FORTRAN 14
189: #define PETSC_VIEWER_MATLAB_SELF_FORTRAN 15
191: #if defined(PETSC_USE_SOCKET_VIEWER)
192: #define PetscPatchDefaultViewers_Fortran_Socket(vin, v) \
193: } \
194: else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_SOCKET_WORLD_FORTRAN) \
195: { \
196: v = PETSC_VIEWER_SOCKET_WORLD; \
197: } \
198: else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_SOCKET_SELF_FORTRAN) \
199: { \
200: v = PETSC_VIEWER_SOCKET_SELF
201: #else
202: #define PetscPatchDefaultViewers_Fortran_Socket(vin, v)
203: #endif
205: #define PetscPatchDefaultViewers_Fortran(vin, v) \
206: { \
207: if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_DRAW_WORLD_FORTRAN) { \
208: v = PETSC_VIEWER_DRAW_WORLD; \
209: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_DRAW_SELF_FORTRAN) { \
210: v = PETSC_VIEWER_DRAW_SELF; \
211: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_STDOUT_WORLD_FORTRAN) { \
212: v = PETSC_VIEWER_STDOUT_WORLD; \
213: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_STDOUT_SELF_FORTRAN) { \
214: v = PETSC_VIEWER_STDOUT_SELF; \
215: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_STDERR_WORLD_FORTRAN) { \
216: v = PETSC_VIEWER_STDERR_WORLD; \
217: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_STDERR_SELF_FORTRAN) { \
218: v = PETSC_VIEWER_STDERR_SELF; \
219: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_BINARY_WORLD_FORTRAN) { \
220: v = PETSC_VIEWER_BINARY_WORLD; \
221: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_BINARY_SELF_FORTRAN) { \
222: v = PETSC_VIEWER_BINARY_SELF; \
223: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_MATLAB_WORLD_FORTRAN) { \
224: v = PETSC_VIEWER_BINARY_WORLD; \
225: } else if ((*(PetscFortranAddr *)vin) == PETSC_VIEWER_MATLAB_SELF_FORTRAN) { \
226: v = PETSC_VIEWER_BINARY_SELF; \
227: PetscPatchDefaultViewers_Fortran_Socket(vin, v); \
228: } else { \
229: v = *vin; \
230: } \
231: }
233: /*
234: Allocates enough space to store Fortran function pointers in PETSc object
235: that are needed by the Fortran interface.
236: */
237: #define PetscObjectAllocateFortranPointers(obj, N) \
238: do { \
239: if (!((PetscObject)(obj))->fortran_func_pointers) { \
240: *ierr = PetscCalloc((N) * sizeof(void (*)(void)), &((PetscObject)(obj))->fortran_func_pointers); \
241: if (*ierr) return; \
242: ((PetscObject)obj)->num_fortran_func_pointers = (N); \
243: } \
244: } while (0)
246: #define PetscCallFortranVoidFunction(...) \
247: do { \
248: PetscErrorCode ierr = PETSC_SUCCESS; \
249: /* the function may or may not access ierr */ \
250: __VA_ARGS__; \
251: PetscCall(ierr); \
252: } while (0)
254: /* Entire function body, _ctx is a "special" variable that can be passed along */
255: #define PetscObjectUseFortranCallback_Private(obj, cid, types, args, cbclass) \
256: { \
257: void(*func) types, *_ctx; \
258: PetscFunctionBegin; \
259: PetscCall(PetscObjectGetFortranCallback((PetscObject)(obj), (cbclass), (cid), (PetscVoidFunction *)&func, &_ctx)); \
260: if (func) PetscCallFortranVoidFunction((*func)args); \
261: PetscFunctionReturn(PETSC_SUCCESS); \
262: }
263: #define PetscObjectUseFortranCallback(obj, cid, types, args) PetscObjectUseFortranCallback_Private(obj, cid, types, args, PETSC_FORTRAN_CALLBACK_CLASS)
264: #define PetscObjectUseFortranCallbackSubType(obj, cid, types, args) PetscObjectUseFortranCallback_Private(obj, cid, types, args, PETSC_FORTRAN_CALLBACK_SUBTYPE)
266: /* Disable deprecation warnings while building Fortran wrappers */
267: #undef PETSC_DEPRECATED_FUNCTION
268: #define PETSC_DEPRECATED_FUNCTION(arg)
270: #endif