#include "ncsi_util.hpp" #include #include #include #include #include #include #include #include #include #include namespace phosphor { namespace network { namespace ncsi { using CallBack = int (*)(struct nl_msg* msg, void* arg); static stdplus::StrBuf toHexStr(std::span c) noexcept { stdplus::StrBuf ret; if (c.empty()) { return ret; } stdplus::IntToStr<16, uint8_t> its; auto oit = ret.append(c.size() * 3); auto cit = c.begin(); oit = its(oit, *cit++, 2); for (; cit != c.end(); ++cit) { *oit++ = ' '; oit = its(oit, *cit, 2); } *oit = 0; return ret; } namespace internal { struct NCSIPacketHeader { uint8_t MCID; uint8_t revision; uint8_t reserved; uint8_t id; uint8_t type; uint8_t channel; uint16_t length; uint32_t rsvd[2]; }; class Command { public: Command() = delete; ~Command() = default; Command(const Command&) = delete; Command& operator=(const Command&) = delete; Command(Command&&) = default; Command& operator=(Command&&) = default; Command( int ncsiCmd, int operation = DEFAULT_VALUE, std::span p = std::span()) : ncsi_cmd(ncsiCmd), operation(operation), payload(p) {} int ncsi_cmd; int operation; std::span payload; }; using nlMsgPtr = std::unique_ptr; using nlSocketPtr = std::unique_ptr; CallBack infoCallBack = [](struct nl_msg* msg, void* arg) { using namespace phosphor::network::ncsi; auto nlh = nlmsg_hdr(msg); struct nlattr* tb[NCSI_ATTR_MAX + 1] = {nullptr}; struct nla_policy ncsiPolicy[NCSI_ATTR_MAX + 1] = { {NLA_UNSPEC, 0, 0}, {NLA_U32, 0, 0}, {NLA_NESTED, 0, 0}, {NLA_U32, 0, 0}, {NLA_U32, 0, 0}, }; struct nlattr* packagetb[NCSI_PKG_ATTR_MAX + 1] = {nullptr}; struct nla_policy packagePolicy[NCSI_PKG_ATTR_MAX + 1] = { {NLA_UNSPEC, 0, 0}, {NLA_NESTED, 0, 0}, {NLA_U32, 0, 0}, {NLA_FLAG, 0, 0}, {NLA_NESTED, 0, 0}, }; struct nlattr* channeltb[NCSI_CHANNEL_ATTR_MAX + 1] = {nullptr}; struct nla_policy channelPolicy[NCSI_CHANNEL_ATTR_MAX + 1] = { {NLA_UNSPEC, 0, 0}, {NLA_NESTED, 0, 0}, {NLA_U32, 0, 0}, {NLA_FLAG, 0, 0}, {NLA_NESTED, 0, 0}, {NLA_UNSPEC, 0, 0}, }; *(int*)arg = 0; auto ret = genlmsg_parse(nlh, 0, tb, NCSI_ATTR_MAX, ncsiPolicy); if (!tb[NCSI_ATTR_PACKAGE_LIST]) { lg2::error("No Packages"); return -1; } auto attrTgt = static_cast(nla_data(tb[NCSI_ATTR_PACKAGE_LIST])); if (!attrTgt) { lg2::error("Package list attribute is null"); return -1; } auto rem = nla_len(tb[NCSI_ATTR_PACKAGE_LIST]); nla_for_each_nested(attrTgt, tb[NCSI_ATTR_PACKAGE_LIST], rem) { ret = nla_parse_nested(packagetb, NCSI_PKG_ATTR_MAX, attrTgt, packagePolicy); if (ret < 0) { lg2::error("Failed to parse package nested"); return -1; } if (packagetb[NCSI_PKG_ATTR_ID]) { auto attrID = nla_get_u32(packagetb[NCSI_PKG_ATTR_ID]); lg2::debug("Package has id : {ATTR_ID}", "ATTR_ID", lg2::hex, attrID); } else { lg2::debug("Package with no id"); } if (packagetb[NCSI_PKG_ATTR_FORCED]) { lg2::debug("This package is forced"); } auto channelListTarget = static_cast( nla_data(packagetb[NCSI_PKG_ATTR_CHANNEL_LIST])); auto channelrem = nla_len(packagetb[NCSI_PKG_ATTR_CHANNEL_LIST]); nla_for_each_nested(channelListTarget, packagetb[NCSI_PKG_ATTR_CHANNEL_LIST], channelrem) { ret = nla_parse_nested(channeltb, NCSI_CHANNEL_ATTR_MAX, channelListTarget, channelPolicy); if (ret < 0) { lg2::error("Failed to parse channel nested"); return -1; } if (channeltb[NCSI_CHANNEL_ATTR_ID]) { auto channel = nla_get_u32(channeltb[NCSI_CHANNEL_ATTR_ID]); if (channeltb[NCSI_CHANNEL_ATTR_ACTIVE]) { lg2::debug("Channel Active : {CHANNEL}", "CHANNEL", lg2::hex, channel); } else { lg2::debug("Channel Not Active : {CHANNEL}", "CHANNEL", lg2::hex, channel); } if (channeltb[NCSI_CHANNEL_ATTR_FORCED]) { lg2::debug("Channel is forced"); } } else { lg2::debug("Channel with no ID"); } if (channeltb[NCSI_CHANNEL_ATTR_VERSION_MAJOR]) { auto major = nla_get_u32(channeltb[NCSI_CHANNEL_ATTR_VERSION_MAJOR]); lg2::debug("Channel Major Version : {CHANNEL_MAJOR_VERSION}", "CHANNEL_MAJOR_VERSION", lg2::hex, major); } if (channeltb[NCSI_CHANNEL_ATTR_VERSION_MINOR]) { auto minor = nla_get_u32(channeltb[NCSI_CHANNEL_ATTR_VERSION_MINOR]); lg2::debug("Channel Minor Version : {CHANNEL_MINOR_VERSION}", "CHANNEL_MINOR_VERSION", lg2::hex, minor); } if (channeltb[NCSI_CHANNEL_ATTR_VERSION_STR]) { auto str = nla_get_string(channeltb[NCSI_CHANNEL_ATTR_VERSION_STR]); lg2::debug("Channel Version Str : {CHANNEL_VERSION_STR}", "CHANNEL_VERSION_STR", str); } if (channeltb[NCSI_CHANNEL_ATTR_LINK_STATE]) { auto link = nla_get_u32(channeltb[NCSI_CHANNEL_ATTR_LINK_STATE]); lg2::debug("Channel Link State : {LINK_STATE}", "LINK_STATE", lg2::hex, link); } if (channeltb[NCSI_CHANNEL_ATTR_VLAN_LIST]) { lg2::debug("Active Vlan ids"); auto vids = channeltb[NCSI_CHANNEL_ATTR_VLAN_LIST]; auto vid = static_cast(nla_data(vids)); auto len = nla_len(vids); while (nla_ok(vid, len)) { auto id = nla_get_u16(vid); lg2::debug("VID : {VLAN_ID}", "VLAN_ID", id); vid = nla_next(vid, &len); } } } } return (int)NL_SKIP; }; CallBack sendCallBack = [](struct nl_msg* msg, void* arg) { using namespace phosphor::network::ncsi; auto nlh = nlmsg_hdr(msg); struct nlattr* tb[NCSI_ATTR_MAX + 1] = {nullptr}; static struct nla_policy ncsiPolicy[NCSI_ATTR_MAX + 1] = { {NLA_UNSPEC, 0, 0}, {NLA_U32, 0, 0}, {NLA_NESTED, 0, 0}, {NLA_U32, 0, 0}, {NLA_U32, 0, 0}, {NLA_BINARY, 0, 0}, {NLA_FLAG, 0, 0}, {NLA_U32, 0, 0}, {NLA_U32, 0, 0}, }; *(int*)arg = 0; auto ret = genlmsg_parse(nlh, 0, tb, NCSI_ATTR_MAX, ncsiPolicy); if (ret) { lg2::error("Failed to parse package"); return ret; } if (tb[NCSI_ATTR_DATA] == nullptr) { lg2::error("Response: No data"); return -1; } auto data_len = nla_len(tb[NCSI_ATTR_DATA]) - sizeof(NCSIPacketHeader); unsigned char* data = (unsigned char*)nla_data(tb[NCSI_ATTR_DATA]) + sizeof(NCSIPacketHeader); // Dump the response to stdout. Enhancement: option to save response data auto str = toHexStr(std::span(data, data_len)); lg2::debug("Response {DATA_LEN} bytes: {DATA}", "DATA_LEN", data_len, "DATA", str); return 0; }; int applyCmd(int ifindex, const Command& cmd, int package = DEFAULT_VALUE, int channel = DEFAULT_VALUE, int flags = NONE, CallBack function = nullptr) { int cb_ret = 0; nlSocketPtr socket(nl_socket_alloc(), &::nl_socket_free); if (socket == nullptr) { lg2::error("Unable to allocate memory for the socket"); return -ENOMEM; } auto ret = genl_connect(socket.get()); if (ret < 0) { lg2::error("Failed to open the socket , RC : {RC}", "RC", ret); return ret; } auto driverID = genl_ctrl_resolve(socket.get(), "NCSI"); if (driverID < 0) { lg2::error("Failed to resolve, RC : {RC}", "RC", ret); return driverID; } nlMsgPtr msg(nlmsg_alloc(), &::nlmsg_free); if (msg == nullptr) { lg2::error("Unable to allocate memory for the message"); return -ENOMEM; } auto msgHdr = genlmsg_put(msg.get(), NL_AUTO_PORT, NL_AUTO_SEQ, driverID, 0, flags, cmd.ncsi_cmd, 0); if (!msgHdr) { lg2::error("Unable to add the netlink headers , COMMAND : {COMMAND}", "COMMAND", cmd.ncsi_cmd); return -ENOMEM; } if (package != DEFAULT_VALUE) { ret = nla_put_u32(msg.get(), ncsi_nl_attrs::NCSI_ATTR_PACKAGE_ID, package); if (ret < 0) { lg2::error("Failed to set the attribute , RC : {RC} PACKAGE " "{PACKAGE}", "RC", ret, "PACKAGE", lg2::hex, package); return ret; } } if (channel != DEFAULT_VALUE) { ret = nla_put_u32(msg.get(), ncsi_nl_attrs::NCSI_ATTR_CHANNEL_ID, channel); if (ret < 0) { lg2::error("Failed to set the attribute , RC : {RC} CHANNEL : " "{CHANNEL}", "RC", ret, "CHANNEL", lg2::hex, channel); return ret; } } ret = nla_put_u32(msg.get(), ncsi_nl_attrs::NCSI_ATTR_IFINDEX, ifindex); if (ret < 0) { lg2::error("Failed to set the attribute , RC : {RC} INTERFACE : " "{INTERFACE}", "RC", ret, "INTERFACE", lg2::hex, ifindex); return ret; } if (cmd.operation != DEFAULT_VALUE) { std::vector pl(sizeof(NCSIPacketHeader) + cmd.payload.size()); NCSIPacketHeader* hdr = (NCSIPacketHeader*)pl.data(); std::copy(cmd.payload.begin(), cmd.payload.end(), pl.begin() + sizeof(NCSIPacketHeader)); hdr->type = cmd.operation; hdr->length = htons(cmd.payload.size()); ret = nla_put(msg.get(), ncsi_nl_attrs::NCSI_ATTR_DATA, pl.size(), pl.data()); if (ret < 0) { lg2::error("Failed to set the data attribute, RC : {RC}", "RC", ret); return ret; } nl_socket_disable_seq_check(socket.get()); } if (function) { cb_ret = 1; // Add a callback function to the socket nl_socket_modify_cb(socket.get(), NL_CB_VALID, NL_CB_CUSTOM, function, &cb_ret); } ret = nl_send_auto(socket.get(), msg.get()); if (ret < 0) { lg2::error("Failed to send the message , RC : {RC}", "RC", ret); return ret; } do { ret = nl_recvmsgs_default(socket.get()); if (ret < 0) { lg2::error("Failed to receive the message , RC : {RC}", "RC", ret); break; } } while (cb_ret); return ret; } } // namespace internal int sendOemCommand(int ifindex, int package, int channel, int operation, std::span payload) { lg2::debug("Send OEM Command, CHANNEL : {CHANNEL} , PACKAGE : {PACKAGE}, " "INTERFACE_INDEX: {INTERFACE_INDEX}", "CHANNEL", lg2::hex, channel, "PACKAGE", lg2::hex, package, "INTERFACE_INDEX", lg2::hex, ifindex); if (!payload.empty()) { lg2::debug("Payload: {PAYLOAD}", "PAYLOAD", toHexStr(payload)); } return internal::applyCmd( ifindex, internal::Command(ncsi_nl_commands::NCSI_CMD_SEND_CMD, operation, payload), package, channel, NONE, internal::sendCallBack); } int setChannel(int ifindex, int package, int channel) { lg2::debug( "Set CHANNEL : {CHANNEL} , PACKAGE : {PACKAGE}, INTERFACE_INDEX: " "{INTERFACE_INDEX}", "CHANNEL", lg2::hex, channel, "PACKAGE", lg2::hex, package, "INTERFACE_INDEX", lg2::hex, ifindex); return internal::applyCmd( ifindex, internal::Command(ncsi_nl_commands::NCSI_CMD_SET_INTERFACE), package, channel); } int clearInterface(int ifindex) { lg2::debug("ClearInterface , INTERFACE_INDEX : {INTERFACE_INDEX}", "INTERFACE_INDEX", lg2::hex, ifindex); return internal::applyCmd( ifindex, internal::Command(ncsi_nl_commands::NCSI_CMD_CLEAR_INTERFACE)); } int getInfo(int ifindex, int package) { lg2::debug( "Get Info , PACKAGE : {PACKAGE}, INTERFACE_INDEX: {INTERFACE_INDEX}", "PACKAGE", lg2::hex, package, "INTERFACE_INDEX", lg2::hex, ifindex); if (package == DEFAULT_VALUE) { return internal::applyCmd( ifindex, internal::Command(ncsi_nl_commands::NCSI_CMD_PKG_INFO), package, DEFAULT_VALUE, NLM_F_DUMP, internal::infoCallBack); } else { return internal::applyCmd(ifindex, ncsi_nl_commands::NCSI_CMD_PKG_INFO, package, DEFAULT_VALUE, NONE, internal::infoCallBack); } } } // namespace ncsi } // namespace network } // namespace phosphor