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.

Sign up for GitHub

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

chore add test graph constructor #16

Merged
merged 2 commits into from
Apr 4, 2024
Merged

chore add test graph constructor #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7473628
chore: Add test constructor for WMD graphs
patrickkenney9801 Mar 30, 2024
73d2c36
chore: Remove instrumentation legacy code
patrickkenney9801 Apr 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,10 +208,6 @@ if(GALOIS_ENABLE_PAPI)
add_definitions(-DGALOIS_ENABLE_PAPI)
endif()

if (GALOIS_ENABLE_INSTRUMENT)
add_definitions(-DGALOIS_INSTRUMENT)
endif()

find_package(Threads REQUIRED)

include(CheckMmap)
Expand Down
39 changes: 0 additions & 39 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,45 +12,6 @@ Users can run `make docker-image` to setup all dependecies needed for
`pando-galois`. After creating the image it can be run via `make docker`.
And for first time cmake users can run `make run-cmake`.

# Instrumentation

This section pertains to enabling and instrumenting memory accesses for
performance projections on the theoretical PANDO hardware.

In order for the instrumentation code in `libwmd/include/galois/wmd/instrument.h`,
the following should be added to your top level source directory:

```cmake
set(GALOIS_ENABLE_INSTRUMENT ON)
if (GALOIS_ENABLE_INSTRUMENT)
add_definitions(-DGALOIS_INSTRUMENT)
endif()
```

Here is a description of the control-flow macros used by the instrumentation
and when they should be used.

```cpp
// Should be called once at the start of the program to initialize the instrumentation
// For example specifying `GRAPH_NAME=example-graph` will result in instrumentation
// files starting with `example-graph`
I_INIT(GRAPH_NAME, HOST, NUM_HOSTS, NUM_EDGES)
// Should be called once at the end of the program to cleanup the instrumentation
I_DEINIT()
// Should be called after the first kernel measured if multiple kernels are being measured
// For example if you specified `GRAPH_NAME=example-graph` above then specifying here that
// `NAME_SUFFIX=-kernel2` will result in instrumentation files starting `example-graph-kernel2`
I_NEW_FILE(NAME_SUFFIX, NUM_EDGES)
// I_ROUND should be called at the end of a communication round to log all memory accesses
// and communication recorded into instrumentation files
// I_CLEAR should be called after I_ROUND
I_ROUND(ROUND_NUM)
I_CLEAR()
// Should be called when sending custom communication to a remote host, recommended practice
// is to just pass in the size of the SendBuffer you are using
I_LC(REMOTE_HOST, BYTES)
```

## Tools

### [asdf](https://asdf-vm.com)
Expand Down
Loading