Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cxxrtl: reorganize runtime component files #4047

Merged
merged 1 commit into from
Nov 28, 2023

Conversation

whitequark
Copy link
Member

@whitequark whitequark commented Nov 28, 2023

In preparation for substantial expansion of CXXRTL's runtime, this PR reorganizes the files used by the implementation. Only minimal changes are required in a consumer.

First, change:

-I$(yosys-config --datdir)/include

to:

-I$(yosys-config --datdir)/include/backends/cxxrtl/runtime

Second, change:

#include <backends/cxxrtl/cxxrtl.h>

to:

#include <cxxrtl/cxxrtl.h>

(and do the same for cxxrtl_vcd.h, etc.)

This PR also adds a short README in the runtime directory, explaining API and ABI stability commitments.

In preparation for substantial expansion of CXXRTL's runtime, this commit
reorganizes the files used by the implementation. Only minimal changes are
required in a consumer.

First, change:
  -I$(yosys-config --datdir)/include
to:
  -I$(yosys-config --datdir)/include/backends/cxxrtl/runtime

Second, change:
  #include <backends/cxxrtl/cxxrtl.h>
to:
  #include <cxxrtl/cxxrtl.h>
(and do the same for cxxrtl_vcd.h, etc.)
Copy link
Member

@povik povik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@whitequark whitequark merged commit 62bbd08 into YosysHQ:master Nov 28, 2023
15 checks passed
@whitequark whitequark deleted the cxxrtl-renames branch November 28, 2023 15:32
@whitequark
Copy link
Member Author

FYI: the components I'm planning to add soon-ish are (in no particular order): reactor (for easier integration of external code, ex. Amaranth); record/replay (for bidirectional stepping and trace compression); agent (for connecting an IDE).

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.

2 participants