Skip to content

Annotate errors using GitHub Actions markup in ocamltest#6

Open
MisterDA wants to merge 1 commit intotrunkfrom
ocamltest-github-actions-reporting
Open

Annotate errors using GitHub Actions markup in ocamltest#6
MisterDA wants to merge 1 commit intotrunkfrom
ocamltest-github-actions-reporting

Conversation

@MisterDA
Copy link
Owner

No description provided.

@MisterDA MisterDA force-pushed the ocamltest-github-actions-reporting branch 5 times, most recently from 3505968 to 314876f Compare August 24, 2023 14:15
@MisterDA MisterDA force-pushed the ocamltest-github-actions-reporting branch from 314876f to 7b963d7 Compare October 17, 2023 16:35
@MisterDA MisterDA force-pushed the ocamltest-github-actions-reporting branch from 7b963d7 to 421d5b7 Compare May 17, 2024 12:45
MisterDA pushed a commit that referenced this pull request Jul 25, 2024
…l#13294)

The toplevel printer detects cycles by keeping a hashtable of values
that it has already traversed.

However, some OCaml runtime types (at least bigarrays) may be
partially uninitialized, and hashing them at arbitrary program points
may read uninitialized memory. In particular, the OCaml testsuite
fails when running with a memory-sanitizer enabled, as bigarray
printing results in reads to uninitialized memory:

```
==133712==WARNING: MemorySanitizer: use-of-uninitialized-value
    #0 0x4e6d11 in caml_ba_hash /var/home/edwin/git/ocaml/runtime/bigarray.c:486:45
    #1 0x52474a in caml_hash /var/home/edwin/git/ocaml/runtime/hash.c:251:35
    #2 0x599ebf in caml_interprete /var/home/edwin/git/ocaml/runtime/interp.c:1065:14
    #3 0x5a909a in caml_main /var/home/edwin/git/ocaml/runtime/startup_byt.c:575:9
    #4 0x540ccb in main /var/home/edwin/git/ocaml/runtime/main.c:37:3
    #5 0x7f0910abb087 in __libc_start_call_main (/lib64/libc.so.6+0x2a087) (BuildId: 8f53abaad945a669f2bdcd25f471d80e077568ef)
    #6 0x7f0910abb14a in __libc_start_main@GLIBC_2.2.5 (/lib64/libc.so.6+0x2a14a) (BuildId: 8f53abaad945a669f2bdcd25f471d80e077568ef)
    #7 0x441804 in _start (/var/home/edwin/git/ocaml/runtime/ocamlrun+0x441804) (BuildId: 7a60eef57e1c2baf770bc38d10d6c227e60ead37)

  Uninitialized value was created by a heap allocation
    #0 0x47d306 in malloc (/var/home/edwin/git/ocaml/runtime/ocamlrun+0x47d306) (BuildId: 7a60eef57e1c2baf770bc38d10d6c227e60ead37)
    #1 0x4e7960 in caml_ba_alloc /var/home/edwin/git/ocaml/runtime/bigarray.c:246:12
    #2 0x4e801f in caml_ba_create /var/home/edwin/git/ocaml/runtime/bigarray.c:673:10
    #3 0x59b8fc in caml_interprete /var/home/edwin/git/ocaml/runtime/interp.c:1058:14
    #4 0x5a909a in caml_main /var/home/edwin/git/ocaml/runtime/startup_byt.c:575:9
    #5 0x540ccb in main /var/home/edwin/git/ocaml/runtime/main.c:37:3
    #6 0x7f0910abb087 in __libc_start_call_main (/lib64/libc.so.6+0x2a087) (BuildId: 8f53abaad945a669f2bdcd25f471d80e077568ef)
    #7 0x7f0910abb14a in __libc_start_main@GLIBC_2.2.5 (/lib64/libc.so.6+0x2a14a) (BuildId: 8f53abaad945a669f2bdcd25f471d80e077568ef)
    #8 0x441804 in _start (/var/home/edwin/git/ocaml/runtime/ocamlrun+0x441804) (BuildId: 7a60eef57e1c2baf770bc38d10d6c227e60ead37)

SUMMARY: MemorySanitizer: use-of-uninitialized-value /var/home/edwin/git/ocaml/runtime/bigarray.c:486:45 in caml_ba_hash
```

The only use of hashing in genprintval is to avoid cycles, that is, it
is only useful for OCaml values that contain other OCaml values
(including possibly themselves). Bigarrays cannot introduce cycles,
and they are always printed as "<abstr>" anyway.

The present commit proposes to be more conservative in which values
are hashed by the cycle detector to avoid this issue: we skip hashing
any value with tag above No_scan_tag -- which may not contain any
OCaml values.

Suggested-by: Gabriel Scherer <gabriel.scherer@gmail.com>

Signed-off-by: Edwin Török <edwin.torok@cloud.com>
Co-authored-by: Edwin Török <edwin.torok@cloud.com>
It can be a bit tedious to locate a failing test in the whole
testsuite, scrolling endlessly in the GitHub Actions interface. It's
possible, using a simple markup language documented at [1], to tell
GitHub to highlight a location in the logs. Detecting the CI is
achieved using two environment variables, `CI`, and
`GITHUB_ACTIONS`. Making full use of the markup language (i.e.,
linking to the source file where the test fails, showing advanced
messages in the GHA UI) is currenlty not possible because these
information are not extracted from the test run.

[1]: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions
@MisterDA MisterDA force-pushed the ocamltest-github-actions-reporting branch from 421d5b7 to dc816dc Compare August 20, 2024 13:15
@MisterDA MisterDA changed the title Ocamltest GitHub actions reporting Annotate errors using GitHub Actions markup in ocamltest Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant