ifndef vanishes from includes

[flaviens]

Hi there!

When Morty pickles a header file such as

`ifndef BP_COMMON_CACHE_ENGINE_SVH
`define BP_COMMON_CACHE_ENGINE_SVH

typedef logic newtype_t;

`endif

then it becomes

`define BP_COMMON_CACHE_ENGINE_SVH

typedef logic newtype_t;

and this may cause tools to crash if the header is included multiple times.
I created an example here.

What workarounds would you suggest? Or is there anything that can be done in Morty to fix that problem?

I'm quite surprised to not have stumbled into this problem before so maybe I'm doing something wrong here.
Maybe doing such a typedef in a svh is also not legal, but can be found in the wild such as here.

Thanks!
Flavien

[micprog]

This is because morty parses files individually, doing macro resolution of each, not taking into account the previously parsed files and the defines contained within. I attempted to make use of some of the parser's features to collect all the defines from the parsed files, but I haven't properly tested or investigated any further issues. You can give the following branch a shot if you like: https://github.com/pulp-platform/morty/tree/collect_defines
Let me know if this works, or if you encounter any issues with this change.

[flaviens]

Again, that was fast 😍 ! That should fix it, however it's difficult to estimate whether it would break backward compatibility.
You're the best placed to decide!
Thanks!

[micprog]

I will likely modify this feature to be enabled/disabled with a flag before merging to ensure compatibility isn't broken.

[jiahanxie353]

Hi @micprog ,
I'm also having some issues with ifdef being removed by Morty. I'm wondering if that enabled/disabled flag is supported by main now?
What can I do with the available API functions in morty crate to just simply keep all ifdef VERILATOR blocks? I can see the keep_defines, propagate_defines, etc. fields in the do_pickle function, but I'm not very familiar with their usage.
Could you help me with this? Thanks!