[SYCL] Remove <iostream> from header and source files (#6469)

raaiq1 · web-flow · commit b5705a3454ad · 2022-07-29T16:59:26.000-07:00
-Removed <iostream> headers from header and source files to best conform to LLVM Coding Standards : https://llvm.org/docs/CodingStandards.html#include-iostream-is-forbidden . -Substituted the removed headers with a proxy header which uses external linkage to resolve symbols in <iostream>
diff --git a/sycl/include/sycl/backend_types.hpp b/sycl/include/sycl/backend_types.hpp
@@ -9,9 +9,9 @@
 #pragma once
 
 #include <sycl/detail/defines.hpp>
+#include <sycl/detail/iostream_proxy.hpp>
 
 #include <fstream>
-#include <iostream>
 #include <istream>
 #include <string>
 
diff --git a/sycl/include/sycl/detail/common.hpp b/sycl/include/sycl/detail/common.hpp
@@ -116,7 +116,7 @@ static inline std::string codeToString(pi_int32 code) {
                           "Native API returns: "
 
 #ifndef __SYCL_SUPPRESS_PI_ERROR_REPORT
-#include <iostream>
+#include <sycl/detail/iostream_proxy.hpp>
 // TODO: rename all names with direct use of OCL/OPENCL to be backend agnostic.
 #define __SYCL_REPORT_PI_ERR_TO_STREAM(expr)                                   \
   {                                                                            \
diff --git a/sycl/include/sycl/detail/device_filter.hpp b/sycl/include/sycl/detail/device_filter.hpp
@@ -10,9 +10,9 @@
 
 #include <sycl/backend_types.hpp>
 #include <sycl/detail/defines.hpp>
+#include <sycl/detail/iostream_proxy.hpp>
 #include <sycl/info/info_desc.hpp>
 
-#include <iostream>
 #include <string>
 
 __SYCL_INLINE_NAMESPACE(cl) {
diff --git a/sycl/include/sycl/detail/image_accessor_util.hpp b/sycl/include/sycl/detail/image_accessor_util.hpp
@@ -15,12 +15,12 @@
 #include <sycl/builtins.hpp>
 #include <sycl/detail/export.hpp>
 #include <sycl/detail/generic_type_traits.hpp>
+#include <sycl/detail/iostream_proxy.hpp>
 #include <sycl/image.hpp>
 #include <sycl/sampler.hpp>
 #include <sycl/types.hpp>
 
 #include <cmath>
-#include <iostream>
 
 __SYCL_INLINE_NAMESPACE(cl) {
 namespace sycl {
diff --git a/sycl/include/sycl/detail/iostream_proxy.hpp b/sycl/include/sycl/detail/iostream_proxy.hpp
@@ -0,0 +1,10 @@
+#pragma once
+#include <istream>
+#include <ostream>
+
+namespace std {
+extern istream cin;  /// Linked to standard input
+extern ostream cout; /// Linked to standard output
+extern ostream cerr; /// Linked to standard error (unbuffered)
+extern ostream clog; /// Linked to standard error (buffered)
+} // namespace std
diff --git a/sycl/include/sycl/ext/intel/esimd/simd.hpp b/sycl/include/sycl/ext/intel/esimd/simd.hpp
@@ -22,7 +22,7 @@
 #include <sycl/ext/oneapi/experimental/invoke_simd.hpp>
 
 #ifndef __SYCL_DEVICE_ONLY__
-#include <iostream>
+#include <sycl/detail/iostream_proxy.hpp>
 #endif // __SYCL_DEVICE_ONLY__
 
 __SYCL_INLINE_NAMESPACE(cl) {
diff --git a/sycl/include/sycl/half_type.hpp b/sycl/include/sycl/half_type.hpp
@@ -10,10 +10,10 @@
 
 #include <sycl/detail/defines.hpp>
 #include <sycl/detail/export.hpp>
+#include <sycl/detail/iostream_proxy.hpp>
 #include <sycl/detail/type_traits.hpp>
 
 #include <functional>
-#include <iostream>
 #include <limits>
 
 #if !__has_builtin(__builtin_expect)
diff --git a/sycl/plugins/esimd_emulator/pi_esimd_emulator.cpp b/sycl/plugins/esimd_emulator/pi_esimd_emulator.cpp
@@ -35,6 +35,7 @@
 #include <cstdio>
 #include <cstring>
 #include <functional>
+#include <iostream>
 #include <map>
 #include <memory>
 #include <string>
diff --git a/sycl/plugins/esimd_emulator/pi_esimd_emulator.hpp b/sycl/plugins/esimd_emulator/pi_esimd_emulator.hpp
@@ -14,11 +14,12 @@
 
 #pragma once
 
+#include <sycl/detail/iostream_proxy.hpp>
+#include <sycl/detail/pi.h>
+
 #include <atomic>
 #include <cassert>
-#include <iostream>
 #include <mutex>
-#include <sycl/detail/pi.h>
 #include <unordered_map>
 
 #include <malloc.h>
diff --git a/sycl/plugins/level_zero/pi_level_zero.hpp b/sycl/plugins/level_zero/pi_level_zero.hpp
@@ -29,7 +29,6 @@
 #include <cassert>
 #include <cstring>
 #include <functional>
-#include <iostream>
 #include <list>
 #include <map>
 #include <memory>
@@ -43,6 +42,7 @@
 
 #include <level_zero/ze_api.h>
 #include <level_zero/zes_api.h>
+#include <sycl/detail/iostream_proxy.hpp>
 
 #include "usm_allocator.hpp"
 
diff --git a/sycl/plugins/level_zero/tracing.cpp b/sycl/plugins/level_zero/tracing.cpp
@@ -12,7 +12,7 @@
 #include <level_zero/ze_api.h>
 #include <xpti/xpti_trace_framework.h>
 
-#include <iostream>
+#include <sycl/detail/iostream_proxy.hpp>
 
 constexpr auto ZE_CALL_STREAM_NAME = "sycl.experimental.level_zero.call";
 constexpr auto ZE_DEBUG_STREAM_NAME = "sycl.experimental.level_zero.debug";
diff --git a/sycl/plugins/level_zero/usm_allocator.cpp b/sycl/plugins/level_zero/usm_allocator.cpp
@@ -12,7 +12,6 @@
 #include <cassert>
 #include <cctype>
 #include <iomanip>
-#include <iostream>
 #include <list>
 #include <memory>
 #include <mutex>
@@ -23,7 +22,7 @@
 #include <vector>
 
 #include "usm_allocator.hpp"
-#include <iostream>
+#include <sycl/detail/iostream_proxy.hpp>
 #include <sycl/detail/spinlock.hpp>
 
 // USM allocations are a minimum of 4KB/64KB/2MB even when a smaller size is
diff --git a/sycl/plugins/opencl/pi_opencl.cpp b/sycl/plugins/opencl/pi_opencl.cpp
@@ -18,12 +18,12 @@
 
 #include <pi_opencl.hpp>
 #include <sycl/detail/cl.h>
+#include <sycl/detail/iostream_proxy.hpp>
 #include <sycl/detail/pi.h>
 
 #include <algorithm>
 #include <cassert>
 #include <cstring>
-#include <iostream>
 #include <limits>
 #include <map>
 #include <sstream>
diff --git a/sycl/source/detail/config.cpp b/sycl/source/detail/config.cpp
@@ -9,11 +9,11 @@
 #include <detail/config.hpp>
 #include <sycl/detail/common.hpp>
 #include <sycl/detail/defines_elementary.hpp>
+#include <sycl/detail/iostream_proxy.hpp>
 #include <sycl/detail/os_util.hpp>
 
 #include <cstring>
 #include <fstream>
-#include <iostream>
 #include <limits>
 
 __SYCL_INLINE_NAMESPACE(cl) {
diff --git a/sycl/source/detail/spec_constant_impl.cpp b/sycl/source/detail/spec_constant_impl.cpp
@@ -9,12 +9,12 @@
 #include <detail/spec_constant_impl.hpp>
 
 #include <sycl/detail/defines.hpp>
+#include <sycl/detail/iostream_proxy.hpp>
 #include <sycl/detail/pi.h>
 #include <sycl/detail/util.hpp>
 #include <sycl/exception.hpp>
 
 #include <cstring>
-#include <iostream>
 
 __SYCL_INLINE_NAMESPACE(cl) {
 namespace sycl {
diff --git a/sycl/source/detail/spec_constant_impl.hpp b/sycl/source/detail/spec_constant_impl.hpp
@@ -9,10 +9,10 @@
 #pragma once
 
 #include <sycl/detail/defines.hpp>
+#include <sycl/detail/iostream_proxy.hpp>
 #include <sycl/detail/util.hpp>
 #include <sycl/stl.hpp>
 
-#include <iostream>
 #include <map>
 #include <vector>
 
diff --git a/sycl/test/basic_tests/iostream_clean_compile_1.cpp b/sycl/test/basic_tests/iostream_clean_compile_1.cpp
@@ -0,0 +1,5 @@
+// RUN: %clangxx -Wno-unused-command-line-argument -Werror -fsycl %s -c
+
+#include <iostream>
+#include <sycl/sycl.hpp>
+void foo() { std::cout << 42; }
diff --git a/sycl/test/basic_tests/iostream_clean_compile_2.cpp b/sycl/test/basic_tests/iostream_clean_compile_2.cpp
@@ -0,0 +1,7 @@
+// RUN: %clangxx -Wno-unused-command-line-argument -Werror -fsycl %s -c
+
+// clang-format off
+#include <sycl/sycl.hpp>
+#include <iostream>
+// clang-format on
+void foo() { std::cout << 42; }
diff --git a/sycl/test/basic_tests/no_iostream.cpp b/sycl/test/basic_tests/no_iostream.cpp
@@ -0,0 +1,6 @@
+// RUN: %clangxx -fsycl %s -S -emit-llvm -o- | FileCheck %s
+// CHECK-NOT: {{^@}}
+//
+// Tests if <sycl/sycl.hpp> headers include any <iostream> headers
+
+#include <sycl/sycl.hpp>
