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", 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 if (eventInfo->dof >= 0.) { 1199 PetscInt e; 1200 1201 ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : %.0g", eventInfo->dof);CHKERRQ(ierr); 1202 ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [");CHKERRQ(ierr); 1203 for (e = 0; e < 8; ++e) { 1204 if (e > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);} 1205 ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e]);CHKERRQ(ierr); 1206 } 1207 ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr); 1208 } 1209 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"}\n");CHKERRQ(ierr); 1210 } 1211 } 1212 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 1213 ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 1214 PetscFunctionReturn(0); 1215 } 1216 1217 static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm,FILE *fd) 1218 { 1219 PetscErrorCode ierr; 1220 PetscFunctionBegin; 1221 if (!PetscLogSyncOn) PetscFunctionReturn(0); 1222 ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1223 ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1224 ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1225 ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1226 ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1227 ierr = PetscFPrintf(comm, fd, " # This program was run with logging synchronization. #\n");CHKERRQ(ierr); 1228 ierr = PetscFPrintf(comm, fd, " # This option provides more meaningful imbalance #\n");CHKERRQ(ierr); 1229 ierr = PetscFPrintf(comm, fd, " # figures at the expense of slowing things down and #\n");CHKERRQ(ierr); 1230 ierr = PetscFPrintf(comm, fd, " # providing a distorted view of the overall runtime. #\n");CHKERRQ(ierr); 1231 ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1232 ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1233 PetscFunctionReturn(0); 1234 PetscFunctionReturn(0); 1235 } 1236 1237 static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm,FILE *fd) 1238 { 1239 #if defined(PETSC_USE_DEBUG) 1240 PetscErrorCode ierr; 1241 1242 PetscFunctionBegin; 1243 ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1244 ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1245 ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1246 ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1247 ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1248 ierr = PetscFPrintf(comm, fd, " # This code was compiled with a debugging option. #\n");CHKERRQ(ierr); 1249 ierr = PetscFPrintf(comm, fd, " # To get timing results run ./configure #\n");CHKERRQ(ierr); 1250 ierr = PetscFPrintf(comm, fd, " # using --with-debugging=no, the performance will #\n");CHKERRQ(ierr); 1251 ierr = PetscFPrintf(comm, fd, " # be generally two or three times faster. #\n");CHKERRQ(ierr); 1252 ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1253 ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1254 PetscFunctionReturn(0); 1255 #else 1256 return 0; 1257 #endif 1258 } 1259 1260 PetscErrorCode PetscLogView_Default(PetscViewer viewer) 1261 { 1262 FILE *fd; 1263 PetscLogDouble zero = 0.0; 1264 PetscStageLog stageLog; 1265 PetscStageInfo *stageInfo = NULL; 1266 PetscEventPerfInfo *eventInfo = NULL; 1267 PetscClassPerfInfo *classInfo; 1268 char arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128]; 1269 const char *name; 1270 PetscLogDouble locTotalTime, TotalTime, TotalFlops; 1271 PetscLogDouble numMessages, messageLength, avgMessLen, numReductions; 1272 PetscLogDouble stageTime, flops, flopr, mem, mess, messLen, red; 1273 PetscLogDouble fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed; 1274 PetscLogDouble fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed; 1275 PetscLogDouble min, max, tot, ratio, avg, x, y; 1276 PetscLogDouble minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr; 1277 PetscMPIInt minC, maxC; 1278 PetscMPIInt size, rank; 1279 PetscBool *localStageUsed, *stageUsed; 1280 PetscBool *localStageVisible, *stageVisible; 1281 int numStages, localNumEvents, numEvents; 1282 int stage, oclass; 1283 PetscLogEvent event; 1284 PetscErrorCode ierr; 1285 char version[256]; 1286 MPI_Comm comm; 1287 1288 PetscFunctionBegin; 1289 ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 1290 ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr); 1291 ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 1292 ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 1293 /* Get the total elapsed time */ 1294 PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 1295 1296 ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 1297 ierr = PetscFPrintf(comm, fd, "*** WIDEN YOUR WINDOW TO 120 CHARACTERS. Use 'enscript -r -fCourier9' to print this document ***\n");CHKERRQ(ierr); 1298 ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 1299 ierr = PetscFPrintf(comm, fd, "\n---------------------------------------------- PETSc Performance Summary: ----------------------------------------------\n\n");CHKERRQ(ierr); 1300 ierr = PetscLogViewWarnSync(comm,fd);CHKERRQ(ierr); 1301 ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 1302 ierr = PetscGetArchType(arch,sizeof(arch));CHKERRQ(ierr); 1303 ierr = PetscGetHostName(hostname,sizeof(hostname));CHKERRQ(ierr); 1304 ierr = PetscGetUserName(username,sizeof(username));CHKERRQ(ierr); 1305 ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr); 1306 ierr = PetscGetDate(date,sizeof(date));CHKERRQ(ierr); 1307 ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr); 1308 if (size == 1) { 1309 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); 1310 } else { 1311 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); 1312 } 1313 1314 ierr = PetscFPrintf(comm, fd, "Using %s\n", version);CHKERRQ(ierr); 1315 1316 /* Must preserve reduction count before we go on */ 1317 red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 1318 1319 /* Calculate summary information */ 1320 ierr = PetscFPrintf(comm, fd, "\n Max Max/Min Avg Total \n");CHKERRQ(ierr); 1321 /* Time */ 1322 ierr = MPIU_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1323 ierr = MPIU_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1324 ierr = MPIU_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1325 avg = tot/((PetscLogDouble) size); 1326 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1327 ierr = PetscFPrintf(comm, fd, "Time (sec): %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 1328 TotalTime = tot; 1329 /* Objects */ 1330 avg = (PetscLogDouble) petsc_numObjects; 1331 ierr = MPIU_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1332 ierr = MPIU_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1333 ierr = MPIU_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1334 avg = tot/((PetscLogDouble) size); 1335 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1336 ierr = PetscFPrintf(comm, fd, "Objects: %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 1337 /* Flops */ 1338 ierr = MPIU_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1339 ierr = MPIU_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1340 ierr = MPIU_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1341 avg = tot/((PetscLogDouble) size); 1342 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1343 ierr = PetscFPrintf(comm, fd, "Flop: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 1344 TotalFlops = tot; 1345 /* Flops/sec -- Must talk to Barry here */ 1346 if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime; else flops = 0.0; 1347 ierr = MPIU_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1348 ierr = MPIU_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1349 ierr = MPIU_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1350 avg = tot/((PetscLogDouble) size); 1351 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1352 ierr = PetscFPrintf(comm, fd, "Flop/sec: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 1353 /* Memory */ 1354 ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr); 1355 if (mem > 0.0) { 1356 ierr = MPIU_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1357 ierr = MPIU_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1358 ierr = MPIU_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1359 avg = tot/((PetscLogDouble) size); 1360 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1361 ierr = PetscFPrintf(comm, fd, "Memory: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 1362 } 1363 /* Messages */ 1364 mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct); 1365 ierr = MPIU_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1366 ierr = MPIU_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1367 ierr = MPIU_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1368 avg = tot/((PetscLogDouble) size); 1369 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1370 ierr = PetscFPrintf(comm, fd, "MPI Messages: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 1371 numMessages = tot; 1372 /* Message Lengths */ 1373 mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len); 1374 ierr = MPIU_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1375 ierr = MPIU_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1376 ierr = MPIU_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1377 if (numMessages != 0) avg = tot/numMessages; else avg = 0.0; 1378 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1379 ierr = PetscFPrintf(comm, fd, "MPI Message Lengths: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 1380 messageLength = tot; 1381 /* Reductions */ 1382 ierr = MPIU_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1383 ierr = MPIU_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1384 ierr = MPIU_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1385 if (min != 0.0) ratio = max/min; else ratio = 0.0; 1386 ierr = PetscFPrintf(comm, fd, "MPI Reductions: %5.3e %7.3f\n", max, ratio);CHKERRQ(ierr); 1387 numReductions = red; /* wrong because uses count from process zero */ 1388 ierr = PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n");CHKERRQ(ierr); 1389 ierr = PetscFPrintf(comm, fd, " e.g., VecAXPY() for real vectors of length N --> 2N flop\n");CHKERRQ(ierr); 1390 ierr = PetscFPrintf(comm, fd, " and VecAXPY() for complex vectors of length N --> 8N flop\n");CHKERRQ(ierr); 1391 1392 /* Get total number of stages -- 1393 Currently, a single processor can register more stages than another, but stages must all be registered in order. 1394 We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID. 1395 This seems best accomplished by assoicating a communicator with each stage. 1396 */ 1397 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1398 ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1399 ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr); 1400 ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr); 1401 ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr); 1402 ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr); 1403 if (numStages > 0) { 1404 stageInfo = stageLog->stageInfo; 1405 for (stage = 0; stage < numStages; stage++) { 1406 if (stage < stageLog->numStages) { 1407 localStageUsed[stage] = stageInfo[stage].used; 1408 localStageVisible[stage] = stageInfo[stage].perfInfo.visible; 1409 } else { 1410 localStageUsed[stage] = PETSC_FALSE; 1411 localStageVisible[stage] = PETSC_TRUE; 1412 } 1413 } 1414 ierr = MPIU_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm);CHKERRQ(ierr); 1415 ierr = MPIU_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr); 1416 for (stage = 0; stage < numStages; stage++) { 1417 if (stageUsed[stage]) { 1418 ierr = PetscFPrintf(comm, fd, "\nSummary of Stages: ----- Time ------ ----- Flop ------ --- Messages --- -- Message Lengths -- -- Reductions --\n");CHKERRQ(ierr); 1419 ierr = PetscFPrintf(comm, fd, " Avg %%Total Avg %%Total Count %%Total Avg %%Total Count %%Total \n");CHKERRQ(ierr); 1420 break; 1421 } 1422 } 1423 for (stage = 0; stage < numStages; stage++) { 1424 if (!stageUsed[stage]) continue; 1425 /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 1426 if (localStageUsed[stage]) { 1427 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1428 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1429 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1430 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1431 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1432 name = stageInfo[stage].name; 1433 } else { 1434 ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1435 ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1436 ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1437 ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1438 ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1439 name = ""; 1440 } 1441 mess *= 0.5; messLen *= 0.5; red /= size; 1442 if (TotalTime != 0.0) fracTime = stageTime/TotalTime; else fracTime = 0.0; 1443 if (TotalFlops != 0.0) fracFlops = flops/TotalFlops; else fracFlops = 0.0; 1444 /* Talk to Barry if (stageTime != 0.0) flops = (size*flops)/stageTime; else flops = 0.0; */ 1445 if (numMessages != 0.0) fracMessages = mess/numMessages; else fracMessages = 0.0; 1446 if (mess != 0.0) avgMessLen = messLen/mess; else avgMessLen = 0.0; 1447 if (messageLength != 0.0) fracLength = messLen/messageLength; else fracLength = 0.0; 1448 if (numReductions != 0.0) fracReductions = red/numReductions; else fracReductions = 0.0; 1449 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", 1450 stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops, 1451 mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr); 1452 } 1453 } 1454 1455 ierr = PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 1456 ierr = PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n");CHKERRQ(ierr); 1457 ierr = PetscFPrintf(comm, fd, "Phase summary info:\n");CHKERRQ(ierr); 1458 ierr = PetscFPrintf(comm, fd, " Count: number of times phase was executed\n");CHKERRQ(ierr); 1459 ierr = PetscFPrintf(comm, fd, " Time and Flop: Max - maximum over all processors\n");CHKERRQ(ierr); 1460 ierr = PetscFPrintf(comm, fd, " Ratio - ratio of maximum to minimum over all processors\n");CHKERRQ(ierr); 1461 ierr = PetscFPrintf(comm, fd, " Mess: number of messages sent\n");CHKERRQ(ierr); 1462 ierr = PetscFPrintf(comm, fd, " AvgLen: average message length (bytes)\n");CHKERRQ(ierr); 1463 ierr = PetscFPrintf(comm, fd, " Reduct: number of global reductions\n");CHKERRQ(ierr); 1464 ierr = PetscFPrintf(comm, fd, " Global: entire computation\n");CHKERRQ(ierr); 1465 ierr = PetscFPrintf(comm, fd, " Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n");CHKERRQ(ierr); 1466 ierr = PetscFPrintf(comm, fd, " %%T - percent time in this phase %%F - percent flop in this phase\n");CHKERRQ(ierr); 1467 ierr = PetscFPrintf(comm, fd, " %%M - percent messages in this phase %%L - percent message lengths in this phase\n");CHKERRQ(ierr); 1468 ierr = PetscFPrintf(comm, fd, " %%R - percent reductions in this phase\n");CHKERRQ(ierr); 1469 ierr = PetscFPrintf(comm, fd, " Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n");CHKERRQ(ierr); 1470 ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 1471 1472 ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 1473 1474 /* Report events */ 1475 ierr = PetscFPrintf(comm, fd,"Event Count Time (sec) Flop --- Global --- --- Stage ---- Total\n");CHKERRQ(ierr); 1476 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); 1477 ierr = PetscFPrintf(comm,fd,"------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 1478 1479 /* Problem: The stage name will not show up unless the stage executed on proc 1 */ 1480 for (stage = 0; stage < numStages; stage++) { 1481 if (!stageVisible[stage]) continue; 1482 /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 1483 if (localStageUsed[stage]) { 1484 ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 1485 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1486 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1487 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1488 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1489 ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1490 } else { 1491 ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 1492 ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1493 ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1494 ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1495 ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1496 ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1497 } 1498 mess *= 0.5; messLen *= 0.5; red /= size; 1499 1500 /* Get total number of events in this stage -- 1501 Currently, a single processor can register more events than another, but events must all be registered in order, 1502 just like stages. We can removed this requirement if necessary by having a global event numbering and indirection 1503 on the event ID. This seems best accomplished by associating a communicator with each stage. 1504 1505 Problem: If the event did not happen on proc 1, its name will not be available. 1506 Problem: Event visibility is not implemented 1507 */ 1508 if (localStageUsed[stage]) { 1509 eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 1510 localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents; 1511 } else localNumEvents = 0; 1512 ierr = MPIU_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1513 for (event = 0; event < numEvents; event++) { 1514 /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 1515 if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) { 1516 if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; else flopr = 0.0; 1517 ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1518 ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1519 ierr = MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1520 ierr = MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1521 ierr = MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1522 ierr = MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1523 ierr = MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1524 ierr = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1525 ierr = MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1526 ierr = MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRQ(ierr); 1527 ierr = MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1528 name = stageLog->eventLog->eventInfo[event].name; 1529 } else { 1530 flopr = 0.0; 1531 ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1532 ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1533 ierr = MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1534 ierr = MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1535 ierr = MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1536 ierr = MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1537 ierr = MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1538 ierr = MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1539 ierr = MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1540 ierr = MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRQ(ierr); 1541 ierr = MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1542 name = ""; 1543 } 1544 if (mint < 0.0) { 1545 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); 1546 mint = 0; 1547 } 1548 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); 1549 totm *= 0.5; totml *= 0.5; totr /= size; 1550 1551 if (maxC != 0) { 1552 if (minC != 0) ratC = ((PetscLogDouble)maxC)/minC;else ratC = 0.0; 1553 if (mint != 0.0) ratt = maxt/mint; else ratt = 0.0; 1554 if (minf != 0.0) ratf = maxf/minf; else ratf = 0.0; 1555 if (TotalTime != 0.0) fracTime = tott/TotalTime; else fracTime = 0.0; 1556 if (TotalFlops != 0.0) fracFlops = totf/TotalFlops; else fracFlops = 0.0; 1557 if (stageTime != 0.0) fracStageTime = tott/stageTime; else fracStageTime = 0.0; 1558 if (flops != 0.0) fracStageFlops = totf/flops; else fracStageFlops = 0.0; 1559 if (numMessages != 0.0) fracMess = totm/numMessages; else fracMess = 0.0; 1560 if (messageLength != 0.0) fracMessLen = totml/messageLength; else fracMessLen = 0.0; 1561 if (numReductions != 0.0) fracRed = totr/numReductions; else fracRed = 0.0; 1562 if (mess != 0.0) fracStageMess = totm/mess; else fracStageMess = 0.0; 1563 if (messLen != 0.0) fracStageMessLen = totml/messLen; else fracStageMessLen = 0.0; 1564 if (red != 0.0) fracStageRed = totr/red; else fracStageRed = 0.0; 1565 if (totm != 0.0) totml /= totm; else totml = 0.0; 1566 if (maxt != 0.0) flopr = totf/maxt; else flopr = 0.0; 1567 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); 1568 ierr = PetscFPrintf(comm, fd, 1569 "%-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", 1570 name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr, 1571 100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed, 1572 100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed, 1573 PetscAbs(flopr)/1.0e6);CHKERRQ(ierr); 1574 } 1575 } 1576 } 1577 1578 /* Memory usage and object creation */ 1579 ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 1580 ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 1581 ierr = PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n");CHKERRQ(ierr); 1582 1583 /* Right now, only stages on the first processor are reported here, meaning only objects associated with 1584 the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then 1585 stats for stages local to processor sets. 1586 */ 1587 /* We should figure out the longest object name here (now 20 characters) */ 1588 ierr = PetscFPrintf(comm, fd, "Object Type Creations Destructions Memory Descendants' Mem.\n");CHKERRQ(ierr); 1589 ierr = PetscFPrintf(comm, fd, "Reports information only for process 0.\n");CHKERRQ(ierr); 1590 for (stage = 0; stage < numStages; stage++) { 1591 if (localStageUsed[stage]) { 1592 classInfo = stageLog->stageInfo[stage].classLog->classInfo; 1593 ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 1594 for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) { 1595 if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) { 1596 ierr = PetscFPrintf(comm, fd, "%20s %5d %5d %11.0f %g\n", stageLog->classLog->classInfo[oclass].name, 1597 classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem, 1598 classInfo[oclass].descMem);CHKERRQ(ierr); 1599 } 1600 } 1601 } else { 1602 if (!localStageVisible[stage]) continue; 1603 ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 1604 } 1605 } 1606 1607 ierr = PetscFree(localStageUsed);CHKERRQ(ierr); 1608 ierr = PetscFree(stageUsed);CHKERRQ(ierr); 1609 ierr = PetscFree(localStageVisible);CHKERRQ(ierr); 1610 ierr = PetscFree(stageVisible);CHKERRQ(ierr); 1611 1612 /* Information unrelated to this particular run */ 1613 ierr = PetscFPrintf(comm, fd, "========================================================================================================================\n");CHKERRQ(ierr); 1614 PetscTime(&y); 1615 PetscTime(&x); 1616 PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 1617 PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 1618 ierr = PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0);CHKERRQ(ierr); 1619 /* MPI information */ 1620 if (size > 1) { 1621 MPI_Status status; 1622 PetscMPIInt tag; 1623 MPI_Comm newcomm; 1624 1625 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1626 PetscTime(&x); 1627 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1628 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1629 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1630 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1631 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1632 PetscTime(&y); 1633 ierr = PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0);CHKERRQ(ierr); 1634 ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr); 1635 ierr = MPI_Barrier(comm);CHKERRQ(ierr); 1636 if (rank) { 1637 ierr = MPI_Recv(NULL, 0, MPI_INT, rank-1, tag, newcomm, &status);CHKERRQ(ierr); 1638 ierr = MPI_Send(NULL, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRQ(ierr); 1639 } else { 1640 PetscTime(&x); 1641 ierr = MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm);CHKERRQ(ierr); 1642 ierr = MPI_Recv(NULL, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRQ(ierr); 1643 PetscTime(&y); 1644 ierr = PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size);CHKERRQ(ierr); 1645 } 1646 ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr); 1647 } 1648 ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr); 1649 1650 /* Machine and compile information */ 1651 #if defined(PETSC_USE_FORTRAN_KERNELS) 1652 ierr = PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n");CHKERRQ(ierr); 1653 #else 1654 ierr = PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n");CHKERRQ(ierr); 1655 #endif 1656 #if defined(PETSC_USE_64BIT_INDICES) 1657 ierr = PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n");CHKERRQ(ierr); 1658 #elif defined(PETSC_USE___FLOAT128) 1659 ierr = PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n");CHKERRQ(ierr); 1660 #endif 1661 #if defined(PETSC_USE_REAL_SINGLE) 1662 ierr = PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 1663 #elif defined(PETSC_USE___FLOAT128) 1664 ierr = PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 1665 #endif 1666 #if defined(PETSC_USE_REAL_MAT_SINGLE) 1667 ierr = PetscFPrintf(comm, fd, "Compiled with single precision matrices\n");CHKERRQ(ierr); 1668 #else 1669 ierr = PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n");CHKERRQ(ierr); 1670 #endif 1671 ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n", 1672 (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr); 1673 1674 ierr = PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions);CHKERRQ(ierr); 1675 ierr = PetscFPrintf(comm, fd, "%s", petscmachineinfo);CHKERRQ(ierr); 1676 ierr = PetscFPrintf(comm, fd, "%s", petsccompilerinfo);CHKERRQ(ierr); 1677 ierr = PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo);CHKERRQ(ierr); 1678 ierr = PetscFPrintf(comm, fd, "%s", petsclinkerinfo);CHKERRQ(ierr); 1679 1680 /* Cleanup */ 1681 ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 1682 ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 1683 PetscFunctionReturn(0); 1684 } 1685 1686 /*@C 1687 PetscLogView - Prints a summary of the logging. 1688 1689 Collective over MPI_Comm 1690 1691 Input Parameter: 1692 . viewer - an ASCII viewer 1693 1694 Options Database Keys: 1695 + -log_view [:filename] - Prints summary of log information 1696 . -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file 1697 . -log_view :filename.xml:ascii_xml - Saves a summary of the logging information in a nested format (see below for how to view it) 1698 . -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation 1699 - -log_trace [filename] - Displays a trace of what each process is doing 1700 1701 Notes: 1702 It is possible to control the logging programatically but we recommend using the options database approach whenever possible 1703 By default the summary is printed to stdout. 1704 1705 Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin() 1706 1707 If PETSc is configured with --with-logging=0 then this functionality is not available 1708 1709 To view the nested XML format filename.xml first copy ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current 1710 directory then open filename.xml with your browser. Specific notes for certain browsers 1711 $ Firefox and Internet explorer - simply open the file 1712 $ Google Chrome - you must start up Chrome with the option --allow-file-access-from-files 1713 $ Safari - see http://ccm.net/faq/36342-safari-how-to-enable-local-file-access 1714 or one can use the package http://xmlsoft.org/XSLT/xsltproc2.html to translate the xml file to html and then open it with 1715 your browser. 1716 1717 The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij MARITIME RESEARCH INSTITUTE NETHERLANDS 1718 1719 Level: beginner 1720 1721 .keywords: log, dump, print 1722 .seealso: PetscLogDefaultBegin(), PetscLogDump() 1723 @*/ 1724 PetscErrorCode PetscLogView(PetscViewer viewer) 1725 { 1726 PetscErrorCode ierr; 1727 PetscBool isascii; 1728 PetscViewerFormat format; 1729 int stage, lastStage; 1730 PetscStageLog stageLog; 1731 1732 PetscFunctionBegin; 1733 if (!PetscLogPLB) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_view or PetscLogDefaultBegin() before calling this routine"); 1734 /* Pop off any stages the user forgot to remove */ 1735 lastStage = 0; 1736 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1737 ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 1738 while (stage >= 0) { 1739 lastStage = stage; 1740 ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 1741 ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 1742 } 1743 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 1744 if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII"); 1745 ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr); 1746 if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) { 1747 ierr = PetscLogView_Default(viewer);CHKERRQ(ierr); 1748 } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 1749 ierr = PetscLogView_Detailed(viewer);CHKERRQ(ierr); 1750 } else if (format == PETSC_VIEWER_ASCII_XML) { 1751 ierr = PetscLogView_Nested(viewer);CHKERRQ(ierr); 1752 } 1753 ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr); 1754 PetscFunctionReturn(0); 1755 } 1756 1757 /*@C 1758 PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed. 1759 1760 Collective on PETSC_COMM_WORLD 1761 1762 Not normally called by user 1763 1764 Level: intermediate 1765 1766 @*/ 1767 PetscErrorCode PetscLogViewFromOptions(void) 1768 { 1769 PetscErrorCode ierr; 1770 PetscViewer viewer; 1771 PetscBool flg; 1772 PetscViewerFormat format; 1773 1774 PetscFunctionBegin; 1775 ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,"-log_view",&viewer,&format,&flg);CHKERRQ(ierr); 1776 if (flg) { 1777 ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 1778 ierr = PetscLogView(viewer);CHKERRQ(ierr); 1779 ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 1780 ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1781 } 1782 PetscFunctionReturn(0); 1783 } 1784 1785 1786 1787 /*----------------------------------------------- Counter Functions -------------------------------------------------*/ 1788 /*@C 1789 PetscGetFlops - Returns the number of flops used on this processor 1790 since the program began. 1791 1792 Not Collective 1793 1794 Output Parameter: 1795 flops - number of floating point operations 1796 1797 Notes: 1798 A global counter logs all PETSc flop counts. The user can use 1799 PetscLogFlops() to increment this counter to include flops for the 1800 application code. 1801 1802 Level: intermediate 1803 1804 .keywords: log, flops, floating point operations 1805 1806 .seealso: PetscTime(), PetscLogFlops() 1807 @*/ 1808 PetscErrorCode PetscGetFlops(PetscLogDouble *flops) 1809 { 1810 PetscFunctionBegin; 1811 *flops = petsc_TotalFlops; 1812 PetscFunctionReturn(0); 1813 } 1814 1815 PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 1816 { 1817 PetscErrorCode ierr; 1818 size_t fullLength; 1819 va_list Argp; 1820 1821 PetscFunctionBegin; 1822 if (!petsc_logObjects) PetscFunctionReturn(0); 1823 va_start(Argp, format); 1824 ierr = PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp);CHKERRQ(ierr); 1825 va_end(Argp); 1826 PetscFunctionReturn(0); 1827 } 1828 1829 1830 /*MC 1831 PetscLogFlops - Adds floating point operations to the global counter. 1832 1833 Synopsis: 1834 #include <petsclog.h> 1835 PetscErrorCode PetscLogFlops(PetscLogDouble f) 1836 1837 Not Collective 1838 1839 Input Parameter: 1840 . f - flop counter 1841 1842 1843 Usage: 1844 .vb 1845 PetscLogEvent USER_EVENT; 1846 PetscLogEventRegister("User event",0,&USER_EVENT); 1847 PetscLogEventBegin(USER_EVENT,0,0,0,0); 1848 [code segment to monitor] 1849 PetscLogFlops(user_flops) 1850 PetscLogEventEnd(USER_EVENT,0,0,0,0); 1851 .ve 1852 1853 Notes: 1854 A global counter logs all PETSc flop counts. The user can use 1855 PetscLogFlops() to increment this counter to include flops for the 1856 application code. 1857 1858 Level: intermediate 1859 1860 .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops() 1861 1862 .keywords: log, flops, floating point operations 1863 M*/ 1864 1865 /*MC 1866 PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice) 1867 to get accurate timings 1868 1869 Synopsis: 1870 #include <petsclog.h> 1871 void PetscPreLoadBegin(PetscBool flag,char *name); 1872 1873 Not Collective 1874 1875 Input Parameter: 1876 + flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden 1877 with command line option -preload true or -preload false 1878 - name - name of first stage (lines of code timed separately with -log_view) to 1879 be preloaded 1880 1881 Usage: 1882 .vb 1883 PetscPreLoadBegin(PETSC_TRUE,"first stage); 1884 lines of code 1885 PetscPreLoadStage("second stage"); 1886 lines of code 1887 PetscPreLoadEnd(); 1888 .ve 1889 1890 Notes: 1891 Only works in C/C++, not Fortran 1892 1893 Flags available within the macro. 1894 + PetscPreLoadingUsed - true if we are or have done preloading 1895 . PetscPreLoadingOn - true if it is CURRENTLY doing preload 1896 . PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second 1897 - PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on 1898 The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() 1899 and PetscPreLoadEnd() 1900 1901 Level: intermediate 1902 1903 .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage() 1904 1905 Concepts: preloading 1906 Concepts: timing^accurate 1907 Concepts: paging^eliminating effects of 1908 1909 1910 M*/ 1911 1912 /*MC 1913 PetscPreLoadEnd - End a segment of code that may be preloaded (run twice) 1914 to get accurate timings 1915 1916 Synopsis: 1917 #include <petsclog.h> 1918 void PetscPreLoadEnd(void); 1919 1920 Not Collective 1921 1922 Usage: 1923 .vb 1924 PetscPreLoadBegin(PETSC_TRUE,"first stage); 1925 lines of code 1926 PetscPreLoadStage("second stage"); 1927 lines of code 1928 PetscPreLoadEnd(); 1929 .ve 1930 1931 Notes: 1932 only works in C/C++ not fortran 1933 1934 Level: intermediate 1935 1936 .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage() 1937 1938 M*/ 1939 1940 /*MC 1941 PetscPreLoadStage - Start a new segment of code to be timed separately. 1942 to get accurate timings 1943 1944 Synopsis: 1945 #include <petsclog.h> 1946 void PetscPreLoadStage(char *name); 1947 1948 Not Collective 1949 1950 Usage: 1951 .vb 1952 PetscPreLoadBegin(PETSC_TRUE,"first stage); 1953 lines of code 1954 PetscPreLoadStage("second stage"); 1955 lines of code 1956 PetscPreLoadEnd(); 1957 .ve 1958 1959 Notes: 1960 only works in C/C++ not fortran 1961 1962 Level: intermediate 1963 1964 .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd() 1965 1966 M*/ 1967 1968 1969 #else /* end of -DPETSC_USE_LOG section */ 1970 1971 PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 1972 { 1973 PetscFunctionBegin; 1974 PetscFunctionReturn(0); 1975 } 1976 1977 #endif /* PETSC_USE_LOG*/ 1978 1979 1980 PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 1981 PetscClassId PETSC_OBJECT_CLASSID = 0; 1982 1983 /*@C 1984 PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code. 1985 1986 Not Collective 1987 1988 Input Parameter: 1989 . name - The class name 1990 1991 Output Parameter: 1992 . oclass - The class id or classid 1993 1994 Level: developer 1995 1996 .keywords: log, class, register 1997 1998 @*/ 1999 PetscErrorCode PetscClassIdRegister(const char name[],PetscClassId *oclass) 2000 { 2001 #if defined(PETSC_USE_LOG) 2002 PetscStageLog stageLog; 2003 PetscInt stage; 2004 PetscErrorCode ierr; 2005 #endif 2006 2007 PetscFunctionBegin; 2008 *oclass = ++PETSC_LARGEST_CLASSID; 2009 #if defined(PETSC_USE_LOG) 2010 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 2011 ierr = PetscClassRegLogRegister(stageLog->classLog, name, *oclass);CHKERRQ(ierr); 2012 for (stage = 0; stage < stageLog->numStages; stage++) { 2013 ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 2014 } 2015 #endif 2016 PetscFunctionReturn(0); 2017 } 2018 2019 #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE) 2020 #include <mpe.h> 2021 2022 PetscBool PetscBeganMPE = PETSC_FALSE; 2023 2024 PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2025 PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2026 2027 /*@C 2028 PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files 2029 and slows the program down. 2030 2031 Collective over PETSC_COMM_WORLD 2032 2033 Options Database Keys: 2034 . -log_mpe - Prints extensive log information 2035 2036 Notes: 2037 A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is 2038 intended for production runs since it logs only flop rates and object 2039 creation (and should not significantly slow the programs). 2040 2041 Level: advanced 2042 2043 Concepts: logging^MPE 2044 Concepts: logging^message passing 2045 2046 .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogEventActivate(), 2047 PetscLogEventDeactivate() 2048 @*/ 2049 PetscErrorCode PetscLogMPEBegin(void) 2050 { 2051 PetscErrorCode ierr; 2052 2053 PetscFunctionBegin; 2054 /* Do MPE initialization */ 2055 if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */ 2056 ierr = PetscInfo(0,"Initializing MPE.\n");CHKERRQ(ierr); 2057 ierr = MPE_Init_log();CHKERRQ(ierr); 2058 2059 PetscBeganMPE = PETSC_TRUE; 2060 } else { 2061 ierr = PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n");CHKERRQ(ierr); 2062 } 2063 ierr = PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE);CHKERRQ(ierr); 2064 PetscFunctionReturn(0); 2065 } 2066 2067 /*@C 2068 PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot. 2069 2070 Collective over PETSC_COMM_WORLD 2071 2072 Level: advanced 2073 2074 .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin() 2075 @*/ 2076 PetscErrorCode PetscLogMPEDump(const char sname[]) 2077 { 2078 char name[PETSC_MAX_PATH_LEN]; 2079 PetscErrorCode ierr; 2080 2081 PetscFunctionBegin; 2082 if (PetscBeganMPE) { 2083 ierr = PetscInfo(0,"Finalizing MPE.\n");CHKERRQ(ierr); 2084 if (sname) { 2085 ierr = PetscStrcpy(name,sname);CHKERRQ(ierr); 2086 } else { 2087 ierr = PetscGetProgramName(name,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 2088 } 2089 ierr = MPE_Finish_log(name);CHKERRQ(ierr); 2090 } else { 2091 ierr = PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n");CHKERRQ(ierr); 2092 } 2093 PetscFunctionReturn(0); 2094 } 2095 2096 #define PETSC_RGB_COLORS_MAX 39 2097 static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = { 2098 "OliveDrab: ", 2099 "BlueViolet: ", 2100 "CadetBlue: ", 2101 "CornflowerBlue: ", 2102 "DarkGoldenrod: ", 2103 "DarkGreen: ", 2104 "DarkKhaki: ", 2105 "DarkOliveGreen: ", 2106 "DarkOrange: ", 2107 "DarkOrchid: ", 2108 "DarkSeaGreen: ", 2109 "DarkSlateGray: ", 2110 "DarkTurquoise: ", 2111 "DeepPink: ", 2112 "DarkKhaki: ", 2113 "DimGray: ", 2114 "DodgerBlue: ", 2115 "GreenYellow: ", 2116 "HotPink: ", 2117 "IndianRed: ", 2118 "LavenderBlush: ", 2119 "LawnGreen: ", 2120 "LemonChiffon: ", 2121 "LightCoral: ", 2122 "LightCyan: ", 2123 "LightPink: ", 2124 "LightSalmon: ", 2125 "LightSlateGray: ", 2126 "LightYellow: ", 2127 "LimeGreen: ", 2128 "MediumPurple: ", 2129 "MediumSeaGreen: ", 2130 "MediumSlateBlue:", 2131 "MidnightBlue: ", 2132 "MintCream: ", 2133 "MistyRose: ", 2134 "NavajoWhite: ", 2135 "NavyBlue: ", 2136 "OliveDrab: " 2137 }; 2138 2139 /*@C 2140 PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister() 2141 2142 Not collective. Maybe it should be? 2143 2144 Output Parameter 2145 . str - character string representing the color 2146 2147 Level: developer 2148 2149 .keywords: log, mpe , color 2150 .seealso: PetscLogEventRegister 2151 @*/ 2152 PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) 2153 { 2154 static int idx = 0; 2155 2156 PetscFunctionBegin; 2157 *str = PetscLogMPERGBColors[idx]; 2158 idx = (idx + 1)% PETSC_RGB_COLORS_MAX; 2159 PetscFunctionReturn(0); 2160 } 2161 2162 #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */ 2163