feat: vm: switch to the new exec trace format

[Stebalien]

Related Issues

requires filecoin-project/filecoin-ffi#379
fixes #10370

Proposed Changes

Execution traces now match what we expose in the FVM. Changes include:

1. Don't treat "trace" messages like off-chain messages. E.g., don't include CIDs, versions, etc.
2. Include IPLD codecs where applicable.
3. Remove fields that aren't filled by the FVM (some errors, code locations, etc.).
4. Plumb through gas-charge timing information.
5. Fix a couple of small display bugs in the HTML trace.

Note: this is a breaking change for anyone consuming this API, but it shouldn't be too involved.

Checklist

Before you mark the PR ready for review, please make sure that:

• Commits have a clear commit message.
• PR title is in the form of of <PR type>: <area>: <change being made>
  • example: fix: mempool: Introduce a cache for valid signatures
  • PR type: fix, feat, build, chore, ci, docs, perf, refactor, revert, style, test
  • area, e.g. api, chain, state, market, mempool, multisig, networking, paych, proving, sealing, wallet, deps
• Tests exist for new functionality or change in behavior
  • Manually tested
• CI is green

[arajasek]

Thank you for the PR! This broadly looks good to me, but we are gonna need to discuss the breakages with some of our users -- we have important node operators with somewhat specific usages of the API endpoints here. I agree that it likely won't be too involved, but I think we should:

• Write up a quick blurb describing the changes.
• Include that in the 1.21.0 release notes (the release that will likely include this).
• Reach out to known users of the endpoints here encouraging them to upgrade to 1.21.0 and integrate these changes ahead of the next mandatory release that forces them onto this.

[frrist]

@arajasek Is merging this into master blocked on your comment? Lily needs this change to collect execution traces successfully, and we plan to reference a commit from master once this is in.

[arajasek]

@arajasek Is merging this into master blocked on your comment? Lily needs this change to collect execution traces successfully, and we plan to reference a commit from master once this is in.

Nope, I just wanna get general alignment on the plan here.

[Stebalien]

The ExecutionTrace format is changing to account for changes introduced by the FVM.

Specifically:

• The Msg field no longer matches the Filecoin message format as many of the message fields didn't make sense in on-chain sub-calls. Instead, it now has the fields To, From, Value, Method, Params, and ParamsCodec where ParamsCodec is a new field indicating the IPLD codec of the parameters.
  • Importantly, the Msg.CID field has been removed. This field is still present in top-level invocation results, just not inside the execution trace itself.
• The MsgRct field no longer includes a GasUsed field and now has a ReturnCodec field to indicating the IPLD codec of the return value.
• The Error and Duration fields have been removed as these are not set by the FVM. The top-level message "invocation result" retains the Error and Duration fields, they've only been removed from the trace itself.
• Gas Charges no longer include "virtual" gas fields (those starting with v...) or source location information (loc) as neither field is set by the FVM.

A note on "codecs": FVM parameters and return values are IPLD blocks where the "codec" specifies the data encoding. The codec will generally be one of:

• 0x51, 0x71 - CBOR or DagCBOR. You should generally treat these as equivalent.
• 0x55 - Raw bytes.
• 0x0 - Nothing. If the codec is 0x0, the parameter and/or return value should be empty and should be treated as "void" (not specified).

Old ExecutionTrace:

{
  "Msg": {
    "Version": 0,
    "To": "f01234",
    "From": "f04321",
    "Nonce": 1,
    "Value": "0",
    "GasLimit": 0,
    "GasFeeCap": "1234",
    "GasPremium": "1234",
    "Method": 42,
    "Params": "<base64-data-or-null>",
    "CID": {
        "/": "bafyxyz....."
    },
  },
  "MsgRct": {
    "ExitCode": 0,
    "Return": "<base64-data-or-null>",
    "GasUsed": 12345,
  },
  "Error": "",
  "Duration": 568191845,
  "GasCharges": [
    {
      "Name": "OnMethodInvocation",
      "loc": null,
      "tg": 23856,
      "cg": 23856,
      "sg": 0,
      "vtg": 0,
      "vcg": 0,
      "vsg": 0,
      "tt": 0
    },
    {
      "Name": "wasm_exec",
      "loc": null,
      "tg": 1764,
      "cg": 1764,
      "sg": 0,
      "vtg": 0,
      "vcg": 0,
      "vsg": 0,
      "tt": 0
    },
    {
      "Name": "OnSyscall",
      "loc": null,
      "tg": 14000,
      "cg": 14000,
      "sg": 0,
      "vtg": 0,
      "vcg": 0,
      "vsg": 0,
      "tt": 0
    },
  ],
  "Subcalls": [
    {
      "Msg": { },
      "MsgRct": { },
      "Error": "",
      "Duration": 1235,
      "GasCharges": [],
      "Subcalls": [],
    },
  ]
}

New ExecutionTrace:

{
  "Msg": {
    "To": "f01234",
    "From": "f04321",
    "Value": "0",
    "Method": 42,
    "Params": "<base64-data-or-null>",
    "ParamsCodec": 81
  },
  "MsgRct": {
    "ExitCode": 0,
    "Return": "<base64-data-or-null>",
    "ReturnCodec": 81
  },
  "GasCharges": [
    {
      "Name": "OnMethodInvocation",
      "loc": null,
      "tg": 23856,
      "cg": 23856,
      "tt": 0
    },
    {
      "Name": "wasm_exec",
      "loc": null,
      "tg": 1764,
      "cg": 1764,
      "sg": 0,
      "tt": 0
    },
    {
      "Name": "OnSyscall",
      "loc": null,
      "tg": 14000,
      "cg": 14000,
      "sg": 0,
      "tt": 0
    },
  ],
  "Subcalls": [
    {
      "Msg": { },
      "MsgRct": { },
      "GasCharges": [],
      "Subcalls": [],
    },
  ]
}

[arajasek]

Needs the FFI PR merged and tagged in an alpha, but LGTM! This is much cleaner and nicer.

[arajasek]

@Stebalien Thank you for the notes! Can we please:

• wait till chore: merge releases into master #10377 lands
• rebase on top of that
• include your note in an UNRELEASED section at the top of the changelog?