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