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
|
#pragma once
#include "blob_interface.hpp"
#include "ipmi_interface.hpp"
#include <memory>
namespace ipmiblob
{
class BlobHandler : public BlobInterface
{
public:
enum BlobOEMCommands
{
bmcBlobGetCount = 0,
bmcBlobEnumerate = 1,
bmcBlobOpen = 2,
bmcBlobRead = 3,
bmcBlobWrite = 4,
bmcBlobCommit = 5,
bmcBlobClose = 6,
bmcBlobDelete = 7,
bmcBlobStat = 8,
bmcBlobSessionStat = 9,
bmcBlobWriteMeta = 10,
};
/**
* Create a BlobInterface pointer for use given an ipmi handler.
*
* @note This is a convenience method.
* @return a BlobHandler wrapped as a BlobInterface pointer.
*/
static std::unique_ptr<BlobInterface>
CreateBlobHandler(std::unique_ptr<IpmiInterface> ipmi);
explicit BlobHandler(std::unique_ptr<IpmiInterface> ipmi) :
ipmi(std::move(ipmi)){};
~BlobHandler() = default;
BlobHandler(const BlobHandler&) = delete;
BlobHandler& operator=(const BlobHandler&) = delete;
BlobHandler(BlobHandler&&) = default;
BlobHandler& operator=(BlobHandler&&) = default;
/**
* Retrieve the blob count.
*
* @return the number of blob_ids found (0 on failure).
*/
int getBlobCount();
/**
* Given an index into the list of blobs, return the name.
*
* @param[in] index - the index into the list of blob ids.
* @return the name as a string or empty on failure.
*/
std::string enumerateBlob(std::uint32_t index);
/**
* @throws BlobException.
*/
void commit(std::uint16_t session,
const std::vector<std::uint8_t>& bytes) override;
/**
* @throws BlobException.
*/
void writeMeta(std::uint16_t session, std::uint32_t offset,
const std::vector<std::uint8_t>& bytes) override;
/**
* @throw BlobException.
*/
void writeBytes(std::uint16_t session, std::uint32_t offset,
const std::vector<std::uint8_t>& bytes) override;
std::vector<std::string> getBlobList() override;
/**
* @throws BlobException.
*/
StatResponse getStat(const std::string& id) override;
/**
* @throws BlobException.
*/
StatResponse getStat(std::uint16_t session) override;
/**
* @throws BlobException.
*/
std::uint16_t openBlob(const std::string& id,
std::uint16_t handlerFlags) override;
void closeBlob(std::uint16_t session) override;
/**
* @throws BlobException.
*/
std::vector<std::uint8_t> readBytes(std::uint16_t session,
std::uint32_t offset,
std::uint32_t length) override;
private:
/**
* Send the contents of the payload to IPMI, this method handles wrapping
* with the OEN, subcommand and CRC.
*
* @param[in] command - the blob command.
* @param[in] payload - the payload bytes.
* @return the bytes returned from the ipmi interface.
* @throws BlobException.
*/
std::vector<std::uint8_t>
sendIpmiPayload(BlobOEMCommands command,
const std::vector<std::uint8_t>& payload);
/**
* Generic blob byte writer.
*
* @param[in] command - the command associated with this write.
* @param[in] session - the session id.
* @param[in] offset - the offset for the metadata to write.
* @param[in] bytes - the bytes to send.
* @throws BlobException on failure.
*/
void writeGeneric(BlobOEMCommands command, std::uint16_t session,
std::uint32_t offset,
const std::vector<std::uint8_t>& bytes);
/**
* Generic stat reader.
*
* @param[in] command - the command associated with this write.
* @param[in] request - the bytes of the request
* @return the metadata StatResponse
* @throws BlobException on failure.
*/
StatResponse statGeneric(BlobOEMCommands command,
const std::vector<std::uint8_t>& request);
std::unique_ptr<IpmiInterface> ipmi;
};
} // namespace ipmiblob
|
