1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
|
package ipmi
import (
"context"
"fmt"
)
// 33.12 Get SDR Command
type GetSDRRequest struct {
ReservationID uint16 // LS Byte first
RecordID uint16 // LS Byte first
ReadOffset uint8 // Offset into record
ReadBytes uint8 // FFh means read entire record
}
type GetSDRResponse struct {
NextRecordID uint16
RecordData []byte
}
func (req *GetSDRRequest) Pack() []byte {
msg := make([]byte, 6)
packUint16L(req.ReservationID, msg, 0)
packUint16L(req.RecordID, msg, 2)
packUint8(req.ReadOffset, msg, 4)
packUint8(req.ReadBytes, msg, 5)
return msg
}
func (req *GetSDRRequest) Command() Command {
return CommandGetSDR
}
func (res *GetSDRResponse) Unpack(msg []byte) error {
if len(msg) < 2 {
return ErrUnpackedDataTooShortWith(len(msg), 2)
}
res.NextRecordID, _, _ = unpackUint16L(msg, 0)
res.RecordData, _, _ = unpackBytes(msg, 2, len(msg)-2)
return nil
}
func (res *GetSDRResponse) CompletionCodes() map[uint8]string {
// no command-specific cc
return map[uint8]string{}
}
func (res *GetSDRResponse) Format() string {
return fmt.Sprintf("%v", res)
}
// GetSDR returns raw SDR record.
func (c *Client) GetSDR(ctx context.Context, recordID uint16) (response *GetSDRResponse, err error) {
request := &GetSDRRequest{
ReservationID: 0,
RecordID: recordID,
ReadOffset: 0,
ReadBytes: 0xff,
}
response = &GetSDRResponse{}
err = c.Exchange(ctx, request, response)
// try read partial data if err (ResponseError and CompletionCode) indicate
// reading full data (0xff) exceeds the maximum transfer length for the interface
if respErr, ok := isResponseError(err); ok {
if respErr.CompletionCode() == CompletionCodeCannotReturnRequestedDataBytes {
return c.getSDR(ctx, recordID)
}
}
return
}
func (c *Client) GetSDREnhanced(ctx context.Context, recordID uint16) (*SDR, error) {
res, err := c.GetSDR(ctx, recordID)
if err != nil {
return nil, fmt.Errorf("GetSDR failed for recordID (%#02x), err: %w", recordID, err)
}
sdr, err := ParseSDR(res.RecordData, res.NextRecordID)
if err != nil {
return nil, fmt.Errorf("ParseSDR failed, err: %w", err)
}
if err := c.enhanceSDR(ctx, sdr); err != nil {
return sdr, fmt.Errorf("enhanceSDR failed, err: %w", err)
}
return sdr, nil
}
// getSDR return SDR in a partial read way.
func (c *Client) getSDR(ctx context.Context, recordID uint16) (response *GetSDRResponse, err error) {
var data []byte
// the actual data length of the SDR can only be determined after the first GetSDR request/response.
dataLength := uint8(0)
reservationID := uint16(0)
readBytes := uint8(16)
readTotal := uint8(0)
readOffset := uint8(0)
for {
request := &GetSDRRequest{
ReservationID: reservationID,
RecordID: recordID,
ReadOffset: readOffset,
ReadBytes: readBytes,
}
response = &GetSDRResponse{}
if err = c.Exchange(ctx, request, response); err != nil {
return
}
// determine the total data length by parsing the SDR Header part
if readOffset == 0 {
if len(response.RecordData) < SDRRecordHeaderSize {
return nil, fmt.Errorf("too short record data for SDR header (%d/%d)", len(response.RecordData), SDRRecordHeaderSize)
}
dataLength = response.RecordData[4] + uint8(SDRRecordHeaderSize)
data = make([]byte, dataLength)
}
copy(data[readOffset:readOffset+readBytes], response.RecordData[:])
readOffset += uint8(len(response.RecordData))
readTotal += uint8(len(response.RecordData))
if readTotal >= dataLength {
break
}
if readOffset+readBytes > dataLength {
// decrease the readBytes for the last read.
readBytes = dataLength - readOffset
}
rsp, err := c.ReserveSDRRepo(ctx)
if err == nil {
reservationID = rsp.ReservationID
} else {
reservationID = 0
}
}
return &GetSDRResponse{
NextRecordID: response.NextRecordID,
RecordData: data,
}, nil
}
func (c *Client) GetSDRBySensorID(ctx context.Context, sensorNumber uint8) (*SDR, error) {
var recordID uint16 = 0
for {
res, err := c.GetSDR(ctx, recordID)
if err != nil {
return nil, fmt.Errorf("GetSDR failed for recordID (%#02x), err: %w", recordID, err)
}
sdr, err := ParseSDR(res.RecordData, res.NextRecordID)
if err != nil {
return nil, fmt.Errorf("ParseSDR failed, err: %w", err)
}
recordType := sdr.RecordHeader.RecordType
// Only Full/Compact/EventOnly SDRs have a sensor number.
if uint8(sdr.SensorNumber()) != sensorNumber || (recordType != SDRRecordTypeFullSensor && recordType != SDRRecordTypeCompactSensor && recordType != SDRRecordTypeEventOnly) {
recordID = sdr.NextRecordID
if recordID == 0xffff {
break
}
continue
}
if err := c.enhanceSDR(ctx, sdr); err != nil {
return sdr, fmt.Errorf("enhanceSDR failed, err: %w", err)
}
return sdr, nil
}
return nil, fmt.Errorf("not found SDR for sensor id (%#0x)", sensorNumber)
}
func (c *Client) GetSDRBySensorName(ctx context.Context, sensorName string) (*SDR, error) {
var recordID uint16 = 0
for {
res, err := c.GetSDR(ctx, recordID)
if err != nil {
return nil, fmt.Errorf("GetSDR failed for recordID (%#02x), err: %w", recordID, err)
}
sdr, err := ParseSDR(res.RecordData, res.NextRecordID)
if err != nil {
return nil, fmt.Errorf("ParseSDR failed, err: %w", err)
}
recordType := sdr.RecordHeader.RecordType
// Only Full/Compact/EventOnly SDRs have a sensor name.
if sdr.SensorName() != sensorName || (recordType != SDRRecordTypeFullSensor && recordType != SDRRecordTypeCompactSensor && recordType != SDRRecordTypeEventOnly) {
recordID = sdr.NextRecordID
if recordID == 0xffff {
break
}
continue
}
if err := c.enhanceSDR(ctx, sdr); err != nil {
return sdr, fmt.Errorf("enhanceSDR failed, err: %w", err)
}
return sdr, nil
}
return nil, fmt.Errorf("not found SDR for sensor name (%s)", sensorName)
}
// GetSDRs fetches the SDR records with the specified RecordTypes.
// The parameter is a slice of SDRRecordType used as filter.
// Empty means to get all SDR records.
func (c *Client) GetSDRs(ctx context.Context, recordTypes ...SDRRecordType) ([]*SDR, error) {
var recordID uint16 = 0
var out = make([]*SDR, 0)
for {
sdr, err := c.GetSDREnhanced(ctx, recordID)
if err != nil {
return nil, fmt.Errorf("GetSDR for recordID (%#0x) failed, err: %w", recordID, err)
}
if len(recordTypes) == 0 {
out = append(out, sdr)
} else {
for _, v := range recordTypes {
if sdr.RecordHeader.RecordType == v {
out = append(out, sdr)
break
}
}
}
recordID = sdr.NextRecordID
if recordID == 0xffff {
break
}
}
return out, nil
}
// GetSDRsMap returns all Full/Compact SDRs grouped by GeneratorID and SensorNumber.
// The sensor name can only be got from SDR record.
// So use this method to construct a map from which you can get sensor name.
func (c *Client) GetSDRsMap(ctx context.Context) (SDRMapBySensorNumber, error) {
var out = make(map[GeneratorID]map[SensorNumber]*SDR)
var recordID uint16 = 0
for {
sdr, err := c.GetSDREnhanced(ctx, recordID)
if err != nil {
return nil, fmt.Errorf("GetSDR for recordID (%#0x) failed, err: %w", recordID, err)
}
var generatorID GeneratorID
var sensorNumber SensorNumber
recordType := sdr.RecordHeader.RecordType
switch recordType {
case SDRRecordTypeFullSensor:
generatorID = sdr.Full.GeneratorID
sensorNumber = sdr.Full.SensorNumber
case SDRRecordTypeCompactSensor:
generatorID = sdr.Compact.GeneratorID
sensorNumber = sdr.Compact.SensorNumber
}
if recordType == SDRRecordTypeFullSensor || recordType == SDRRecordTypeCompactSensor {
if _, ok := out[generatorID]; !ok {
out[generatorID] = make(map[SensorNumber]*SDR)
}
out[generatorID][sensorNumber] = sdr
}
recordID = sdr.NextRecordID
if recordID == 0xffff {
break
}
}
return out, nil
}
|