xref: /petsc/src/sys/tests/ex68.c (revision 934c28ddc29f2ef830f40fcfadab042dd386ea01)

const char help[] = "Test PetscLogEventsPause() and PetscLogEventsUnpause()";

#include <petscsys.h>

int main(int argc, char **argv)
{
  const PetscInt  num_log_events = 4;
  PetscLogStage   main_stage, unrelated_stage_1, unrelated_stage_2;
  PetscLogEvent   runtime_event, unrelated_event[4];
  PetscLogHandler default_handler;
  PetscClassId    runtime_classid, unrelated_classid[4];
  PetscBool       main_visible      = PETSC_FALSE;
  PetscBool       unrelated_visible = PETSC_FALSE;
  PetscBool       get_main_visible;
  PetscBool       get_unrelated_1_visible;
  PetscBool       get_unrelated_2_visible;
  PetscBool       is_active;

  PetscCall(PetscInitialize(&argc, &argv, NULL, help));
  PetscCall(PetscLogIsActive(&is_active));
  PetscCheck(is_active, PETSC_COMM_WORLD, PETSC_ERR_SUP, "Logging must be active for this test");
  PetscCall(PetscLogActions(PETSC_FALSE));
  PetscCall(PetscLogObjects(PETSC_FALSE));

  PetscOptionsBegin(PETSC_COMM_WORLD, NULL, help, NULL);
  PetscCall(PetscOptionsBool("-main_visible", "The logging visibility of the main stage", NULL, main_visible, &main_visible, NULL));
  PetscCall(PetscOptionsBool("-unrelated_visible", "The logging visibility of the unrelated stage", NULL, unrelated_visible, &unrelated_visible, NULL));
  PetscOptionsEnd();

  /* This test simulates a program with unrelated logging stages and events
     that has to "stop the world" to lazily initialize a runtime.

     - Pausing events should send the log data for the runtime initialization
       to the Main Stage

     - Turning the Main Stage invisible should hide it from -log_view

     So the runtime initialization should be more or less missing from -log_view. */

  PetscCall(PetscClassIdRegister("External runtime", &runtime_classid));
  PetscCall(PetscLogEventRegister("External runtime initialization", runtime_classid, &runtime_event));

  for (PetscInt i = 0; i < num_log_events; i++) {
    char name[32];

    PetscCall(PetscSNPrintf(name, sizeof(name) / sizeof(char), "Unrelated event %" PetscInt_FMT, i));
    PetscCall(PetscClassIdRegister(name, &unrelated_classid[i]));
    PetscCall(PetscLogEventRegister(name, unrelated_classid[i], &unrelated_event[i]));
  }
  PetscCall(PetscLogStageRegister("Unrelated stage 1", &unrelated_stage_1));
  PetscCall(PetscLogStageRegister("Unrelated stage 2", &unrelated_stage_2));
  PetscCall(PetscLogStageGetId("Main Stage", &main_stage));
  PetscCall(PetscLogStageSetVisible(main_stage, main_visible));
  PetscCall(PetscLogStageSetVisible(unrelated_stage_1, unrelated_visible));
  PetscCall(PetscLogStageSetVisible(unrelated_stage_2, unrelated_visible));
  PetscCall(PetscLogGetDefaultHandler(&default_handler));
  if (default_handler) {
    PetscCall(PetscLogStageGetVisible(main_stage, &get_main_visible));
    PetscCall(PetscLogStageGetVisible(unrelated_stage_1, &get_unrelated_1_visible));
    PetscCall(PetscLogStageGetVisible(unrelated_stage_2, &get_unrelated_2_visible));
    PetscCheck(main_visible == get_main_visible, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Get/Set stage visibility discrepancy");
    PetscCheck(unrelated_visible == get_unrelated_1_visible, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Get/Set stage visibility discrepancy");
    PetscCheck(unrelated_visible == get_unrelated_2_visible, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Get/Set stage visibility discrepancy");
  }

  PetscCall(PetscLogStagePush(unrelated_stage_1));
  PetscCall(PetscLogEventBegin(unrelated_event[0], NULL, NULL, NULL, NULL));
  PetscCall(PetscSleep(0.05));
  PetscCall(PetscLogEventBegin(unrelated_event[1], NULL, NULL, NULL, NULL));
  PetscCall(PetscSleep(0.05));
  PetscCall(PetscLogStagePush(unrelated_stage_2));
  PetscCall(PetscLogEventBegin(unrelated_event[2], NULL, NULL, NULL, NULL));
  PetscCall(PetscSleep(0.05));
  PetscCall(PetscLogEventBegin(unrelated_event[3], NULL, NULL, NULL, NULL));
  PetscCall(PetscSleep(0.05));
  PetscCall(PetscLogEventsPause());
  PetscCall(PetscLogEventBegin(runtime_event, NULL, NULL, NULL, NULL));
  PetscCall(PetscSleep(0.2));
  PetscCall(PetscLogEventEnd(runtime_event, NULL, NULL, NULL, NULL));
  PetscCall(PetscLogEventsResume());
  PetscCall(PetscLogEventEnd(unrelated_event[3], NULL, NULL, NULL, NULL));
  PetscCall(PetscSleep(0.05));
  PetscCall(PetscLogEventEnd(unrelated_event[2], NULL, NULL, NULL, NULL));
  PetscCall(PetscSleep(0.05));
  PetscCall(PetscLogStagePop());
  PetscCall(PetscSleep(0.05));
  PetscCall(PetscLogEventEnd(unrelated_event[1], NULL, NULL, NULL, NULL));
  PetscCall(PetscSleep(0.05));
  PetscCall(PetscLogEventEnd(unrelated_event[0], NULL, NULL, NULL, NULL));
  PetscCall(PetscLogStagePop());
  { // test of PetscLogStageGetPerfInfo()
    PetscLogHandler handler;

    PetscCall(PetscLogGetDefaultHandler(&handler));
    if (handler) {
      PetscEventPerfInfo stage_info;

      PetscCall(PetscLogStageGetPerfInfo(unrelated_stage_1, &stage_info));
      (void)stage_info;
    }
  }
  PetscCall(PetscFinalize());
  return 0;
}

/*TEST

  # main stage invisible, "External runtime initialization" shouldn't appear in the log
  test:
    requires: defined(PETSC_USE_LOG)
    suffix: 0
    args: -log_view -unrelated_visible -log_view_memory
    filter: grep -o "\\(External runtime initialization\\|Unrelated event\\)"

  # unrelated stage invisible, "Unrelated event" shouldn't appear in the log
  test:
    requires: defined(PETSC_USE_LOG)
    suffix: 1
    args: -log_view -main_visible -log_view_memory
    filter: grep -o "\\(External runtime initialization\\|Unrelated event\\)"

TEST*/