Skip to content

Commit

Permalink
[OpenMP] Use simple VLA implementation to replace uses of actual VLA
Browse files Browse the repository at this point in the history
Use of VLA can cause compile warning that was introduced in D156565. This patch
implements a simple stack/heap-based VLA that can miminc the behavior of an
actual VLA and prevent the warning. By default the stack accomodates the
elements. If the number of emelements is greater than N, which by default is 8,
a heap buffer will be allocated and used to acccomodate the elements.
  • Loading branch information
shiltian committed Nov 29, 2023
1 parent 4528808 commit 97e16da
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 4 deletions.
7 changes: 4 additions & 3 deletions openmp/runtime/src/kmp_gsupport.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

#include "kmp.h"
#include "kmp_atomic.h"
#include "kmp_utils.h"

#if OMPT_SUPPORT
#include "ompt-specific.h"
Expand Down Expand Up @@ -1280,7 +1281,7 @@ void KMP_EXPAND_NAME(KMP_API_NAME_GOMP_TASK)(void (*func)(void *), void *data,
KMP_ASSERT(depend);
kmp_gomp_depends_info_t gomp_depends(depend);
kmp_int32 ndeps = gomp_depends.get_num_deps();
kmp_depend_info_t dep_list[ndeps];
SimpleVLA<kmp_depend_info_t> dep_list(ndeps);
for (kmp_int32 i = 0; i < ndeps; i++)
dep_list[i] = gomp_depends.get_kmp_depend(i);
kmp_int32 ndeps_cnv;
Expand Down Expand Up @@ -1309,7 +1310,7 @@ void KMP_EXPAND_NAME(KMP_API_NAME_GOMP_TASK)(void (*func)(void *), void *data,
KMP_ASSERT(depend);
kmp_gomp_depends_info_t gomp_depends(depend);
kmp_int32 ndeps = gomp_depends.get_num_deps();
kmp_depend_info_t dep_list[ndeps];
SimpleVLA<kmp_depend_info_t> dep_list(ndeps);
for (kmp_int32 i = 0; i < ndeps; i++)
dep_list[i] = gomp_depends.get_kmp_depend(i);
__kmpc_omp_wait_deps(&loc, gtid, ndeps, dep_list, 0, NULL);
Expand Down Expand Up @@ -1993,7 +1994,7 @@ void KMP_EXPAND_NAME(KMP_API_NAME_GOMP_TASKWAIT_DEPEND)(void **depend) {
KA_TRACE(20, ("GOMP_taskwait_depend: T#%d\n", gtid));
kmp_gomp_depends_info_t gomp_depends(depend);
kmp_int32 ndeps = gomp_depends.get_num_deps();
kmp_depend_info_t dep_list[ndeps];
SimpleVLA<kmp_depend_info_t> dep_list(ndeps);
for (kmp_int32 i = 0; i < ndeps; i++)
dep_list[i] = gomp_depends.get_kmp_depend(i);
#if OMPT_SUPPORT
Expand Down
3 changes: 2 additions & 1 deletion openmp/runtime/src/kmp_runtime.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
#include "kmp_wait_release.h"
#include "kmp_wrapper_getpid.h"
#include "kmp_dispatch.h"
#include "kmp_utils.h"
#if KMP_USE_HIER_SCHED
#include "kmp_dispatch_hier.h"
#endif
Expand Down Expand Up @@ -1652,7 +1653,7 @@ __kmp_serial_fork_call(ident_t *loc, int gtid, enum fork_context_e call_context,
/* josh todo: hypothetical question: what do we do for OS X*? */
#if KMP_OS_LINUX && \
(KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
void *args[argc];
SimpleVLA<void *> args(argc);
#else
void **args = (void **)KMP_ALLOCA(argc * sizeof(void *));
#endif /* KMP_OS_LINUX && ( KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || \
Expand Down
58 changes: 58 additions & 0 deletions openmp/runtime/src/kmp_utils.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/*
* kmp_utils.h -- Utilities that used internally
*/

//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef __KMP_UTILS_H__
#define __KMP_UTILS_H__

#include <cstddef>

#include "kmp.h"

/// A simple pure header implementation of VLA that aims to replace uses of
/// actual VLA, which can cause compile warning. This class by default creates a
/// stack buffer that can accomodate \p N elements. If the number of elements is
/// greater than \p N, then a heap buffer will be allocated and used to
/// accomodate the elements. Similar to the actual VLA, we don't check boundary
/// (for now), so we will not store the number of elements. We can always revise
/// it later.
template <typename T, unsigned N = 8> class SimpleVLA final {
T StackBuffer[N];
T *HeapBuffer = nullptr;
T *Ptr = StackBuffer;

public:
SimpleVLA() = delete;
SimpleVLA(const SimpleVLA &) = delete;
SimpleVLA(SimpleVLA &&) = delete;
SimpleVLA &operator=(const SimpleVLA &) = delete;
SimpleVLA &operator=(SimpleVLA &&) = delete;

explicit SimpleVLA(unsigned NumOfElements) noexcept {
if (NumOfElements > N) {
HeapBuffer =
reinterpret_cast<T *>(__kmp_allocate(NumOfElements * sizeof(T)));
Ptr = HeapBuffer;
}
}

~SimpleVLA() {
if (HeapBuffer)
__kmp_free(HeapBuffer);
}

const T &operator[](std::size_t Idx) const noexcept { return Ptr[Idx]; }
T &operator[](std::size_t Idx) noexcept { return Ptr[Idx]; }

operator T *() noexcept { return Ptr; }
operator const T *() const noexcept { return Ptr; }
};

#endif

0 comments on commit 97e16da

Please sign in to comment.