mirror of
https://gcc.gnu.org/git/gcc.git
synced 2024-11-30 15:24:07 +08:00
9f2fca5659
This patch considers the environment variable syntax extension for device-specific variants of environment variables from OpenMP 5.1 (see OpenMP 5.1 specification, p. 75 and p. 639). An environment variable (e.g. OMP_NUM_TEAMS) can have different suffixes: _DEV (e.g. OMP_NUM_TEAMS_DEV): affects all devices but not the host. _DEV_<device> (e.g. OMP_NUM_TEAMS_DEV_42): affects only device with number <device>. no suffix (e.g. OMP_NUM_TEAMS): affects only the host. In future OpenMP versions also suffix _ALL will be introduced (see discussion https://github.com/OpenMP/spec/issues/3179). This is also considered in this patch: _ALL (e.g. OMP_NUM_TEAMS_ALL): affects all devices and the host. The precedence is as follows (descending). For the host: 1. no suffix 2. _ALL For devices: 1. _DEV_<device> 2. _DEV 3. _ALL That means, _DEV_<device> is used whenever available. Otherwise _DEV is used if available, and at last _ALL. If there is no value for any of the variable variants, default values are used as already implemented before. This patch concerns parsing (a), storing (b), output (c) and transmission to the device (d): (a) The actual number of devices and the numbering are not known when parsing the environment variables. Thus all environment variables are iterated and searched for device-specific ones. (b) Only configured device-specific variables are stored. Thus, a linked list is used. (c) The output is done in omp_display_env (see specification p. 468f). Global ICVs are tagged with [all], see https://github.com/OpenMP/spec/issues/3179. ICVs which are not global but aren't handled device-specific yet are tagged with [host]. omp_display_env outputs the initial values of the ICVs. That is why a dedicated data structure is introduced for the inital values only (gomp_initial_icv_list). (d) Device-specific ICVs are transmitted to the device via GOMP_ADDITIONAL_ICVS. libgomp/ChangeLog: * config/gcn/icv-device.c (omp_get_default_device): Return device- specific ICV. (omp_get_max_teams): Added for GCN devices. (omp_set_num_teams): Likewise. (ialias): Likewise. * config/nvptx/icv-device.c (omp_get_default_device): Return device- specific ICV. (omp_get_max_teams): Added for NVPTX devices. (omp_set_num_teams): Likewise. (ialias): Likewise. * env.c (struct gomp_icv_list): New struct to store entries of initial ICV values. (struct gomp_offload_icv_list): New struct to store entries of device- specific ICV values that are copied to the device and back. (struct gomp_default_icv_values): New struct to store default values of ICVs according to the OpenMP standard. (parse_schedule): Generalized for different variants of OMP_SCHEDULE. (print_env_var_error): Function that prints an error for invalid values for ICVs. (parse_unsigned_long_1): Removed getenv. Generalized. (parse_unsigned_long): Likewise. (parse_int_1): Likewise. (parse_int): Likewise. (parse_int_secure): Likewise. (parse_unsigned_long_list): Likewise. (parse_target_offload): Likewise. (parse_bind_var): Likewise. (parse_stacksize): Likewise. (parse_boolean): Likewise. (parse_wait_policy): Likewise. (parse_allocator): Likewise. (omp_display_env): Extended to output different variants of environment variables. (print_schedule): New helper function for omp_display_env which prints the values of run_sched_var. (print_proc_bind): New helper function for omp_display_env which prints the values of proc_bind_var. (enum gomp_parse_type): Collection of types used for parsing environment variables. (ENTRY): Preprocess string lengths of environment variables. (OMP_VAR_CNT): Preprocess table size. (OMP_HOST_VAR_CNT): Likewise. (INT_MAX_STR_LEN): Constant for the maximal number of digits of a device number. (gomp_get_icv_flag): Returns if a flag for a particular ICV is set. (gomp_set_icv_flag): Sets a flag for a particular ICV. (print_device_specific_icvs): New helper function for omp_display_env to print device specific ICV values. (get_device_num): New helper function for parse_device_specific. Extracts the device number from an environment variable name. (get_icv_member_addr): Gets the memory address for a particular member of an ICV struct. (gomp_get_initial_icv_item): Get a list item of gomp_initial_icv_list. (initialize_icvs): New function to initialize a gomp_initial_icvs struct. (add_initial_icv_to_list): Adds an ICV struct to gomp_initial_icv_list. (startswith): Checks if a string starts with a given prefix. (initialize_env): Extended to parse the new syntax of environment variables. * icv-device.c (omp_get_max_teams): Added. (ialias): Likewise. (omp_set_num_teams): Likewise. * icv.c (omp_set_num_teams): Moved to icv-device.c. (omp_get_max_teams): Likewise. (ialias): Likewise. * libgomp-plugin.h (GOMP_DEVICE_NUM_VAR): Removed. (GOMP_ADDITIONAL_ICVS): New target-side struct that holds the designated ICVs of the target device. * libgomp.h (enum gomp_icvs): Collection of ICVs. (enum gomp_device_num): Definition of device numbers for _ALL, _DEV, and no suffix. (enum gomp_env_suffix): Collection of possible suffixes of environment variables. (struct gomp_initial_icvs): Contains all ICVs for which we need to store initial values. (struct gomp_default_icv):New struct to hold ICVs for which we need to store initial values. (struct gomp_icv_list): Definition of a linked list that is used for storing ICVs for the devices and also for _DEV, _ALL, and without suffix. (struct gomp_offload_icvs): New struct to hold ICVs that are copied to a device. (struct gomp_offload_icv_list): Definition of a linked list that holds device-specific ICVs that are copied to devices. (gomp_get_initial_icv_item): Get a list item of gomp_initial_icv_list. (gomp_get_icv_flag): Returns if a flag for a particular ICV is set. * libgomp.texi: Updated. * plugin/plugin-gcn.c (GOMP_OFFLOAD_load_image): Extended to read further ICVs from the offload image. * plugin/plugin-nvptx.c (GOMP_OFFLOAD_load_image): Likewise. * target.c (gomp_get_offload_icv_item): Get a list item of gomp_offload_icv_list. (get_gomp_offload_icvs): New. Returns the ICV values depending on the device num and the variable hierarchy. (gomp_load_image_to_device): Extended to copy further ICVs to a device. * testsuite/libgomp.c-c++-common/icv-5.c: New test. * testsuite/libgomp.c-c++-common/icv-6.c: New test. * testsuite/libgomp.c-c++-common/icv-7.c: New test. * testsuite/libgomp.c-c++-common/icv-8.c: New test. * testsuite/libgomp.c-c++-common/omp-display-env-1.c: New test. * testsuite/libgomp.c-c++-common/omp-display-env-2.c: New test.
176 lines
6.5 KiB
C
176 lines
6.5 KiB
C
/* The libgomp plugin API.
|
|
|
|
Copyright (C) 2014-2022 Free Software Foundation, Inc.
|
|
|
|
Contributed by Mentor Embedded.
|
|
|
|
This file is part of the GNU Offloading and Multi Processing Library
|
|
(libgomp).
|
|
|
|
Libgomp is free software; you can redistribute it and/or modify it
|
|
under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 3, or (at your option)
|
|
any later version.
|
|
|
|
Libgomp is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
|
more details.
|
|
|
|
Under Section 7 of GPL version 3, you are granted additional
|
|
permissions described in the GCC Runtime Library Exception, version
|
|
3.1, as published by the Free Software Foundation.
|
|
|
|
You should have received a copy of the GNU General Public License and
|
|
a copy of the GCC Runtime Library Exception along with this program;
|
|
see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
|
|
<http://www.gnu.org/licenses/>. */
|
|
|
|
#ifndef LIBGOMP_PLUGIN_H
|
|
#define LIBGOMP_PLUGIN_H 1
|
|
|
|
#include <stdbool.h>
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Capabilities of offloading devices. */
|
|
#define GOMP_OFFLOAD_CAP_SHARED_MEM (1 << 0)
|
|
#define GOMP_OFFLOAD_CAP_NATIVE_EXEC (1 << 1)
|
|
#define GOMP_OFFLOAD_CAP_OPENMP_400 (1 << 2)
|
|
#define GOMP_OFFLOAD_CAP_OPENACC_200 (1 << 3)
|
|
|
|
/* Type of offload target device. Keep in sync with include/gomp-constants.h. */
|
|
enum offload_target_type
|
|
{
|
|
OFFLOAD_TARGET_TYPE_HOST = 2,
|
|
/* OFFLOAD_TARGET_TYPE_HOST_NONSHM = 3 removed. */
|
|
OFFLOAD_TARGET_TYPE_NVIDIA_PTX = 5,
|
|
OFFLOAD_TARGET_TYPE_INTEL_MIC = 6,
|
|
OFFLOAD_TARGET_TYPE_HSA = 7,
|
|
OFFLOAD_TARGET_TYPE_GCN = 8
|
|
};
|
|
|
|
/* Opaque type to represent plugin-dependent implementation of an
|
|
OpenACC asynchronous queue. */
|
|
struct goacc_asyncqueue;
|
|
|
|
/* Used to keep a list of active asynchronous queues. */
|
|
struct goacc_asyncqueue_list
|
|
{
|
|
struct goacc_asyncqueue *aq;
|
|
struct goacc_asyncqueue_list *next;
|
|
};
|
|
|
|
typedef struct goacc_asyncqueue *goacc_aq;
|
|
typedef struct goacc_asyncqueue_list *goacc_aq_list;
|
|
|
|
|
|
/* OpenACC 'acc_get_property' support. */
|
|
|
|
/* Device property values. Keep in sync with
|
|
'libgomp/{openacc.h,openacc.f90}:acc_device_property_t'. */
|
|
enum goacc_property
|
|
{
|
|
/* Mask to tell numeric and string values apart. */
|
|
#define GOACC_PROPERTY_STRING_MASK 0x10000
|
|
|
|
/* Start from 1 to catch uninitialized use. */
|
|
GOACC_PROPERTY_MEMORY = 1,
|
|
GOACC_PROPERTY_FREE_MEMORY = 2,
|
|
GOACC_PROPERTY_NAME = GOACC_PROPERTY_STRING_MASK | 1,
|
|
GOACC_PROPERTY_VENDOR = GOACC_PROPERTY_STRING_MASK | 2,
|
|
GOACC_PROPERTY_DRIVER = GOACC_PROPERTY_STRING_MASK | 3
|
|
};
|
|
|
|
/* Container type for passing device properties. */
|
|
union goacc_property_value
|
|
{
|
|
const char *ptr;
|
|
size_t val;
|
|
};
|
|
|
|
|
|
/* Auxiliary struct, used for transferring pairs of addresses from plugin
|
|
to libgomp. */
|
|
struct addr_pair
|
|
{
|
|
uintptr_t start;
|
|
uintptr_t end;
|
|
};
|
|
|
|
/* This following symbol is used to name the target side variable struct that
|
|
holds the designated ICVs of the target device. The symbol needs to be
|
|
available to libgomp code and the offload plugin (which in the latter case
|
|
must be stringified). */
|
|
#define GOMP_ADDITIONAL_ICVS __gomp_additional_icvs
|
|
|
|
/* Miscellaneous functions. */
|
|
extern void *GOMP_PLUGIN_malloc (size_t) __attribute__ ((malloc));
|
|
extern void *GOMP_PLUGIN_malloc_cleared (size_t) __attribute__ ((malloc));
|
|
extern void *GOMP_PLUGIN_realloc (void *, size_t);
|
|
void GOMP_PLUGIN_target_task_completion (void *);
|
|
|
|
extern void GOMP_PLUGIN_debug (int, const char *, ...)
|
|
__attribute__ ((format (printf, 2, 3)));
|
|
extern void GOMP_PLUGIN_error (const char *, ...)
|
|
__attribute__ ((format (printf, 1, 2)));
|
|
extern void GOMP_PLUGIN_fatal (const char *, ...)
|
|
__attribute__ ((noreturn, format (printf, 1, 2)));
|
|
|
|
/* Prototypes for functions implemented by libgomp plugins. */
|
|
extern const char *GOMP_OFFLOAD_get_name (void);
|
|
extern unsigned int GOMP_OFFLOAD_get_caps (void);
|
|
extern int GOMP_OFFLOAD_get_type (void);
|
|
extern int GOMP_OFFLOAD_get_num_devices (unsigned int);
|
|
extern bool GOMP_OFFLOAD_init_device (int);
|
|
extern bool GOMP_OFFLOAD_fini_device (int);
|
|
extern unsigned GOMP_OFFLOAD_version (void);
|
|
extern int GOMP_OFFLOAD_load_image (int, unsigned, const void *,
|
|
struct addr_pair **);
|
|
extern bool GOMP_OFFLOAD_unload_image (int, unsigned, const void *);
|
|
extern void *GOMP_OFFLOAD_alloc (int, size_t);
|
|
extern bool GOMP_OFFLOAD_free (int, void *);
|
|
extern bool GOMP_OFFLOAD_dev2host (int, void *, const void *, size_t);
|
|
extern bool GOMP_OFFLOAD_host2dev (int, void *, const void *, size_t);
|
|
extern bool GOMP_OFFLOAD_dev2dev (int, void *, const void *, size_t);
|
|
extern bool GOMP_OFFLOAD_can_run (void *);
|
|
extern void GOMP_OFFLOAD_run (int, void *, void *, void **);
|
|
extern void GOMP_OFFLOAD_async_run (int, void *, void *, void **, void *);
|
|
|
|
extern void GOMP_OFFLOAD_openacc_exec (void (*) (void *), size_t, void **,
|
|
void **, unsigned *, void *);
|
|
extern void *GOMP_OFFLOAD_openacc_create_thread_data (int);
|
|
extern void GOMP_OFFLOAD_openacc_destroy_thread_data (void *);
|
|
extern struct goacc_asyncqueue *GOMP_OFFLOAD_openacc_async_construct (int);
|
|
extern bool GOMP_OFFLOAD_openacc_async_destruct (struct goacc_asyncqueue *);
|
|
extern int GOMP_OFFLOAD_openacc_async_test (struct goacc_asyncqueue *);
|
|
extern bool GOMP_OFFLOAD_openacc_async_synchronize (struct goacc_asyncqueue *);
|
|
extern bool GOMP_OFFLOAD_openacc_async_serialize (struct goacc_asyncqueue *,
|
|
struct goacc_asyncqueue *);
|
|
extern void GOMP_OFFLOAD_openacc_async_queue_callback (struct goacc_asyncqueue *,
|
|
void (*)(void *), void *);
|
|
extern void GOMP_OFFLOAD_openacc_async_exec (void (*) (void *), size_t, void **,
|
|
void **, unsigned *, void *,
|
|
struct goacc_asyncqueue *);
|
|
extern bool GOMP_OFFLOAD_openacc_async_dev2host (int, void *, const void *, size_t,
|
|
struct goacc_asyncqueue *);
|
|
extern bool GOMP_OFFLOAD_openacc_async_host2dev (int, void *, const void *, size_t,
|
|
struct goacc_asyncqueue *);
|
|
extern void *GOMP_OFFLOAD_openacc_cuda_get_current_device (void);
|
|
extern void *GOMP_OFFLOAD_openacc_cuda_get_current_context (void);
|
|
extern void *GOMP_OFFLOAD_openacc_cuda_get_stream (struct goacc_asyncqueue *);
|
|
extern int GOMP_OFFLOAD_openacc_cuda_set_stream (struct goacc_asyncqueue *,
|
|
void *);
|
|
extern union goacc_property_value
|
|
GOMP_OFFLOAD_openacc_get_property (int, enum goacc_property);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|