Skip to content

mctpd: accept set endpoint ID as endpoint #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 11, 2025
Merged

mctpd: accept set endpoint ID as endpoint #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19e2104
mctpd: remove assignments from SET_* macros
khangng-ampere Aug 11, 2025
8b906b4
mctpd: accept set endpoint ID as endpoint
khangng-ampere Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 41 additions & 19 deletions src/mctp-control-spec.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,18 +232,40 @@ struct mctp_ctrl_resp_resolve_endpoint_id {

#define MCTP_CTRL_CC_GET_MCTP_VER_SUPPORT_UNSUPPORTED_TYPE 0x80

/* MCTP Set Endpoint ID response fields
/* MCTP Set Endpoint ID request and response fields
* See DSP0236 v1.3.0 Table 14.
*/

#define MCTP_SET_EID_OPERATION_SHIFT 0x0
#define MCTP_SET_EID_OPERATION_MASK 0x3
#define GET_MCTP_SET_EID_OPERATION(field) \
(((field) >> MCTP_SET_EID_OPERATION_SHIFT) & \
MCTP_SET_EID_OPERATION_MASK)
#define SET_MCTP_SET_EID_OPERATION(status) \
(((status) & MCTP_SET_EID_OPERATION_MASK) \
<< MCTP_SET_EID_OPERATION_SHIFT)
#define MCTP_SET_EID_SET 0x0
#define MCTP_SET_EID_FORCE 0x1
#define MCTP_SET_EID_RESET 0x2
#define MCTP_SET_EID_DISCOVERED 0x3

#define MCTP_EID_ASSIGNMENT_STATUS_SHIFT 0x4
#define MCTP_EID_ASSIGNMENT_STATUS_MASK 0x3
#define SET_MCTP_EID_ASSIGNMENT_STATUS(field, status) \
((field) |= (((status) & MCTP_EID_ASSIGNMENT_STATUS_MASK) \
<< MCTP_EID_ASSIGNMENT_STATUS_SHIFT))
#define SET_MCTP_EID_ASSIGNMENT_STATUS(status) \
(((status) & MCTP_EID_ASSIGNMENT_STATUS_MASK) \
<< MCTP_EID_ASSIGNMENT_STATUS_SHIFT)
#define MCTP_SET_EID_ACCEPTED 0x0
#define MCTP_SET_EID_REJECTED 0x1

#define MCTP_EID_ALLOCATION_STATUS_SHIFT 0x0
#define MCTP_EID_ALLOCATION_STATUS_MASK 0x3
#define SET_MCTP_EID_ALLOCATION_STATUS(status) \
(((status) & MCTP_EID_ALLOCATION_STATUS_MASK) \
<< MCTP_EID_ALLOCATION_STATUS_SHIFT)
#define MCTP_SET_EID_POOL_NONE 0x0
#define MCTP_SET_EID_POOL_REQUIRED 0x1
#define MCTP_SET_EID_POOL_RECEIVED 0x2

/* MCTP Physical Transport Binding identifiers
* See DSP0239 v1.7.0 Table 3.
*/
Expand All @@ -263,26 +285,26 @@ struct mctp_ctrl_resp_resolve_endpoint_id {
#define MCTP_ENDPOINT_TYPE_MASK 0x3
#define MCTP_SIMPLE_ENDPOINT 0
#define MCTP_BUS_OWNER_BRIDGE 1
#define SET_ENDPOINT_TYPE(field, type) \
((field) |= \
(((type) & MCTP_ENDPOINT_TYPE_MASK) << MCTP_ENDPOINT_TYPE_SHIFT))
#define SET_ENDPOINT_TYPE(type) \
(((type) & MCTP_ENDPOINT_TYPE_MASK) << MCTP_ENDPOINT_TYPE_SHIFT)

#define MCTP_ENDPOINT_ID_TYPE_SHIFT 0
#define MCTP_ENDPOINT_ID_TYPE_MASK 0x3
#define MCTP_DYNAMIC_EID 0
#define MCTP_STATIC_EID 1
#define SET_ENDPOINT_ID_TYPE(field, type) \
((field) |= (((type) & MCTP_ENDPOINT_ID_TYPE_MASK) \
<< MCTP_ENDPOINT_ID_TYPE_SHIFT))
#define MCTP_STATIC_EID_MATCHING_PRESENT 2
#define MCTP_STATIC_EID_NOT_MATCHING_PRESENT 3
#define SET_ENDPOINT_ID_TYPE(type) \
(((type) & MCTP_ENDPOINT_ID_TYPE_MASK) << MCTP_ENDPOINT_ID_TYPE_SHIFT)

/* MCTP Routing Table entry types
* See DSP0236 v1.3.0 Table 27.
*/
#define MCTP_ROUTING_ENTRY_PORT_SHIFT 0
#define MCTP_ROUTING_ENTRY_PORT_MASK 0x1F
#define SET_ROUTING_ENTRY_PORT(field, port) \
((field) |= (((port) & MCTP_ROUTING_ENTRY_PORT_MASK) \
<< MCTP_ROUTING_ENTRY_PORT_SHIFT))
#define SET_ROUTING_ENTRY_PORT(port) \
(((port) & MCTP_ROUTING_ENTRY_PORT_MASK) \
<< MCTP_ROUTING_ENTRY_PORT_SHIFT)
#define GET_ROUTING_ENTRY_PORT(field) \
(((field) >> MCTP_ROUTING_ENTRY_PORT_SHIFT) & \
MCTP_ROUTING_ENTRY_PORT_MASK)
Expand All @@ -291,9 +313,9 @@ struct mctp_ctrl_resp_resolve_endpoint_id {
#define MCTP_ROUTING_ENTRY_ASSIGNMENT_TYPE_MASK 0x1
#define MCTP_DYNAMIC_ASSIGNMENT 0
#define MCTP_STATIC_ASSIGNMENT 1
#define SET_ROUTING_ENTRY_ASSIGNMENT_TYPE(field, type) \
((field) |= (((type) & MCTP_ROUTING_ENTRY_ASSIGNMENT_TYPE_MASK) \
<< MCTP_ROUTING_ENTRY_ASSIGNMENT_TYPE_SHIFT))
#define SET_ROUTING_ENTRY_ASSIGNMENT_TYPE(type) \
(((type) & MCTP_ROUTING_ENTRY_ASSIGNMENT_TYPE_MASK) \
<< MCTP_ROUTING_ENTRY_ASSIGNMENT_TYPE_SHIFT)
#define GET_ROUTING_ENTRY_ASSIGNMENT_TYPE(field) \
(((field) >> MCTP_ROUTING_ENTRY_ASSIGNMENT_TYPE_SHIFT) & \
MCTP_ROUTING_ENTRY_ASSIGNMENT_TYPE_MASK)
Expand All @@ -304,9 +326,9 @@ struct mctp_ctrl_resp_resolve_endpoint_id {
#define MCTP_ROUTING_ENTRY_BRIDGE_AND_ENDPOINTS 0x01
#define MCTP_ROUTING_ENTRY_BRIDGE 0x02
#define MCTP_ROUTING_ENTRY_ENDPOINTS 0x03
#define SET_ROUTING_ENTRY_TYPE(field, type) \
((field) |= (((type) & MCTP_ROUTING_ENTRY_TYPE_MASK) \
<< MCTP_ROUTING_ENTRY_TYPE_SHIFT))
#define SET_ROUTING_ENTRY_TYPE(type) \
(((type) & MCTP_ROUTING_ENTRY_TYPE_MASK) \
<< MCTP_ROUTING_ENTRY_TYPE_SHIFT)
#define GET_ROUTING_ENTRY_TYPE(field) \
(((field) >> MCTP_ROUTING_ENTRY_TYPE_SHIFT) & \
MCTP_ROUTING_ENTRY_TYPE_MASK)
Expand Down
172 changes: 162 additions & 10 deletions src/mctpd.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,12 @@ static int emit_interface_added(struct link *link);
static int emit_interface_removed(struct link *link);
static int emit_net_added(struct ctx *ctx, struct net *net);
static int emit_net_removed(struct ctx *ctx, struct net *net);
static int add_peer(struct ctx *ctx, const dest_phys *dest, mctp_eid_t eid,
uint32_t net, struct peer **ret_peer);
static int add_peer_from_addr(struct ctx *ctx,
const struct sockaddr_mctp_ext *addr,
struct peer **ret_peer);
static int remove_peer(struct peer *peer);
static int query_peer_properties(struct peer *peer);
static int setup_added_peer(struct peer *peer);
static void add_peer_route(struct peer *peer);
Expand Down Expand Up @@ -631,32 +637,162 @@ static int reply_message(struct ctx *ctx, int sd, const void *resp,
return 0;
}

// Handles new Incoming Set Endpoint ID request
/// Clear interface local addresses and remote cached peers
static void clear_interface_addrs(struct ctx *ctx, int ifindex)
{
mctp_eid_t *addrs;
size_t addrs_num;
size_t i;
int rc;

// Remove all addresses on this interface
addrs = mctp_nl_addrs_byindex(ctx->nl, ifindex, &addrs_num);
if (addrs) {
for (i = 0; i < addrs_num; i++) {
rc = mctp_nl_addr_del(ctx->nl, addrs[i], ifindex);
if (rc < 0) {
errx(rc,
"ERR: cannot remove local eid %d ifindex %d",
addrs[i], ifindex);
}
}
free(addrs);
}

// Remove all peers on this interface
for (i = 0; i < ctx->num_peers; i++) {
struct peer *p = ctx->peers[i];
if (p->state == REMOTE && p->phys.ifindex == ifindex) {
remove_peer(p);
}
}
}

/// Handles new Incoming Set Endpoint ID request
///
/// This currently handles two cases: Top-most bus owner and Endpoint. No bridge
/// support yet.
///
///
/// # References
///
/// The DSP0236 1.3.3 specification describes Set Endpoint ID in the following
/// sections:
///
/// - 8.18 Endpoint ID assignment and endpoint ID pools
///
/// > A non-bridge device that is connected to multiple different buses
/// > will have one EID for each bus it is attached to.
///
/// - 9.1.3 EID options for MCTP bridge
///
/// > There are three general options:
/// > - The bridge uses a single MCTP endpoint
/// > - The bridge uses an MCTP endpoint for each bus that connects to a bus owner
/// > - The bridge uses an MCTP endpoint for every bus to which it connects
///
/// - 12.4 Set Endpoint ID
///
/// [the whole section]
///
static int handle_control_set_endpoint_id(struct ctx *ctx, int sd,
struct sockaddr_mctp_ext *addr,
const uint8_t *buf,
const size_t buf_size)
{
struct mctp_ctrl_cmd_set_eid *req = NULL;
struct mctp_ctrl_resp_set_eid respi = { 0 }, *resp = &respi;
struct link *link_data;
struct peer *peer;
size_t resp_len;
int rc;

if (buf_size < sizeof(*req)) {
warnx("short Set Endpoint ID message");
bug_warn("short Set Endpoint ID message");
return -ENOMSG;
}
req = (void *)buf;

link_data = mctp_nl_get_link_userdata(ctx->nl, addr->smctp_ifindex);
if (!link_data) {
bug_warn("unconfigured interface %d", addr->smctp_ifindex);
return -ENOENT;
}

mctp_ctrl_msg_hdr_init_resp(&respi.ctrl_hdr, req->ctrl_hdr);
resp->completion_code = MCTP_CTRL_CC_SUCCESS;
resp->status = 0x01 << 4; // Already assigned, TODO
resp->eid_set = local_addr(ctx, addr->smctp_ifindex);
resp->eid_pool_size = 0;
resp_len = sizeof(struct mctp_ctrl_resp_set_eid);

// TODO: learn busowner route and neigh
// reject if we are bus owner
if (link_data->role == ENDPOINT_ROLE_BUS_OWNER) {
warnx("Rejected set EID %d request from (%s) because we are the bus owner",
req->eid, ext_addr_tostr(addr));
resp->completion_code = MCTP_CTRL_CC_ERROR_UNSUPPORTED_CMD;
resp_len = sizeof(struct mctp_ctrl_resp);
return reply_message(ctx, sd, resp, resp_len, addr);
}

return reply_message(ctx, sd, resp, resp_len, addr);
// error if EID is invalid
if (req->eid < 0x08 || req->eid == 0xFF) {
warnx("Rejected invalid EID %d", req->eid);
resp->completion_code = MCTP_CTRL_CC_ERROR_INVALID_DATA;
resp_len = sizeof(struct mctp_ctrl_resp);
return reply_message(ctx, sd, resp, resp_len, addr);
}

switch (GET_MCTP_SET_EID_OPERATION(req->operation)) {
case MCTP_SET_EID_SET:
// TODO: for bridges, only accept EIDs from originator bus
//
// We currently only support endpoints, which require separate EIDs on
// interfaces (see function comment). For bridges, we might need to support
// sharing a single EID for multiple interfaces. We will need to:
// - track the first bus assigned the EID.
// - policy for propagating EID to other interfaces (see bridge EID options in
// function comment above)

// fallthrough
case MCTP_SET_EID_FORCE:

fprintf(stderr, "setting EID to %d\n", req->eid);

// When we are assigned a new EID, assume our world view of the network
// reachable from this interface has been stale. Reset everything.
clear_interface_addrs(ctx, addr->smctp_ifindex);

rc = mctp_nl_addr_add(ctx->nl, req->eid, addr->smctp_ifindex);
if (rc < 0) {
warnx("ERR: cannot add local eid %d to ifindex %d",
req->eid, addr->smctp_ifindex);
resp->completion_code = MCTP_CTRL_CC_ERROR_NOT_READY;
}

rc = add_peer_from_addr(ctx, addr, &peer);
if (rc == 0) {
rc = setup_added_peer(peer);
}
if (rc < 0) {
warnx("ERR: cannot add bus owner to object lists");
}

resp->status =
SET_MCTP_EID_ASSIGNMENT_STATUS(MCTP_SET_EID_ACCEPTED) |
SET_MCTP_EID_ALLOCATION_STATUS(MCTP_SET_EID_POOL_NONE);
resp->eid_set = req->eid;
resp->eid_pool_size = 0;
fprintf(stderr, "Accepted set eid %d\n", req->eid);
return reply_message(ctx, sd, resp, resp_len, addr);

case MCTP_SET_EID_DISCOVERED:
case MCTP_SET_EID_RESET:
// unsupported
resp->completion_code = MCTP_CTRL_CC_ERROR_INVALID_DATA;
return reply_message(ctx, sd, resp, resp_len, addr);

default:
bug_warn("unreachable Set EID operation code");
return -EINVAL;
}
}

static int
Expand Down Expand Up @@ -719,10 +855,12 @@ static int handle_control_get_endpoint_id(struct ctx *ctx, int sd,
mctp_ctrl_msg_hdr_init_resp(&resp->ctrl_hdr, req->ctrl_hdr);

resp->eid = local_addr(ctx, addr->smctp_ifindex);

resp->eid_type = 0;
if (ctx->default_role == ENDPOINT_ROLE_BUS_OWNER)
SET_ENDPOINT_TYPE(resp->eid_type, MCTP_BUS_OWNER_BRIDGE);
// 10b = 2 = static EID supported, matches currently assigned.
SET_ENDPOINT_ID_TYPE(resp->eid_type, 2);
resp->eid_type |= SET_ENDPOINT_TYPE(MCTP_BUS_OWNER_BRIDGE);
resp->eid_type |=
SET_ENDPOINT_ID_TYPE(MCTP_STATIC_EID_MATCHING_PRESENT);
// TODO: medium specific information

// Get Endpoint ID is typically send and reply using physical addressing.
Expand Down Expand Up @@ -1476,6 +1614,20 @@ static int add_peer(struct ctx *ctx, const dest_phys *dest, mctp_eid_t eid,
return 0;
}

static int add_peer_from_addr(struct ctx *ctx,
const struct sockaddr_mctp_ext *addr,
struct peer **ret_peer)
{
struct dest_phys phys;

phys.ifindex = addr->smctp_ifindex;
memcpy(phys.hwaddr, addr->smctp_haddr, addr->smctp_halen);
phys.hwaddr_len = addr->smctp_halen;

return add_peer(ctx, &phys, addr->smctp_base.smctp_addr.s_addr,
addr->smctp_base.smctp_network, ret_peer);
}

static int check_peer_struct(const struct peer *peer, const struct net *n)
{
if (n->net != peer->net) {
Expand Down
Loading