[XPTIFW] Minor doc changes + include reordering

Signed-off-by: Vasanth Tovinkere <[email protected]>

Author: tovinkere

xptifw/basic_test/performance_tests.cpp

@@ -10,10 +10,6 @@
 // scenarios and computing the average costs and maximum Events/sec that can
 // be serviced by the framework at a given max. overhead constraint.
 //---------------------------------------------------------------------------
-#include <atomic>
-#include <chrono>
-#include <random>
-
 #include "tbb/concurrent_vector.h"
 #include "tbb/parallel_for.h"
 #include "tbb/spin_mutex.h"
@@ -23,6 +19,10 @@
 #include "cl_processor.hpp"
 #include "xpti_trace_framework.h"
 
+#include <atomic>
+#include <chrono>
+#include <random>
+
 namespace test {
 void registerCallbacks(uint8_t sid);
 namespace performance {

xptifw/basic_test/semantic_tests.cpp

@@ -9,10 +9,6 @@
 // Tests the correctness of the API by comparing it agains the spec and
 // expected results.
 //--------------------------------------------------------------------------
-#include <atomic>
-#include <chrono>
-#include <random>
-
 #include "tbb/concurrent_vector.h"
 #include "tbb/parallel_for.h"
 #include "tbb/spin_mutex.h"
@@ -22,6 +18,10 @@
 #include "cl_processor.hpp"
 #include "xpti_trace_framework.h"
 
+#include <atomic>
+#include <chrono>
+#include <random>
+
 static void tpCallback(uint16_t trace_type, xpti::trace_event_data_t *parent,
                        xpti::trace_event_data_t *event, uint64_t instance,
                        const void *ud) {}

xptifw/doc/XPTI_Framework.md

@@ -281,6 +281,10 @@ below.
    the performance of the framework in detail in the sections [Performance of the Framework](#performance-of-the-framework) and  [Modeling and projection](#modeling-and-projection). For details on the command line arguments,
    please refer to these sections.
 
+   > **NOTE:** These tests rely on the availability of TBB for creating the
+   multi-threaded tests and will not be created if TBB has not been enabled
+   during the build process.
+
    ```bash
    % <xptifw-dir>/lib/Release/run_test --trace-points 1000 --type performance --overhead 1.5 --num-threads 0,1,2,3 --test-id 1,2 --tp-frequency 50
    ```

xptifw/samples/basic_collector/basic_collector.cpp

@@ -5,6 +5,9 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //
+#include "xpti_timers.hpp"
+#include "xpti_trace_framework.h"
+
 #include <chrono>
 #include <iostream>
 #include <map>
@@ -14,9 +17,6 @@
 #include <thread>
 #include <unordered_map>
 
-#include "xpti_timers.hpp"
-#include "xpti_trace_framework.h"
-
 static uint8_t GStreamID = 0;
 std::mutex GIOMutex;
 xpti::ThreadID GThreadIDEnum;

xptifw/unit_test/xpti_api_tests.cpp

@@ -5,11 +5,10 @@
 //
 #include "xpti_trace_framework.hpp"
 
+#include <gtest/gtest.h>
 #include <iostream>
 #include <set>
 
-#include <gtest/gtest.h>
-
 TEST(xptiApiTest, xptiInitializeBadInput) {
   auto Result = xptiInitialize(nullptr, 0, 0, nullptr);
   EXPECT_EQ(Result, xpti::result_t::XPTI_RESULT_INVALIDARG);

xptifw/unit_test/xpti_correctness_tests.cpp

@@ -6,11 +6,10 @@
 #include "xpti_trace_framework.h"
 #include "xpti_trace_framework.hpp"
 
+#include <gtest/gtest.h>
 #include <iostream>
 #include <set>
 
-#include <gtest/gtest.h>
-
 XPTI_CALLBACK_API void tpCallback(uint16_t trace_type,
                                   xpti::trace_event_data_t *parent,
                                   xpti::trace_event_data_t *event,