Added long 'print-values' option for var-update MI command.

[ki.stfu]

Summary

The -var-update MI command should take the same print-values options as var-list children, however currently only the integer versions are supported.
Added --no-values, --all-values, and --simple-values long options.

See:
https://sourceware.org/gdb/onlinedocs/gdb/GDB_002fMI-Variable-Objects.html#GDB_002fMI-Variable-Objects

Patch from [e-mail]

[ki.stfu]

See my comments.

lldb/tools/lldb-mi/MICmdCmdVar.cpp

339–341 ↗

(On Diff #21010)

I think it should be pArgNoValues/pArgAllValues/pArgSimpleValues (aka --no-value*s*/--all-value*s*/--simple-value*s*)

343–357 ↗

(On Diff #21010)

Use the following:

CMICmnLLDBDebugSessionInfo::VariableInfoFormat_e eVarInfoFormat;
if (pArgPrintValues->GetFound())
{
    const MIuint nPrintValues = pArgPrintValues->GetValue();
    if (nPrintValues >= CMICmnLLDBDebugSessionInfo::kNumVariableInfoFormats)
    {
        SetError(CMIUtilString::Format(MIRSRC(IDS_CMD_ERR_INVALID_PRINT_VALUES), m_cmdData.strMiCmd.c_str()));
        return MIstatus::failure;
    }
    eVarInfoFormat = static_cast<CMICmnLLDBDebugSessionInfo::VariableInfoFormat_e>(nPrintValues);
}
else if (pArgNoValues->GetFound())
    eVarInfoFormat = CMICmnLLDBDebugSessionInfo::eVariableInfoFormat_NoValues;
else if (pArgAllValues->GetFound())
    eVarInfoFormat = CMICmnLLDBDebugSessionInfo::eVariableInfoFormat_AllValues;
else if (pArgSimpleValues->GetFound())
    eVarInfoFormat = CMICmnLLDBDebugSessionInfo::eVariableInfoFormat_SimpleValues;
else
    // If no print-values, default is "no-values"
    eVarInfoFormat = CMICmnLLDBDebugSessionInfo::eVariableInfoFormat_NoValues;
m_eVarInfoFormat = eVarInfoFormat;

532 ↗

(On Diff #21010)

why you are ignoring --simple-value?
In addition you should do the same thing in CMICmdCmdVarUpdate::MIFormResponse.

[EwanCrawford]

Thanks for the comments ki.stfu.

My understanding of MIFormResponse() is that it is only called from CMICmdCmdVarUpdate::Execute() when there are composite types, in which case we wouldn't print the values for --simple-values. So we only need to check for --all-values and can ignore --simple-values.
Should MIFormResponse() ever need to print values for --simple-value?

I'll add a check --simple-value to CMICmdCmdVarUpdate::Acknowledge() though, to print values for when m_bValueChangedNormalType is set.

lldb/tools/lldb-mi/MICmdCmdVar.cpp

339–341 ↗

(On Diff #21010)

Will do

343–357 ↗

(On Diff #21010)

no problem

[EwanCrawford]

Updated patch with suggested changes

[ki.stfu]

lgtm

[EwanCrawford]

Thanks Ilia. I don't have commit access, would you mind committing?

[ki.stfu]

fix diff path

tools/lldb-mi/MICmdCmdVar.h

class CMICmdCmdVarUpdate : public CMICmdBase
   private:
     bool ExamineSBValueForChange(const CMICmnLLDBDebugSessionInfoVarObj &vrVarObj, const bool vbIgnoreVarType, bool &vrwbChanged);
     bool MIFormResponse(const CMIUtilString &vrStrVarName, const CMIUtilString &vrStrValue, const CMIUtilString &vrStrScope);
 
     // Attribute:
   private:
     CMIUtilString m_strValueName;
     CMICmnLLDBDebugSessionInfo::VariableInfoFormat_e m_eVarInfoFormat;
-    const CMIUtilString m_constStrArgPrintValues; // Not handled by *this command
+    const CMIUtilString m_constStrArgPrintValues;
     const CMIUtilString m_constStrArgName;
+    const CMIUtilString m_constStrArgNoValues;
+    const CMIUtilString m_constStrArgAllValues;
+    const CMIUtilString m_constStrArgSimpleValues;
     bool m_bValueChangedArrayType;     // True = yes value changed, false = no change
     bool m_bValueChangedCompositeType; // True = yes value changed, false = no change
     bool m_bValueChangedNormalType;    // True = yes value changed, false = no change
     CMICmnMIValueList m_miValueList;
 };
 
 //++ ============================================================================
 // Details: MI command class. MI commands derived from the command base class.

tools/lldb-mi/MICmdCmdVar.cpp

 // Args:    None.
 // Return:  None.
 // Throws:  None.
 //--
 CMICmdCmdVarUpdate::CMICmdCmdVarUpdate(void)
     : m_eVarInfoFormat(CMICmnLLDBDebugSessionInfo::eVariableInfoFormat_NoValues)
     , m_constStrArgPrintValues("print-values")
     , m_constStrArgName("name")
+    , m_constStrArgNoValues("no-values")
+    , m_constStrArgAllValues("all-values")
+    , m_constStrArgSimpleValues("simple-values")
     , m_bValueChangedArrayType(false)
     , m_bValueChangedCompositeType(false)
     , m_bValueChangedNormalType(false)
     , m_miValueList(true)
 {
     // Command factory matches this name with that received from the stdin stream
     m_strMiCmd = "var-update";
 

 // Return:  MIstatus::success - Functional succeeded.
 //          MIstatus::failure - Functional failed.
 // Throws:  None.
 //--
 bool
 CMICmdCmdVarUpdate::ParseArgs(void)
 {
     bool bOk = m_setCmdArgs.Add(*(new CMICmdArgValNumber(m_constStrArgPrintValues, false, true)));
+    bOk = bOk && m_setCmdArgs.Add(*(new CMICmdArgValOptionLong(m_constStrArgNoValues, false, true)));
+    bOk = bOk && m_setCmdArgs.Add(*(new CMICmdArgValOptionLong(m_constStrArgAllValues, false, true)));
+    bOk = bOk && m_setCmdArgs.Add(*(new CMICmdArgValOptionLong(m_constStrArgSimpleValues, false, true)));
     bOk = bOk && m_setCmdArgs.Add(*(new CMICmdArgValString(m_constStrArgName, true, true)));
     return (bOk && ParseValidateCmdOptions());
 }
 
 //++ ------------------------------------------------------------------------------------
 // Details: The invoker requires this function. The command does work in this function.
 //          The command is likely to communicate with the LLDB SBDebugger in here.
 // Type:    Overridden.
 // Args:    None.
 // Return:  MIstatus::success - Functional succeeded.
 //          MIstatus::failure - Functional failed.
 // Throws:  None.
 //--
 bool
 CMICmdCmdVarUpdate::Execute(void)
 {
     CMICMDBASE_GETOPTION(pArgPrintValues, Number, m_constStrArgPrintValues);
     CMICMDBASE_GETOPTION(pArgName, String, m_constStrArgName);
+    CMICMDBASE_GETOPTION(pArgNoValues, OptionLong, m_constStrArgNoValues);
+    CMICMDBASE_GETOPTION(pArgAllValues, OptionLong, m_constStrArgAllValues);
+    CMICMDBASE_GETOPTION(pArgSimpleValues, OptionLong, m_constStrArgSimpleValues);
 
-    const CMIUtilString &rVarObjName(pArgName->GetValue());
-    CMICmnLLDBDebugSessionInfoVarObj varObj;
-    if (!CMICmnLLDBDebugSessionInfoVarObj::VarObjGet(rVarObjName, varObj))
+    CMICmnLLDBDebugSessionInfo::VariableInfoFormat_e eVarInfoFormat;
+    if (pArgPrintValues->GetFound())
     {
-        SetError(CMIUtilString::Format(MIRSRC(IDS_CMD_ERR_VARIABLE_DOESNOTEXIST), m_cmdData.strMiCmd.c_str(), rVarObjName.c_str()));
-        return MIstatus::failure;
-    }
-
         const MIuint nPrintValues = pArgPrintValues->GetValue();
         if (nPrintValues >= CMICmnLLDBDebugSessionInfo::kNumVariableInfoFormats)
         {
             SetError(CMIUtilString::Format(MIRSRC(IDS_CMD_ERR_INVALID_PRINT_VALUES), m_cmdData.strMiCmd.c_str()));
             return MIstatus::failure;
         }
-    m_eVarInfoFormat = static_cast<CMICmnLLDBDebugSessionInfo::VariableInfoFormat_e>(nPrintValues);
+        eVarInfoFormat = static_cast<CMICmnLLDBDebugSessionInfo::VariableInfoFormat_e>(nPrintValues);
+    }
+    else if (pArgNoValues->GetFound())
+        eVarInfoFormat = CMICmnLLDBDebugSessionInfo::eVariableInfoFormat_NoValues;
+    else if (pArgAllValues->GetFound())
+        eVarInfoFormat = CMICmnLLDBDebugSessionInfo::eVariableInfoFormat_AllValues;
+    else if (pArgSimpleValues->GetFound())
+        eVarInfoFormat = CMICmnLLDBDebugSessionInfo::eVariableInfoFormat_SimpleValues;
+    else
+        // If no print-values, default is "no-values"
+        eVarInfoFormat = CMICmnLLDBDebugSessionInfo::eVariableInfoFormat_NoValues;
+    m_eVarInfoFormat = eVarInfoFormat;
+
+    const CMIUtilString &rVarObjName(pArgName->GetValue());
+    CMICmnLLDBDebugSessionInfoVarObj varObj;
+    if (!CMICmnLLDBDebugSessionInfoVarObj::VarObjGet(rVarObjName, varObj))
+    {
+        SetError(CMIUtilString::Format(MIRSRC(IDS_CMD_ERR_VARIABLE_DOESNOTEXIST), m_cmdData.strMiCmd.c_str(), rVarObjName.c_str()));
+        return MIstatus::failure;
+    }
 
     const CMIUtilString &rVarRealName(varObj.GetNameReal());
     MIunused(rVarRealName);
     lldb::SBValue &rValue = const_cast<lldb::SBValue &>(varObj.GetValue());
     const bool bValid = rValue.IsValid();
     if (bValid && rValue.GetValueDidChange())
     {
         m_bValueChangedNormalType = true;
if (m_bValueChangedArrayType || m_bValueChangedNormalType)
         const bool bValid = rValue.IsValid();
         const CMIUtilString strValue(bValid ? varObj.GetValueFormatted() : "<unknown>");
         const CMIUtilString strInScope((bValid && rValue.IsInScope()) ? "true" : "false");
 
         // MI print "%s^done,changelist=[{name=\"%s\",value=\"%s\",in_scope=\"%s\",type_changed=\"false\",has_more=\"0\"}]"
         const CMICmnMIValueConst miValueConst(m_strValueName);
         CMICmnMIValueResult miValueResult("name", miValueConst);
         CMICmnMIValueTuple miValueTuple(miValueResult);
-        if (m_eVarInfoFormat != CMICmnLLDBDebugSessionInfo::eVariableInfoFormat_NoValues)
+        if (m_eVarInfoFormat == CMICmnLLDBDebugSessionInfo::eVariableInfoFormat_AllValues ||
+           (m_eVarInfoFormat == CMICmnLLDBDebugSessionInfo::eVariableInfoFormat_SimpleValues
+           && m_bValueChangedNormalType))
         {
             const CMICmnMIValueConst miValueConst2(strValue);
             CMICmnMIValueResult miValueResult2("value", miValueConst2);
             miValueTuple.Add(miValueResult2);
         }
         const CMICmnMIValueConst miValueConst3(strInScope);
         CMICmnMIValueResult miValueResult3("in_scope", miValueConst3);
         miValueTuple.Add(miValueResult3);

 bool
 CMICmdCmdVarUpdate::MIFormResponse(const CMIUtilString &vrStrVarName, const CMIUtilString &vrStrValue, const CMIUtilString &vrStrScope)
 {
     // MI print "[{name=\"%s\",value=\"%s\",in_scope=\"%s\",type_changed=\"false\",has_more=\"0\"}]"
     const CMICmnMIValueConst miValueConst(vrStrVarName);
     CMICmnMIValueResult miValueResult("name", miValueConst);
     CMICmnMIValueTuple miValueTuple(miValueResult);
     const CMICmnMIValueConst miValueConst2(vrStrValue);
+    bool bOk = true;
+    if(m_eVarInfoFormat == CMICmnLLDBDebugSessionInfo::eVariableInfoFormat_AllValues)
+    {
       CMICmnMIValueResult miValueResult2("value", miValueConst2);
-    bool bOk = miValueTuple.Add(miValueResult2);
+      bOk = bOk && miValueTuple.Add(miValueResult2);
+    }
     const CMICmnMIValueConst miValueConst3(vrStrScope);
     CMICmnMIValueResult miValueResult3("in_scope", miValueConst3);
     bOk = bOk && miValueTuple.Add(miValueResult3);
     const CMICmnMIValueConst miValueConst4("false");
     CMICmnMIValueResult miValueResult4("type_changed", miValueConst4);
     bOk = bOk && miValueTuple.Add(miValueResult4);
     const CMICmnMIValueConst miValueConst5("0");
     CMICmnMIValueResult miValueResult5("has_more", miValueConst5);

tools/lldb-mi/MICmnResources.cpp

const CMICmnResources::SRsrcTextData CMICmnResources::ms_pResourceId2TextData[] = {
     {IDS_CMD_ERR_CMD_RUN_BUT_NO_ACTION, "<Error: Command run but command did not do anything useful. No MI response formed>"},
     {IDS_CMD_ERR_EVENT_HANDLED_BUT_NO_ACTION, "<Error: Command run and event caught, did nothing useful. No MI Out-of-Bound formed>"},
     {IDS_CMD_ERR_DISASM_ADDR_START_INVALID, "Command '%s'. Invalid start value '%s'"},
     {IDS_CMD_ERR_DISASM_ADDR_END_INVALID, "Command '%s'. Invalid end value '%s'"},
     {IDS_CMD_ERR_MEMORY_ALLOC_FAILURE, "Command '%s'. Failed to allocate memory %d bytes"},
     {IDS_CMD_ERR_LLDB_ERR_NOT_READ_WHOLE_BLK, "Command '%s'. LLDB unable to read entire memory block of %u bytes at address 0x%08x"},
     {IDS_CMD_ERR_LLDB_ERR_READ_MEM_BYTES, "Command '%s'. Unable to read memory block of %u bytes at address 0x%08x: %s "},
     {IDS_CMD_ERR_INVALID_PROCESS, "Command '%s'. Invalid process during debug session"},
-    {IDS_CMD_ERR_INVALID_PRINT_VALUES, "Command '%s'. Unknown value for PRINT_VALUES: must be: 0 or \"--no-values\", 1 or \"all-values\", 2 or \"simple-values\""},
+    {IDS_CMD_ERR_INVALID_PRINT_VALUES, "Command '%s'. Unknown value for PRINT_VALUES: must be: 0 or \"--no-values\", 1 or \"--all-values\", 2 or \"--simple-values\""},
     {IDS_CMD_ERR_INVALID_FORMAT_TYPE, "Command '%s'. Invalid var format type '%s'"},
     {IDS_CMD_ERR_BRKPT_INFO_OBJ_NOT_FOUND, "Command '%s'. Breakpoint information for breakpoint ID %d not found"},
     {IDS_CMD_ERR_LLDB_ERR_READ_MEM_BYTES, "Command '%s'. Unable to write memory block of %u bytes at address 0x%08x: %s "},
     {IDS_CMD_ERR_LLDB_ERR_NOT_WRITE_WHOLEBLK, "Command '%s'. LLDB unable to write entire memory block of %u bytes at address 0x%08x"},
     {IDS_CMD_ERR_SET_NEW_DRIVER_STATE, "Command '%s'. Command tried to set new MI Driver running state and failed. %s"},
     {IDS_CMD_ERR_INFO_PRINTFN_NOT_FOUND, "The request '%s' was not recogised, not implemented"},
     {IDS_CMD_ERR_INFO_PRINTFN_FAILED, "The request '%s' failed."},
     {IDS_CMD_ERR_GDBSET_OPT_SOLIBSEARCHPATH, "'solib-search-path' requires at least one argument"}};