Change printf to PDC logger #232

TheAssembler1 · 2025-03-20T00:15:04Z

This is a large commit but I think it is very beneficial for all logging to go through the PDC logger. This way we get the filename, function name, and line numbers for all logging.

Also removed large blocks of comments and changed the PDC logger to print the file name, function, and line number.

We can now remove a lot of the code that manually printed the line numbers for debugging and error identification reasons.

TheAssembler1 · 2025-03-20T00:33:32Z

Still working on the clang-format I ran it on the codebase I'll look at what the cd/ci scripts do...

Also removed large blocks of comments and chanegd the pdc logger to print the file name, function, and line number.

sbyna · 2025-03-20T00:49:01Z

examples/haccio.c

@@ -77,7 +77,7 @@ create_pdc_object(pdcid_t pdc_id, pdcid_t cont_id, const char *obj_name, pdc_var

    pdcid_t obj_id = PDCobj_create_mpi(cont_id, obj_name, *obj_prop, 0, comm);
    if (obj_id == 0) {
-        printf("Error getting an object id of %s from server, exit...\n", "obj-var-xx");
+        LOG_INFO("Error getting an object id of %s from server, exit...\n", "obj-var-xx");


LOG_ERROR or LOG_INFO?

sbyna · 2025-03-20T00:49:16Z

examples/haccio.c

@@ -142,7 +142,7 @@ main(int argc, char **argv)
    for (i = 0; i < NUM_VARS; i++) {
        ret = PDCreg_obtain_lock(obj_ids[i], region_remote_ids[i], PDC_WRITE, PDC_NOBLOCK);
        if (ret != SUCCEED) {
-            printf("Fail to obtain lock @ line  %d!\n", __LINE__);
+            LOG_INFO("Fail to obtain lock");


LOG_ERROR or LOG_INFO?

sbyna · 2025-03-20T00:49:44Z

examples/haccio.c

@@ -174,7 +174,7 @@ main(int argc, char **argv)
    for (i = 0; i < NUM_VARS; i++) {
        ret = PDCreg_release_lock(obj_ids[i], region_remote_ids[i], PDC_WRITE);
        if (ret != SUCCEED) {
-            printf("Fail to release lock @ line  %d!\n", __LINE__);
+            LOG_INFO("Fail to release lock");


LOG_ERROR or LOG_INFO? There are several similar ones in this file.

sbyna · 2025-03-20T00:50:52Z

examples/haccio_v2.c

@@ -78,7 +78,7 @@ create_pdc_object(pdcid_t pdc_id, pdcid_t cont_id, const char *obj_name, pdc_var

    pdcid_t obj_id = PDCobj_create_mpi(cont_id, obj_name, *obj_prop, 0, comm);
    if (obj_id == 0) {
-        printf("Error getting an object id of %s from server, exit...\n", "obj-var-xx");
+        LOG_INFO("Error getting an object id of %s from server, exit...\n", "obj-var-xx");


LOG_ERROR or LOG_INFO?

sbyna · 2025-03-20T00:52:11Z

examples/llsm/llsm_aux/parallelReadTiff.c


        if (!tif)
-            printf("tiff:threadError | File \"%s\" cannot be opened\n", fileName);
+            LGO_ERROR("tiff:threadError | File \"%s\" cannot be opened\n", fileName);


LGO_ERROR --> LOG_ERROR. This may be caught by compiler.

sbyna · 2025-03-20T00:53:39Z

examples/obj_get_data.c

    }

    // close a container
    if (PDCcont_close(cont) < 0) {
-        printf("fail to close container c1\n");
+        LOG_INFO("Fail to close container c1\n");


LOG_ERROR or LOG_INFO?

sbyna · 2025-03-20T00:54:39Z

examples/pdc_init.c


    // close pdc
    if (PDCclose(pdc) < 0) {
-        printf("fail to close PDC\n");
+        LOGI("fail to close PDC\n");


"failed to close PDC."

sbyna · 2025-03-20T00:55:04Z

examples/obj_get_data.c

    }
    // close pdc
    if (PDCclose(pdc) < 0) {
-        printf("fail to close PDC\n");
+        LOG_INFO("Fail to close PDC\n");


"Failed to close PDC"

sbyna · 2025-03-20T00:55:15Z

examples/obj_get_data.c

        ret_value = 1;
    }
    else {
-        printf("successfully close container property\n");
+        LOG_INFO("successfully close container property\n");


sbyna · 2025-03-20T00:55:25Z

examples/obj_get_data.c

    }
    // close a container property
    if (PDCprop_close(cont_prop) < 0) {
-        printf("Fail to close property @ line %d\n", __LINE__);
+        LOG_INFO("Fail to close property");


sbyna · 2025-03-20T00:55:35Z

examples/obj_get_data.c

        ret_value = 1;
    }
    else {
-        printf("successfully close container c1\n");
+        LOG_INFO("successfully close container c1\n");


sbyna · 2025-03-20T00:56:51Z

examples/read_write_perf.c

@@ -129,26 +129,26 @@ main(int argc, char **argv)
    // create a container property
    cont_prop = PDCprop_create(PDC_CONT_CREATE, pdc);
    if (cont_prop <= 0) {
-        printf("Fail to create container property @ line  %d!\n", __LINE__);
+        LOG_INFO("Fail to create container property");


while we are at it, correct the grammar as well. "Failed"

houjun

@TheAssembler1 can you also add to the documentation about these new macros and how to use them? You can add a subsection in Developer Notes

TheAssembler1 · 2025-03-20T16:01:51Z

@TheAssembler1 can you also add to the documentation about these new macros and how to use them? You can add a subsection in Developer Notes

I didn't create the logging macros they were already there just no one was using them. Yes I will add documentation for them.

TheAssembler1 · 2025-03-22T13:21:47Z

@TheAssembler1 can you also add to the documentation about these new macros and how to use them? You can add a subsection in Developer Notes

Ok I added docs for each of the macros in the developer notes.

TheAssembler1 requested a review from a team as a code owner March 20, 2025 00:15

TheAssembler1 temporarily deployed to internal March 20, 2025 00:15 — with GitHub Actions Inactive

TheAssembler1 force-pushed the pdc_logging branch from 9a102b1 to b5f8832 Compare March 20, 2025 00:18

TheAssembler1 temporarily deployed to internal March 20, 2025 00:18 — with GitHub Actions Inactive

TheAssembler1 force-pushed the pdc_logging branch from b5f8832 to cf63b42 Compare March 20, 2025 00:23

TheAssembler1 temporarily deployed to internal March 20, 2025 00:23 — with GitHub Actions Inactive

TheAssembler1 force-pushed the pdc_logging branch from cf63b42 to 71ed74b Compare March 20, 2025 00:25

TheAssembler1 temporarily deployed to internal March 20, 2025 00:26 — with GitHub Actions Inactive

Changed all printf to use pdc logger

1e0534c

Also removed large blocks of comments and chanegd the pdc logger to print the file name, function, and line number.

TheAssembler1 force-pushed the pdc_logging branch from 71ed74b to 1e0534c Compare March 20, 2025 00:41

TheAssembler1 temporarily deployed to internal March 20, 2025 00:41 — with GitHub Actions Inactive

sbyna requested review from houjun and jeanbez March 20, 2025 00:42

sbyna reviewed Mar 20, 2025

View reviewed changes

Change typo of LOG_INFO to LOG_ERROR

01efd7f

TheAssembler1 temporarily deployed to internal March 20, 2025 00:56 — with GitHub Actions Inactive

sbyna reviewed Mar 20, 2025

View reviewed changes

Correct grammar from fail -> failed

36b39c0

TheAssembler1 temporarily deployed to internal March 20, 2025 01:00 — with GitHub Actions Inactive

update grammer succesfully close -> successfully closed

714308e

TheAssembler1 temporarily deployed to internal March 20, 2025 01:04 — with GitHub Actions Inactive

switch type of LOG_INFO to LOG_ERROR

923c0ec

TheAssembler1 temporarily deployed to internal March 20, 2025 01:15 — with GitHub Actions Inactive

houjun requested changes Mar 20, 2025

View reviewed changes

Add logging docs and fix some LOG_INFO->LOG_JUST_PRINT

4b661e9

TheAssembler1 deployed to internal March 22, 2025 13:21 — with GitHub Actions Active

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change printf to PDC logger #232

Change printf to PDC logger #232

TheAssembler1 commented Mar 20, 2025 •

edited

Loading

TheAssembler1 commented Mar 20, 2025

sbyna Mar 20, 2025

sbyna Mar 20, 2025

sbyna Mar 20, 2025

sbyna Mar 20, 2025

sbyna Mar 20, 2025

sbyna Mar 20, 2025

sbyna Mar 20, 2025

sbyna Mar 20, 2025

sbyna Mar 20, 2025

sbyna Mar 20, 2025

sbyna Mar 20, 2025

sbyna Mar 20, 2025

houjun left a comment

TheAssembler1 commented Mar 20, 2025

TheAssembler1 commented Mar 22, 2025

Change printf to PDC logger #232

Are you sure you want to change the base?

Change printf to PDC logger #232

Conversation

TheAssembler1 commented Mar 20, 2025 • edited Loading

TheAssembler1 commented Mar 20, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

houjun left a comment

Choose a reason for hiding this comment

TheAssembler1 commented Mar 20, 2025

TheAssembler1 commented Mar 22, 2025

TheAssembler1 commented Mar 20, 2025 •

edited

Loading