introduce vm ExitCode (#50)

Signed-off-by: Alexey-N-Chernyshov <[email protected]>

Author: Alexey-N-Chernyshov

core/common/enum.hpp

@@ -0,0 +1,39 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef CPP_FILECOIN_CORE_COMMON_ENUM_HPP
+#define CPP_FILECOIN_CORE_COMMON_ENUM_HPP
+
+namespace fc::common {
+
+  /**
+   * @brief Convert enum class value as integer
+   * Usage:
+   *   Given an enum class
+   *   @code
+   *   enum class Enumerator {
+   *     one = 1,
+   *     eleven = 11,
+   *     hundred = 100
+   *   }
+   *   @nocode
+   *   Can be converted as:
+   *   @code
+   *   int v = to_int(Enumerator::eleven); // v == 11
+   *   @nocode
+   *
+   * @tparam Enumeration - enum type
+   * @param value - to convert
+   * @return integer value of enum
+   */
+  template <typename Enumeration>
+  auto to_int(Enumeration const value) ->
+      typename std::underlying_type<Enumeration>::type {
+    return static_cast<typename std::underlying_type<Enumeration>::type>(value);
+  }
+
+}  // namespace fc::common
+
+#endif  // CPP_FILECOIN_CORE_COMMON_ENUM_HPP

core/vm/CMakeLists.txt

@@ -4,3 +4,4 @@
 #
 
 add_subdirectory(actor)
+add_subdirectory(exit_code)

core/vm/exit_code/CMakeLists.txt

@@ -0,0 +1,10 @@
+#
+# Copyright Soramitsu Co., Ltd. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+
+add_library(exit_code
+    impl/exit_code.cpp
+    )
+target_link_libraries(exit_code
+    )

core/vm/exit_code/exit_code.hpp

@@ -0,0 +1,169 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef CPP_FILECOIN_CORE_VM_EXITCODE_EXITCODE_HPP
+#define CPP_FILECOIN_CORE_VM_EXITCODE_EXITCODE_HPP
+
+#include <string>
+
+namespace fc::vm::exit_code {
+
+  /**
+   * @brief System error codes
+   */
+  enum class ErrorCode {
+
+    /**
+     * Successful exit code
+     */
+    kSuccess = 0,
+
+    // System error codes
+
+    /**
+     * Represents a failure to find an actor
+     */
+    kActorNotFound,
+
+    /**
+     * Represents a failure to find the code for a particular actor in the VM
+     * registry.
+     */
+    kActorCodeNotFound,
+
+    /**
+     * Represents a failure to find a method in an actor
+     */
+    kInvalidMethod,
+
+    /**
+     * Indicates that a method was called with the incorrect number of
+     * arguments, or that its arguments did not satisfy its preconditions
+     */
+    kInvalidArgumentsSystem,
+
+    /**
+     * Represents a failure to apply a message, as it did not carry sufficient
+     */
+    kInsufficientFundsSystem,
+
+    /**
+     * Represents a message invocation out of sequence. This happens when
+     * message.CallSeqNum is not exactly actor.CallSeqNum + 1
+     */
+    kInvalidCallSeqNum,
+
+    /**
+     * Returned when the execution of an actor method (including its subcalls)
+     * uses more gas than initially allocated
+     */
+    kOutOfGas,
+
+    /**
+     * Returned when an actor method invocation makes a call to the runtime that
+     * does not satisfy its preconditions
+     */
+    kRuntimeAPIError,
+
+    /**
+     * Returned when an actor method invocation calls rt.Assert with a false
+     * condition
+     */
+    kRuntimeAssertFailure,
+
+    /**
+     * Returned when an actor method's Send call has returned with a failure
+     * error code (and the Send call did not specify to ignore errors)
+     */
+    kMethodSubcallError,
+
+    // User defined error codes
+
+    kInsufficientFundsUser,
+    kInvalidArgumentsUser,
+    kInconsistentStateUser,
+
+    kInvalidSectorPacking,
+    kSealVerificationFailed,
+    kPoStVerificationFailed,
+    kDeadlineExceeded,
+    kInsufficientPledgeCollateral,
+  };
+
+  /**
+   * @brief Virtual machine exit code
+   */
+  class ExitCode {
+   public:
+    /**
+     * @brief Create exit code
+     * @param exit_code - code to set
+     */
+    explicit ExitCode(ErrorCode error_code);
+
+    /**
+     * @brief Create successful exit code
+     * @return Successful exit code
+     */
+    static ExitCode makeOkExitCode();
+
+    /**
+     * @brief Create error exit code
+     * @param exit_code - code to set
+     */
+    static ExitCode makeErrorExitCode(ErrorCode error_code);
+
+    /**
+     * @brief ensure if exit code is error code
+     * @param exit_code - to check
+     * @return exit_code if error code is present or ExitCode with
+     * SystemError::kRuntimeAPIError set otherwise
+     */
+    static ExitCode ensureErrorCode(const ExitCode &exit_code);
+
+    /**
+     * @brief Check if exit code is Success
+     * @return true if no error
+     */
+    bool isSuccess() const;
+
+    /**
+     * @brief Check if exit code is System or User defined error
+     * @return true if error
+     */
+    bool isError() const;
+
+    /**
+     * @brief Check if state update is allowed
+     * @return true if is successful
+     */
+    bool allowsStateUpdate() const;
+
+    std::string toString() const;
+
+    bool operator==(const ExitCode &other) const;
+
+   private:
+    ErrorCode exit_code_;
+  };
+
+  /**
+   * @brief Runtime error with text message
+   */
+  class RuntimeError {
+   public:
+    RuntimeError(ExitCode exit_code, std::string error_message);
+    explicit RuntimeError(ExitCode exit_code);
+
+    std::string toString() const;
+
+   private:
+    ExitCode exit_code_;
+    std::string error_message_;
+  };
+
+}  // namespace fc::vm::exit_code
+
+#endif  // CPP_FILECOIN_CORE_VM_EXITCODE_EXITCODE_HPP

core/vm/exit_code/impl/exit_code.cpp

@@ -0,0 +1,63 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "vm/exit_code/exit_code.hpp"
+
+#include <sstream>
+
+#include "common/enum.hpp"
+
+using fc::common::to_int;
+using fc::vm::exit_code::ErrorCode;
+using fc::vm::exit_code::ExitCode;
+using fc::vm::exit_code::RuntimeError;
+
+ExitCode::ExitCode(ErrorCode error_code) : exit_code_{error_code} {}
+
+ExitCode ExitCode::makeOkExitCode() {
+  return ExitCode(ErrorCode::kSuccess);
+}
+
+ExitCode ExitCode::makeErrorExitCode(ErrorCode error_code) {
+  return ExitCode(error_code);
+}
+
+ExitCode ExitCode::ensureErrorCode(const ExitCode &exit_code) {
+  if (exit_code.isSuccess()) return ExitCode(ErrorCode::kRuntimeAPIError);
+  return exit_code;
+}
+
+bool ExitCode::isSuccess() const {
+  return exit_code_ == ErrorCode::kSuccess;
+}
+
+bool ExitCode::isError() const {
+  return !isSuccess();
+}
+
+bool ExitCode::allowsStateUpdate() const {
+  return isSuccess();
+}
+
+std::string ExitCode::toString() const {
+  if (exit_code_ == ErrorCode::kSuccess) return "Success";
+  return "ErrorCode " + std::to_string(to_int(exit_code_));
+}
+
+bool ExitCode::operator==(const ExitCode &other) const {
+  return exit_code_ == other.exit_code_;
+}
+
+RuntimeError::RuntimeError(ExitCode exit_code, std::string error_message)
+    : exit_code_(exit_code), error_message_(std::move(error_message)) {}
+
+RuntimeError::RuntimeError(ExitCode exit_code) : exit_code_(exit_code) {}
+
+std::string RuntimeError::toString() const {
+  std::stringstream res;
+  res << "Runtime error: '" << exit_code_.toString();
+  if (!error_message_.empty()) res << " (\"" << error_message_ << "\")";
+  return res.str();
+}

test/core/vm/CMakeLists.txt

@@ -4,3 +4,4 @@
 #
 
 add_subdirectory(actor)
+add_subdirectory(exit_code)

test/core/vm/exit_code/CMakeLists.txt

@@ -0,0 +1,11 @@
+#
+# Copyright Soramitsu Co., Ltd. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+
+addtest(exit_code_test
+    exit_code_test.cpp
+    )
+target_link_libraries(exit_code_test
+    exit_code
+    )