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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
|
/*
* Copyright (C) 2008-2009, Google Inc.
* Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
* and other copyright owners as documented in the project's IP log.
*
* This program and the accompanying materials are made available
* under the terms of the Eclipse Distribution License v1.0 which
* accompanies this distribution, is reproduced below, and is
* available at http://www.eclipse.org/org/documents/edl-v10.php
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* - Neither the name of the Eclipse Foundation, Inc. nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.eclipse.jgit.util;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import org.eclipse.jgit.JGitText;
import org.eclipse.jgit.lib.NullProgressMonitor;
import org.eclipse.jgit.lib.ProgressMonitor;
/**
* A fully buffered output stream.
* <p>
* Subclasses determine the behavior when the in-memory buffer capacity has been
* exceeded and additional bytes are still being received for output.
*/
public abstract class TemporaryBuffer extends OutputStream {
/** Default limit for in-core storage. */
protected static final int DEFAULT_IN_CORE_LIMIT = 1024 * 1024;
/** Chain of data, if we are still completely in-core; otherwise null. */
private ArrayList<Block> blocks;
/**
* Maximum number of bytes we will permit storing in memory.
* <p>
* When this limit is reached the data will be shifted to a file on disk,
* preventing the JVM heap from growing out of control.
*/
private int inCoreLimit;
/** If {@link #inCoreLimit} has been reached, remainder goes here. */
private OutputStream overflow;
/**
* Create a new empty temporary buffer.
*
* @param limit
* maximum number of bytes to store in memory before entering the
* overflow output path.
*/
protected TemporaryBuffer(final int limit) {
inCoreLimit = limit;
reset();
}
@Override
public void write(final int b) throws IOException {
if (overflow != null) {
overflow.write(b);
return;
}
Block s = last();
if (s.isFull()) {
if (reachedInCoreLimit()) {
overflow.write(b);
return;
}
s = new Block();
blocks.add(s);
}
s.buffer[s.count++] = (byte) b;
}
@Override
public void write(final byte[] b, int off, int len) throws IOException {
if (overflow == null) {
while (len > 0) {
Block s = last();
if (s.isFull()) {
if (reachedInCoreLimit())
break;
s = new Block();
blocks.add(s);
}
final int n = Math.min(Block.SZ - s.count, len);
System.arraycopy(b, off, s.buffer, s.count, n);
s.count += n;
len -= n;
off += n;
}
}
if (len > 0)
overflow.write(b, off, len);
}
/**
* Copy all bytes remaining on the input stream into this buffer.
*
* @param in
* the stream to read from, until EOF is reached.
* @throws IOException
* an error occurred reading from the input stream, or while
* writing to a local temporary file.
*/
public void copy(final InputStream in) throws IOException {
if (blocks != null) {
for (;;) {
Block s = last();
if (s.isFull()) {
if (reachedInCoreLimit())
break;
s = new Block();
blocks.add(s);
}
final int n = in.read(s.buffer, s.count, Block.SZ - s.count);
if (n < 1)
return;
s.count += n;
}
}
final byte[] tmp = new byte[Block.SZ];
int n;
while ((n = in.read(tmp)) > 0)
overflow.write(tmp, 0, n);
}
/**
* Obtain the length (in bytes) of the buffer.
* <p>
* The length is only accurate after {@link #close()} has been invoked.
*
* @return total length of the buffer, in bytes.
*/
public long length() {
final Block last = last();
return ((long) blocks.size()) * Block.SZ - (Block.SZ - last.count);
}
/**
* Convert this buffer's contents into a contiguous byte array.
* <p>
* The buffer is only complete after {@link #close()} has been invoked.
*
* @return the complete byte array; length matches {@link #length()}.
* @throws IOException
* an error occurred reading from a local temporary file
* @throws OutOfMemoryError
* the buffer cannot fit in memory
*/
public byte[] toByteArray() throws IOException {
final long len = length();
if (Integer.MAX_VALUE < len)
throw new OutOfMemoryError(JGitText.get().lengthExceedsMaximumArraySize);
final byte[] out = new byte[(int) len];
int outPtr = 0;
for (final Block b : blocks) {
System.arraycopy(b.buffer, 0, out, outPtr, b.count);
outPtr += b.count;
}
return out;
}
/**
* Send this buffer to an output stream.
* <p>
* This method may only be invoked after {@link #close()} has completed
* normally, to ensure all data is completely transferred.
*
* @param os
* stream to send this buffer's complete content to.
* @param pm
* if not null progress updates are sent here. Caller should
* initialize the task and the number of work units to <code>
* {@link #length()}/1024</code>.
* @throws IOException
* an error occurred reading from a temporary file on the local
* system, or writing to the output stream.
*/
public void writeTo(final OutputStream os, ProgressMonitor pm)
throws IOException {
if (pm == null)
pm = NullProgressMonitor.INSTANCE;
for (final Block b : blocks) {
os.write(b.buffer, 0, b.count);
pm.update(b.count / 1024);
}
}
/** Reset this buffer for reuse, purging all buffered content. */
public void reset() {
if (overflow != null) {
destroy();
}
blocks = new ArrayList<Block>(inCoreLimit / Block.SZ);
blocks.add(new Block());
}
/**
* Open the overflow output stream, so the remaining output can be stored.
*
* @return the output stream to receive the buffered content, followed by
* the remaining output.
* @throws IOException
* the buffer cannot create the overflow stream.
*/
protected abstract OutputStream overflow() throws IOException;
private Block last() {
return blocks.get(blocks.size() - 1);
}
private boolean reachedInCoreLimit() throws IOException {
if (blocks.size() * Block.SZ < inCoreLimit)
return false;
overflow = overflow();
final Block last = blocks.remove(blocks.size() - 1);
for (final Block b : blocks)
overflow.write(b.buffer, 0, b.count);
blocks = null;
overflow = new BufferedOutputStream(overflow, Block.SZ);
overflow.write(last.buffer, 0, last.count);
return true;
}
public void close() throws IOException {
if (overflow != null) {
try {
overflow.close();
} finally {
overflow = null;
}
}
}
/** Clear this buffer so it has no data, and cannot be used again. */
public void destroy() {
blocks = null;
if (overflow != null) {
try {
overflow.close();
} catch (IOException err) {
// We shouldn't encounter an error closing the file.
} finally {
overflow = null;
}
}
}
/**
* A fully buffered output stream using local disk storage for large data.
* <p>
* Initially this output stream buffers to memory and is therefore similar
* to ByteArrayOutputStream, but it shifts to using an on disk temporary
* file if the output gets too large.
* <p>
* The content of this buffered stream may be sent to another OutputStream
* only after this stream has been properly closed by {@link #close()}.
*/
public static class LocalFile extends TemporaryBuffer {
/**
* Location of our temporary file if we are on disk; otherwise null.
* <p>
* If we exceeded the {@link #inCoreLimit} we nulled out {@link #blocks}
* and created this file instead. All output goes here through
* {@link #overflow}.
*/
private File onDiskFile;
/** Create a new temporary buffer. */
public LocalFile() {
this(DEFAULT_IN_CORE_LIMIT);
}
/**
* Create a new temporary buffer, limiting memory usage.
*
* @param inCoreLimit
* maximum number of bytes to store in memory. Storage beyond
* this limit will use the local file.
*/
public LocalFile(final int inCoreLimit) {
super(inCoreLimit);
}
protected OutputStream overflow() throws IOException {
onDiskFile = File.createTempFile("jgit_", ".buffer");
return new FileOutputStream(onDiskFile);
}
public long length() {
if (onDiskFile == null) {
return super.length();
}
return onDiskFile.length();
}
public byte[] toByteArray() throws IOException {
if (onDiskFile == null) {
return super.toByteArray();
}
final long len = length();
if (Integer.MAX_VALUE < len)
throw new OutOfMemoryError(JGitText.get().lengthExceedsMaximumArraySize);
final byte[] out = new byte[(int) len];
final FileInputStream in = new FileInputStream(onDiskFile);
try {
IO.readFully(in, out, 0, (int) len);
} finally {
in.close();
}
return out;
}
public void writeTo(final OutputStream os, ProgressMonitor pm)
throws IOException {
if (onDiskFile == null) {
super.writeTo(os, pm);
return;
}
if (pm == null)
pm = NullProgressMonitor.INSTANCE;
final FileInputStream in = new FileInputStream(onDiskFile);
try {
int cnt;
final byte[] buf = new byte[Block.SZ];
while ((cnt = in.read(buf)) >= 0) {
os.write(buf, 0, cnt);
pm.update(cnt / 1024);
}
} finally {
in.close();
}
}
@Override
public void destroy() {
super.destroy();
if (onDiskFile != null) {
try {
if (!onDiskFile.delete())
onDiskFile.deleteOnExit();
} finally {
onDiskFile = null;
}
}
}
}
/**
* A temporary buffer that will never exceed its in-memory limit.
* <p>
* If the in-memory limit is reached an IOException is thrown, rather than
* attempting to spool to local disk.
*/
public static class Heap extends TemporaryBuffer {
/**
* Create a new heap buffer with a maximum storage limit.
*
* @param limit
* maximum number of bytes that can be stored in this buffer.
* Storing beyond this many will cause an IOException to be
* thrown during write.
*/
public Heap(final int limit) {
super(limit);
}
@Override
protected OutputStream overflow() throws IOException {
throw new IOException(JGitText.get().inMemoryBufferLimitExceeded);
}
}
static class Block {
static final int SZ = 8 * 1024;
final byte[] buffer = new byte[SZ];
int count;
boolean isFull() {
return count == SZ;
}
}
}
|