TipsAndTricks/DebuggingBitbakeInWingIDE - Revision history

Tim Orling: /* Debug Core Bitbake or a Bitbake Tool */ Fix image link for Remote Debug

2017-07-26T20:29:51Z

Debug Core Bitbake or a Bitbake Tool: Fix image link for Remote Debug

← Older revision		Revision as of 20:29, 26 July 2017
Line 8:		Line 8:
	=== Debug Core Bitbake or a Bitbake Tool ===		=== Debug Core Bitbake or a Bitbake Tool ===
	This details how to configure the WingIDE Personal debugger to debug core bitbake (e.g. bitbake/lib/bb/main.py) or a particular tool (e.g. poky/scripts/oe-check-sstate). This is useful if you are trying to understand the program flow or look at some variables w/out adding a bunch of logger.warn(;;;) statements.		This details how to configure the WingIDE Personal debugger to debug core bitbake (e.g. bitbake/lib/bb/main.py) or a particular tool (e.g. poky/scripts/oe-check-sstate). This is useful if you are trying to understand the program flow or look at some variables w/out adding a bunch of logger.warn(;;;) statements.
	* Turn on the Debuggers ability to accept incoming connections . Edit->Preferences->External/Remote. All I did was accept the defaults and hit the checkbox to turn it on.<br>[File:WingRemoteDebugOn.png\|x200px]]		* Turn on the Debuggers ability to accept incoming connections . Edit->Preferences->External/Remote. All I did was accept the defaults and hit the checkbox to turn it on.<br>[[File:WingRemoteDebugOn.png\|x200px]]
	* make a new project		* make a new project
	* set the interpreter to be python3 -><br>		* set the interpreter to be python3 -><br>
Line 23:		Line 23:
	[[File:WingSetBP-step-tinfoil.png \|x200px]]		[[File:WingSetBP-step-tinfoil.png \|x200px]]
	* You can put bp in any other non meta-data file. You can also start bitbake/bin/bitbake this way and hit the breakpoints...		* You can put bp in any other non meta-data file. You can also start bitbake/bin/bitbake this way and hit the breakpoints...

	=== Debug Bitbake Metadata ===		=== Debug Bitbake Metadata ===
	Because the metadata is interpreted as part of bitbake parsing/execution, we need to approach this differently. The below steps worked for me. There may be a better way if someone has more knowledge of the Wing Remote Debug interface. Sometimes, I just want to be able to break in a metadata file and see what is happening and what the state is.		Because the metadata is interpreted as part of bitbake parsing/execution, we need to approach this differently. The below steps worked for me. There may be a better way if someone has more knowledge of the Wing Remote Debug interface. Sometimes, I just want to be able to break in a metadata file and see what is happening and what the state is.

Bavery at 22:47, 10 March 2017

2017-03-10T22:47:17Z

← Older revision		Revision as of 22:47, 10 March 2017
Line 57:		Line 57:
	BB_NUMBER_PARSE_THREADS="1"		BB_NUMBER_PARSE_THREADS="1"
	</code>		</code>
	*** If you go back to debugging bitbake and it is really slow, check to see if you have commented out the above limitations since bb parses VERY slowly with only one thread.		* If you go back to debugging bitbake and it is really slow, check to see if you have commented out the above limitations since bb parses VERY slowly with only one thread.

Bavery at 22:46, 10 March 2017

2017-03-10T22:46:55Z

← Older revision		Revision as of 22:46, 10 March 2017
Line 57:		Line 57:
	BB_NUMBER_PARSE_THREADS="1"		BB_NUMBER_PARSE_THREADS="1"
	</code>		</code>
			*** If you go back to debugging bitbake and it is really slow, check to see if you have commented out the above limitations since bb parses VERY slowly with only one thread.

Bavery at 22:31, 10 March 2017

2017-03-10T22:31:28Z

← Older revision		Revision as of 22:31, 10 March 2017
Line 42:		Line 42:
	After the line <code> EXTRA_OECONF = "--disable-nls" </code>		After the line <code> EXTRA_OECONF = "--disable-nls" </code>
	* Note the line <strong><code> import wingdbstub </code></strong>		* Note the line <strong><code> import wingdbstub </code></strong>
			** this file should be copied from where the Wing IDE install put it (on ubuntu /usr/lib/wingide-personal6) to bitbake/lib. This is so that all the bitbake meta files can easily find it.
			** this file tells how to talk to the Wing IDE debugger.
			* Now you can pull up files like native.bbclass and quilt-native.inc and put breakpoints in them.
			* Here's an example of breaking in native.bbclass:<br>
			[[File:WingBreakNativeMetadata.png\|x200px]]
			** <strong>Caveats:</strong>
			*** You MUST start bitbake from the command line as normal, with your WingIDE up and running.
			*** You will MISS breakoints that are happening in other threads while you are stopped in a particular bp. For instance, if we had breakpoints in quilt-native.inc and in cmake_3.7.2.bb you will probably miss one of them while broke on the other one. For this reason, if you are debugging more than one metadata file at a time, you may need to set the following in your local.conf:
			<code>
			# FOR Happier WING debugger
			# single threaded parsing and building.
			# parallel makes are fine...
			BB_NUMBER_THREADS="1"
			BB_NUMBER_PARSE_THREADS="1"
			</code>

Bavery at 22:15, 10 March 2017

2017-03-10T22:15:03Z

← Older revision		Revision as of 22:15, 10 March 2017
Line 38:		Line 38:
	print("\nCOWZ IN QUILT_NATIVE.INC\n")		print("\nCOWZ IN QUILT_NATIVE.INC\n")
	print("\n VERSION=",sys.version,"\n")		print("\n VERSION=",sys.version,"\n")
	}		}
	</code>		</code>
	After the line <code> EXTRA_OECONF = "--disable-nls" </code>		After the line <code> EXTRA_OECONF = "--disable-nls" </code>
			* Note the line <strong><code> import wingdbstub </code></strong>

Bavery at 22:13, 10 March 2017

2017-03-10T22:13:34Z

← Older revision		Revision as of 22:13, 10 March 2017
Line 22:		Line 22:
	* and you can step into tinfoil.py which is in bitbake/lib/bb! <br>		* and you can step into tinfoil.py which is in bitbake/lib/bb! <br>
	[[File:WingSetBP-step-tinfoil.png \|x200px]]		[[File:WingSetBP-step-tinfoil.png \|x200px]]
			* You can put bp in any other non meta-data file. You can also start bitbake/bin/bitbake this way and hit the breakpoints...
			=== Debug Bitbake Metadata ===
			Because the metadata is interpreted as part of bitbake parsing/execution, we need to approach this differently. The below steps worked for me. There may be a better way if someone has more knowledge of the Wing Remote Debug interface. Sometimes, I just want to be able to break in a metadata file and see what is happening and what the state is.
			* Make a new project
			* First, set up everything as before with respect to the remote debugger, python interpreter, and project properties.
			* add the poky/meta directory
			* We will bring up the meta/classes/native.bbclass and the poky/meta/recipes-devtools/quilt/quilt-native.inc
			** Like we did in the pudb example, we will add some python to the quilt-native.inc file as an example. Add :
			<code>
			python () {
			import sys
			import wingdbstub
			i=5
			for j in range(i):
			print("\nCOWZ IN QUILT_NATIVE.INC\n")
			print("\n VERSION=",sys.version,"\n")
			}
			</code>
			After the line <code> EXTRA_OECONF = "--disable-nls" </code>

Bavery at 22:04, 10 March 2017

2017-03-10T22:04:01Z

← Older revision		Revision as of 22:04, 10 March 2017
Line 19:		Line 19:
	** If Wing doesn't recognize a file as python, you can right click on the file and set the type via File Properties.		** If Wing doesn't recognize a file as python, you can right click on the file and set the type via File Properties.
	* Then you will hit the bp in oe-check-sstate. <br>		* Then you will hit the bp in oe-check-sstate. <br>
	[[File: \|200xpx]]		[[File:WingSetBP-check-sstate.png \|200xpx]]
	* and you can step into tinfoil.py which is in bitbake/lib/bb! <br>		* and you can step into tinfoil.py which is in bitbake/lib/bb! <br>
	[[File: \|x200px]]		[[File:WingSetBP-step-tinfoil.png \|x200px]]

Bavery at 22:01, 10 March 2017

2017-03-10T22:01:49Z

← Older revision		Revision as of 22:01, 10 March 2017
Line 15:		Line 15:
	* Now you need to help the Source Parser know about the bb libs. Add bitbake/libs and poky/script/libs into the Python Path the IDE knows about. Select Project Properties and add those to the PYTHONPATH. <br> [[File:WingAddBBLibs.png\|x200px]]		* Now you need to help the Source Parser know about the bb libs. Add bitbake/libs and poky/script/libs into the Python Path the IDE knows about. Select Project Properties and add those to the PYTHONPATH. <br> [[File:WingAddBBLibs.png\|x200px]]
	* You also need to tell the debugger to start in the build directory. By default, it will start in the directory the file you are debugging is in. e.g. bitbake/bin.<br> [[File:WingSetBuilddir.png\|x200px]]		* You also need to tell the debugger to start in the build directory. By default, it will start in the directory the file you are debugging is in. e.g. bitbake/bin.<br> [[File:WingSetBuilddir.png\|x200px]]
	* Then you can pull up files ~~like main.py~~ and add a breakpoint.		* Then you can pull up files and add a breakpoint. In this example I put a bp in oe-check-sstate itself.
	* Bring up ~~bitbake~~ from the ~~bitbake~~/~~bin~~ and right click to say "Debug this file". This will bring up a dialog box and you can type in the target. For example ~~quilt~~-native.		* Bring up oe-check-sstate from the poky/scripts and right click to say "Debug this file". This will bring up a dialog box and you can type in the target. For example autoconf-native.
	** If Wing doesn't recognize a file as python, you can right click on the file and set the type via File Properties.		** If Wing doesn't recognize a file as python, you can right click on the file and set the type via File Properties.
			* Then you will hit the bp in oe-check-sstate. <br>
			[[File: \|200xpx]]
			* and you can step into tinfoil.py which is in bitbake/lib/bb! <br>
			[[File: \|x200px]]

Bavery at 21:53, 10 March 2017

2017-03-10T21:53:09Z

← Older revision		Revision as of 21:53, 10 March 2017
Line 8:		Line 8:
	=== Debug Core Bitbake or a Bitbake Tool ===		=== Debug Core Bitbake or a Bitbake Tool ===
	This details how to configure the WingIDE Personal debugger to debug core bitbake (e.g. bitbake/lib/bb/main.py) or a particular tool (e.g. poky/scripts/oe-check-sstate). This is useful if you are trying to understand the program flow or look at some variables w/out adding a bunch of logger.warn(;;;) statements.		This details how to configure the WingIDE Personal debugger to debug core bitbake (e.g. bitbake/lib/bb/main.py) or a particular tool (e.g. poky/scripts/oe-check-sstate). This is useful if you are trying to understand the program flow or look at some variables w/out adding a bunch of logger.warn(;;;) statements.
			* Turn on the Debuggers ability to accept incoming connections . Edit->Preferences->External/Remote. All I did was accept the defaults and hit the checkbox to turn it on.<br>[File:WingRemoteDebugOn.png\|x200px]]
	* make a new project		* make a new project
	* set the interpreter to be python3 -><br>		* set the interpreter to be python3 -><br>
Line 13:		Line 14:
	* add the bitbake/bin bitbake/lib and scripts/lib to the project. Right click in the are to the right where the tab says project and select Add Directory.... <br>[[File:WingAddBB.png\|x200px]]		* add the bitbake/bin bitbake/lib and scripts/lib to the project. Right click in the are to the right where the tab says project and select Add Directory.... <br>[[File:WingAddBB.png\|x200px]]
	* Now you need to help the Source Parser know about the bb libs. Add bitbake/libs and poky/script/libs into the Python Path the IDE knows about. Select Project Properties and add those to the PYTHONPATH. <br> [[File:WingAddBBLibs.png\|x200px]]		* Now you need to help the Source Parser know about the bb libs. Add bitbake/libs and poky/script/libs into the Python Path the IDE knows about. Select Project Properties and add those to the PYTHONPATH. <br> [[File:WingAddBBLibs.png\|x200px]]
	* Then you can pull up files like main.py and add a breakpoint. If you ~~pull a~~ file ~~into~~ the		* You also need to tell the debugger to start in the build directory. By default, it will start in the directory the file you are debugging is in. e.g. bitbake/bin.<br> [[File:WingSetBuilddir.png\|x200px]]
			* Then you can pull up files like main.py and add a breakpoint.
			* Bring up bitbake from the bitbake/bin and right click to say "Debug this file". This will bring up a dialog box and you can type in the target. For example quilt-native.
			** If Wing doesn't recognize a file as python, you can right click on the file and set the type via File Properties.

Bavery at 21:46, 10 March 2017

2017-03-10T21:46:30Z

← Older revision		Revision as of 21:46, 10 March 2017
Line 11:		Line 11:
	* set the interpreter to be python3 -><br>		* set the interpreter to be python3 -><br>
	[[File:WingProjectPython.png\|x200px]]		[[File:WingProjectPython.png\|x200px]]
	* add the bitbake/bin bitbake/lib and scripts/lib to the project. Right click in the are to the right where the tab says project. <br>[[File:WingAddBB.png\|x200px]]		* add the bitbake/bin bitbake/lib and scripts/lib to the project. Right click in the are to the right where the tab says project and select Add Directory.... <br>[[File:WingAddBB.png\|x200px]]
			* Now you need to help the Source Parser know about the bb libs. Add bitbake/libs and poky/script/libs into the Python Path the IDE knows about. Select Project Properties and add those to the PYTHONPATH. <br> [[File:WingAddBBLibs.png\|x200px]]
			* Then you can pull up files like main.py and add a breakpoint. If you pull a file into the