attn/attn_handler.cpp - openbmc/openpower-hw-diags - Gitiles

 #include <libpdbg.h>

 #include <analyzer/analyzer_main.hpp>
 #include <attn/attention.hpp>
 #include <attn/attn_config.hpp>
 #include <attn/attn_handler.hpp>
 #include <attn/attn_logging.hpp>
 #include <attn/bp_handler.hpp>
 #include <attn/ti_handler.hpp>

 #include <algorithm>
 #include <iomanip>
 #include <map>
 #include <sstream>
 #include <vector>

 namespace attn
 {

 /**
  * @brief Handle SBE vital attention
  *
  * @param i_attention Attention object
  * @return 0 indicates that the vital attention was successfully handled
  *         1 indicates that the vital attention was NOT successfully handled
  */
 int handleVital(Attention* i_attention);

 /**
  * @brief Handle checkstop attention
  *
  * @param i_attention Attention object
  * @return 0 indicates that the checkstop attention was successfully handled
  *         1 indicates that the checkstop attention was NOT successfully
  *           handled.
  */
 int handleCheckstop(Attention* i_attention);

 /**
  * @brief Handle special attention
  *
  * @param i_attention Attention object
  * @return 0 indicates that the special attention was successfully handled
  *         1 indicates that the special attention was NOT successfully handled
  */
 int handleSpecial(Attention* i_attention);

 /** @brief Determine if attention is active and not masked */
 bool activeAttn(uint32_t i_val, uint32_t i_mask, uint32_t i_attn);

 /**
  * @brief The main attention handler logic
  *
  * @param i_breakpoints true = breakpoint special attn handling enabled
  */
 void attnHandler(Config* i_config)
 {
     // Vector of active attentions to be handled
     std::vector<Attention> active_attentions;

     uint32_t isr_val, isr_mask;
     uint32_t proc;

     std::stringstream ss; // for trace messages

     // loop through processors looking for active attentions
     trace<level::INFO>("Attention handler started");

     pdbg_target* target;
     pdbg_for_each_class_target("proc", target)
     {
         if (PDBG_TARGET_ENABLED == pdbg_target_probe(target))
         {
             proc = pdbg_target_index(target); // get processor number

             // Use PIB target to determine if a processor is enabled
             char path[16];
             sprintf(path, "/proc%d/pib", proc);
             pdbg_target* attnTarget = pdbg_target_from_path(nullptr, path);

             // sanity check
             if (nullptr == attnTarget)
             {
                 trace<level::INFO>("pib path or target not found");
                 continue;
             }

             if (PDBG_TARGET_ENABLED == pdbg_target_probe(attnTarget))
             {
                 // The processor FSI target is required for CFAM read
                 sprintf(path, "/proc%d/fsi", proc);
                 attnTarget = pdbg_target_from_path(nullptr, path);

                 // sanity check
                 if (nullptr == attnTarget)
                 {
                     trace<level::INFO>("fsi path or target not found");
                     continue;
                 }

                 // trace fsi path
                 ss.str(std::string()); // clear stream
                 ss << "target - " << path;
                 trace<level::INFO>(ss.str().c_str());

                 isr_val = 0xffffffff; // invalid isr value

                 // get active attentions on processor
                 if (RC_SUCCESS != fsi_read(attnTarget, 0x1007, &isr_val))
                 {
                     // log cfam read error
                     trace<level::INFO>("Error! cfam read 0x1007 FAILED");
                     eventAttentionFail(RC_CFAM_ERROR);
                 }
                 else if (0xffffffff == isr_val)
                 {
                     trace<level::INFO>("Error! cfam read 0x1007 INVALID");
                     continue;
                 }
                 else
                 {
                     // trace isr
                     ss.str(std::string());           // clear stream
                     ss << std::hex << std::showbase; // trace as hex vals
                     ss << "cfam 0x1007 = " << std::setw(8) << std::setfill('0')
                        << isr_val;
                     trace<level::INFO>(ss.str().c_str());

                     isr_mask = 0xffffffff; // invalid isr mask

                     // get interrupt enabled special attentions mask
                     if (RC_SUCCESS != fsi_read(attnTarget, 0x100d, &isr_mask))
                     {
                         // log cfam read error
                         trace<level::INFO>("Error! cfam read 0x100d FAILED");
                         eventAttentionFail(RC_CFAM_ERROR);
                     }
                     else if (0xffffffff == isr_mask)
                     {
                         trace<level::INFO>("Error! cfam read 0x100d INVALID");
                         continue;
                     }
                     else
                     {
                         // trace true-mask
                         ss.str(std::string());           // clear stream
                         ss << std::hex << std::showbase; // trace as hex vals
                         ss << "cfam 0x100d = " << std::setw(8)
                            << std::setfill('0') << isr_mask;
                         trace<level::INFO>(ss.str().c_str());

                         // SBE vital attention active and not masked?
                         if (true == activeAttn(isr_val, isr_mask, SBE_ATTN))
                         {
                             active_attentions.emplace_back(Attention::Vital,
                                                            handleVital, target,
                                                            i_config);
                         }

                         // Checkstop attention active and not masked?
                         if (true ==
                             activeAttn(isr_val, isr_mask, CHECKSTOP_ATTN))
                         {
                             active_attentions.emplace_back(Attention::Checkstop,
                                                            handleCheckstop,
                                                            target, i_config);
                         }

                         // Special attention active and not masked?
                         if (true == activeAttn(isr_val, isr_mask, SPECIAL_ATTN))
                         {
                             active_attentions.emplace_back(Attention::Special,
                                                            handleSpecial,
                                                            target, i_config);
                         }
                     } // cfam 0x100d valid
                 }     // cfam 0x1007 valid
             }         // proc target enabled
         }             // fsi target enabled
     }                 // next processor

     // convert to heap, highest priority is at front
     if (!std::is_heap(active_attentions.begin(), active_attentions.end()))
     {
         std::make_heap(active_attentions.begin(), active_attentions.end());
     }

     // call the attention handler until one is handled or all were attempted
     while (false == active_attentions.empty())
     {
         // handle highest priority attention, done if successful
         if (RC_SUCCESS == active_attentions.front().handle())
         {
             // an attention was handled so we are done
             break;
         }

         // move attention to back of vector
         std::pop_heap(active_attentions.begin(), active_attentions.end());

         // remove attention from vector
         active_attentions.pop_back();
     }
 }

 /**
  * @brief Handle SBE vital attention
  *
  * @param i_attention Attention object
  * @return 0 indicates that the vital attention was successfully handled
  *         1 indicates that the vital attention was NOT successfully handled
  */
 int handleVital(Attention* i_attention)
 {
     int rc = RC_SUCCESS; // assume vital handled

     trace<level::INFO>("vital handler started");

     // if vital handling enabled, handle vital attention
     if (false == (i_attention->getConfig()->getFlag(enVital)))
     {
         trace<level::INFO>("vital handling disabled");
         rc = RC_NOT_HANDLED;
     }
     else
     {
         eventVital();
     }

     return rc;
 }

 /**
  * @brief Handle checkstop attention
  *
  * @param i_attention Attention object
  * @return 0 indicates that the checkstop attention was successfully handled
  *         1 indicates that the checkstop attention was NOT successfully
  *           handled.
  */
 int handleCheckstop(Attention* i_attention)
 {
     int rc = RC_SUCCESS; // assume checkstop handled

     trace<level::INFO>("checkstop handler started");

     // if checkstop handling enabled, handle checkstop attention
     if (false == (i_attention->getConfig()->getFlag(enCheckstop)))
     {
         trace<level::INFO>("Checkstop handling disabled");
     }
     else
     {
         // Look for any attentions found in hardware. This will generate and
         // commit a PEL if any errors are found.
         if (true != analyzer::analyzeHardware())
         {
             rc = RC_ANALYZER_ERROR;
         }
     }

     return rc;
 }

 /**
  * @brief Handle special attention
  *
  * @param i_attention Attention object
  * @return 0 indicates that the special attention was successfully handled
  *         1 indicates that the special attention was NOT successfully handled
  */
 int handleSpecial(Attention* i_attention)
 {
     int rc = RC_SUCCESS; // assume special attention handled

     // The TI info chipop will give us a pointer to the TI info data
     uint8_t* tiInfo       = nullptr;                  // ptr to TI info data
     uint32_t tiInfoLen    = 0;                        // length of TI info data
     pdbg_target* attnProc = i_attention->getTarget(); // proc with attention

     if (attnProc != nullptr)
     {
         // The processor PIB target is required for get TI info chipop
         char path[16];
         sprintf(path, "/proc%d/pib", pdbg_target_index(attnProc));
         pdbg_target* tiInfoTarget = pdbg_target_from_path(nullptr, path);

         if (nullptr != tiInfoTarget)
         {
             if (PDBG_TARGET_ENABLED == pdbg_target_probe(tiInfoTarget))
             {
                 sbe_mpipl_get_ti_info(tiInfoTarget, &tiInfo, &tiInfoLen);
                 if (tiInfo == nullptr)
                 {
                     trace<level::INFO>("TI info data ptr is null after call");
                 }
             }
         }
     }

     // If TI area exists and is marked valid we can assume TI occurred
     if ((nullptr != tiInfo) && (0 != tiInfo[0]))
     {
         TiDataArea* tiDataArea = (TiDataArea*)tiInfo;

         // trace a few known TI data area values
         std::stringstream ss;
         ss << std::hex << std::showbase;

         ss << "TI data command = " << (int)tiDataArea->command;
         trace<level::INFO>(ss.str().c_str());
         ss.str(std::string());

         ss << "TI data hb_terminate_type = "
            << (int)tiDataArea->hbTerminateType;
         trace<level::INFO>(ss.str().c_str());
         ss.str(std::string());

         ss << "TI data SRC format = " << (int)tiDataArea->srcFormat;
         trace<level::INFO>(ss.str().c_str());
         ss.str(std::string());

         ss << "TI data source = " << (int)tiDataArea->source;
         trace<level::INFO>(ss.str().c_str());
         ss.str(std::string());

         if (true == (i_attention->getConfig()->getFlag(enTerminate)))
         {
             // Call TI special attention handler
             rc = tiHandler(tiDataArea);
         }
     }
     // TI area not valid or not available
     else
     {
         trace<level::INFO>("TI info NOT available");

         // if configured to handle breakpoint as default special attention
         if (i_attention->getConfig()->getFlag(dfltBreakpoint))
         {
             if (true == (i_attention->getConfig()->getFlag(enBreakpoints)))
             {
                 // Call the breakpoint special attention handler
                 bpHandler();
             }
         }
         // if configured to handle TI as default special attention
         else
         {
             trace<level::INFO>("assuming TI");

             if (true == (i_attention->getConfig()->getFlag(enTerminate)))
             {
                 // Call TI special attention handler
                 rc = tiHandler(nullptr);
             }
         }
     }

     // release TI data buffer
     if (nullptr != tiInfo)
     {
         free(tiInfo);
     }

     if (RC_SUCCESS != rc)
     {
         trace<level::INFO>("Special attn not handled");
     }

     return rc;
 }

 /**
  * @brief Determine if attention is active and not masked
  *
  * Determine whether an attention needs to be handled and trace details of
  * attention type and whether it is masked or not.
  *
  * @param i_val attention status register
  * @param i_mask attention true mask register
  * @param i_attn attention type
  * @param i_proc processor associated with registers
  *
  * @return true if attention is active and not masked, otherwise false
  */
 bool activeAttn(uint32_t i_val, uint32_t i_mask, uint32_t i_attn)
 {
     bool rc        = false; // assume attn masked and/or inactive
     bool validAttn = true;  // known attention type

     // if attention active
     if (0 != (i_val & i_attn))
     {
         std::stringstream ss;

         switch (i_attn)
         {
             case SBE_ATTN:
                 ss << "SBE attn";
                 break;
             case CHECKSTOP_ATTN:
                 ss << "Checkstop attn";
                 break;
             case SPECIAL_ATTN:
                 ss << "Special attn";
                 break;
             default:
                 ss << "Unknown attn";
                 validAttn = false;
         }

         // see if attention is masked
         if (true == validAttn)
         {
             if (0 != (i_mask & i_attn))
             {
                 rc = true; // attention active and not masked
             }
             else
             {
                 ss << " masked";
             }
         }

         trace<level::INFO>(ss.str().c_str()); // commit trace stream
     }

     return rc;
 }

 } // namespace attn
	#include <libpdbg.h>

	#include <analyzer/analyzer_main.hpp>
	#include <attn/attention.hpp>
	#include <attn/attn_config.hpp>
	#include <attn/attn_handler.hpp>
	#include <attn/attn_logging.hpp>
	#include <attn/bp_handler.hpp>
	#include <attn/ti_handler.hpp>

	#include <algorithm>
	#include <iomanip>
	#include <map>
	#include <sstream>
	#include <vector>

	namespace attn
	{

	/**
	* @brief Handle SBE vital attention
	*
	* @param i_attention Attention object
	* @return 0 indicates that the vital attention was successfully handled
	* 1 indicates that the vital attention was NOT successfully handled
	*/
	int handleVital(Attention* i_attention);

	/**
	* @brief Handle checkstop attention
	*
	* @param i_attention Attention object
	* @return 0 indicates that the checkstop attention was successfully handled
	* 1 indicates that the checkstop attention was NOT successfully
	* handled.
	*/
	int handleCheckstop(Attention* i_attention);

	/**
	* @brief Handle special attention
	*
	* @param i_attention Attention object
	* @return 0 indicates that the special attention was successfully handled
	* 1 indicates that the special attention was NOT successfully handled
	*/
	int handleSpecial(Attention* i_attention);

	/** @brief Determine if attention is active and not masked */
	bool activeAttn(uint32_t i_val, uint32_t i_mask, uint32_t i_attn);

	/**
	* @brief The main attention handler logic
	*
	* @param i_breakpoints true = breakpoint special attn handling enabled
	*/
	void attnHandler(Config* i_config)
	{
	// Vector of active attentions to be handled
	std::vector<Attention> active_attentions;

	uint32_t isr_val, isr_mask;
	uint32_t proc;

	std::stringstream ss; // for trace messages

	// loop through processors looking for active attentions
	trace<level::INFO>("Attention handler started");

	pdbg_target* target;
	pdbg_for_each_class_target("proc", target)
	{
	if (PDBG_TARGET_ENABLED == pdbg_target_probe(target))
	{
	proc = pdbg_target_index(target); // get processor number

	// Use PIB target to determine if a processor is enabled
	char path[16];
	sprintf(path, "/proc%d/pib", proc);
	pdbg_target* attnTarget = pdbg_target_from_path(nullptr, path);

	// sanity check
	if (nullptr == attnTarget)
	{
	trace<level::INFO>("pib path or target not found");
	continue;
	}

	if (PDBG_TARGET_ENABLED == pdbg_target_probe(attnTarget))
	{
	// The processor FSI target is required for CFAM read
	sprintf(path, "/proc%d/fsi", proc);
	attnTarget = pdbg_target_from_path(nullptr, path);

	// sanity check
	if (nullptr == attnTarget)
	{
	trace<level::INFO>("fsi path or target not found");
	continue;
	}

	// trace fsi path
	ss.str(std::string()); // clear stream
	ss << "target - " << path;
	trace<level::INFO>(ss.str().c_str());

	isr_val = 0xffffffff; // invalid isr value

	// get active attentions on processor
	if (RC_SUCCESS != fsi_read(attnTarget, 0x1007, &isr_val))
	{
	// log cfam read error
	trace<level::INFO>("Error! cfam read 0x1007 FAILED");
	eventAttentionFail(RC_CFAM_ERROR);
	}
	else if (0xffffffff == isr_val)
	{
	trace<level::INFO>("Error! cfam read 0x1007 INVALID");
	continue;
	}
	else
	{
	// trace isr
	ss.str(std::string()); // clear stream
	ss << std::hex << std::showbase; // trace as hex vals
	ss << "cfam 0x1007 = " << std::setw(8) << std::setfill('0')
	<< isr_val;
	trace<level::INFO>(ss.str().c_str());

	isr_mask = 0xffffffff; // invalid isr mask

	// get interrupt enabled special attentions mask
	if (RC_SUCCESS != fsi_read(attnTarget, 0x100d, &isr_mask))
	{
	// log cfam read error
	trace<level::INFO>("Error! cfam read 0x100d FAILED");
	eventAttentionFail(RC_CFAM_ERROR);
	}
	else if (0xffffffff == isr_mask)
	{
	trace<level::INFO>("Error! cfam read 0x100d INVALID");
	continue;
	}
	else
	{
	// trace true-mask
	ss.str(std::string()); // clear stream
	ss << std::hex << std::showbase; // trace as hex vals
	ss << "cfam 0x100d = " << std::setw(8)
	<< std::setfill('0') << isr_mask;
	trace<level::INFO>(ss.str().c_str());

	// SBE vital attention active and not masked?
	if (true == activeAttn(isr_val, isr_mask, SBE_ATTN))
	{
	active_attentions.emplace_back(Attention::Vital,
	handleVital, target,
	i_config);
	}

	// Checkstop attention active and not masked?
	if (true ==
	activeAttn(isr_val, isr_mask, CHECKSTOP_ATTN))
	{
	active_attentions.emplace_back(Attention::Checkstop,
	handleCheckstop,
	target, i_config);
	}

	// Special attention active and not masked?
	if (true == activeAttn(isr_val, isr_mask, SPECIAL_ATTN))
	{
	active_attentions.emplace_back(Attention::Special,
	handleSpecial,
	target, i_config);
	}
	} // cfam 0x100d valid
	} // cfam 0x1007 valid
	} // proc target enabled
	} // fsi target enabled
	} // next processor

	// convert to heap, highest priority is at front
	if (!std::is_heap(active_attentions.begin(), active_attentions.end()))
	{
	std::make_heap(active_attentions.begin(), active_attentions.end());
	}

	// call the attention handler until one is handled or all were attempted
	while (false == active_attentions.empty())
	{
	// handle highest priority attention, done if successful
	if (RC_SUCCESS == active_attentions.front().handle())
	{
	// an attention was handled so we are done
	break;
	}

	// move attention to back of vector
	std::pop_heap(active_attentions.begin(), active_attentions.end());

	// remove attention from vector
	active_attentions.pop_back();
	}
	}

	/**
	* @brief Handle SBE vital attention
	*
	* @param i_attention Attention object
	* @return 0 indicates that the vital attention was successfully handled
	* 1 indicates that the vital attention was NOT successfully handled
	*/
	int handleVital(Attention* i_attention)
	{
	int rc = RC_SUCCESS; // assume vital handled

	trace<level::INFO>("vital handler started");

	// if vital handling enabled, handle vital attention
	if (false == (i_attention->getConfig()->getFlag(enVital)))
	{
	trace<level::INFO>("vital handling disabled");
	rc = RC_NOT_HANDLED;
	}
	else
	{
	eventVital();
	}

	return rc;
	}

	/**
	* @brief Handle checkstop attention
	*
	* @param i_attention Attention object
	* @return 0 indicates that the checkstop attention was successfully handled
	* 1 indicates that the checkstop attention was NOT successfully
	* handled.
	*/
	int handleCheckstop(Attention* i_attention)
	{
	int rc = RC_SUCCESS; // assume checkstop handled

	trace<level::INFO>("checkstop handler started");

	// if checkstop handling enabled, handle checkstop attention
	if (false == (i_attention->getConfig()->getFlag(enCheckstop)))
	{
	trace<level::INFO>("Checkstop handling disabled");
	}
	else
	{
	// Look for any attentions found in hardware. This will generate and
	// commit a PEL if any errors are found.
	if (true != analyzer::analyzeHardware())
	{
	rc = RC_ANALYZER_ERROR;
	}
	}

	return rc;
	}

	/**
	* @brief Handle special attention
	*
	* @param i_attention Attention object
	* @return 0 indicates that the special attention was successfully handled
	* 1 indicates that the special attention was NOT successfully handled
	*/
	int handleSpecial(Attention* i_attention)
	{
	int rc = RC_SUCCESS; // assume special attention handled

	// The TI info chipop will give us a pointer to the TI info data
	uint8_t* tiInfo = nullptr; // ptr to TI info data
	uint32_t tiInfoLen = 0; // length of TI info data
	pdbg_target* attnProc = i_attention->getTarget(); // proc with attention

	if (attnProc != nullptr)
	{
	// The processor PIB target is required for get TI info chipop
	char path[16];
	sprintf(path, "/proc%d/pib", pdbg_target_index(attnProc));
	pdbg_target* tiInfoTarget = pdbg_target_from_path(nullptr, path);

	if (nullptr != tiInfoTarget)
	{
	if (PDBG_TARGET_ENABLED == pdbg_target_probe(tiInfoTarget))
	{
	sbe_mpipl_get_ti_info(tiInfoTarget, &tiInfo, &tiInfoLen);
	if (tiInfo == nullptr)
	{
	trace<level::INFO>("TI info data ptr is null after call");
	}
	}
	}
	}

	// If TI area exists and is marked valid we can assume TI occurred
	if ((nullptr != tiInfo) && (0 != tiInfo[0]))
	{
	TiDataArea* tiDataArea = (TiDataArea*)tiInfo;

	// trace a few known TI data area values
	std::stringstream ss;
	ss << std::hex << std::showbase;

	ss << "TI data command = " << (int)tiDataArea->command;
	trace<level::INFO>(ss.str().c_str());
	ss.str(std::string());

	ss << "TI data hb_terminate_type = "
	<< (int)tiDataArea->hbTerminateType;
	trace<level::INFO>(ss.str().c_str());
	ss.str(std::string());

	ss << "TI data SRC format = " << (int)tiDataArea->srcFormat;
	trace<level::INFO>(ss.str().c_str());
	ss.str(std::string());

	ss << "TI data source = " << (int)tiDataArea->source;
	trace<level::INFO>(ss.str().c_str());
	ss.str(std::string());

	if (true == (i_attention->getConfig()->getFlag(enTerminate)))
	{
	// Call TI special attention handler
	rc = tiHandler(tiDataArea);
	}
	}
	// TI area not valid or not available
	else
	{
	trace<level::INFO>("TI info NOT available");

	// if configured to handle breakpoint as default special attention
	if (i_attention->getConfig()->getFlag(dfltBreakpoint))
	{
	if (true == (i_attention->getConfig()->getFlag(enBreakpoints)))
	{
	// Call the breakpoint special attention handler
	bpHandler();
	}
	}
	// if configured to handle TI as default special attention
	else
	{
	trace<level::INFO>("assuming TI");

	if (true == (i_attention->getConfig()->getFlag(enTerminate)))
	{
	// Call TI special attention handler
	rc = tiHandler(nullptr);
	}
	}
	}

	// release TI data buffer
	if (nullptr != tiInfo)
	{
	free(tiInfo);
	}

	if (RC_SUCCESS != rc)
	{
	trace<level::INFO>("Special attn not handled");
	}

	return rc;
	}

	/**
	* @brief Determine if attention is active and not masked
	*
	* Determine whether an attention needs to be handled and trace details of
	* attention type and whether it is masked or not.
	*
	* @param i_val attention status register
	* @param i_mask attention true mask register
	* @param i_attn attention type
	* @param i_proc processor associated with registers
	*
	* @return true if attention is active and not masked, otherwise false
	*/
	bool activeAttn(uint32_t i_val, uint32_t i_mask, uint32_t i_attn)
	{
	bool rc = false; // assume attn masked and/or inactive
	bool validAttn = true; // known attention type

	// if attention active
	if (0 != (i_val & i_attn))
	{
	std::stringstream ss;

	switch (i_attn)
	{
	case SBE_ATTN:
	ss << "SBE attn";
	break;
	case CHECKSTOP_ATTN:
	ss << "Checkstop attn";
	break;
	case SPECIAL_ATTN:
	ss << "Special attn";
	break;
	default:
	ss << "Unknown attn";
	validAttn = false;
	}

	// see if attention is masked
	if (true == validAttn)
	{
	if (0 != (i_mask & i_attn))
	{
	rc = true; // attention active and not masked
	}
	else
	{
	ss << " masked";
	}
	}

	trace<level::INFO>(ss.str().c_str()); // commit trace stream
	}

	return rc;
	}

	} // namespace attn