deepblue/ipmitool
1
0
Fork 0
mirror of https://github.com/ipmitool/ipmitool.git synced 2025-05-12 11:37:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

nm: Refactor error checking

Browse Source 
Make chk_nm_rsp() search for the codes really defined in the
NM dictionary and not just check some arbitrary completion codes
range. For all codes not defined in NM dictionary, print strings
from the generic IPMI completion codes dictionary.

Rename chk_nm_rsp() to is_nm_err() to better reflect the purpose
of the function. Make it 'bool'. Use centralized exiting for the
function.

Also fix wording for invalid NM ID.

End-user-impact: On invalid responses from the NM, instead of
                 "A valid NM command was not returned!" accompanied
                 by a single byte of data, the following message
                 with full 3 bytes of data will now be printed:
                 "No valid NM ID in response!"
Signed-off-by: Alexander Amelkin <alexander@amelkin.msk.ru>
This commit is contained in:
Alexander Amelkin 2019-02-25 18:49:23 +03:00
parent 7469522fbb
commit 67928205e7
No known key found for this signature in database
GPG Key ID: E893587B5B74178D
2 changed files with 43 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
include/ipmitool/ipmi_nm.h
View File

@ -72,6 +72,7 @@
#define IPMI_NM_CC_POLICY_STATS_RANGE 0x89 #define IPMI_NM_CC_POLICY_STATS_RANGE 0x89
#define IPMI_NM_CC_POLICY_LIMIT_NONE 0xA1 #define IPMI_NM_CC_POLICY_LIMIT_NONE 0xA1
#define IPMI_NM_CC_POLICY_PARAM_BUSY 0xD5 #define IPMI_NM_CC_POLICY_PARAM_BUSY 0xD5
#define IPMI_NM_CC_POLICY_DOMAIN_ERR 0xD6
#define IPMI_NM_CC_POLICY_VALUE_INVALID 0x8B #define IPMI_NM_CC_POLICY_VALUE_INVALID 0x8B
#define IPMI_NM_CC_STATS_MODE_INVALID 0x88 #define IPMI_NM_CC_STATS_MODE_INVALID 0x88
#define IPMI_NM_CC_POWER_LIMIT_RANGE 0x84 #define IPMI_NM_CC_POWER_LIMIT_RANGE 0x84

77
lib/ipmi_nm.c
View File

@ -306,39 +306,46 @@ const struct valstr nm_ccode_vals[] = {
/* End strings */ /* End strings */
/* check the Node Manager response from the BMC /* Check whether the Node Manager response from the BMC is an error
* @rsp: Response data structure * @rsp: Response data structure
*/ */
static int static bool
chk_nm_rsp(struct ipmi_rs *rsp) is_nm_error(struct ipmi_rs *rsp)
{ {
bool rc = true; /* There IS an error */
/* if the response from the intf is NULL then the BMC is experiencing /* if the response from the intf is NULL then the BMC is experiencing
* some issue and cannot complete the command * some issue and cannot complete the command
*/ */
if (!rsp) { if (!rsp) {
lprintf(LOG_ERR, "\n No response to NM request"); lprintf(LOG_ERR, "\n No response to NM request");
return 1; goto out;
} }
/* if the completion code is greater than zero there was an error. We'll
* use val2str from helper.c to print the error from either the DCMI /* if the completion code is greater than zero there was an error.
* completion code struct or the generic IPMI completion_code_vals struct * We'll use val2str from helper.c to print the error from either the
* DCMI completion code dictionary or the generic IPMI codes dictionary.
*/ */
if ((rsp->ccode >= IPMI_NM_CC_POLICY_ID_INVALID) if (rsp->ccode) {
&& (rsp->ccode <= IPMI_NM_CC_POLICY_DOMAIN_ERR)) { /* Try to find the code in NM dictionary */
lprintf(LOG_ERR, "\n NM request failed because: %s (%x)", lprintf(LOG_ERR, "\n NM request failed: %s",
val2str(rsp->ccode, nm_ccode_vals), rsp->ccode); specific_val2str(rsp->ccode,
return 1; nm_ccode_vals,
} else if (rsp->ccode) { completion_code_vals),
lprintf(LOG_ERR, "\n NM request failed because: %s (%x)", rsp->ccode);
val2str(rsp->ccode, completion_code_vals), rsp->ccode); goto out;
return 1;
} }
/* check to make sure this is an NM firmware */
/* The code was OK, but was it an NM firmware at all? */
if (!nm_check_id(rsp->data)) { if (!nm_check_id(rsp->data)) {
printf("\n A valid NM command was not returned! (%x)", rsp->data[0]); printf("\n No valid NM ID in response! (%06x)",
return 1; ipmi24toh(rsp->data));
goto out;
} }
return 0;
rc = false; /* No error */
out:
return rc;
} }
/* Node Manager discover */ /* Node Manager discover */
@ -356,7 +363,7 @@ _ipmi_nm_discover(struct ipmi_intf *intf, struct nm_discover *disc)
req.msg.data = msg_data; req.msg.data = msg_data;
req.msg.data_len = 3; req.msg.data_len = 3;
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
memcpy(disc, rsp->data, sizeof(struct nm_discover)); memcpy(disc, rsp->data, sizeof(struct nm_discover));
@ -388,7 +395,7 @@ _ipmi_nm_getcapabilities(struct ipmi_intf *intf, uint8_t domain,
req.msg.data = msg_data; req.msg.data = msg_data;
req.msg.data_len = 5; req.msg.data_len = 5;
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
memcpy(caps, rsp->data, sizeof(struct nm_capability)); memcpy(caps, rsp->data, sizeof(struct nm_capability));
@ -412,7 +419,7 @@ _ipmi_nm_get_policy(struct ipmi_intf *intf, uint8_t domain, uint8_t policy_id,
req.msg.data = msg_data; req.msg.data = msg_data;
req.msg.data_len = 5; req.msg.data_len = 5;
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
memcpy(policy, rsp->data, sizeof(struct nm_get_policy)); memcpy(policy, rsp->data, sizeof(struct nm_get_policy));
@ -431,7 +438,7 @@ _ipmi_nm_set_policy(struct ipmi_intf *intf, struct nm_policy *policy)
req.msg.data_len = sizeof(struct nm_policy); req.msg.data_len = sizeof(struct nm_policy);
nm_set_id(policy->intel_id); nm_set_id(policy->intel_id);
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
return 0; return 0;
@ -455,7 +462,7 @@ _ipmi_nm_policy_limiting(struct ipmi_intf *intf, uint8_t domain)
/* check for special case error of no policy is limiting */ /* check for special case error of no policy is limiting */
if (rsp && (rsp->ccode == IPMI_NM_CC_POLICY_LIMIT_NONE)) if (rsp && (rsp->ccode == IPMI_NM_CC_POLICY_LIMIT_NONE))
return 0x80; return 0x80;
else if (chk_nm_rsp(rsp)) else if (is_nm_error(rsp))
return -1; return -1;
return rsp->data[0]; return rsp->data[0];
} }
@ -478,7 +485,7 @@ _ipmi_nm_control(struct ipmi_intf *intf, uint8_t scope,
req.msg.data = msg_data; req.msg.data = msg_data;
req.msg.data_len = 6; req.msg.data_len = 6;
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
return 0; return 0;
@ -511,7 +518,7 @@ _ipmi_nm_statistics(struct ipmi_intf *intf, uint8_t mode, uint8_t domain,
req.msg.data = msg_data; req.msg.data = msg_data;
req.msg.data_len = 6; req.msg.data_len = 6;
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
memcpy(caps, rsp->data, sizeof(struct nm_statistics)); memcpy(caps, rsp->data, sizeof(struct nm_statistics));
@ -536,7 +543,7 @@ _ipmi_nm_reset_stats(struct ipmi_intf *intf, uint8_t mode,
req.msg.data = msg_data; req.msg.data = msg_data;
req.msg.data_len = 6; req.msg.data_len = 6;
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
return 0; return 0;
@ -562,7 +569,7 @@ _nm_set_range(struct ipmi_intf *intf, uint8_t domain,
req.msg.data = msg_data; req.msg.data = msg_data;
req.msg.data_len = 8; req.msg.data_len = 8;
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
return 0; return 0;
@ -582,7 +589,7 @@ _ipmi_nm_get_alert(struct ipmi_intf *intf, struct nm_set_alert *alert)
req.msg.data = msg_data; req.msg.data = msg_data;
req.msg.data_len = 3; req.msg.data_len = 3;
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
memcpy(alert, rsp->data, sizeof(struct nm_set_alert)); memcpy(alert, rsp->data, sizeof(struct nm_set_alert));
@ -606,7 +613,7 @@ _ipmi_nm_set_alert(struct ipmi_intf *intf, struct nm_set_alert *alert)
req.msg.data = msg_data; req.msg.data = msg_data;
req.msg.data_len = 6; req.msg.data_len = 6;
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
return 0; return 0;
@ -636,7 +643,7 @@ _ipmi_nm_get_thresh(struct ipmi_intf *intf, uint8_t domain,
req.msg.data = msg_data; req.msg.data = msg_data;
req.msg.data_len = 5; req.msg.data_len = 5;
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
if (rsp->data[3] > 0) if (rsp->data[3] > 0)
@ -678,7 +685,7 @@ _ipmi_nm_set_thresh(struct ipmi_intf *intf, struct nm_thresh * thresh)
req.msg.data = msg_data; req.msg.data = msg_data;
req.msg.data_len = 6 + (thresh->count * 2); req.msg.data_len = 6 + (thresh->count * 2);
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
return 0; return 0;
@ -708,7 +715,7 @@ _ipmi_nm_get_suspend(struct ipmi_intf *intf, uint8_t domain,
req.msg.data = msg_data; req.msg.data = msg_data;
req.msg.data_len = 5; req.msg.data_len = 5;
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
*count = rsp->data[3]; *count = rsp->data[3];
@ -748,7 +755,7 @@ _ipmi_nm_set_suspend(struct ipmi_intf *intf, struct nm_suspend *suspend)
req.msg.cmd = IPMI_NM_SET_SUSPEND; req.msg.cmd = IPMI_NM_SET_SUSPEND;
req.msg.data = msg_data; req.msg.data = msg_data;
rsp = intf->sendrecv(intf, &req); rsp = intf->sendrecv(intf, &req);
if (chk_nm_rsp(rsp)) { if (is_nm_error(rsp)) {
return -1; return -1;
} }
return 0; return 0;