From b7c308a1ad32af4198dcc7eaa73f44fef27dc8fc Mon Sep 17 00:00:00 2001 From: Pablo Tello Date: Tue, 22 Jan 2019 12:59:26 +0000 Subject: COMPMID-1887: Fixed segfault in validation tests. Added the option to initialise the CLScheduler with an external cl::Context. This allows more control over the order of destruction of the static members which caused the suite to segfault. Change-Id: I0a90f12cc39daf1fd5ab842a5584986785694b35 Reviewed-on: https://review.mlplatform.org/550 Tested-by: Arm Jenkins Reviewed-by: Giuseppe Rossini --- arm_compute/runtime/CL/CLHelpers.h | 41 +++++++++++++ arm_compute/runtime/CL/CLScheduler.h | 25 ++++---- src/runtime/CL/CLHelpers.cpp | 105 ++++++++++++++++++++++++++++++++ src/runtime/CL/CLScheduler.cpp | 86 +++++++++++--------------- tests/benchmark_examples/RunExample.cpp | 17 ++++-- tests/main.cpp | 11 +++- 6 files changed, 212 insertions(+), 73 deletions(-) create mode 100644 arm_compute/runtime/CL/CLHelpers.h create mode 100644 src/runtime/CL/CLHelpers.cpp diff --git a/arm_compute/runtime/CL/CLHelpers.h b/arm_compute/runtime/CL/CLHelpers.h new file mode 100644 index 0000000000..f3b11f8b75 --- /dev/null +++ b/arm_compute/runtime/CL/CLHelpers.h @@ -0,0 +1,41 @@ +/* + * Copyright (c) 2019 ARM Limited. + * + * SPDX-License-Identifier: MIT + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef __ARM_COMPUTE_CL_HELPERS_H__ +#define __ARM_COMPUTE_CL_HELPERS_H__ + +#include "arm_compute/core/CL/OpenCL.h" + +namespace arm_compute +{ +/** This function creates an OpenCL context and a device. + * + * @note In debug builds, the function will automatically enable cl_arm_printf if the driver/device supports it. + * + * @return A std::tuple where the first element is the opencl context, the second element is the opencl device + * and the third one an error code. The error code will be CL_SUCCESS upon successful creation, otherwise + * a value telling why the function failed. + */ +std::tuple create_opencl_context_and_device(); +} // namespace arm_compute +#endif /* __ARM_COMPUTE_CL_HELPERS_H__ */ diff --git a/arm_compute/runtime/CL/CLScheduler.h b/arm_compute/runtime/CL/CLScheduler.h index 663f78a56c..53cb88ad5b 100644 --- a/arm_compute/runtime/CL/CLScheduler.h +++ b/arm_compute/runtime/CL/CLScheduler.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016-2018 ARM Limited. + * Copyright (c) 2016-2019 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -59,6 +59,14 @@ public: * @param[in] cl_tuner (Optional) Pointer to ICLTuner (default=nullptr) */ void default_init(ICLTuner *cl_tuner = nullptr); + /** Initialises the scheduler with context and device provided by the user + * + * @param[in] device OpenCL device to be used + * @param[in] ctx OpenCL ctx to be used + * @param[in] cl_tuner (Optional) Pointer to ICLTuner (default=nullptr) + */ + void default_init_with_context(cl::Device &device, cl::Context &ctx, ICLTuner *cl_tuner = nullptr); + /** Schedule the execution of the passed kernel if possible. * * @param[in] kernel Kernel to execute. @@ -74,14 +82,7 @@ public: * @param[in] cl_tuner (Optional) Pointer to OpenCL tuner (default=nullptr) * Note: It is caller's responsibility to release the allocated memory for CLTuner */ - void init(cl::Context context, cl::CommandQueue queue, cl::Device device, ICLTuner *cl_tuner = nullptr) - { - set_context(context); - _queue = std::move(queue); - _target = get_target_from_device(device); - _is_initialised = true; - _cl_tuner = cl_tuner; - } + void init(cl::Context context, cl::CommandQueue queue, const cl::Device &device, ICLTuner *cl_tuner = nullptr); /** Accessor for the associated CL context. * @@ -117,11 +118,7 @@ public: * * @param[in] context A CL context. */ - void set_context(cl::Context context) - { - _context = std::move(context); - CLKernelLibrary::get().set_context(_context); - } + void set_context(cl::Context context); /** Accessor to set the CL command queue to be used by the scheduler. * diff --git a/src/runtime/CL/CLHelpers.cpp b/src/runtime/CL/CLHelpers.cpp new file mode 100644 index 0000000000..449d7d5a6c --- /dev/null +++ b/src/runtime/CL/CLHelpers.cpp @@ -0,0 +1,105 @@ +/* + * Copyright (c) 2019 ARM Limited. + * + * SPDX-License-Identifier: MIT + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +#include "arm_compute/runtime/CL/CLHelpers.h" + +#include "arm_compute/core/CL/CLHelpers.h" +#include "arm_compute/core/Error.h" + +namespace +{ +#if defined(ARM_COMPUTE_ASSERTS_ENABLED) +void printf_callback(const char *buffer, unsigned int len, size_t complete, void *user_data) +{ + printf("%.*s", len, buffer); +} +#endif /* defined(ARM_COMPUTE_ASSERTS_ENABLED) */ + +/** This initialises the properties vector with the configuration to be used when creating the opencl context + * + * @param[in] platform The opencl platform used to create the context + * @param[in] device The opencl device to be used to create the context + * @param[in] prop An array of properties to be initialised + * + * @note In debug builds, this function will enable cl_arm_printf if it's supported. + * + * @return A pointer to the context properties which can be used to create an opencl context + */ + +void initialise_context_properties(const cl::Platform &platform, const cl::Device &device, cl_context_properties prop[7]) +{ + ARM_COMPUTE_UNUSED(device); +#if defined(ARM_COMPUTE_ASSERTS_ENABLED) + // Query devices in the context for cl_arm_printf support + if(arm_compute::device_supports_extension(device, "cl_arm_printf")) + { + // Create a cl_context with a printf_callback and user specified buffer size. + cl_context_properties properties_printf[] = + { + CL_CONTEXT_PLATFORM, reinterpret_cast(platform()), + // Enable a printf callback function for this context. + CL_PRINTF_CALLBACK_ARM, reinterpret_cast(printf_callback), + // Request a minimum printf buffer size of 4MB for devices in the + // context that support this extension. + CL_PRINTF_BUFFERSIZE_ARM, 0x1000, + 0 + }; + std::copy_n(prop, 7, properties_printf); + } + else +#endif // defined(ARM_COMPUTE_ASSERTS_ENABLED) + { + cl_context_properties properties[] = + { + CL_CONTEXT_PLATFORM, reinterpret_cast(platform()), + 0 + }; + std::copy_n(prop, 3, properties); + }; +} +} //namespace + +namespace arm_compute +{ +std::tuple +create_opencl_context_and_device() +{ + ARM_COMPUTE_ERROR_ON(!opencl_is_available()); + std::vector platforms; + cl::Platform::get(&platforms); + ARM_COMPUTE_ERROR_ON_MSG(platforms.size() == 0, "Couldn't find any OpenCL platform"); + cl::Platform p = platforms[0]; + cl::Device device; + std::vector platform_devices; + p.getDevices(CL_DEVICE_TYPE_DEFAULT, &platform_devices); + ARM_COMPUTE_ERROR_ON_MSG(platform_devices.size() == 0, "Couldn't find any OpenCL device"); + device = platform_devices[0]; + cl_int err = CL_SUCCESS; + cl_context_properties properties[7] = { 0, 0, 0, 0, 0, 0, 0 }; + initialise_context_properties(p, device, properties); + cl::Context cl_context = cl::Context(device, properties, nullptr, nullptr, &err); + ARM_COMPUTE_ERROR_ON_MSG(err != CL_SUCCESS, "Failed to create OpenCL context"); + return std::make_tuple(cl_context, device, err); +} +} // namespace arm_compute diff --git a/src/runtime/CL/CLScheduler.cpp b/src/runtime/CL/CLScheduler.cpp index a311c6fb41..701ffe0ab1 100644 --- a/src/runtime/CL/CLScheduler.cpp +++ b/src/runtime/CL/CLScheduler.cpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016-2018 ARM Limited. + * Copyright (c) 2016-2019 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -23,22 +23,14 @@ */ #include "arm_compute/runtime/CL/CLScheduler.h" +#include "arm_compute/runtime/CL/CLHelpers.h" + #include "arm_compute/core/CL/ICLKernel.h" #include "arm_compute/runtime/CL/CLTuner.h" #include "arm_compute/runtime/CL/tuners/Tuners.h" using namespace arm_compute; -namespace -{ -#if defined(ARM_COMPUTE_DEBUG_ENABLED) -void printf_callback(const char *buffer, unsigned int len, size_t complete, void *user_data) -{ - printf("%.*s", len, buffer); -} -#endif /* defined(ARM_COMPUTE_DEBUG_ENABLED) */ -} // namespace - std::once_flag CLScheduler::_initialize_symbols; CLScheduler::CLScheduler() @@ -53,53 +45,30 @@ CLScheduler &CLScheduler::get() return scheduler; } -void CLScheduler::default_init(ICLTuner *cl_tuner) +void CLScheduler::default_init_with_context(cl::Device &device, cl::Context &ctx, ICLTuner *cl_tuner) { if(!_is_initialised) { - std::vector platforms; - cl::Platform::get(&platforms); - ARM_COMPUTE_ERROR_ON_MSG(platforms.size() == 0, "Couldn't find any OpenCL platform"); - cl::Platform p = platforms[0]; - cl::Context ctx; - cl::Device device; - std::vector platform_devices; - p.getDevices(CL_DEVICE_TYPE_DEFAULT, &platform_devices); - ARM_COMPUTE_ERROR_ON_MSG(platform_devices.size() == 0, "Couldn't find any OpenCL device"); - device = platform_devices[0]; -#if defined(ARM_COMPUTE_DEBUG_ENABLED) - - // Query devices in the context for cl_arm_printf support - if(device_supports_extension(device, "cl_arm_printf")) - { - // Create a cl_context with a printf_callback and user specified buffer size. - cl_context_properties properties[] = - { - CL_CONTEXT_PLATFORM, reinterpret_cast(p()), - // Enable a printf callback function for this context. - CL_PRINTF_CALLBACK_ARM, reinterpret_cast(printf_callback), - // Request a minimum printf buffer size of 4MB for devices in the - // context that support this extension. - CL_PRINTF_BUFFERSIZE_ARM, 0x1000, - 0 - }; - ctx = cl::Context(device, properties); - } - else -#endif // defined(ARM_COMPUTE_DEBUG_ENABLED) - { - cl_context_properties properties[] = - { - CL_CONTEXT_PLATFORM, reinterpret_cast(p()), - 0 - }; - ctx = cl::Context(device, properties); - }; - cl::CommandQueue queue = cl::CommandQueue(ctx, device); CLKernelLibrary::get().init("./cl_kernels/", ctx, device); init(ctx, queue, device, cl_tuner); + _cl_default_static_tuner = tuners::TunerFactory::create_tuner(_target); + _cl_tuner = (cl_tuner == nullptr) ? _cl_default_static_tuner.get() : cl_tuner; + } +} +void CLScheduler::default_init(ICLTuner *cl_tuner) +{ + if(!_is_initialised) + { + cl::Context ctx; + cl::Device dev; + cl_int err; + std::tie(ctx, dev, err) = create_opencl_context_and_device(); + ARM_COMPUTE_ERROR_ON_MSG(err != CL_SUCCESS, "Failed to create OpenCL context"); + cl::CommandQueue queue = cl::CommandQueue(ctx, dev); + CLKernelLibrary::get().init("./cl_kernels/", ctx, dev); + init(ctx, queue, dev, cl_tuner); // Create a default static tuner and set if none was provided _cl_default_static_tuner = tuners::TunerFactory::create_tuner(_target); } @@ -108,6 +77,21 @@ void CLScheduler::default_init(ICLTuner *cl_tuner) _cl_tuner = (cl_tuner == nullptr) ? _cl_default_static_tuner.get() : cl_tuner; } +void CLScheduler::set_context(cl::Context context) +{ + _context = std::move(context); + CLKernelLibrary::get().set_context(_context); +} + +void CLScheduler::init(cl::Context context, cl::CommandQueue queue, const cl::Device &device, ICLTuner *cl_tuner) +{ + set_context(std::move(context)); + _queue = std::move(queue); + _target = get_target_from_device(device); + _is_initialised = true; + _cl_tuner = cl_tuner; +} + void CLScheduler::enqueue(ICLKernel &kernel, bool flush) { ARM_COMPUTE_ERROR_ON_MSG(!_is_initialised, diff --git a/tests/benchmark_examples/RunExample.cpp b/tests/benchmark_examples/RunExample.cpp index 9bc0e4380a..a7a8be01cc 100644 --- a/tests/benchmark_examples/RunExample.cpp +++ b/tests/benchmark_examples/RunExample.cpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018 ARM Limited. + * Copyright (c) 2018-2019 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -35,6 +35,7 @@ #include "utils/command_line/CommandLineParser.h" #ifdef ARM_COMPUTE_CL +#include "arm_compute/runtime/CL/CLHelpers.h" #include "arm_compute/runtime/CL/CLScheduler.h" #endif /* ARM_COMPUTE_CL */ #ifdef ARM_COMPUTE_GC @@ -126,6 +127,16 @@ int run_example(int argc, char **argv, std::unique_ptr example) } } +#ifdef ARM_COMPUTE_CL + if(opencl_is_available()) + { + auto ctx_dev_err = create_opencl_context_and_device(); + ARM_COMPUTE_ERROR_ON_MSG(std::get<2>(ctx_dev_err) != CL_SUCCESS, "Failed to create OpenCL context"); + CLScheduler::get() + .default_init_with_context(std::get<1>(ctx_dev_err), std::get<0>(ctx_dev_err)); + } +#endif /* ARM_COMPUTE_CL */ + if(options.log_level->value() >= framework::LogLevel::CONFIG) { for(auto &p : printers) @@ -135,10 +146,6 @@ int run_example(int argc, char **argv, std::unique_ptr example) #ifdef ARM_COMPUTE_CL if(opencl_is_available()) { - if(!CLScheduler::get().is_initialised()) - { - CLScheduler::get().default_init(); - } p->print_entry("CL_DEVICE_VERSION", CLKernelLibrary::get().get_device_version()); } else diff --git a/tests/main.cpp b/tests/main.cpp index 617faaf5a9..b02c9f87e5 100644 --- a/tests/main.cpp +++ b/tests/main.cpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017-2018 ARM Limited. + * Copyright (c) 2017-2019 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -35,8 +35,11 @@ #include "utils/command_line/CommandLineParser.h" #ifdef ARM_COMPUTE_CL +#include "arm_compute/core/CL/OpenCL.h" +#include "arm_compute/runtime/CL/CLHelpers.h" #include "arm_compute/runtime/CL/CLScheduler.h" #include "arm_compute/runtime/CL/CLTuner.h" + #endif /* ARM_COMPUTE_CL */ #ifdef ARM_COMPUTE_GC #include "arm_compute/runtime/GLES_COMPUTE/GCScheduler.h" @@ -90,7 +93,10 @@ int main(int argc, char **argv) CLTuner cl_tuner(false); if(opencl_is_available()) { - CLScheduler::get().default_init(&cl_tuner); + auto ctx_dev_err = create_opencl_context_and_device(); + ARM_COMPUTE_ERROR_ON_MSG(std::get<2>(ctx_dev_err) != CL_SUCCESS, "Failed to create OpenCL context"); + CLScheduler::get() + .default_init_with_context(std::get<1>(ctx_dev_err), std::get<0>(ctx_dev_err), &cl_tuner); } #endif /* ARM_COMPUTE_CL */ @@ -287,6 +293,5 @@ int main(int argc, char **argv) return 1; } - return 0; } -- cgit v1.2.1