uses_allocators Clause

| OPENMP API Specification: "Version 5.2 -- GIT rev 95b2e3a44"

6.8 uses_allocators Clause


Name: uses_allocators	Properties: data-environment attribute, data-sharing attribute

Arguments


Name	Type	Properties

allocator	expression of allocator_handle type	default

Modiﬁers


Name	Modiﬁes	Type	Properties

mem-space	Generic	Complex, name: memspace Arguments: memspace-handle expression of memspace_handle type (default)	default

traits-array	Generic	Complex, name: traits Arguments: traits variable of alloctrait array type (default)	default

Directives

target

Additional information

The comma-separated list syntax, in which each list item is a clause-argument-speciﬁcation of the form allocator[(traits)] may also be used for the uses_allocators clause arguments. With this syntax, traits must be a constant array with constant values. This syntax has been deprecated.

Semantics

The uses_allocators clause enables the use of the speciﬁed allocator in the region associated with the directive on which the clause appears. If allocator refers to a predeﬁned allocator, that predeﬁned allocator will be available for use in the region. If allocator does not refer to a predeﬁned allocator, the eﬀect is as if allocator is speciﬁed on a private clause. The resulting corresponding item is assigned the result of a call to omp_init_allocator at the beginning of the associated region with arguments memspace-handle, the number of traits in the traits array, and traits. If mem-space is not speciﬁed, the eﬀect is as if memspace-handle is speciﬁed as omp_default_mem_space. If traits-array is not speciﬁed, the eﬀect is as if traits is speciﬁed as an empty array. Further, at the end of the associated region, the eﬀect is as if this allocator is destroyed as if by a call to omp_destroy_allocator.

Restrictions

The allocator expression must be a base language identiﬁer.
If allocator is a predeﬁned allocator, no modiﬁers may be speciﬁed.
If allocator is not a predeﬁned allocator, it must be a variable.
The allocator argument must not appear in other data-sharing attribute clauses or data-mapping attribute clauses on the same construct.
The traits argument for the traits-array modiﬁer must be a constant array, have constant values and be deﬁned in the same scope as the construct on which the clause appears.
The memspace-handle argument for the mem-space modiﬁer must be an identiﬁer that matches one of the predeﬁned memory space names.

Cross References

Memory Allocators, see Section 6.2
Memory Spaces, see Section 6.1
omp_destroy_allocator, see Section 18.13.3
omp_init_allocator, see Section 18.13.2
target directive, see Section 13.8

[next] [prev] [prev-tail] [front] [up]