-
Notifications
You must be signed in to change notification settings - Fork 25
/
allocationregister.ts
224 lines (187 loc) · 8.48 KB
/
allocationregister.ts
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/* spellchecker: disable */
import { Observable, ReplaySubject } from 'rxjs';
import { assert, prettyPrintBytes } from './auxiliaries';
/* spellchecker: enable */
/**
* This register enables monitoring of memory (de)allocations and is intended for use in WebGL context for internal GPU
* memory allocation tracking. For it, a unique identifier for registration has to be created:
* ```
* let gpuAllocReg = this.context.gpuAllocationRegister;
* const identifier = gpuAllocReg.createUniqueIdentifier('gpu-object');
* ```
*
* Then allocations, deallocations, and reallocations can be registered:
* ```
* gpuAllocReg.allocate(identifier, this.sizeofRGBAColorAttachment());
* gpuAllocReg.allocate(identifier, this.sizeofDepthStencilAttachment());
* // ... reallocation
* gpuAllocReg.reallocate(identifier,
* this.sizeofRGBAColorAttachment() + this.sizeofDepthStencilAttachment());
* // ... uninitialize
* gpuAllocReg.reallocate(identifier, 0);
* ```
*
* Requesting the allocated memory can be done as follows:
* ```
* // memory allocated by identifier:
* console.log(mfCanvas.context.gpuAllocationRegister.toString());
* //> IntermediateFBO: 10.582MiB, AccumulationPingFBO: 21.163MiB, AccumulationPongFBO: 21.163MiB
*
* // memory allocated over all identifiers:
* console.log(mfCanvas.context.gpuAllocationRegister.bytesToString());
* //> 52.908MiB
* ```
*/
export class AllocationRegister {
/**
* Map that provides access to the accumulated memory allocations for all registered identifiers.
*/
protected _bytesByIdentifier = new Map<string, GLsizei>();
/** @see {@link bytes} */
protected _bytes: GLsizei = 0;
protected _bytesSubject = new ReplaySubject<[GLsizei, string]>(1);
/**
* Utility for communicating this._bytes changes to its associated subject.
*/
protected bytesNext(): void {
this._bytesSubject.next([this._bytes, this.bytesToString()]);
}
/**
* Asserts existence of an identifier.
* @param identifier - Identifier to assert the existence of.
*/
protected assertIdentifier(identifier: string): void {
assert(this._bytesByIdentifier.has(identifier), `allocation identifier unknown`);
}
/**
* Creates a unique identifier based on a given identifier: if the identifier is already unique it is returned as
* is. If not, an enumerated identifier is returned, e.g., 'TempFBO-2' when 'TempFBO' already exists. This also
* enables tracking for the identifier, thus, it should always be called before tracking/monitoring.
* @param identifier - Requested identifier for allocation registration.
* @returns - Unique identifier (might differ from given identifier) for which allocation registration is enabled.
*/
createUniqueIdentifier(identifier: string): string {
let uniqueIdentifier: string = identifier;
let unificationSuffix = 2;
while (this._bytesByIdentifier.has(uniqueIdentifier)) {
uniqueIdentifier = `${identifier}-${unificationSuffix}`;
++unificationSuffix;
}
this._bytesByIdentifier.set(uniqueIdentifier, 0);
return uniqueIdentifier;
}
/**
* Removes a previously created unique identifier from the allocation registry.
* @param identifier - Identifier that is to be deleted from allocation registration.
*/
deleteUniqueIdentifier(identifier: string): void {
assert(this._bytesByIdentifier.has(identifier), `identifier expected to be known for allocation registration`);
this._bytesByIdentifier.delete(identifier);
}
/**
* Registers allocated bytes for a given identifier.
* @param identifier - Identifier to register the allocated bytes for.
* @param allocate - Allocated bytes to register for identifier.
*/
allocate(identifier: string, allocate: number): void {
this.assertIdentifier(identifier);
assert(allocate >= 0, `positive number of bytes expected for allocation, given ${allocate}`);
/* Nothing to do if no bytes are allocated */
if (allocate === 0) {
return;
}
const bytes = (this._bytesByIdentifier.get(identifier)!) + allocate;
this._bytesByIdentifier.set(identifier, bytes);
this._bytes = this._bytes + allocate; // allocate total
this.bytesNext();
}
/**
* Registers deallocated bytes for a given identifier.
* @param identifier - Identifier to register the deallocated bytes for.
* @param allocate - Number of deallocated bytes to register for identifier.
*/
deallocate(identifier: string, deallocate: number): void {
this.assertIdentifier(identifier);
const bytes = this._bytesByIdentifier.get(identifier)!;
assert(deallocate >= 0, `positive number of bytes expected for deallocation, given ${deallocate}`);
assert(deallocate <= bytes, `deallocation cannot exceed previous allocations of ${bytes}, given ${deallocate}`);
/* Nothing to do if no bytes are deallocated */
if (deallocate === 0) {
return;
}
this._bytesByIdentifier.set(identifier, bytes - deallocate);
this._bytes = this._bytes - deallocate; // deallocate total
this.bytesNext();
}
/**
* Resets the previously allocated bytes for the given identifier and registers the given allocated bytes instead.
* @param identifier - Identifier to register the reallocated bytes for.
* @param allocate - Number of reallocated bytes to register for identifier.
*/
reallocate(identifier: string, reallocate: number): void {
this.assertIdentifier(identifier);
assert(reallocate >= 0, `positive number of bytes expected for reallocation, given ${reallocate}`);
const previousBytes = this._bytesByIdentifier.get(identifier)!;
/* Nothing to do if same size should be reallocated */
if (previousBytes === reallocate) {
return;
}
this._bytes = this._bytes - previousBytes; // deallocate total
this._bytesByIdentifier.set(identifier, reallocate);
this._bytes = this._bytes + reallocate; // allocate total
this.bytesNext();
}
/**
* Provides access to the allocated bytes for an identifier as well as the overall allocated bytes (when identifier
* is undefined, default). If the identifier is undefined, the overall allocated number of bytes is returned.
* @param identifier - Identifier to return the allocated bytes for.
* @param allocate - Number of allocated bytes registered for identifier.
*/
allocated(identifier?: string): number {
if (identifier === undefined) {
return this._bytes;
}
this.assertIdentifier(identifier);
return this._bytesByIdentifier.get(identifier)!;
}
/**
* Provides a pretty printed string of the allocated bytes of this register and their identifier. The output for a
* register of three objects could be as follows:
* ```
* IntermediateFBO: 10.582MiB, AccumulationPingFBO: 21.163MiB, AccumulationPongFBO: 21.163MiB
* ```
* @returns - Pretty printed string of all memory allocations.
*/
toString(): string {
const output = new Array<string>();
this._bytesByIdentifier.forEach((bytes: number, identifier: string) => {
output.push(`${identifier}: ${prettyPrintBytes(bytes)}`);
});
return output.join(', ');
}
/**
* Provides a pretty printed string of the overall number of bytes or a specific identifier. If the identifier is
* undefined, the overall number of bytes is pretty printed.
* @param identifier - Identifier to pretty print the bytes for.
* @returns - Pretty printed string of the requested number of bytes.
*/
bytesToString(identifier?: string): string {
return prettyPrintBytes(this.allocated(identifier));
}
/**
* Cache for the overall number of allocated bytes (over all identifiers). This should always be the sum of the
* bytes allocated over each identifier, which can be validated using validate().
*
* This property can be observed, e.g., `allocationRegister.bytesObservable.subscribe()`.
*/
get bytes(): GLsizei {
return this._bytes;
}
/**
* Observable that can be used to subscribe to bytes value changes. Yields a 2-tuple of overall allocated bytes as
* number and pretty printed string.
*/
get bytes$(): Observable<[GLsizei, string]> {
return this._bytesSubject.asObservable();
}
}