0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
1 //===--- MemoryBuffer.h - Memory Buffer Interface ---------------*- C++ -*-===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
2 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
3 // The LLVM Compiler Infrastructure
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
4 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
5 // This file is distributed under the University of Illinois Open Source
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
6 // License. See LICENSE.TXT for details.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
7 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
8 //===----------------------------------------------------------------------===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
9 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
10 // This file defines the MemoryBuffer interface.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
11 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
12 //===----------------------------------------------------------------------===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
13
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
14 #ifndef LLVM_SUPPORT_MEMORYBUFFER_H
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
15 #define LLVM_SUPPORT_MEMORYBUFFER_H
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
16
|
|
121
|
17 #include "llvm-c/Types.h"
|
|
|
18 #include "llvm/ADT/StringRef.h"
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
19 #include "llvm/ADT/Twine.h"
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
20 #include "llvm/Support/CBindingWrapping.h"
|
|
77
|
21 #include "llvm/Support/ErrorOr.h"
|
|
121
|
22 #include <cstddef>
|
|
|
23 #include <cstdint>
|
|
77
|
24 #include <memory>
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
25
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
26 namespace llvm {
|
|
121
|
27
|
|
77
|
28 class MemoryBufferRef;
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
29
|
|
77
|
30 /// This interface provides simple read-only access to a block of memory, and
|
|
|
31 /// provides simple methods for reading files and standard input into a memory
|
|
|
32 /// buffer. In addition to basic access to the characters in the file, this
|
|
|
33 /// interface guarantees you can read one character past the end of the file,
|
|
|
34 /// and that this character will read as '\0'.
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
35 ///
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
36 /// The '\0' guarantee is needed to support an optimization -- it's intended to
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
37 /// be more efficient for clients which are reading all the data to stop
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
38 /// reading when they encounter a '\0' than to continually check the file
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
39 /// position to see if it has reached the end of the file.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
40 class MemoryBuffer {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
41 const char *BufferStart; // Start of the buffer.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
42 const char *BufferEnd; // End of the buffer.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
43
|
|
121
|
44
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
45 protected:
|
|
121
|
46 MemoryBuffer() = default;
|
|
|
47
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
48 void init(const char *BufStart, const char *BufEnd,
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
49 bool RequiresNullTerminator);
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
50 public:
|
|
121
|
51 MemoryBuffer(const MemoryBuffer &) = delete;
|
|
|
52 MemoryBuffer &operator=(const MemoryBuffer &) = delete;
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
53 virtual ~MemoryBuffer();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
54
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
55 const char *getBufferStart() const { return BufferStart; }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
56 const char *getBufferEnd() const { return BufferEnd; }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
57 size_t getBufferSize() const { return BufferEnd-BufferStart; }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
58
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
59 StringRef getBuffer() const {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
60 return StringRef(BufferStart, getBufferSize());
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
61 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
62
|
|
77
|
63 /// Return an identifier for this buffer, typically the filename it was read
|
|
|
64 /// from.
|
|
120
|
65 virtual StringRef getBufferIdentifier() const { return "Unknown buffer"; }
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
66
|
|
77
|
67 /// Open the specified file as a MemoryBuffer, returning a new MemoryBuffer
|
|
|
68 /// if successful, otherwise returning null. If FileSize is specified, this
|
|
|
69 /// means that the client knows that the file exists and that it has the
|
|
|
70 /// specified size.
|
|
|
71 ///
|
|
121
|
72 /// \param IsVolatile Set to true to indicate that the contents of the file
|
|
|
73 /// can change outside the user's control, e.g. when libclang tries to parse
|
|
|
74 /// while the user is editing/updating the file or if the file is on an NFS.
|
|
77
|
75 static ErrorOr<std::unique_ptr<MemoryBuffer>>
|
|
83
|
76 getFile(const Twine &Filename, int64_t FileSize = -1,
|
|
121
|
77 bool RequiresNullTerminator = true, bool IsVolatile = false);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
78
|
|
120
|
79 /// Read all of the specified file into a MemoryBuffer as a stream
|
|
|
80 /// (i.e. until EOF reached). This is useful for special files that
|
|
|
81 /// look like a regular file but have 0 size (e.g. /proc/cpuinfo on Linux).
|
|
|
82 static ErrorOr<std::unique_ptr<MemoryBuffer>>
|
|
|
83 getFileAsStream(const Twine &Filename);
|
|
|
84
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
85 /// Given an already-open file descriptor, map some slice of it into a
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
86 /// MemoryBuffer. The slice is specified by an \p Offset and \p MapSize.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
87 /// Since this is in the middle of a file, the buffer is not null terminated.
|
|
77
|
88 static ErrorOr<std::unique_ptr<MemoryBuffer>>
|
|
83
|
89 getOpenFileSlice(int FD, const Twine &Filename, uint64_t MapSize,
|
|
121
|
90 int64_t Offset, bool IsVolatile = false);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
91
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
92 /// Given an already-open file descriptor, read the file and return a
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
93 /// MemoryBuffer.
|
|
77
|
94 ///
|
|
121
|
95 /// \param IsVolatile Set to true to indicate that the contents of the file
|
|
|
96 /// can change outside the user's control, e.g. when libclang tries to parse
|
|
|
97 /// while the user is editing/updating the file or if the file is on an NFS.
|
|
77
|
98 static ErrorOr<std::unique_ptr<MemoryBuffer>>
|
|
83
|
99 getOpenFile(int FD, const Twine &Filename, uint64_t FileSize,
|
|
121
|
100 bool RequiresNullTerminator = true, bool IsVolatile = false);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
101
|
|
77
|
102 /// Open the specified memory range as a MemoryBuffer. Note that InputData
|
|
|
103 /// must be null terminated if RequiresNullTerminator is true.
|
|
|
104 static std::unique_ptr<MemoryBuffer>
|
|
|
105 getMemBuffer(StringRef InputData, StringRef BufferName = "",
|
|
|
106 bool RequiresNullTerminator = true);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
107
|
|
77
|
108 static std::unique_ptr<MemoryBuffer>
|
|
|
109 getMemBuffer(MemoryBufferRef Ref, bool RequiresNullTerminator = true);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
110
|
|
77
|
111 /// Open the specified memory range as a MemoryBuffer, copying the contents
|
|
|
112 /// and taking ownership of it. InputData does not have to be null terminated.
|
|
|
113 static std::unique_ptr<MemoryBuffer>
|
|
83
|
114 getMemBufferCopy(StringRef InputData, const Twine &BufferName = "");
|
|
77
|
115
|
|
|
116 /// Allocate a new zero-initialized MemoryBuffer of the specified size. Note
|
|
|
117 /// that the caller need not initialize the memory allocated by this method.
|
|
|
118 /// The memory is owned by the MemoryBuffer object.
|
|
|
119 static std::unique_ptr<MemoryBuffer>
|
|
|
120 getNewMemBuffer(size_t Size, StringRef BufferName = "");
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
121
|
|
77
|
122 /// Allocate a new MemoryBuffer of the specified size that is not initialized.
|
|
|
123 /// Note that the caller should initialize the memory allocated by this
|
|
|
124 /// method. The memory is owned by the MemoryBuffer object.
|
|
|
125 static std::unique_ptr<MemoryBuffer>
|
|
83
|
126 getNewUninitMemBuffer(size_t Size, const Twine &BufferName = "");
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
127
|
|
77
|
128 /// Read all of stdin into a file buffer, and return it.
|
|
|
129 static ErrorOr<std::unique_ptr<MemoryBuffer>> getSTDIN();
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
130
|
|
77
|
131 /// Open the specified file as a MemoryBuffer, or open stdin if the Filename
|
|
|
132 /// is "-".
|
|
|
133 static ErrorOr<std::unique_ptr<MemoryBuffer>>
|
|
100
|
134 getFileOrSTDIN(const Twine &Filename, int64_t FileSize = -1,
|
|
|
135 bool RequiresNullTerminator = true);
|
|
83
|
136
|
|
95
|
137 /// Map a subrange of the specified file as a MemoryBuffer.
|
|
83
|
138 static ErrorOr<std::unique_ptr<MemoryBuffer>>
|
|
121
|
139 getFileSlice(const Twine &Filename, uint64_t MapSize, uint64_t Offset, bool IsVolatile = false);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
140
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
141 //===--------------------------------------------------------------------===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
142 // Provided for performance analysis.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
143 //===--------------------------------------------------------------------===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
144
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
145 /// The kind of memory backing used to support the MemoryBuffer.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
146 enum BufferKind {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
147 MemoryBuffer_Malloc,
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
148 MemoryBuffer_MMap
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
149 };
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
150
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
151 /// Return information on the memory mechanism used to support the
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
152 /// MemoryBuffer.
|
|
77
|
153 virtual BufferKind getBufferKind() const = 0;
|
|
|
154
|
|
|
155 MemoryBufferRef getMemBufferRef() const;
|
|
|
156 };
|
|
|
157
|
|
|
158 class MemoryBufferRef {
|
|
|
159 StringRef Buffer;
|
|
|
160 StringRef Identifier;
|
|
|
161
|
|
|
162 public:
|
|
121
|
163 MemoryBufferRef() = default;
|
|
100
|
164 MemoryBufferRef(MemoryBuffer& Buffer)
|
|
|
165 : Buffer(Buffer.getBuffer()), Identifier(Buffer.getBufferIdentifier()) {}
|
|
77
|
166 MemoryBufferRef(StringRef Buffer, StringRef Identifier)
|
|
|
167 : Buffer(Buffer), Identifier(Identifier) {}
|
|
|
168
|
|
|
169 StringRef getBuffer() const { return Buffer; }
|
|
|
170
|
|
|
171 StringRef getBufferIdentifier() const { return Identifier; }
|
|
|
172
|
|
|
173 const char *getBufferStart() const { return Buffer.begin(); }
|
|
|
174 const char *getBufferEnd() const { return Buffer.end(); }
|
|
|
175 size_t getBufferSize() const { return Buffer.size(); }
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
176 };
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
177
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
178 // Create wrappers for C Binding types (see CBindingWrapping.h).
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
179 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef)
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
180
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
181 } // end namespace llvm
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
182
|
|
121
|
183 #endif // LLVM_SUPPORT_MEMORYBUFFER_H
|
