path: root/src/usr/hwas/common/deconfigGard.C

/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/hwas/common/deconfigGard.C $                          */
/*                                                                        */
/* IBM CONFIDENTIAL                                                       */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2011,2013              */
/*                                                                        */
/* p1                                                                     */
/*                                                                        */
/* Object Code Only (OCO) source materials                                */
/* Licensed Internal Code Source Materials                                */
/* IBM HostBoot Licensed Internal Code                                    */
/*                                                                        */
/* The source code for this program is not published or otherwise         */
/* divested of its trade secrets, irrespective of what has been           */
/* deposited with the U.S. Copyright Office.                              */
/*                                                                        */
/* Origin: 30                                                             */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
/**
 *  @file deconfigGard.C
 *
 *  @brief Implements the DeconfigGard class
 */
#include <stdint.h>
#include <algorithm>

#include <hwas/common/hwas.H>
#include <hwas/common/hwasCommon.H>
#include <hwas/common/deconfigGard.H>
#include <hwas/common/hwas_reasoncodes.H>
#include <targeting/common/utilFilter.H>

#include <hwas/common/hwas.H>                   // checkMinimumHardware()

// Trace definition
#define __COMP_TD__ g_trac_deconf

// TODO The DeconfigGard code needs to trace a target. The current recommended
// way is to get the Target's PHYS_PATH attribute and do a binary trace.
// However, the size of a TARGETING::EntityPath is more than 16 bytes. This code
// will trace only the first 16 bytes (which in most cases is enough) to avoid a
// multi-line binary trace. This all seems a little convoluted. Is there a
// better way to trace a Target
#define DG_DBG_TARGET(string, pPath) \
    HWAS_DBG_BIN(string, pPath, sizeof(TARGETING::EntityPath) - 1)
#define DG_INF_TARGET(string, pPath) \
    HWAS_INF_BIN(string, pPath, sizeof(TARGETING::EntityPath) - 1)
#define DG_ERR_TARGET(string, pPath) \
    HWAS_ERR_BIN(string, pPath, sizeof(TARGETING::EntityPath) - 1)

// TODO There are a number of error logs created in this file. Most of them
// should include the target identifier (PHYS_PATH). There is a plan in RTC
// story 4110 to provide a way to easily add a target to an error log. When that
// is done need to update the error logs

namespace HWAS
{

using namespace HWAS::COMMON;

bool processDeferredDeconfig()
{
    return HWAS::theDeconfigGard()._processDeferredDeconfig();
}

errlHndl_t collectGard(const TARGETING::PredicateBase *i_pPredicate)
{
    HWAS_INF("collectGard entry" );
    errlHndl_t errl = NULL;

    do
    {

        errl = theDeconfigGard().clearGardRecordsForReplacedTargets();
        if (errl)
        {
            HWAS_ERR("ERROR: collectGard failed to clear GARD Records for replaced Targets");
            break;
        }

        errl = theDeconfigGard().
                    deconfigureTargetsFromGardRecordsForIpl(i_pPredicate);
        if (errl)
        {
            HWAS_ERR("ERROR: collectGard failed to deconfigure Targets from GARD Records for IPL");
            break;
        }

        errl = theDeconfigGard().processFieldCoreOverride();
        if (errl)
        {
            HWAS_ERR("ERROR: collectGard failed to process Field Core Override");
            break;
        }
    }
    while(0);

    if (errl)
    {
        HWAS_INF("collectGard failed (plid 0x%X)", errl->plid());
    }
    else
    {
        HWAS_INF("collectGard completed successfully");
    }
    return errl;
}

//******************************************************************************
DeconfigGard & theDeconfigGard()
{
    return HWAS_GET_SINGLETON(theDeconfigGardSingleton);
}

//******************************************************************************
DeconfigGard::DeconfigGard()
: iv_nextGardRecordId(0),
  iv_maxGardRecords(0),
  iv_pGardRecords(NULL)
{
    HWAS_INF("DeconfigGard Constructor");
    HWAS_MUTEX_INIT(iv_mutex);
}

//******************************************************************************
DeconfigGard::~DeconfigGard()
{
    HWAS_INF("DeconfigGard Destructor");
    HWAS_MUTEX_DESTROY(iv_mutex);
}

//******************************************************************************
errlHndl_t DeconfigGard::clearGardRecordsForReplacedTargets()
{
    HWAS_INF("User Request: Clear GARD Records for replaced Targets");
    errlHndl_t l_pErr = NULL;

    // Create the predicate with HWAS changed state and our GARD bit
    TARGETING::PredicateHwasChanged l_predicateHwasChanged;
    l_predicateHwasChanged.changedBit(TARGETING::HWAS_CHANGED_BIT_GARD, true);

    HWAS_MUTEX_LOCK(iv_mutex);
    do
    {
        GardAddress l_GardAddress(l_pErr);
        if (l_pErr)
        {
            HWAS_ERR("Error from l_GardAddress");
            break;
        }

        // For each GARD Record
        for (uint32_t i = 0; i < iv_maxGardRecords; i++)
        {
            if (iv_pGardRecords[i].iv_recordId == EMPTY_GARD_RECORDID)
            {
                // if this isn't a valid/filled GARD record, skip
                continue;
            }

            // Find the associated Target
            TARGETING::Target* l_pTarget = TARGETING::targetService().
                            toTarget(iv_pGardRecords[i].iv_targetId);

            if (l_pTarget == NULL)
            {
                // could be a platform specific target for the other
                // ie, we are hostboot and this is an FSP target, or vice-versa
                DG_INF_TARGET("Could not find Target for",
                               &(iv_pGardRecords[i].iv_targetId));
                continue;
            }

            // if this does NOT match, continue to next in loop
            if (l_predicateHwasChanged(l_pTarget) == false)
            {
                HWAS_INF("skipping %.8X - GARD changed bit false",
                        TARGETING::get_huid(l_pTarget));
                continue;
            }

            // Clear the gard record
            HWAS_INF("clearing GARD for %.8X, recordId %d",
                        TARGETING::get_huid(l_pTarget),
                        iv_pGardRecords[i].iv_recordId);
            iv_pGardRecords[i].iv_recordId = EMPTY_GARD_RECORDID;
            l_GardAddress.writeRecord(&iv_pGardRecords[i]);
            l_GardAddress.flush();

            // now clear our 'changed' bit
            TARGETING::clear_hwas_changed_bit(
                    l_pTarget,TARGETING::HWAS_CHANGED_BIT_GARD);

        } // for
    }
    while (0);

    HWAS_MUTEX_UNLOCK(iv_mutex);
    return l_pErr;
}

//******************************************************************************
errlHndl_t DeconfigGard::deconfigureTargetsFromGardRecordsForIpl(
        const TARGETING::PredicateBase *i_pPredicate)
{
    HWAS_INF("Deconfigure Targets from GARD Records for IPL");
    errlHndl_t l_pErr = NULL;
    GardRecords_t l_gardRecords;

    // TODO If deconfiguring all Targets with a GARD Record will result in a
    //      configuration that cannot IPL then need to figure out which
    //      subset of Targets to deconfigure to give the best chance of IPL
    //      This is known as Resource Recovery

    HWAS_MUTEX_LOCK(iv_mutex);
    do
    {
        TARGETING::Target* pSys;
        TARGETING::targetService().getTopLevelTarget(pSys);
        HWAS_ASSERT(pSys,
                "HWAS _createGardRecord: no system TopLevelTarget found");

        // check for system CDM Policy
        const TARGETING::ATTR_CDM_POLICIES_type l_sys_policy =
                pSys->getAttr<TARGETING::ATTR_CDM_POLICIES>();
        if (l_sys_policy & TARGETING::CDM_POLICIES_MANUFACTURING_DISABLED)
        {
            // manufacturing records are disabled
            //  - don't process
            HWAS_INF("Manufacturing policy: disabled - skipping GARD Records");
            break;
        }

        // Get all GARD Records
        l_pErr = _getGardRecords(GET_ALL_GARD_RECORDS, l_gardRecords);
        if (l_pErr)
        {
            HWAS_ERR("Error from _getGardRecords");
            break;
        }

        HWAS_INF("%d GARD Records found", l_gardRecords.size());

        if (l_gardRecords.empty())
        {
            break;
        }

        // For each GARD Record
        for (GardRecordsCItr_t l_itr = l_gardRecords.begin();
             l_itr != l_gardRecords.end();
             ++l_itr)
        {
            GardRecord l_gardRecord = *l_itr;

            if ((l_sys_policy & TARGETING::CDM_POLICIES_PREDICTIVE_DISABLED) &&
                (l_gardRecord.iv_errorType == GARD_Predictive))
            {
                // predictive records are disabled AND gard record is predictive
                //  - don't process
                HWAS_INF("Predictive policy: disabled - skipping GARD Record");
                continue;
            }

            if ((l_sys_policy & TARGETING::CDM_POLICIES_FUNCTIONAL_DISABLED) &&
                (l_gardRecord.iv_errorType == GARD_Func))
            {
                // functional records are disabled AND gard record is Functional
                //  - don't process
                HWAS_INF("Functional policy: disabled - skipping GARD Record");
                continue;
            }

            // Find the associated Target
            TARGETING::Target * l_pTarget =
                TARGETING::targetService().toTarget(l_gardRecord.iv_targetId);

            if (l_pTarget == NULL)
            {
                // could be a platform specific target for the other
                // ie, we are hostboot and this is an FSP target, or vice-versa
                DG_INF_TARGET("Could not find Target for",
                               &(l_gardRecord.iv_targetId));
                continue;
            }

            // if this does NOT match, continue to next in loop
            if (i_pPredicate && ((*i_pPredicate)(l_pTarget) == false))
            {
                HWAS_INF("skipping %.8X - predicate didn't match",
                        TARGETING::get_huid(l_pTarget));
                continue;
            }

            // skip if not present
            if (!l_pTarget->getAttr<TARGETING::ATTR_HWAS_STATE>().present)
            {
                HWAS_INF("skipping %.8X - target not present",
                        TARGETING::get_huid(l_pTarget));
                continue;
            }

            // special case - use errlogPlid UNLESS it's a Manual Gard
            const uint32_t l_errlogPlid =
                (l_gardRecord.iv_errorType == GARD_User_Manual) ?
                    DECONFIGURED_BY_MANUAL_GARD : l_gardRecord.iv_errlogPlid;

            // Deconfigure the Target
            // don't need to check ATTR_DECONFIG_GARDABLE -- if we get
            //  here, it's because of a gard record on this target
            _deconfigureTarget(*l_pTarget, l_errlogPlid);

            // Deconfigure other Targets by association
            _deconfigureByAssoc(*l_pTarget, l_errlogPlid);
        } // for

        //  check and see if we still have enough hardware to continue
        l_pErr  =   checkMinimumHardware();
        if ( l_pErr )
        {
            HWAS_ERR("Error from checkMinimumHardware ");
            break;
        }
    }
    while (0);

    HWAS_MUTEX_UNLOCK(iv_mutex);
    return l_pErr;
}

bool compareTargetHuid(TARGETING::TargetHandle_t t1,
        TARGETING::TargetHandle_t t2)
{
    return (t1->getAttr<TARGETING::ATTR_HUID>() <
                t2->getAttr<TARGETING::ATTR_HUID>());
}

//******************************************************************************
errlHndl_t DeconfigGard::processFieldCoreOverride()
{
    HWAS_INF("Process Field Core Override FCO");
    errlHndl_t l_pErr = NULL;

    do
    {
        // otherwise, process and reduce cores.
        // find all functional NODE targets
        TARGETING::Target* pSys;
        TARGETING::targetService().getTopLevelTarget(pSys);
        TARGETING::PredicateCTM predNode(TARGETING::CLASS_ENC,
                                        TARGETING::TYPE_NODE);
        TARGETING::PredicateHwas predFunctional;
        predFunctional.functional(true);
        TARGETING::PredicatePostfixExpr nodeCheckExpr;
        nodeCheckExpr.push(&predNode).push(&predFunctional).And();

        TARGETING::TargetHandleList pNodeList;
        TARGETING::targetService().getAssociated(pNodeList, pSys,
                        TARGETING::TargetService::CHILD,
                        TARGETING::TargetService::ALL,
                        &nodeCheckExpr);

        // sort the list by ATTR_HUID to ensure that we
        //  start at the same place each time
        std::sort(pNodeList.begin(), pNodeList.end(),
                    compareTargetHuid);

        // for each of the nodes
        for (TARGETING::TargetHandleList::const_iterator
                pNode_it = pNodeList.begin();
                pNode_it != pNodeList.end();
                ++pNode_it
            )
        {
            const TARGETING::TargetHandle_t pNode = *pNode_it;

            // Get FCO value
            uint32_t l_fco = 0;
            l_pErr = platGetFCO(pNode, l_fco);
            if (l_pErr)
            {
                HWAS_ERR("Error from platGetFCO");
                break;
            }

            // FCO of 0 means no overrides for this node
            if (l_fco == 0)
            {
                HWAS_INF("FCO: node %.8X: no overrides, done.",
                        TARGETING::get_huid(pNode));
                continue; // next node
            }

            HWAS_INF("FCO: node %.8X: value %d",
                TARGETING::get_huid(pNode), l_fco);

            // find all functional child PROC targets
            TARGETING::TargetHandleList pProcList;
            TARGETING::getChildAffinityTargets(pProcList, pNode,
                    TARGETING::CLASS_CHIP, TARGETING::TYPE_PROC,
                    true);

            // sort the list by ATTR_HUID to ensure that we
            //  start at the same place each time
            std::sort(pProcList.begin(), pProcList.end(),
                    compareTargetHuid);

            // create list for restrictEXunits() function
            procRestrict_t l_procEntry;
            std::vector <procRestrict_t> l_procRestrictList;
            for (TARGETING::TargetHandleList::const_iterator
                    pProc_it = pProcList.begin();
                    pProc_it != pProcList.end();
                    ++pProc_it
                )
            {
                const TARGETING::TargetHandle_t pProc = *pProc_it;

                // save info so that we can
                //  restrict the number of EX units
                HWAS_INF("pProc %.8X - pushing to proclist",
                    TARGETING::get_huid(pProc));
                l_procEntry.target = pProc;
                l_procEntry.group = 0;
                l_procEntry.procs = pProcList.size();
                l_procEntry.maxEXs = l_fco;
                l_procRestrictList.push_back(l_procEntry);
            } // for pProc_it

            // restrict the EX units; units turned off are marked
            //  present=true, functional=false, and marked with the
            //  appropriate deconfigure code.
            HWAS_INF("FCO: calling restrictEXunits with %d entries",
                    l_procRestrictList.size());
            l_pErr = restrictEXunits(l_procRestrictList,
                        true, DECONFIGURED_BY_FIELD_CORE_OVERRIDE);
            if (l_pErr)
            {
                break;
            }
        } // for pNode_it
    }
    while (0);

    return l_pErr;
}

//******************************************************************************
errlHndl_t DeconfigGard::deconfigureTarget(TARGETING::Target & i_target,
                                           const uint32_t i_errlPlid,
                                           bool i_evenAtRunTime)
{
    HWAS_INF("Deconfigure Target");
    errlHndl_t l_pErr = NULL;

    do
    {
        // Do not deconfig Target if we're NOT being asked to force AND
        //   the is System is at runtime
        if (!i_evenAtRunTime && platSystemIsAtRuntime())
        {
            HWAS_INF("Skipping deconfigTarget - System at Runtime");
            break;
        }

        const uint8_t lDeconfigGardable =
                i_target.getAttr<TARGETING::ATTR_DECONFIG_GARDABLE>();
        const uint8_t lPresent =
                i_target.getAttr<TARGETING::ATTR_HWAS_STATE>().present;
        if (!lDeconfigGardable || !lPresent)
        {
            // Target is not Deconfigurable. Create an error
            HWAS_ERR("Target %.8X not Deconfigurable",
                TARGETING::get_huid(&i_target));

            /*@
             * @errortype
             * @moduleid     HWAS::MOD_DECONFIG_GARD
             * @reasoncode   HWAS::RC_TARGET_NOT_DECONFIGURABLE
             * @devdesc      Attempt to deconfigure a target that is not
             *               deconfigurable
             *               (not DECONFIG_GARDABLE or not present)
             * @userdata1    HUID of input target // GARD errlog PLID
             * @userdata2    ATTR_DECONFIG_GARDABLE // ATTR_HWAS_STATE.present
             */
            const uint64_t userdata1 =
                (static_cast<uint64_t>(TARGETING::get_huid(&i_target)) << 32) |
                i_errlPlid;
            const uint64_t userdata2 =
                (static_cast<uint64_t>(lDeconfigGardable) << 32) | lPresent;
            l_pErr = hwasError(
                ERRL_SEV_INFORMATIONAL,
                HWAS::MOD_DECONFIG_GARD,
                HWAS::RC_TARGET_NOT_DECONFIGURABLE,
                userdata1,
                userdata2);
            break;
        }

        // all ok - do the work
        HWAS_MUTEX_LOCK(iv_mutex);

        // Deconfigure the Target
        _deconfigureTarget(i_target, i_errlPlid);

        // Deconfigure other Targets by association
        _deconfigureByAssoc(i_target, i_errlPlid);

        HWAS_MUTEX_UNLOCK(iv_mutex);

        //  check and see if we still have enough hardware to continue
        l_pErr  =   checkMinimumHardware();
        if ( l_pErr )
        {
            HWAS_ERR("Error from checkMinimumHardware ");
            break;
        }

    }
    while (0);

    return l_pErr;
}

//******************************************************************************
void DeconfigGard::registerDeferredDeconfigure(
        const TARGETING::Target & i_target,
        const uint32_t i_errlPlid)
{
    HWAS_INF("registerDeferredDeconfigure Target %.8X, errlPlid %X",
            TARGETING::get_huid(&i_target), i_errlPlid);

    // Create a Deconfigure Record
    HWAS_MUTEX_LOCK(iv_mutex);
    _createDeconfigureRecord(i_target, i_errlPlid);
    HWAS_MUTEX_UNLOCK(iv_mutex);
}

//******************************************************************************
errlHndl_t DeconfigGard::createGardRecord(const TARGETING::Target & i_target,
                                          const uint32_t i_errlPlid,
                                          const GARD_ErrorType i_errorType)
{
    HWAS_INF("Create GARD Record");
    HWAS_MUTEX_LOCK(iv_mutex);
    errlHndl_t l_pErr = _createGardRecord(i_target, i_errlPlid, i_errorType);
    HWAS_MUTEX_UNLOCK(iv_mutex);
    return l_pErr;
}

//******************************************************************************
errlHndl_t DeconfigGard::_getDeconfigureRecords(
    const TARGETING::Target * i_pTarget,
    DeconfigureRecords_t & o_records)
{
    HWAS_INF("Get Deconfigure Record(s)");
    HWAS_MUTEX_LOCK(iv_mutex);

    DeconfigureRecordsCItr_t l_itr = iv_deconfigureRecords.begin();
    o_records.clear();

    if (i_pTarget == NULL)
    {
        HWAS_INF("Getting all %d Deconfigure Records",
                 iv_deconfigureRecords.size());

        for (; l_itr != iv_deconfigureRecords.end(); ++l_itr)
        {
            o_records.push_back(*l_itr);
        }
    }
    else
    {
        // Look for a Deconfigure Record for the specified Target (there can
        // only be one record)
        for (; l_itr != iv_deconfigureRecords.end(); ++l_itr)
        {
            if ((*l_itr).iv_target == i_pTarget)
            {
                HWAS_INF("Getting Deconfigure Record for %.8X",
                               get_huid(i_pTarget));
                o_records.push_back(*l_itr);
                break;
            }
        }

        if (l_itr == iv_deconfigureRecords.end())
        {
            HWAS_INF("Did not find a Deconfigure Record for %.8X",
                           get_huid(i_pTarget));
        }
    }

    HWAS_MUTEX_UNLOCK(iv_mutex);
    return NULL;
}


//******************************************************************************
errlHndl_t DeconfigGard::clearGardRecords(const uint32_t i_recordId)
{
    HWAS_INF("Clear GARD Record(s) by Record ID");
    HWAS_MUTEX_LOCK(iv_mutex);
    errlHndl_t l_pErr = _clearGardRecords(i_recordId);
    HWAS_MUTEX_UNLOCK(iv_mutex);
    return l_pErr;
}

//******************************************************************************
errlHndl_t DeconfigGard::clearGardRecords(
    const TARGETING::EntityPath & i_targetId)
{
    HWAS_INF("Clear GARD Record(s) by Target ID");
    HWAS_MUTEX_LOCK(iv_mutex);
    errlHndl_t l_pErr = _clearGardRecords(i_targetId);
    HWAS_MUTEX_UNLOCK(iv_mutex);
    return l_pErr;
}

//******************************************************************************
errlHndl_t DeconfigGard::getGardRecords(
    const uint32_t i_recordId,
    GardRecords_t & o_records)
{
    HWAS_INF("Get GARD Record(s) by Record ID");
    HWAS_MUTEX_LOCK(iv_mutex);
    errlHndl_t l_pErr = _getGardRecords(i_recordId, o_records);
    HWAS_MUTEX_UNLOCK(iv_mutex);
    return l_pErr;
}

//******************************************************************************
errlHndl_t DeconfigGard::getGardRecords(
    const TARGETING::EntityPath & i_targetId,
    GardRecords_t & o_records)
{
    HWAS_INF("Get GARD Record(s) by Target ID");
    HWAS_MUTEX_LOCK(iv_mutex);
    errlHndl_t l_pErr = _getGardRecords(i_targetId, o_records);
    HWAS_MUTEX_UNLOCK(iv_mutex);
    return l_pErr;
}

//******************************************************************************
void DeconfigGard::_deconfigureByAssoc(TARGETING::Target & i_target,
                                       const uint32_t i_errlPlid)
{
    HWAS_INF("Deconfiguring by Association for: %.8X",
                   TARGETING::get_huid(&i_target));

    TARGETING::TargetHandleList pChildList;
    TARGETING::PredicateHwas hwasPredicate;
    hwasPredicate.poweredOn(true).present(true).functional(true);

    // find all CHILD and CHILD_BY_AFFINITY matches for this target
    // and deconfigure them
    TARGETING::targetService().getAssociated( pChildList, &i_target,
        TARGETING::TargetService::CHILD,
        TARGETING::TargetService::ALL,
        &hwasPredicate);
    for (TARGETING::TargetHandleList::const_iterator
            pChild_it = pChildList.begin();
            pChild_it != pChildList.end();
            ++pChild_it)
    {
        TARGETING::TargetHandle_t pChild = *pChild_it;

        if (pChild->getAttr<TARGETING::ATTR_DECONFIG_GARDABLE>())
        {   // only deconfigure targets that are able to be deconfigured
            _deconfigureTarget(*pChild, i_errlPlid);
        }
    } // for CHILD

    TARGETING::targetService().getAssociated( pChildList, &i_target,
        TARGETING::TargetService::CHILD_BY_AFFINITY,
        TARGETING::TargetService::ALL,
        &hwasPredicate);
    for (TARGETING::TargetHandleList::const_iterator
            pChild_it = pChildList.begin();
            pChild_it != pChildList.end();
            ++pChild_it)
    {
        TARGETING::TargetHandle_t pChild = *pChild_it;

        if (pChild->getAttr<TARGETING::ATTR_DECONFIG_GARDABLE>())
        {   // only deconfigure targets that are able to be deconfigured
            _deconfigureTarget(*pChild, i_errlPlid);
        }
    } // for CHILD_BY_AFFINITY
}

//******************************************************************************
void DeconfigGard::_deconfigureTarget(TARGETING::Target & i_target,
                                      const uint32_t i_errlPlid)
{
    HWAS_INF("Deconfiguring Target %.8X, errlPlid %X",
            TARGETING::get_huid(&i_target), i_errlPlid);

    // Set the Target state to non-functional. The assumption is that it is
    // not possible for another thread (other than deconfigGard) to be
    // updating HWAS_STATE concurrently.
    TARGETING::HwasState l_state =
        i_target.getAttr<TARGETING::ATTR_HWAS_STATE>();

    if (!l_state.functional)
    {
        HWAS_DBG(
        "Target HWAS_STATE already has functional=0; deconfiguredByPlid=0x%x",
                l_state.deconfiguredByPlid);
    }
    else
    {
        HWAS_INF(
        "Setting Target HWAS_STATE: functional=0, deconfiguredByPlid=0x%x",
            i_errlPlid);
        l_state.functional = 0;
        l_state.deconfiguredByPlid = i_errlPlid;
        i_target.setAttr<TARGETING::ATTR_HWAS_STATE>(l_state);
    }

    // Do any necessary Deconfigure Actions
    _doDeconfigureActions(i_target);
}

//******************************************************************************
void DeconfigGard::_doDeconfigureActions(TARGETING::Target & i_target)
{
    // TODO
}

//******************************************************************************
void DeconfigGard::_createDeconfigureRecord(
    const TARGETING::Target & i_target,
    const uint32_t i_errlPlid)
{
    // Look for an existing Deconfigure Record for the Target
    DeconfigureRecordsCItr_t l_itr = iv_deconfigureRecords.begin();

    for (; l_itr != iv_deconfigureRecords.end(); ++l_itr)
    {
        if ((*l_itr).iv_target == &i_target)
        {
            HWAS_DBG("Not creating Deconfigure Record, one exists errlPlid %X",
                (*l_itr).iv_errlogPlid);
            break;
        }
    }

    // didn't find a match
    if (l_itr == iv_deconfigureRecords.end())
    {
        // Create a DeconfigureRecord
        HWAS_INF("Creating a Deconfigure Record");

        DeconfigureRecord l_record;
        l_record.iv_target = &i_target;
        l_record.iv_errlogPlid = i_errlPlid;

        iv_deconfigureRecords.push_back(l_record);
    }
}

//******************************************************************************
void DeconfigGard::clearDeconfigureRecords(
        const TARGETING::Target * i_pTarget)
{
    if (i_pTarget == NULL)
    {
        HWAS_INF("Clearing all %d Deconfigure Records",
                 iv_deconfigureRecords.size());
        iv_deconfigureRecords.clear();
    }
    else
    {
        // Look for a Deconfigure Record for the specified Target (there can
        // only be one record)
        bool l_foundRecord = false;

        for (DeconfigureRecordsItr_t l_itr = iv_deconfigureRecords.begin();
             l_itr != iv_deconfigureRecords.end(); ++l_itr)
        {
            if ((*l_itr).iv_target == i_pTarget)
            {
                HWAS_INF("Clearing Deconfigure Record for %.8X",
                                get_huid(i_pTarget));
                iv_deconfigureRecords.erase(l_itr);
                l_foundRecord = true;
                break;
            }
        }

        if (!l_foundRecord)
        {
            HWAS_INF("Did not find a Deconfigure Record to clear for %.8X",
                           get_huid(i_pTarget));
        }
    }
}


//******************************************************************************
bool DeconfigGard::_processDeferredDeconfig()
{
    HWAS_DBG(">processDeferredDeconfig");

    // get all deconfigure records, process them, and delete them.
    HWAS_MUTEX_LOCK(iv_mutex);

    // we return true if there were targets to deconfigure.
    bool rc = !iv_deconfigureRecords.empty();

    for (DeconfigureRecordsItr_t l_itr = iv_deconfigureRecords.begin();
            l_itr != iv_deconfigureRecords.end();
            ++l_itr)
    {
        // do the deconfigure
        DeconfigureRecord l_record = *l_itr;
        _deconfigureTarget(
                const_cast<TARGETING::Target &> (*(l_record.iv_target)),
                l_record.iv_errlogPlid);
    } // for

    // clear the list - handled them all
    iv_deconfigureRecords.clear();

    HWAS_MUTEX_UNLOCK(iv_mutex);

    HWAS_DBG("<processDeferredDeconfig returning %d", rc);
    return rc;
} // _processDeferredDeconfig

//******************************************************************************
errlHndl_t DeconfigGard::_createGardRecord(const TARGETING::Target & i_target,
                                           const uint32_t i_errlPlid,
                                           const GARD_ErrorType i_errorType)
{
    HWAS_INF("Creating GARD Record for %.8X",
            TARGETING::get_huid(&i_target));
    errlHndl_t l_pErr = NULL;

    do
    {
        const uint8_t lDeconfigGardable =
                i_target.getAttr<TARGETING::ATTR_DECONFIG_GARDABLE>();
        const uint8_t lPresent =
                i_target.getAttr<TARGETING::ATTR_HWAS_STATE>().present;
        if (!lDeconfigGardable || !lPresent)
        {
            // Target is not GARDable. Commit an error
            HWAS_ERR("Target not GARDable");

            /*@
             * @errortype
             * @moduleid     HWAS::MOD_DECONFIG_GARD
             * @reasoncode   HWAS::RC_TARGET_NOT_GARDABLE
             * @devdesc      Attempt to create a GARD Record for a target that
             *               is not GARDable
             *               (not DECONFIG_GARDABLE or not present)
             * @userdata1    HUID of input target // GARD errlog PLID
             * @userdata2    ATTR_DECONFIG_GARDABLE // ATTR_HWAS_STATE.present
             */
            const uint64_t userdata1 =
                (static_cast<uint64_t>(TARGETING::get_huid(&i_target)) << 32) |
                i_errlPlid;
            const uint64_t userdata2 =
                (static_cast<uint64_t>(lDeconfigGardable) << 32) | lPresent;
            l_pErr = hwasError(
                ERRL_SEV_UNRECOVERABLE,
                HWAS::MOD_DECONFIG_GARD,
                HWAS::RC_TARGET_NOT_GARDABLE,
                userdata1,
                userdata2);
            break;
        }

        TARGETING::Target* pSys;
        TARGETING::targetService().getTopLevelTarget(pSys);
        HWAS_ASSERT(pSys,
                "HWAS _createGardRecord: no system TopLevelTarget found");

        // check for system CDM Policy
        const TARGETING::ATTR_CDM_POLICIES_type l_sys_policy =
                pSys->getAttr<TARGETING::ATTR_CDM_POLICIES>();
        if (l_sys_policy & TARGETING::CDM_POLICIES_MANUFACTURING_DISABLED)
        {
            // manufacturing records are disabled
            //  - don't process
            HWAS_INF("Manufacturing policy: disabled - skipping GARD Record");
            break;
        }

        if ((l_sys_policy & TARGETING::CDM_POLICIES_PREDICTIVE_DISABLED) &&
            (i_errorType == GARD_Predictive))
        {
            // predictive records are disabled AND gard record is predictive
            //  - don't process
            HWAS_INF("Predictive policy: disabled - skipping GARD Record");
            break;
        }

        if ((l_sys_policy & TARGETING::CDM_POLICIES_FUNCTIONAL_DISABLED) &&
            (i_errorType == GARD_Func))
        {
            // functional records are disabled AND gard record is Functional
            //  - don't process
            HWAS_INF("Functional policy: disabled - skipping GARD Record");
            break;
        }

        GardAddress l_GardAddress(l_pErr);
        if (l_pErr)
        {
            HWAS_ERR("Error from l_GardAddress");
            break;
        }

        // Find an empty GARD Record slot
        GardRecord * l_pRecord = NULL;
        for (uint32_t i = 0; i < iv_maxGardRecords; i++)
        {
            if (iv_pGardRecords[i].iv_recordId == EMPTY_GARD_RECORDID)
            {
                l_pRecord = &(iv_pGardRecords[i]);
                break;
            }
        }

        if (!l_pRecord)
        {
            HWAS_ERR("GARD Record Repository full");

            /*@
             * @errortype
             * @moduleid     HWAS::MOD_DECONFIG_GARD
             * @reasoncode   HWAS::RC_GARD_REPOSITORY_FULL
             * @devdesc      Attempt to create a GARD Record and the GARD
             *               Repository is full
             * @userdata1    HUID of input target // GARD errlog PLID
             */
            const uint64_t userdata1 =
                (static_cast<uint64_t> (TARGETING::get_huid(&i_target)) << 32) |
                i_errlPlid;
            l_pErr = hwasError(
                ERRL_SEV_UNRECOVERABLE,
                HWAS::MOD_DECONFIG_GARD,
                HWAS::RC_GARD_REPOSITORY_FULL,
                userdata1);
            break;
        }

        l_pRecord->iv_recordId = iv_nextGardRecordId++;
        l_pRecord->iv_targetId = i_target.getAttr<TARGETING::ATTR_PHYS_PATH>();
        l_pRecord->iv_errlogPlid = i_errlPlid;
        l_pRecord->iv_errorType = i_errorType;
        l_pRecord->iv_ResourceRecovery = 0;  //Finished by Story 35114 & 62392.
        l_pRecord->iv_padding[0] = 0xff;
        l_pRecord->iv_padding[1] = 0xff;
        l_pRecord->iv_padding[2] = 0xff;
        l_pRecord->iv_padding[3] = 0xff;
        l_pRecord->iv_padding[4] = 0xff;
        l_pRecord->iv_padding[5] = 0xff;

        l_GardAddress.writeRecord((void *)l_pRecord);
    }
    while (0);

    return l_pErr;
}

//******************************************************************************
errlHndl_t DeconfigGard::_clearGardRecords(const uint32_t i_recordId)
{
    errlHndl_t l_pErr = NULL;

    GardAddress l_GardAddress(l_pErr);
    if (!l_pErr)
    {
        if (i_recordId == CLEAR_ALL_GARD_RECORDS)
        {
            HWAS_INF("Clearing all GARD Records");

            // Only clear valid GARD Records to avoid excessive PNOR access
            for (uint32_t i = 0; i < iv_maxGardRecords; i++)
            {
                if (iv_pGardRecords[i].iv_recordId != EMPTY_GARD_RECORDID)
                {
                    // clear iv_recordId
                    iv_pGardRecords[i].iv_recordId = EMPTY_GARD_RECORDID;
                    l_GardAddress.writeRecord(&iv_pGardRecords[i]);
                }
            }
        }
        else
        {
            uint32_t i = 0;
            for (; i < iv_maxGardRecords; i++)
            {
                if (iv_pGardRecords[i].iv_recordId == i_recordId)
                {
                    HWAS_INF("Clearing GARD Record ID 0x%x", i_recordId);
                    // clear iv_recordId
                    iv_pGardRecords[i].iv_recordId = EMPTY_GARD_RECORDID;
                    l_GardAddress.writeRecord(&iv_pGardRecords[i]);
                    break;
                }
            }

            if (i == iv_maxGardRecords)
            {
                HWAS_INF("No GARD Record ID 0x%x to clear", i_recordId);
            }
        }
    }
    else
    {
        HWAS_ERR("Error from l_GardAddress");
    }

    return l_pErr;
}

//******************************************************************************
errlHndl_t DeconfigGard::_clearGardRecords(
    const TARGETING::EntityPath & i_targetId)
{
    errlHndl_t l_pErr = NULL;

    GardAddress l_GardAddress(l_pErr);
    if (!l_pErr)
    {
        bool l_gardRecordsCleared = false;

        for (uint32_t i = 0; i < iv_maxGardRecords; i++)
        {
            if ((iv_pGardRecords[i].iv_recordId != EMPTY_GARD_RECORDID) &&
                (iv_pGardRecords[i].iv_targetId == i_targetId)
               )
            {
                DG_INF_TARGET("Clearing GARD Record for: ", &i_targetId);
                l_gardRecordsCleared = true;
                // clear iv_recordId
                iv_pGardRecords[i].iv_recordId = EMPTY_GARD_RECORDID;
                l_GardAddress.writeRecord(&iv_pGardRecords[i]);
            }
        }

        if (!l_gardRecordsCleared)
        {
            DG_INF_TARGET("No GARD Records to clear for: ", &i_targetId);
        }
    }
    else
    {
        HWAS_ERR("Error from l_GardAddress");
    }

    return l_pErr;
}

//******************************************************************************
errlHndl_t DeconfigGard::_getGardRecords(const uint32_t i_recordId,
                                         GardRecords_t & o_records)
{
    errlHndl_t l_pErr = NULL;
    o_records.clear();

    GardAddress l_GardAddress(l_pErr);
    if (!l_pErr)
    {
        if (i_recordId == GET_ALL_GARD_RECORDS)
        {
            HWAS_DBG("Getting all GARD Records");
            for (uint32_t i = 0; i < iv_maxGardRecords; i++)
            {
                if (iv_pGardRecords[i].iv_recordId != EMPTY_GARD_RECORDID)
                {
                    HWAS_DBG("Getting GARD Record ID 0x%x",
                             iv_pGardRecords[i].iv_recordId);
                    o_records.push_back(iv_pGardRecords[i]);
                }
            }
        }
        else
        {
            for (uint32_t i = 0; i < iv_maxGardRecords; i++)
            {
                if (iv_pGardRecords[i].iv_recordId == i_recordId)
                {
                    HWAS_DBG("Getting GARD Record ID 0x%x", i_recordId);
                    o_records.push_back(iv_pGardRecords[i]);
                    break;
                }
            }
        }
        HWAS_INF("%d GARD Records found", o_records.size());
    }
    else
    {
        HWAS_ERR("Error from l_GardAddress");
    }

    return l_pErr;
}

//******************************************************************************
errlHndl_t DeconfigGard::_getGardRecords(
    const TARGETING::EntityPath & i_targetId,
    GardRecords_t & o_records)
{
    errlHndl_t l_pErr = NULL;
    o_records.clear();

    GardAddress l_GardAddress(l_pErr);
    if (!l_pErr)
    {
        for (uint32_t i = 0; i < iv_maxGardRecords; i++)
        {
            if ((iv_pGardRecords[i].iv_recordId != EMPTY_GARD_RECORDID) &&
                (iv_pGardRecords[i].iv_targetId == i_targetId)
               )
            {
                DG_INF_TARGET("Getting GARD Record for: ", &i_targetId);
                o_records.push_back(iv_pGardRecords[i]);
            }
        }

        if (o_records.empty())
        {
            DG_INF_TARGET("No GARD Records to get for: ", &i_targetId);
        }
    }
    else
    {
        HWAS_ERR("Error from l_GardAddress");
    }

    return l_pErr;
}

//******************************************************************************
void DeconfigGard::_GardRecordIdSetup(uint32_t i_size)
{
    if (iv_maxGardRecords == 0)
    {
        // hasn't been computed yet
        HWAS_INF("GardRecordIdSetup(size=%d)", i_size);

        iv_maxGardRecords = i_size / sizeof(GardRecord);

        // Figure out the next GARD Record ID to use
        uint32_t l_numGardRecords = 0;
        for (uint32_t i = 0; i < iv_maxGardRecords; i++)
        {
            // if this gard record is already fill out:
            if (iv_pGardRecords[i].iv_recordId != EMPTY_GARD_RECORDID)
            {
                // count how many gard records are already defined
                l_numGardRecords++;

                // find the 'last' recordId, so that we can start after it
                if (iv_pGardRecords[i].iv_recordId > iv_nextGardRecordId)
                {
                    iv_nextGardRecordId = iv_pGardRecords[i].iv_recordId;
                }
            }
        } // for

        // next record will start after the highest Id we found
        iv_nextGardRecordId++;

        HWAS_INF("GARD setup. maxRecords %d nextID %d numRecords %d",
                 iv_maxGardRecords, iv_nextGardRecordId, l_numGardRecords);
    }
}


} // namespce HWAS