xref: /petsc/src/sys/tutorials/ex3.c (revision dfd57a172ac9fa6c7b5fe6de6ab5df85cefc2996)
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   PetscErrorCode ierr;
26c4762a1bSJed Brown   PetscMPIInt    rank;
27c4762a1bSJed Brown   int            i,imax=10000,icount;
28c4762a1bSJed Brown   PetscLogEvent  USER_EVENT,check_USER_EVENT;
29c4762a1bSJed Brown 
30c4762a1bSJed Brown   ierr = PetscInitialize(&argc,&argv,NULL,help);if (ierr) return ierr;
31c4762a1bSJed Brown 
32c4762a1bSJed Brown   /*
33c4762a1bSJed Brown      Create a new user-defined event.
34c4762a1bSJed Brown       - Note that PetscLogEventRegister() returns to the user a unique
35c4762a1bSJed Brown         integer event number, which should then be used for profiling
36c4762a1bSJed Brown         the event via PetscLogEventBegin() and PetscLogEventEnd().
37c4762a1bSJed Brown       - The user can also optionally log floating point operations
38c4762a1bSJed Brown         with the routine PetscLogFlops().
39c4762a1bSJed Brown   */
40c4762a1bSJed Brown   ierr = PetscLogEventRegister("User event",PETSC_VIEWER_CLASSID,&USER_EVENT);CHKERRQ(ierr);
41c4762a1bSJed Brown   ierr = PetscLogEventGetId("User event",&check_USER_EVENT);CHKERRQ(ierr);
42c4762a1bSJed Brown   if (USER_EVENT != check_USER_EVENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Event Ids do not match");
43c4762a1bSJed Brown 
44c4762a1bSJed Brown   ierr = PetscLogEventBegin(USER_EVENT,0,0,0,0);CHKERRQ(ierr);
45c4762a1bSJed Brown   icount = 0;
46c4762a1bSJed Brown   for (i=0; i<imax; i++) icount++;
47c4762a1bSJed Brown   ierr = PetscLogFlops(imax);CHKERRQ(ierr);
48c4762a1bSJed Brown   ierr = PetscSleep(0.5);CHKERRQ(ierr);
49c4762a1bSJed Brown   ierr = PetscLogEventEnd(USER_EVENT,0,0,0,0);CHKERRQ(ierr);
50c4762a1bSJed Brown 
51c4762a1bSJed Brown   /*
52c4762a1bSJed Brown      We disable the logging of an event.
53c4762a1bSJed Brown 
54c4762a1bSJed Brown   */
55c4762a1bSJed Brown   ierr = PetscLogEventDeactivate(USER_EVENT);CHKERRQ(ierr);
56c4762a1bSJed Brown   ierr = PetscLogEventBegin(USER_EVENT,0,0,0,0);CHKERRQ(ierr);
57c4762a1bSJed Brown   ierr = PetscSleep(0.5);CHKERRQ(ierr);
58c4762a1bSJed Brown   ierr = PetscLogEventEnd(USER_EVENT,0,0,0,0);CHKERRQ(ierr);
59c4762a1bSJed Brown 
60c4762a1bSJed Brown   /*
61c4762a1bSJed Brown      We next enable the logging of an event
62c4762a1bSJed Brown   */
63c4762a1bSJed Brown   ierr = PetscLogEventActivate(USER_EVENT);CHKERRQ(ierr);
64c4762a1bSJed Brown   ierr = PetscLogEventBegin(USER_EVENT,0,0,0,0);CHKERRQ(ierr);
65c4762a1bSJed Brown   ierr = PetscSleep(0.5);CHKERRQ(ierr);
66c4762a1bSJed Brown   ierr = PetscLogEventEnd(USER_EVENT,0,0,0,0);CHKERRQ(ierr);
67c4762a1bSJed Brown 
68c4762a1bSJed Brown   /*
69c4762a1bSJed Brown      We test event logging imbalance
70c4762a1bSJed Brown   */
71ffc4695bSBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRMPI(ierr);
72c4762a1bSJed Brown   if (!rank) {ierr = PetscSleep(0.5);CHKERRQ(ierr);}
73c4762a1bSJed Brown   ierr = PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD);CHKERRQ(ierr);
74c4762a1bSJed Brown   ierr = PetscLogEventBegin(USER_EVENT,0,0,0,0);CHKERRQ(ierr);
75ffc4695bSBarry Smith   ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRMPI(ierr);
76c4762a1bSJed Brown   ierr = PetscSleep(0.5);CHKERRQ(ierr);
77c4762a1bSJed Brown   ierr = PetscLogEventEnd(USER_EVENT,0,0,0,0);CHKERRQ(ierr);
78c4762a1bSJed Brown 
79c4762a1bSJed Brown   ierr = PetscFinalize();
80c4762a1bSJed Brown   return ierr;
81c4762a1bSJed Brown }
82c4762a1bSJed Brown 
83c4762a1bSJed Brown /*TEST
84c4762a1bSJed Brown 
85c4762a1bSJed Brown    build:
86*dfd57a17SPierre Jolivet      requires: defined(PETSC_USE_LOG)
87c4762a1bSJed Brown 
88c4762a1bSJed Brown    test:
89c4762a1bSJed Brown 
90c4762a1bSJed Brown TEST*/
91