platform.h

Go to the documentation of this file.

/*
 *  Copyright 2019 Patrick Stotko
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
 
#ifndef STDGPU_PLATFORM_H
#define STDGPU_PLATFORM_H
 
#include <stdgpu/config.h>
 
/* clang-format off */
#define STDGPU_DETAIL_BACKEND_HEADER(header_file)                                                                      \
    <stdgpu/STDGPU_BACKEND_DIRECTORY/header_file> // NOLINT(bugprone-macro-parentheses,misc-macro-parentheses)
/* clang-format on */
 
#include STDGPU_DETAIL_BACKEND_HEADER(platform.h)
 
#include <stdgpu/compiler.h> // NOTE: For backwards compatibility only
#include <stdgpu/impl/preprocessor.h>
 
namespace stdgpu
{
 
#define STDGPU_BACKEND_CUDA 100
#define STDGPU_BACKEND_OPENMP 101
#define STDGPU_BACKEND_HIP 102
 
// Workaround: Provide a define only for the purpose of creating the documentation
#ifdef STDGPU_RUN_DOXYGEN
    #define STDGPU_BACKEND
#endif
// STDGPU_BACKEND is defined in stdgpu/config.h
 
#define STDGPU_HOST_DEVICE STDGPU_DETAIL_CAT3(STDGPU_, STDGPU_BACKEND_MACRO_NAMESPACE, _HOST_DEVICE)
 
#define STDGPU_DEVICE_ONLY STDGPU_DETAIL_CAT3(STDGPU_, STDGPU_BACKEND_MACRO_NAMESPACE, _DEVICE_ONLY)
 
#define STDGPU_CONSTANT STDGPU_DETAIL_CAT3(STDGPU_, STDGPU_BACKEND_MACRO_NAMESPACE, _CONSTANT)
 
#define STDGPU_CODE_HOST 1000
#define STDGPU_CODE_DEVICE 1001
 
namespace detail
{
 
#define STDGPU_DETAIL_IS_DEVICE_CODE STDGPU_DETAIL_CAT3(STDGPU_, STDGPU_BACKEND_MACRO_NAMESPACE, _IS_DEVICE_CODE)
 
} // namespace detail
 
#if STDGPU_DETAIL_IS_DEVICE_CODE
    #define STDGPU_CODE STDGPU_CODE_DEVICE
#else
    #define STDGPU_CODE STDGPU_CODE_HOST
#endif
 
namespace detail
{
 
#define STDGPU_DETAIL_IS_DEVICE_COMPILED                                                                               \
    STDGPU_DETAIL_CAT3(STDGPU_, STDGPU_BACKEND_MACRO_NAMESPACE, _IS_DEVICE_COMPILED)
 
} // namespace detail
 
} // namespace stdgpu
 
#endif // STDGPU_PLATFORM_H