1 // Copyright 2021 Google LLC 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); 4 // you may not use this file except in compliance with the License. 5 // You may obtain a copy of the License at 6 // 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 15 #include "cable.hpp" 16 17 #include "commands.hpp" 18 #include "errors.hpp" 19 #include "handler.hpp" 20 21 #include <cstdint> 22 #include <cstring> 23 #include <ipmid/api-types.hpp> 24 #include <span> 25 #include <string> 26 #include <vector> 27 28 namespace google 29 { 30 namespace ipmi 31 { 32 33 struct CableRequest 34 { 35 uint8_t ifNameLength; 36 } __attribute__((packed)); 37 38 Resp cableCheck(std::span<const uint8_t> data, const HandlerInterface* handler) 39 { 40 // There is an IPMI LAN channel statistics command which could be used for 41 // this type of check, however, we're not able to wait for the OpenBMC 42 // implementation to stabilize related to the network management. 43 // 44 // There is a link status file, but it is "unknown" to start with... 45 // The path we're checking: /sys/class/net/eth1/statistics/rx_packets 46 47 // This command is expecting: [0x00][len][ifName] 48 // data should have [len][ifName] 49 if (data.size() < sizeof(struct CableRequest)) 50 { 51 std::fprintf(stderr, "Invalid command length: %u\n", 52 static_cast<uint32_t>(data.size())); 53 return ::ipmi::responseReqDataLenInvalid(); 54 } 55 56 const auto request = 57 reinterpret_cast<const struct CableRequest*>(data.data()); 58 59 // Sanity check the object contents. 60 if (request->ifNameLength == 0) 61 { 62 std::fprintf(stderr, "Invalid string length: %d\n", 63 request->ifNameLength); 64 return ::ipmi::responseReqDataLenInvalid(); 65 } 66 67 // Verify the request buffer contains the object and the string. 68 if (data.size() < (sizeof(struct CableRequest) + request->ifNameLength)) 69 { 70 std::fprintf(stderr, "*dataLen too small: %u\n", 71 static_cast<uint32_t>(data.size())); 72 return ::ipmi::responseReqDataLenInvalid(); 73 } 74 75 // Maximum length one can specify, plus null terminator. 76 char nameBuf[256] = {}; 77 // Copy the string out of the request buffer. 78 std::memcpy(&nameBuf[0], request + 1, request->ifNameLength); 79 std::string name = nameBuf; 80 int64_t count; 81 82 try 83 { 84 count = handler->getRxPackets(name); 85 } 86 catch (const IpmiException& e) 87 { 88 return ::ipmi::response(e.getIpmiError()); 89 } 90 91 // If we have received packets then there is a cable present. 92 std::uint8_t value = (count > 0) ? 1 : 0; 93 94 return ::ipmi::responseSuccess(SysOEMCommands::SysCableCheck, 95 std::vector<std::uint8_t>{value}); 96 } 97 98 } // namespace ipmi 99 } // namespace google 100