Chiebot-Mirror
/
protobuf
8
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve performance of parsing unknown fields in Java (#9371)

Browse Source 
Credit should go to @elharo for most of these Java changes--I am just
cherry-picking them from our internal codebase. The one thing I did
change was to give the UTF-8 validation tests their own Bazel test
target. This makes it possible to give the other tests a shorter
timeout, which is important for UnknownFieldSetPerformanceTest in
particular.
pull/10217/head
Adam Cozzette 3 years ago
parent 0e02f95b87
commit 9638a5e531
6 changed files with 499 additions and 214 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 1
      Makefile.am
  2. 24
      java/core/BUILD
  3. 427
      java/core/src/main/java/com/google/protobuf/UnknownFieldSet.java
  4. 78
      java/core/src/test/java/com/google/protobuf/UnknownFieldSetPerformanceTest.java
  5. 182
      java/core/src/test/java/com/google/protobuf/UnknownFieldSetTest.java
  6. 1
      java/lite/pom.xml

1
Makefile.am
Unescape View File

@ -493,6 +493,7 @@ java_EXTRA_DIST=
java/core/src/test/java/com/google/protobuf/TypeRegistryTest.java \ java/core/src/test/java/com/google/protobuf/TypeRegistryTest.java \
java/core/src/test/java/com/google/protobuf/UnknownEnumValueTest.java \ java/core/src/test/java/com/google/protobuf/UnknownEnumValueTest.java \
java/core/src/test/java/com/google/protobuf/UnknownFieldSetTest.java \ java/core/src/test/java/com/google/protobuf/UnknownFieldSetTest.java \
java/core/src/test/java/com/google/protobuf/UnknownFieldSetPerformanceTest.java \
java/core/src/test/java/com/google/protobuf/UnmodifiableLazyStringListTest.java \ java/core/src/test/java/com/google/protobuf/UnmodifiableLazyStringListTest.java \
java/core/src/test/java/com/google/protobuf/Utf8Test.java \ java/core/src/test/java/com/google/protobuf/Utf8Test.java \
java/core/src/test/java/com/google/protobuf/Utf8Utils.java \ java/core/src/test/java/com/google/protobuf/Utf8Utils.java \

24
java/core/BUILD
Unescape View File

@ -224,6 +224,7 @@ test_suite(
"conformance_test", "conformance_test",
"core_build_test", "core_build_test",
"core_tests", "core_tests",
"utf8_tests",
], ],
) )
@ -243,10 +244,12 @@ conformance_test(
junit_tests( junit_tests(
name = "core_tests", name = "core_tests",
size = "large", size = "small",
srcs = glob( srcs = glob(
["src/test/java/**/*.java"], ["src/test/java/**/*.java"],
exclude = [ exclude = [
"src/test/java/com/google/protobuf/DecodeUtf8Test.java",
"src/test/java/com/google/protobuf/IsValidUtf8Test.java",
"src/test/java/com/google/protobuf/TestUtil.java", "src/test/java/com/google/protobuf/TestUtil.java",
"src/test/java/com/google/protobuf/TestUtilLite.java", "src/test/java/com/google/protobuf/TestUtilLite.java",
], ],
@ -264,6 +267,24 @@ junit_tests(
], ],
) )
# The UTF-8 validation tests are much slower than the other tests, so they get
# their own test target with a longer timeout.
junit_tests(
name = "utf8_tests",
size = "large",
srcs = [
"src/test/java/com/google/protobuf/DecodeUtf8Test.java",
"src/test/java/com/google/protobuf/IsValidUtf8Test.java",
"src/test/java/com/google/protobuf/IsValidUtf8TestUtil.java",
],
deps = [
":core",
"@maven//:com_google_guava_guava",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
],
)
java_lite_proto_library( java_lite_proto_library(
name = "generic_test_protos_java_proto_lite", name = "generic_test_protos_java_proto_lite",
visibility = [ visibility = [
@ -346,6 +367,7 @@ LITE_TEST_EXCLUSIONS = [
"src/test/java/com/google/protobuf/TypeRegistryTest.java", "src/test/java/com/google/protobuf/TypeRegistryTest.java",
"src/test/java/com/google/protobuf/UnknownEnumValueTest.java", "src/test/java/com/google/protobuf/UnknownEnumValueTest.java",
"src/test/java/com/google/protobuf/UnknownFieldSetLiteTest.java", "src/test/java/com/google/protobuf/UnknownFieldSetLiteTest.java",
"src/test/java/com/google/protobuf/UnknownFieldSetPerformanceTest.java",
"src/test/java/com/google/protobuf/UnknownFieldSetTest.java", "src/test/java/com/google/protobuf/UnknownFieldSetTest.java",
"src/test/java/com/google/protobuf/WellKnownTypesTest.java", "src/test/java/com/google/protobuf/WellKnownTypesTest.java",
"src/test/java/com/google/protobuf/WireFormatTest.java", "src/test/java/com/google/protobuf/WireFormatTest.java",

427
java/core/src/main/java/com/google/protobuf/UnknownFieldSet.java
Unescape View File

@ -43,13 +43,13 @@ import java.util.Map;
import java.util.TreeMap; import java.util.TreeMap;
/** /**
* {@code UnknownFieldSet} is used to keep track of fields which were seen when parsing a protocol * {@code UnknownFieldSet} keeps track of fields which were seen when parsing a protocol
* message but whose field numbers or types are unrecognized. This most frequently occurs when new * message but whose field numbers or types are unrecognized. This most frequently occurs when new
* fields are added to a message type and then messages containing those fields are read by old * fields are added to a message type and then messages containing those fields are read by old
* software that was compiled before the new types were added. * software that was compiled before the new types were added.
* *
* <p>Every {@link Message} contains an {@code UnknownFieldSet} (and every {@link Message.Builder} * <p>Every {@link Message} contains an {@code UnknownFieldSet} (and every {@link Message.Builder}
* contains an {@link Builder}). * contains a {@link Builder}).
* *
* <p>Most users will never need to use this class. * <p>Most users will never need to use this class.
* *
@ -57,9 +57,13 @@ import java.util.TreeMap;
*/ */
public final class UnknownFieldSet implements MessageLite { public final class UnknownFieldSet implements MessageLite {
private UnknownFieldSet() { private final TreeMap<Integer, Field> fields;
fields = null;
fieldsDescending = null; /**
* Construct an {@code UnknownFieldSet} around the given map.
*/
UnknownFieldSet(TreeMap<Integer, Field> fields) {
this.fields = fields;
} }
/** Create a new {@link Builder}. */ /** Create a new {@link Builder}. */
@ -68,7 +72,7 @@ public final class UnknownFieldSet implements MessageLite {
} }
/** Create a new {@link Builder} and initialize it to be a copy of {@code copyFrom}. */ /** Create a new {@link Builder} and initialize it to be a copy of {@code copyFrom}. */
public static Builder newBuilder(final UnknownFieldSet copyFrom) { public static Builder newBuilder(UnknownFieldSet copyFrom) {
return newBuilder().mergeFrom(copyFrom); return newBuilder().mergeFrom(copyFrom);
} }
@ -83,25 +87,11 @@ public final class UnknownFieldSet implements MessageLite {
} }
private static final UnknownFieldSet defaultInstance = private static final UnknownFieldSet defaultInstance =
new UnknownFieldSet( new UnknownFieldSet(new TreeMap<Integer, Field>());
Collections.<Integer, Field>emptyMap(), Collections.<Integer, Field>emptyMap());
/**
* Construct an {@code UnknownFieldSet} around the given map. The map is expected to be immutable.
*/
UnknownFieldSet(final Map<Integer, Field> fields, final Map<Integer, Field> fieldsDescending) {
this.fields = fields;
this.fieldsDescending = fieldsDescending;
}
private final Map<Integer, Field> fields;
/** A copy of {@link #fields} who's iterator order is reversed. */
private final Map<Integer, Field> fieldsDescending;
@Override @Override
public boolean equals(final Object other) { public boolean equals(Object other) {
if (this == other) { if (this == other) {
return true; return true;
} }
@ -110,29 +100,33 @@ public final class UnknownFieldSet implements MessageLite {
@Override @Override
public int hashCode() { public int hashCode() {
if (fields.isEmpty()) { // avoid allocation of iterator.
// This optimization may not be helpful but it is needed for the allocation tests to pass.
return 0;
}
return fields.hashCode(); return fields.hashCode();
} }
/** Get a map of fields in the set by number. */ /** Get a map of fields in the set by number. */
public Map<Integer, Field> asMap() { public Map<Integer, Field> asMap() {
return fields; return (Map<Integer, Field>) fields.clone();
} }
/** Check if the given field number is present in the set. */ /** Check if the given field number is present in the set. */
public boolean hasField(final int number) { public boolean hasField(int number) {
return fields.containsKey(number); return fields.containsKey(number);
} }
/** Get a field by number. Returns an empty field if not present. Never returns {@code null}. */ /** Get a field by number. Returns an empty field if not present. Never returns {@code null}. */
public Field getField(final int number) { public Field getField(int number) {
final Field result = fields.get(number); Field result = fields.get(number);
return (result == null) ? Field.getDefaultInstance() : result; return (result == null) ? Field.getDefaultInstance() : result;
} }
/** Serializes the set and writes it to {@code output}. */ /** Serializes the set and writes it to {@code output}. */
@Override @Override
public void writeTo(final CodedOutputStream output) throws IOException { public void writeTo(CodedOutputStream output) throws IOException {
for (final Map.Entry<Integer, Field> entry : fields.entrySet()) { for (Map.Entry<Integer, Field> entry : fields.entrySet()) {
Field field = entry.getValue(); Field field = entry.getValue();
field.writeTo(entry.getKey(), output); field.writeTo(entry.getKey(), output);
} }
@ -154,10 +148,10 @@ public final class UnknownFieldSet implements MessageLite {
@Override @Override
public ByteString toByteString() { public ByteString toByteString() {
try { try {
final ByteString.CodedBuilder out = ByteString.newCodedBuilder(getSerializedSize()); ByteString.CodedBuilder out = ByteString.newCodedBuilder(getSerializedSize());
writeTo(out.getCodedOutput()); writeTo(out.getCodedOutput());
return out.build(); return out.build();
} catch (final IOException e) { } catch (IOException e) {
throw new RuntimeException( throw new RuntimeException(
"Serializing to a ByteString threw an IOException (should never happen).", e); "Serializing to a ByteString threw an IOException (should never happen).", e);
} }
@ -170,12 +164,12 @@ public final class UnknownFieldSet implements MessageLite {
@Override @Override
public byte[] toByteArray() { public byte[] toByteArray() {
try { try {
final byte[] result = new byte[getSerializedSize()]; byte[] result = new byte[getSerializedSize()];
final CodedOutputStream output = CodedOutputStream.newInstance(result); CodedOutputStream output = CodedOutputStream.newInstance(result);
writeTo(output); writeTo(output);
output.checkNoSpaceLeft(); output.checkNoSpaceLeft();
return result; return result;
} catch (final IOException e) { } catch (IOException e) {
throw new RuntimeException( throw new RuntimeException(
"Serializing to a byte array threw an IOException (should never happen).", e); "Serializing to a byte array threw an IOException (should never happen).", e);
} }
@ -186,16 +180,16 @@ public final class UnknownFieldSet implements MessageLite {
* {@link #writeTo(CodedOutputStream)}. * {@link #writeTo(CodedOutputStream)}.
*/ */
@Override @Override
public void writeTo(final OutputStream output) throws IOException { public void writeTo(OutputStream output) throws IOException {
final CodedOutputStream codedOutput = CodedOutputStream.newInstance(output); CodedOutputStream codedOutput = CodedOutputStream.newInstance(output);
writeTo(codedOutput); writeTo(codedOutput);
codedOutput.flush(); codedOutput.flush();
} }
@Override @Override
public void writeDelimitedTo(OutputStream output) throws IOException { public void writeDelimitedTo(OutputStream output) throws IOException {
final CodedOutputStream codedOutput = CodedOutputStream.newInstance(output); CodedOutputStream codedOutput = CodedOutputStream.newInstance(output);
codedOutput.writeRawVarint32(getSerializedSize()); codedOutput.writeUInt32NoTag(getSerializedSize());
writeTo(codedOutput); writeTo(codedOutput);
codedOutput.flush(); codedOutput.flush();
} }
@ -204,15 +198,17 @@ public final class UnknownFieldSet implements MessageLite {
@Override @Override
public int getSerializedSize() { public int getSerializedSize() {
int result = 0; int result = 0;
for (final Map.Entry<Integer, Field> entry : fields.entrySet()) { if (!fields.isEmpty()) {
result += entry.getValue().getSerializedSize(entry.getKey()); for (Map.Entry<Integer, Field> entry : fields.entrySet()) {
result += entry.getValue().getSerializedSize(entry.getKey());
}
} }
return result; return result;
} }
/** Serializes the set and writes it to {@code output} using {@code MessageSet} wire format. */ /** Serializes the set and writes it to {@code output} using {@code MessageSet} wire format. */
public void writeAsMessageSetTo(final CodedOutputStream output) throws IOException { public void writeAsMessageSetTo(CodedOutputStream output) throws IOException {
for (final Map.Entry<Integer, Field> entry : fields.entrySet()) { for (Map.Entry<Integer, Field> entry : fields.entrySet()) {
entry.getValue().writeAsMessageSetExtensionTo(entry.getKey(), output); entry.getValue().writeAsMessageSetExtensionTo(entry.getKey(), output);
} }
} }
@ -221,7 +217,7 @@ public final class UnknownFieldSet implements MessageLite {
void writeTo(Writer writer) throws IOException { void writeTo(Writer writer) throws IOException {
if (writer.fieldOrder() == Writer.FieldOrder.DESCENDING) { if (writer.fieldOrder() == Writer.FieldOrder.DESCENDING) {
// Write fields in descending order. // Write fields in descending order.
for (Map.Entry<Integer, Field> entry : fieldsDescending.entrySet()) { for (Map.Entry<Integer, Field> entry : fields.descendingMap().entrySet()) {
entry.getValue().writeTo(entry.getKey(), writer); entry.getValue().writeTo(entry.getKey(), writer);
} }
} else { } else {
@ -233,15 +229,15 @@ public final class UnknownFieldSet implements MessageLite {
} }
/** Serializes the set and writes it to {@code writer} using {@code MessageSet} wire format. */ /** Serializes the set and writes it to {@code writer} using {@code MessageSet} wire format. */
void writeAsMessageSetTo(final Writer writer) throws IOException { void writeAsMessageSetTo(Writer writer) throws IOException {
if (writer.fieldOrder() == Writer.FieldOrder.DESCENDING) { if (writer.fieldOrder() == Writer.FieldOrder.DESCENDING) {
// Write fields in descending order. // Write fields in descending order.
for (final Map.Entry<Integer, Field> entry : fieldsDescending.entrySet()) { for (Map.Entry<Integer, Field> entry : fields.descendingMap().entrySet()) {
entry.getValue().writeAsMessageSetExtensionTo(entry.getKey(), writer); entry.getValue().writeAsMessageSetExtensionTo(entry.getKey(), writer);
} }
} else { } else {
// Write fields in ascending order. // Write fields in ascending order.
for (final Map.Entry<Integer, Field> entry : fields.entrySet()) { for (Map.Entry<Integer, Field> entry : fields.entrySet()) {
entry.getValue().writeAsMessageSetExtensionTo(entry.getKey(), writer); entry.getValue().writeAsMessageSetExtensionTo(entry.getKey(), writer);
} }
} }
@ -250,7 +246,7 @@ public final class UnknownFieldSet implements MessageLite {
/** Get the number of bytes required to encode this set using {@code MessageSet} wire format. */ /** Get the number of bytes required to encode this set using {@code MessageSet} wire format. */
public int getSerializedSizeAsMessageSet() { public int getSerializedSizeAsMessageSet() {
int result = 0; int result = 0;
for (final Map.Entry<Integer, Field> entry : fields.entrySet()) { for (Map.Entry<Integer, Field> entry : fields.entrySet()) {
result += entry.getValue().getSerializedSizeAsMessageSetExtension(entry.getKey()); result += entry.getValue().getSerializedSizeAsMessageSetExtension(entry.getKey());
} }
return result; return result;
@ -264,23 +260,23 @@ public final class UnknownFieldSet implements MessageLite {
} }
/** Parse an {@code UnknownFieldSet} from the given input stream. */ /** Parse an {@code UnknownFieldSet} from the given input stream. */
public static UnknownFieldSet parseFrom(final CodedInputStream input) throws IOException { public static UnknownFieldSet parseFrom(CodedInputStream input) throws IOException {
return newBuilder().mergeFrom(input).build(); return newBuilder().mergeFrom(input).build();
} }
/** Parse {@code data} as an {@code UnknownFieldSet} and return it. */ /** Parse {@code data} as an {@code UnknownFieldSet} and return it. */
public static UnknownFieldSet parseFrom(final ByteString data) public static UnknownFieldSet parseFrom(ByteString data)
throws InvalidProtocolBufferException { throws InvalidProtocolBufferException {
return newBuilder().mergeFrom(data).build(); return newBuilder().mergeFrom(data).build();
} }
/** Parse {@code data} as an {@code UnknownFieldSet} and return it. */ /** Parse {@code data} as an {@code UnknownFieldSet} and return it. */
public static UnknownFieldSet parseFrom(final byte[] data) throws InvalidProtocolBufferException { public static UnknownFieldSet parseFrom(byte[] data) throws InvalidProtocolBufferException {
return newBuilder().mergeFrom(data).build(); return newBuilder().mergeFrom(data).build();
} }
/** Parse an {@code UnknownFieldSet} from {@code input} and return it. */ /** Parse an {@code UnknownFieldSet} from {@code input} and return it. */
public static UnknownFieldSet parseFrom(final InputStream input) throws IOException { public static UnknownFieldSet parseFrom(InputStream input) throws IOException {
return newBuilder().mergeFrom(input).build(); return newBuilder().mergeFrom(input).build();
} }
@ -309,64 +305,43 @@ public final class UnknownFieldSet implements MessageLite {
// This constructor should never be called directly (except from 'create'). // This constructor should never be called directly (except from 'create').
private Builder() {} private Builder() {}
private Map<Integer, Field> fields; private TreeMap<Integer, Field.Builder> fieldBuilders = new TreeMap<>();
// Optimization: We keep around a builder for the last field that was
// modified so that we can efficiently add to it multiple times in a
// row (important when parsing an unknown repeated field).
private int lastFieldNumber;
private Field.Builder lastField;
private static Builder create() { private static Builder create() {
Builder builder = new Builder(); return new Builder();
builder.reinitialize();
return builder;
} }
/** /**
* Get a field builder for the given field number which includes any values that already exist. * Get a field builder for the given field number which includes any values that already exist.
*/ */
private Field.Builder getFieldBuilder(final int number) { private Field.Builder getFieldBuilder(int number) {
if (lastField != null) {
if (number == lastFieldNumber) {
return lastField;
}
// Note: addField() will reset lastField and lastFieldNumber.
addField(lastFieldNumber, lastField.build());
}
if (number == 0) { if (number == 0) {
return null; return null;
} else { } else {
final Field existing = fields.get(number); Field.Builder builder = fieldBuilders.get(number);
lastFieldNumber = number; if (builder == null) {
lastField = Field.newBuilder(); builder = Field.newBuilder();
if (existing != null) { fieldBuilders.put(number, builder);
lastField.mergeFrom(existing);
} }
return lastField; return builder;
} }
} }
/** /**
* Build the {@link UnknownFieldSet} and return it. * Build the {@link UnknownFieldSet} and return it.
*
* <p>Once {@code build()} has been called, the {@code Builder} will no longer be usable.
* Calling any method after {@code build()} will result in undefined behavior and can cause a
* {@code NullPointerException} to be thrown.
*/ */
@Override @Override
public UnknownFieldSet build() { public UnknownFieldSet build() {
getFieldBuilder(0); // Force lastField to be built. UnknownFieldSet result;
final UnknownFieldSet result; if (fieldBuilders.isEmpty()) {
if (fields.isEmpty()) {
result = getDefaultInstance(); result = getDefaultInstance();
} else { } else {
Map<Integer, Field> descendingFields = null; TreeMap<Integer, Field> fields = new TreeMap<>();
descendingFields = for (Map.Entry<Integer, Field.Builder> entry : fieldBuilders.entrySet()) {
Collections.unmodifiableMap(((TreeMap<Integer, Field>) fields).descendingMap()); fields.put(entry.getKey(), entry.getValue().build());
result = new UnknownFieldSet(Collections.unmodifiableMap(fields), descendingFields); }
result = new UnknownFieldSet(fields);
} }
fields = null;
return result; return result;
} }
@ -378,11 +353,13 @@ public final class UnknownFieldSet implements MessageLite {
@Override @Override
public Builder clone() { public Builder clone() {
getFieldBuilder(0); // Force lastField to be built. Builder clone = UnknownFieldSet.newBuilder();
Map<Integer, Field> descendingFields = null; for (Map.Entry<Integer, Field.Builder> entry : fieldBuilders.entrySet()) {
descendingFields = Integer key = entry.getKey();
Collections.unmodifiableMap(((TreeMap<Integer, Field>) fields).descendingMap()); Field.Builder value = entry.getValue();
return UnknownFieldSet.newBuilder().mergeFrom(new UnknownFieldSet(fields, descendingFields)); clone.fieldBuilders.put(key, value.clone());
}
return clone;
} }
@Override @Override
@ -390,31 +367,24 @@ public final class UnknownFieldSet implements MessageLite {
return UnknownFieldSet.getDefaultInstance(); return UnknownFieldSet.getDefaultInstance();
} }
private void reinitialize() {
fields = Collections.emptyMap();
lastFieldNumber = 0;
lastField = null;
}
/** Reset the builder to an empty set. */ /** Reset the builder to an empty set. */
@Override @Override
public Builder clear() { public Builder clear() {
reinitialize(); fieldBuilders = new TreeMap<>();
return this; return this;
} }
/** Clear fields from the set with a given field number. */ /**
public Builder clearField(final int number) { * Clear fields from the set with a given field number.
if (number == 0) { *
throw new IllegalArgumentException("Zero is not a valid field number."); * @throws IllegalArgumentException if number is not positive
} */
if (lastField != null && lastFieldNumber == number) { public Builder clearField(int number) {
// Discard this. if (number <= 0) {
lastField = null; throw new IllegalArgumentException(number + " is not a valid field number.");
lastFieldNumber = 0;
} }
if (fields.containsKey(number)) { if (fieldBuilders.containsKey(number)) {
fields.remove(number); fieldBuilders.remove(number);
} }
return this; return this;
} }
@ -423,9 +393,9 @@ public final class UnknownFieldSet implements MessageLite {
* Merge the fields from {@code other} into this set. If a field number exists in both sets, * Merge the fields from {@code other} into this set. If a field number exists in both sets,
* {@code other}'s values for that field will be appended to the values in this set. * {@code other}'s values for that field will be appended to the values in this set.
*/ */
public Builder mergeFrom(final UnknownFieldSet other) { public Builder mergeFrom(UnknownFieldSet other) {
if (other != getDefaultInstance()) { if (other != getDefaultInstance()) {
for (final Map.Entry<Integer, Field> entry : other.fields.entrySet()) { for (Map.Entry<Integer, Field> entry : other.fields.entrySet()) {
mergeField(entry.getKey(), entry.getValue()); mergeField(entry.getKey(), entry.getValue());
} }
} }
@ -435,10 +405,12 @@ public final class UnknownFieldSet implements MessageLite {
/** /**
* Add a field to the {@code UnknownFieldSet}. If a field with the same number already exists, * Add a field to the {@code UnknownFieldSet}. If a field with the same number already exists,
* the two are merged. * the two are merged.
*
* @throws IllegalArgumentException if number is not positive
*/ */
public Builder mergeField(final int number, final Field field) { public Builder mergeField(int number, final Field field) {
if (number == 0) { if (number <= 0) {
throw new IllegalArgumentException("Zero is not a valid field number."); throw new IllegalArgumentException(number + " is not a valid field number.");
} }
if (hasField(number)) { if (hasField(number)) {
getFieldBuilder(number).mergeFrom(field); getFieldBuilder(number).mergeFrom(field);
@ -454,10 +426,12 @@ public final class UnknownFieldSet implements MessageLite {
/** /**
* Convenience method for merging a new field containing a single varint value. This is used in * Convenience method for merging a new field containing a single varint value. This is used in
* particular when an unknown enum value is encountered. * particular when an unknown enum value is encountered.
*
* @throws IllegalArgumentException if number is not positive
*/ */
public Builder mergeVarintField(final int number, final int value) { public Builder mergeVarintField(int number, int value) {
if (number == 0) { if (number <= 0) {
throw new IllegalArgumentException("Zero is not a valid field number."); throw new IllegalArgumentException(number + " is not a valid field number.");
} }
getFieldBuilder(number).addVarint(value); getFieldBuilder(number).addVarint(value);
return this; return this;
@ -467,40 +441,33 @@ public final class UnknownFieldSet implements MessageLite {
* Convenience method for merging a length-delimited field. * Convenience method for merging a length-delimited field.
* *
* <p>For use by generated code only. * <p>For use by generated code only.
*
* @throws IllegalArgumentException if number is not positive
*/ */
public Builder mergeLengthDelimitedField(final int number, final ByteString value) { public Builder mergeLengthDelimitedField(int number, ByteString value) {
if (number == 0) { if (number <= 0) {
throw new IllegalArgumentException("Zero is not a valid field number."); throw new IllegalArgumentException(number + " is not a valid field number.");
} }
getFieldBuilder(number).addLengthDelimited(value); getFieldBuilder(number).addLengthDelimited(value);
return this; return this;
} }
/** Check if the given field number is present in the set. */ /** Check if the given field number is present in the set. */
public boolean hasField(final int number) { public boolean hasField(int number) {
if (number == 0) { return fieldBuilders.containsKey(number);
throw new IllegalArgumentException("Zero is not a valid field number.");
}
return number == lastFieldNumber || fields.containsKey(number);
} }
/** /**
* Add a field to the {@code UnknownFieldSet}. If a field with the same number already exists, * Add a field to the {@code UnknownFieldSet}. If a field with the same number already exists,
* it is removed. * it is removed.
*
* @throws IllegalArgumentException if number is not positive
*/ */
public Builder addField(final int number, final Field field) { public Builder addField(int number, Field field) {
if (number == 0) { if (number <= 0) {
throw new IllegalArgumentException("Zero is not a valid field number."); throw new IllegalArgumentException(number + " is not a valid field number.");
}
if (lastField != null && lastFieldNumber == number) {
// Discard this.
lastField = null;
lastFieldNumber = 0;
} }
if (fields.isEmpty()) { fieldBuilders.put(number, Field.newBuilder(field));
fields = new TreeMap<Integer, Field>();
}
fields.put(number, field);
return this; return this;
} }
@ -509,15 +476,18 @@ public final class UnknownFieldSet implements MessageLite {
* changes may or may not be reflected in this map. * changes may or may not be reflected in this map.
*/ */
public Map<Integer, Field> asMap() { public Map<Integer, Field> asMap() {
getFieldBuilder(0); // Force lastField to be built. TreeMap<Integer, Field> fields = new TreeMap<>();
for (Map.Entry<Integer, Field.Builder> entry : fieldBuilders.entrySet()) {
fields.put(entry.getKey(), entry.getValue().build());
}
return Collections.unmodifiableMap(fields); return Collections.unmodifiableMap(fields);
} }
/** Parse an entire message from {@code input} and merge its fields into this set. */ /** Parse an entire message from {@code input} and merge its fields into this set. */
@Override @Override
public Builder mergeFrom(final CodedInputStream input) throws IOException { public Builder mergeFrom(CodedInputStream input) throws IOException {
while (true) { while (true) {
final int tag = input.readTag(); int tag = input.readTag();
if (tag == 0 || !mergeFieldFrom(tag, input)) { if (tag == 0 || !mergeFieldFrom(tag, input)) {
break; break;
} }
@ -531,8 +501,8 @@ public final class UnknownFieldSet implements MessageLite {
* @param tag The field's tag number, which was already parsed. * @param tag The field's tag number, which was already parsed.
* @return {@code false} if the tag is an end group tag. * @return {@code false} if the tag is an end group tag.
*/ */
public boolean mergeFieldFrom(final int tag, final CodedInputStream input) throws IOException { public boolean mergeFieldFrom(int tag, CodedInputStream input) throws IOException {
final int number = WireFormat.getTagFieldNumber(tag); int number = WireFormat.getTagFieldNumber(tag);
switch (WireFormat.getTagWireType(tag)) { switch (WireFormat.getTagWireType(tag)) {
case WireFormat.WIRETYPE_VARINT: case WireFormat.WIRETYPE_VARINT:
getFieldBuilder(number).addVarint(input.readInt64()); getFieldBuilder(number).addVarint(input.readInt64());
@ -544,7 +514,7 @@ public final class UnknownFieldSet implements MessageLite {
getFieldBuilder(number).addLengthDelimited(input.readBytes()); getFieldBuilder(number).addLengthDelimited(input.readBytes());
return true; return true;
case WireFormat.WIRETYPE_START_GROUP: case WireFormat.WIRETYPE_START_GROUP:
final Builder subBuilder = newBuilder(); Builder subBuilder = newBuilder();
input.readGroup(number, subBuilder, ExtensionRegistry.getEmptyRegistry()); input.readGroup(number, subBuilder, ExtensionRegistry.getEmptyRegistry());
getFieldBuilder(number).addGroup(subBuilder.build()); getFieldBuilder(number).addGroup(subBuilder.build());
return true; return true;
@ -563,15 +533,15 @@ public final class UnknownFieldSet implements MessageLite {
* is just a small wrapper around {@link #mergeFrom(CodedInputStream)}. * is just a small wrapper around {@link #mergeFrom(CodedInputStream)}.
*/ */
@Override @Override
public Builder mergeFrom(final ByteString data) throws InvalidProtocolBufferException { public Builder mergeFrom(ByteString data) throws InvalidProtocolBufferException {
try { try {
final CodedInputStream input = data.newCodedInput(); CodedInputStream input = data.newCodedInput();
mergeFrom(input); mergeFrom(input);
input.checkLastTagWas(0); input.checkLastTagWas(0);
return this; return this;
} catch (final InvalidProtocolBufferException e) { } catch (InvalidProtocolBufferException e) {
throw e; throw e;
} catch (final IOException e) { } catch (IOException e) {
throw new RuntimeException( throw new RuntimeException(
"Reading from a ByteString threw an IOException (should never happen).", e); "Reading from a ByteString threw an IOException (should never happen).", e);
} }
@ -582,15 +552,15 @@ public final class UnknownFieldSet implements MessageLite {
* is just a small wrapper around {@link #mergeFrom(CodedInputStream)}. * is just a small wrapper around {@link #mergeFrom(CodedInputStream)}.
*/ */
@Override @Override
public Builder mergeFrom(final byte[] data) throws InvalidProtocolBufferException { public Builder mergeFrom(byte[] data) throws InvalidProtocolBufferException {
try { try {
final CodedInputStream input = CodedInputStream.newInstance(data); CodedInputStream input = CodedInputStream.newInstance(data);
mergeFrom(input); mergeFrom(input);
input.checkLastTagWas(0); input.checkLastTagWas(0);
return this; return this;
} catch (final InvalidProtocolBufferException e) { } catch (InvalidProtocolBufferException e) {
throw e; throw e;
} catch (final IOException e) { } catch (IOException e) {
throw new RuntimeException( throw new RuntimeException(
"Reading from a byte array threw an IOException (should never happen).", e); "Reading from a byte array threw an IOException (should never happen).", e);
} }
@ -601,8 +571,8 @@ public final class UnknownFieldSet implements MessageLite {
* This is just a small wrapper around {@link #mergeFrom(CodedInputStream)}. * This is just a small wrapper around {@link #mergeFrom(CodedInputStream)}.
*/ */
@Override @Override
public Builder mergeFrom(final InputStream input) throws IOException { public Builder mergeFrom(InputStream input) throws IOException {
final CodedInputStream codedInput = CodedInputStream.newInstance(input); CodedInputStream codedInput = CodedInputStream.newInstance(input);
mergeFrom(codedInput); mergeFrom(codedInput);
codedInput.checkLastTagWas(0); codedInput.checkLastTagWas(0);
return this; return this;
@ -610,12 +580,12 @@ public final class UnknownFieldSet implements MessageLite {
@Override @Override
public boolean mergeDelimitedFrom(InputStream input) throws IOException { public boolean mergeDelimitedFrom(InputStream input) throws IOException {
final int firstByte = input.read(); int firstByte = input.read();
if (firstByte == -1) { if (firstByte == -1) {
return false; return false;
} }
final int size = CodedInputStream.readRawVarint32(firstByte, input); int size = CodedInputStream.readRawVarint32(firstByte, input);
final InputStream limitedInput = new LimitedInputStream(input, size); InputStream limitedInput = new LimitedInputStream(input, size);
mergeFrom(limitedInput); mergeFrom(limitedInput);
return true; return true;
} }
@ -644,7 +614,7 @@ public final class UnknownFieldSet implements MessageLite {
@Override @Override
public Builder mergeFrom(byte[] data, int off, int len) throws InvalidProtocolBufferException { public Builder mergeFrom(byte[] data, int off, int len) throws InvalidProtocolBufferException {
try { try {
final CodedInputStream input = CodedInputStream.newInstance(data, off, len); CodedInputStream input = CodedInputStream.newInstance(data, off, len);
mergeFrom(input); mergeFrom(input);
input.checkLastTagWas(0); input.checkLastTagWas(0);
return this; return this;
@ -718,7 +688,7 @@ public final class UnknownFieldSet implements MessageLite {
} }
/** Construct a new {@link Builder} and initialize it to a copy of {@code copyFrom}. */ /** Construct a new {@link Builder} and initialize it to a copy of {@code copyFrom}. */
public static Builder newBuilder(final Field copyFrom) { public static Builder newBuilder(Field copyFrom) {
return newBuilder().mergeFrom(copyFrom); return newBuilder().mergeFrom(copyFrom);
} }
@ -758,7 +728,7 @@ public final class UnknownFieldSet implements MessageLite {
} }
@Override @Override
public boolean equals(final Object other) { public boolean equals(Object other) {
if (this == other) { if (this == other) {
return true; return true;
} }
@ -785,7 +755,7 @@ public final class UnknownFieldSet implements MessageLite {
public ByteString toByteString(int fieldNumber) { public ByteString toByteString(int fieldNumber) {
try { try {
// TODO(lukes): consider caching serialized size in a volatile long // TODO(lukes): consider caching serialized size in a volatile long
final ByteString.CodedBuilder out = ByteString.CodedBuilder out =
ByteString.newCodedBuilder(getSerializedSize(fieldNumber)); ByteString.newCodedBuilder(getSerializedSize(fieldNumber));
writeTo(fieldNumber, out.getCodedOutput()); writeTo(fieldNumber, out.getCodedOutput());
return out.build(); return out.build();
@ -796,40 +766,40 @@ public final class UnknownFieldSet implements MessageLite {
} }
/** Serializes the field, including field number, and writes it to {@code output}. */ /** Serializes the field, including field number, and writes it to {@code output}. */
public void writeTo(final int fieldNumber, final CodedOutputStream output) throws IOException { public void writeTo(int fieldNumber, CodedOutputStream output) throws IOException {
for (final long value : varint) { for (long value : varint) {
output.writeUInt64(fieldNumber, value); output.writeUInt64(fieldNumber, value);
} }
for (final int value : fixed32) { for (int value : fixed32) {
output.writeFixed32(fieldNumber, value); output.writeFixed32(fieldNumber, value);
} }
for (final long value : fixed64) { for (long value : fixed64) {
output.writeFixed64(fieldNumber, value); output.writeFixed64(fieldNumber, value);
} }
for (final ByteString value : lengthDelimited) { for (ByteString value : lengthDelimited) {
output.writeBytes(fieldNumber, value); output.writeBytes(fieldNumber, value);
} }
for (final UnknownFieldSet value : group) { for (UnknownFieldSet value : group) {
output.writeGroup(fieldNumber, value); output.writeGroup(fieldNumber, value);
} }
} }
/** Get the number of bytes required to encode this field, including field number. */ /** Get the number of bytes required to encode this field, including field number. */
public int getSerializedSize(final int fieldNumber) { public int getSerializedSize(int fieldNumber) {
int result = 0; int result = 0;
for (final long value : varint) { for (long value : varint) {
result += CodedOutputStream.computeUInt64Size(fieldNumber, value); result += CodedOutputStream.computeUInt64Size(fieldNumber, value);
} }
for (final int value : fixed32) { for (int value : fixed32) {
result += CodedOutputStream.computeFixed32Size(fieldNumber, value); result += CodedOutputStream.computeFixed32Size(fieldNumber, value);
} }
for (final long value : fixed64) { for (long value : fixed64) {
result += CodedOutputStream.computeFixed64Size(fieldNumber, value); result += CodedOutputStream.computeFixed64Size(fieldNumber, value);
} }
for (final ByteString value : lengthDelimited) { for (ByteString value : lengthDelimited) {
result += CodedOutputStream.computeBytesSize(fieldNumber, value); result += CodedOutputStream.computeBytesSize(fieldNumber, value);
} }
for (final UnknownFieldSet value : group) { for (UnknownFieldSet value : group) {
result += CodedOutputStream.computeGroupSize(fieldNumber, value); result += CodedOutputStream.computeGroupSize(fieldNumber, value);
} }
return result; return result;
@ -839,15 +809,15 @@ public final class UnknownFieldSet implements MessageLite {
* Serializes the field, including field number, and writes it to {@code output}, using {@code * Serializes the field, including field number, and writes it to {@code output}, using {@code
* MessageSet} wire format. * MessageSet} wire format.
*/ */
public void writeAsMessageSetExtensionTo(final int fieldNumber, final CodedOutputStream output) public void writeAsMessageSetExtensionTo(int fieldNumber, CodedOutputStream output)
throws IOException { throws IOException {
for (final ByteString value : lengthDelimited) { for (ByteString value : lengthDelimited) {
output.writeRawMessageSetExtension(fieldNumber, value); output.writeRawMessageSetExtension(fieldNumber, value);
} }
} }
/** Serializes the field, including field number, and writes it to {@code writer}. */ /** Serializes the field, including field number, and writes it to {@code writer}. */
void writeTo(final int fieldNumber, final Writer writer) throws IOException { void writeTo(int fieldNumber, Writer writer) throws IOException {
writer.writeInt64List(fieldNumber, varint, false); writer.writeInt64List(fieldNumber, varint, false);
writer.writeFixed32List(fieldNumber, fixed32, false); writer.writeFixed32List(fieldNumber, fixed32, false);
writer.writeFixed64List(fieldNumber, fixed64, false); writer.writeFixed64List(fieldNumber, fixed64, false);
@ -872,7 +842,7 @@ public final class UnknownFieldSet implements MessageLite {
* Serializes the field, including field number, and writes it to {@code writer}, using {@code * Serializes the field, including field number, and writes it to {@code writer}, using {@code
* MessageSet} wire format. * MessageSet} wire format.
*/ */
private void writeAsMessageSetExtensionTo(final int fieldNumber, final Writer writer) private void writeAsMessageSetExtensionTo(int fieldNumber, Writer writer)
throws IOException { throws IOException {
if (writer.fieldOrder() == Writer.FieldOrder.DESCENDING) { if (writer.fieldOrder() == Writer.FieldOrder.DESCENDING) {
// Write in descending field order. // Write in descending field order.
@ -882,7 +852,7 @@ public final class UnknownFieldSet implements MessageLite {
} }
} else { } else {
// Write in ascending field order. // Write in ascending field order.
for (final ByteString value : lengthDelimited) { for (ByteString value : lengthDelimited) {
writer.writeMessageSetItem(fieldNumber, value); writer.writeMessageSetItem(fieldNumber, value);
} }
} }
@ -892,9 +862,9 @@ public final class UnknownFieldSet implements MessageLite {
* Get the number of bytes required to encode this field, including field number, using {@code * Get the number of bytes required to encode this field, including field number, using {@code
* MessageSet} wire format. * MessageSet} wire format.
*/ */
public int getSerializedSizeAsMessageSetExtension(final int fieldNumber) { public int getSerializedSizeAsMessageSetExtension(int fieldNumber) {
int result = 0; int result = 0;
for (final ByteString value : lengthDelimited) { for (ByteString value : lengthDelimited) {
result += CodedOutputStream.computeRawMessageSetExtensionSize(fieldNumber, value); result += CodedOutputStream.computeRawMessageSetExtensionSize(fieldNumber, value);
} }
return result; return result;
@ -912,52 +882,85 @@ public final class UnknownFieldSet implements MessageLite {
* <p>Use {@link Field#newBuilder()} to construct a {@code Builder}. * <p>Use {@link Field#newBuilder()} to construct a {@code Builder}.
*/ */
public static final class Builder { public static final class Builder {
// This constructor should never be called directly (except from 'create'). // This constructor should only be called directly from 'create' and 'clone'.
private Builder() {} private Builder() {
result = new Field();
}
private static Builder create() { private static Builder create() {
Builder builder = new Builder(); Builder builder = new Builder();
builder.result = new Field();
return builder; return builder;
} }
private Field result; private Field result;
@Override
public Builder clone() {
Field copy = new Field();
if (result.varint == null) {
copy.varint = null;
} else {
copy.varint = new ArrayList<>(result.varint);
}
if (result.fixed32 == null) {
copy.fixed32 = null;
} else {
copy.fixed32 = new ArrayList<>(result.fixed32);
}
if (result.fixed64 == null) {
copy.fixed64 = null;
} else {
copy.fixed64 = new ArrayList<>(result.fixed64);
}
if (result.lengthDelimited == null) {
copy.lengthDelimited = null;
} else {
copy.lengthDelimited = new ArrayList<>(result.lengthDelimited);
}
if (result.group == null) {
copy.group = null;
} else {
copy.group = new ArrayList<>(result.group);
}
Builder clone = new Builder();
clone.result = copy;
return clone;
}
/** /**
* Build the field. After {@code build()} has been called, the {@code Builder} is no longer * Build the field.
* usable. Calling any other method will result in undefined behavior and can cause a {@code
* NullPointerException} to be thrown.
*/ */
public Field build() { public Field build() {
Field built = new Field();
if (result.varint == null) { if (result.varint == null) {
result.varint = Collections.emptyList(); built.varint = Collections.emptyList();
} else { } else {
result.varint = Collections.unmodifiableList(result.varint); built.varint = Collections.unmodifiableList(new ArrayList<>(result.varint));
} }
if (result.fixed32 == null) { if (result.fixed32 == null) {
result.fixed32 = Collections.emptyList(); built.fixed32 = Collections.emptyList();
} else { } else {
result.fixed32 = Collections.unmodifiableList(result.fixed32); built.fixed32 = Collections.unmodifiableList(new ArrayList<>(result.fixed32));
} }
if (result.fixed64 == null) { if (result.fixed64 == null) {
result.fixed64 = Collections.emptyList(); built.fixed64 = Collections.emptyList();
} else { } else {
result.fixed64 = Collections.unmodifiableList(result.fixed64); built.fixed64 = Collections.unmodifiableList(new ArrayList<>(result.fixed64));
} }
if (result.lengthDelimited == null) { if (result.lengthDelimited == null) {
result.lengthDelimited = Collections.emptyList(); built.lengthDelimited = Collections.emptyList();
} else { } else {
result.lengthDelimited = Collections.unmodifiableList(result.lengthDelimited); built.lengthDelimited = Collections.unmodifiableList(
new ArrayList<>(result.lengthDelimited));
} }
if (result.group == null) { if (result.group == null) {
result.group = Collections.emptyList(); built.group = Collections.emptyList();
} else { } else {
result.group = Collections.unmodifiableList(result.group); built.group = Collections.unmodifiableList(new ArrayList<>(result.group));
} }
final Field returnMe = result; return built;
result = null;
return returnMe;
} }
/** Discard the field's contents. */ /** Discard the field's contents. */
@ -970,7 +973,7 @@ public final class UnknownFieldSet implements MessageLite {
* Merge the values in {@code other} into this field. For each list of values, {@code other}'s * Merge the values in {@code other} into this field. For each list of values, {@code other}'s
* values are append to the ones in this field. * values are append to the ones in this field.
*/ */
public Builder mergeFrom(final Field other) { public Builder mergeFrom(Field other) {
if (!other.varint.isEmpty()) { if (!other.varint.isEmpty()) {
if (result.varint == null) { if (result.varint == null) {
result.varint = new ArrayList<Long>(); result.varint = new ArrayList<Long>();
@ -985,19 +988,19 @@ public final class UnknownFieldSet implements MessageLite {
} }
if (!other.fixed64.isEmpty()) { if (!other.fixed64.isEmpty()) {
if (result.fixed64 == null) { if (result.fixed64 == null) {
result.fixed64 = new ArrayList<Long>(); result.fixed64 = new ArrayList<>();
} }
result.fixed64.addAll(other.fixed64); result.fixed64.addAll(other.fixed64);
} }
if (!other.lengthDelimited.isEmpty()) { if (!other.lengthDelimited.isEmpty()) {
if (result.lengthDelimited == null) { if (result.lengthDelimited == null) {
result.lengthDelimited = new ArrayList<ByteString>(); result.lengthDelimited = new ArrayList<>();
} }
result.lengthDelimited.addAll(other.lengthDelimited); result.lengthDelimited.addAll(other.lengthDelimited);
} }
if (!other.group.isEmpty()) { if (!other.group.isEmpty()) {
if (result.group == null) { if (result.group == null) {
result.group = new ArrayList<UnknownFieldSet>(); result.group = new ArrayList<>();
} }
result.group.addAll(other.group); result.group.addAll(other.group);
} }
@ -1005,45 +1008,45 @@ public final class UnknownFieldSet implements MessageLite {
} }
/** Add a varint value. */ /** Add a varint value. */
public Builder addVarint(final long value) { public Builder addVarint(long value) {
if (result.varint == null) { if (result.varint == null) {
result.varint = new ArrayList<Long>(); result.varint = new ArrayList<>();
} }
result.varint.add(value); result.varint.add(value);
return this; return this;
} }
/** Add a fixed32 value. */ /** Add a fixed32 value. */
public Builder addFixed32(final int value) { public Builder addFixed32(int value) {
if (result.fixed32 == null) { if (result.fixed32 == null) {
result.fixed32 = new ArrayList<Integer>(); result.fixed32 = new ArrayList<>();
} }
result.fixed32.add(value); result.fixed32.add(value);
return this; return this;
} }
/** Add a fixed64 value. */ /** Add a fixed64 value. */
public Builder addFixed64(final long value) { public Builder addFixed64(long value) {
if (result.fixed64 == null) { if (result.fixed64 == null) {
result.fixed64 = new ArrayList<Long>(); result.fixed64 = new ArrayList<>();
} }
result.fixed64.add(value); result.fixed64.add(value);
return this; return this;
} }
/** Add a length-delimited value. */ /** Add a length-delimited value. */
public Builder addLengthDelimited(final ByteString value) { public Builder addLengthDelimited(ByteString value) {
if (result.lengthDelimited == null) { if (result.lengthDelimited == null) {
result.lengthDelimited = new ArrayList<ByteString>(); result.lengthDelimited = new ArrayList<>();
} }
result.lengthDelimited.add(value); result.lengthDelimited.add(value);
return this; return this;
} }
/** Add an embedded group. */ /** Add an embedded group. */
public Builder addGroup(final UnknownFieldSet value) { public Builder addGroup(UnknownFieldSet value) {
if (result.group == null) { if (result.group == null) {
result.group = new ArrayList<UnknownFieldSet>(); result.group = new ArrayList<>();
} }
result.group.add(value); result.group.add(value);
return this; return this;

78
java/core/src/test/java/com/google/protobuf/UnknownFieldSetPerformanceTest.java
Unescape View File

@ -0,0 +1,78 @@
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc. All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// 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 Google 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 com.google.protobuf;
import static com.google.common.truth.Truth.assertThat;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
@RunWith(JUnit4.class)
public final class UnknownFieldSetPerformanceTest {
private static byte[] generateBytes(int length) {
assertThat(length % 4).isEqualTo(0);
byte[] input = new byte[length];
for (int i = 0; i < length; i += 4) {
input[i] = (byte) 0x08; // field 1, wiretype 0
input[i + 1] = (byte) 0x08; // field 1, payload 8
input[i + 2] = (byte) 0x20; // field 4, wiretype 0
input[i + 3] = (byte) 0x20; // field 4, payload 32
}
return input;
}
@Test
// This is a performance test. Failure here is a timeout.
public void testAlternatingFieldNumbers() throws IOException {
byte[] input = generateBytes(800000);
InputStream in = new ByteArrayInputStream(input);
UnknownFieldSet.Builder builder = UnknownFieldSet.newBuilder();
CodedInputStream codedInput = CodedInputStream.newInstance(in);
builder.mergeFrom(codedInput);
}
@Test
// This is a performance test. Failure here is a timeout.
public void testAddField() {
UnknownFieldSet.Builder builder = UnknownFieldSet.newBuilder();
for (int i = 1; i <= 100000; i++) {
UnknownFieldSet.Field field = UnknownFieldSet.Field.newBuilder().addFixed32(i).build();
builder.addField(i, field);
}
UnknownFieldSet fieldSet = builder.build();
assertThat(fieldSet.getField(100000).getFixed32List().get(0)).isEqualTo(100000);
}
}

182
java/core/src/test/java/com/google/protobuf/UnknownFieldSetTest.java
Unescape View File

@ -42,7 +42,9 @@ import protobuf_unittest.UnittestProto.TestEmptyMessageWithExtensions;
import protobuf_unittest.UnittestProto.TestPackedExtensions; import protobuf_unittest.UnittestProto.TestPackedExtensions;
import protobuf_unittest.UnittestProto.TestPackedTypes; import protobuf_unittest.UnittestProto.TestPackedTypes;
import proto3_unittest.UnittestProto3; import proto3_unittest.UnittestProto3;
import java.util.List;
import java.util.Map; import java.util.Map;
import org.junit.Assert;
import org.junit.Before; import org.junit.Before;
import org.junit.Test; import org.junit.Test;
import org.junit.runner.RunWith; import org.junit.runner.RunWith;
@ -61,7 +63,7 @@ public class UnknownFieldSetTest {
unknownFields = emptyMessage.getUnknownFields(); unknownFields = emptyMessage.getUnknownFields();
} }
UnknownFieldSet.Field getField(String name) { private UnknownFieldSet.Field getField(String name) {
Descriptors.FieldDescriptor field = descriptor.findFieldByName(name); Descriptors.FieldDescriptor field = descriptor.findFieldByName(name);
assertThat(field).isNotNull(); assertThat(field).isNotNull();
return unknownFields.getField(field.getNumber()); return unknownFields.getField(field.getNumber());
@ -100,6 +102,174 @@ public class UnknownFieldSetTest {
// ================================================================= // =================================================================
@Test
public void testFieldBuildersAreReusable() {
UnknownFieldSet.Field.Builder fieldBuilder = UnknownFieldSet.Field.newBuilder();
fieldBuilder.addFixed32(10);
UnknownFieldSet.Field first = fieldBuilder.build();
UnknownFieldSet.Field second = fieldBuilder.build();
fieldBuilder.addFixed32(11);
UnknownFieldSet.Field third = fieldBuilder.build();
assertThat(first).isEqualTo(second);
assertThat(first).isNotEqualTo(third);
}
@Test
public void testClone() {
UnknownFieldSet.Builder unknownSetBuilder = UnknownFieldSet.newBuilder();
UnknownFieldSet.Field.Builder fieldBuilder = UnknownFieldSet.Field.newBuilder();
fieldBuilder.addFixed32(10);
unknownSetBuilder.addField(8, fieldBuilder.build());
// necessary to call clone twice to expose the bug
UnknownFieldSet.Builder clone1 = unknownSetBuilder.clone();
UnknownFieldSet.Builder clone2 = unknownSetBuilder.clone(); // failure is a NullPointerException
assertThat(clone1).isNotSameInstanceAs(clone2);
}
@Test
public void testClone_lengthDelimited() {
UnknownFieldSet.Builder destUnknownFieldSet =
UnknownFieldSet.newBuilder()
.addField(997, UnknownFieldSet.Field.newBuilder().addVarint(99).build())
.addField(
999,
UnknownFieldSet.Field.newBuilder()
.addLengthDelimited(ByteString.copyFromUtf8("some data"))
.addLengthDelimited(ByteString.copyFromUtf8("some more data"))
.build());
UnknownFieldSet clone = destUnknownFieldSet.clone().build();
assertThat(clone.getField(997)).isNotNull();
UnknownFieldSet.Field field999 = clone.getField(999);
List<ByteString> lengthDelimited = field999.getLengthDelimitedList();
assertThat(lengthDelimited.get(0).toStringUtf8()).isEqualTo("some data");
assertThat(lengthDelimited.get(1).toStringUtf8()).isEqualTo("some more data");
UnknownFieldSet clone2 = destUnknownFieldSet.clone().build();
assertThat(clone2.getField(997)).isNotNull();
UnknownFieldSet.Field secondField = clone2.getField(999);
List<ByteString> lengthDelimited2 = secondField.getLengthDelimitedList();
assertThat(lengthDelimited2.get(0).toStringUtf8()).isEqualTo("some data");
assertThat(lengthDelimited2.get(1).toStringUtf8()).isEqualTo("some more data");
}
@Test
public void testReuse() {
UnknownFieldSet.Builder builder =
UnknownFieldSet.newBuilder()
.addField(997, UnknownFieldSet.Field.newBuilder().addVarint(99).build())
.addField(
999,
UnknownFieldSet.Field.newBuilder()
.addLengthDelimited(ByteString.copyFromUtf8("some data"))
.addLengthDelimited(ByteString.copyFromUtf8("some more data"))
.build());
UnknownFieldSet fieldSet1 = builder.build();
UnknownFieldSet fieldSet2 = builder.build();
builder.addField(1000, UnknownFieldSet.Field.newBuilder().addVarint(-90).build());
UnknownFieldSet fieldSet3 = builder.build();
assertThat(fieldSet1).isEqualTo(fieldSet2);
assertThat(fieldSet1).isNotEqualTo(fieldSet3);
}
@Test
@SuppressWarnings("ModifiedButNotUsed")
public void testAddField_zero() {
UnknownFieldSet.Field field = getField("optional_int32");
try {
UnknownFieldSet.newBuilder().addField(0, field);
Assert.fail();
} catch (IllegalArgumentException expected) {
assertThat(expected).hasMessageThat().isEqualTo("0 is not a valid field number.");
}
}
@Test
@SuppressWarnings("ModifiedButNotUsed")
public void testAddField_negative() {
UnknownFieldSet.Field field = getField("optional_int32");
try {
UnknownFieldSet.newBuilder().addField(-2, field);
Assert.fail();
} catch (IllegalArgumentException expected) {
assertThat(expected).hasMessageThat().isEqualTo("-2 is not a valid field number.");
}
}
@Test
@SuppressWarnings("ModifiedButNotUsed")
public void testClearField_negative() {
try {
UnknownFieldSet.newBuilder().clearField(-28);
Assert.fail();
} catch (IllegalArgumentException expected) {
assertThat(expected).hasMessageThat().isEqualTo("-28 is not a valid field number.");
}
}
@Test
@SuppressWarnings("ModifiedButNotUsed")
public void testMergeField_negative() {
UnknownFieldSet.Field field = getField("optional_int32");
try {
UnknownFieldSet.newBuilder().mergeField(-2, field);
Assert.fail();
} catch (IllegalArgumentException expected) {
assertThat(expected).hasMessageThat().isEqualTo("-2 is not a valid field number.");
}
}
@Test
@SuppressWarnings("ModifiedButNotUsed")
public void testMergeVarintField_negative() {
try {
UnknownFieldSet.newBuilder().mergeVarintField(-2, 78);
Assert.fail();
} catch (IllegalArgumentException expected) {
assertThat(expected).hasMessageThat().isEqualTo("-2 is not a valid field number.");
}
}
@Test
@SuppressWarnings("ModifiedButNotUsed")
public void testHasField_negative() {
assertThat(UnknownFieldSet.newBuilder().hasField(-2)).isFalse();
}
@Test
@SuppressWarnings("ModifiedButNotUsed")
public void testMergeLengthDelimitedField_negative() {
ByteString byteString = ByteString.copyFromUtf8("some data");
try {
UnknownFieldSet.newBuilder().mergeLengthDelimitedField(-2, byteString);
Assert.fail();
} catch (IllegalArgumentException expected) {
assertThat(expected).hasMessageThat().isEqualTo("-2 is not a valid field number.");
}
}
@Test
public void testAddField() {
UnknownFieldSet.Field field = getField("optional_int32");
UnknownFieldSet fieldSet = UnknownFieldSet.newBuilder().addField(1, field).build();
assertThat(fieldSet.getField(1)).isEqualTo(field);
}
@Test
public void testAddField_withReplacement() {
UnknownFieldSet.Field first = UnknownFieldSet.Field.newBuilder().addFixed32(56).build();
UnknownFieldSet.Field second = UnknownFieldSet.Field.newBuilder().addFixed32(25).build();
UnknownFieldSet fieldSet = UnknownFieldSet.newBuilder()
.addField(1, first)
.addField(1, second)
.build();
List<Integer> list = fieldSet.getField(1).getFixed32List();
assertThat(list).hasSize(1);
assertThat(list.get(0)).isEqualTo(25);
}
@Test @Test
public void testVarint() throws Exception { public void testVarint() throws Exception {
UnknownFieldSet.Field field = getField("optional_int32"); UnknownFieldSet.Field field = getField("optional_int32");
@ -185,6 +355,16 @@ public class UnknownFieldSetTest {
assertThat(destination.toString()).isEqualTo("1: 1\n2: 2\n3: 3\n3: 4\n"); assertThat(destination.toString()).isEqualTo("1: 1\n2: 2\n3: 3\n3: 4\n");
} }
@Test
public void testAsMap() throws Exception {
UnknownFieldSet.Builder builder = UnknownFieldSet.newBuilder().mergeFrom(unknownFields);
Map<Integer, UnknownFieldSet.Field> mapFromBuilder = builder.asMap();
assertThat(mapFromBuilder).isNotEmpty();
UnknownFieldSet fields = builder.build();
Map<Integer, UnknownFieldSet.Field> mapFromFieldSet = fields.asMap();
assertThat(mapFromFieldSet).containsExactlyEntriesIn(mapFromBuilder);
}
@Test @Test
public void testClear() throws Exception { public void testClear() throws Exception {
UnknownFieldSet fields = UnknownFieldSet.newBuilder().mergeFrom(unknownFields).clear().build(); UnknownFieldSet fields = UnknownFieldSet.newBuilder().mergeFrom(unknownFields).clear().build();

1
java/lite/pom.xml
Unescape View File

@ -232,6 +232,7 @@
<exclude>TypeRegistryTest.java</exclude> <exclude>TypeRegistryTest.java</exclude>
<exclude>UnknownEnumValueTest.java</exclude> <exclude>UnknownEnumValueTest.java</exclude>
<exclude>UnknownFieldSetLiteTest.java</exclude> <exclude>UnknownFieldSetLiteTest.java</exclude>
<exclude>UnknownFieldSetPerformanceTest.java</exclude>
<exclude>UnknownFieldSetTest.java</exclude> <exclude>UnknownFieldSetTest.java</exclude>
<exclude>WellKnownTypesTest.java</exclude> <exclude>WellKnownTypesTest.java</exclude>
<exclude>WireFormatTest.java</exclude> <exclude>WireFormatTest.java</exclude>

Write Preview
Loading…
Cancel
Save