Add trace interfaces

Author: jcmosc

Sources/OpenGraph_SPI/include/OGGraphTracing.h

@@ -7,13 +7,19 @@
 
 #include "OGBase.h"
 #include "OGGraph.h"
+#include "OGUniqueID.h"
 
 typedef OG_OPTIONS(uint32_t, OGGraphTraceFlags) {
-    OGGraphTraceFlags_0 = 0,
-    OGGraphTraceFlags_1 = 1 << 0,
-    OGGraphTraceFlags_2 = 1 << 1,
+    OGGraphTraceFlagsEnabled = 1 << 0,
+    OGGraphTraceFlagsFull = 1 << 1,
+    OGGraphTraceFlagsBacktrace = 1 << 2,
+    OGGraphTraceFlagsPrepare = 1 << 3,
+    OGGraphTraceFlagsCustom = 1 << 4,
+    OGGraphTraceFlagsAll = 1 << 5,
 } OG_SWIFT_NAME(OGGraphRef.TraceFlags);
 
+typedef struct OGTrace *OGTraceRef;
+
 OG_ASSUME_NONNULL_BEGIN
 
 OG_IMPLICIT_BRIDGING_ENABLED
@@ -22,16 +28,25 @@ OG_EXTERN_C_BEGIN
 
 OG_EXPORT
 OG_REFINED_FOR_SWIFT
-void OGGraphStartTracing(_Nullable OGGraphRef graph, OGGraphTraceFlags options) OG_SWIFT_NAME(OGGraphRef.startTracing(_:options:));
+void OGGraphStartTracing(_Nullable OGGraphRef graph, OGGraphTraceFlags flags) OG_SWIFT_NAME(OGGraphRef.startTracing(_:flags:));
 
 OG_EXPORT
 OG_REFINED_FOR_SWIFT
-void OGGraphStartTracing2(_Nullable OGGraphRef graph, OGGraphTraceFlags options, _Nullable CFArrayRef array);
+void OGGraphStartTracing2(_Nullable OGGraphRef graph, OGGraphTraceFlags flags, _Nullable CFArrayRef subsystems) OG_SWIFT_NAME(OGGraphRef.startTracing(_:flags:subsystems:));
 
 OG_EXPORT
 OG_REFINED_FOR_SWIFT
 void OGGraphStopTracing(_Nullable OGGraphRef graph) OG_SWIFT_NAME(OGGraphRef.stopTracing(_:));
 
+OG_EXPORT
+OG_REFINED_FOR_SWIFT
+OGUniqueID OGGraphAddTrace(OGGraphRef graph, const OGTraceRef trace, void *_Nullable context)
+OG_SWIFT_NAME(OGGraphRef.addTrace(self:_:context:));
+
+OG_EXPORT
+OG_REFINED_FOR_SWIFT
+void OGGraphRemoveTrace(OGGraphRef graph, OGUniqueID trace_id) OG_SWIFT_NAME(OGGraphRef.removeTrace(self:traceID:));
+
 OG_EXTERN_C_END
 
 OG_IMPLICIT_BRIDGING_DISABLED

Sources/OpenGraph_SPI/include/OGTrace.h

@@ -0,0 +1,83 @@
+//
+//  OGTrace.h
+//  OpenGraph_SPI
+
+#ifndef OGTrace_hpp
+#define OGTrace_hpp
+
+#include "OGBase.h"
+#include "OGGraph.h"
+
+OG_ASSUME_NONNULL_BEGIN
+
+typedef OG_ENUM(uint64_t, OGTraceEvents) {
+    OGTraceEventsCustom = 1,
+    OGTraceEventsNamed = 2,
+    OGTraceEventsDeadline = 3,
+    OGTraceEventsCompareFailed = 4,
+};
+
+typedef struct OGTrace {
+    OGTraceEvents events;
+
+    void (*_Nullable begin_trace)(void *_Nullable context, OGGraphRef graph);
+    void (*_Nullable end_trace)(void *_Nullable context, OGGraphRef graph);
+
+    void (*_Nullable begin_update_subgraph)(void *_Nullable context, OGSubgraphRef subgraph, uint32_t options);
+    void (*_Nullable end_update_subgraph)(void *_Nullable context, OGSubgraphRef subgraph);
+    void (*_Nullable begin_update_stack)(void *_Nullable context, OGAttribute attribute);
+    void (*_Nullable end_update_stack)(void *_Nullable context, bool changed);
+    void (*_Nullable begin_update_attribute)(void *_Nullable context, OGAttribute attribute);
+    void (*_Nullable end_update_attribute)(void *_Nullable context, OGAttribute attribute, bool changed);
+    void (*_Nullable begin_update_graph)(void *_Nullable context, OGGraphRef graph);
+    void (*_Nullable end_update_graph)(void *_Nullable context, OGGraphRef graph);
+
+    void (*_Nullable begin_invalidation)(void *_Nullable context, OGGraphRef graph, OGAttribute attribute);
+    void (*_Nullable end_invalidation)(void *_Nullable context, OGGraphRef graph, OGAttribute attribute);
+
+    void (*_Nullable begin_modify)(void *_Nullable context, OGAttribute attribute);
+    void (*_Nullable end_modify)(void *_Nullable context, OGAttribute attribute);
+
+    void (*_Nullable begin_event)(void *_Nullable context, OGAttribute attribute, const char *event_name);
+    void (*_Nullable end_event)(void *_Nullable context, OGAttribute attribute, const char *event_name);
+
+    void (*_Nullable created_graph)(void *_Nullable context, OGGraphRef graph);
+    void (*_Nullable destroy_graph)(void *_Nullable context, OGGraphRef graph);
+    void (*_Nullable needs_update)(void *_Nullable context, OGGraphRef graph);
+
+    void (*_Nullable created_subgraph)(void *_Nullable context, OGSubgraphRef subgraph);
+    void (*_Nullable invalidate_subgraph)(void *_Nullable context, OGSubgraphRef subgraph);
+    void (*_Nullable add_child_subgraph)(void *_Nullable context, OGSubgraphRef subgraph, OGSubgraphRef child);
+    void (*_Nullable remove_child_subgraph)(void *_Nullable context, OGSubgraphRef subgraph, OGSubgraphRef child);
+
+    void (*_Nullable added_attribute)(void *_Nullable context, OGAttribute attribute);
+    void (*_Nullable add_edge)(void *_Nullable context, OGAttribute attribute, OGAttribute input, unsigned int flags);
+    void (*_Nullable remove_edge)(void *_Nullable context, OGAttribute attribute, size_t index);
+    void (*_Nullable set_edge_pending)(void *_Nullable context, OGAttribute attribute, OGAttribute input, bool pending);
+
+    void (*_Nullable set_dirty)(void *_Nullable context, OGAttribute attribute, bool dirty);
+    void (*_Nullable set_pending)(void *_Nullable context, OGAttribute attribute, bool pending);
+    void (*_Nullable set_value)(void *_Nullable context, OGAttribute attribute);
+    void (*_Nullable mark_value)(void *_Nullable context, OGAttribute attribute);
+
+    void (*_Nullable added_indirect_attribute)(void *_Nullable context, OGAttribute attribute);
+    void (*_Nullable set_source)(void *_Nullable context, OGAttribute attribute, OGAttribute source);
+    void (*_Nullable set_dependency)(void *_Nullable context, OGAttribute attribute, OGAttribute dependency);
+
+    void (*_Nullable mark_profile)(void *_Nullable context, const char *event_name);
+
+    void (*_Nullable custom_event)(void *_Nullable context, OGGraphRef graph, const char *event_name, const void *value,
+                                   OGTypeID type);
+    void (*_Nullable named_event)(void *_Nullable context, OGGraphRef graph, uint32_t eventID, uint32_t eventArgCount,
+                                  const void *eventArgs, CFDataRef data, uint32_t arg6);
+    bool (*_Nullable named_event_enabled)(void *_Nullable context);
+
+    void (*_Nullable set_deadline)(void *_Nullable context);
+    void (*_Nullable passed_deadline)(void *_Nullable context);
+
+    void (*_Nullable compare_failed)(void *_Nullable context, OGAttribute attribute, OGComparisonState comparisonState);
+} OGTrace;
+
+OG_ASSUME_NONNULL_END
+
+#endif /* OGTrace_hpp */

Sources/OpenGraph_SPI/include/OpenGraph.h

@@ -16,6 +16,7 @@
 #include "OGInputOptions.h"
 #include "OGSearchOptions.h"
 #include "OGSubgraph.h"
+#include "OGTrace.h"
 #include "OGTupleType.h"
 #include "OGTypeID.h"
 #include "OGUniqueID.h"

Tests/OpenGraphCompatibilityTests/Graph/GraphTracingCompatibilityTests.swift

@@ -8,13 +8,13 @@ struct GraphTracingCompatibilityTests {
     @Test
     func tracing() {
         let graph = Graph()
-        Graph.startTracing(graph, options: [])
+        Graph.startTracing(graph, flags: [])
         Graph.stopTracing(graph)
     }
 
     @Test
     func tracingAll() {
-        Graph.startTracing(nil, options: [])
+        Graph.startTracing(nil, flags: [])
         Graph.stopTracing(nil)
     }