LLVM  15.0.0git
SmallVectorMemoryBuffer.h
Go to the documentation of this file.
1 //===- SmallVectorMemoryBuffer.h --------------------------------*- 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 // This file declares a wrapper class to hold the memory into which an
10 // object will be generated.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_SUPPORT_SMALLVECTORMEMORYBUFFER_H
15 #define LLVM_SUPPORT_SMALLVECTORMEMORYBUFFER_H
16 
17 #include "llvm/ADT/SmallVector.h"
20 
21 namespace llvm {
22 
23 /// SmallVector-backed MemoryBuffer instance.
24 ///
25 /// This class enables efficient construction of MemoryBuffers from SmallVector
26 /// instances. This is useful for MCJIT and Orc, where object files are streamed
27 /// into SmallVectors, then inspected using ObjectFile (which takes a
28 /// MemoryBuffer).
30 public:
31  /// Construct a SmallVectorMemoryBuffer from the given SmallVector r-value.
33  bool RequiresNullTerminator = true)
34  : SmallVectorMemoryBuffer(std::move(SV), "<in-memory object>",
35  RequiresNullTerminator) {}
36 
37  /// Construct a named SmallVectorMemoryBuffer from the given SmallVector
38  /// r-value and StringRef.
40  bool RequiresNullTerminator = true)
41  : SV(std::move(SV)), BufferName(std::string(Name)) {
42  if (RequiresNullTerminator) {
43  this->SV.push_back('\0');
44  this->SV.pop_back();
45  }
46  init(this->SV.begin(), this->SV.end(), false);
47  }
48 
49  // Key function.
50  ~SmallVectorMemoryBuffer() override;
51 
52  StringRef getBufferIdentifier() const override { return BufferName; }
53 
54  BufferKind getBufferKind() const override { return MemoryBuffer_Malloc; }
55 
56 private:
58  std::string BufferName;
59 };
60 
61 } // namespace llvm
62 
63 #endif
MemoryBuffer.h
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:17
llvm::SmallVector< char, 0 >
llvm::SmallVectorMemoryBuffer::SmallVectorMemoryBuffer
SmallVectorMemoryBuffer(SmallVectorImpl< char > &&SV, bool RequiresNullTerminator=true)
Construct a SmallVectorMemoryBuffer from the given SmallVector r-value.
Definition: SmallVectorMemoryBuffer.h:32
llvm::SmallVectorMemoryBuffer
SmallVector-backed MemoryBuffer instance.
Definition: SmallVectorMemoryBuffer.h:29
llvm::MemoryBuffer
This interface provides simple read-only access to a block of memory, and provides simple methods for...
Definition: MemoryBuffer.h:50
llvm::MemoryBuffer::init
void init(const char *BufStart, const char *BufEnd, bool RequiresNullTerminator)
init - Initialize this MemoryBuffer as a reference to externally allocated memory,...
Definition: MemoryBuffer.cpp:48
llvm::SmallVectorMemoryBuffer::SmallVectorMemoryBuffer
SmallVectorMemoryBuffer(SmallVectorImpl< char > &&SV, StringRef Name, bool RequiresNullTerminator=true)
Construct a named SmallVectorMemoryBuffer from the given SmallVector r-value and StringRef.
Definition: SmallVectorMemoryBuffer.h:39
llvm::SmallVectorMemoryBuffer::~SmallVectorMemoryBuffer
~SmallVectorMemoryBuffer() override
llvm::MemoryBuffer::BufferKind
BufferKind
The kind of memory backing used to support the MemoryBuffer.
Definition: MemoryBuffer.h:153
llvm::move
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1663
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:58
this
Analysis the ScalarEvolution expression for r is this
Definition: README.txt:8
llvm::GraphProgram::Name
Name
Definition: GraphWriter.h:50
std
Definition: BitVector.h:851
SmallVector.h
llvm::SmallVectorMemoryBuffer::getBufferKind
BufferKind getBufferKind() const override
Return information on the memory mechanism used to support the MemoryBuffer.
Definition: SmallVectorMemoryBuffer.h:54
llvm::SmallVectorImpl< char >
raw_ostream.h
llvm::SmallVectorMemoryBuffer::getBufferIdentifier
StringRef getBufferIdentifier() const override
Return an identifier for this buffer, typically the filename it was read from.
Definition: SmallVectorMemoryBuffer.h:52
llvm::MemoryBuffer::MemoryBuffer_Malloc
@ MemoryBuffer_Malloc
Definition: MemoryBuffer.h:154
SpecialSubKind::string
@ string