From f36b1da92770344e01c6e4f9c7c489f7a1b348a0 Mon Sep 17 00:00:00 2001 From: Christina Quast Date: Mon, 28 Sep 2026 11:11:52 +0200 Subject: [PATCH] pldm: Rename ipc-api and ipc-server to api and server Every other service names its IPC crates by role, not by transport: services/i2c has api, client, client-ipc, server, services/mctp has api, client-ipc, server. The pldm seam was the only one carrying an ipc- prefix on crates that have no non-IPC counterpart to distinguish them from. Bazel targets follow: pldm_ipc_api becomes pldm_api, pldm_ipc_server becomes pldm_server. The Rust crate names come from the targets, so the use statements in the server move with them. Assisted-by: Claude --- docs/src/design/ipc-service-stack.md | 4 ++-- services/pldm/{ipc-api => api}/BUILD.bazel | 6 +++--- services/pldm/{ipc-api => api}/src/error.rs | 0 services/pldm/{ipc-api => api}/src/lib.rs | 0 services/pldm/{ipc-api => api}/src/status.rs | 0 services/pldm/{ipc-api => api}/src/wire.rs | 0 services/pldm/{ipc-server => server}/BUILD.bazel | 8 ++++---- services/pldm/{ipc-server => server}/src/lib.rs | 16 ++++++++-------- 8 files changed, 17 insertions(+), 17 deletions(-) rename services/pldm/{ipc-api => api}/BUILD.bazel (75%) rename services/pldm/{ipc-api => api}/src/error.rs (100%) rename services/pldm/{ipc-api => api}/src/lib.rs (100%) rename services/pldm/{ipc-api => api}/src/status.rs (100%) rename services/pldm/{ipc-api => api}/src/wire.rs (100%) rename services/pldm/{ipc-server => server}/BUILD.bazel (68%) rename services/pldm/{ipc-server => server}/src/lib.rs (98%) diff --git a/docs/src/design/ipc-service-stack.md b/docs/src/design/ipc-service-stack.md index 3043ca708..992e3fece 100644 --- a/docs/src/design/ipc-service-stack.md +++ b/docs/src/design/ipc-service-stack.md @@ -13,7 +13,7 @@ sequenceDiagram participant AT as AsyncTransaction
(util/ipc) participant K as pw_kernel
(channel) participant S as Server process - participant D as dispatch()
(ipc-server) + participant D as dispatch()
(pldm/server) participant H as FdHandler Note over C,H: Request @@ -58,7 +58,7 @@ path. sequenceDiagram participant C as Client
(test code) participant L as Loopback<D, N>
(util/service) - participant D as dispatch()
(ipc-server) + participant D as dispatch()
(pldm/server) participant H as FdHandler C->>L: start(req: &[u8]) diff --git a/services/pldm/ipc-api/BUILD.bazel b/services/pldm/api/BUILD.bazel similarity index 75% rename from services/pldm/ipc-api/BUILD.bazel rename to services/pldm/api/BUILD.bazel index 076874b28..37aa11ae4 100644 --- a/services/pldm/ipc-api/BUILD.bazel +++ b/services/pldm/api/BUILD.bazel @@ -4,13 +4,13 @@ load("@rules_rust//rust:defs.bzl", "rust_library", "rust_test") rust_library( - name = "pldm_ipc_api", + name = "pldm_api", srcs = glob(["src/**/*.rs"]), edition = "2024", visibility = ["//visibility:public"], ) rust_test( - name = "pldm_ipc_api_test", - crate = ":pldm_ipc_api", + name = "pldm_api_test", + crate = ":pldm_api", ) diff --git a/services/pldm/ipc-api/src/error.rs b/services/pldm/api/src/error.rs similarity index 100% rename from services/pldm/ipc-api/src/error.rs rename to services/pldm/api/src/error.rs diff --git a/services/pldm/ipc-api/src/lib.rs b/services/pldm/api/src/lib.rs similarity index 100% rename from services/pldm/ipc-api/src/lib.rs rename to services/pldm/api/src/lib.rs diff --git a/services/pldm/ipc-api/src/status.rs b/services/pldm/api/src/status.rs similarity index 100% rename from services/pldm/ipc-api/src/status.rs rename to services/pldm/api/src/status.rs diff --git a/services/pldm/ipc-api/src/wire.rs b/services/pldm/api/src/wire.rs similarity index 100% rename from services/pldm/ipc-api/src/wire.rs rename to services/pldm/api/src/wire.rs diff --git a/services/pldm/ipc-server/BUILD.bazel b/services/pldm/server/BUILD.bazel similarity index 68% rename from services/pldm/ipc-server/BUILD.bazel rename to services/pldm/server/BUILD.bazel index 704f385e1..dd318ed45 100644 --- a/services/pldm/ipc-server/BUILD.bazel +++ b/services/pldm/server/BUILD.bazel @@ -4,17 +4,17 @@ load("@rules_rust//rust:defs.bzl", "rust_library", "rust_test") rust_library( - name = "pldm_ipc_server", + name = "pldm_server", srcs = glob(["src/**/*.rs"]), edition = "2024", visibility = ["//visibility:public"], deps = [ - "//services/pldm/ipc-api:pldm_ipc_api", + "//services/pldm/api:pldm_api", "//util/service", ], ) rust_test( - name = "pldm_ipc_server_test", - crate = ":pldm_ipc_server", + name = "pldm_server_test", + crate = ":pldm_server", ) diff --git a/services/pldm/ipc-server/src/lib.rs b/services/pldm/server/src/lib.rs similarity index 98% rename from services/pldm/ipc-server/src/lib.rs rename to services/pldm/server/src/lib.rs index b17b3c61f..ea191bc60 100644 --- a/services/pldm/ipc-server/src/lib.rs +++ b/services/pldm/server/src/lib.rs @@ -11,8 +11,8 @@ #![no_std] -use pldm_ipc_api::wire::{self, PldmOp}; -use pldm_ipc_api::{DenyReason, FdStatus, ResponseCode, WireError}; +use pldm_api::wire::{self, PldmOp}; +use pldm_api::{DenyReason, FdStatus, ResponseCode, WireError}; use util_service::{Dispatch, DispatchError}; /// What the FD does in response to each orchestrator operation. @@ -151,8 +151,8 @@ fn encode_unit_result( #[cfg(test)] mod tests { use super::*; - use pldm_ipc_api::status::TransferMode; - use pldm_ipc_api::wire::{RequestHeader, MAX_RESPONSE_SIZE}; + use pldm_api::status::TransferMode; + use pldm_api::wire::{RequestHeader, MAX_RESPONSE_SIZE}; /// Mock handler that records calls and returns canned responses. struct MockFd { @@ -449,7 +449,7 @@ mod tests { #[cfg(test)] mod loopback_tests { use super::*; - use pldm_ipc_api::wire::MAX_REQUEST_SIZE; + use pldm_api::wire::MAX_REQUEST_SIZE; use util_service::{AsyncTransport, Loopback, TransportError}; /// Start one request and poll the response out, as the client layer @@ -462,9 +462,9 @@ mod loopback_tests { transport.start(req).unwrap(); transport.poll(resp).unwrap().unwrap() } - use pldm_ipc_api::status::TransferMode; - use pldm_ipc_api::wire::{self, MAX_RESPONSE_SIZE}; - use pldm_ipc_api::{DenyReason, FdStatus, ResponseCode}; + use pldm_api::status::TransferMode; + use pldm_api::wire::{self, MAX_RESPONSE_SIZE}; + use pldm_api::{DenyReason, FdStatus, ResponseCode}; /// Minimal handler for loopback tests. struct StubFd {