1 /* $Id: petsclog.h,v 1.107 1997/07/02 22:28:35 bsmith Exp balay $ */ 2 3 /* 4 Defines profile/logging in PETSc. 5 */ 6 7 #if !defined(__PLOG_PACKAGE) 8 #define __PLOG_PACKAGE 9 #include "petsc.h" 10 11 /* 12 Lists all PETSc events that are logged/profiled. 13 14 If you add an event here, make sure you add it to 15 petsc/bin/petscview.cfg, 16 petsc/bin/petscview, 17 petsc/src/plog/src/plog.c, 18 petsc/src/plog/src/plogmpe.c, and 19 petsc/include/FINCLUDE/petsclog.h!!! 20 */ 21 #define MAT_Mult 0 22 #define MAT_MatrixFreeMult 1 23 #define MAT_AssemblyBegin 2 24 #define MAT_AssemblyEnd 3 25 #define MAT_GetReordering 4 26 #define MAT_MultTrans 5 27 #define MAT_MultAdd 6 28 #define MAT_MultTransAdd 7 29 #define MAT_LUFactor 8 30 #define MAT_CholeskyFactor 9 31 #define MAT_LUFactorSymbolic 10 32 #define MAT_ILUFactorSymbolic 11 33 #define MAT_CholeskyFactorSymbolic 12 34 #define MAT_IncompleteCholeskyFactorSymbolic 13 35 #define MAT_LUFactorNumeric 14 36 #define MAT_CholeskyFactorNumeric 15 37 #define MAT_Relax 16 38 #define MAT_Copy 17 39 #define MAT_Convert 18 40 #define MAT_Scale 19 41 #define MAT_ZeroEntries 20 42 #define MAT_Solve 21 43 #define MAT_SolveAdd 22 44 #define MAT_SolveTrans 23 45 #define MAT_SolveTransAdd 24 46 #define MAT_SetValues 25 47 #define MAT_ForwardSolve 26 48 #define MAT_BackwardSolve 27 49 #define MAT_Load 28 50 #define MAT_View 29 51 #define MAT_ILUFactor 30 52 #define MAT_GetColoring 31 53 #define MAT_GetSubMatrices 32 54 #define MAT_GetValues 33 55 #define MAT_IncreaseOverlap 34 56 #define MAT_GetRow 35 57 58 #define VEC_Dot 40 59 #define VEC_Norm 41 60 #define VEC_Max 42 61 #define VEC_Min 43 62 #define VEC_TDot 44 63 #define VEC_Scale 45 64 #define VEC_Copy 46 65 #define VEC_Set 47 66 #define VEC_AXPY 48 67 #define VEC_AYPX 49 68 #define VEC_Swap 50 69 #define VEC_WAXPY 51 70 #define VEC_AssemblyBegin 52 71 #define VEC_AssemblyEnd 53 72 #define VEC_MTDot 54 73 #define VEC_MDot 55 74 #define VEC_MAXPY 56 75 #define VEC_PMult 57 76 #define VEC_SetValues 58 77 #define VEC_Load 59 78 #define VEC_View 60 79 #define VEC_ScatterBegin 61 80 #define VEC_ScatterEnd 62 81 #define VEC_SetRandom 63 82 83 #define SLES_Solve 70 84 #define SLES_SetUp 71 85 86 #define KSP_GMRESOrthogonalization 72 87 88 #define PC_ModifySubMatrices 74 89 #define PC_SetUp 75 90 #define PC_SetUpOnBlocks 76 91 #define PC_Apply 77 92 #define PC_ApplySymmetricLeft 78 93 #define PC_ApplySymmetricRight 79 94 95 #define SNES_Solve 80 96 #define SNES_LineSearch 81 97 #define SNES_FunctionEval 82 98 #define SNES_JacobianEval 83 99 #define SNES_MinimizationFunctionEval 84 100 #define SNES_GradientEval 85 101 #define SNES_HessianEval 86 102 103 #define TS_Step 90 104 #define TS_PseudoComputeTimeStep 91 105 106 #define Petsc_Barrier 100 107 108 #define EC_SetUp 105 109 #define EC_Solve 106 110 111 #define DFVec_RefineVector 110 112 #define DFVec_AssembleFullVector 111 113 #define DFVec_GetComponentVectors 112 114 #define DFVec_DrawContours 113 115 116 /* 117 Event numbers PLOG_USER_EVENT_LOW to PLOG_USER_EVENT_HIGH are reserved 118 for applications. Make sure that src/plog/src/plog.c defines enough 119 entries in (*name)[] to go up to PLOG_USER_EVENT_HIGH. 120 */ 121 #define PLOG_USER_EVENT_LOW_STATIC 120 122 #define PLOG_USER_EVENT_HIGH 200 123 124 /* Global flop counter */ 125 extern PLogDouble _TotalFlops; 126 127 /* General logging of information; different from event logging */ 128 extern int PLogInfo(void*,char*,...); 129 extern int PLogInfoDeactivateClass(int); 130 extern int PLogInfoActivateClass(int); 131 extern int PLogPrintInfo; /* if 1, indicates PLogInfo() is turned on */ 132 133 #if defined(PETSC_LOG) /* --------------------------------------------*/ 134 135 #define PLogFlops(n) {_TotalFlops += (n);} 136 137 #if defined (HAVE_MPE) 138 #include "mpe.h" 139 #define MPEBEGIN 1000 140 extern int PLogMPEBegin(); 141 extern int PLogMPEDump(char *); 142 extern int UseMPE,PLogEventMPEFlags[]; 143 extern int PLogEventMPEActivate(int); 144 extern int PLogEventMPEDeactivate(int); 145 #else 146 #define PLogEventMPEActivate(a) 0 147 #define PLogEventMPEDeactivate(a) 0 148 #endif 149 150 extern int PLogEventActivate(int); 151 extern int PLogEventDeactivate(int); 152 153 extern int PLogEventActivateClass(int); 154 extern int PLogEventDeactivateClass(int); 155 156 extern int PLogEventFlags[]; 157 extern int (*_PLogPLB)(int,int,PetscObject,PetscObject,PetscObject,PetscObject); 158 extern int (*_PLogPLE)(int,int,PetscObject,PetscObject,PetscObject,PetscObject); 159 extern int (*_PLogPHC)(PetscObject); 160 extern int (*_PLogPHD)(PetscObject); 161 162 #if defined(HAVE_MPE) 163 #define PLogEventBegin(e,o1,o2,o3,o4) \ 164 { \ 165 if (_PLogPLB && PLogEventFlags[e]) \ 166 (*_PLogPLB)(e,0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4));\ 167 if (UseMPE && PLogEventMPEFlags[e])\ 168 MPE_Log_event(MPEBEGIN+2*e,0,"");\ 169 } 170 #else 171 #define PLogEventBegin(e,o1,o2,o3,o4) \ 172 { \ 173 if (_PLogPLB && PLogEventFlags[e]) \ 174 (*_PLogPLB)(e,0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4));\ 175 } 176 #endif 177 178 #if defined(HAVE_MPE) 179 #define PLogEventEnd(e,o1,o2,o3,o4) {\ 180 if (_PLogPLE && PLogEventFlags[e]) \ 181 (*_PLogPLE)(e,0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4));\ 182 if (UseMPE && PLogEventMPEFlags[e])\ 183 MPE_Log_event(MPEBEGIN+2*e+1,0,"");\ 184 } 185 #else 186 #define PLogEventEnd(e,o1,o2,o3,o4) {\ 187 if (_PLogPLE && PLogEventFlags[e]) \ 188 (*_PLogPLE)(e,0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4));\ 189 } 190 #endif 191 192 193 #define PLogObjectParent(p,c) {PetscValidHeader((PetscObject)c); \ 194 PetscValidHeader((PetscObject)p);\ 195 ((PetscObject)(c))->parent = (PetscObject) p;} 196 #define PLogObjectParents(p,n,d) {int _i; for ( _i=0; _i<n; _i++ ) \ 197 PLogObjectParent(p,(d)[_i]);} 198 #define PLogObjectCreate(h) {if (_PLogPHC) (*_PLogPHC)((PetscObject)h);} 199 #define PLogObjectDestroy(h) {if (_PLogPHD) (*_PLogPHD)((PetscObject)h);} 200 #define PLogObjectMemory(p,m) {PetscValidHeader((PetscObject)p);\ 201 ((PetscObject)(p))->mem += (m);} 202 extern int PLogObjectState(PetscObject,char *,...); 203 extern int PLogDestroy(); 204 extern int PLogStagePush(int); 205 extern int PLogStagePop(); 206 extern int PLogStageRegister(int,char*); 207 extern int PLogPrintSummary(MPI_Comm,char *); 208 extern int PLogBegin(); 209 extern int PLogTraceBegin(FILE *); 210 extern int PLogAllBegin(); 211 extern int PLogSet(int (*)(int,int,PetscObject,PetscObject,PetscObject,PetscObject), 212 int (*)(int,int,PetscObject,PetscObject,PetscObject,PetscObject)); 213 extern int PLogDump(char*); 214 extern int PLogEventRegister(int*,char*,char*); 215 extern PLogDouble PetscGetFlops(); 216 217 extern PLogDouble irecv_ct, isend_ct, wait_ct, wait_any_ct, recv_ct, send_ct; 218 extern PLogDouble irecv_len, isend_len, recv_len, send_len; 219 extern PLogDouble wait_all_ct,allreduce_ct,sum_of_waits_ct; 220 /* 221 This does not work for MPI-Uni because our src/mpiuni/mpi.h file 222 uses macros to defined the MPI operations. 223 224 It does not work correctly from HP-UX because it processes the 225 macros in a way that sometimes it double counts. 226 227 It does not work with Windows NT because winmpich lacks MPI_Type_size() 228 */ 229 #if !defined(PETSC_USING_MPIUNI) && !defined(PARCH_hpux) && !defined (PARCH_nt) 230 /* 231 Logging of MPI activities 232 */ 233 234 #define TypeSize(buff,count,type) \ 235 { \ 236 if (type == MPIU_SCALAR) { \ 237 buff += (PLogDouble) ((count)*sizeof(Scalar)); \ 238 } else if (type == MPI_INT) { \ 239 buff += (PLogDouble) ((count)*sizeof(int)); \ 240 } else { \ 241 int _size; MPI_Type_size(type,&_size); buff += (PLogDouble) ((count)*_size); \ 242 } \ 243 } 244 245 #define MPI_Irecv( buf, count, datatype, source, tag, comm, request) \ 246 { \ 247 MPI_Irecv( buf, count, datatype, source, tag, comm, request); \ 248 irecv_ct++; TypeSize(irecv_len,count,datatype); \ 249 } 250 251 #define MPI_Isend( buf, count, datatype, dest, tag, comm, request) \ 252 { \ 253 MPI_Isend( buf, count, datatype, dest, tag, comm, request); \ 254 isend_ct++; TypeSize(isend_len,count,datatype); \ 255 } 256 257 #define MPI_Startall_irecv( count,number,requests) \ 258 { \ 259 MPI_Startall( number, requests); \ 260 irecv_ct += (PLogDouble)(number); irecv_len += (PLogDouble) (count*sizeof(Scalar)); \ 261 } 262 263 #define MPI_Startall_isend( count,number,requests) \ 264 { \ 265 MPI_Startall( number, requests); \ 266 isend_ct += (PLogDouble)(number); isend_len += (PLogDouble) (count*sizeof(Scalar)); \ 267 } 268 269 #define MPI_Start_isend(count, requests) \ 270 { \ 271 MPI_Start( requests); \ 272 isend_ct++; isend_len += (PLogDouble) (count*sizeof(Scalar)); \ 273 } 274 275 #define MPI_Recv( buf, count, datatype, source, tag, comm, status) \ 276 { \ 277 MPI_Recv( buf, count, datatype, source, tag, comm, status); \ 278 recv_ct++; TypeSize(recv_len,count,datatype); \ 279 } 280 281 #define MPI_Send( buf, count, datatype, dest, tag, comm) \ 282 { \ 283 MPI_Send( buf, count, datatype, dest, tag, comm); \ 284 send_ct++; TypeSize(send_len,count,datatype); \ 285 } 286 287 #define MPI_Wait(request, status) \ 288 ( \ 289 wait_ct++, sum_of_waits_ct++, \ 290 MPI_Wait(request, status) \ 291 ) 292 293 #define MPI_Waitany(a, b, c, d) \ 294 ( \ 295 wait_any_ct++, sum_of_waits_ct++, \ 296 MPI_Waitany(a, b, c, d) \ 297 ) 298 299 #define MPI_Waitall(count, array_of_requests, array_of_statuses) \ 300 ( \ 301 wait_all_ct++, sum_of_waits_ct += (PLogDouble) (count), \ 302 MPI_Waitall(count, array_of_requests, array_of_statuses) \ 303 ) 304 305 #define MPI_Allreduce( sendbuf, recvbuf, count, datatype, op, comm) \ 306 ( \ 307 allreduce_ct++, \ 308 MPI_Allreduce( sendbuf, recvbuf, count, datatype, op, comm) \ 309 ) 310 #else 311 312 #define MPI_Startall_irecv( count,number,requests) \ 313 { \ 314 MPI_Startall( number, requests); \ 315 } 316 317 #define MPI_Startall_isend( count,number,requests) \ 318 { \ 319 MPI_Startall( number, requests); \ 320 } 321 322 #define MPI_Start_isend(count, requests) \ 323 { \ 324 MPI_Start( requests); \ 325 } 326 327 #endif /* ! PETSC_USING_MPIUNI && ! PARCH_hpux */ 328 329 #else /* ------------------------------------------------------------*/ 330 331 #define PLogFlops(n) 332 333 #if defined (HAVE_MPE) 334 #define MPEBEGIN 1000 335 extern int PLogMPEBegin(); 336 extern int PLogMPEDump(char *); 337 #else 338 #define PLogEventMPEActivate(a) 0 339 #define PLogEventMPEDeactivate(a) 0 340 #endif 341 342 #define PLogEventActivate(a) 0 343 #define PLogEventDeactivate(a) 0 344 345 #define PLogEventActivateClass(a) 0 346 #define PLogEventDeactivateClass(a) 0 347 348 #define _PLogPLB 0 349 #define _PLogPLE 0 350 #define _PLogPHC 0 351 #define _PLogPHD 0 352 #define PetscGetFlops() 0.0 353 #define PLogEventBegin(e,o1,o2,o3,o4) 354 #define PLogEventEnd(e,o1,o2,o3,o4) 355 #define PLogObjectParent(p,c) 356 #define PLogObjectParents(p,n,c) 357 #define PLogObjectCreate(h) 358 #define PLogObjectDestroy(h) 359 #define PLogObjectMemory(p,m) 360 #define PLogDestroy() 361 #define PLogStagePush(a) 362 #define PLogStagePop() 363 #define PLogStageRegister(a,b) 364 #define PLogPrintSummary(comm,file) 365 #define PLogBegin() 366 #define PLogTraceBegin(file) 0 367 #define PLogSet(lb,le) 368 #define PLogAllBegin() 369 #define PLogDump(char) 370 #define PLogEventRegister(a,b,c) 0 371 #define PLogMPEBegin() 372 #define PLogMPEDump(a) 373 extern int PLogObjectState(PetscObject,char *,...); 374 375 /* If PETSC_LOG is NOT defined, these still need to be! */ 376 #define MPI_Startall_irecv( count,number,requests) \ 377 { \ 378 MPI_Startall( number, requests); \ 379 } 380 381 #define MPI_Startall_isend( count,number,requests) \ 382 { \ 383 MPI_Startall( number, requests); \ 384 } 385 386 #define MPI_Start_isend(count, requests) \ 387 { \ 388 MPI_Start( requests); \ 389 } 390 #endif /* PETSC_LOG */ 391 392 /*MC 393 PLogFlops - Adds floating point operations to the global counter. 394 395 Input Parameter: 396 . f - flop counter 397 398 Synopsis: 399 void PLogFlops(int f) 400 401 Notes: 402 A global counter logs all PETSc flop counts. The user can use 403 PLogFlops() to increment this counter to include flops for the 404 application code. 405 406 PETSc automatically logs library events if the code has been 407 compiled with -DPETSC_LOG (which is the default), and -log, 408 -log_summary, or -log_all are specified. PLogFlops() is 409 intended for logging user flops to supplement this PETSc 410 information. 411 412 Example of Usage: 413 $ int USER_EVENT; 414 $ PLogEventRegister(&USER_EVENT,"User event","Color:"); 415 $ PLogEventBegin(USER_EVENT,0,0,0,0); 416 $ [code segment to monitor] 417 $ PLogFlops(user_flops) 418 $ PLogEventEnd(USER_EVENT,0,0,0,0); 419 420 .seealso: PLogEventRegister(), PLogEventBegin(), PLogEventEnd(), PetscGetFlops() 421 422 .keywords: log, flops, floating point operations 423 M*/ 424 425 426 /*MC 427 PLogEventBegin - Logs the beginning of a user event. 428 429 Input Parameters: 430 . e - integer associated with the event obtained from PLogEventRegister() 431 . o1,o2,o3,o4 - objects associated with the event, or 0 432 433 Synopsis: 434 void PLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3, 435 PetscObject o4) 436 437 Notes: 438 You should also register each integer event with the command 439 PLogRegisterEvent(). The source code must be compiled with 440 -DPETSC_LOG, which is the default. 441 442 PETSc automatically logs library events if the code has been 443 compiled with -DPETSC_LOG, and -log, -log_summary, or -log_all are 444 specified. PLogEventBegin() is intended for logging user events 445 to supplement this PETSc information. 446 447 Example of Usage: 448 $ int USER_EVENT; 449 $ int user_event_flops; 450 $ PLogEventRegister(&USER_EVENT,"User event","Color:"); 451 $ PLogEventBegin(&USER_EVENT,0,0,0,0); 452 $ [code segment to monitor] 453 $ PLogFlops(user_event_flops); 454 $ PLogEventEnd(&USER_EVENT,0,0,0,0); 455 456 .seealso: PLogEventRegister(), PLogEventEnd(), PLogFlops() 457 458 .keywords: log, event, begin 459 M*/ 460 461 /*MC 462 PLogEventEnd - Log the end of a user event. 463 464 Input Parameters: 465 . e - integer associated with the event obtained with PLogEventRegister() 466 . o1,o2,o3,o4 - objects associated with the event, or 0 467 468 Synopsis: 469 void PLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3, 470 PetscObject o4) 471 472 Notes: 473 You should also register each additional integer event with the command 474 PLogRegisterEvent(). Source code must be compiled with 475 -DPETSC_LOG, which is the default. 476 477 PETSc automatically logs library events if the code has been 478 compiled with -DPETSC_LOG, and -log, -log_summary, or -log_all are 479 specified. PLogEventEnd() is intended for logging user events 480 to supplement this PETSc information. 481 482 Example of Usage: 483 $ int USER_EVENT; 484 $ int user_event_flops; 485 $ PLogEventRegister(&USER_EVENT,"User event","Color:"); 486 $ PLogEventBegin(USER_EVENT,0,0,0,0); 487 $ [code segment to monitor] 488 $ PLogFlops(user_event_flops); 489 $ PLogEventEnd(USER_EVENT,0,0,0,0); 490 491 .seealso: PLogEventRegister(), PLogEventBegin(), PLogFlops() 492 493 .keywords: log, event, end 494 M*/ 495 496 497 #endif 498 499 500 501 502 503 504