external.okio.Buffer Maven / Gradle / Ivy
Show all versions of ratel-api Show documentation
/*
* Copyright (C) 2014 Square, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package external.okio;
import java.io.Closeable;
import java.io.EOFException;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.ByteBuffer;
import java.nio.channels.ByteChannel;
import java.nio.charset.Charset;
import java.security.InvalidKeyException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import javax.annotation.Nullable;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import static external.okio.Util.checkOffsetAndCount;
import static external.okio.Util.reverseBytesLong;
/**
* A collection of bytes in memory.
*
* Moving data from one buffer to another is fast. Instead
* of copying bytes from one place in memory to another, this class just changes
* ownership of the underlying byte arrays.
*
*
This buffer grows with your data. Just like ArrayList,
* each buffer starts small. It consumes only the memory it needs to.
*
*
This buffer pools its byte arrays. When you allocate a
* byte array in Java, the runtime must zero-fill the requested array before
* returning it to you. Even if you're going to write over that space anyway.
* This class avoids zero-fill and GC churn by pooling byte arrays.
*/
public final class Buffer implements BufferedSource, BufferedSink, Cloneable, ByteChannel {
private static final byte[] DIGITS =
{ '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
static final int REPLACEMENT_CHARACTER = '\ufffd';
@Nullable Segment head;
long size;
public Buffer() {
}
/** Returns the number of bytes currently in this buffer. */
public final long size() {
return size;
}
@Override public Buffer buffer() {
return this;
}
@Override public Buffer getBuffer() {
return this;
}
@Override public OutputStream outputStream() {
return new OutputStream() {
@Override public void write(int b) {
writeByte((byte) b);
}
@Override public void write(byte[] data, int offset, int byteCount) {
Buffer.this.write(data, offset, byteCount);
}
@Override public void flush() {
}
@Override public void close() {
}
@Override public String toString() {
return Buffer.this + ".outputStream()";
}
};
}
@Override public Buffer emitCompleteSegments() {
return this; // Nowhere to emit to!
}
@Override public BufferedSink emit() {
return this; // Nowhere to emit to!
}
@Override public boolean exhausted() {
return size == 0;
}
@Override public void require(long byteCount) throws EOFException {
if (size < byteCount) throw new EOFException();
}
@Override public boolean request(long byteCount) {
return size >= byteCount;
}
@Override public BufferedSource peek() {
return Okio.buffer(new PeekSource(this));
}
@Override public InputStream inputStream() {
return new InputStream() {
@Override public int read() {
if (size > 0) return readByte() & 0xff;
return -1;
}
@Override public int read(byte[] sink, int offset, int byteCount) {
return Buffer.this.read(sink, offset, byteCount);
}
@Override public int available() {
return (int) Math.min(size, Integer.MAX_VALUE);
}
@Override public void close() {
}
@Override public String toString() {
return Buffer.this + ".inputStream()";
}
};
}
/** Copy the contents of this to {@code out}. */
public final Buffer copyTo(OutputStream out) throws IOException {
return copyTo(out, 0, size);
}
/**
* Copy {@code byteCount} bytes from this, starting at {@code offset}, to
* {@code out}.
*/
public final Buffer copyTo(OutputStream out, long offset, long byteCount) throws IOException {
if (out == null) throw new IllegalArgumentException("out == null");
checkOffsetAndCount(size, offset, byteCount);
if (byteCount == 0) return this;
// Skip segments that we aren't copying from.
Segment s = head;
for (; offset >= (s.limit - s.pos); s = s.next) {
offset -= (s.limit - s.pos);
}
// Copy from one segment at a time.
for (; byteCount > 0; s = s.next) {
int pos = (int) (s.pos + offset);
int toCopy = (int) Math.min(s.limit - pos, byteCount);
out.write(s.data, pos, toCopy);
byteCount -= toCopy;
offset = 0;
}
return this;
}
/** Copy {@code byteCount} bytes from this, starting at {@code offset}, to {@code out}. */
public final Buffer copyTo(Buffer out, long offset, long byteCount) {
if (out == null) throw new IllegalArgumentException("out == null");
checkOffsetAndCount(size, offset, byteCount);
if (byteCount == 0) return this;
out.size += byteCount;
// Skip segments that we aren't copying from.
Segment s = head;
for (; offset >= (s.limit - s.pos); s = s.next) {
offset -= (s.limit - s.pos);
}
// Copy one segment at a time.
for (; byteCount > 0; s = s.next) {
Segment copy = s.sharedCopy();
copy.pos += offset;
copy.limit = Math.min(copy.pos + (int) byteCount, copy.limit);
if (out.head == null) {
out.head = copy.next = copy.prev = copy;
} else {
out.head.prev.push(copy);
}
byteCount -= copy.limit - copy.pos;
offset = 0;
}
return this;
}
/** Write the contents of this to {@code out}. */
public final Buffer writeTo(OutputStream out) throws IOException {
return writeTo(out, size);
}
/** Write {@code byteCount} bytes from this to {@code out}. */
public final Buffer writeTo(OutputStream out, long byteCount) throws IOException {
if (out == null) throw new IllegalArgumentException("out == null");
checkOffsetAndCount(size, 0, byteCount);
Segment s = head;
while (byteCount > 0) {
int toCopy = (int) Math.min(byteCount, s.limit - s.pos);
out.write(s.data, s.pos, toCopy);
s.pos += toCopy;
size -= toCopy;
byteCount -= toCopy;
if (s.pos == s.limit) {
Segment toRecycle = s;
head = s = toRecycle.pop();
SegmentPool.recycle(toRecycle);
}
}
return this;
}
/** Read and exhaust bytes from {@code in} to this. */
public final Buffer readFrom(InputStream in) throws IOException {
readFrom(in, Long.MAX_VALUE, true);
return this;
}
/** Read {@code byteCount} bytes from {@code in} to this. */
public final Buffer readFrom(InputStream in, long byteCount) throws IOException {
if (byteCount < 0) throw new IllegalArgumentException("byteCount < 0: " + byteCount);
readFrom(in, byteCount, false);
return this;
}
private void readFrom(InputStream in, long byteCount, boolean forever) throws IOException {
if (in == null) throw new IllegalArgumentException("in == null");
while (byteCount > 0 || forever) {
Segment tail = writableSegment(1);
int maxToCopy = (int) Math.min(byteCount, Segment.SIZE - tail.limit);
int bytesRead = in.read(tail.data, tail.limit, maxToCopy);
if (bytesRead == -1) {
if (forever) return;
throw new EOFException();
}
tail.limit += bytesRead;
size += bytesRead;
byteCount -= bytesRead;
}
}
/**
* Returns the number of bytes in segments that are not writable. This is the
* number of bytes that can be flushed immediately to an underlying sink
* without harming throughput.
*/
public final long completeSegmentByteCount() {
long result = size;
if (result == 0) return 0;
// Omit the tail if it's still writable.
Segment tail = head.prev;
if (tail.limit < Segment.SIZE && tail.owner) {
result -= tail.limit - tail.pos;
}
return result;
}
@Override public byte readByte() {
if (size == 0) throw new IllegalStateException("size == 0");
Segment segment = head;
int pos = segment.pos;
int limit = segment.limit;
byte[] data = segment.data;
byte b = data[pos++];
size -= 1;
if (pos == limit) {
head = segment.pop();
SegmentPool.recycle(segment);
} else {
segment.pos = pos;
}
return b;
}
/** Returns the byte at {@code pos}. */
public final byte getByte(long pos) {
checkOffsetAndCount(size, pos, 1);
if (size - pos > pos) {
for (Segment s = head; true; s = s.next) {
int segmentByteCount = s.limit - s.pos;
if (pos < segmentByteCount) return s.data[s.pos + (int) pos];
pos -= segmentByteCount;
}
} else {
pos -= size;
for (Segment s = head.prev; true; s = s.prev) {
pos += s.limit - s.pos;
if (pos >= 0) return s.data[s.pos + (int) pos];
}
}
}
@Override public short readShort() {
if (size < 2) throw new IllegalStateException("size < 2: " + size);
Segment segment = head;
int pos = segment.pos;
int limit = segment.limit;
// If the short is split across multiple segments, delegate to readByte().
if (limit - pos < 2) {
int s = (readByte() & 0xff) << 8
| (readByte() & 0xff);
return (short) s;
}
byte[] data = segment.data;
int s = (data[pos++] & 0xff) << 8
| (data[pos++] & 0xff);
size -= 2;
if (pos == limit) {
head = segment.pop();
SegmentPool.recycle(segment);
} else {
segment.pos = pos;
}
return (short) s;
}
@Override public int readInt() {
if (size < 4) throw new IllegalStateException("size < 4: " + size);
Segment segment = head;
int pos = segment.pos;
int limit = segment.limit;
// If the int is split across multiple segments, delegate to readByte().
if (limit - pos < 4) {
return (readByte() & 0xff) << 24
| (readByte() & 0xff) << 16
| (readByte() & 0xff) << 8
| (readByte() & 0xff);
}
byte[] data = segment.data;
int i = (data[pos++] & 0xff) << 24
| (data[pos++] & 0xff) << 16
| (data[pos++] & 0xff) << 8
| (data[pos++] & 0xff);
size -= 4;
if (pos == limit) {
head = segment.pop();
SegmentPool.recycle(segment);
} else {
segment.pos = pos;
}
return i;
}
@Override public long readLong() {
if (size < 8) throw new IllegalStateException("size < 8: " + size);
Segment segment = head;
int pos = segment.pos;
int limit = segment.limit;
// If the long is split across multiple segments, delegate to readInt().
if (limit - pos < 8) {
return (readInt() & 0xffffffffL) << 32
| (readInt() & 0xffffffffL);
}
byte[] data = segment.data;
long v = (data[pos++] & 0xffL) << 56
| (data[pos++] & 0xffL) << 48
| (data[pos++] & 0xffL) << 40
| (data[pos++] & 0xffL) << 32
| (data[pos++] & 0xffL) << 24
| (data[pos++] & 0xffL) << 16
| (data[pos++] & 0xffL) << 8
| (data[pos++] & 0xffL);
size -= 8;
if (pos == limit) {
head = segment.pop();
SegmentPool.recycle(segment);
} else {
segment.pos = pos;
}
return v;
}
@Override public short readShortLe() {
return Util.reverseBytesShort(readShort());
}
@Override public int readIntLe() {
return Util.reverseBytesInt(readInt());
}
@Override public long readLongLe() {
return Util.reverseBytesLong(readLong());
}
@Override public long readDecimalLong() {
if (size == 0) throw new IllegalStateException("size == 0");
// This value is always built negatively in order to accommodate Long.MIN_VALUE.
long value = 0;
int seen = 0;
boolean negative = false;
boolean done = false;
long overflowZone = Long.MIN_VALUE / 10;
long overflowDigit = (Long.MIN_VALUE % 10) + 1;
do {
Segment segment = head;
byte[] data = segment.data;
int pos = segment.pos;
int limit = segment.limit;
for (; pos < limit; pos++, seen++) {
byte b = data[pos];
if (b >= '0' && b <= '9') {
int digit = '0' - b;
// Detect when the digit would cause an overflow.
if (value < overflowZone || value == overflowZone && digit < overflowDigit) {
Buffer buffer = new Buffer().writeDecimalLong(value).writeByte(b);
if (!negative) buffer.readByte(); // Skip negative sign.
throw new NumberFormatException("Number too large: " + buffer.readUtf8());
}
value *= 10;
value += digit;
} else if (b == '-' && seen == 0) {
negative = true;
overflowDigit -= 1;
} else {
if (seen == 0) {
throw new NumberFormatException(
"Expected leading [0-9] or '-' character but was 0x" + Integer.toHexString(b));
}
// Set a flag to stop iteration. We still need to run through segment updating below.
done = true;
break;
}
}
if (pos == limit) {
head = segment.pop();
SegmentPool.recycle(segment);
} else {
segment.pos = pos;
}
} while (!done && head != null);
size -= seen;
return negative ? value : -value;
}
@Override public long readHexadecimalUnsignedLong() {
if (size == 0) throw new IllegalStateException("size == 0");
long value = 0;
int seen = 0;
boolean done = false;
do {
Segment segment = head;
byte[] data = segment.data;
int pos = segment.pos;
int limit = segment.limit;
for (; pos < limit; pos++, seen++) {
int digit;
byte b = data[pos];
if (b >= '0' && b <= '9') {
digit = b - '0';
} else if (b >= 'a' && b <= 'f') {
digit = b - 'a' + 10;
} else if (b >= 'A' && b <= 'F') {
digit = b - 'A' + 10; // We never write uppercase, but we support reading it.
} else {
if (seen == 0) {
throw new NumberFormatException(
"Expected leading [0-9a-fA-F] character but was 0x" + Integer.toHexString(b));
}
// Set a flag to stop iteration. We still need to run through segment updating below.
done = true;
break;
}
// Detect when the shift will overflow.
if ((value & 0xf000000000000000L) != 0) {
Buffer buffer = new Buffer().writeHexadecimalUnsignedLong(value).writeByte(b);
throw new NumberFormatException("Number too large: " + buffer.readUtf8());
}
value <<= 4;
value |= digit;
}
if (pos == limit) {
head = segment.pop();
SegmentPool.recycle(segment);
} else {
segment.pos = pos;
}
} while (!done && head != null);
size -= seen;
return value;
}
@Override public ByteString readByteString() {
return new ByteString(readByteArray());
}
@Override public ByteString readByteString(long byteCount) throws EOFException {
return new ByteString(readByteArray(byteCount));
}
@Override public int select(Options options) {
int index = selectPrefix(options, false);
if (index == -1) return -1;
// If the prefix match actually matched a full byte string, consume it and return it.
int selectedSize = options.byteStrings[index].size();
try {
skip(selectedSize);
} catch (EOFException e) {
throw new AssertionError();
}
return index;
}
/**
* Returns the index of a value in options that is a prefix of this buffer. Returns -1 if no value
* is found. This method does two simultaneous iterations: it iterates the trie and it iterates
* this buffer. It returns when it reaches a result in the trie, when it mismatches in the trie,
* and when the buffer is exhausted.
*
* @param selectTruncated true to return -2 if a possible result is present but truncated. For
* example, this will return -2 if the buffer contains [ab] and the options are [abc, abd].
* Note that this is made complicated by the fact that options are listed in preference order,
* and one option may be a prefix of another. For example, this returns -2 if the buffer
* contains [ab] and the options are [abc, a].
*/
int selectPrefix(Options options, boolean selectTruncated) {
Segment head = this.head;
if (head == null) {
if (selectTruncated) return -2; // A result is present but truncated.
return options.indexOf(ByteString.EMPTY);
}
Segment s = head;
byte[] data = head.data;
int pos = head.pos;
int limit = head.limit;
int[] trie = options.trie;
int triePos = 0;
int prefixIndex = -1;
navigateTrie:
while (true) {
int scanOrSelect = trie[triePos++];
int possiblePrefixIndex = trie[triePos++];
if (possiblePrefixIndex != -1) {
prefixIndex = possiblePrefixIndex;
}
int nextStep;
if (s == null) {
break;
} else if (scanOrSelect < 0) {
// Scan: take multiple bytes from the buffer and the trie, looking for any mismatch.
int scanByteCount = -1 * scanOrSelect;
int trieLimit = triePos + scanByteCount;
while (true) {
int b = data[pos++] & 0xff;
if (b != trie[triePos++]) return prefixIndex; // Fail 'cause we found a mismatch.
boolean scanComplete = (triePos == trieLimit);
// Advance to the next buffer segment if this one is exhausted.
if (pos == limit) {
s = s.next;
pos = s.pos;
data = s.data;
limit = s.limit;
if (s == head) {
if (!scanComplete) break navigateTrie; // We were exhausted before the scan completed.
s = null; // We were exhausted at the end of the scan.
}
}
if (scanComplete) {
nextStep = trie[triePos];
break;
}
}
} else {
// Select: take one byte from the buffer and find a match in the trie.
int selectChoiceCount = scanOrSelect;
int b = data[pos++] & 0xff;
int selectLimit = triePos + selectChoiceCount;
while (true) {
if (triePos == selectLimit) return prefixIndex; // Fail 'cause we didn't find a match.
if (b == trie[triePos]) {
nextStep = trie[triePos + selectChoiceCount];
break;
}
triePos++;
}
// Advance to the next buffer segment if this one is exhausted.
if (pos == limit) {
s = s.next;
pos = s.pos;
data = s.data;
limit = s.limit;
if (s == head) {
s = null; // No more segments! The next trie node will be our last.
}
}
}
if (nextStep >= 0) return nextStep; // Found a matching option.
triePos = -nextStep; // Found another node to continue the search.
}
// We break out of the loop above when we've exhausted the buffer without exhausting the trie.
if (selectTruncated) return -2; // The buffer is a prefix of at least one option.
return prefixIndex; // Return any matches we encountered while searching for a deeper match.
}
@Override public void readFully(Buffer sink, long byteCount) throws EOFException {
if (size < byteCount) {
sink.write(this, size); // Exhaust ourselves.
throw new EOFException();
}
sink.write(this, byteCount);
}
@Override public long readAll(Sink sink) throws IOException {
long byteCount = size;
if (byteCount > 0) {
sink.write(this, byteCount);
}
return byteCount;
}
@Override public String readUtf8() {
try {
return readString(size, Util.UTF_8);
} catch (EOFException e) {
throw new AssertionError(e);
}
}
@Override public String readUtf8(long byteCount) throws EOFException {
return readString(byteCount, Util.UTF_8);
}
@Override public String readString(Charset charset) {
try {
return readString(size, charset);
} catch (EOFException e) {
throw new AssertionError(e);
}
}
@Override public String readString(long byteCount, Charset charset) throws EOFException {
checkOffsetAndCount(size, 0, byteCount);
if (charset == null) throw new IllegalArgumentException("charset == null");
if (byteCount > Integer.MAX_VALUE) {
throw new IllegalArgumentException("byteCount > Integer.MAX_VALUE: " + byteCount);
}
if (byteCount == 0) return "";
Segment s = head;
if (s.pos + byteCount > s.limit) {
// If the string spans multiple segments, delegate to readBytes().
return new String(readByteArray(byteCount), charset);
}
String result = new String(s.data, s.pos, (int) byteCount, charset);
s.pos += byteCount;
size -= byteCount;
if (s.pos == s.limit) {
head = s.pop();
SegmentPool.recycle(s);
}
return result;
}
@Override public @Nullable String readUtf8Line() throws EOFException {
long newline = indexOf((byte) '\n');
if (newline == -1) {
return size != 0 ? readUtf8(size) : null;
}
return readUtf8Line(newline);
}
@Override public String readUtf8LineStrict() throws EOFException {
return readUtf8LineStrict(Long.MAX_VALUE);
}
@Override public String readUtf8LineStrict(long limit) throws EOFException {
if (limit < 0) throw new IllegalArgumentException("limit < 0: " + limit);
long scanLength = limit == Long.MAX_VALUE ? Long.MAX_VALUE : limit + 1;
long newline = indexOf((byte) '\n', 0, scanLength);
if (newline != -1) return readUtf8Line(newline);
if (scanLength < size()
&& getByte(scanLength - 1) == '\r' && getByte(scanLength) == '\n') {
return readUtf8Line(scanLength); // The line was 'limit' UTF-8 bytes followed by \r\n.
}
Buffer data = new Buffer();
copyTo(data, 0, Math.min(32, size()));
throw new EOFException("\\n not found: limit=" + Math.min(size(), limit)
+ " content=" + data.readByteString().hex() + '…');
}
String readUtf8Line(long newline) throws EOFException {
if (newline > 0 && getByte(newline - 1) == '\r') {
// Read everything until '\r\n', then skip the '\r\n'.
String result = readUtf8((newline - 1));
skip(2);
return result;
} else {
// Read everything until '\n', then skip the '\n'.
String result = readUtf8(newline);
skip(1);
return result;
}
}
@Override public int readUtf8CodePoint() throws EOFException {
if (size == 0) throw new EOFException();
byte b0 = getByte(0);
int codePoint;
int byteCount;
int min;
if ((b0 & 0x80) == 0) {
// 0xxxxxxx.
codePoint = b0 & 0x7f;
byteCount = 1; // 7 bits (ASCII).
min = 0x0;
} else if ((b0 & 0xe0) == 0xc0) {
// 0x110xxxxx
codePoint = b0 & 0x1f;
byteCount = 2; // 11 bits (5 + 6).
min = 0x80;
} else if ((b0 & 0xf0) == 0xe0) {
// 0x1110xxxx
codePoint = b0 & 0x0f;
byteCount = 3; // 16 bits (4 + 6 + 6).
min = 0x800;
} else if ((b0 & 0xf8) == 0xf0) {
// 0x11110xxx
codePoint = b0 & 0x07;
byteCount = 4; // 21 bits (3 + 6 + 6 + 6).
min = 0x10000;
} else {
// We expected the first byte of a code point but got something else.
skip(1);
return REPLACEMENT_CHARACTER;
}
if (size < byteCount) {
throw new EOFException("size < " + byteCount + ": " + size
+ " (to read code point prefixed 0x" + Integer.toHexString(b0) + ")");
}
// Read the continuation bytes. If we encounter a non-continuation byte, the sequence consumed
// thus far is truncated and is decoded as the replacement character. That non-continuation byte
// is left in the stream for processing by the next call to readUtf8CodePoint().
for (int i = 1; i < byteCount; i++) {
byte b = getByte(i);
if ((b & 0xc0) == 0x80) {
// 0x10xxxxxx
codePoint <<= 6;
codePoint |= b & 0x3f;
} else {
skip(i);
return REPLACEMENT_CHARACTER;
}
}
skip(byteCount);
if (codePoint > 0x10ffff) {
return REPLACEMENT_CHARACTER; // Reject code points larger than the Unicode maximum.
}
if (codePoint >= 0xd800 && codePoint <= 0xdfff) {
return REPLACEMENT_CHARACTER; // Reject partial surrogates.
}
if (codePoint < min) {
return REPLACEMENT_CHARACTER; // Reject overlong code points.
}
return codePoint;
}
@Override public byte[] readByteArray() {
try {
return readByteArray(size);
} catch (EOFException e) {
throw new AssertionError(e);
}
}
@Override public byte[] readByteArray(long byteCount) throws EOFException {
checkOffsetAndCount(size, 0, byteCount);
if (byteCount > Integer.MAX_VALUE) {
throw new IllegalArgumentException("byteCount > Integer.MAX_VALUE: " + byteCount);
}
byte[] result = new byte[(int) byteCount];
readFully(result);
return result;
}
@Override public int read(byte[] sink) {
return read(sink, 0, sink.length);
}
@Override public void readFully(byte[] sink) throws EOFException {
int offset = 0;
while (offset < sink.length) {
int read = read(sink, offset, sink.length - offset);
if (read == -1) throw new EOFException();
offset += read;
}
}
@Override public int read(byte[] sink, int offset, int byteCount) {
checkOffsetAndCount(sink.length, offset, byteCount);
Segment s = head;
if (s == null) return -1;
int toCopy = Math.min(byteCount, s.limit - s.pos);
System.arraycopy(s.data, s.pos, sink, offset, toCopy);
s.pos += toCopy;
size -= toCopy;
if (s.pos == s.limit) {
head = s.pop();
SegmentPool.recycle(s);
}
return toCopy;
}
@Override public int read(ByteBuffer sink) throws IOException {
Segment s = head;
if (s == null) return -1;
int toCopy = Math.min(sink.remaining(), s.limit - s.pos);
sink.put(s.data, s.pos, toCopy);
s.pos += toCopy;
size -= toCopy;
if (s.pos == s.limit) {
head = s.pop();
SegmentPool.recycle(s);
}
return toCopy;
}
/**
* Discards all bytes in this buffer. Calling this method when you're done
* with a buffer will return its segments to the pool.
*/
public final void clear() {
try {
skip(size);
} catch (EOFException e) {
throw new AssertionError(e);
}
}
/** Discards {@code byteCount} bytes from the head of this buffer. */
@Override public void skip(long byteCount) throws EOFException {
while (byteCount > 0) {
if (head == null) throw new EOFException();
int toSkip = (int) Math.min(byteCount, head.limit - head.pos);
size -= toSkip;
byteCount -= toSkip;
head.pos += toSkip;
if (head.pos == head.limit) {
Segment toRecycle = head;
head = toRecycle.pop();
SegmentPool.recycle(toRecycle);
}
}
}
@Override public Buffer write(ByteString byteString) {
if (byteString == null) throw new IllegalArgumentException("byteString == null");
byteString.write(this);
return this;
}
@Override public Buffer writeUtf8(String string) {
return writeUtf8(string, 0, string.length());
}
@Override public Buffer writeUtf8(String string, int beginIndex, int endIndex) {
if (string == null) throw new IllegalArgumentException("string == null");
if (beginIndex < 0) throw new IllegalArgumentException("beginIndex < 0: " + beginIndex);
if (endIndex < beginIndex) {
throw new IllegalArgumentException("endIndex < beginIndex: " + endIndex + " < " + beginIndex);
}
if (endIndex > string.length()) {
throw new IllegalArgumentException(
"endIndex > string.length: " + endIndex + " > " + string.length());
}
// Transcode a UTF-16 Java String to UTF-8 bytes.
for (int i = beginIndex; i < endIndex;) {
int c = string.charAt(i);
if (c < 0x80) {
Segment tail = writableSegment(1);
byte[] data = tail.data;
int segmentOffset = tail.limit - i;
int runLimit = Math.min(endIndex, Segment.SIZE - segmentOffset);
// Emit a 7-bit character with 1 byte.
data[segmentOffset + i++] = (byte) c; // 0xxxxxxx
// Fast-path contiguous runs of ASCII characters. This is ugly, but yields a ~4x performance
// improvement over independent calls to writeByte().
while (i < runLimit) {
c = string.charAt(i);
if (c >= 0x80) break;
data[segmentOffset + i++] = (byte) c; // 0xxxxxxx
}
int runSize = i + segmentOffset - tail.limit; // Equivalent to i - (previous i).
tail.limit += runSize;
size += runSize;
} else if (c < 0x800) {
// Emit a 11-bit character with 2 bytes.
writeByte(c >> 6 | 0xc0); // 110xxxxx
writeByte(c & 0x3f | 0x80); // 10xxxxxx
i++;
} else if (c < 0xd800 || c > 0xdfff) {
// Emit a 16-bit character with 3 bytes.
writeByte(c >> 12 | 0xe0); // 1110xxxx
writeByte(c >> 6 & 0x3f | 0x80); // 10xxxxxx
writeByte(c & 0x3f | 0x80); // 10xxxxxx
i++;
} else {
// c is a surrogate. Make sure it is a high surrogate & that its successor is a low
// surrogate. If not, the UTF-16 is invalid, in which case we emit a replacement character.
int low = i + 1 < endIndex ? string.charAt(i + 1) : 0;
if (c > 0xdbff || low < 0xdc00 || low > 0xdfff) {
writeByte('?');
i++;
continue;
}
// UTF-16 high surrogate: 110110xxxxxxxxxx (10 bits)
// UTF-16 low surrogate: 110111yyyyyyyyyy (10 bits)
// Unicode code point: 00010000000000000000 + xxxxxxxxxxyyyyyyyyyy (21 bits)
int codePoint = 0x010000 + ((c & ~0xd800) << 10 | low & ~0xdc00);
// Emit a 21-bit character with 4 bytes.
writeByte(codePoint >> 18 | 0xf0); // 11110xxx
writeByte(codePoint >> 12 & 0x3f | 0x80); // 10xxxxxx
writeByte(codePoint >> 6 & 0x3f | 0x80); // 10xxyyyy
writeByte(codePoint & 0x3f | 0x80); // 10yyyyyy
i += 2;
}
}
return this;
}
@Override public Buffer writeUtf8CodePoint(int codePoint) {
if (codePoint < 0x80) {
// Emit a 7-bit code point with 1 byte.
writeByte(codePoint);
} else if (codePoint < 0x800) {
// Emit a 11-bit code point with 2 bytes.
writeByte(codePoint >> 6 | 0xc0); // 110xxxxx
writeByte(codePoint & 0x3f | 0x80); // 10xxxxxx
} else if (codePoint < 0x10000) {
if (codePoint >= 0xd800 && codePoint <= 0xdfff) {
// Emit a replacement character for a partial surrogate.
writeByte('?');
} else {
// Emit a 16-bit code point with 3 bytes.
writeByte(codePoint >> 12 | 0xe0); // 1110xxxx
writeByte(codePoint >> 6 & 0x3f | 0x80); // 10xxxxxx
writeByte(codePoint & 0x3f | 0x80); // 10xxxxxx
}
} else if (codePoint <= 0x10ffff) {
// Emit a 21-bit code point with 4 bytes.
writeByte(codePoint >> 18 | 0xf0); // 11110xxx
writeByte(codePoint >> 12 & 0x3f | 0x80); // 10xxxxxx
writeByte(codePoint >> 6 & 0x3f | 0x80); // 10xxxxxx
writeByte(codePoint & 0x3f | 0x80); // 10xxxxxx
} else {
throw new IllegalArgumentException(
"Unexpected code point: " + Integer.toHexString(codePoint));
}
return this;
}
@Override public Buffer writeString(String string, Charset charset) {
return writeString(string, 0, string.length(), charset);
}
@Override
public Buffer writeString(String string, int beginIndex, int endIndex, Charset charset) {
if (string == null) throw new IllegalArgumentException("string == null");
if (beginIndex < 0) throw new IllegalAccessError("beginIndex < 0: " + beginIndex);
if (endIndex < beginIndex) {
throw new IllegalArgumentException("endIndex < beginIndex: " + endIndex + " < " + beginIndex);
}
if (endIndex > string.length()) {
throw new IllegalArgumentException(
"endIndex > string.length: " + endIndex + " > " + string.length());
}
if (charset == null) throw new IllegalArgumentException("charset == null");
if (charset.equals(Util.UTF_8)) return writeUtf8(string, beginIndex, endIndex);
byte[] data = string.substring(beginIndex, endIndex).getBytes(charset);
return write(data, 0, data.length);
}
@Override public Buffer write(byte[] source) {
if (source == null) throw new IllegalArgumentException("source == null");
return write(source, 0, source.length);
}
@Override public Buffer write(byte[] source, int offset, int byteCount) {
if (source == null) throw new IllegalArgumentException("source == null");
checkOffsetAndCount(source.length, offset, byteCount);
int limit = offset + byteCount;
while (offset < limit) {
Segment tail = writableSegment(1);
int toCopy = Math.min(limit - offset, Segment.SIZE - tail.limit);
System.arraycopy(source, offset, tail.data, tail.limit, toCopy);
offset += toCopy;
tail.limit += toCopy;
}
size += byteCount;
return this;
}
@Override public int write(ByteBuffer source) throws IOException {
if (source == null) throw new IllegalArgumentException("source == null");
int byteCount = source.remaining();
int remaining = byteCount;
while (remaining > 0) {
Segment tail = writableSegment(1);
int toCopy = Math.min(remaining, Segment.SIZE - tail.limit);
source.get(tail.data, tail.limit, toCopy);
remaining -= toCopy;
tail.limit += toCopy;
}
size += byteCount;
return byteCount;
}
@Override public long writeAll(Source source) throws IOException {
if (source == null) throw new IllegalArgumentException("source == null");
long totalBytesRead = 0;
for (long readCount; (readCount = source.read(this, Segment.SIZE)) != -1; ) {
totalBytesRead += readCount;
}
return totalBytesRead;
}
@Override public BufferedSink write(Source source, long byteCount) throws IOException {
while (byteCount > 0) {
long read = source.read(this, byteCount);
if (read == -1) throw new EOFException();
byteCount -= read;
}
return this;
}
@Override public Buffer writeByte(int b) {
Segment tail = writableSegment(1);
tail.data[tail.limit++] = (byte) b;
size += 1;
return this;
}
@Override public Buffer writeShort(int s) {
Segment tail = writableSegment(2);
byte[] data = tail.data;
int limit = tail.limit;
data[limit++] = (byte) ((s >>> 8) & 0xff);
data[limit++] = (byte) (s & 0xff);
tail.limit = limit;
size += 2;
return this;
}
@Override public Buffer writeShortLe(int s) {
return writeShort(Util.reverseBytesShort((short) s));
}
@Override public Buffer writeInt(int i) {
Segment tail = writableSegment(4);
byte[] data = tail.data;
int limit = tail.limit;
data[limit++] = (byte) ((i >>> 24) & 0xff);
data[limit++] = (byte) ((i >>> 16) & 0xff);
data[limit++] = (byte) ((i >>> 8) & 0xff);
data[limit++] = (byte) (i & 0xff);
tail.limit = limit;
size += 4;
return this;
}
@Override public Buffer writeIntLe(int i) {
return writeInt(Util.reverseBytesInt(i));
}
@Override public Buffer writeLong(long v) {
Segment tail = writableSegment(8);
byte[] data = tail.data;
int limit = tail.limit;
data[limit++] = (byte) ((v >>> 56L) & 0xff);
data[limit++] = (byte) ((v >>> 48L) & 0xff);
data[limit++] = (byte) ((v >>> 40L) & 0xff);
data[limit++] = (byte) ((v >>> 32L) & 0xff);
data[limit++] = (byte) ((v >>> 24L) & 0xff);
data[limit++] = (byte) ((v >>> 16L) & 0xff);
data[limit++] = (byte) ((v >>> 8L) & 0xff);
data[limit++] = (byte) (v & 0xff);
tail.limit = limit;
size += 8;
return this;
}
@Override public Buffer writeLongLe(long v) {
return writeLong(reverseBytesLong(v));
}
@Override public Buffer writeDecimalLong(long v) {
if (v == 0) {
// Both a shortcut and required since the following code can't handle zero.
return writeByte('0');
}
boolean negative = false;
if (v < 0) {
v = -v;
if (v < 0) { // Only true for Long.MIN_VALUE.
return writeUtf8("-9223372036854775808");
}
negative = true;
}
// Binary search for character width which favors matching lower numbers.
int width = //
v < 100000000L
? v < 10000L
? v < 100L
? v < 10L ? 1 : 2
: v < 1000L ? 3 : 4
: v < 1000000L
? v < 100000L ? 5 : 6
: v < 10000000L ? 7 : 8
: v < 1000000000000L
? v < 10000000000L
? v < 1000000000L ? 9 : 10
: v < 100000000000L ? 11 : 12
: v < 1000000000000000L
? v < 10000000000000L ? 13
: v < 100000000000000L ? 14 : 15
: v < 100000000000000000L
? v < 10000000000000000L ? 16 : 17
: v < 1000000000000000000L ? 18 : 19;
if (negative) {
++width;
}
Segment tail = writableSegment(width);
byte[] data = tail.data;
int pos = tail.limit + width; // We write backwards from right to left.
while (v != 0) {
int digit = (int) (v % 10);
data[--pos] = DIGITS[digit];
v /= 10;
}
if (negative) {
data[--pos] = '-';
}
tail.limit += width;
this.size += width;
return this;
}
@Override public Buffer writeHexadecimalUnsignedLong(long v) {
if (v == 0) {
// Both a shortcut and required since the following code can't handle zero.
return writeByte('0');
}
int width = Long.numberOfTrailingZeros(Long.highestOneBit(v)) / 4 + 1;
Segment tail = writableSegment(width);
byte[] data = tail.data;
for (int pos = tail.limit + width - 1, start = tail.limit; pos >= start; pos--) {
data[pos] = DIGITS[(int) (v & 0xF)];
v >>>= 4;
}
tail.limit += width;
size += width;
return this;
}
/**
* Returns a tail segment that we can write at least {@code minimumCapacity}
* bytes to, creating it if necessary.
*/
Segment writableSegment(int minimumCapacity) {
if (minimumCapacity < 1 || minimumCapacity > Segment.SIZE) throw new IllegalArgumentException();
if (head == null) {
head = SegmentPool.take(); // Acquire a first segment.
return head.next = head.prev = head;
}
Segment tail = head.prev;
if (tail.limit + minimumCapacity > Segment.SIZE || !tail.owner) {
tail = tail.push(SegmentPool.take()); // Append a new empty segment to fill up.
}
return tail;
}
@Override public void write(Buffer source, long byteCount) {
// Move bytes from the head of the source buffer to the tail of this buffer
// while balancing two conflicting goals: don't waste CPU and don't waste
// memory.
//
//
// Don't waste CPU (ie. don't copy data around).
//
// Copying large amounts of data is expensive. Instead, we prefer to
// reassign entire segments from one buffer to the other.
//
//
// Don't waste memory.
//
// As an invariant, adjacent pairs of segments in a buffer should be at
// least 50% full, except for the head segment and the tail segment.
//
// The head segment cannot maintain the invariant because the application is
// consuming bytes from this segment, decreasing its level.
//
// The tail segment cannot maintain the invariant because the application is
// producing bytes, which may require new nearly-empty tail segments to be
// appended.
//
//
// Moving segments between buffers
//
// When writing one buffer to another, we prefer to reassign entire segments
// over copying bytes into their most compact form. Suppose we have a buffer
// with these segment levels [91%, 61%]. If we append a buffer with a
// single [72%] segment, that yields [91%, 61%, 72%]. No bytes are copied.
//
// Or suppose we have a buffer with these segment levels: [100%, 2%], and we
// want to append it to a buffer with these segment levels [99%, 3%]. This
// operation will yield the following segments: [100%, 2%, 99%, 3%]. That
// is, we do not spend time copying bytes around to achieve more efficient
// memory use like [100%, 100%, 4%].
//
// When combining buffers, we will compact adjacent buffers when their
// combined level doesn't exceed 100%. For example, when we start with
// [100%, 40%] and append [30%, 80%], the result is [100%, 70%, 80%].
//
//
// Splitting segments
//
// Occasionally we write only part of a source buffer to a sink buffer. For
// example, given a sink [51%, 91%], we may want to write the first 30% of
// a source [92%, 82%] to it. To simplify, we first transform the source to
// an equivalent buffer [30%, 62%, 82%] and then move the head segment,
// yielding sink [51%, 91%, 30%] and source [62%, 82%].
if (source == null) throw new IllegalArgumentException("source == null");
if (source == this) throw new IllegalArgumentException("source == this");
checkOffsetAndCount(source.size, 0, byteCount);
while (byteCount > 0) {
// Is a prefix of the source's head segment all that we need to move?
if (byteCount < (source.head.limit - source.head.pos)) {
Segment tail = head != null ? head.prev : null;
if (tail != null && tail.owner
&& (byteCount + tail.limit - (tail.shared ? 0 : tail.pos) <= Segment.SIZE)) {
// Our existing segments are sufficient. Move bytes from source's head to our tail.
source.head.writeTo(tail, (int) byteCount);
source.size -= byteCount;
size += byteCount;
return;
} else {
// We're going to need another segment. Split the source's head
// segment in two, then move the first of those two to this buffer.
source.head = source.head.split((int) byteCount);
}
}
// Remove the source's head segment and append it to our tail.
Segment segmentToMove = source.head;
long movedByteCount = segmentToMove.limit - segmentToMove.pos;
source.head = segmentToMove.pop();
if (head == null) {
head = segmentToMove;
head.next = head.prev = head;
} else {
Segment tail = head.prev;
tail = tail.push(segmentToMove);
tail.compact();
}
source.size -= movedByteCount;
size += movedByteCount;
byteCount -= movedByteCount;
}
}
@Override public long read(Buffer sink, long byteCount) {
if (sink == null) throw new IllegalArgumentException("sink == null");
if (byteCount < 0) throw new IllegalArgumentException("byteCount < 0: " + byteCount);
if (size == 0) return -1L;
if (byteCount > size) byteCount = size;
sink.write(this, byteCount);
return byteCount;
}
@Override public long indexOf(byte b) {
return indexOf(b, 0, Long.MAX_VALUE);
}
/**
* Returns the index of {@code b} in this at or beyond {@code fromIndex}, or
* -1 if this buffer does not contain {@code b} in that range.
*/
@Override public long indexOf(byte b, long fromIndex) {
return indexOf(b, fromIndex, Long.MAX_VALUE);
}
@Override public long indexOf(byte b, long fromIndex, long toIndex) {
if (fromIndex < 0 || toIndex < fromIndex) {
throw new IllegalArgumentException(
String.format("size=%s fromIndex=%s toIndex=%s", size, fromIndex, toIndex));
}
if (toIndex > size) toIndex = size;
if (fromIndex == toIndex) return -1L;
Segment s;
long offset;
// TODO(jwilson): extract this to a shared helper method when can do so without allocating.
findSegmentAndOffset: {
// Pick the first segment to scan. This is the first segment with offset <= fromIndex.
s = head;
if (s == null) {
// No segments to scan!
return -1L;
} else if (size - fromIndex < fromIndex) {
// We're scanning in the back half of this buffer. Find the segment starting at the back.
offset = size;
while (offset > fromIndex) {
s = s.prev;
offset -= (s.limit - s.pos);
}
} else {
// We're scanning in the front half of this buffer. Find the segment starting at the front.
offset = 0L;
for (long nextOffset; (nextOffset = offset + (s.limit - s.pos)) < fromIndex; ) {
s = s.next;
offset = nextOffset;
}
}
}
// Scan through the segments, searching for b.
while (offset < toIndex) {
byte[] data = s.data;
int limit = (int) Math.min(s.limit, s.pos + toIndex - offset);
int pos = (int) (s.pos + fromIndex - offset);
for (; pos < limit; pos++) {
if (data[pos] == b) {
return pos - s.pos + offset;
}
}
// Not in this segment. Try the next one.
offset += (s.limit - s.pos);
fromIndex = offset;
s = s.next;
}
return -1L;
}
@Override public long indexOf(ByteString bytes) throws IOException {
return indexOf(bytes, 0);
}
@Override public long indexOf(ByteString bytes, long fromIndex) throws IOException {
if (bytes.size() == 0) throw new IllegalArgumentException("bytes is empty");
if (fromIndex < 0) throw new IllegalArgumentException("fromIndex < 0");
Segment s;
long offset;
// TODO(jwilson): extract this to a shared helper method when can do so without allocating.
findSegmentAndOffset: {
// Pick the first segment to scan. This is the first segment with offset <= fromIndex.
s = head;
if (s == null) {
// No segments to scan!
return -1L;
} else if (size - fromIndex < fromIndex) {
// We're scanning in the back half of this buffer. Find the segment starting at the back.
offset = size;
while (offset > fromIndex) {
s = s.prev;
offset -= (s.limit - s.pos);
}
} else {
// We're scanning in the front half of this buffer. Find the segment starting at the front.
offset = 0L;
for (long nextOffset; (nextOffset = offset + (s.limit - s.pos)) < fromIndex; ) {
s = s.next;
offset = nextOffset;
}
}
}
// Scan through the segments, searching for the lead byte. Each time that is found, delegate to
// rangeEquals() to check for a complete match.
byte b0 = bytes.getByte(0);
int bytesSize = bytes.size();
long resultLimit = size - bytesSize + 1;
while (offset < resultLimit) {
// Scan through the current segment.
byte[] data = s.data;
int segmentLimit = (int) Math.min(s.limit, s.pos + resultLimit - offset);
for (int pos = (int) (s.pos + fromIndex - offset); pos < segmentLimit; pos++) {
if (data[pos] == b0 && rangeEquals(s, pos + 1, bytes, 1, bytesSize)) {
return pos - s.pos + offset;
}
}
// Not in this segment. Try the next one.
offset += (s.limit - s.pos);
fromIndex = offset;
s = s.next;
}
return -1L;
}
@Override public long indexOfElement(ByteString targetBytes) {
return indexOfElement(targetBytes, 0);
}
@Override public long indexOfElement(ByteString targetBytes, long fromIndex) {
if (fromIndex < 0) throw new IllegalArgumentException("fromIndex < 0");
Segment s;
long offset;
// TODO(jwilson): extract this to a shared helper method when can do so without allocating.
findSegmentAndOffset: {
// Pick the first segment to scan. This is the first segment with offset <= fromIndex.
s = head;
if (s == null) {
// No segments to scan!
return -1L;
} else if (size - fromIndex < fromIndex) {
// We're scanning in the back half of this buffer. Find the segment starting at the back.
offset = size;
while (offset > fromIndex) {
s = s.prev;
offset -= (s.limit - s.pos);
}
} else {
// We're scanning in the front half of this buffer. Find the segment starting at the front.
offset = 0L;
for (long nextOffset; (nextOffset = offset + (s.limit - s.pos)) < fromIndex; ) {
s = s.next;
offset = nextOffset;
}
}
}
// Special case searching for one of two bytes. This is a common case for tools like Moshi,
// which search for pairs of chars like `\r` and `\n` or {@code `"` and `\`. The impact of this
// optimization is a ~5x speedup for this case without a substantial cost to other cases.
if (targetBytes.size() == 2) {
// Scan through the segments, searching for either of the two bytes.
byte b0 = targetBytes.getByte(0);
byte b1 = targetBytes.getByte(1);
while (offset < size) {
byte[] data = s.data;
for (int pos = (int) (s.pos + fromIndex - offset), limit = s.limit; pos < limit; pos++) {
int b = data[pos];
if (b == b0 || b == b1) {
return pos - s.pos + offset;
}
}
// Not in this segment. Try the next one.
offset += (s.limit - s.pos);
fromIndex = offset;
s = s.next;
}
} else {
// Scan through the segments, searching for a byte that's also in the array.
byte[] targetByteArray = targetBytes.internalArray();
while (offset < size) {
byte[] data = s.data;
for (int pos = (int) (s.pos + fromIndex - offset), limit = s.limit; pos < limit; pos++) {
int b = data[pos];
for (byte t : targetByteArray) {
if (b == t) return pos - s.pos + offset;
}
}
// Not in this segment. Try the next one.
offset += (s.limit - s.pos);
fromIndex = offset;
s = s.next;
}
}
return -1L;
}
@Override public boolean rangeEquals(long offset, ByteString bytes) {
return rangeEquals(offset, bytes, 0, bytes.size());
}
@Override public boolean rangeEquals(
long offset, ByteString bytes, int bytesOffset, int byteCount) {
if (offset < 0
|| bytesOffset < 0
|| byteCount < 0
|| size - offset < byteCount
|| bytes.size() - bytesOffset < byteCount) {
return false;
}
for (int i = 0; i < byteCount; i++) {
if (getByte(offset + i) != bytes.getByte(bytesOffset + i)) {
return false;
}
}
return true;
}
/**
* Returns true if the range within this buffer starting at {@code segmentPos} in {@code segment}
* is equal to {@code bytes[bytesOffset..bytesLimit)}.
*/
private boolean rangeEquals(
Segment segment, int segmentPos, ByteString bytes, int bytesOffset, int bytesLimit) {
int segmentLimit = segment.limit;
byte[] data = segment.data;
for (int i = bytesOffset; i < bytesLimit; ) {
if (segmentPos == segmentLimit) {
segment = segment.next;
data = segment.data;
segmentPos = segment.pos;
segmentLimit = segment.limit;
}
if (data[segmentPos] != bytes.getByte(i)) {
return false;
}
segmentPos++;
i++;
}
return true;
}
@Override public void flush() {
}
@Override public boolean isOpen() {
return true;
}
@Override public void close() {
}
@Override public Timeout timeout() {
return Timeout.NONE;
}
/** For testing. This returns the sizes of the segments in this buffer. */
List segmentSizes() {
if (head == null) return Collections.emptyList();
List result = new ArrayList<>();
result.add(head.limit - head.pos);
for (Segment s = head.next; s != head; s = s.next) {
result.add(s.limit - s.pos);
}
return result;
}
/** Returns the 128-bit MD5 hash of this buffer. */
public final ByteString md5() {
return digest("MD5");
}
/** Returns the 160-bit SHA-1 hash of this buffer. */
public final ByteString sha1() {
return digest("SHA-1");
}
/** Returns the 256-bit SHA-256 hash of this buffer. */
public final ByteString sha256() {
return digest("SHA-256");
}
/** Returns the 512-bit SHA-512 hash of this buffer. */
public final ByteString sha512() {
return digest("SHA-512");
}
private ByteString digest(String algorithm) {
try {
MessageDigest messageDigest = MessageDigest.getInstance(algorithm);
if (head != null) {
messageDigest.update(head.data, head.pos, head.limit - head.pos);
for (Segment s = head.next; s != head; s = s.next) {
messageDigest.update(s.data, s.pos, s.limit - s.pos);
}
}
return ByteString.of(messageDigest.digest());
} catch (NoSuchAlgorithmException e) {
throw new AssertionError();
}
}
/** Returns the 160-bit SHA-1 HMAC of this buffer. */
public final ByteString hmacSha1(ByteString key) {
return hmac("HmacSHA1", key);
}
/** Returns the 256-bit SHA-256 HMAC of this buffer. */
public final ByteString hmacSha256(ByteString key) {
return hmac("HmacSHA256", key);
}
/** Returns the 512-bit SHA-512 HMAC of this buffer. */
public final ByteString hmacSha512(ByteString key) {
return hmac("HmacSHA512", key);
}
private ByteString hmac(String algorithm, ByteString key) {
try {
Mac mac = Mac.getInstance(algorithm);
mac.init(new SecretKeySpec(key.toByteArray(), algorithm));
if (head != null) {
mac.update(head.data, head.pos, head.limit - head.pos);
for (Segment s = head.next; s != head; s = s.next) {
mac.update(s.data, s.pos, s.limit - s.pos);
}
}
return ByteString.of(mac.doFinal());
} catch (NoSuchAlgorithmException e) {
throw new AssertionError();
} catch (InvalidKeyException e) {
throw new IllegalArgumentException(e);
}
}
@Override public boolean equals(Object o) {
if (this == o) return true;
if (!(o instanceof Buffer)) return false;
Buffer that = (Buffer) o;
if (size != that.size) return false;
if (size == 0) return true; // Both buffers are empty.
Segment sa = this.head;
Segment sb = that.head;
int posA = sa.pos;
int posB = sb.pos;
for (long pos = 0, count; pos < size; pos += count) {
count = Math.min(sa.limit - posA, sb.limit - posB);
for (int i = 0; i < count; i++) {
if (sa.data[posA++] != sb.data[posB++]) return false;
}
if (posA == sa.limit) {
sa = sa.next;
posA = sa.pos;
}
if (posB == sb.limit) {
sb = sb.next;
posB = sb.pos;
}
}
return true;
}
@Override public int hashCode() {
Segment s = head;
if (s == null) return 0;
int result = 1;
do {
for (int pos = s.pos, limit = s.limit; pos < limit; pos++) {
result = 31 * result + s.data[pos];
}
s = s.next;
} while (s != head);
return result;
}
/**
* Returns a human-readable string that describes the contents of this buffer. Typically this
* is a string like {@code [text=Hello]} or {@code [hex=0000ffff]}.
*/
@Override public String toString() {
return snapshot().toString();
}
/** Returns a deep copy of this buffer. */
@Override public Buffer clone() {
Buffer result = new Buffer();
if (size == 0) return result;
result.head = head.sharedCopy();
result.head.next = result.head.prev = result.head;
for (Segment s = head.next; s != head; s = s.next) {
result.head.prev.push(s.sharedCopy());
}
result.size = size;
return result;
}
/** Returns an immutable copy of this buffer as a byte string. */
public final ByteString snapshot() {
if (size > Integer.MAX_VALUE) {
throw new IllegalArgumentException("size > Integer.MAX_VALUE: " + size);
}
return snapshot((int) size);
}
/**
* Returns an immutable copy of the first {@code byteCount} bytes of this buffer as a byte string.
*/
public final ByteString snapshot(int byteCount) {
if (byteCount == 0) return ByteString.EMPTY;
return new SegmentedByteString(this, byteCount);
}
public final UnsafeCursor readUnsafe() {
return readUnsafe(new UnsafeCursor());
}
public final UnsafeCursor readUnsafe(UnsafeCursor unsafeCursor) {
if (unsafeCursor.buffer != null) {
throw new IllegalStateException("already attached to a buffer");
}
unsafeCursor.buffer = this;
unsafeCursor.readWrite = false;
return unsafeCursor;
}
public final UnsafeCursor readAndWriteUnsafe() {
return readAndWriteUnsafe(new UnsafeCursor());
}
public final UnsafeCursor readAndWriteUnsafe(UnsafeCursor unsafeCursor) {
if (unsafeCursor.buffer != null) {
throw new IllegalStateException("already attached to a buffer");
}
unsafeCursor.buffer = this;
unsafeCursor.readWrite = true;
return unsafeCursor;
}
/**
* A handle to the underlying data in a buffer. This handle is unsafe because it does not enforce
* its own invariants. Instead, it assumes a careful user who has studied Okio's implementation
* details and their consequences.
*
* Buffer Internals
*
* Most code should use {@code Buffer} as a black box: a class that holds 0 or more bytes of
* data with efficient APIs to append data to the end and to consume data from the front. Usually
* this is also the most efficient way to use buffers because it allows Okio to employ several
* optimizations, including:
*
*
* - Fast Allocation: Buffers use a shared pool of memory that is not
* zero-filled before use.
*
- Fast Resize: A buffer's capacity can change without copying its
* contents.
*
- Fast Move: Memory ownership can be reassigned from one buffer to
* another.
*
- Fast Copy: Multiple buffers can share the same underlying memory.
*
- Fast Encoding and Decoding: Common operations like UTF-8 encoding and
* decimal decoding do not require intermediate objects to be allocated.
*
*
* These optimizations all leverage the way Okio stores data internally. Okio Buffers are
* implemented using a doubly-linked list of segments. Each segment is a contiguous range within a
* 8 KiB {@code byte[]}. Each segment has two indexes, {@code start}, the offset of the first
* byte of the array containing application data, and {@code end}, the offset of the first byte
* beyond {@code start} whose data is undefined.
*
*
New buffers are empty and have no segments:
*
*
{@code
*
* Buffer buffer = new Buffer();
* }
*
* We append 7 bytes of data to the end of our empty buffer. Internally, the buffer allocates a
* segment and writes its new data there. The lone segment has an 8 KiB byte array but only 7
* bytes of data:
*
* {@code
*
* buffer.writeUtf8("sealion");
*
* // [ 's', 'e', 'a', 'l', 'i', 'o', 'n', '?', '?', '?', ...]
* // ^ ^
* // start = 0 end = 7
* }
*
* When we read 4 bytes of data from the buffer, it finds its first segment and returns that data
* to us. As bytes are read the data is consumed. The segment tracks this by adjusting its
* internal indices.
*
* {@code
*
* buffer.readUtf8(4); // "seal"
*
* // [ 's', 'e', 'a', 'l', 'i', 'o', 'n', '?', '?', '?', ...]
* // ^ ^
* // start = 4 end = 7
* }
*
* As we write data into a buffer we fill up its internal segments. When a write doesn't fit into
* a buffer's last segment, additional segments are allocated and appended to the linked list of
* segments. Each segment has its own start and end indexes tracking where the user's data begins
* and ends.
*
* {@code
*
* Buffer xoxo = new Buffer();
* xoxo.writeUtf8(Strings.repeat("xo", 5_000));
*
* // [ 'x', 'o', 'x', 'o', 'x', 'o', 'x', 'o', ..., 'x', 'o', 'x', 'o']
* // ^ ^
* // start = 0 end = 8192
* //
* // [ 'x', 'o', 'x', 'o', ..., 'x', 'o', 'x', 'o', '?', '?', '?', ...]
* // ^ ^
* // start = 0 end = 1808
* }
*
* The start index is always inclusive and the end index is always
* exclusive. The data preceding the start index is undefined, and the data
* at and following the end index is undefined.
*
* After the last byte of a segment has been read, that segment may be returned to an internal
* segment pool. In addition to reducing the need to do garbage collection, segment pooling also
* saves the JVM from needing to zero-fill byte arrays. Okio doesn't need to zero-fill its arrays
* because it always writes memory before it reads it. But if you look at a segment in a debugger
* you may see its effects. In this example, one of the "xoxo" segments above is reused in an
* unrelated buffer:
*
*
{@code
*
* Buffer abc = new Buffer();
* abc.writeUtf8("abc");
*
* // [ 'a', 'b', 'c', 'o', 'x', 'o', 'x', 'o', ...]
* // ^ ^
* // start = 0 end = 3
* }
*
* There is an optimization in {@code Buffer.clone()} and other methods that allows two segments
* to share the same underlying byte array. Clones can't write to the shared byte array; instead
* they allocate a new (private) segment early.
*
* {@code
*
* Buffer nana = new Buffer();
* nana.writeUtf8(Strings.repeat("na", 2_500));
* nana.readUtf8(2); // "na"
*
* // [ 'n', 'a', 'n', 'a', ..., 'n', 'a', 'n', 'a', '?', '?', '?', ...]
* // ^ ^
* // start = 0 end = 5000
*
* nana2 = nana.clone();
* nana2.writeUtf8("batman");
*
* // [ 'n', 'a', 'n', 'a', ..., 'n', 'a', 'n', 'a', '?', '?', '?', ...]
* // ^ ^
* // start = 0 end = 5000
* //
* // [ 'b', 'a', 't', 'm', 'a', 'n', '?', '?', '?', ...]
* // ^ ^
* // start = 0 end = 7
* }
*
* Segments are not shared when the shared region is small (ie. less than 1 KiB). This is intended
* to prevent fragmentation in sharing-heavy use cases.
*
* Unsafe Cursor API
*
* This class exposes privileged access to the internal byte arrays of a buffer. A cursor
* either references the data of a single segment, it is before the first segment ({@code
* offset == -1}), or it is after the last segment ({@code offset == buffer.size}).
*
*
Call {@link #seek} to move the cursor to the segment that contains a specified offset. After
* seeking, {@link #data} references the segment's internal byte array, {@link #start} is the
* segment's start and {@link #end} is its end.
*
*
Call {@link #next} to advance the cursor to the next segment. This returns -1 if there are
* no further segments in the buffer.
*
*
Use {@link Buffer#readUnsafe} to create a cursor to read buffer data and {@link
* Buffer#readAndWriteUnsafe} to create a cursor to read and write buffer data. In either case,
* always call {@link #close} when done with a cursor. This is convenient with Java 7's
* try-with-resources syntax. In this example we read all of the bytes in a buffer into a byte
* array:
*
*
{@code
*
* byte[] bufferBytes = new byte[(int) buffer.size()];
*
* try (UnsafeCursor cursor = buffer.readUnsafe()) {
* while (cursor.next() != -1) {
* System.arraycopy(cursor.data, cursor.start,
* bufferBytes, (int) cursor.offset, cursor.end - cursor.start);
* }
* }
* }
*
* Change the capacity of a buffer with {@link #resizeBuffer}. This is only permitted for
* read+write cursors. The buffer's size always changes from the end: shrinking it removes bytes
* from the end; growing it adds capacity to the end.
*
*
Warnings
*
* Most application developers should avoid this API. Those that must use this API should
* respect these warnings.
*
*
Don't mutate a cursor. This class has public, non-final fields because that
* is convenient for low-level I/O frameworks. Never assign values to these fields; instead use
* the cursor API to adjust these.
*
*
Never mutate {@code data} unless you have read+write access. You are on the
* honor system to never write the buffer in read-only mode. Read-only mode may be more efficient
* than read+write mode because it does not need to make private copies of shared segments.
*
*
Only access data in {@code [start..end)}. Other data in the byte array
* is undefined! It may contain private or sensitive data from other parts of your process.
*
*
Always fill the new capacity when you grow a buffer. New capacity is not
* zero-filled and may contain data from other parts of your process. Avoid leaking this
* information by always writing something to the newly-allocated capacity. Do not assume that
* new capacity will be filled with {@code 0}; it will not be.
*
*
Do not access a buffer while is being accessed by a cursor. Even simple
* read-only operations like {@link Buffer#clone} are unsafe because they mark segments as shared.
*
*
Do not hard-code the segment size in your application. It is possible that
* segment sizes will change with advances in hardware. Future versions of Okio may even have
* heterogeneous segment sizes.
*
*
These warnings are intended to help you to use this API safely. It's here for developers
* that need absolutely the most throughput. Since that's you, here's one final performance tip.
* You can reuse instances of this class if you like. Use the overloads of {@link #readUnsafe} and
* {@link #readAndWriteUnsafe} that take a cursor and close it after use.
*/
public static final class UnsafeCursor implements Closeable {
public Buffer buffer;
public boolean readWrite;
private Segment segment;
public long offset = -1L;
public byte[] data;
public int start = -1;
public int end = -1;
/**
* Seeks to the next range of bytes, advancing the offset by {@code end - start}. Returns the
* size of the readable range (at least 1), or -1 if we have reached the end of the buffer and
* there are no more bytes to read.
*/
public final int next() {
if (offset == buffer.size) throw new IllegalStateException();
if (offset == -1L) return seek(0L);
return seek(offset + (end - start));
}
/**
* Reposition the cursor so that the data at {@code offset} is readable at {@code data[start]}.
* Returns the number of bytes readable in {@code data} (at least 1), or -1 if there are no data
* to read.
*/
public final int seek(long offset) {
if (offset < -1 || offset > buffer.size) {
throw new ArrayIndexOutOfBoundsException(
String.format("offset=%s > size=%s", offset, buffer.size));
}
if (offset == -1 || offset == buffer.size) {
this.segment = null;
this.offset = offset;
this.data = null;
this.start = -1;
this.end = -1;
return -1;
}
// Navigate to the segment that contains `offset`. Start from our current segment if possible.
long min = 0L;
long max = buffer.size;
Segment head = buffer.head;
Segment tail = buffer.head;
if (this.segment != null) {
long segmentOffset = this.offset - (this.start - this.segment.pos);
if (segmentOffset > offset) {
// Set the cursor segment to be the 'end'
max = segmentOffset;
tail = this.segment;
} else {
// Set the cursor segment to be the 'beginning'
min = segmentOffset;
head = this.segment;
}
}
Segment next;
long nextOffset;
if (max - offset > offset - min) {
// Start at the 'beginning' and search forwards
next = head;
nextOffset = min;
while (offset >= nextOffset + (next.limit - next.pos)) {
nextOffset += (next.limit - next.pos);
next = next.next;
}
} else {
// Start at the 'end' and search backwards
next = tail;
nextOffset = max;
while (nextOffset > offset) {
next = next.prev;
nextOffset -= (next.limit - next.pos);
}
}
// If we're going to write and our segment is shared, swap it for a read-write one.
if (readWrite && next.shared) {
Segment unsharedNext = next.unsharedCopy();
if (buffer.head == next) {
buffer.head = unsharedNext;
}
next = next.push(unsharedNext);
next.prev.pop();
}
// Update this cursor to the requested offset within the found segment.
this.segment = next;
this.offset = offset;
this.data = next.data;
this.start = next.pos + (int) (offset - nextOffset);
this.end = next.limit;
return end - start;
}
/**
* Change the size of the buffer so that it equals {@code newSize} by either adding new
* capacity at the end or truncating the buffer at the end. Newly added capacity may span
* multiple segments.
*
*
As a side-effect this cursor will {@link #seek seek}. If the buffer is being enlarged it
* will move {@link #offset} to the first byte of newly-added capacity. This is the size of the
* buffer prior to the {@code resizeBuffer()} call. If the buffer is being shrunk it will move
* {@link #offset} to the end of the buffer.
*
*
Warning: it is the caller’s responsibility to write new data to every byte of the
* newly-allocated capacity. Failure to do so may cause serious security problems as the data
* in the returned buffers is not zero filled. Buffers may contain dirty pooled segments that
* hold very sensitive data from other parts of the current process.
*
* @return the previous size of the buffer.
*/
public final long resizeBuffer(long newSize) {
if (buffer == null) {
throw new IllegalStateException("not attached to a buffer");
}
if (!readWrite) {
throw new IllegalStateException("resizeBuffer() only permitted for read/write buffers");
}
long oldSize = buffer.size;
if (newSize <= oldSize) {
if (newSize < 0) {
throw new IllegalArgumentException("newSize < 0: " + newSize);
}
// Shrink the buffer by either shrinking segments or removing them.
for (long bytesToSubtract = oldSize - newSize; bytesToSubtract > 0; ) {
Segment tail = buffer.head.prev;
int tailSize = tail.limit - tail.pos;
if (tailSize <= bytesToSubtract) {
buffer.head = tail.pop();
SegmentPool.recycle(tail);
bytesToSubtract -= tailSize;
} else {
tail.limit -= bytesToSubtract;
break;
}
}
// Seek to the end.
this.segment = null;
this.offset = newSize;
this.data = null;
this.start = -1;
this.end = -1;
} else if (newSize > oldSize) {
// Enlarge the buffer by either enlarging segments or adding them.
boolean needsToSeek = true;
for (long bytesToAdd = newSize - oldSize; bytesToAdd > 0; ) {
Segment tail = buffer.writableSegment(1);
int segmentBytesToAdd = (int) Math.min(bytesToAdd, Segment.SIZE - tail.limit);
tail.limit += segmentBytesToAdd;
bytesToAdd -= segmentBytesToAdd;
// If this is the first segment we're adding, seek to it.
if (needsToSeek) {
this.segment = tail;
this.offset = oldSize;
this.data = tail.data;
this.start = tail.limit - segmentBytesToAdd;
this.end = tail.limit;
needsToSeek = false;
}
}
}
buffer.size = newSize;
return oldSize;
}
/**
* Grow the buffer by adding a contiguous range of capacity in a single
* segment. This adds at least {@code minByteCount} bytes but may add up to a full segment of
* additional capacity.
*
*
As a side-effect this cursor will {@link #seek seek}. It will move {@link #offset} to the
* first byte of newly-added capacity. This is the size of the buffer prior to the {@code
* expandBuffer()} call.
*
*
If {@code minByteCount} bytes are available in the buffer's current tail segment that will
* be used; otherwise another segment will be allocated and appended. In either case this
* returns the number of bytes of capacity added to this buffer.
*
*
Warning: it is the caller’s responsibility to either write new data to every byte of the
* newly-allocated capacity, or to {@link #resizeBuffer shrink} the buffer to the data written.
* Failure to do so may cause serious security problems as the data in the returned buffers is
* not zero filled. Buffers may contain dirty pooled segments that hold very sensitive data from
* other parts of the current process.
*
* @param minByteCount the size of the contiguous capacity. Must be positive and not greater
* than the capacity size of a single segment (8 KiB).
* @return the number of bytes expanded by. Not less than {@code minByteCount}.
*/
public final long expandBuffer(int minByteCount) {
if (minByteCount <= 0) {
throw new IllegalArgumentException("minByteCount <= 0: " + minByteCount);
}
if (minByteCount > Segment.SIZE) {
throw new IllegalArgumentException("minByteCount > Segment.SIZE: " + minByteCount);
}
if (buffer == null) {
throw new IllegalStateException("not attached to a buffer");
}
if (!readWrite) {
throw new IllegalStateException("expandBuffer() only permitted for read/write buffers");
}
long oldSize = buffer.size;
Segment tail = buffer.writableSegment(minByteCount);
int result = Segment.SIZE - tail.limit;
tail.limit = Segment.SIZE;
buffer.size = oldSize + result;
// Seek to the old size.
this.segment = tail;
this.offset = oldSize;
this.data = tail.data;
this.start = Segment.SIZE - result;
this.end = Segment.SIZE;
return result;
}
@Override public void close() {
// TODO(jwilson): use edit counts or other information to track unexpected changes?
if (buffer == null) {
throw new IllegalStateException("not attached to a buffer");
}
buffer = null;
segment = null;
offset = -1L;
data = null;
start = -1;
end = -1;
}
}
}