1 2 /* 3 PETSc code to log object creation and destruction and PETSc events. 4 5 This provides the public API used by the rest of PETSc and by users. 6 7 These routines use a private API that is not used elsewhere in PETSc and is not 8 accessible to users. The private API is defined in logimpl.h and the utils directory. 9 10 */ 11 #include <petsc/private/logimpl.h> /*I "petscsys.h" I*/ 12 #include <petsctime.h> 13 #include <petscviewer.h> 14 15 PetscErrorCode PetscLogObjectParent(PetscObject p,PetscObject c) 16 { 17 if (!c || !p) return 0; 18 c->parent = p; 19 c->parentid = p->id; 20 return 0; 21 } 22 23 /*@C 24 PetscLogObjectMemory - Adds to an object a count of additional amount of memory that is used by the object. 25 26 Not collective. 27 28 Input Parameters: 29 + obj - the PETSc object 30 - mem - the amount of memory that is being added to the object 31 32 Level: developer 33 34 Developer Notes: 35 Currently we do not always do a good job of associating all memory allocations with an object. 36 37 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments() 38 39 @*/ 40 PetscErrorCode PetscLogObjectMemory(PetscObject p,PetscLogDouble m) 41 { 42 if (!p) return 0; 43 p->mem += m; 44 return 0; 45 } 46 47 PetscLogEvent PETSC_LARGEST_EVENT = PETSC_EVENT; 48 49 #if defined(PETSC_USE_LOG) 50 #include <petscmachineinfo.h> 51 #include <petscconfiginfo.h> 52 53 /* used in the MPI_XXX() count macros in petsclog.h */ 54 55 /* Action and object logging variables */ 56 Action *petsc_actions = NULL; 57 Object *petsc_objects = NULL; 58 PetscBool petsc_logActions = PETSC_FALSE; 59 PetscBool petsc_logObjects = PETSC_FALSE; 60 int petsc_numActions = 0, petsc_maxActions = 100; 61 int petsc_numObjects = 0, petsc_maxObjects = 100; 62 int petsc_numObjectsDestroyed = 0; 63 64 /* Global counters */ 65 PetscLogDouble petsc_BaseTime = 0.0; 66 PetscLogDouble petsc_TotalFlops = 0.0; /* The number of flops */ 67 PetscLogDouble petsc_tmp_flops = 0.0; /* The incremental number of flops */ 68 PetscLogDouble petsc_send_ct = 0.0; /* The number of sends */ 69 PetscLogDouble petsc_recv_ct = 0.0; /* The number of receives */ 70 PetscLogDouble petsc_send_len = 0.0; /* The total length of all sent messages */ 71 PetscLogDouble petsc_recv_len = 0.0; /* The total length of all received messages */ 72 PetscLogDouble petsc_isend_ct = 0.0; /* The number of immediate sends */ 73 PetscLogDouble petsc_irecv_ct = 0.0; /* The number of immediate receives */ 74 PetscLogDouble petsc_isend_len = 0.0; /* The total length of all immediate send messages */ 75 PetscLogDouble petsc_irecv_len = 0.0; /* The total length of all immediate receive messages */ 76 PetscLogDouble petsc_wait_ct = 0.0; /* The number of waits */ 77 PetscLogDouble petsc_wait_any_ct = 0.0; /* The number of anywaits */ 78 PetscLogDouble petsc_wait_all_ct = 0.0; /* The number of waitalls */ 79 PetscLogDouble petsc_sum_of_waits_ct = 0.0; /* The total number of waits */ 80 PetscLogDouble petsc_allreduce_ct = 0.0; /* The number of reductions */ 81 PetscLogDouble petsc_gather_ct = 0.0; /* The number of gathers and gathervs */ 82 PetscLogDouble petsc_scatter_ct = 0.0; /* The number of scatters and scattervs */ 83 84 /* Logging functions */ 85 PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL; 86 PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL; 87 PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 88 PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 89 90 /* Tracing event logging variables */ 91 FILE *petsc_tracefile = NULL; 92 int petsc_tracelevel = 0; 93 const char *petsc_traceblanks = " "; 94 char petsc_tracespace[128] = " "; 95 PetscLogDouble petsc_tracetime = 0.0; 96 static PetscBool PetscLogInitializeCalled = PETSC_FALSE; 97 98 PETSC_INTERN PetscErrorCode PetscLogInitialize(void) 99 { 100 int stage; 101 PetscBool opt; 102 PetscErrorCode ierr; 103 104 PetscFunctionBegin; 105 if (PetscLogInitializeCalled) PetscFunctionReturn(0); 106 PetscLogInitializeCalled = PETSC_TRUE; 107 108 ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_actions", &opt);CHKERRQ(ierr); 109 if (opt) petsc_logActions = PETSC_FALSE; 110 ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_objects", &opt);CHKERRQ(ierr); 111 if (opt) petsc_logObjects = PETSC_FALSE; 112 if (petsc_logActions) { 113 ierr = PetscMalloc1(petsc_maxActions, &petsc_actions);CHKERRQ(ierr); 114 } 115 if (petsc_logObjects) { 116 ierr = PetscMalloc1(petsc_maxObjects, &petsc_objects);CHKERRQ(ierr); 117 } 118 PetscLogPHC = PetscLogObjCreateDefault; 119 PetscLogPHD = PetscLogObjDestroyDefault; 120 /* Setup default logging structures */ 121 ierr = PetscStageLogCreate(&petsc_stageLog);CHKERRQ(ierr); 122 ierr = PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage);CHKERRQ(ierr); 123 124 /* All processors sync here for more consistent logging */ 125 ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr); 126 PetscTime(&petsc_BaseTime); 127 ierr = PetscLogStagePush(stage);CHKERRQ(ierr); 128 PetscFunctionReturn(0); 129 } 130 131 PETSC_INTERN PetscErrorCode PetscLogFinalize(void) 132 { 133 PetscStageLog stageLog; 134 PetscErrorCode ierr; 135 136 PetscFunctionBegin; 137 ierr = PetscFree(petsc_actions);CHKERRQ(ierr); 138 ierr = PetscFree(petsc_objects);CHKERRQ(ierr); 139 ierr = PetscLogNestedEnd();CHKERRQ(ierr); 140 ierr = PetscLogSet(NULL, NULL);CHKERRQ(ierr); 141 142 /* Resetting phase */ 143 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 144 ierr = PetscStageLogDestroy(stageLog);CHKERRQ(ierr); 145 146 petsc_TotalFlops = 0.0; 147 petsc_numActions = 0; 148 petsc_numObjects = 0; 149 petsc_numObjectsDestroyed = 0; 150 petsc_maxActions = 100; 151 petsc_maxObjects = 100; 152 petsc_actions = NULL; 153 petsc_objects = NULL; 154 petsc_logActions = PETSC_FALSE; 155 petsc_logObjects = PETSC_FALSE; 156 petsc_BaseTime = 0.0; 157 petsc_TotalFlops = 0.0; 158 petsc_tmp_flops = 0.0; 159 petsc_send_ct = 0.0; 160 petsc_recv_ct = 0.0; 161 petsc_send_len = 0.0; 162 petsc_recv_len = 0.0; 163 petsc_isend_ct = 0.0; 164 petsc_irecv_ct = 0.0; 165 petsc_isend_len = 0.0; 166 petsc_irecv_len = 0.0; 167 petsc_wait_ct = 0.0; 168 petsc_wait_any_ct = 0.0; 169 petsc_wait_all_ct = 0.0; 170 petsc_sum_of_waits_ct = 0.0; 171 petsc_allreduce_ct = 0.0; 172 petsc_gather_ct = 0.0; 173 petsc_scatter_ct = 0.0; 174 PETSC_LARGEST_EVENT = PETSC_EVENT; 175 PetscLogPHC = NULL; 176 PetscLogPHD = NULL; 177 petsc_tracefile = NULL; 178 petsc_tracelevel = 0; 179 petsc_traceblanks = " "; 180 petsc_tracespace[0] = ' '; petsc_tracespace[1] = 0; 181 petsc_tracetime = 0.0; 182 PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 183 PETSC_OBJECT_CLASSID = 0; 184 petsc_stageLog = 0; 185 PetscLogInitializeCalled = PETSC_FALSE; 186 PetscFunctionReturn(0); 187 } 188 189 /*@C 190 PetscLogSet - Sets the logging functions called at the beginning and ending of every event. 191 192 Not Collective 193 194 Input Parameters: 195 + b - The function called at beginning of event 196 - e - The function called at end of event 197 198 Level: developer 199 200 .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogTraceBegin() 201 @*/ 202 PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), 203 PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject)) 204 { 205 PetscFunctionBegin; 206 PetscLogPLB = b; 207 PetscLogPLE = e; 208 PetscFunctionReturn(0); 209 } 210 211 /*@C 212 PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop 213 rates and object creation and should not slow programs down too much. 214 This routine may be called more than once. 215 216 Logically Collective over PETSC_COMM_WORLD 217 218 Options Database Keys: 219 . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the 220 screen (for code configured with --with-log=1 (which is the default)) 221 222 Usage: 223 .vb 224 PetscInitialize(...); 225 PetscLogDefaultBegin(); 226 ... code ... 227 PetscLogView(viewer); or PetscLogDump(); 228 PetscFinalize(); 229 .ve 230 231 Notes: 232 PetscLogView(viewer) or PetscLogDump() actually cause the printing of 233 the logging information. 234 235 Level: advanced 236 237 .keywords: log, begin 238 .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogTraceBegin() 239 @*/ 240 PetscErrorCode PetscLogDefaultBegin(void) 241 { 242 PetscErrorCode ierr; 243 244 PetscFunctionBegin; 245 ierr = PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault);CHKERRQ(ierr); 246 PetscFunctionReturn(0); 247 } 248 249 /*@C 250 PetscLogAllBegin - Turns on extensive logging of objects and events. Logs 251 all events. This creates large log files and slows the program down. 252 253 Logically Collective on PETSC_COMM_WORLD 254 255 Options Database Keys: 256 . -log_all - Prints extensive log information 257 258 Usage: 259 .vb 260 PetscInitialize(...); 261 PetscLogAllBegin(); 262 ... code ... 263 PetscLogDump(filename); 264 PetscFinalize(); 265 .ve 266 267 Notes: 268 A related routine is PetscLogDefaultBegin() (with the options key -log), which is 269 intended for production runs since it logs only flop rates and object 270 creation (and shouldn't significantly slow the programs). 271 272 Level: advanced 273 274 .keywords: log, all, begin 275 .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogTraceBegin() 276 @*/ 277 PetscErrorCode PetscLogAllBegin(void) 278 { 279 PetscErrorCode ierr; 280 281 PetscFunctionBegin; 282 ierr = PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete);CHKERRQ(ierr); 283 PetscFunctionReturn(0); 284 } 285 286 /*@ 287 PetscLogTraceBegin - Activates trace logging. Every time a PETSc event 288 begins or ends, the event name is printed. 289 290 Logically Collective on PETSC_COMM_WORLD 291 292 Input Parameter: 293 . file - The file to print trace in (e.g. stdout) 294 295 Options Database Key: 296 . -log_trace [filename] - Activates PetscLogTraceBegin() 297 298 Notes: 299 PetscLogTraceBegin() prints the processor number, the execution time (sec), 300 then "Event begin:" or "Event end:" followed by the event name. 301 302 PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful 303 to determine where a program is hanging without running in the 304 debugger. Can be used in conjunction with the -info option. 305 306 Level: intermediate 307 308 .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogDefaultBegin() 309 @*/ 310 PetscErrorCode PetscLogTraceBegin(FILE *file) 311 { 312 PetscErrorCode ierr; 313 314 PetscFunctionBegin; 315 petsc_tracefile = file; 316 317 ierr = PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace);CHKERRQ(ierr); 318 PetscFunctionReturn(0); 319 } 320 321 /*@ 322 PetscLogActions - Determines whether actions are logged for the graphical viewer. 323 324 Not Collective 325 326 Input Parameter: 327 . flag - PETSC_TRUE if actions are to be logged 328 329 Level: intermediate 330 331 Note: Logging of actions continues to consume more memory as the program 332 runs. Long running programs should consider turning this feature off. 333 334 Options Database Keys: 335 . -log_exclude_actions - Turns off actions logging 336 337 .keywords: log, stage, register 338 .seealso: PetscLogStagePush(), PetscLogStagePop() 339 @*/ 340 PetscErrorCode PetscLogActions(PetscBool flag) 341 { 342 PetscFunctionBegin; 343 petsc_logActions = flag; 344 PetscFunctionReturn(0); 345 } 346 347 /*@ 348 PetscLogObjects - Determines whether objects are logged for the graphical viewer. 349 350 Not Collective 351 352 Input Parameter: 353 . flag - PETSC_TRUE if objects are to be logged 354 355 Level: intermediate 356 357 Note: Logging of objects continues to consume more memory as the program 358 runs. Long running programs should consider turning this feature off. 359 360 Options Database Keys: 361 . -log_exclude_objects - Turns off objects logging 362 363 .keywords: log, stage, register 364 .seealso: PetscLogStagePush(), PetscLogStagePop() 365 @*/ 366 PetscErrorCode PetscLogObjects(PetscBool flag) 367 { 368 PetscFunctionBegin; 369 petsc_logObjects = flag; 370 PetscFunctionReturn(0); 371 } 372 373 /*------------------------------------------------ Stage Functions --------------------------------------------------*/ 374 /*@C 375 PetscLogStageRegister - Attaches a character string name to a logging stage. 376 377 Not Collective 378 379 Input Parameter: 380 . sname - The name to associate with that stage 381 382 Output Parameter: 383 . stage - The stage number 384 385 Level: intermediate 386 387 .keywords: log, stage, register 388 .seealso: PetscLogStagePush(), PetscLogStagePop() 389 @*/ 390 PetscErrorCode PetscLogStageRegister(const char sname[],PetscLogStage *stage) 391 { 392 PetscStageLog stageLog; 393 PetscLogEvent event; 394 PetscErrorCode ierr; 395 396 PetscFunctionBegin; 397 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 398 ierr = PetscStageLogRegister(stageLog, sname, stage);CHKERRQ(ierr); 399 /* Copy events already changed in the main stage, this sucks */ 400 ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 401 for (event = 0; event < stageLog->eventLog->numEvents; event++) { 402 ierr = PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event]);CHKERRQ(ierr); 403 } 404 ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 405 PetscFunctionReturn(0); 406 } 407 408 /*@C 409 PetscLogStagePush - This function pushes a stage on the stack. 410 411 Not Collective 412 413 Input Parameter: 414 . stage - The stage on which to log 415 416 Usage: 417 If the option -log_sumary is used to run the program containing the 418 following code, then 2 sets of summary data will be printed during 419 PetscFinalize(). 420 .vb 421 PetscInitialize(int *argc,char ***args,0,0); 422 [stage 0 of code] 423 PetscLogStagePush(1); 424 [stage 1 of code] 425 PetscLogStagePop(); 426 PetscBarrier(...); 427 [more stage 0 of code] 428 PetscFinalize(); 429 .ve 430 431 Notes: 432 Use PetscLogStageRegister() to register a stage. 433 434 Level: intermediate 435 436 .keywords: log, push, stage 437 .seealso: PetscLogStagePop(), PetscLogStageRegister(), PetscBarrier() 438 @*/ 439 PetscErrorCode PetscLogStagePush(PetscLogStage stage) 440 { 441 PetscStageLog stageLog; 442 PetscErrorCode ierr; 443 444 PetscFunctionBegin; 445 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 446 ierr = PetscStageLogPush(stageLog, stage);CHKERRQ(ierr); 447 PetscFunctionReturn(0); 448 } 449 450 /*@C 451 PetscLogStagePop - This function pops a stage from the stack. 452 453 Not Collective 454 455 Usage: 456 If the option -log_sumary is used to run the program containing the 457 following code, then 2 sets of summary data will be printed during 458 PetscFinalize(). 459 .vb 460 PetscInitialize(int *argc,char ***args,0,0); 461 [stage 0 of code] 462 PetscLogStagePush(1); 463 [stage 1 of code] 464 PetscLogStagePop(); 465 PetscBarrier(...); 466 [more stage 0 of code] 467 PetscFinalize(); 468 .ve 469 470 Notes: 471 Use PetscLogStageRegister() to register a stage. 472 473 Level: intermediate 474 475 .keywords: log, pop, stage 476 .seealso: PetscLogStagePush(), PetscLogStageRegister(), PetscBarrier() 477 @*/ 478 PetscErrorCode PetscLogStagePop(void) 479 { 480 PetscStageLog stageLog; 481 PetscErrorCode ierr; 482 483 PetscFunctionBegin; 484 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 485 ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 486 PetscFunctionReturn(0); 487 } 488 489 /*@ 490 PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 491 492 Not Collective 493 494 Input Parameters: 495 + stage - The stage 496 - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 497 498 Level: intermediate 499 500 .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 501 @*/ 502 PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive) 503 { 504 PetscStageLog stageLog; 505 PetscErrorCode ierr; 506 507 PetscFunctionBegin; 508 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 509 ierr = PetscStageLogSetActive(stageLog, stage, isActive);CHKERRQ(ierr); 510 PetscFunctionReturn(0); 511 } 512 513 /*@ 514 PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 515 516 Not Collective 517 518 Input Parameter: 519 . stage - The stage 520 521 Output Parameter: 522 . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 523 524 Level: intermediate 525 526 .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 527 @*/ 528 PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive) 529 { 530 PetscStageLog stageLog; 531 PetscErrorCode ierr; 532 533 PetscFunctionBegin; 534 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 535 ierr = PetscStageLogGetActive(stageLog, stage, isActive);CHKERRQ(ierr); 536 PetscFunctionReturn(0); 537 } 538 539 /*@ 540 PetscLogStageSetVisible - Determines stage visibility in PetscLogView() 541 542 Not Collective 543 544 Input Parameters: 545 + stage - The stage 546 - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 547 548 Level: intermediate 549 550 .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 551 @*/ 552 PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible) 553 { 554 PetscStageLog stageLog; 555 PetscErrorCode ierr; 556 557 PetscFunctionBegin; 558 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 559 ierr = PetscStageLogSetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 560 PetscFunctionReturn(0); 561 } 562 563 /*@ 564 PetscLogStageGetVisible - Returns stage visibility in PetscLogView() 565 566 Not Collective 567 568 Input Parameter: 569 . stage - The stage 570 571 Output Parameter: 572 . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 573 574 Level: intermediate 575 576 .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 577 @*/ 578 PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible) 579 { 580 PetscStageLog stageLog; 581 PetscErrorCode ierr; 582 583 PetscFunctionBegin; 584 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 585 ierr = PetscStageLogGetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 586 PetscFunctionReturn(0); 587 } 588 589 /*@C 590 PetscLogStageGetId - Returns the stage id when given the stage name. 591 592 Not Collective 593 594 Input Parameter: 595 . name - The stage name 596 597 Output Parameter: 598 . stage - The stage, , or -1 if no stage with that name exists 599 600 Level: intermediate 601 602 .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 603 @*/ 604 PetscErrorCode PetscLogStageGetId(const char name[], PetscLogStage *stage) 605 { 606 PetscStageLog stageLog; 607 PetscErrorCode ierr; 608 609 PetscFunctionBegin; 610 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 611 ierr = PetscStageLogGetStage(stageLog, name, stage);CHKERRQ(ierr); 612 PetscFunctionReturn(0); 613 } 614 615 /*------------------------------------------------ Event Functions --------------------------------------------------*/ 616 /*@C 617 PetscLogEventRegister - Registers an event name for logging operations in an application code. 618 619 Not Collective 620 621 Input Parameter: 622 + name - The name associated with the event 623 - classid - The classid associated to the class for this event, obtain either with 624 PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones 625 are only available in C code 626 627 Output Parameter: 628 . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd(). 629 630 Example of Usage: 631 .vb 632 PetscLogEvent USER_EVENT; 633 PetscClassId classid; 634 PetscLogDouble user_event_flops; 635 PetscClassIdRegister("class name",&classid); 636 PetscLogEventRegister("User event name",classid,&USER_EVENT); 637 PetscLogEventBegin(USER_EVENT,0,0,0,0); 638 [code segment to monitor] 639 PetscLogFlops(user_event_flops); 640 PetscLogEventEnd(USER_EVENT,0,0,0,0); 641 .ve 642 643 Notes: 644 PETSc automatically logs library events if the code has been 645 configured with --with-log (which is the default) and 646 -log_view or -log_all is specified. PetscLogEventRegister() is 647 intended for logging user events to supplement this PETSc 648 information. 649 650 PETSc can gather data for use with the utilities Jumpshot 651 (part of the MPICH distribution). If PETSc has been compiled 652 with flag -DPETSC_HAVE_MPE (MPE is an additional utility within 653 MPICH), the user can employ another command line option, -log_mpe, 654 to create a logfile, "mpe.log", which can be visualized 655 Jumpshot. 656 657 The classid is associated with each event so that classes of events 658 can be disabled simultaneously, such as all matrix events. The user 659 can either use an existing classid, such as MAT_CLASSID, or create 660 their own as shown in the example. 661 662 If an existing event with the same name exists, its event handle is 663 returned instead of creating a new event. 664 665 Level: intermediate 666 667 .keywords: log, event, register 668 .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogFlops(), 669 PetscLogEventActivate(), PetscLogEventDeactivate(), PetscClassIdRegister() 670 @*/ 671 PetscErrorCode PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event) 672 { 673 PetscStageLog stageLog; 674 int stage; 675 PetscErrorCode ierr; 676 677 PetscFunctionBegin; 678 *event = PETSC_DECIDE; 679 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 680 ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 681 if (*event > 0) PetscFunctionReturn(0); 682 ierr = PetscEventRegLogRegister(stageLog->eventLog, name, classid, event);CHKERRQ(ierr); 683 for (stage = 0; stage < stageLog->numStages; stage++) { 684 ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 685 ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 686 } 687 PetscFunctionReturn(0); 688 } 689 690 /*@ 691 PetscLogEventSetCollective - Indicates that a particular event is collective. 692 693 Not Collective 694 695 Input Parameter: 696 + event - The event id 697 - collective - Bolean flag indicating whether a particular event is collective 698 699 Note: 700 New events returned from PetscLogEventRegister() are collective by default. 701 702 Level: developer 703 704 .keywords: log, event, collective 705 .seealso: PetscLogEventRegister() 706 @*/ 707 PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event,PetscBool collective) 708 { 709 PetscStageLog stageLog; 710 PetscEventRegLog eventRegLog; 711 PetscErrorCode ierr; 712 713 PetscFunctionBegin; 714 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 715 ierr = PetscStageLogGetEventRegLog(stageLog,&eventRegLog);CHKERRQ(ierr); 716 if (event < 0 || event > eventRegLog->numEvents) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Invalid event id"); 717 eventRegLog->eventInfo[event].collective = collective; 718 PetscFunctionReturn(0); 719 } 720 721 /*@ 722 PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage. 723 724 Not Collective 725 726 Input Parameter: 727 . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 728 729 Level: developer 730 731 .keywords: log, event, include, class 732 .seealso: PetscLogEventActivateClass(),PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 733 @*/ 734 PetscErrorCode PetscLogEventIncludeClass(PetscClassId classid) 735 { 736 PetscStageLog stageLog; 737 int stage; 738 PetscErrorCode ierr; 739 740 PetscFunctionBegin; 741 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 742 for (stage = 0; stage < stageLog->numStages; stage++) { 743 ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 744 } 745 PetscFunctionReturn(0); 746 } 747 748 /*@ 749 PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage. 750 751 Not Collective 752 753 Input Parameter: 754 . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 755 756 Level: developer 757 758 .keywords: log, event, exclude, class 759 .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivateClass(),PetscLogEventDeactivate(),PetscLogEventActivate() 760 @*/ 761 PetscErrorCode PetscLogEventExcludeClass(PetscClassId classid) 762 { 763 PetscStageLog stageLog; 764 int stage; 765 PetscErrorCode ierr; 766 767 PetscFunctionBegin; 768 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 769 for (stage = 0; stage < stageLog->numStages; stage++) { 770 ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 771 } 772 PetscFunctionReturn(0); 773 } 774 775 /*@ 776 PetscLogEventActivate - Indicates that a particular event should be logged. 777 778 Not Collective 779 780 Input Parameter: 781 . event - The event id 782 783 Usage: 784 .vb 785 PetscLogEventDeactivate(VEC_SetValues); 786 [code where you do not want to log VecSetValues()] 787 PetscLogEventActivate(VEC_SetValues); 788 [code where you do want to log VecSetValues()] 789 .ve 790 791 Note: 792 The event may be either a pre-defined PETSc event (found in include/petsclog.h) 793 or an event number obtained with PetscLogEventRegister(). 794 795 Level: advanced 796 797 .keywords: log, event, activate 798 .seealso: PlogEventDeactivate() 799 @*/ 800 PetscErrorCode PetscLogEventActivate(PetscLogEvent event) 801 { 802 PetscStageLog stageLog; 803 int stage; 804 PetscErrorCode ierr; 805 806 PetscFunctionBegin; 807 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 808 ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 809 ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 810 PetscFunctionReturn(0); 811 } 812 813 /*@ 814 PetscLogEventDeactivate - Indicates that a particular event should not be logged. 815 816 Not Collective 817 818 Input Parameter: 819 . event - The event id 820 821 Usage: 822 .vb 823 PetscLogEventDeactivate(VEC_SetValues); 824 [code where you do not want to log VecSetValues()] 825 PetscLogEventActivate(VEC_SetValues); 826 [code where you do want to log VecSetValues()] 827 .ve 828 829 Note: 830 The event may be either a pre-defined PETSc event (found in 831 include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 832 833 Level: advanced 834 835 .keywords: log, event, deactivate 836 .seealso: PlogEventActivate() 837 @*/ 838 PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event) 839 { 840 PetscStageLog stageLog; 841 int stage; 842 PetscErrorCode ierr; 843 844 PetscFunctionBegin; 845 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 846 ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 847 ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 848 PetscFunctionReturn(0); 849 } 850 851 /*@ 852 PetscLogEventSetActiveAll - Sets the event activity in every stage. 853 854 Not Collective 855 856 Input Parameters: 857 + event - The event id 858 - isActive - The activity flag determining whether the event is logged 859 860 Level: advanced 861 862 .keywords: log, event, activate 863 .seealso: PlogEventActivate(),PlogEventDeactivate() 864 @*/ 865 PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive) 866 { 867 PetscStageLog stageLog; 868 int stage; 869 PetscErrorCode ierr; 870 871 PetscFunctionBegin; 872 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 873 for (stage = 0; stage < stageLog->numStages; stage++) { 874 if (isActive) { 875 ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 876 } else { 877 ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 878 } 879 } 880 PetscFunctionReturn(0); 881 } 882 883 /*@ 884 PetscLogEventActivateClass - Activates event logging for a PETSc object class. 885 886 Not Collective 887 888 Input Parameter: 889 . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 890 891 Level: developer 892 893 .keywords: log, event, activate, class 894 .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 895 @*/ 896 PetscErrorCode PetscLogEventActivateClass(PetscClassId classid) 897 { 898 PetscStageLog stageLog; 899 int stage; 900 PetscErrorCode ierr; 901 902 PetscFunctionBegin; 903 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 904 ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 905 ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 906 PetscFunctionReturn(0); 907 } 908 909 /*@ 910 PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class. 911 912 Not Collective 913 914 Input Parameter: 915 . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 916 917 Level: developer 918 919 .keywords: log, event, deactivate, class 920 .seealso: PetscLogEventActivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 921 @*/ 922 PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid) 923 { 924 PetscStageLog stageLog; 925 int stage; 926 PetscErrorCode ierr; 927 928 PetscFunctionBegin; 929 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 930 ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 931 ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 932 PetscFunctionReturn(0); 933 } 934 935 /*MC 936 PetscLogEventBegin - Logs the beginning of a user event. 937 938 Synopsis: 939 #include <petsclog.h> 940 PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 941 942 Not Collective 943 944 Input Parameters: 945 + e - integer associated with the event obtained from PetscLogEventRegister() 946 - o1,o2,o3,o4 - objects associated with the event, or 0 947 948 949 Fortran Synopsis: 950 void PetscLogEventBegin(int e,PetscErrorCode ierr) 951 952 Usage: 953 .vb 954 PetscLogEvent USER_EVENT; 955 PetscLogDouble user_event_flops; 956 PetscLogEventRegister("User event",0,&USER_EVENT); 957 PetscLogEventBegin(USER_EVENT,0,0,0,0); 958 [code segment to monitor] 959 PetscLogFlops(user_event_flops); 960 PetscLogEventEnd(USER_EVENT,0,0,0,0); 961 .ve 962 963 Notes: 964 You need to register each integer event with the command 965 PetscLogEventRegister(). 966 967 Level: intermediate 968 969 .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops() 970 971 .keywords: log, event, begin 972 M*/ 973 974 /*MC 975 PetscLogEventEnd - Log the end of a user event. 976 977 Synopsis: 978 #include <petsclog.h> 979 PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 980 981 Not Collective 982 983 Input Parameters: 984 + e - integer associated with the event obtained with PetscLogEventRegister() 985 - o1,o2,o3,o4 - objects associated with the event, or 0 986 987 988 Fortran Synopsis: 989 void PetscLogEventEnd(int e,PetscErrorCode ierr) 990 991 Usage: 992 .vb 993 PetscLogEvent USER_EVENT; 994 PetscLogDouble user_event_flops; 995 PetscLogEventRegister("User event",0,&USER_EVENT,); 996 PetscLogEventBegin(USER_EVENT,0,0,0,0); 997 [code segment to monitor] 998 PetscLogFlops(user_event_flops); 999 PetscLogEventEnd(USER_EVENT,0,0,0,0); 1000 .ve 1001 1002 Notes: 1003 You should also register each additional integer event with the command 1004 PetscLogEventRegister(). 1005 1006 Level: intermediate 1007 1008 .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogFlops() 1009 1010 .keywords: log, event, end 1011 M*/ 1012 1013 /*@C 1014 PetscLogEventGetId - Returns the event id when given the event name. 1015 1016 Not Collective 1017 1018 Input Parameter: 1019 . name - The event name 1020 1021 Output Parameter: 1022 . event - The event, or -1 if no event with that name exists 1023 1024 Level: intermediate 1025 1026 .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStageGetId() 1027 @*/ 1028 PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event) 1029 { 1030 PetscStageLog stageLog; 1031 PetscErrorCode ierr; 1032 1033 PetscFunctionBegin; 1034 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1035 ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 1036 PetscFunctionReturn(0); 1037 } 1038 1039 1040 /*------------------------------------------------ Output Functions -------------------------------------------------*/ 1041 /*@C 1042 PetscLogDump - Dumps logs of objects to a file. This file is intended to 1043 be read by bin/petscview. This program no longer exists. 1044 1045 Collective on PETSC_COMM_WORLD 1046 1047 Input Parameter: 1048 . name - an optional file name 1049 1050 Usage: 1051 .vb 1052 PetscInitialize(...); 1053 PetscLogDefaultBegin(); or PetscLogAllBegin(); 1054 ... code ... 1055 PetscLogDump(filename); 1056 PetscFinalize(); 1057 .ve 1058 1059 Notes: 1060 The default file name is 1061 $ Log.<rank> 1062 where <rank> is the processor number. If no name is specified, 1063 this file will be used. 1064 1065 Level: advanced 1066 1067 .keywords: log, dump 1068 .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogView() 1069 @*/ 1070 PetscErrorCode PetscLogDump(const char sname[]) 1071 { 1072 PetscStageLog stageLog; 1073 PetscEventPerfInfo *eventInfo; 1074 FILE *fd; 1075 char file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN]; 1076 PetscLogDouble flops, _TotalTime; 1077 PetscMPIInt rank; 1078 int action, object, curStage; 1079 PetscLogEvent event; 1080 PetscErrorCode ierr; 1081 1082 PetscFunctionBegin; 1083 /* Calculate the total elapsed time */ 1084 PetscTime(&_TotalTime); 1085 _TotalTime -= petsc_BaseTime; 1086 /* Open log file */ 1087 ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank);CHKERRQ(ierr); 1088 if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank); 1089 else sprintf(file, "Log.%d", rank); 1090 ierr = PetscFixFilename(file, fname);CHKERRQ(ierr); 1091 ierr = PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd);CHKERRQ(ierr); 1092 if ((!rank) && (!fd)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname); 1093 /* Output totals */ 1094 ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime);CHKERRQ(ierr); 1095 ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0);CHKERRQ(ierr); 1096 /* Output actions */ 1097 if (petsc_logActions) { 1098 ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions);CHKERRQ(ierr); 1099 for (action = 0; action < petsc_numActions; action++) { 1100 ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n", 1101 petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1, 1102 petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem);CHKERRQ(ierr); 1103 } 1104 } 1105 /* Output objects */ 1106 if (petsc_logObjects) { 1107 ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed);CHKERRQ(ierr); 1108 for (object = 0; object < petsc_numObjects; object++) { 1109 ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem);CHKERRQ(ierr); 1110 if (!petsc_objects[object].name[0]) { 1111 ierr = PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n");CHKERRQ(ierr); 1112 } else { 1113 ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name);CHKERRQ(ierr); 1114 } 1115 if (petsc_objects[object].info[0] != 0) { 1116 ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n");CHKERRQ(ierr); 1117 } else { 1118 ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info);CHKERRQ(ierr); 1119 } 1120 } 1121 } 1122 /* Output events */ 1123 ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n");CHKERRQ(ierr); 1124 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1125 ierr = PetscIntStackTop(stageLog->stack, &curStage);CHKERRQ(ierr); 1126 eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo; 1127 for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) { 1128 if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time; 1129 else flops = 0.0; 1130 ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count, 1131 eventInfo[event].flops, eventInfo[event].time, flops);CHKERRQ(ierr); 1132 } 1133 ierr = PetscFClose(PETSC_COMM_WORLD, fd);CHKERRQ(ierr); 1134 PetscFunctionReturn(0); 1135 } 1136 1137 /* 1138 PetscLogView_Detailed - Each process prints the times for its own events 1139 1140 */ 1141 PetscErrorCode PetscLogView_Detailed(PetscViewer viewer) 1142 { 1143 PetscStageLog stageLog; 1144 PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL; 1145 PetscLogDouble locTotalTime, numRed, maxMem; 1146 int numStages,numEvents,stage,event; 1147 MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 1148 PetscMPIInt rank,size; 1149 PetscErrorCode ierr; 1150 1151 PetscFunctionBegin; 1152 ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 1153 ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 1154 /* Must preserve reduction count before we go on */ 1155 numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 1156 /* Get the total elapsed time */ 1157 PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 1158 ierr = PetscViewerASCIIPrintf(viewer,"size = %d\n",size);CHKERRQ(ierr); 1159 ierr = PetscViewerASCIIPrintf(viewer,"LocalTimes = {}\n");CHKERRQ(ierr); 1160 ierr = PetscViewerASCIIPrintf(viewer,"LocalMessages = {}\n");CHKERRQ(ierr); 1161 ierr = PetscViewerASCIIPrintf(viewer,"LocalMessageLens = {}\n");CHKERRQ(ierr); 1162 ierr = PetscViewerASCIIPrintf(viewer,"LocalReductions = {}\n");CHKERRQ(ierr); 1163 ierr = PetscViewerASCIIPrintf(viewer,"LocalFlop = {}\n");CHKERRQ(ierr); 1164 ierr = PetscViewerASCIIPrintf(viewer,"LocalObjects = {}\n");CHKERRQ(ierr); 1165 ierr = PetscViewerASCIIPrintf(viewer,"LocalMemory = {}\n");CHKERRQ(ierr); 1166 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1167 ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1168 ierr = PetscViewerASCIIPrintf(viewer,"Stages = {}\n");CHKERRQ(ierr); 1169 for (stage=0; stage<numStages; stage++) { 1170 ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 1171 ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"summary\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 1172 ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1173 for (event = 0; event < numEvents; event++) { 1174 ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"%s\"] = {}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name);CHKERRQ(ierr); 1175 } 1176 } 1177 ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr); 1178 ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr); 1179 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalTimes[%d] = %g\n",rank,locTotalTime);CHKERRQ(ierr); 1180 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessages[%d] = %g\n",rank,(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct));CHKERRQ(ierr); 1181 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessageLens[%d] = %g\n",rank,(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len));CHKERRQ(ierr); 1182 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalReductions[%d] = %g\n",rank,numRed);CHKERRQ(ierr); 1183 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalFlop[%d] = %g\n",rank,petsc_TotalFlops);CHKERRQ(ierr); 1184 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalObjects[%d] = %d\n",rank,petsc_numObjects);CHKERRQ(ierr); 1185 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMemory[%d] = %g\n",rank,maxMem);CHKERRQ(ierr); 1186 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 1187 for (stage=0; stage<numStages; stage++) { 1188 stageInfo = &stageLog->stageInfo[stage].perfInfo; 1189 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n", 1190 stageLog->stageInfo[stage].name,rank, 1191 stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr); 1192 ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1193 for (event = 0; event < numEvents; event++) { 1194 eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 1195 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %D, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n", 1196 stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name,rank, 1197 eventInfo->count,eventInfo->time,eventInfo->syncTime,eventInfo->numMessages,eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr); 1198 } 1199 } 1200 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 1201 ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 1202 PetscFunctionReturn(0); 1203 } 1204 1205 static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm,FILE *fd) 1206 { 1207 PetscErrorCode ierr; 1208 PetscFunctionBegin; 1209 if (!PetscLogSyncOn) PetscFunctionReturn(0); 1210 ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1211 ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1212 ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1213 ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1214 ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1215 ierr = PetscFPrintf(comm, fd, " # This program was run with logging synchronization. #\n");CHKERRQ(ierr); 1216 ierr = PetscFPrintf(comm, fd, " # This option provides more meaningful imbalance #\n");CHKERRQ(ierr); 1217 ierr = PetscFPrintf(comm, fd, " # figures at the expense of slowing things down and #\n");CHKERRQ(ierr); 1218 ierr = PetscFPrintf(comm, fd, " # providing a distorted view of the overall runtime. #\n");CHKERRQ(ierr); 1219 ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1220 ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1221 PetscFunctionReturn(0); 1222 PetscFunctionReturn(0); 1223 } 1224 1225 static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm,FILE *fd) 1226 { 1227 #if defined(PETSC_USE_DEBUG) 1228 PetscErrorCode ierr; 1229 1230 PetscFunctionBegin; 1231 ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1232 ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1233 ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1234 ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1235 ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1236 ierr = PetscFPrintf(comm, fd, " # This code was compiled with a debugging option. #\n");CHKERRQ(ierr); 1237 ierr = PetscFPrintf(comm, fd, " # To get timing results run ./configure #\n");CHKERRQ(ierr); 1238 ierr = PetscFPrintf(comm, fd, " # using --with-debugging=no, the performance will #\n");CHKERRQ(ierr); 1239 ierr = PetscFPrintf(comm, fd, " # be generally two or three times faster. #\n");CHKERRQ(ierr); 1240 ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1241 ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1242 PetscFunctionReturn(0); 1243 #else 1244 return 0; 1245 #endif 1246 } 1247 1248 PetscErrorCode PetscLogView_Default(PetscViewer viewer) 1249 { 1250 FILE *fd; 1251 PetscLogDouble zero = 0.0; 1252 PetscStageLog stageLog; 1253 PetscStageInfo *stageInfo = NULL; 1254 PetscEventPerfInfo *eventInfo = NULL; 1255 PetscClassPerfInfo *classInfo; 1256 char arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128]; 1257 const char *name; 1258 PetscLogDouble locTotalTime, TotalTime, TotalFlops; 1259 PetscLogDouble numMessages, messageLength, avgMessLen, numReductions; 1260 PetscLogDouble stageTime, flops, flopr, mem, mess, messLen, red; 1261 PetscLogDouble fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed; 1262 PetscLogDouble fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed; 1263 PetscLogDouble min, max, tot, ratio, avg, x, y; 1264 PetscLogDouble minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr; 1265 PetscMPIInt minC, maxC; 1266 PetscMPIInt size, rank; 1267 PetscBool *localStageUsed, *stageUsed; 1268 PetscBool *localStageVisible, *stageVisible; 1269 int numStages, localNumEvents, numEvents; 1270 int stage, oclass; 1271 PetscLogEvent event; 1272 PetscErrorCode ierr; 1273 char version[256]; 1274 MPI_Comm comm; 1275 1276 PetscFunctionBegin; 1277 ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 1278 ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr); 1279 ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 1280 ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 1281 /* Get the total elapsed time */ 1282 PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 1283 1284 ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 1285 ierr = PetscFPrintf(comm, fd, "*** WIDEN YOUR WINDOW TO 120 CHARACTERS. Use 'enscript -r -fCourier9' to print this document ***\n");CHKERRQ(ierr); 1286 ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 1287 ierr = PetscFPrintf(comm, fd, "\n---------------------------------------------- PETSc Performance Summary: ----------------------------------------------\n\n");CHKERRQ(ierr); 1288 ierr = PetscLogViewWarnSync(comm,fd);CHKERRQ(ierr); 1289 ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 1290 ierr = PetscGetArchType(arch,sizeof(arch));CHKERRQ(ierr); 1291 ierr = PetscGetHostName(hostname,sizeof(hostname));CHKERRQ(ierr); 1292 ierr = PetscGetUserName(username,sizeof(username));CHKERRQ(ierr); 1293 ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr); 1294 ierr = PetscGetDate(date,sizeof(date));CHKERRQ(ierr); 1295 ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr); 1296 if (size == 1) { 1297 ierr = PetscFPrintf(comm,fd,"%s on a %s named %s with %d processor, by %s %s\n", pname, arch, hostname, size, username, date);CHKERRQ(ierr); 1298 } else { 1299 ierr = PetscFPrintf(comm,fd,"%s on a %s named %s with %d processors, by %s %s\n", pname, arch, hostname, size, username, date);CHKERRQ(ierr); 1300 } 1301 1302 ierr = PetscFPrintf(comm, fd, "Using %s\n", version);CHKERRQ(ierr); 1303 1304 /* Must preserve reduction count before we go on */ 1305 red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 1306 1307 /* Calculate summary information */ 1308 ierr = PetscFPrintf(comm, fd, "\n Max Max/Min Avg Total \n");CHKERRQ(ierr); 1309 /* Time */ 1310 ierr = MPIU_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1311 ierr = MPIU_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1312 ierr = MPIU_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1313 avg = tot/((PetscLogDouble) size); 1314 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1315 ierr = PetscFPrintf(comm, fd, "Time (sec): %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 1316 TotalTime = tot; 1317 /* Objects */ 1318 avg = (PetscLogDouble) petsc_numObjects; 1319 ierr = MPIU_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1320 ierr = MPIU_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1321 ierr = MPIU_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1322 avg = tot/((PetscLogDouble) size); 1323 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1324 ierr = PetscFPrintf(comm, fd, "Objects: %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 1325 /* Flops */ 1326 ierr = MPIU_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1327 ierr = MPIU_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1328 ierr = MPIU_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1329 avg = tot/((PetscLogDouble) size); 1330 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1331 ierr = PetscFPrintf(comm, fd, "Flop: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 1332 TotalFlops = tot; 1333 /* Flops/sec -- Must talk to Barry here */ 1334 if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime; else flops = 0.0; 1335 ierr = MPIU_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1336 ierr = MPIU_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1337 ierr = MPIU_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1338 avg = tot/((PetscLogDouble) size); 1339 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1340 ierr = PetscFPrintf(comm, fd, "Flop/sec: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 1341 /* Memory */ 1342 ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr); 1343 if (mem > 0.0) { 1344 ierr = MPIU_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1345 ierr = MPIU_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1346 ierr = MPIU_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1347 avg = tot/((PetscLogDouble) size); 1348 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1349 ierr = PetscFPrintf(comm, fd, "Memory: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 1350 } 1351 /* Messages */ 1352 mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct); 1353 ierr = MPIU_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1354 ierr = MPIU_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1355 ierr = MPIU_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1356 avg = tot/((PetscLogDouble) size); 1357 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1358 ierr = PetscFPrintf(comm, fd, "MPI Messages: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 1359 numMessages = tot; 1360 /* Message Lengths */ 1361 mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len); 1362 ierr = MPIU_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1363 ierr = MPIU_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1364 ierr = MPIU_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1365 if (numMessages != 0) avg = tot/numMessages; else avg = 0.0; 1366 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1367 ierr = PetscFPrintf(comm, fd, "MPI Message Lengths: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 1368 messageLength = tot; 1369 /* Reductions */ 1370 ierr = MPIU_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1371 ierr = MPIU_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1372 ierr = MPIU_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1373 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1374 ierr = PetscFPrintf(comm, fd, "MPI Reductions: %5.3e %7.3f\n", max, ratio);CHKERRQ(ierr); 1375 numReductions = red; /* wrong because uses count from process zero */ 1376 ierr = PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n");CHKERRQ(ierr); 1377 ierr = PetscFPrintf(comm, fd, " e.g., VecAXPY() for real vectors of length N --> 2N flop\n");CHKERRQ(ierr); 1378 ierr = PetscFPrintf(comm, fd, " and VecAXPY() for complex vectors of length N --> 8N flop\n");CHKERRQ(ierr); 1379 1380 /* Get total number of stages -- 1381 Currently, a single processor can register more stages than another, but stages must all be registered in order. 1382 We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID. 1383 This seems best accomplished by assoicating a communicator with each stage. 1384 */ 1385 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1386 ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1387 ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr); 1388 ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr); 1389 ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr); 1390 ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr); 1391 if (numStages > 0) { 1392 stageInfo = stageLog->stageInfo; 1393 for (stage = 0; stage < numStages; stage++) { 1394 if (stage < stageLog->numStages) { 1395 localStageUsed[stage] = stageInfo[stage].used; 1396 localStageVisible[stage] = stageInfo[stage].perfInfo.visible; 1397 } else { 1398 localStageUsed[stage] = PETSC_FALSE; 1399 localStageVisible[stage] = PETSC_TRUE; 1400 } 1401 } 1402 ierr = MPIU_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm);CHKERRQ(ierr); 1403 ierr = MPIU_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr); 1404 for (stage = 0; stage < numStages; stage++) { 1405 if (stageUsed[stage]) { 1406 ierr = PetscFPrintf(comm, fd, "\nSummary of Stages: ----- Time ------ ----- Flop ------ --- Messages --- -- Message Lengths -- -- Reductions --\n");CHKERRQ(ierr); 1407 ierr = PetscFPrintf(comm, fd, " Avg %%Total Avg %%Total Count %%Total Avg %%Total Count %%Total \n");CHKERRQ(ierr); 1408 break; 1409 } 1410 } 1411 for (stage = 0; stage < numStages; stage++) { 1412 if (!stageUsed[stage]) continue; 1413 /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 1414 if (localStageUsed[stage]) { 1415 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1416 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1417 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1418 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1419 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1420 name = stageInfo[stage].name; 1421 } else { 1422 ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1423 ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1424 ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1425 ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1426 ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1427 name = ""; 1428 } 1429 mess *= 0.5; messLen *= 0.5; red /= size; 1430 if (TotalTime != 0.0) fracTime = stageTime/TotalTime; else fracTime = 0.0; 1431 if (TotalFlops != 0.0) fracFlops = flops/TotalFlops; else fracFlops = 0.0; 1432 /* Talk to Barry if (stageTime != 0.0) flops = (size*flops)/stageTime; else flops = 0.0; */ 1433 if (numMessages != 0.0) fracMessages = mess/numMessages; else fracMessages = 0.0; 1434 if (mess != 0.0) avgMessLen = messLen/mess; else avgMessLen = 0.0; 1435 if (messageLength != 0.0) fracLength = messLen/messageLength; else fracLength = 0.0; 1436 if (numReductions != 0.0) fracReductions = red/numReductions; else fracReductions = 0.0; 1437 ierr = PetscFPrintf(comm, fd, "%2d: %15s: %6.4e %5.1f%% %6.4e %5.1f%% %5.3e %5.1f%% %5.3e %5.1f%% %5.3e %5.1f%% \n", 1438 stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops, 1439 mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr); 1440 } 1441 } 1442 1443 ierr = PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 1444 ierr = PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n");CHKERRQ(ierr); 1445 ierr = PetscFPrintf(comm, fd, "Phase summary info:\n");CHKERRQ(ierr); 1446 ierr = PetscFPrintf(comm, fd, " Count: number of times phase was executed\n");CHKERRQ(ierr); 1447 ierr = PetscFPrintf(comm, fd, " Time and Flop: Max - maximum over all processors\n");CHKERRQ(ierr); 1448 ierr = PetscFPrintf(comm, fd, " Ratio - ratio of maximum to minimum over all processors\n");CHKERRQ(ierr); 1449 ierr = PetscFPrintf(comm, fd, " Mess: number of messages sent\n");CHKERRQ(ierr); 1450 ierr = PetscFPrintf(comm, fd, " AvgLen: average message length (bytes)\n");CHKERRQ(ierr); 1451 ierr = PetscFPrintf(comm, fd, " Reduct: number of global reductions\n");CHKERRQ(ierr); 1452 ierr = PetscFPrintf(comm, fd, " Global: entire computation\n");CHKERRQ(ierr); 1453 ierr = PetscFPrintf(comm, fd, " Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n");CHKERRQ(ierr); 1454 ierr = PetscFPrintf(comm, fd, " %%T - percent time in this phase %%F - percent flop in this phase\n");CHKERRQ(ierr); 1455 ierr = PetscFPrintf(comm, fd, " %%M - percent messages in this phase %%L - percent message lengths in this phase\n");CHKERRQ(ierr); 1456 ierr = PetscFPrintf(comm, fd, " %%R - percent reductions in this phase\n");CHKERRQ(ierr); 1457 ierr = PetscFPrintf(comm, fd, " Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n");CHKERRQ(ierr); 1458 ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 1459 1460 ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 1461 1462 /* Report events */ 1463 ierr = PetscFPrintf(comm, fd,"Event Count Time (sec) Flop --- Global --- --- Stage ---- Total\n");CHKERRQ(ierr); 1464 ierr = PetscFPrintf(comm, fd," Max Ratio Max Ratio Max Ratio Mess AvgLen Reduct %%T %%F %%M %%L %%R %%T %%F %%M %%L %%R Mflop/s\n");CHKERRQ(ierr); 1465 ierr = PetscFPrintf(comm,fd,"------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 1466 1467 /* Problem: The stage name will not show up unless the stage executed on proc 1 */ 1468 for (stage = 0; stage < numStages; stage++) { 1469 if (!stageVisible[stage]) continue; 1470 /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 1471 if (localStageUsed[stage]) { 1472 ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 1473 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1474 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1475 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1476 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1477 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1478 } else { 1479 ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 1480 ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1481 ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1482 ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1483 ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1484 ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1485 } 1486 mess *= 0.5; messLen *= 0.5; red /= size; 1487 1488 /* Get total number of events in this stage -- 1489 Currently, a single processor can register more events than another, but events must all be registered in order, 1490 just like stages. We can removed this requirement if necessary by having a global event numbering and indirection 1491 on the event ID. This seems best accomplished by associating a communicator with each stage. 1492 1493 Problem: If the event did not happen on proc 1, its name will not be available. 1494 Problem: Event visibility is not implemented 1495 */ 1496 if (localStageUsed[stage]) { 1497 eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 1498 localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents; 1499 } else localNumEvents = 0; 1500 ierr = MPIU_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1501 for (event = 0; event < numEvents; event++) { 1502 /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 1503 if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) { 1504 if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; else flopr = 0.0; 1505 ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1506 ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1507 ierr = MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1508 ierr = MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1509 ierr = MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1510 ierr = MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1511 ierr = MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1512 ierr = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1513 ierr = MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1514 ierr = MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRQ(ierr); 1515 ierr = MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1516 name = stageLog->eventLog->eventInfo[event].name; 1517 } else { 1518 flopr = 0.0; 1519 ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1520 ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1521 ierr = MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1522 ierr = MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1523 ierr = MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1524 ierr = MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1525 ierr = MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1526 ierr = MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1527 ierr = MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1528 ierr = MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRQ(ierr); 1529 ierr = MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1530 name = ""; 1531 } 1532 if (mint < 0.0) { 1533 ierr = PetscFPrintf(comm, fd, "WARNING!!! Minimum time %g over all processors for %s is negative! This happens\n on some machines whose times cannot handle too rapid calls.!\n artificially changing minimum to zero.\n",mint,name); 1534 mint = 0; 1535 } 1536 if (minf < 0.0) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Minimum flop %g over all processors for %s is negative! Not possible!",minf,name); 1537 totm *= 0.5; totml *= 0.5; totr /= size; 1538 1539 if (maxC != 0) { 1540 if (minC != 0) ratC = ((PetscLogDouble)maxC)/minC;else ratC = 0.0; 1541 if (mint != 0.0) ratt = maxt/mint; else ratt = 0.0; 1542 if (minf != 0.0) ratf = maxf/minf; else ratf = 0.0; 1543 if (TotalTime != 0.0) fracTime = tott/TotalTime; else fracTime = 0.0; 1544 if (TotalFlops != 0.0) fracFlops = totf/TotalFlops; else fracFlops = 0.0; 1545 if (stageTime != 0.0) fracStageTime = tott/stageTime; else fracStageTime = 0.0; 1546 if (flops != 0.0) fracStageFlops = totf/flops; else fracStageFlops = 0.0; 1547 if (numMessages != 0.0) fracMess = totm/numMessages; else fracMess = 0.0; 1548 if (messageLength != 0.0) fracMessLen = totml/messageLength; else fracMessLen = 0.0; 1549 if (numReductions != 0.0) fracRed = totr/numReductions; else fracRed = 0.0; 1550 if (mess != 0.0) fracStageMess = totm/mess; else fracStageMess = 0.0; 1551 if (messLen != 0.0) fracStageMessLen = totml/messLen; else fracStageMessLen = 0.0; 1552 if (red != 0.0) fracStageRed = totr/red; else fracStageRed = 0.0; 1553 if (totm != 0.0) totml /= totm; else totml = 0.0; 1554 if (maxt != 0.0) flopr = totf/maxt; else flopr = 0.0; 1555 if (fracStageTime > 1.00) ierr = PetscFPrintf(comm, fd,"Warning -- total time of event greater than time of entire stage -- something is wrong with the timer\n");CHKERRQ(ierr); 1556 ierr = PetscFPrintf(comm, fd, 1557 "%-16s %7d%4.1f %5.4e%4.1f %3.2e%4.1f %2.1e %2.1e %2.1e%3.0f%3.0f%3.0f%3.0f%3.0f %3.0f%3.0f%3.0f%3.0f%3.0f %5.0f\n", 1558 name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr, 1559 100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed, 1560 100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed, 1561 PetscAbs(flopr)/1.0e6);CHKERRQ(ierr); 1562 } 1563 } 1564 } 1565 1566 /* Memory usage and object creation */ 1567 ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 1568 ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 1569 ierr = PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n");CHKERRQ(ierr); 1570 1571 /* Right now, only stages on the first processor are reported here, meaning only objects associated with 1572 the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then 1573 stats for stages local to processor sets. 1574 */ 1575 /* We should figure out the longest object name here (now 20 characters) */ 1576 ierr = PetscFPrintf(comm, fd, "Object Type Creations Destructions Memory Descendants' Mem.\n");CHKERRQ(ierr); 1577 ierr = PetscFPrintf(comm, fd, "Reports information only for process 0.\n");CHKERRQ(ierr); 1578 for (stage = 0; stage < numStages; stage++) { 1579 if (localStageUsed[stage]) { 1580 classInfo = stageLog->stageInfo[stage].classLog->classInfo; 1581 ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 1582 for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) { 1583 if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) { 1584 ierr = PetscFPrintf(comm, fd, "%20s %5d %5d %11.0f %g\n", stageLog->classLog->classInfo[oclass].name, 1585 classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem, 1586 classInfo[oclass].descMem);CHKERRQ(ierr); 1587 } 1588 } 1589 } else { 1590 if (!localStageVisible[stage]) continue; 1591 ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 1592 } 1593 } 1594 1595 ierr = PetscFree(localStageUsed);CHKERRQ(ierr); 1596 ierr = PetscFree(stageUsed);CHKERRQ(ierr); 1597 ierr = PetscFree(localStageVisible);CHKERRQ(ierr); 1598 ierr = PetscFree(stageVisible);CHKERRQ(ierr); 1599 1600 /* Information unrelated to this particular run */ 1601 ierr = PetscFPrintf(comm, fd, "========================================================================================================================\n");CHKERRQ(ierr); 1602 PetscTime(&y); 1603 PetscTime(&x); 1604 PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 1605 PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 1606 ierr = PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0);CHKERRQ(ierr); 1607 /* MPI information */ 1608 if (size > 1) { 1609 MPI_Status status; 1610 PetscMPIInt tag; 1611 MPI_Comm newcomm; 1612 1613 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1614 PetscTime(&x); 1615 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1616 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1617 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1618 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1619 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1620 PetscTime(&y); 1621 ierr = PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0);CHKERRQ(ierr); 1622 ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr); 1623 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1624 if (rank) { 1625 ierr = MPI_Recv(NULL, 0, MPI_INT, rank-1, tag, newcomm, &status);CHKERRQ(ierr); 1626 ierr = MPI_Send(NULL, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRQ(ierr); 1627 } else { 1628 PetscTime(&x); 1629 ierr = MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm);CHKERRQ(ierr); 1630 ierr = MPI_Recv(NULL, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRQ(ierr); 1631 PetscTime(&y); 1632 ierr = PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size);CHKERRQ(ierr); 1633 } 1634 ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr); 1635 } 1636 ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr); 1637 1638 /* Machine and compile information */ 1639 #if defined(PETSC_USE_FORTRAN_KERNELS) 1640 ierr = PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n");CHKERRQ(ierr); 1641 #else 1642 ierr = PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n");CHKERRQ(ierr); 1643 #endif 1644 #if defined(PETSC_USE_64BIT_INDICES) 1645 ierr = PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n");CHKERRQ(ierr); 1646 #elif defined(PETSC_USE___FLOAT128) 1647 ierr = PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n");CHKERRQ(ierr); 1648 #endif 1649 #if defined(PETSC_USE_REAL_SINGLE) 1650 ierr = PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 1651 #elif defined(PETSC_USE___FLOAT128) 1652 ierr = PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 1653 #endif 1654 #if defined(PETSC_USE_REAL_MAT_SINGLE) 1655 ierr = PetscFPrintf(comm, fd, "Compiled with single precision matrices\n");CHKERRQ(ierr); 1656 #else 1657 ierr = PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n");CHKERRQ(ierr); 1658 #endif 1659 ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n", 1660 (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr); 1661 1662 ierr = PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions);CHKERRQ(ierr); 1663 ierr = PetscFPrintf(comm, fd, "%s", petscmachineinfo);CHKERRQ(ierr); 1664 ierr = PetscFPrintf(comm, fd, "%s", petsccompilerinfo);CHKERRQ(ierr); 1665 ierr = PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo);CHKERRQ(ierr); 1666 ierr = PetscFPrintf(comm, fd, "%s", petsclinkerinfo);CHKERRQ(ierr); 1667 1668 /* Cleanup */ 1669 ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 1670 ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 1671 PetscFunctionReturn(0); 1672 } 1673 1674 /*@C 1675 PetscLogView - Prints a summary of the logging. 1676 1677 Collective over MPI_Comm 1678 1679 Input Parameter: 1680 . viewer - an ASCII viewer 1681 1682 Options Database Keys: 1683 + -log_view [:filename] - Prints summary of log information 1684 . -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file 1685 . -log_view :filename.xml:ascii_xml - Saves a summary of the logging information in a nested format (see below for how to view it) 1686 . -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation 1687 - -log_trace [filename] - Displays a trace of what each process is doing 1688 1689 Notes: 1690 It is possible to control the logging programatically but we recommend using the options database approach whenever possible 1691 By default the summary is printed to stdout. 1692 1693 Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin() 1694 1695 If PETSc is configured with --with-logging=0 then this functionality is not available 1696 1697 To view the nested XML format filename.xml first copy ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current 1698 directory then open filename.xml with your browser. Specific notes for certain browsers 1699 $ Firefox and Internet explorer - simply open the file 1700 $ Google Chrome - you must start up Chrome with the option --allow-file-access-from-files 1701 $ Safari - see http://ccm.net/faq/36342-safari-how-to-enable-local-file-access 1702 or one can use the package http://xmlsoft.org/XSLT/xsltproc2.html to translate the xml file to html and then open it with 1703 your browser. 1704 Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser 1705 window and render the XML log file contents. 1706 1707 The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij MARITIME RESEARCH INSTITUTE NETHERLANDS 1708 1709 Level: beginner 1710 1711 .keywords: log, dump, print 1712 .seealso: PetscLogDefaultBegin(), PetscLogDump() 1713 @*/ 1714 PetscErrorCode PetscLogView(PetscViewer viewer) 1715 { 1716 PetscErrorCode ierr; 1717 PetscBool isascii; 1718 PetscViewerFormat format; 1719 int stage, lastStage; 1720 PetscStageLog stageLog; 1721 1722 PetscFunctionBegin; 1723 if (!PetscLogPLB) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_view or PetscLogDefaultBegin() before calling this routine"); 1724 /* Pop off any stages the user forgot to remove */ 1725 lastStage = 0; 1726 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1727 ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 1728 while (stage >= 0) { 1729 lastStage = stage; 1730 ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 1731 ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 1732 } 1733 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 1734 if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII"); 1735 ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr); 1736 if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) { 1737 ierr = PetscLogView_Default(viewer);CHKERRQ(ierr); 1738 } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 1739 ierr = PetscLogView_Detailed(viewer);CHKERRQ(ierr); 1740 } else if (format == PETSC_VIEWER_ASCII_XML) { 1741 ierr = PetscLogView_Nested(viewer);CHKERRQ(ierr); 1742 } 1743 ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr); 1744 PetscFunctionReturn(0); 1745 } 1746 1747 /*@C 1748 PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed. 1749 1750 Collective on PETSC_COMM_WORLD 1751 1752 Not normally called by user 1753 1754 Level: intermediate 1755 1756 @*/ 1757 PetscErrorCode PetscLogViewFromOptions(void) 1758 { 1759 PetscErrorCode ierr; 1760 PetscViewer viewer; 1761 PetscBool flg; 1762 PetscViewerFormat format; 1763 1764 PetscFunctionBegin; 1765 ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-log_view",&viewer,&format,&flg);CHKERRQ(ierr); 1766 if (flg) { 1767 ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 1768 ierr = PetscLogView(viewer);CHKERRQ(ierr); 1769 ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 1770 ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1771 } 1772 PetscFunctionReturn(0); 1773 } 1774 1775 1776 1777 /*----------------------------------------------- Counter Functions -------------------------------------------------*/ 1778 /*@C 1779 PetscGetFlops - Returns the number of flops used on this processor 1780 since the program began. 1781 1782 Not Collective 1783 1784 Output Parameter: 1785 flops - number of floating point operations 1786 1787 Notes: 1788 A global counter logs all PETSc flop counts. The user can use 1789 PetscLogFlops() to increment this counter to include flops for the 1790 application code. 1791 1792 Level: intermediate 1793 1794 .keywords: log, flops, floating point operations 1795 1796 .seealso: PetscTime(), PetscLogFlops() 1797 @*/ 1798 PetscErrorCode PetscGetFlops(PetscLogDouble *flops) 1799 { 1800 PetscFunctionBegin; 1801 *flops = petsc_TotalFlops; 1802 PetscFunctionReturn(0); 1803 } 1804 1805 PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 1806 { 1807 PetscErrorCode ierr; 1808 size_t fullLength; 1809 va_list Argp; 1810 1811 PetscFunctionBegin; 1812 if (!petsc_logObjects) PetscFunctionReturn(0); 1813 va_start(Argp, format); 1814 ierr = PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp);CHKERRQ(ierr); 1815 va_end(Argp); 1816 PetscFunctionReturn(0); 1817 } 1818 1819 1820 /*MC 1821 PetscLogFlops - Adds floating point operations to the global counter. 1822 1823 Synopsis: 1824 #include <petsclog.h> 1825 PetscErrorCode PetscLogFlops(PetscLogDouble f) 1826 1827 Not Collective 1828 1829 Input Parameter: 1830 . f - flop counter 1831 1832 1833 Usage: 1834 .vb 1835 PetscLogEvent USER_EVENT; 1836 PetscLogEventRegister("User event",0,&USER_EVENT); 1837 PetscLogEventBegin(USER_EVENT,0,0,0,0); 1838 [code segment to monitor] 1839 PetscLogFlops(user_flops) 1840 PetscLogEventEnd(USER_EVENT,0,0,0,0); 1841 .ve 1842 1843 Notes: 1844 A global counter logs all PETSc flop counts. The user can use 1845 PetscLogFlops() to increment this counter to include flops for the 1846 application code. 1847 1848 Level: intermediate 1849 1850 .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops() 1851 1852 .keywords: log, flops, floating point operations 1853 M*/ 1854 1855 /*MC 1856 PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice) 1857 to get accurate timings 1858 1859 Synopsis: 1860 #include <petsclog.h> 1861 void PetscPreLoadBegin(PetscBool flag,char *name); 1862 1863 Not Collective 1864 1865 Input Parameter: 1866 + flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden 1867 with command line option -preload true or -preload false 1868 - name - name of first stage (lines of code timed separately with -log_view) to 1869 be preloaded 1870 1871 Usage: 1872 .vb 1873 PetscPreLoadBegin(PETSC_TRUE,"first stage); 1874 lines of code 1875 PetscPreLoadStage("second stage"); 1876 lines of code 1877 PetscPreLoadEnd(); 1878 .ve 1879 1880 Notes: 1881 Only works in C/C++, not Fortran 1882 1883 Flags available within the macro. 1884 + PetscPreLoadingUsed - true if we are or have done preloading 1885 . PetscPreLoadingOn - true if it is CURRENTLY doing preload 1886 . PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second 1887 - PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on 1888 The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() 1889 and PetscPreLoadEnd() 1890 1891 Level: intermediate 1892 1893 .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage() 1894 1895 Concepts: preloading 1896 Concepts: timing^accurate 1897 Concepts: paging^eliminating effects of 1898 1899 1900 M*/ 1901 1902 /*MC 1903 PetscPreLoadEnd - End a segment of code that may be preloaded (run twice) 1904 to get accurate timings 1905 1906 Synopsis: 1907 #include <petsclog.h> 1908 void PetscPreLoadEnd(void); 1909 1910 Not Collective 1911 1912 Usage: 1913 .vb 1914 PetscPreLoadBegin(PETSC_TRUE,"first stage); 1915 lines of code 1916 PetscPreLoadStage("second stage"); 1917 lines of code 1918 PetscPreLoadEnd(); 1919 .ve 1920 1921 Notes: 1922 only works in C/C++ not fortran 1923 1924 Level: intermediate 1925 1926 .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage() 1927 1928 M*/ 1929 1930 /*MC 1931 PetscPreLoadStage - Start a new segment of code to be timed separately. 1932 to get accurate timings 1933 1934 Synopsis: 1935 #include <petsclog.h> 1936 void PetscPreLoadStage(char *name); 1937 1938 Not Collective 1939 1940 Usage: 1941 .vb 1942 PetscPreLoadBegin(PETSC_TRUE,"first stage); 1943 lines of code 1944 PetscPreLoadStage("second stage"); 1945 lines of code 1946 PetscPreLoadEnd(); 1947 .ve 1948 1949 Notes: 1950 only works in C/C++ not fortran 1951 1952 Level: intermediate 1953 1954 .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd() 1955 1956 M*/ 1957 1958 1959 #else /* end of -DPETSC_USE_LOG section */ 1960 1961 PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 1962 { 1963 PetscFunctionBegin; 1964 PetscFunctionReturn(0); 1965 } 1966 1967 #endif /* PETSC_USE_LOG*/ 1968 1969 1970 PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 1971 PetscClassId PETSC_OBJECT_CLASSID = 0; 1972 1973 /*@C 1974 PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code. 1975 1976 Not Collective 1977 1978 Input Parameter: 1979 . name - The class name 1980 1981 Output Parameter: 1982 . oclass - The class id or classid 1983 1984 Level: developer 1985 1986 .keywords: log, class, register 1987 1988 @*/ 1989 PetscErrorCode PetscClassIdRegister(const char name[],PetscClassId *oclass) 1990 { 1991 #if defined(PETSC_USE_LOG) 1992 PetscStageLog stageLog; 1993 PetscInt stage; 1994 PetscErrorCode ierr; 1995 #endif 1996 1997 PetscFunctionBegin; 1998 *oclass = ++PETSC_LARGEST_CLASSID; 1999 #if defined(PETSC_USE_LOG) 2000 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 2001 ierr = PetscClassRegLogRegister(stageLog->classLog, name, *oclass);CHKERRQ(ierr); 2002 for (stage = 0; stage < stageLog->numStages; stage++) { 2003 ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 2004 } 2005 #endif 2006 PetscFunctionReturn(0); 2007 } 2008 2009 #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE) 2010 #include <mpe.h> 2011 2012 PetscBool PetscBeganMPE = PETSC_FALSE; 2013 2014 PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2015 PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2016 2017 /*@C 2018 PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files 2019 and slows the program down. 2020 2021 Collective over PETSC_COMM_WORLD 2022 2023 Options Database Keys: 2024 . -log_mpe - Prints extensive log information 2025 2026 Notes: 2027 A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is 2028 intended for production runs since it logs only flop rates and object 2029 creation (and should not significantly slow the programs). 2030 2031 Level: advanced 2032 2033 Concepts: logging^MPE 2034 Concepts: logging^message passing 2035 2036 .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogEventActivate(), 2037 PetscLogEventDeactivate() 2038 @*/ 2039 PetscErrorCode PetscLogMPEBegin(void) 2040 { 2041 PetscErrorCode ierr; 2042 2043 PetscFunctionBegin; 2044 /* Do MPE initialization */ 2045 if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */ 2046 ierr = PetscInfo(0,"Initializing MPE.\n");CHKERRQ(ierr); 2047 ierr = MPE_Init_log();CHKERRQ(ierr); 2048 2049 PetscBeganMPE = PETSC_TRUE; 2050 } else { 2051 ierr = PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n");CHKERRQ(ierr); 2052 } 2053 ierr = PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE);CHKERRQ(ierr); 2054 PetscFunctionReturn(0); 2055 } 2056 2057 /*@C 2058 PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot. 2059 2060 Collective over PETSC_COMM_WORLD 2061 2062 Level: advanced 2063 2064 .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin() 2065 @*/ 2066 PetscErrorCode PetscLogMPEDump(const char sname[]) 2067 { 2068 char name[PETSC_MAX_PATH_LEN]; 2069 PetscErrorCode ierr; 2070 2071 PetscFunctionBegin; 2072 if (PetscBeganMPE) { 2073 ierr = PetscInfo(0,"Finalizing MPE.\n");CHKERRQ(ierr); 2074 if (sname) { 2075 ierr = PetscStrcpy(name,sname);CHKERRQ(ierr); 2076 } else { 2077 ierr = PetscGetProgramName(name,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 2078 } 2079 ierr = MPE_Finish_log(name);CHKERRQ(ierr); 2080 } else { 2081 ierr = PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n");CHKERRQ(ierr); 2082 } 2083 PetscFunctionReturn(0); 2084 } 2085 2086 #define PETSC_RGB_COLORS_MAX 39 2087 static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = { 2088 "OliveDrab: ", 2089 "BlueViolet: ", 2090 "CadetBlue: ", 2091 "CornflowerBlue: ", 2092 "DarkGoldenrod: ", 2093 "DarkGreen: ", 2094 "DarkKhaki: ", 2095 "DarkOliveGreen: ", 2096 "DarkOrange: ", 2097 "DarkOrchid: ", 2098 "DarkSeaGreen: ", 2099 "DarkSlateGray: ", 2100 "DarkTurquoise: ", 2101 "DeepPink: ", 2102 "DarkKhaki: ", 2103 "DimGray: ", 2104 "DodgerBlue: ", 2105 "GreenYellow: ", 2106 "HotPink: ", 2107 "IndianRed: ", 2108 "LavenderBlush: ", 2109 "LawnGreen: ", 2110 "LemonChiffon: ", 2111 "LightCoral: ", 2112 "LightCyan: ", 2113 "LightPink: ", 2114 "LightSalmon: ", 2115 "LightSlateGray: ", 2116 "LightYellow: ", 2117 "LimeGreen: ", 2118 "MediumPurple: ", 2119 "MediumSeaGreen: ", 2120 "MediumSlateBlue:", 2121 "MidnightBlue: ", 2122 "MintCream: ", 2123 "MistyRose: ", 2124 "NavajoWhite: ", 2125 "NavyBlue: ", 2126 "OliveDrab: " 2127 }; 2128 2129 /*@C 2130 PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister() 2131 2132 Not collective. Maybe it should be? 2133 2134 Output Parameter 2135 . str - character string representing the color 2136 2137 Level: developer 2138 2139 .keywords: log, mpe , color 2140 .seealso: PetscLogEventRegister 2141 @*/ 2142 PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) 2143 { 2144 static int idx = 0; 2145 2146 PetscFunctionBegin; 2147 *str = PetscLogMPERGBColors[idx]; 2148 idx = (idx + 1)% PETSC_RGB_COLORS_MAX; 2149 PetscFunctionReturn(0); 2150 } 2151 2152 #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */ 2153