Skip to content

Commit

Permalink
Updates flags definition + path type
Browse files Browse the repository at this point in the history
  • Loading branch information
mfrancepillois committed Oct 30, 2023
1 parent a7c5d94 commit 3618713
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions sycl/doc/extensions/experimental/sycl_ext_oneapi_graph.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,8 @@ effects of prior uses as a sub-graph.
namespace sycl {
namespace ext::oneapi::experimental {
using graph_bitfield = uint64;
// State of a queue, returned by queue::ext_oneapi_get_state()
enum class queue_state {
executing,
Expand All @@ -313,14 +315,12 @@ enum class graph_support_level {
emulated
};
enum class graph_debug_print_flag {
none = 0x00,
kernel_args = 0x01, // adds the printing of the kernel args
// where applicable
memory_access_desc = 0x02 // adds the printing of information related to
// the memory access: source address,
// destination address, length, etc.
};
using graph_debug_print_flags = graph_bitfield;
// Adds the printing of the kernel args where applicable
constexpr graph_debug_print_flags GRAPH_DEBUG_PRINT_KERNEL_ARGS = (1 << 0);
// adds the printing of information related to the memory access:
// source address, destination address, length, etc.
constexpr graph_debug_print_flags GRAPH_DEBUG_PRINT_MEMORY_ACCESS_DESC = (1 << 2);
namespace property {
Expand Down Expand Up @@ -391,6 +391,8 @@ public:
node add(T cgf, const property_list& propList = {});
void make_edge(node& src, node& dest);
void print_dot_graph(std::string path, graph_debug_print_flags flags) const;
};
template<>
Expand Down Expand Up @@ -740,21 +742,21 @@ Returns: A new executable graph object which can be submitted to a queue.
[source,c++]
----
void
print_dot_graph(const char* path, debug_print_flags flags) const;
print_dot_graph(std::string path, graph_debug_print_flags flags) const;
----

|Synchronous operation that write to path a DOT formatted description of the
graph. By default this includes the graph topology, node types, node id,
and kernel names.
Flags can be specified to write more detailed information about each node type
such as kernel arguments, copy source and destination addresses.
Please report to `debug_print_flags` to have more information of extra debug
Please report to `graph_debug_print_flags` to have more information of extra debug
info.

Parameters:

* `path` - The path to write the DOT file to.
* `flags` - Flags from `debug_print_flags` for specifying which additional
* `flags` - Flags from `graph_debug_print_flags` for specifying which additional
node information to write.

Exceptions:
Expand Down

0 comments on commit 3618713

Please sign in to comment.