File: xray_recursion_guard.h

package info (click to toggle)
llvm-toolchain-17 1%3A17.0.6-22
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,799,624 kB
  • sloc: cpp: 6,428,607; ansic: 1,383,196; asm: 793,408; python: 223,504; objc: 75,364; f90: 60,502; lisp: 33,869; pascal: 15,282; sh: 9,684; perl: 7,453; ml: 4,937; awk: 3,523; makefile: 2,889; javascript: 2,149; xml: 888; fortran: 619; cs: 573
file content (56 lines) | stat: -rw-r--r-- 1,841 bytes parent folder | download | duplicates (30)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
//===-- xray_recursion_guard.h ---------------------------------*- C++ -*-===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// This file is a part of XRay, a dynamic runtime instrumentation system.
//
//===----------------------------------------------------------------------===//
#ifndef XRAY_XRAY_RECURSION_GUARD_H
#define XRAY_XRAY_RECURSION_GUARD_H

#include "sanitizer_common/sanitizer_atomic.h"

namespace __xray {

/// The RecursionGuard is useful for guarding against signal handlers which are
/// also potentially calling XRay-instrumented functions. To use the
/// RecursionGuard, you'll typically need a thread_local atomic_uint8_t:
///
///   thread_local atomic_uint8_t Guard{0};
///
///   // In a handler function:
///   void handleArg0(int32_t F, XRayEntryType T) {
///     RecursionGuard G(Guard);
///     if (!G)
///       return;  // Failed to acquire the guard.
///     ...
///   }
///
class RecursionGuard {
  atomic_uint8_t &Running;
  const bool Valid;

public:
  explicit inline RecursionGuard(atomic_uint8_t &R)
      : Running(R), Valid(!atomic_exchange(&R, 1, memory_order_acq_rel)) {}

  inline RecursionGuard(const RecursionGuard &) = delete;
  inline RecursionGuard(RecursionGuard &&) = delete;
  inline RecursionGuard &operator=(const RecursionGuard &) = delete;
  inline RecursionGuard &operator=(RecursionGuard &&) = delete;

  explicit inline operator bool() const { return Valid; }

  inline ~RecursionGuard() noexcept {
    if (Valid)
      atomic_store(&Running, 0, memory_order_release);
  }
};

} // namespace __xray

#endif // XRAY_XRAY_RECURSION_GUARD_H