xref: /petsc/src/sys/objects/ftn-custom/zstart.c (revision c98fd787ce49cfe1bba58d59168f91d3fdf7ec65)
1 /*
2   This file contains Fortran stubs for PetscInitialize and Finalize.
3 */
4 
5 /*
6     This is to prevent the Cray T3D version of MPI (University of Edinburgh)
7   from stupidly redefining MPI_INIT(). They put this in to detect errors
8   in C code,but here I do want to be calling the Fortran version from a
9   C subroutine.
10 */
11 #define T3DMPI_FORTRAN
12 #define T3EMPI_FORTRAN
13 
14 #include <petsc-private/fortranimpl.h>
15 
16 #if defined(PETSC_HAVE_CUDA)
17 #include <cublas.h>
18 #endif
19 #include <petscthreadcomm.h>
20 
21 #if defined(PETSC_HAVE_FORTRAN_CAPS)
22 #define petscinitialize_              PETSCINITIALIZE
23 #define petscfinalize_                PETSCFINALIZE
24 #define petscend_                     PETSCEND
25 #define iargc_                        IARGC
26 #define getarg_                       GETARG
27 #define mpi_init_                     MPI_INIT
28 #define petscgetcommoncomm_           PETSCGETCOMMONCOMM
29 #elif !defined(PETSC_HAVE_FORTRAN_UNDERSCORE)
30 #define petscinitialize_              petscinitialize
31 #define petscfinalize_                petscfinalize
32 #define petscend_                     petscend
33 #define mpi_init_                     mpi_init
34 #define iargc_                        iargc
35 #define getarg_                       getarg
36 #define petscgetcommoncomm_           petscgetcommoncomm
37 #endif
38 
39 #if defined(PETSC_HAVE_NAGF90)
40 #undef iargc_
41 #undef getarg_
42 #define iargc_  f90_unix_MP_iargc
43 #define getarg_ f90_unix_MP_getarg
44 #endif
45 #if defined(PETSC_USE_NARGS) /* Digital Fortran */
46 #undef iargc_
47 #undef getarg_
48 #define iargc_  NARGS
49 #define getarg_ GETARG
50 #elif defined(PETSC_HAVE_PXFGETARG_NEW)  /* cray x1 */
51 #undef iargc_
52 #undef getarg_
53 #define iargc_  ipxfargc_
54 #define getarg_ pxfgetarg_
55 #endif
56 #if defined(PETSC_HAVE_FORTRAN_IARGC_UNDERSCORE) /* HPUX + no underscore */
57 #undef iargc_
58 #undef getarg_
59 #define iargc_   iargc_
60 #define getarg_  getarg_
61 #endif
62 #if defined(PETSC_HAVE_GFORTRAN_IARGC) /* gfortran from gcc4 */
63 #undef iargc_
64 #undef getarg_
65 #define iargc_  _gfortran_iargc
66 #define getarg_ _gfortran_getarg_i4
67 #elif defined(PETSC_HAVE_BGL_IARGC) /* bgl g77 has different external & internal name mangling */
68 #undef iargc_
69 #undef getarg_
70 #define iargc  iargc_
71 #define getarg getarg_
72 #endif
73 
74 /*
75     The extra _ is because the f2c compiler puts an
76   extra _ at the end if the original routine name
77   contained any _.
78 */
79 #if defined(PETSC_HAVE_FORTRAN_UNDERSCORE_UNDERSCORE)
80 #undef mpi_init_
81 #define mpi_init_             mpi_init__
82 #endif
83 
84 PETSC_EXTERN void PETSC_STDCALL mpi_init_(int*);
85 PETSC_EXTERN void PETSC_STDCALL petscgetcommoncomm_(PetscMPIInt*);
86 
87 /*
88      Different Fortran compilers handle command lines in different ways
89 */
90 #if defined(PETSC_USE_NARGS)
91 PETSC_EXTERN short __stdcall NARGS();
92 PETSC_EXTERN void __stdcall GETARG(short*,char*,int,short *);
93 
94 #elif defined(PETSC_HAVE_FORTRAN_STDCALL)
95 PETSC_EXTERN int PETSC_STDCALL IARGC();
96 PETSC_EXTERN void PETSC_STDCALL GETARG(int *,char *,int);
97 
98 #elif defined(PETSC_HAVE_PXFGETARG_NEW)
99 PETSC_EXTERN int iargc_();
100 PETSC_EXTERN void getarg_(int*,char*,int*,int*,int);
101 
102 #else
103 PETSC_EXTERN int iargc_();
104 PETSC_EXTERN void getarg_(int*,char*,int);
105 /*
106       The Cray T3D/T3E use the PXFGETARG() function
107 */
108 #if defined(PETSC_HAVE_PXFGETARG)
109 PETSC_EXTERN void PXFGETARG(int*,_fcd,int*,int*);
110 #endif
111 #endif
112 
113 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
114 extern MPI_Op MPIU_SUM;
115 
116 PETSC_EXTERN void MPIAPI PetscSum_Local(void*,void*,PetscMPIInt*,MPI_Datatype*);
117 
118 #endif
119 #if defined(PETSC_USE_REAL___FLOAT128)
120 
121 PETSC_EXTERN void MPIAPI PetscSum_Local(void*,void*,PetscMPIInt*,MPI_Datatype*);
122 PETSC_EXTERN void MPIAPI PetscMax_Local(void*,void*,PetscMPIInt*,MPI_Datatype*);
123 PETSC_EXTERN void MPIAPI PetscMin_Local(void*,void*,PetscMPIInt*,MPI_Datatype*);
124 #endif
125 
126 extern MPI_Op PetscMaxSum_Op;
127 
128 PETSC_EXTERN void MPIAPI PetscMaxSum_Local(void*,void*,PetscMPIInt*,MPI_Datatype*);
129 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm,PetscMPIInt,void*,void*);
130 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm,PetscMPIInt,void*,void*);
131 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm,PetscMPIInt,void*,void*);
132 
133 extern PetscErrorCode  PetscOptionsCheckInitial_Private(void);
134 extern PetscErrorCode  PetscOptionsCheckInitial_Components(void);
135 extern PetscErrorCode  PetscInitialize_DynamicLibraries(void);
136 #if defined(PETSC_USE_LOG)
137 extern PetscErrorCode  PetscLogBegin_Private(void);
138 #endif
139 extern PetscErrorCode  PetscMallocAlign(size_t,int,const char[],const char[],void**);
140 extern PetscErrorCode  PetscFreeAlign(void*,int,const char[],const char[]);
141 extern int  PetscGlobalArgc;
142 extern char **PetscGlobalArgs;
143 
144 /*
145     Reads in Fortran command line argments and sends them to
146   all processors and adds them to Options database.
147 */
148 
149 PetscErrorCode PETScParseFortranArgs_Private(int *argc,char ***argv)
150 {
151 #if defined(PETSC_USE_NARGS)
152   short          i,flg;
153 #else
154   int            i;
155 #endif
156   PetscErrorCode ierr;
157   int            warg = 256;
158   PetscMPIInt    rank;
159   char           *p;
160 
161   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
162   if (!rank) {
163 #if defined(PETSC_HAVE_IARG_COUNT_PROGNAME)
164     *argc = iargc_();
165 #else
166     /* most compilers do not count the program name for argv[0] */
167     *argc = 1 + iargc_();
168 #endif
169   }
170   ierr = MPI_Bcast(argc,1,MPI_INT,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
171 
172   /* PetscTrMalloc() not yet set, so don't use PetscMalloc() */
173   ierr = PetscMallocAlign((*argc+1)*(warg*sizeof(char)+sizeof(char*)),0,0,0,(void**)argv);CHKERRQ(ierr);
174   (*argv)[0] = (char*)(*argv + *argc + 1);
175 
176   if (!rank) {
177     ierr = PetscMemzero((*argv)[0],(*argc)*warg*sizeof(char));CHKERRQ(ierr);
178     for (i=0; i<*argc; i++) {
179       (*argv)[i+1] = (*argv)[i] + warg;
180 #if defined(PETSC_HAVE_PXFGETARG_NEW)
181       {char *tmp = (*argv)[i];
182       int ilen;
183       getarg_(&i,tmp,&ilen,&ierr,warg);CHKERRQ(ierr);
184       tmp[ilen] = 0;}
185 #elif defined(PETSC_USE_NARGS)
186       GETARG(&i,(*argv)[i],warg,&flg);
187 #else
188       /*
189       Because the stupid #defines above define all kinds of things to getarg_ we cannot do this test
190       #elif defined(PETSC_HAVE_GETARG)
191       getarg_(&i,(*argv)[i],warg);
192       #else
193          SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Cannot get Fortran command line arguments");
194       */
195       getarg_(&i,(*argv)[i],warg);
196 #endif
197       /* zero out garbage at end of each argument */
198       p = (*argv)[i] + warg-1;
199       while (p > (*argv)[i]) {
200         if (*p == ' ') *p = 0;
201         p--;
202       }
203     }
204   }
205   ierr = MPI_Bcast((*argv)[0],*argc*warg,MPI_CHAR,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
206   if (rank) {
207     for (i=0; i<*argc; i++) (*argv)[i+1] = (*argv)[i] + warg;
208   }
209   return 0;
210 }
211 
212 /* -----------------------------------------------------------------------------------------------*/
213 
214 #if defined(PETSC_HAVE_SAWS)
215 #include <petscviewersaws.h>
216 extern PetscErrorCode  PetscInitializeSAWs(const char[]);
217 #endif
218 
219 /*
220     petscinitialize - Version called from Fortran.
221 
222     Notes:
223       Since this is called from Fortran it does not return error codes
224 
225 */
226 PETSC_EXTERN void PETSC_STDCALL petscinitialize_(CHAR filename PETSC_MIXED_LEN(len),PetscErrorCode *ierr PETSC_END_LEN(len))
227 {
228 #if defined (PETSC_USE_NARGS)
229   short       flg,i;
230 #else
231   int         i;
232 #if !defined(PETSC_HAVE_PXFGETARG_NEW) && !defined (PETSC_HAVE_PXFGETARG_NEW)
233   int         j;
234 #endif
235 #endif
236 #if defined(PETSC_HAVE_CUDA)
237   PetscBool   flg2;
238 #endif
239   int         flag;
240   PetscMPIInt size;
241   char        *t1,name[256],hostname[64];
242   PetscMPIInt f_petsc_comm_world;
243 
244   *ierr = PetscMemzero(name,256); if (*ierr) return;
245   if (PetscInitializeCalled) {*ierr = 0; return;}
246 
247   /* this must be initialized in a routine, not as a constant declaration*/
248   PETSC_STDOUT = stdout;
249   PETSC_STDERR = stderr;
250 
251   /* on Windows - set printf to default to printing 2 digit exponents */
252 #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
253   _set_output_format(_TWO_DIGIT_EXPONENT);
254 #endif
255 
256   *ierr = PetscOptionsCreate();
257   if (*ierr) return;
258   i = 0;
259 #if defined (PETSC_HAVE_PXFGETARG_NEW)
260   { int ilen,sierr;
261     getarg_(&i,name,&ilen,&sierr,256);
262     if (sierr) PetscStrncpy(name,"Unknown Name",256);
263     else name[ilen] = 0;
264   }
265 #elif defined(PETSC_USE_NARGS)
266   GETARG(&i,name,256,&flg);
267 #else
268   getarg_(&i,name,256);
269   /* Eliminate spaces at the end of the string */
270   for (j=254; j>=0; j--) {
271     if (name[j] != ' ') {
272       name[j+1] = 0;
273       break;
274     }
275   }
276   if (j<0) PetscStrncpy(name,"Unknown Name",256);
277 #endif
278   *ierr = PetscSetProgramName(name);
279   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize: Calling PetscSetProgramName()\n");return;}
280 
281   /* check if PETSC_COMM_WORLD is initialized by the user in fortran */
282   petscgetcommoncomm_(&f_petsc_comm_world);
283   MPI_Initialized(&flag);
284   if (!flag) {
285     PetscMPIInt mierr;
286 
287     if (f_petsc_comm_world) {(*PetscErrorPrintf)("You cannot set PETSC_COMM_WORLD if you have not initialized MPI first\n");return;}
288     /* MPI requires calling Fortran mpi_init() if main program is Fortran */
289 #if defined(PETSC_HAVE_MPIUNI) && defined(MPIUNI_AVOID_MPI_NAMESPACE)
290     mierr = MPI_Init((int*)0, (char***)0);
291 #else
292     mpi_init_(&mierr);
293 #endif
294     if (mierr) {
295       *ierr = mierr;
296       (*PetscErrorPrintf)("PetscInitialize: Calling Fortran MPI_Init()\n");
297       return;
298     }
299     PetscBeganMPI = PETSC_TRUE;
300   }
301   if (f_petsc_comm_world) PETSC_COMM_WORLD = MPI_Comm_f2c(*(MPI_Fint*)&f_petsc_comm_world); /* User called MPI_INITIALIZE() and changed PETSC_COMM_WORLD */
302   else PETSC_COMM_WORLD = MPI_COMM_WORLD;
303   PetscInitializeCalled = PETSC_TRUE;
304 
305   *ierr = PetscErrorPrintfInitialize();
306   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize: Calling PetscErrorPrintfInitialize()\n");return;}
307   *ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);
308   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize: Setting PetscGlobalRank\n");return;}
309   *ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);
310   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize: Setting PetscGlobalSize\n");return;}
311 
312   MPIU_BOOL = MPI_INT;
313   MPIU_ENUM = MPI_INT;
314 
315 #if defined(PETSC_HAVE_COMPLEX)
316   /*
317      Initialized the global variable; this is because with
318      shared libraries the constructors for global variables
319      are not called; at least on IRIX.
320   */
321   {
322 #if defined(PETSC_CLANGUAGE_CXX)
323     PetscComplex ic(0.0,1.0);
324     PETSC_i = ic;
325 #else
326     PETSC_i = _Complex_I;
327 #endif
328   }
329 
330 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
331   *ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);
332   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI types\n");return;}
333   *ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);
334   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI types\n");return;}
335   *ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);
336   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI types\n");return;}
337   *ierr = MPI_Type_commit(&MPIU_C_COMPLEX);
338   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI types\n");return;}
339   *ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);
340   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI ops\n");return;}
341 #endif
342 
343 #endif
344 
345 #if defined(PETSC_USE_REAL___FLOAT128)
346   *ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);
347   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI types\n");return;}
348   *ierr = MPI_Type_commit(&MPIU___FLOAT128);
349   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI types\n");return;}
350 #if defined(PETSC_HAVE_COMPLEX)
351   *ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);
352   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI types\n");return;}
353   *ierr = MPI_Type_commit(&MPIU___COMPLEX128);
354   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI types\n");return;}
355 #endif
356   *ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);
357   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI ops\n");return;}
358   *ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);
359   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI ops\n");return;}
360   *ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);
361   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI ops\n");return;}
362 #endif
363 
364   /*
365        Create the PETSc MPI reduction operator that sums of the first
366      half of the entries and maxes the second half.
367   */
368   *ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);
369   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI ops\n");return;}
370 
371   *ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);
372   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI types\n");return;}
373   *ierr = MPI_Type_commit(&MPIU_2SCALAR);
374   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI types\n");return;}
375 #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
376   *ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);
377   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI types\n");return;}
378   *ierr = MPI_Type_commit(&MPIU_2INT);
379   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI types\n");return;}
380 #endif
381   *ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);
382   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI keyvals\n");return;}
383   *ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);
384   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI keyvals\n");return;}
385   *ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);
386   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating MPI keyvals\n");return;}
387 
388   /*
389      PetscInitializeFortran() is called twice. Here it initializes
390      PETSC_NULL_CHARACTER_Fortran. Below it initializes the PETSC_VIEWERs.
391      The PETSC_VIEWERs have not been created yet, so they must be initialized
392      below.
393   */
394   PetscInitializeFortran();
395   PETScParseFortranArgs_Private(&PetscGlobalArgc,&PetscGlobalArgs);
396   FIXCHAR(filename,len,t1);
397   *ierr = PetscOptionsInsert(&PetscGlobalArgc,&PetscGlobalArgs,t1);
398   FREECHAR(filename,t1);
399   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Creating options database\n");return;}
400   *ierr = PetscOptionsCheckInitial_Private();
401   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Checking initial options\n");return;}
402   *ierr = PetscCitationsInitialize();
403   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:PetscCitationsInitialize()\n");return;}
404 #if defined(PETSC_HAVE_SAWS)
405   *ierr = PetscInitializeSAWs(NULL);
406   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Initializing SAWs\n");return;}
407 #endif
408 #if defined(PETSC_USE_LOG)
409   *ierr = PetscLogBegin_Private();
410   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize: intializing logging\n");return;}
411 #endif
412   *ierr = PetscInitialize_DynamicLibraries();
413   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Initializing dynamic libraries\n");return;}
414 
415   *ierr = PetscInitializeFortran();
416   if (*ierr) { (*PetscErrorPrintf)("PetscInitialize:Setting up common block\n");return;}
417 
418   *ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);
419   if (*ierr) { (*PetscErrorPrintf)("PetscInitialize:Getting MPI_Comm_size()\n");return;}
420   *ierr = PetscInfo1(0,"(Fortran):PETSc successfully started: procs %d\n",size);
421   if (*ierr) { (*PetscErrorPrintf)("PetscInitialize:Calling PetscInfo()\n");return;}
422   *ierr = PetscGetHostName(hostname,64);
423   if (*ierr) { (*PetscErrorPrintf)("PetscInitialize:Getting hostname\n");return;}
424   *ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);
425   if (*ierr) { (*PetscErrorPrintf)("PetscInitialize:Calling PetscInfo()\n");return;}
426   *ierr = PetscOptionsCheckInitial_Components();
427   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Checking initial options\n");return;}
428 
429   *ierr = PetscThreadCommInitializePackage();
430   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:Calling PetscThreadCommInitialize()\n");return;}
431 
432   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates pthread_key */
433 #if defined(PETSC_USE_DEBUG)
434   *ierr = PetscStackCreate();
435   if (*ierr) {(*PetscErrorPrintf)("PetscInitialize:PetscStackCreate()\n");return;}
436 #endif
437 
438 #if defined(PETSC_HAVE_CUDA)
439   flg2  = PETSC_TRUE;
440   *ierr = PetscOptionsGetBool(NULL,"-cublas",&flg2,NULL);
441   if (flg2) cublasInit();
442 #endif
443 }
444 
445 PETSC_EXTERN void PETSC_STDCALL petscfinalize_(PetscErrorCode *ierr)
446 {
447 #if defined(PETSC_HAVE_SUNMATHPRO)
448   extern void standard_arithmetic();
449   standard_arithmetic();
450 #endif
451   /* was malloced with PetscMallocAlign() so free the same way */
452   *ierr = PetscFreeAlign(PetscGlobalArgs,0,0,0);if (*ierr) {(*PetscErrorPrintf)("PetscFinalize:Freeing args\n");return;}
453 
454   *ierr = PetscFinalize();
455 }
456 
457 void PETSC_STDCALL petscend_(PetscErrorCode *ierr)
458 {
459 #if defined(PETSC_HAVE_SUNMATHPRO)
460   extern void standard_arithmetic();
461   standard_arithmetic();
462 #endif
463 
464   *ierr = PetscEnd();
465 }
466 
467