feat(db): remove leveldb support for arm64

Author: halibobo1205

README.md

@@ -59,8 +59,20 @@ TRON enables large-scale development and engagement. With over 2000 transactions
 
 # Building the Source Code
 
-Building java-tron requires `git` package and 64-bit version of `Oracle JDK 1.8` to be installed, other JDK versions are not supported yet. Make sure you operate on `Linux` and `MacOS` operating systems.
+Building java-tron requires `git` package
 
+## Operating systems
+Make sure you operate on `Linux` or `MacOS` operating systems, other operating systems are not supported yet.
+
+## Architecture
+
+### x86_64
+64-bit version of `Oracle JDK 1.8` to be installed, other JDK versions are not supported yet.
+
+### ARM64
+64-bit version of `JDK 17` to be installed, other JDK versions are not supported yet.
+
+### build
 Clone the repo and switch to the `master` branch
 
 ```bash
@@ -77,8 +89,19 @@ $ ./gradlew clean build -x test
 
 # Running java-tron
 
-Running java-tron requires 64-bit version of `Oracle JDK 1.8` to be installed, other JDK versions are not supported yet. Make sure you operate on `Linux` and `MacOS` operating systems.
+## Operating systems
+Make sure you operate on `Linux` or `MacOS` operating systems, other operating systems are not supported yet.
+
+## Architecture
 
+### X86_64
+Requires 64-bit version of `Oracle JDK 1.8` to be installed, other JDK versions are not supported yet.
+
+### ARM64
+Requires 64-bit version of `JDK 17` to be installed, other JDK versions are not supported yet.
+
+
+## Configuration flile
 Get the mainnet configuration file: [main_net_config.conf](https://github.com/tronprotocol/tron-deployment/blob/master/main_net_config.conf), other network configuration files can be found [here](https://github.com/tronprotocol/tron-deployment).
 
 ## Hardware Requirements
@@ -100,6 +123,7 @@ Recommended:
 
 Full node has full historical data, it is the entry point into the TRON network, it can be used by other processes as a gateway into the TRON network via HTTP and GRPC endpoints. You can interact with the TRON network through full node：transfer assets, deploy contracts, interact with contracts and so on. `-c` parameter specifies a configuration file to run a full node:
 
+### x86_64 JDK 1.8
 ```bash
 $ nohup java -Xms9G -Xmx9G -XX:ReservedCodeCacheSize=256m \
              -XX:MetaspaceSize=256m -XX:MaxMetaspaceSize=512m \
@@ -111,6 +135,19 @@ $ nohup java -Xms9G -Xmx9G -XX:ReservedCodeCacheSize=256m \
              -XX:+UseCMSInitiatingOccupancyOnly  -XX:CMSInitiatingOccupancyFraction=70 \
              -jar FullNode.jar -c main_net_config.conf >> start.log 2>&1 &
 ```
+### ARM64 JDK 17
+```bash
+$ nohup java -Xms9G -Xmx9G -XX:+UseZGC \
+             -Xlog:gc*:file=gc.log:time,uptime,level,tags:filecount=50,filesize=100M \
+             -XX:ReservedCodeCacheSize=256m \
+             -XX:+UseCodeCacheFlushing \
+             -XX:MetaspaceSize=256m \
+             -XX:MaxMetaspaceSize=512m \
+             -XX:MaxDirectMemorySize=1g \
+             -XX:+HeapDumpOnOutOfMemoryError \
+             -jar FullNode.jar -c main_net_config.conf >> start.log 2>&1 &
+```
+
 
 ## Running a super representative node for mainnet
 
@@ -126,6 +163,7 @@ Fill in the private key of a super representative address into the `localwitness
 
 then run the following command to start the node:
 
+### x86_64 JDK 1.8
 ```bash
 $ nohup java -Xms9G -Xmx9G -XX:ReservedCodeCacheSize=256m \
              -XX:MetaspaceSize=256m -XX:MaxMetaspaceSize=512m \
@@ -137,6 +175,18 @@ $ nohup java -Xms9G -Xmx9G -XX:ReservedCodeCacheSize=256m \
              -XX:+UseCMSInitiatingOccupancyOnly  -XX:CMSInitiatingOccupancyFraction=70 \
              -jar FullNode.jar --witness -c main_net_config.conf >> start.log 2>&1 &
 ```
+### ARM64 JDK 17
+```bash
+$ nohup java -Xms9G -Xmx9G -XX:+UseZGC \
+             -Xlog:gc*:file=gc.log:time,uptime,level,tags:filecount=50,filesize=100M \
+             -XX:ReservedCodeCacheSize=256m \
+             -XX:+UseCodeCacheFlushing \
+             -XX:MetaspaceSize=256m \
+             -XX:MaxMetaspaceSize=512m \
+             -XX:MaxDirectMemorySize=1g \
+             -XX:+HeapDumpOnOutOfMemoryError \
+             -jar FullNode.jar --witness -c main_net_config.conf >> start.log 2>&1 &
+```
 
 ## Quick Start Tool
 

build.gradle

@@ -11,7 +11,7 @@ static def isX86() {
 
 static def isArm64() {
     def arch = System.getProperty("os.arch").toLowerCase()
-    return new Architectures.KnownArchitecture("arm64", "aarch64").isAlias(arch)
+    return Architectures.AARCH64.isAlias(arch)
 }
 
 if (isArm64() && !JavaVersion.current().is(JavaVersion.VERSION_17)) {

chainbase/build.gradle

@@ -10,7 +10,6 @@ dependencies {
     api project(":common")
     api project(":crypto")
     api "org.fusesource.jansi:jansi:$jansiVersion"
-    api 'io.github.tronprotocol:zksnark-java-sdk:1.0.0'
     api 'org.reflections:reflections:0.9.11'
 }
 

framework/build.gradle

@@ -1,3 +1,5 @@
+import org.gradle.nativeplatform.platform.internal.Architectures
+
 plugins {
     id "org.gradle.test-retry" version "1.5.9"
     id "org.sonarqube" version "2.6"
@@ -34,6 +36,11 @@ task version(type: Exec) {
     commandLine 'bash', '-c', '../ver.sh'
 }
 
+static def isArm64() {
+    def arch = System.getProperty("os.arch").toLowerCase()
+    return Architectures.AARCH64.isAlias(arch)
+}
+
 dependencies {
     //local libraries
     implementation fileTree(dir: 'libs', include: '*.jar')
@@ -122,6 +129,18 @@ test {
         destinationFile = file("$buildDir/jacoco/jacocoTest.exec")
         classDumpDir = file("$buildDir/jacoco/classpathdumps")
     }
+    if (isArm64()) {
+        exclude { element ->
+            element.file.name.toLowerCase().contains('leveldb')
+        }
+        exclude('org/tron/program/DBConvertTest.class')
+        filter {
+            excludeTestsMatching '*.*leveldb*'
+            excludeTestsMatching '*.*Leveldb*'
+            excludeTestsMatching '*.*LevelDB*'
+            excludeTestsMatching '*.*LevelDb*'
+        }
+    }
     if (isWindows()) {
         exclude '**/ShieldedTransferActuatorTest.class'
         exclude '**/BackupDbUtilTest.class'

framework/src/main/java/org/tron/program/DBConvert.java

@@ -32,6 +32,7 @@
 import org.rocksdb.RocksDBException;
 import org.rocksdb.RocksIterator;
 import org.rocksdb.Status;
+import org.tron.common.arch.Arch;
 import org.tron.common.utils.FileUtil;
 import org.tron.common.utils.MarketOrderPriceComparatorForLevelDB;
 import org.tron.common.utils.MarketOrderPriceComparatorForRocksDB;
@@ -91,6 +92,13 @@ public static org.iq80.leveldb.Options newDefaultLevelDbOptions() {
   }
 
   public static void main(String[] args) {
+    if (Arch.isArm64()) {
+      String tips = String.format("This tool is not supported on %s architecture.",
+          Arch.getOsArch());
+      System.err.println(tips);
+      logger.error(tips);
+      return;
+    }
     int code = run(args);
     logger.info("exit code {}.", code);
     System.out.printf("exit code %d.\n", code);

framework/src/main/resources/config.conf

@@ -5,7 +5,7 @@ net {
 
 storage {
   # Directory for storing persistent data
-  db.engine = "LEVELDB",
+  db.engine = "LEVELDB",  // deprecated for arm, because arm only support  "ROCKSDB".
   db.sync = false,
   db.directory = "database",
   index.directory = "index",
@@ -19,7 +19,7 @@ storage {
   # Otherwise, db configs will remain default and data will be stored in
   # the path of "output-directory" or which is set by "-d" ("--output-directory").
 
-  # setting can impove leveldb performance .... start
+  # setting can impove leveldb performance .... start, deprecated for arm
   # node: if this will increase process fds,you may be check your ulimit if 'too many open files' error occurs
   # see https://github.com/tronprotocol/tips/blob/master/tip-343.md for detail
   # if you find block sync has lower performance,you can try  this  settings
@@ -32,21 +32,21 @@ storage {
   #defaultL = {
   #  maxOpenFiles = 1000
   #}
-  # setting can impove leveldb performance .... end
+  # setting can impove leveldb performance .... end, deprecated for arm
 
   # Attention: name is a required field that must be set !!!
   properties = [
     //    {
     //      name = "account",
     //      path = "storage_directory_test",
-    //      createIfMissing = true,
+    //      createIfMissing = true, // deprecated for arm start
     //      paranoidChecks = true,
     //      verifyChecksums = true,
     //      compressionType = 1,        // compressed with snappy
     //      blockSize = 4096,           // 4  KB =         4 * 1024 B
     //      writeBufferSize = 10485760, // 10 MB = 10 * 1024 * 1024 B
     //      cacheSize = 10485760,       // 10 MB = 10 * 1024 * 1024 B
-    //      maxOpenFiles = 100
+    //      maxOpenFiles = 100 // deprecated for arm end
     //    },
     //    {
     //      name = "account-index",

gradle/verification-metadata.xml

@@ -569,35 +569,6 @@
             <sha256 value="cf8878e091c721ce2944d74979e9e38972019381781fcd6882f1562ba8d47e60" origin="Generated by Gradle"/>
          </artifact>
       </component>
-      <component group="com.halibobor" name="leveldb" version="1.18.3">
-         <artifact name="leveldb-1.18.3.jar">
-            <sha256 value="0f722db29feb192377769555c73bc1a9bc6b81d31400957d596c645c957e45cc" origin="Generated by Gradle"/>
-         </artifact>
-         <artifact name="leveldb-1.18.3.pom">
-            <sha256 value="4ae67f61cef4c5e2f460215f1b92832c5bc5a97c6c3d5b0219ddd20156143fd8" origin="Generated by Gradle"/>
-         </artifact>
-      </component>
-      <component group="com.halibobor" name="leveldb-api" version="1.18.3">
-         <artifact name="leveldb-api-1.18.3.jar">
-            <sha256 value="3da4c1711f01e9087ca1cc58c55ac098d02c808d401d5595d084532ca227b101" origin="Generated by Gradle"/>
-         </artifact>
-         <artifact name="leveldb-api-1.18.3.pom">
-            <sha256 value="825a008e567eb81d422581a567ba780b45a21ff0537e11d1fea9f49a3c332d33" origin="Generated by Gradle"/>
-         </artifact>
-      </component>
-      <component group="com.halibobor" name="leveldb-project" version="1.18.3">
-         <artifact name="leveldb-project-1.18.3.pom">
-            <sha256 value="c908cfdc66a933a890ab0ae77ceb28676c995a9abbb15e4946a436ce1fc995b5" origin="Generated by Gradle"/>
-         </artifact>
-      </component>
-      <component group="com.halibobor" name="leveldbjni-all" version="1.18.3">
-         <artifact name="leveldbjni-all-1.18.3.jar">
-            <sha256 value="83a72983b6a8e0b90449f7f1e9d56c9db54526288c21c93614c9c52b351fb232" origin="Generated by Gradle"/>
-         </artifact>
-         <artifact name="leveldbjni-all-1.18.3.pom">
-            <sha256 value="2559bdc07dfda47215c6bad79a540566def47c2c110963e6e48402320530fd90" origin="Generated by Gradle"/>
-         </artifact>
-      </component>
       <component group="com.mchange" name="c3p0" version="0.9.5.4">
          <artifact name="c3p0-0.9.5.4.jar">
             <sha256 value="60cf2906cd6ad6771f514a3e848b74b3e3da99c1806f2a63c38e2dd8da5ef11f" origin="Generated by Gradle"/>
@@ -840,14 +811,6 @@
             <sha256 value="3e3c732c738ee941e7d30d04158e7d6b2a8ca2f055d23f4cc02837d06f31fb07" origin="Generated by Gradle"/>
          </artifact>
       </component>
-      <component group="io.github.tronprotocol" name="leveldbjni-all" version="1.18.2">
-         <artifact name="leveldbjni-all-1.18.2.jar">
-            <sha256 value="9525adabb3300f1f9aa4cf564ae1f01b7d4acf9f01a1f0d81df1cd2bc340be75" origin="Generated by Gradle"/>
-         </artifact>
-         <artifact name="leveldbjni-all-1.18.2.pom">
-            <sha256 value="8719f349cd542ae3ce523ac3992513a8c04020621bc86e880a79afa5f1aaf589" origin="Generated by Gradle"/>
-         </artifact>
-      </component>
       <component group="io.github.tronprotocol" name="libp2p" version="2.2.5">
          <artifact name="libp2p-2.2.5.jar">
             <sha256 value="67225eaeae777be6ee1966718d56389c69b7080fbc345861d3d68d8c3d9cd188" origin="Generated by Gradle"/>

platform/build.gradle

@@ -10,21 +10,15 @@ static def isX86() {
 
 static def isArm64() {
     def arch = System.getProperty("os.arch").toLowerCase()
-    return new Architectures.KnownArchitecture("arm64", "aarch64").isAlias(arch)
+    return Architectures.AARCH64.isAlias(arch)
 }
 
 if (isX86()) {
     ext {
-        leveldbGroup = "org.fusesource.leveldbjni"
-        leveldbName = "leveldbjni-all"
-        leveldbVersion = "1.8"
         rocksDBVersion = "5.15.10"
     }
 } else if (isArm64()) {
     ext {
-        leveldbGroup = "com.halibobor"
-        leveldbName = "leveldbjni-all"
-        leveldbVersion = "1.18.3"
         rocksDBVersion = "7.7.3"
     }
 } else {
@@ -45,8 +39,9 @@ sourceSets {
 }
 
 dependencies {
-    api group: leveldbGroup, name: leveldbName, version: leveldbVersion
+    api group: 'org.fusesource.leveldbjni', name: 'leveldbjni-all', version: '1.8'
     api group: 'org.rocksdb', name: 'rocksdbjni', version: rocksDBVersion
+    api 'io.github.tronprotocol:zksnark-java-sdk:1.0.0'
 }
 
 tasks.withType(JavaCompile).configureEach {

platform/src/main/java/common/org/tron/common/arch/Arch.java

@@ -57,4 +57,10 @@ public static boolean isArm64() {
     String osArch = getOsArch();
     return osArch.contains("arm64") || osArch.contains("aarch64");
   }
+
+  public static void throwUnsupportedArm64Exception() {
+    if (isArm64()) {
+      throw new UnsupportedOperationException("unsupported on " + getOsArch() + " architecture");
+    }
+  }
 }

plugins/README.md

@@ -2,7 +2,7 @@
 
 This package contains a set of tools for TRON, the followings are the documentation for each tool.
 
-## DB Archive
+## DB Archive(Requires x86 + LevelDB)
 
 DB archive provides the ability to reformat the manifest according to the current `database`, parameters are compatible with the previous `ArchiveManifest`.
 
@@ -26,7 +26,7 @@ DB archive provides the ability to reformat the manifest according to the curren
 ```
 
 
-## DB Convert
+## DB Convert(Requires x86 + LevelDB)
 
 DB convert provides a helper which can convert LevelDB data to RocksDB data, parameters are compatible with previous `DBConvert`.
 
@@ -64,7 +64,7 @@ DB copy provides a helper which can copy LevelDB or RocksDB data quickly on the
   java -jar Toolkit.jar db cp  output-directory/database /tmp/databse
 ```
 
-## DB Lite
+## DB Lite(LevelDB unavailable on ARM)
 
 DB lite provides lite database, parameters are compatible with previous `LiteFullNodeTool`.
 
@@ -132,7 +132,7 @@ Execute move command.
   java -jar Toolkit.jar db mv -c main_net_config.conf -d /data/tron/output-directory
 ```
 
-## DB Root
+## DB Root(LevelDB unavailable on ARM)
 
 DB root provides a helper which can compute merkle root for tiny db.