Merge branch 'real-logic:master' into rust-lang

Author: mward

.github/workflows/ci.yml

@@ -14,12 +14,13 @@ env:
 
 jobs:
  java-build:
- name: Java ${{ matrix.java }}
- runs-on: ubuntu-20.04
+ name: Java ${{ matrix.java }} (${{ matrix.os }})
+ runs-on: ${{ matrix.os }}
  strategy:
  fail-fast: false
  matrix:
  java: [ '8', '11', '16', '17-ea' ]
+ os: [ 'ubuntu-20.04', 'windows-latest' ]
  steps:
  - name: Checkout code
  uses: actions/checkout@v2
@@ -170,9 +171,11 @@ jobs:
 
  cpp-clang-macos-build:
  name: C++ Xcode ${{ matrix.version }} (macOS)
- runs-on: macos-latest
+ runs-on: ${{ matrix.os }}
  strategy:
  fail-fast: false
+ matrix:
+ os: [ 'macos-latest' ]
  env:
  CC: clang
  CXX: clang++
@@ -189,9 +192,11 @@ jobs:
 
  cpp-msvc-build:
  name: C++ MSVC (Windows)
- runs-on: windows-latest
+ runs-on: ${{ matrix.os }}
  strategy:
  fail-fast: false
+ matrix:
+ os: [ 'windows-latest' ]
  env:
  CC: cl
  CXX: cl

CMakeLists.txt

@@ -153,7 +153,7 @@ file(GLOB_RECURSE SBE_SOURCES
 )
 
 add_custom_command(OUTPUT ${SBE_JAR}
- COMMAND ./gradlew assemble -x javadoc
+ COMMAND ./gradlew assemble -x javadoc --console=plain
  DEPENDS ${SBE_SOURCES}
  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
  COMMENT "Generating SBE jar"

build.gradle

@@ -14,6 +14,10 @@
  * limitations under the License.
  */
 
+import java.nio.file.Files
+import java.nio.file.StandardOpenOption
+import java.security.MessageDigest
+
 plugins {
  id 'java-library'
  id 'com.github.johnrengelman.shadow' version '7.0.0' apply false
@@ -41,11 +45,10 @@ def toolchainLauncher = javaToolchains.launcherFor {
 def checkstyleVersion = '8.39'
 def hamcrestVersion = '2.2'
 def mockitoVersion = '3.11.2'
-def byteBuddyVersion = '1.11.3'
 def junitVersion = '5.7.2'
-def jmhVersion = '1.32'
-def agronaVersion = '1.11.0'
-def agronaVersionRange = '[1.11,1.12[' // allow any patch release of 1.11.x
+def jmhVersion = '1.33'
+def agronaVersion = '1.12.0'
+def agronaVersionRange = '[1.12,1.13[' // allow any patch release of 1.12.x
 
 def sbeGroup = 'uk.co.real-logic'
 def sbeVersion = file('version.txt').text.trim()
@@ -138,8 +141,6 @@ allprojects {
  configurations.all {
  resolutionStrategy {
  failOnVersionConflict()
-
- force "net.bytebuddy:byte-buddy:${byteBuddyVersion}", "net.bytebuddy:byte-buddy-agent:${byteBuddyVersion}"
  }
  }
 
@@ -723,7 +724,7 @@ task generateCSharpCodecs {
  'generateCSharpCodecsWithXIncludes'
 }
 
-task generateJavaIrCodecs(type: JavaExec) {
+task generateJavaIrCodecs(type: JavaExec, dependsOn: 'computeOriginalIrHash') {
  mainClass = 'uk.co.real_logic.sbe.SbeTool'
  classpath = project(':sbe-all').sourceSets.main.runtimeClasspath
  systemProperties(
@@ -771,20 +772,98 @@ task testReport(type: TestReport) {
  reportOn subprojects*.test
 }
 
+final codecsDir = project.file('sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated')
+final outputDir = project.file('sbe-tool/build')
+final oldHashFile = new File(outputDir, 'old.sha256')
+final newHashFile = new File(outputDir, 'new.sha256')
+
+task computeOriginalIrHash(type: ChecksumTask) {
+ inputDirectory = codecsDir
+ outputFile = oldHashFile
+}
+
+task computeUpdatedIrHash(type: ChecksumTask, dependsOn: 'generateJavaIrCodecs') {
+ inputDirectory = codecsDir
+ outputFile = newHashFile
+}
+
+task verifyJavaIrCodecsInSync(dependsOn: 'computeUpdatedIrHash') {
+ doLast {
+ final byte[] oldHash = Files.readAllBytes(oldHashFile.toPath())
+ final byte[] newHash = Files.readAllBytes(newHashFile.toPath())
+ if (!Arrays.equals(oldHash, newHash))
+ {
+ throw new GradleException("Java Ir codecs are out of sync! Please execute the `generateJavaIrCodecs` task and commit the changes.")
+ }
+ }
+}
+
 def isNonStable = { String version ->
  def stableKeyword = ['RELEASE', 'FINAL', 'GA'].any { it -> version.toUpperCase().contains(it) }
  def regex = /^[0-9,.v-]+(-r)?$/
  return !stableKeyword && !(version ==~ regex)
 }
 
-tasks.named("dependencyUpdates").configure {
+tasks.named('dependencyUpdates').configure {
  // Reject all non stable versions
  rejectVersionIf {
  isNonStable(it.candidate.version)
  }
 }
 
+tasks.findByName('build').dependsOn verifyJavaIrCodecsInSync
+
 wrapper {
  gradleVersion = '7.1.1'
  distributionType = 'ALL'
 }
+
+class ChecksumTask extends DefaultTask
+{
+ private static final MessageDigest SHA_256 = MessageDigest.getInstance("SHA-256");
+ private static final byte CR = (byte) ('\r' as char)
+ private static final byte LF = (byte) ('\n' as char)
+
+ @InputDirectory
+ File inputDirectory
+
+ @OutputFile
+ File outputFile
+
+ @TaskAction
+ def checksum() {
+ SHA_256.reset()
+
+ final File[] files = inputDirectory.listFiles();
+ for (final File f : files)
+ {
+ final byte[] raw = Files.readAllBytes(f.toPath())
+ final byte[] normalized = normalizeEOL(raw);
+ SHA_256.update(normalized)
+ }
+
+ final byte[] hash = SHA_256.digest()
+
+ Files.write(
+ outputFile.toPath(),
+ hash,
+ StandardOpenOption.CREATE,
+ StandardOpenOption.WRITE,
+ StandardOpenOption.TRUNCATE_EXISTING)
+ }
+
+ private byte[] normalizeEOL(final byte[] raw)
+ {
+ final byte[] result = new byte[raw.length]
+ int i = 0
+ for (int j = 0, size = raw.length; j < size; j++)
+ {
+ if (CR == raw[j] && (j == size - 1 || LF == raw[j + 1]))
+ {
+ continue;
+ }
+ result[i++] = raw[j]
+ }
+ return raw.length == i ? result : Arrays.copyOf(result, i);
+ }
+}

gradle.properties

@@ -1,6 +1,9 @@
 org.gradle.java.installations.auto-download=false
 org.gradle.java.installations.fromEnv=BUILD_JAVA_HOME
 
+org.gradle.logging.level=warn
+org.gradle.warning.mode=all
+
 # HTTP timeouts for Gradle
 systemProp.org.gradle.internal.http.connectionTimeout=300000
 systemProp.org.gradle.internal.http.socketTimeout=300000

sbe-benchmarks/src/main/java/uk/co/real_logic/sbe/CarBenchmark.java

@@ -210,7 +210,7 @@ private static void decode(
  }
 
  /*
- * Benchmarks to allow execution outside of JMH.
+ * Benchmarks to allow execution outside JMH.
  */
 
  public static void main(final String[] args)

sbe-samples/src/main/java/uk/co/real_logic/sbe/examples/OtfExample.java

@@ -63,7 +63,7 @@ public static void main(final String[] args) throws Exception
  final ByteBuffer encodedMsgBuffer = ByteBuffer.allocate(MSG_BUFFER_CAPACITY);
  encodeTestMessage(encodedMsgBuffer);
 
- // Now lets decode the schema IR so we have IR objects.
+ // Now let's decode the schema IR, so we have IR objects.
  encodedSchemaBuffer.flip();
  final Ir ir = decodeIr(encodedSchemaBuffer);
 
@@ -81,7 +81,7 @@ public static void main(final String[] args) throws Exception
 
  bufferOffset += headerDecoder.encodedLength();
 
- // Given the header information we can select the appropriate message template to do the decode.
+ // Given the header information we can select the appropriate message template to do the decode operation.
  // The OTF Java classes are thread safe so the same instances can be reused across multiple threads.
 
  final List<Token> msgTokens = ir.getMessage(templateId);

sbe-tool/src/main/java/uk/co/real_logic/sbe/ValidationUtil.java

@@ -80,7 +80,7 @@ public static boolean isCKeyword(final String token)
  * Is the value a possible C language keyword?
  *
  * @param value to be checked.
- * @return true if the value a possible C language keyword.
+ * @return true if the value is a possible C language keyword.
  */
  private static boolean possibleCKeyword(final String value)
  {
@@ -178,7 +178,7 @@ public static boolean isCppKeyword(final String token)
  * Is the value a possible C++ language keyword?
  *
  * @param value to be checked.
- * @return true if the value a possible C++ language keyword.
+ * @return true if the value is a possible C++ language keyword.
  */
  private static boolean possibleCppKeyword(final String value)
  {
@@ -319,7 +319,7 @@ private static boolean isJavaIdentifier(final String token)
  * identifier = letter { letter | unicode_digit }
  * letter = unicode_letter | "_" .
  * <p>
- * unicode_letter and unicode_digit are defined in section 4.5 of the the unicode
+ * unicode_letter and unicode_digit are defined in section 4.5 of the unicode
  * standard at http://www.unicode.org/versions/Unicode8.0.0/ and
  * the Java Character and Digit functions are unicode friendly
  *
@@ -358,7 +358,7 @@ public static boolean isGolangKeyword(final String token)
  * Is the value a possible Go language keyword?
  *
  * @param value to be checked.
- * @return true if the value a possible Go language keyword.
+ * @return true if the value is a possible Go language keyword.
  */
  private static boolean possibleGolangKeyword(final String value)
  {
@@ -418,11 +418,11 @@ private static boolean isSbeGolangIdentifierPart(final char c)
  /**
  * "Check" value for validity of usage as a csharp identifier.
  * https://msdn.microsoft.com/en-us/library/aa664670(v=vs.71).aspx
- * ( Which basically boils down to
+ * Which basically boils down to
  * <p>
  * first subsequent*
  * first is { @ | letter | underscore }
- * subsequent is { first | digit | connecing | combining | formatting }*
+ * subsequent is { first | digit | connecting | combining | formatting }*
  * <p>
  * letter is Lu, Ll, Lt, Lm, Lo, or Nl (possibly escaped)
  * digit is Nd (possibly escaped)
@@ -468,7 +468,7 @@ public static boolean isCSharpKeyword(final String token)
  * Is the value a possible C# language keyword?
  *
  * @param value to be checked.
- * @return true if the value a possible C# language keyword.
+ * @return true if the value is a possible C# language keyword.
  */
  public static boolean possibleCSharpKeyword(final String value)
  {

sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/Generators.java

@@ -54,7 +54,7 @@ public static void forEachField(final List<Token> tokens, final BiConsumer<Token
  /**
  * Uppercase the first character of a given String.
  *
- * @param s to have the first character upper cased.
+ * @param s to have the first character upper-cased.
  * @return a new String with the first character in uppercase.
  */
  public static String toUpperFirstChar(final String s)
@@ -70,7 +70,7 @@ public static String toUpperFirstChar(final String s)
  /**
  * Lowercase the first character of a given String.
  *
- * @param s to have the first character upper cased.
+ * @param s to have the first character upper-cased.
  * @return a new String with the first character in uppercase.
  */
  public static String toLowerFirstChar(final String s)

sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/TargetCodeGenerator.java

@@ -25,7 +25,7 @@ public interface TargetCodeGenerator
  /**
  * Get a new {@link CodeGenerator} for the given target language.
  *
- * @param ir describing the message schemas from which code should generated.
+ * @param ir describing the message schemas from which code should be generated.
  * @param outputDir to which the generated code with be written.
  * @return a new instance of a {@link CodeGenerator} for the given target language.
  */

sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/TargetCodeGeneratorLoader.java

@@ -30,7 +30,7 @@
 import static uk.co.real_logic.sbe.SbeTool.*;
 
 /**
- * Loader for {@link CodeGenerator}s which target a language. This provide convenient short names rather than the
+ * Loader for {@link CodeGenerator}s which target a language. This provides convenient short names rather than the
  * fully qualified class name of the generator.
  */
 public enum TargetCodeGeneratorLoader implements TargetCodeGenerator
@@ -118,7 +118,7 @@ public CodeGenerator newInstance(final Ir ir, final String outputDir)
  };
 
  /**
- * Do a case insensitive lookup of a target language for code generation.
+ * Do a case-insensitive lookup of a target language for code generation.
  *
  * @param name of the target language to lookup.
  * @return the {@link TargetCodeGenerator} for the given language name.