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