clang/lib/CodeGen/EHScopeStack.h

   1 //===-- EHScopeStack.h - Stack for cleanup IR generation --------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 //
   9 // These classes should be the minimum interface required for other parts of
  10 // CodeGen to emit cleanups.  The implementation is in CGCleanup.cpp and other
  11 // implemenentation details that are not widely needed are in CGCleanup.h.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_CLANG_LIB_CODEGEN_EHSCOPESTACK_H
  16 #define LLVM_CLANG_LIB_CODEGEN_EHSCOPESTACK_H
  17
  18 #include "clang/Basic/LLVM.h"
  19 #include "llvm/ADT/STLExtras.h"
  20 #include "llvm/ADT/SmallVector.h"
  21 #include "llvm/IR/BasicBlock.h"
  22 #include "llvm/IR/Instructions.h"
  23 #include "llvm/IR/Value.h"
  24
  25 namespace clang {
  26 namespace CodeGen {
  27
  28 class CodeGenFunction;
  29
  30 /// A branch fixup.  These are required when emitting a goto to a
  31 /// label which hasn't been emitted yet.  The goto is optimistically
  32 /// emitted as a branch to the basic block for the label, and (if it
  33 /// occurs in a scope with non-trivial cleanups) a fixup is added to
  34 /// the innermost cleanup.  When a (normal) cleanup is popped, any
  35 /// unresolved fixups in that scope are threaded through the cleanup.
  36 struct BranchFixup {
  37   /// The block containing the terminator which needs to be modified
  38   /// into a switch if this fixup is resolved into the current scope.
  39   /// If null, LatestBranch points directly to the destination.
  40   llvm::BasicBlock *OptimisticBranchBlock;
  41
  42   /// The ultimate destination of the branch.
  43   ///
  44   /// This can be set to null to indicate that this fixup was
  45   /// successfully resolved.
  46   llvm::BasicBlock *Destination;
  47
  48   /// The destination index value.
  49   unsigned DestinationIndex;
  50
  51   /// The initial branch of the fixup.
  52   llvm::BranchInst *InitialBranch;
  53 };
  54
  55 template <class T> struct InvariantValue {
  56   typedef T type;
  57   typedef T saved_type;
  58   static bool needsSaving(type value) { return false; }
  59   static saved_type save(CodeGenFunction &CGF, type value) { return value; }
  60   static type restore(CodeGenFunction &CGF, saved_type value) { return value; }
  61 };
  62
  63 /// A metaprogramming class for ensuring that a value will dominate an
  64 /// arbitrary position in a function.
  65 template <class T> struct DominatingValue : InvariantValue<T> {};
  66
  67 template <class T, bool mightBeInstruction =
  68             std::is_base_of<llvm::Value, T>::value &&
  69             !std::is_base_of<llvm::Constant, T>::value &&
  70             !std::is_base_of<llvm::BasicBlock, T>::value>
  71 struct DominatingPointer;
  72 template <class T> struct DominatingPointer<T,false> : InvariantValue<T*> {};
  73 // template <class T> struct DominatingPointer<T,true> at end of file
  74
  75 template <class T> struct DominatingValue<T*> : DominatingPointer<T> {};
  76
  77 enum CleanupKind : unsigned {
  78   /// Denotes a cleanup that should run when a scope is exited using exceptional
  79   /// control flow (a throw statement leading to stack unwinding, ).
  80   EHCleanup = 0x1,
  81
  82   /// Denotes a cleanup that should run when a scope is exited using normal
  83   /// control flow (falling off the end of the scope, return, goto, ...).
  84   NormalCleanup = 0x2,
  85
  86   NormalAndEHCleanup = EHCleanup | NormalCleanup,
  87
  88   LifetimeMarker = 0x8,
  89   NormalEHLifetimeMarker = LifetimeMarker | NormalAndEHCleanup,
  90 };
  91
  92 /// A stack of scopes which respond to exceptions, including cleanups
  93 /// and catch blocks.
  94 class EHScopeStack {
  95 public:
  96   /* Should switch to alignof(uint64_t) instead of 8, when EHCleanupScope can */
  97   enum { ScopeStackAlignment = 8 };
  98
  99   /// A saved depth on the scope stack.  This is necessary because
 100   /// pushing scopes onto the stack invalidates iterators.
 101   class stable_iterator {
 102     friend class EHScopeStack;
 103
 104     /// Offset from StartOfData to EndOfBuffer.
 105     ptrdiff_t Size;
 106
 107     stable_iterator(ptrdiff_t Size) : Size(Size) {}
 108
 109   public:
 110     static stable_iterator invalid() { return stable_iterator(-1); }
 111     stable_iterator() : Size(-1) {}
 112
 113     bool isValid() const { return Size >= 0; }
 114
 115     /// Returns true if this scope encloses I.
 116     /// Returns false if I is invalid.
 117     /// This scope must be valid.
 118     bool encloses(stable_iterator I) const { return Size <= I.Size; }
 119
 120     /// Returns true if this scope strictly encloses I: that is,
 121     /// if it encloses I and is not I.
 122     /// Returns false is I is invalid.
 123     /// This scope must be valid.
 124     bool strictlyEncloses(stable_iterator I) const { return Size < I.Size; }
 125
 126     friend bool operator==(stable_iterator A, stable_iterator B) {
 127       return A.Size == B.Size;
 128     }
 129     friend bool operator!=(stable_iterator A, stable_iterator B) {
 130       return A.Size != B.Size;
 131     }
 132   };
 133
 134   /// Information for lazily generating a cleanup.  Subclasses must be
 135   /// POD-like: cleanups will not be destructed, and they will be
 136   /// allocated on the cleanup stack and freely copied and moved
 137   /// around.
 138   ///
 139   /// Cleanup implementations should generally be declared in an
 140   /// anonymous namespace.
 141   class Cleanup {
 142     // Anchor the construction vtable.
 143     virtual void anchor();
 144
 145   protected:
 146     ~Cleanup() = default;
 147
 148   public:
 149     Cleanup(const Cleanup &) = default;
 150     Cleanup(Cleanup &&) {}
 151
 152     // The copy and move assignment operator is defined as deleted pending
 153     // further motivation.
 154     Cleanup &operator=(const Cleanup &) = delete;
 155     Cleanup &operator=(Cleanup &&) = delete;
 156
 157     Cleanup() = default;
 158
 159     virtual bool isRedundantBeforeReturn() { return false; }
 160
 161     /// Generation flags.
 162     class Flags {
 163       enum {
 164         F_IsForEH = 0x1,
 165         F_IsNormalCleanupKind = 0x2,
 166         F_IsEHCleanupKind = 0x4,
 167         F_HasExitSwitch = 0x8,
 168       };
 169       unsigned flags;
 170
 171     public:
 172       Flags() : flags(0) {}
 173
 174       /// isForEH - true if the current emission is for an EH cleanup.
 175       bool isForEHCleanup() const { return flags & F_IsForEH; }
 176       bool isForNormalCleanup() const { return !isForEHCleanup(); }
 177       void setIsForEHCleanup() { flags |= F_IsForEH; }
 178
 179       bool isNormalCleanupKind() const { return flags & F_IsNormalCleanupKind; }
 180       void setIsNormalCleanupKind() { flags |= F_IsNormalCleanupKind; }
 181
 182       /// isEHCleanupKind - true if the cleanup was pushed as an EH
 183       /// cleanup.
 184       bool isEHCleanupKind() const { return flags & F_IsEHCleanupKind; }
 185       void setIsEHCleanupKind() { flags |= F_IsEHCleanupKind; }
 186
 187       bool hasExitSwitch() const { return flags & F_HasExitSwitch; }
 188       void setHasExitSwitch() { flags |= F_HasExitSwitch; }
 189     };
 190
 191     /// Emit the cleanup.  For normal cleanups, this is run in the
 192     /// same EH context as when the cleanup was pushed, i.e. the
 193     /// immediately-enclosing context of the cleanup scope.  For
 194     /// EH cleanups, this is run in a terminate context.
 195     ///
 196     // \param flags cleanup kind.
 197     virtual void Emit(CodeGenFunction &CGF, Flags flags) = 0;
 198   };
 199
 200   /// ConditionalCleanup stores the saved form of its parameters,
 201   /// then restores them and performs the cleanup.
 202   template <class T, class... As>
 203   class ConditionalCleanup final : public Cleanup {
 204     typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
 205     SavedTuple Saved;
 206
 207     template <std::size_t... Is>
 208     T restore(CodeGenFunction &CGF, std::index_sequence<Is...>) {
 209       // It's important that the restores are emitted in order. The braced init
 210       // list guarantees that.
 211       return T{DominatingValue<As>::restore(CGF, std::get<Is>(Saved))...};
 212     }
 213
 214     void Emit(CodeGenFunction &CGF, Flags flags) override {
 215       restore(CGF, std::index_sequence_for<As...>()).Emit(CGF, flags);
 216     }
 217
 218   public:
 219     ConditionalCleanup(typename DominatingValue<As>::saved_type... A)
 220         : Saved(A...) {}
 221
 222     ConditionalCleanup(SavedTuple Tuple) : Saved(std::move(Tuple)) {}
 223   };
 224
 225 private:
 226   // The implementation for this class is in CGException.h and
 227   // CGException.cpp; the definition is here because it's used as a
 228   // member of CodeGenFunction.
 229
 230   /// The start of the scope-stack buffer, i.e. the allocated pointer
 231   /// for the buffer.  All of these pointers are either simultaneously
 232   /// null or simultaneously valid.
 233   char *StartOfBuffer;
 234
 235   /// The end of the buffer.
 236   char *EndOfBuffer;
 237
 238   /// The first valid entry in the buffer.
 239   char *StartOfData;
 240
 241   /// The innermost normal cleanup on the stack.
 242   stable_iterator InnermostNormalCleanup;
 243
 244   /// The innermost EH scope on the stack.
 245   stable_iterator InnermostEHScope;
 246
 247   /// The CGF this Stack belong to
 248   CodeGenFunction* CGF;
 249
 250   /// The current set of branch fixups.  A branch fixup is a jump to
 251   /// an as-yet unemitted label, i.e. a label for which we don't yet
 252   /// know the EH stack depth.  Whenever we pop a cleanup, we have
 253   /// to thread all the current branch fixups through it.
 254   ///
 255   /// Fixups are recorded as the Use of the respective branch or
 256   /// switch statement.  The use points to the final destination.
 257   /// When popping out of a cleanup, these uses are threaded through
 258   /// the cleanup and adjusted to point to the new cleanup.
 259   ///
 260   /// Note that branches are allowed to jump into protected scopes
 261   /// in certain situations;  e.g. the following code is legal:
 262   ///     struct A { ~A(); }; // trivial ctor, non-trivial dtor
 263   ///     goto foo;
 264   ///     A a;
 265   ///    foo:
 266   ///     bar();
 267   SmallVector<BranchFixup, 8> BranchFixups;
 268
 269   char *allocate(size_t Size);
 270   void deallocate(size_t Size);
 271
 272   void *pushCleanup(CleanupKind K, size_t DataSize);
 273
 274 public:
 275   EHScopeStack()
 276     : StartOfBuffer(nullptr), EndOfBuffer(nullptr), StartOfData(nullptr),
 277       InnermostNormalCleanup(stable_end()), InnermostEHScope(stable_end()),
 278       CGF(nullptr) {}
 279   ~EHScopeStack() { delete[] StartOfBuffer; }
 280
 281   /// Push a lazily-created cleanup on the stack.
 282   template <class T, class... As> void pushCleanup(CleanupKind Kind, As... A) {
 283     static_assert(alignof(T) <= ScopeStackAlignment,
 284                   "Cleanup's alignment is too large.");
 285     void *Buffer = pushCleanup(Kind, sizeof(T));
 286     Cleanup *Obj = new (Buffer) T(A...);
 287     (void) Obj;
 288   }
 289
 290   /// Push a lazily-created cleanup on the stack. Tuple version.
 291   template <class T, class... As>
 292   void pushCleanupTuple(CleanupKind Kind, std::tuple<As...> A) {
 293     static_assert(alignof(T) <= ScopeStackAlignment,
 294                   "Cleanup's alignment is too large.");
 295     void *Buffer = pushCleanup(Kind, sizeof(T));
 296     Cleanup *Obj = new (Buffer) T(std::move(A));
 297     (void) Obj;
 298   }
 299
 300   // Feel free to add more variants of the following:
 301
 302   /// Push a cleanup with non-constant storage requirements on the
 303   /// stack.  The cleanup type must provide an additional static method:
 304   ///   static size_t getExtraSize(size_t);
 305   /// The argument to this method will be the value N, which will also
 306   /// be passed as the first argument to the constructor.
 307   ///
 308   /// The data stored in the extra storage must obey the same
 309   /// restrictions as normal cleanup member data.
 310   ///
 311   /// The pointer returned from this method is valid until the cleanup
 312   /// stack is modified.
 313   template <class T, class... As>
 314   T *pushCleanupWithExtra(CleanupKind Kind, size_t N, As... A) {
 315     static_assert(alignof(T) <= ScopeStackAlignment,
 316                   "Cleanup's alignment is too large.");
 317     void *Buffer = pushCleanup(Kind, sizeof(T) + T::getExtraSize(N));
 318     return new (Buffer) T(N, A...);
 319   }
 320
 321   void pushCopyOfCleanup(CleanupKind Kind, const void *Cleanup, size_t Size) {
 322     void *Buffer = pushCleanup(Kind, Size);
 323     std::memcpy(Buffer, Cleanup, Size);
 324   }
 325
 326   void setCGF(CodeGenFunction *inCGF) { CGF = inCGF; }
 327
 328   /// Pops a cleanup scope off the stack.  This is private to CGCleanup.cpp.
 329   void popCleanup();
 330
 331   /// Push a set of catch handlers on the stack.  The catch is
 332   /// uninitialized and will need to have the given number of handlers
 333   /// set on it.
 334   class EHCatchScope *pushCatch(unsigned NumHandlers);
 335
 336   /// Pops a catch scope off the stack.  This is private to CGException.cpp.
 337   void popCatch();
 338
 339   /// Push an exceptions filter on the stack.
 340   class EHFilterScope *pushFilter(unsigned NumFilters);
 341
 342   /// Pops an exceptions filter off the stack.
 343   void popFilter();
 344
 345   /// Push a terminate handler on the stack.
 346   void pushTerminate();
 347
 348   /// Pops a terminate handler off the stack.
 349   void popTerminate();
 350
 351   // Returns true iff the current scope is either empty or contains only
 352   // lifetime markers, i.e. no real cleanup code
 353   bool containsOnlyLifetimeMarkers(stable_iterator Old) const;
 354
 355   /// Determines whether the exception-scopes stack is empty.
 356   bool empty() const { return StartOfData == EndOfBuffer; }
 357
 358   bool requiresLandingPad() const;
 359
 360   /// Determines whether there are any normal cleanups on the stack.
 361   bool hasNormalCleanups() const {
 362     return InnermostNormalCleanup != stable_end();
 363   }
 364
 365   /// Returns the innermost normal cleanup on the stack, or
 366   /// stable_end() if there are no normal cleanups.
 367   stable_iterator getInnermostNormalCleanup() const {
 368     return InnermostNormalCleanup;
 369   }
 370   stable_iterator getInnermostActiveNormalCleanup() const;
 371
 372   stable_iterator getInnermostEHScope() const {
 373     return InnermostEHScope;
 374   }
 375
 376
 377   /// An unstable reference to a scope-stack depth.  Invalidated by
 378   /// pushes but not pops.
 379   class iterator;
 380
 381   /// Returns an iterator pointing to the innermost EH scope.
 382   iterator begin() const;
 383
 384   /// Returns an iterator pointing to the outermost EH scope.
 385   iterator end() const;
 386
 387   /// Create a stable reference to the top of the EH stack.  The
 388   /// returned reference is valid until that scope is popped off the
 389   /// stack.
 390   stable_iterator stable_begin() const {
 391     return stable_iterator(EndOfBuffer - StartOfData);
 392   }
 393
 394   /// Create a stable reference to the bottom of the EH stack.
 395   static stable_iterator stable_end() {
 396     return stable_iterator(0);
 397   }
 398
 399   /// Translates an iterator into a stable_iterator.
 400   stable_iterator stabilize(iterator it) const;
 401
 402   /// Turn a stable reference to a scope depth into a unstable pointer
 403   /// to the EH stack.
 404   iterator find(stable_iterator save) const;
 405
 406   /// Add a branch fixup to the current cleanup scope.
 407   BranchFixup &addBranchFixup() {
 408     assert(hasNormalCleanups() && "adding fixup in scope without cleanups");
 409     BranchFixups.push_back(BranchFixup());
 410     return BranchFixups.back();
 411   }
 412
 413   unsigned getNumBranchFixups() const { return BranchFixups.size(); }
 414   BranchFixup &getBranchFixup(unsigned I) {
 415     assert(I < getNumBranchFixups());
 416     return BranchFixups[I];
 417   }
 418
 419   /// Pops lazily-removed fixups from the end of the list.  This
 420   /// should only be called by procedures which have just popped a
 421   /// cleanup or resolved one or more fixups.
 422   void popNullFixups();
 423
 424   /// Clears the branch-fixups list.  This should only be called by
 425   /// ResolveAllBranchFixups.
 426   void clearFixups() { BranchFixups.clear(); }
 427 };
 428
 429 } // namespace CodeGen
 430 } // namespace clang
 431
 432 #endif