How to tell if hcl.assert_ fired programmatically?

Question

How to tell if hcl.assert_ fired programmatically?

jcasas00 opened this issue 3 years ago · 6 comments

hcl.assert_ terminates the LLVM execution when it fires. However, there doesn't seem to be any indication at the top-level that the hcl.assert_ fired. Can it raise an exception HCLAssert (for example) ?

Answer 1 · 2021-09-02T12:54:57.000Z

Hmmmm... I'll see if I can enable the return value of the top function. If the return value is non-zero then the program is wrong.

Answer 2 · 2021-09-02T14:59:15.000Z

@jcasas00 I proposed a solution in #414. Please see if this is similar to what you have in mind.

Answer 3 · 2021-09-02T16:55:44.000Z

Yes, this is pretty much what I was envisioning.

Answer 4 · 2021-09-04T21:00:14.000Z

Please check #414. Now it is merged.

Answer 5 · 2021-09-07T21:00:35.000Z

I tried #414 and it indeed raises an exception.
One thing though, while the assert error message is printed, the string associated with the caught exception seem to be always "[Assert] Assert Failed!!!" (which we already know by being in the except block). Is it possible to have the actual assertion message also be passed to the exception object?

For example:

    try:
        f(dram, addr)
    except hcl.debug.AssertError as e:
        print ("Got exception: " + str(e))

Output:

Invalid index=3                                                # this is printed by the hcl.assert_
Got exception: [Assert] Assert Failed!!             # could str(e) also be the same assert_ message string (instead of printing)?

Answer 6 · 2021-09-09T00:03:55.000Z

Right, ideally we want to return the error message. For now, it would take some extra work to implement that. I'll mark it as enhancement.