1330d8983SJohannes Doerfert //===--- Configuration.h - OpenMP device configuration interface -- C++ -*-===// 2330d8983SJohannes Doerfert // 3330d8983SJohannes Doerfert // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4330d8983SJohannes Doerfert // See https://llvm.org/LICENSE.txt for license information. 5330d8983SJohannes Doerfert // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6330d8983SJohannes Doerfert // 7330d8983SJohannes Doerfert //===----------------------------------------------------------------------===// 8330d8983SJohannes Doerfert // 9330d8983SJohannes Doerfert // API to query the global (constant) device environment. 10330d8983SJohannes Doerfert // 11330d8983SJohannes Doerfert //===----------------------------------------------------------------------===// 12330d8983SJohannes Doerfert 13330d8983SJohannes Doerfert #ifndef OMPTARGET_CONFIGURATION_H 14330d8983SJohannes Doerfert #define OMPTARGET_CONFIGURATION_H 15330d8983SJohannes Doerfert 16330d8983SJohannes Doerfert #include "Shared/Environment.h" 17330d8983SJohannes Doerfert 18*08533a3eSJohannes Doerfert #include "DeviceTypes.h" 19330d8983SJohannes Doerfert 20330d8983SJohannes Doerfert namespace ompx { 21330d8983SJohannes Doerfert namespace config { 22330d8983SJohannes Doerfert 23330d8983SJohannes Doerfert /// Return the number of devices in the system, same number as returned on the 24330d8983SJohannes Doerfert /// host by omp_get_num_devices. 25330d8983SJohannes Doerfert uint32_t getNumDevices(); 26330d8983SJohannes Doerfert 27330d8983SJohannes Doerfert /// Return the device number in the system for omp_get_device_num. 28330d8983SJohannes Doerfert uint32_t getDeviceNum(); 29330d8983SJohannes Doerfert 30330d8983SJohannes Doerfert /// Return the user choosen debug level. 31330d8983SJohannes Doerfert uint32_t getDebugKind(); 32330d8983SJohannes Doerfert 33330d8983SJohannes Doerfert /// Return if teams oversubscription is assumed 34330d8983SJohannes Doerfert uint32_t getAssumeTeamsOversubscription(); 35330d8983SJohannes Doerfert 36330d8983SJohannes Doerfert /// Return if threads oversubscription is assumed 37330d8983SJohannes Doerfert uint32_t getAssumeThreadsOversubscription(); 38330d8983SJohannes Doerfert 39330d8983SJohannes Doerfert /// Return the amount of dynamic shared memory that was allocated at launch. 40330d8983SJohannes Doerfert uint64_t getDynamicMemorySize(); 41330d8983SJohannes Doerfert 42330d8983SJohannes Doerfert /// Returns the cycles per second of the device's fixed frequency clock. 43330d8983SJohannes Doerfert uint64_t getClockFrequency(); 44330d8983SJohannes Doerfert 45330d8983SJohannes Doerfert /// Returns the pointer to the beginning of the indirect call table. 46330d8983SJohannes Doerfert void *getIndirectCallTablePtr(); 47330d8983SJohannes Doerfert 48330d8983SJohannes Doerfert /// Returns the size of the indirect call table. 49330d8983SJohannes Doerfert uint64_t getIndirectCallTableSize(); 50330d8983SJohannes Doerfert 51330d8983SJohannes Doerfert /// Returns the size of the indirect call table. 52330d8983SJohannes Doerfert uint64_t getHardwareParallelism(); 53330d8983SJohannes Doerfert 54330d8983SJohannes Doerfert /// Return if debugging is enabled for the given debug kind. 55330d8983SJohannes Doerfert bool isDebugMode(DeviceDebugKind Level); 56330d8983SJohannes Doerfert 57330d8983SJohannes Doerfert /// Indicates if this kernel may require thread-specific states, or if it was 58330d8983SJohannes Doerfert /// explicitly disabled by the user. 59330d8983SJohannes Doerfert bool mayUseThreadStates(); 60330d8983SJohannes Doerfert 61330d8983SJohannes Doerfert /// Indicates if this kernel may require data environments for nested 62330d8983SJohannes Doerfert /// parallelism, or if it was explicitly disabled by the user. 63330d8983SJohannes Doerfert bool mayUseNestedParallelism(); 64330d8983SJohannes Doerfert 65330d8983SJohannes Doerfert } // namespace config 66330d8983SJohannes Doerfert } // namespace ompx 67330d8983SJohannes Doerfert 68330d8983SJohannes Doerfert #endif 69