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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/ipmiext/ipmiconfiglookup.C $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2017,2018 */
/* [+] International Business Machines Corp. */
/* */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
/* implied. See the License for the specific language governing */
/* permissions and limitations under the License. */
/* */
/* IBM_PROLOG_END_TAG */
#include <ipmi/ipmiconfiglookup.H>
#include <algorithm>
#include <assert.h>
#include <attributeenums.H>
#include <ipmi/ipmi_reasoncodes.H>
#include <targeting/targplatutil.H>
#include <targeting/common/targetservice.H>
extern trace_desc_t * g_trac_ipmi;
namespace IPMI
{
//-----------------------------------------------------------------------------
// Private method used to lookup sensor information from the IPMI_SENSOR_ARRAY
// attribute of the i_target parameter.
//
// Returns true if the sensor was found, false otherwise.
//-----------------------------------------------------------------------------
bool IpmiConfigLookup::lookupIPMISensorInfo(TARGETING::Target * i_target,
uint32_t i_sensorNumber,
uint8_t& o_sensorType,
uint8_t& o_entityId,
TARGETING::SENSOR_NAME& o_sensorName
)
{
using IPMI_ARRAY_ELEMENT = uint16_t[2];
bool l_result{false};
assert(nullptr != i_target);
assert(TARGETING::UTIL::INVALID_IPMI_SENSOR != i_sensorNumber);
//Get the IPMI_SENSOR_ARRAY attribute from i_target.
TARGETING::AttributeTraits<TARGETING::ATTR_IPMI_SENSORS>::Type l_ipmiArray;
if(!i_target->tryGetAttr<TARGETING::ATTR_IPMI_SENSORS>(l_ipmiArray))
{
return l_result;
}
//Search the IPMI_SENSOR_ARRAY for the desired sensor.
uint32_t elementCount = (sizeof(l_ipmiArray)/sizeof(l_ipmiArray[0]));
const IPMI_ARRAY_ELEMENT * begin = &l_ipmiArray[0];
const IPMI_ARRAY_ELEMENT * end = &l_ipmiArray[elementCount];
const IPMI_ARRAY_ELEMENT * itr{nullptr};
itr = std::find_if(begin,
end,
[i_sensorNumber] (const IPMI_ARRAY_ELEMENT& a)
{
return a[TARGETING::IPMI_SENSOR_ARRAY_NUMBER_OFFSET]
== i_sensorNumber;
}
);
if(itr != end)
{
l_result = true;
uint16_t l_sensorName = (*itr)
[TARGETING::IPMI_SENSOR_ARRAY_NAME_OFFSET];
o_sensorName = static_cast<TARGETING::SENSOR_NAME>(l_sensorName);
o_sensorType = static_cast<uint8_t>((l_sensorName >> 8) & 0x00FF);
o_entityId = static_cast<uint8_t>(l_sensorName & 0x00FF);
}
return l_result;
}
//-----------------------------------------------------------------------------
// Private method used to lookup sensor information from the GPU_SENSORS
// array attribute of the i_target parameter.
//
// Returns true if the sensor was found, false otherwise.
//-----------------------------------------------------------------------------
bool IpmiConfigLookup::lookupGPUSensorInfo(TARGETING::Target * i_target,
uint32_t i_sensorNumber,
uint8_t& o_sensorType,
uint8_t& o_entityId,
TARGETING::SENSOR_NAME& o_sensorName
)
{
using GPU_ARRAY_ELEMENT = uint16_t[7];
bool l_result{false};
assert(nullptr != i_target);
assert(TARGETING::UTIL::INVALID_IPMI_SENSOR != i_sensorNumber);
// Get the GPU_SENSORS array attribute from i_target
TARGETING::AttributeTraits<TARGETING::ATTR_GPU_SENSORS>::Type
l_sensorArray;
if(!i_target->tryGetAttr<TARGETING::ATTR_GPU_SENSORS>(l_sensorArray))
{
return l_result;
}
//Search the sensor array for the desired sensor
uint32_t elementCount = (sizeof(l_sensorArray)/sizeof(l_sensorArray[0]));
const GPU_ARRAY_ELEMENT * begin = &l_sensorArray[0];
const GPU_ARRAY_ELEMENT * end = &l_sensorArray[elementCount];
const GPU_ARRAY_ELEMENT * itr{nullptr};
itr = std::find_if(begin,
end,
[i_sensorNumber] (const GPU_ARRAY_ELEMENT& a)
{
return (
(a[TARGETING::GPU_SENSOR_ARRAY_FUNC_ID_OFFSET] == i_sensorNumber) ||
(a[TARGETING::GPU_SENSOR_ARRAY_TEMP_ID_OFFSET] == i_sensorNumber) ||
(a[TARGETING::GPU_SENSOR_ARRAY_MEM_TEMP_ID_OFFSET] == i_sensorNumber));
}
);
if(itr != end)
{
l_result = true;
uint16_t l_sensorName;
if (*itr[TARGETING::GPU_SENSOR_ARRAY_FUNC_ID_OFFSET] == i_sensorNumber)
{
l_sensorName = *itr[TARGETING::GPU_SENSOR_ARRAY_FUNC_OFFSET];
}
else if
(*itr[TARGETING::GPU_SENSOR_ARRAY_TEMP_ID_OFFSET] == i_sensorNumber)
{
l_sensorName = *itr[TARGETING::GPU_SENSOR_ARRAY_TEMP_ID_OFFSET];
}
else
{
l_sensorName = *itr[TARGETING::GPU_SENSOR_ARRAY_MEM_TEMP_ID_OFFSET];
}
o_sensorName = static_cast<TARGETING::SENSOR_NAME>(l_sensorName);
o_sensorType = static_cast<uint8_t>((l_sensorName >> 8) & 0x00FF);
o_entityId = static_cast<uint8_t>(l_sensorName & 0x00FF);
}
return l_result;
}
//--------------------------------------------------------------------------
//Given a sensor number, lookup and parse SENSOR_NAME into SENSOR_TYPE
//and ENTITY_ID values.
//--------------------------------------------------------------------------
bool IpmiConfigLookup::getIPMISensorInfo(uint32_t i_sensorNumber,
uint8_t * o_sensorType,
uint8_t * o_entityId,
TARGETING::SENSOR_NAME * o_sensorName,
TARGETING::Target * i_sensorTarget
)
{
bool l_result{false};
//Ensure that the sensor number is not the invalid id.
assert(TARGETING::UTIL::INVALID_IPMI_SENSOR != i_sensorNumber);
TARGETING::SENSOR_NAME l_sensorName =
static_cast<TARGETING::SENSOR_NAME>(0);
uint8_t l_sensorType = TARGETING::SENSOR_TYPE_NA;
uint8_t l_entityId = TARGETING::ENTITY_ID_NA;
//Ensure that at least one optional out parameter was given.
assert(nullptr != o_sensorType ||
nullptr != o_sensorName ||
nullptr != o_entityId);
//If the caller passed in a target then find sensor data within the
//context of the passed in target.
if(i_sensorTarget)
{
if(doesTargetHaveIpmiSensorAttr(i_sensorTarget))
{
l_result = lookupIPMISensorInfo(i_sensorTarget,
i_sensorNumber,
l_sensorType,
l_entityId,
l_sensorName);
}
}
else
{
//The caller did not supply a target context for the sensor.
//Search for the sensor amoung all targets.
for(auto itr = TARGETING::targetService().begin();
itr != TARGETING::targetService().end(); ++itr)
{
if(doesTargetHaveIpmiSensorAttr(*itr))
{
l_result = lookupIPMISensorInfo((*itr),
i_sensorNumber,
l_sensorType,
l_entityId,
l_sensorName);
if(l_result)
{
break;
}
}
else if (doesTargetHaveGPUSensorsAttr(*itr))
{
l_result = lookupGPUSensorInfo((*itr),
i_sensorNumber,
l_sensorType,
l_entityId,
l_sensorName);
if (l_result)
{
break;
}
}
}
}
//set any out parameters that are desired by the caller.
if(o_sensorName)
{
*o_sensorName = l_sensorName;
}
if(o_sensorType)
{
*o_sensorType = l_sensorType;
}
if(o_entityId)
{
*o_entityId = l_entityId;
}
return l_result;
}
//------------------------------------------------------------------
errlHndl_t IpmiConfigLookup::getSensorType(uint32_t i_sensorNumber,
uint8_t & o_sensorType,
TARGETING::Target * i_sensorTarget
)
{
errlHndl_t l_errl{};
//Ensure that the sensor number is not the invalid id.
if(TARGETING::UTIL::INVALID_IPMI_SENSOR == i_sensorNumber)
{
TRACFCOMP(g_trac_ipmi,
ERR_MRK"The i_sensorNumber parameter "
"is the invalid sensor number (%X).",
i_sensorNumber
);
/*@
* @errortype ERRL_SEV_UNRECOVERABLE
* @moduleid IPMI::MOD_IPMISENSOR_TYPE
* @reasoncode IPMI::RC_INVALID_SENSOR_NUMBER
* @userdata1 IPMI Sensor Number
* @userdata2 <unused>
* @devdesc The passed in sensor number is not valid.
* @custdesc The passed in sensor number is not valid.
*/
l_errl = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
IPMI::MOD_IPMISENSOR_TYPE,
IPMI::RC_INVALID_SENSOR_NUMBER,
i_sensorNumber,
0,
false);
return l_errl;
}
bool l_rc = getIPMISensorInfo(i_sensorNumber,
&o_sensorType,
nullptr,
nullptr,
i_sensorTarget
);
if(!l_rc)
{
TRACFCOMP(g_trac_ipmi,
ERR_MRK"Did not find a sensor with number %X.",
i_sensorNumber);
/*@
* @errortype ERRL_SEV_UNRECOVERABLE
* @moduleid IPMI::MOD_IPMISENSOR_TYPE
* @reasoncode IPMI::RC_SENSOR_NOT_FOUND
* @userdata1 IPMI Sensor Number
* @userdata2 <unused>
* @devdesc The sensor could not be found based upon
* the sensor number.
* @custdesc Unable to determine sensor information.
*/
l_errl = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
IPMI::MOD_IPMISENSOR_TYPE,
IPMI::RC_SENSOR_NOT_FOUND,
i_sensorNumber,
0,
false);
}
return l_errl;
}
//--------------------------------------------------------------------------
errlHndl_t IpmiConfigLookup::getEntityId(uint32_t i_sensorNumber,
uint8_t & o_entityId,
TARGETING::Target * i_sensorTarget
)
{
errlHndl_t l_errl{};
if(TARGETING::UTIL::INVALID_IPMI_SENSOR == i_sensorNumber)
{
TRACFCOMP(g_trac_ipmi,
ERR_MRK"The i_sensorNumber parameter "
"is an invalid sensor number (%X).",
i_sensorNumber
);
/*@
* @errortype ERRL_SEV_UNRECOVERABLE
* @moduleid IPMI::MOD_IPMISENSOR_ENTITY_ID
* @reasoncode IPMI::RC_INVALID_SENSOR_NUMBER
* @userdata1 IPMI Sensor Number
* @userdata2 <unused>
* @devdesc The passed in sensor number is not valid.
* @custdesc The passed in sensor number is not valid.
*/
l_errl = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
IPMI::MOD_IPMISENSOR_ENTITY_ID,
IPMI::RC_INVALID_SENSOR_NUMBER,
i_sensorNumber,
0,
false);
return l_errl;
}
bool l_rc = getIPMISensorInfo(i_sensorNumber,
nullptr,
&o_entityId,
nullptr,
i_sensorTarget
);
if(!l_rc)
{
TRACFCOMP(g_trac_ipmi,
ERR_MRK"Did not find a sensor with number %X.",
i_sensorNumber);
/*@
* @errortype ERRL_SEV_UNRECOVERABLE
* @moduleid IPMI::MOD_IPMISENSOR_ENTITY_ID
* @reasoncode IPMI::RC_SENSOR_NOT_FOUND
* @userdata1 IPMI Sensor Number
* @userdata2 <unused>
* @devdesc The sensor could not be found based upon
* the sensor number.
* @custdesc Unable to determine sensor information.
*/
l_errl = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
IPMI::MOD_IPMISENSOR_ENTITY_ID,
IPMI::RC_SENSOR_NOT_FOUND,
i_sensorNumber,
0,
false);
}
return l_errl;
}
//-----------------------------------------------------------------------
errlHndl_t IpmiConfigLookup::getSensorName(uint32_t i_sensorNumber,
TARGETING::SENSOR_NAME & o_sensorName,
TARGETING::Target * i_sensorTarget
)
{
errlHndl_t l_errl{};
if(TARGETING::UTIL::INVALID_IPMI_SENSOR == i_sensorNumber)
{
TRACFCOMP(g_trac_ipmi,
ERR_MRK"The i_sensorNumber parameter "
"is an invalid sensor number (%X).",
i_sensorNumber
);
/*@
* @errortype ERRL_SEV_UNRECOVERABLE
* @moduleid IPMI::MOD_IPMISENSOR_NAME
* @reasoncode IPMI::RC_INVALID_SENSOR_NUMBER
* @userdata1 IPMI Sensor Number
* @userdata2 <unused>
* @devdesc The passed in sensor number is not valid.
* @custdesc The passed in sensor number is not valid.
*/
l_errl = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
IPMI::MOD_IPMISENSOR_NAME,
IPMI::RC_INVALID_SENSOR_NUMBER,
i_sensorNumber,
0,
false);
return l_errl;
}
bool l_rc = getIPMISensorInfo(i_sensorNumber,
nullptr,
nullptr,
&o_sensorName,
i_sensorTarget
);
if(!l_rc)
{
TRACFCOMP(g_trac_ipmi,
ERR_MRK"Did not find a sensor with number %X.",
i_sensorNumber);
/*@
* @errortype ERRL_SEV_UNRECOVERABLE
* @moduleid IPMI::MOD_IPMISENSOR_NAME
* @reasoncode IPMI::RC_SENSOR_NOT_FOUND
* @userdata1 IPMI Sensor Number
* @userdata2 <unused>
* @devdesc The sensor could not be found based upon
* the sensor number.
* @custdesc Unable to determine sensor information.
*/
l_errl = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
IPMI::MOD_IPMISENSOR_NAME,
IPMI::RC_SENSOR_NOT_FOUND,
i_sensorNumber,
0,
false);
}
return l_errl;
}
} //End namespace
|
