Heap Peek - Revision history

Dnatt: formatting

2025-09-28T01:24:33Z

formatting

← Older revision		Revision as of 01:24, 28 September 2025
Line 12:		Line 12:
	** (LabVIEW 2025 Q1 and earlier) Press '''Ctrl + Shift + D + H'''.		** (LabVIEW 2025 Q1 and earlier) Press '''Ctrl + Shift + D + H'''.
	** (LabVIEW 2025 Q3 and later) Press '''Ctrl + Shift + : + H''' ''(that's a colon).''		** (LabVIEW 2025 Q3 and later) Press '''Ctrl + Shift + : + H''' ''(that's a colon).''
	** On Mac, use the ''Cmd'' key instead of ''Ctrl''~~. This will open the Heap Peek window~~.		** On Mac, use the ''Cmd'' key instead of ''Ctrl''.

	== Using Heap Peek ==		== Using Heap Peek ==

Dnatt: formatting

2025-09-28T01:24:08Z

formatting

← Older revision		Revision as of 01:24, 28 September 2025
Line 1:		Line 1:
	Heap Peek is a debug feature available at least since [[LabVIEW 3.0]]. It allows to view internal data structures created for all loaded VI files, including Front Panel Heap and Block Diagram Heap.		Heap Peek is a debug feature available at least since [[LabVIEW 3.0]]. It allows to view internal data structures created for all loaded VI files, including Front Panel Heap and Block Diagram Heap. The feature is intended for use by LV R&D, though users may in some cases be instructed by LV Support to check something there.
	The feature is intended for use by LV R&D, though users may in some cases be instructed by LV Support to check something there.

	== Enabling Heap Peek ==		== Enabling Heap Peek ==
Line 10:		Line 9:
	Then, to launch the Heap Peek window:		Then, to launch the Heap Peek window:
	* Open your VI		* Open your VI
	* (LabVIEW 2025 Q1 and earlier) Press '''Ctrl + Shift + D + H'''. (LabVIEW 2025 Q3 and later) Press '''Ctrl + Shift + : + H''' ''(that's a colon).'' On Mac, use the ''Cmd'' key instead of ''Ctrl''. This will open the Heap Peek window.		* Press one of the following key combinations, depending on your situation:
			** (LabVIEW 2025 Q1 and earlier) Press '''Ctrl + Shift + D + H'''.
			** (LabVIEW 2025 Q3 and later) Press '''Ctrl + Shift + : + H''' ''(that's a colon).''
			** On Mac, use the ''Cmd'' key instead of ''Ctrl''. This will open the Heap Peek window.

	== Using Heap Peek ==		== Using Heap Peek ==

Dnatt: Added new Heap Peak shortcut info for LabVIEW 2025 Q3 and later.

2025-09-28T01:21:54Z

Added new Heap Peak shortcut info for LabVIEW 2025 Q3 and later.

← Older revision		Revision as of 01:21, 28 September 2025
Line 8:		Line 8:
	* Put the key "LVdebugKeys=True" in your [[LabVIEW configuration file]]		* Put the key "LVdebugKeys=True" in your [[LabVIEW configuration file]]

	Then, to ~~trigger~~ the Heap Peek window:		Then, to launch the Heap Peek window:
	* Open your VI		* Open your VI
	* Press ~~CTRL~~+~~SHIFT~~+D+H. On Mac, use the ~~command~~ key instead of ~~CTRL~~. This will open the Heap Peek window.		* (LabVIEW 2025 Q1 and earlier) Press '''Ctrl + Shift + D + H'''. (LabVIEW 2025 Q3 and later) Press '''Ctrl + Shift + : + H''' ''(that's a colon).'' On Mac, use the ''Cmd'' key instead of ''Ctrl''. This will open the Heap Peek window.

	== Using Heap Peek ==		== Using Heap Peek ==

Crossrulz: Added image of the Heap Peak window

2024-09-25T17:18:33Z

Added image of the Heap Peak window

← Older revision		Revision as of 17:18, 25 September 2024
Line 13:		Line 13:

	== Using Heap Peek ==		== Using Heap Peek ==
			[[File:HeapPeak.png]]

	The window is divided into 5 sections:		The window is divided into 5 sections:

Flarn2006: /* Heap View */ Made "exporting a few to XML" a link

2022-01-30T05:53:02Z

Heap View: Made "exporting a few to XML" a link

← Older revision		Revision as of 05:53, 30 January 2022
Line 42:		Line 42:
	The view for ''FPHP'' reveals that controls and indicators are composed of several [[Control Parts\|parts]] - ie. Numeric controls consist of: Label, Frame, Up/Down buttons, Edit field, Radix and Annex. Each [[Control_Parts#List_of_parts\|part has partID]], which is used by LV to identify type of that part.		The view for ''FPHP'' reveals that controls and indicators are composed of several [[Control Parts\|parts]] - ie. Numeric controls consist of: Label, Frame, Up/Down buttons, Edit field, Radix and Annex. Each [[Control_Parts#List_of_parts\|part has partID]], which is used by LV to identify type of that part.

	'''Note:''' To learn more about LV Heaps, consider exporting a few to XML, and looking at them there. The flat list visible in ''Heap View'' will be very helpful when you understand them, but it's not the best way to acquire that understanding.		'''Note:''' To learn more about LV Heaps, consider [[Heap storage format\|exporting a few to XML]], and looking at them there. The flat list visible in ''Heap View'' will be very helpful when you understand them, but it's not the best way to acquire that understanding.

	== Structure selection ==		== Structure selection ==

Flarn2006: /* Toolbar */ Added function of "uo" button, corrected capitalization

2022-01-30T05:45:32Z

Toolbar: Added function of "uo" button, corrected capitalization

← Older revision		Revision as of 05:45, 30 January 2022
Line 73:		Line 73:
	* Next/prev buttons		* Next/prev buttons
	* Currently selected item name text		* Currently selected item name text
	* U button		* '''U''' button
	* F button - Click on it to find the object selected in Heap View. LabVIEW will switch to the block diagram or front panel and select related object.		* '''F''' button - Click on it to find the object selected in Heap View. LabVIEW will switch to the block diagram or front panel and select related object.
	* UO button		* '''uo''' button - Toggles between sorting the list on the right by UID (the default) or by memory address.

	'''Note:''' A previous author said that few developers really know the capacities of heap peek. This is true... it's a debugging tool, and it gets hacked up to debug whatever anyone needs to debug.		'''Note:''' A previous author said that few developers really know the capacities of heap peek. This is true... it's a debugging tool, and it gets hacked up to debug whatever anyone needs to debug.

Flarn2006: /* Using Heap Peek */

2022-01-27T21:01:44Z

Using Heap Peek

← Older revision		Revision as of 21:01, 27 January 2022
Line 24:		Line 24:
	When the heap is selected, you can display many details on it by clicking rows of either top-right or middle section. These details will show at base, in Information pane.		When the heap is selected, you can display many details on it by clicking rows of either top-right or middle section. These details will show at base, in Information pane.

	'''Note:''' Heap Peek does not have any ability to change the objects. It is display information ~~only~~.		'''Note:''' Heap Peek only displays information and does not have any ability to change the objects. It does, however, display the locations in memory where the information is stored, which makes it easy to use external memory editing software for this purpose.

	== Loaded Container Files list ==		== Loaded Container Files list ==

Mefistotelis: data space explained on different page

2020-06-10T18:47:08Z

data space explained on different page

← Older revision		Revision as of 18:47, 10 June 2020
Line 64:		Line 64:
	=== DS Fields ===		=== DS Fields ===

	~~'''~~Data Space~~'''~~ in an important concept in LV internals. In short, Data Space contains filling for all type mapped ~~data types. And in more detail:~~		[[Data Space]] in an important concept in LV internals. In short, ''Data Space'' contains filling for all type mapped [[data type]]s. Be sure to read more on [[Data Space]] to understand it better.
	* Like in all languages, you can define [[~~Data~~ type~~\|data types~~]] ~~in LabVIEW. You don't need any action to define integer, it'~~s ~~trivial~~. ~~But compound types, like Clusters and Arrays - these you need~~ to ~~define.~~
	* LV stores all [[Data ~~type\|data types]] used within a [[VI~~]] ~~in form of [[Type descriptor\|Type Descriptors]] ('''TD'''s). There is a table of these in every VI file.~~
	* When an instance of data type is required - real variable needs to be created - the '''TD''' is added to '''Type Map'''. Type Map is just another table, which maps TDs into Data Space. That '''Type Map Entry''' is a confirmation that there is an area reserved in Data Space for the variable, and it ~~also points to the specific place where data starts.~~
	* Data Space is a continuous block of memory, which consists only of data. Reading Data Space requires information of what is stored where - so Type Map Entries are required to give meaning to the binary values stored in Data Space.

	The ''DS Fields'' section contains some general information on Data Space of the file, and then displays whole mapping of the Data Space (''DSTM''). As of LV2014 it doesn't show values stored in data space, but it shows offsets within said Data Space, and Type Map Entries ('''TME'''s) with information about which data type is stored there, with all its properties. The ''DSTM'' data in this section is cut to only show part of Data Space which is used for different purposes than Heap - the complete Data Space is always larger.		The ''DS Fields'' section contains some general information on [[Data Space]] of the file, and then displays whole mapping of the Data Space (''DSTM''). As of LV2014 it doesn't show values stored in data space, but it shows offsets within said Data Space, and Type Map Entries ('''TME'''s) with information about which data type is stored there, with all its properties. The ''DSTM'' data in this section is cut to only show part of Data Space which is used for different purposes than Heap - the complete Data Space is always larger.

	Some of the types stored in Data Space are not linked directly to user created code, and are LV internal data instead. For example, the data space always contains a block of 51 integer values - these are settings internal to LabVIEW, called ''DSInit''. It also contains a list of [[DCO]]s - objects which contain selected properties of controls and indicators from [[Front Panel]], and are retained even when FP is removed form VI file.

	== Toolbar ==		== Toolbar ==

Mefistotelis: refs, typo

2020-06-10T16:01:30Z

refs, typo

← Older revision		Revision as of 16:01, 10 June 2020
Line 65:		Line 65:

	'''Data Space''' in an important concept in LV internals. In short, Data Space contains filling for all type mapped data types. And in more detail:		'''Data Space''' in an important concept in LV internals. In short, Data Space contains filling for all type mapped data types. And in more detail:
	* Like in all languages, you can define data types in LabVIEW. You don't need any action to define integer, it's trivial. But compound types, like Clusters and Arrays - these you need to define.		* Like in all languages, you can define [[Data type\|data types]] in LabVIEW. You don't need any action to define integer, it's trivial. But compound types, like Clusters and Arrays - these you need to define.
	* LV stores all data types used within a VI in form of [[Type descriptor\|Type Descriptors]] ('''TD'''s). There is a table of these in every VI file.		* LV stores all [[Data type\|data types]] used within a [[VI]] in form of [[Type descriptor\|Type Descriptors]] ('''TD'''s). There is a table of these in every VI file.
	* When an instance of data type is required - real variable needs to be created - the '''TD''' is added to '''Type Map'''. Type Map is just another table, which maps TDs into Data Space. That '''Type Map Entry''' is a confirmation that there is an area reserved in Data Space for the variable, and it also points to the specific place where data starts.		* When an instance of data type is required - real variable needs to be created - the '''TD''' is added to '''Type Map'''. Type Map is just another table, which maps TDs into Data Space. That '''Type Map Entry''' is a confirmation that there is an area reserved in Data Space for the variable, and it also points to the specific place where data starts.
	* Data Space is a continuous block of memory, which consists only of data. Reading Data Space requires information of what is stored where - so Type Map Entries are required to give meaning to the binary values stored in Data Space.		* Data Space is a continuous block of memory, which consists only of data. Reading Data Space requires information of what is stored where - so Type Map Entries are required to give meaning to the binary values stored in Data Space.

	The ''DS Fields'' section contains some general information on Data Space of the file, and then displays whole mapping of the Data Space (''DSTM''). As of LV2014 is doesn't show values stored in data space, but it shows offsets within said Data Space, and Type Map Entries ('''TME'''s) with information about which data type is stored there, with all its properties. The ''DSTM'' data in this section is cut to only show part of Data Space which is used for different purposes than Heap - the complete Data Space is always larger.		The ''DS Fields'' section contains some general information on Data Space of the file, and then displays whole mapping of the Data Space (''DSTM''). As of LV2014 it doesn't show values stored in data space, but it shows offsets within said Data Space, and Type Map Entries ('''TME'''s) with information about which data type is stored there, with all its properties. The ''DSTM'' data in this section is cut to only show part of Data Space which is used for different purposes than Heap - the complete Data Space is always larger.

	Some of the types stored in Data Space are not linked directly to user created code, and are LV internal data instead. For example, the data space always contains a block of 51 integer values - these are settings internal to LabVIEW, called DSInit. It also contains a list of ~~'''~~DCO~~'''~~s - objects which contain selected properties of controls and indicators from Front Panel, and are retained even when FP is removed form VI file.		Some of the types stored in Data Space are not linked directly to user created code, and are LV internal data instead. For example, the data space always contains a block of 51 integer values - these are settings internal to LabVIEW, called ''DSInit''. It also contains a list of [[DCO]]s - objects which contain selected properties of controls and indicators from [[Front Panel]], and are retained even when FP is removed form VI file.

	== Toolbar ==		== Toolbar ==

Mefistotelis: category

2020-06-05T15:39:29Z

← Older revision		Revision as of 15:39, 5 June 2020
Line 84:		Line 84:

	'''Note:''' A previous author said that few developers really know the capacities of heap peek. This is true... it's a debugging tool, and it gets hacked up to debug whatever anyone needs to debug.		'''Note:''' A previous author said that few developers really know the capacities of heap peek. This is true... it's a debugging tool, and it gets hacked up to debug whatever anyone needs to debug.

			[[Category:LabVIEW internals]]
			[[Category:Debugging]]