xref: /petsc/src/sys/tutorials/ex3.c (revision 609caa7c8c030312b00807b4f015fd827bb80932)
1c4762a1bSJed Brown static char help[] = "Augmenting PETSc profiling by add events.\n\
2c4762a1bSJed Brown Run this program with one of the\n\
3c4762a1bSJed Brown following options to generate logging information:  -log, -log_view,\n\
4c4762a1bSJed Brown -log_all.  The PETSc routines automatically log event times and flops,\n\
5c4762a1bSJed Brown so this monitoring is intended solely for users to employ in application\n\
6c4762a1bSJed Brown codes.\n\n";
7c4762a1bSJed Brown 
8c4762a1bSJed Brown /*
9c4762a1bSJed Brown   Include "petscsys.h" so that we can use PETSc profiling routines.
10c4762a1bSJed Brown */
11c4762a1bSJed Brown #include <petscsys.h>
12c4762a1bSJed Brown #include <petscviewer.h>
13c4762a1bSJed Brown 
main(int argc,char ** argv)14d71ae5a4SJacob Faibussowitsch int main(int argc, char **argv)
15d71ae5a4SJacob Faibussowitsch {
16c4762a1bSJed Brown   PetscMPIInt   rank;
17c4762a1bSJed Brown   int           i, imax = 10000, icount;
18c4762a1bSJed Brown   PetscLogEvent USER_EVENT, check_USER_EVENT;
19c4762a1bSJed Brown 
20327415f7SBarry Smith   PetscFunctionBeginUser;
219566063dSJacob Faibussowitsch   PetscCall(PetscInitialize(&argc, &argv, NULL, help));
22c4762a1bSJed Brown 
23c4762a1bSJed Brown   /*
24c4762a1bSJed Brown      Create a new user-defined event.
25c4762a1bSJed Brown       - Note that PetscLogEventRegister() returns to the user a unique
26c4762a1bSJed Brown         integer event number, which should then be used for profiling
27c4762a1bSJed Brown         the event via PetscLogEventBegin() and PetscLogEventEnd().
28c4762a1bSJed Brown       - The user can also optionally log floating point operations
29c4762a1bSJed Brown         with the routine PetscLogFlops().
30c4762a1bSJed Brown   */
319566063dSJacob Faibussowitsch   PetscCall(PetscLogEventRegister("User event", PETSC_VIEWER_CLASSID, &USER_EVENT));
329566063dSJacob Faibussowitsch   PetscCall(PetscLogEventGetId("User event", &check_USER_EVENT));
3308401ef6SPierre Jolivet   PetscCheck(USER_EVENT == check_USER_EVENT, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Event Ids do not match");
34c4762a1bSJed Brown 
359566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(USER_EVENT, 0, 0, 0, 0));
36c4762a1bSJed Brown   icount = 0;
37c4762a1bSJed Brown   for (i = 0; i < imax; i++) icount++;
38e57ab8abSSatish Balay   (void)icount;
399566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(imax));
409566063dSJacob Faibussowitsch   PetscCall(PetscSleep(0.5));
419566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(USER_EVENT, 0, 0, 0, 0));
42c4762a1bSJed Brown 
43c4762a1bSJed Brown   /*
44c4762a1bSJed Brown      We disable the logging of an event.
45c4762a1bSJed Brown 
46c4762a1bSJed Brown   */
479566063dSJacob Faibussowitsch   PetscCall(PetscLogEventDeactivate(USER_EVENT));
489566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(USER_EVENT, 0, 0, 0, 0));
499566063dSJacob Faibussowitsch   PetscCall(PetscSleep(0.5));
509566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(USER_EVENT, 0, 0, 0, 0));
51c4762a1bSJed Brown 
52c4762a1bSJed Brown   /*
53c4762a1bSJed Brown      We next enable the logging of an event
54c4762a1bSJed Brown   */
559566063dSJacob Faibussowitsch   PetscCall(PetscLogEventActivate(USER_EVENT));
569566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(USER_EVENT, 0, 0, 0, 0));
579566063dSJacob Faibussowitsch   PetscCall(PetscSleep(0.5));
589566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(USER_EVENT, 0, 0, 0, 0));
59c4762a1bSJed Brown 
60c4762a1bSJed Brown   /*
61c4762a1bSJed Brown      We test event logging imbalance
62c4762a1bSJed Brown   */
639566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank));
649566063dSJacob Faibussowitsch   if (rank == 0) PetscCall(PetscSleep(0.5));
659566063dSJacob Faibussowitsch   PetscCall(PetscLogEventSync(USER_EVENT, PETSC_COMM_WORLD));
669566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(USER_EVENT, 0, 0, 0, 0));
679566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Barrier(PETSC_COMM_WORLD));
689566063dSJacob Faibussowitsch   PetscCall(PetscSleep(0.5));
699566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(USER_EVENT, 0, 0, 0, 0));
70c4762a1bSJed Brown 
719566063dSJacob Faibussowitsch   PetscCall(PetscFinalize());
72b122ec5aSJacob Faibussowitsch   return 0;
73c4762a1bSJed Brown }
74c4762a1bSJed Brown 
75c4762a1bSJed Brown /*TEST
76c4762a1bSJed Brown 
77c4762a1bSJed Brown    build:
78dfd57a17SPierre Jolivet      requires: defined(PETSC_USE_LOG)
79c4762a1bSJed Brown 
80c4762a1bSJed Brown    test:
81*3886731fSPierre Jolivet      output_file: output/empty.out
82c4762a1bSJed Brown 
83c4762a1bSJed Brown TEST*/
84