教學課程：在驅動程式之間傳遞中繼資料

本指南說明如何使用中繼資料程式庫，將中繼資料從一個驅動程式庫傳遞至另一個驅動程式。中繼資料是驅動程式庫建立的任意資料，應可供繫結至子節點的驅動程式存取。一般來說，驅動程式可以自行建立 FIDL 通訊協定，以便傳遞中繼資料，不過，中繼資料程式庫提供的功能可在驅動程式之間傳遞中繼資料，且程式碼較少。

如需驅動程式傳送、擷取及轉寄中繼資料的範例，請參閱這篇文章。

中繼資料定義

首先，中繼資料類型必須定義為 FIDL 類型，並加上 @serializable 註解：

library fuchsia.examples.metadata;

// Type of the metadata to be passed.
// Make sure to annotate it with `@serializable`.
@serializable
type Metadata = table {
    1: test_property string:MAX;
};

這項中繼資料會透過 fuchsia.driver.metadata/Service FIDL 服務，在驅動程式庫的傳出命名空間中提供。驅動程式庫傳出命名空間中的 FIDL 服務名稱不會是 fuchsia.driver.metadata.Service。而是會是 FIDL 類型的可序列化名稱。只有在 Fidl 類型加上 @serializable 註解時，系統才會建立可序列化的名稱。

FIDL 程式庫的建構目標將定義為以下內容：

fidl("fuchsia.examples.metadata") {
  sources = [ "fuchsia.examples.metadata.fidl" ]
}

傳送中繼資料

初始設定

假設我們有一個驅動程式庫，想要將中繼資料傳送至子項：

#include <lib/driver/component/cpp/driver_export.h>

class Sender : public fdf::DriverBase {
 public:
  Sender(fdf::DriverStartArgs start_args, fdf::UnownedSynchronizedDispatcher driver_dispatcher)
      : DriverBase("sender", std::move(start_args), std::move(driver_dispatcher)) {}
};

FUCHSIA_DRIVER_EXPORT(Sender);

元件資訊清單如下所示：

{
    include: [
        "inspect/client.shard.cml",
        "syslog/client.shard.cml",
    ],
    program: {
        runner: "driver",
        binary: "driver/sender.so",
        bind: "meta/bind/sender.bindbc",
    },
}

其建構目標的定義如下：

fuchsia_cc_driver("driver") {
  testonly = true
  output_name = "sender"
  sources = [
    "sender.cc",
  ]
  deps = [
    "//src/devices/lib/driver:driver_runtime",
  ]
}

fuchsia_driver_component("component") {
  testonly = true
  component_name = "sender"
  manifest = "meta/sender.cml"
  deps = [
    ":driver",
    ":bind", # Bind rules not specified in this tutorial.
  ]
  info = "sender.json" # Info not specified in this tutorial.
}

傳送程序

為了讓這個驅動程式庫將中繼資料傳送至子項驅動程式，它必須建立 fdf_metadata::MetadataServer 類別的例項，並透過呼叫其 fdf_metadata::MetadataServer::SetMetadata() 方法設定中繼資料，然後透過呼叫其 fdf_metadata::MetadataServer::Serve() 方法，將中繼資料提供至驅動程式庫程式的傳出目錄，並將 fdf_metadata::MetadataServer::MakeOffer() 建立的中繼資料伺服器的優惠傳遞至子節點：


// Defines the fuchsia.examples.metadata types in C++.
#include <fidl/fuchsia.examples.metadata/cpp/fidl.h>

// Defines fdf::MetadataServer.
#include <lib/driver/metadata/cpp/metadata_server.h>

class Sender : public fdf::DriverBase {
 public:
  zx::result<> Start() override {
    // Set the metadata to be served.
    fuchsia_examples_metadata::Metadata metadata{{.test_property = "test value"}};
    ZX_ASSERT(metadata_server_.SetMetadata(std::move(metadata)).is_ok());

    // Serve the metadata to the driver's outgoing directory.
    ZX_ASSERT(metadata_server_.Serve(*outgoing(), dispatcher()).is_ok());

    // The metadata server's offer must be provided to the child node.
    std::vector<fuchsia_driver_framework::Offer> offers{
      metadata_server_.MakeOffer()};

    zx::result child = AddChild("child", {}, offers);
    if (child.is_error()) {
      return child.take_error();
    }

    return zx::ok();
  }

 private:
  // Responsible for serving metadata.
  fdf_metadata::MetadataServer<fuchsia_examples_metadata::Metadata> metadata_server_;
};

fdf_metadata::MetadataServer::SetMetadata() 可在 fdf_metadata::MetadataServer::Serve() 之前或之後多次呼叫，中繼資料伺服器會提供最新的中繼資料例項。如果子驅動程式庫在嘗試擷取中繼資料之前未呼叫 fdf_metadata::MetadataServer::SetMetadata()，就無法擷取中繼資料。

driver 建構目標需要更新，以納入中繼資料程式庫和定義中繼資料類型的 FIDL 程式庫：

fuchsia_cc_driver("driver") {
  testonly = true
  output_name = "sender"
  sources = [
    "sender.cc",
  ]
  deps = [
    "//src/devices/lib/driver:driver_runtime",

    # This should be the fuchsia.examples.metadata FIDL library's C++ target.
    ":fuchsia.examples.metadata_cpp",

    # This library contains `fdf::MetadataServer`.
    "//sdk/lib/driver/metadata/cpp",
  ]
}

公開中繼資料服務

最後，驅動程式庫需要在其元件資訊清單中宣告並公開 fuchsia.examples.metadata.Metadata FIDL 服務：

{
    include: [
        "inspect/client.shard.cml",
        "syslog/client.shard.cml",
    ],
    program: {
        runner: "driver",
        binary: "driver/sender.so",
        bind: "meta/bind/sender.bindbc",
    },
    capabilities: [
        { service: "fuchsia.examples.metadata.Metadata" },
    ],
    expose: [
        {
            service: "fuchsia.examples.metadata.Metadata",
            from: "self",
        },
    ],
}

從技術層面來說，並沒有 fuchsia.examples.metadata.Metadata FIDL 服務。實際上，fdf_metadata::MetadataServer 會提供 fuchsia.driver.metadata/Service FIDL 服務，以便傳送中繼資料。不過，fdf_metadata::MetadataServer 不會像一般 FIDL 服務一樣，以 fuchsia.driver.metadata.Service 這個名稱提供這項服務。相反地，服務會以中繼資料類型的可序列化名稱提供。在本例中，就是 fuchsia.examples.metadata.Metadata。您可以在 C++ 欄位 fuchsia_examples_metadata::Metadata::kSerializableName 中找到這個名稱。這可讓接收驅動程式庫識別傳遞的中繼資料類型。這表示即使該服務不存在，驅動程式庫仍需要宣告並公開 fuchsia.examples.metadata.Metadata FIDL 服務。

擷取中繼資料

初始設定

假設有個驅動程式庫想要從其父項驅動程式庫擷取中繼資料：

#include <lib/driver/component/cpp/driver_export.h>

class Retriever : public fdf::DriverBase {
 public:
  Retriever(fdf::DriverStartArgs start_args, fdf::UnownedSynchronizedDispatcher driver_dispatcher)
      : DriverBase("retriever", std::move(start_args), std::move(driver_dispatcher)) {}
};

FUCHSIA_DRIVER_EXPORT(Retriever);

元件資訊清單如下所示：

{
    include: [
        "inspect/client.shard.cml",
        "syslog/client.shard.cml",
    ],
    program: {
        runner: "driver",
        binary: "driver/retriever.so",
        bind: "meta/bind/retriever.bindbc",
    },
}

其建構目標的定義如下：

fuchsia_cc_driver("driver") {
  testonly = true
  output_name = "retriever"
  sources = [
    "retriever.cc",
  ]
  deps = [
    "//src/devices/lib/driver:driver_runtime",
  ]
}

fuchsia_driver_component("component") {
  testonly = true
  component_name = "retriever"
  manifest = "meta/retriever.cml"
  deps = [
    ":driver",
    ":bind", # Bind rules not specified in this tutorial.
  ]
  info = "retriever.json" # Info not specified in this tutorial.
}

擷取程序

為了讓驅動程式庫從父項驅動程式庫擷取中繼資料，驅動程式庫需要呼叫 fdf_metadata::GetMetadata()：

// Defines the fuchsia.examples.metadata types in C++.
#include <fidl/fuchsia.examples.metadata/cpp/fidl.h>

// Defines fdf::GetMetadata().
#include <lib/driver/metadata/cpp/metadata.h>

class Retriever : public fdf::DriverBase {
 public:
  zx::result<> Start() override {
    zx::result<fuchsia_examples_metadata::Metadata> metadata =
      fdf_metadata::GetMetadata<fuchsia_examples_metadata::Metadata>(incoming());
    ZX_ASSERT(!metadata.is_error());

    return zx::ok();
  }
};

driver 建構目標需要更新，以便依附中繼資料程式庫和定義中繼資料類型的 FIDL 程式庫：

fuchsia_cc_driver("driver") {
  testonly = true
  output_name = "retriever"
  sources = [
    "retriever.cc",
  ]
  deps = [
    "//src/devices/lib/driver:driver_runtime",

    # This should be the fuchsia.examples.metadata FIDL library's C++ target.
    ":fuchsia.examples.metadata_cpp",

    # This library contains `fdf::GetMetadata()`.
    "//sdk/lib/driver/metadata/cpp",
  ]
}

使用中繼資料服務

最後，驅動程式庫需要在元件資訊清單中宣告 fuchsia.examples.metadata.Metadata FIDL 服務的用法：

{
    include: [
        "inspect/client.shard.cml",
        "syslog/client.shard.cml",
    ],
    program: {
        runner: "driver",
        binary: "driver/retriever.so",
        bind: "meta/bind/retriever.bindbc",
    },
    use: [
        { service: "fuchsia.examples.metadata.Metadata" },
    ],
}

轉寄中繼資料

初始設定

假設有個驅動程式庫想要從父項驅動程式庫擷取中繼資料，並將該中繼資料轉送至子項驅動程式：

#include <lib/driver/component/cpp/driver_export.h>

class Forwarder : public fdf::DriverBase {
 public:
  Forwarder(fdf::DriverStartArgs start_args, fdf::UnownedSynchronizedDispatcher driver_dispatcher)
      : DriverBase("forwarder", std::move(start_args), std::move(driver_dispatcher)) {}
};

FUCHSIA_DRIVER_EXPORT(Forwarder);

元件資訊清單如下所示：

{
    include: [
        "inspect/client.shard.cml",
        "syslog/client.shard.cml",
    ],
    program: {
        runner: "driver",
        binary: "driver/forwarder.so",
        bind: "meta/bind/forwarder.bindbc",
    },
}

其建構目標的定義如下：

fuchsia_cc_driver("driver") {
  testonly = true
  output_name = "forwarder"
  sources = [
    "forwarder.cc",
  ]
  deps = [
    "//src/devices/lib/driver:driver_runtime",
  ]
}

fuchsia_driver_component("component") {
  testonly = true
  component_name = "forward"
  manifest = "meta/forward.cml"
  deps = [
    ":driver",
    ":bind", # Bind rules not specified in this tutorial.
  ]
  info = "forward.json" # Info not specified in this tutorial.
}

正向處理

為了讓驅動程式庫將中繼資料從父項驅動程式庫程式轉送至子項驅動程式，驅動程式需要建立 fdf_metadata::MetadataServer 類別的例項，並透過呼叫其 fdf_metadata::MetadataServer::ForwardMetadata() 方法設定中繼資料，然後透過呼叫其 fdf_metadata::MetadataServer::Serve() 方法將中繼資料提供給驅動程式庫的傳出目錄，並將 fdf_metadata::MetadataServer::MakeOffer() 建立的中繼資料伺服器的優惠傳遞至子節點：

// Defines the fuchsia.examples.metadata types in C++.
#include <fidl/fuchsia.examples.metadata/cpp/fidl.h>

// Defines fdf::MetadataServer.
#include <lib/driver/metadata/cpp/metadata_server.h>

class Forwarder : public fdf::DriverBase {
 public:
  zx::result<> Start() override {
    // Set metadata using the driver's parent driver metadata.
    ZX_ASSERT(metadata_server_.ForwardMetadata(incoming()),is_ok());

    // Serve the metadata to the driver's outgoing directory.
    ZX_ASSERT(metadata_server_.Serve(*outgoing(), dispatcher()).is_ok());

    // The metadata server's offer must be provided to the child node.
    std::vector<fuchsia_driver_framework::Offer> offers{
      metadata_server_.MakeOffer()};

    zx::result child = AddChild("child", {}, offers);
    if (child.is_error()) {
      return child.take_error();
    }

    return zx::ok();
  }

 private:
  // Responsible for serving metadata.
  fdf_metadata::MetadataServer<fuchsia_examples_metadata::Metadata> metadata_server_;
};

請注意，fdf_metadata::MetadataServer::ForwardMetadata() 不會在 fdf_metadata::MetadataServer::ForwardMetadata() 呼叫後，檢查父項驅動程式庫是否變更所提供的中繼資料。驅動程式必須再次呼叫 fdf_metadata::MetadataServer::ForwardMetadata()，才能納入變更。

driver 建構目標需要更新，以便依賴定義中繼資料類型的中繼資料程式庫和 FIDL 程式庫：

fuchsia_cc_driver("driver") {
  testonly = true
  output_name = "forwarder"
  sources = [
    "forwarder.cc",
  ]
  deps = [
    "//src/devices/lib/driver:driver_runtime",

    # This should be the fuchsia.examples.metadata FIDL library's C++ target.
    ":fuchsia.examples.metadata_cpp",

    # This library contains `fdf::MetadataServer`.
    "//sdk/lib/driver/metadata/cpp",
  ]
}

公開及使用中繼資料服務

最後，驅動程式庫需要在其元件資訊清單中宣告、使用及公開 fuchsia.examples.metadata.Metadata FIDL 服務：

{
    include: [
        "inspect/client.shard.cml",
        "syslog/client.shard.cml",
    ],
    program: {
        runner: "driver",
        binary: "driver/forwarder.so",
        bind: "meta/bind/forwarder.bindbc",
    },
    capabilities: [
        { service: "fuchsia.examples.metadata.Metadata" },
    ],
    expose: [
        {
            service: "fuchsia.examples.metadata.Metadata",
            from: "self",
        },
    ],
    use: [
        { service: "fuchsia.examples.metadata.Metadata" },
    ],
}