xref: /petsc/src/sys/tutorials/ex3.c (revision 9566063d113dddea24716c546802770db7481bc0)
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 /*T
10c4762a1bSJed Brown    Concepts: PetscLog^user-defined event profiling
11c4762a1bSJed Brown    Concepts: profiling^user-defined event
12c4762a1bSJed Brown    Concepts: PetscLog^activating/deactivating events for profiling
13c4762a1bSJed Brown    Concepts: profiling^activating/deactivating events
14c4762a1bSJed Brown    Processors: n
15c4762a1bSJed Brown T*/
16c4762a1bSJed Brown 
17c4762a1bSJed Brown /*
18c4762a1bSJed Brown   Include "petscsys.h" so that we can use PETSc profiling routines.
19c4762a1bSJed Brown */
20c4762a1bSJed Brown #include <petscsys.h>
21c4762a1bSJed Brown #include <petscviewer.h>
22c4762a1bSJed Brown 
23c4762a1bSJed Brown int main(int argc,char **argv)
24c4762a1bSJed Brown {
25c4762a1bSJed Brown   PetscMPIInt    rank;
26c4762a1bSJed Brown   int            i,imax=10000,icount;
27c4762a1bSJed Brown   PetscLogEvent  USER_EVENT,check_USER_EVENT;
28c4762a1bSJed Brown 
29*9566063dSJacob Faibussowitsch   PetscCall(PetscInitialize(&argc,&argv,NULL,help));
30c4762a1bSJed Brown 
31c4762a1bSJed Brown   /*
32c4762a1bSJed Brown      Create a new user-defined event.
33c4762a1bSJed Brown       - Note that PetscLogEventRegister() returns to the user a unique
34c4762a1bSJed Brown         integer event number, which should then be used for profiling
35c4762a1bSJed Brown         the event via PetscLogEventBegin() and PetscLogEventEnd().
36c4762a1bSJed Brown       - The user can also optionally log floating point operations
37c4762a1bSJed Brown         with the routine PetscLogFlops().
38c4762a1bSJed Brown   */
39*9566063dSJacob Faibussowitsch   PetscCall(PetscLogEventRegister("User event",PETSC_VIEWER_CLASSID,&USER_EVENT));
40*9566063dSJacob Faibussowitsch   PetscCall(PetscLogEventGetId("User event",&check_USER_EVENT));
412c71b3e2SJacob Faibussowitsch   PetscCheckFalse(USER_EVENT != check_USER_EVENT,PETSC_COMM_SELF,PETSC_ERR_PLIB,"Event Ids do not match");
42c4762a1bSJed Brown 
43*9566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(USER_EVENT,0,0,0,0));
44c4762a1bSJed Brown   icount = 0;
45c4762a1bSJed Brown   for (i=0; i<imax; i++) icount++;
46*9566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(imax));
47*9566063dSJacob Faibussowitsch   PetscCall(PetscSleep(0.5));
48*9566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(USER_EVENT,0,0,0,0));
49c4762a1bSJed Brown 
50c4762a1bSJed Brown   /*
51c4762a1bSJed Brown      We disable the logging of an event.
52c4762a1bSJed Brown 
53c4762a1bSJed Brown   */
54*9566063dSJacob Faibussowitsch   PetscCall(PetscLogEventDeactivate(USER_EVENT));
55*9566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(USER_EVENT,0,0,0,0));
56*9566063dSJacob Faibussowitsch   PetscCall(PetscSleep(0.5));
57*9566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(USER_EVENT,0,0,0,0));
58c4762a1bSJed Brown 
59c4762a1bSJed Brown   /*
60c4762a1bSJed Brown      We next enable the logging of an event
61c4762a1bSJed Brown   */
62*9566063dSJacob Faibussowitsch   PetscCall(PetscLogEventActivate(USER_EVENT));
63*9566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(USER_EVENT,0,0,0,0));
64*9566063dSJacob Faibussowitsch   PetscCall(PetscSleep(0.5));
65*9566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(USER_EVENT,0,0,0,0));
66c4762a1bSJed Brown 
67c4762a1bSJed Brown   /*
68c4762a1bSJed Brown      We test event logging imbalance
69c4762a1bSJed Brown   */
70*9566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD,&rank));
71*9566063dSJacob Faibussowitsch   if (rank == 0) PetscCall(PetscSleep(0.5));
72*9566063dSJacob Faibussowitsch   PetscCall(PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD));
73*9566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(USER_EVENT,0,0,0,0));
74*9566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Barrier(PETSC_COMM_WORLD));
75*9566063dSJacob Faibussowitsch   PetscCall(PetscSleep(0.5));
76*9566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(USER_EVENT,0,0,0,0));
77c4762a1bSJed Brown 
78*9566063dSJacob Faibussowitsch   PetscCall(PetscFinalize());
79b122ec5aSJacob Faibussowitsch   return 0;
80c4762a1bSJed Brown }
81c4762a1bSJed Brown 
82c4762a1bSJed Brown /*TEST
83c4762a1bSJed Brown 
84c4762a1bSJed Brown    build:
85dfd57a17SPierre Jolivet      requires: defined(PETSC_USE_LOG)
86c4762a1bSJed Brown 
87c4762a1bSJed Brown    test:
88c4762a1bSJed Brown 
89c4762a1bSJed Brown TEST*/
90