t '/>
<meta name='robots' content='noindex, nofollow'/>
<link rel='stylesheet' type='text/css' href='/cgit-data/cgit.css'/>
<link rel='shortcut icon' href='/favicon.ico'/>
<link rel='alternate' title='Atom feed' href='http://git.automotivelinux.org/src/xds/xds-docs/atom/docs/part-2/4_xds-gdb.md?h=trout/19.90.0' type='application/atom+xml'/>
<link rel='vcs-git' href='https://git.automotivelinux.org/src/xds/xds-docs' title='xds/xds-docs Git repository'/>
<link rel='vcs-git' href='https://gerrit.automotivelinux.org/gerrit/src/xds/xds-docs' title='xds/xds-docs Git repository'/>
</head>
<body>
<div id="lfcollabprojects-header">
<div class="gray-diagonal">
<div class="header-inner">
<a
id="lfcollabprojects-logo"
href="http://collabprojects.linuxfoundation.org"
>Linux Foundation Collaborative Projects</a
>
</div>
</div>
</div>
<div id='cgit'><table id='header'>
<tr>
<td class='logo' rowspan='2'><a href='/'><img src='/cgit-data/cgit.png' alt='cgit logo'/></a></td>
<td class='main'><a href='/'>index</a> : <a title='xds/xds-docs' href='/src/xds/xds-docs/'>xds/xds-docs</a></td><td class='form'><form method='get'>
<input type='hidden' name='id' value='9eaad307338b5b4f1344bc7dd6e304c6da09d5f6'/><select name='h' onchange='this.form.submit();'>
<option value='flounder'>flounder</option>
<option value='guppy'>guppy</option>
<option value='halibut'>halibut</option>
<option value='icefish'>icefish</option>
<option value='jellyfish'>jellyfish</option>
<option value='koi'>koi</option>
<option value='lamprey'>lamprey</option>
<option value='marlin'>marlin</option>
<option value='master'>master</option>
<option value='needlefish'>needlefish</option>
<option value='octopus'>octopus</option>
<option value='pike'>pike</option>
<option value='quillback'>quillback</option>
<option value='ricefish'>ricefish</option>
<option value='salmon'>salmon</option>
<option value='sandbox/claneys/helloworld-updated'>sandbox/claneys/helloworld-updated</option>
<option value='sandbox/sebd/next-doc'>sandbox/sebd/next-doc</option>
</select> <input type='submit' value='switch'/></form></td></tr>
<tr><td class='sub'>XDS Documentation</td><td class='sub right'>Grokmirror user</td></tr></table>
<table class='tabs'><tr><td>
<a href='/src/xds/xds-docs/about/?h=trout/19.90.0'>about</a><a href='/src/xds/xds-docs/?h=trout/19.90.0'>summary</a><a href='/src/xds/xds-docs/refs/?h=trout/19.90.0&id=9eaad307338b5b4f1344bc7dd6e304c6da09d5f6'>refs</a><a href='/src/xds/xds-docs/log/docs/part-2/4_xds-gdb.md?h=trout/19.90.0'>log</a><a class='active' href='/src/xds/xds-docs/tree/docs/part-2/4_xds-gdb.md?h=trout/19.90.0&id=9eaad307338b5b4f1344bc7dd6e304c6da09d5f6'>tree</a><a href='/src/xds/xds-docs/commit/docs/part-2/4_xds-gdb.md?h=trout/19.90.0&id=9eaad307338b5b4f1344bc7dd6e304c6da09d5f6'>commit</a><a href='/src/xds/xds-docs/diff/docs/part-2/4_xds-gdb.md?h=trout/19.90.0&id=9eaad307338b5b4f1344bc7dd6e304c6da09d5f6'>diff</a><a href='/src/xds/xds-docs/stats/docs/part-2/4_xds-gdb.md?h=trout/19.90.0'>stats</a></td><td class='form'><form class='right' method='get' action='/src/xds/xds-docs/log/docs/part-2/4_xds-gdb.md'>
<input type='hidden' name='h' value='trout/19.90.0'/><input type='hidden' name='id' value='9eaad307338b5b4f1344bc7dd6e304c6da09d5f6'/><select name='qt'>
<option value='grep'>log msg</option>
<option value='author'>author</option>
<option value='committer'>committer</option>
<option value='range'>range</option>
</select>
<input class='txt' type='search' size='10' name='q' value=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/src/xds/xds-docs/tree/?h=trout/19.90.0&id=9eaad307338b5b4f1344bc7dd6e304c6da09d5f6'>root</a>/<a href='/src/xds/xds-docs/tree/docs?h=trout/19.90.0&id=9eaad307338b5b4f1344bc7dd6e304c6da09d5f6'>docs</a>/<a href='/src/xds/xds-docs/tree/docs/part-2?h=trout/19.90.0&id=9eaad307338b5b4f1344bc7dd6e304c6da09d5f6'>part-2</a>/<a href='/src/xds/xds-docs/tree/docs/part-2/4_xds-gdb.md?h=trout/19.90.0&id=9eaad307338b5b4f1344bc7dd6e304c6da09d5f6'>4_xds-gdb.md</a></div><div class='content'>blob: 529dc51c366a1995126fdafd6b0827b4d69e25b5 (<a href='/src/xds/xds-docs/plain/docs/part-2/4_xds-gdb.md?h=trout/19.90.0&id=9eaad307338b5b4f1344bc7dd6e304c6da09d5f6'>plain</a>)
<table summary='blob content' class='blob'>
<tr><td class='linenumbers'><pre><a id='n1' href='#n1'>1</a>
<a id='n2' href='#n2'>2</a>
<a id='n3' href='#n3'>3</a>
<a id='n4' href='#n4'>4</a>
<a id='n5' href='#n5'>5</a>
<a id='n6' href='#n6'>6</a>
<a id='n7' href='#n7'>7</a>
<a id='n8' href='#n8'>8</a>
<a id='n9' href='#n9'>9</a>
<a id='n10' href='#n10'>10</a>
<a id='n11' href='#n11'>11</a>
<a id='n12' href='#n12'>12</a>
<a id='n13' href='#n13'>13</a>
<a id='n14' href='#n14'>14</a>
<a id='n15' href='#n15'>15</a>
<a id='n16' href='#n16'>16</a>
<a id='n17' href='#n17'>17</a>
<a id='n18' href='#n18'>18</a>
<a id='n19' href='#n19'>19</a>
<a id='n20' href='#n20'>20</a>
<a id='n21' href='#n21'>21</a>
<a id='n22' href='#n22'>22</a>
<a id='n23' href='#n23'>23</a>
<a id='n24' href='#n24'>24</a>
<a id='n25' href='#n25'>25</a>
<a id='n26' href='#n26'>26</a>
<a id='n27' href='#n27'>27</a>
<a id='n28' href='#n28'>28</a>
<a id='n29' href='#n29'>29</a>
<a id='n30' href='#n30'>30</a>
<a id='n31' href='#n31'>31</a>
<a id='n32' href='#n32'>32</a>
<a id='n33' href='#n33'>33</a>
<a id='n34' href='#n34'>34</a>
<a id='n35' href='#n35'>35</a>
<a id='n36' href='#n36'>36</a>
<a id='n37' href='#n37'>37</a>
<a id='n38' href='#n38'>38</a>
<a id='n39' href='#n39'>39</a>
<a id='n40' href='#n40'>40</a>
<a id='n41' href='#n41'>41</a>
<a id='n42' href='#n42'>42</a>
<a id='n43' href='#n43'>43</a>
<a id='n44' href='#n44'>44</a>
<a id='n45' href='#n45'>45</a>
<a id='n46' href='#n46'>46</a>
<a id='n47' href='#n47'>47</a>
<a id='n48' href='#n48'>48</a>
<a id='n49' href='#n49'>49</a>
<a id='n50' href='#n50'>50</a>
<a id='n51' href='#n51'>51</a>
<a id='n52' href='#n52'>52</a>
<a id='n53' href='#n53'>53</a>
<a id='n54' href='#n54'>54</a>
<a id='n55' href='#n55'>55</a>
<a id='n56' href='#n56'>56</a>
<a id='n57' href='#n57'>57</a>
<a id='n58' href='#n58'>58</a>
<a id='n59' href='#n59'>59</a>
<a id='n60' href='#n60'>60</a>
<a id='n61' href='#n61'>61</a>
<a id='n62' href='#n62'>62</a>
<a id='n63' href='#n63'>63</a>
<a id='n64' href='#n64'>64</a>
<a id='n65' href='#n65'>65</a>
<a id='n66' href='#n66'>66</a>
<a id='n67' href='#n67'>67</a>
<a id='n68' href='#n68'>68</a>
<a id='n69' href='#n69'>69</a>
<a id='n70' href='#n70'>70</a>
<a id='n71' href='#n71'>71</a>
<a id='n72' href='#n72'>72</a>
<a id='n73' href='#n73'>73</a>
<a id='n74' href='#n74'>74</a>
<a id='n75' href='#n75'>75</a>
<a id='n76' href='#n76'>76</a>
<a id='n77' href='#n77'>77</a>
<a id='n78' href='#n78'>78</a>
<a id='n79' href='#n79'>79</a>
<a id='n80' href='#n80'>80</a>
<a id='n81' href='#n81'>81</a>
<a id='n82' href='#n82'>82</a>
<a id='n83' href='#n83'>83</a>
<a id='n84' href='#n84'>84</a>
<a id='n85' href='#n85'>85</a>
<a id='n86' href='#n86'>86</a>
<a id='n87' href='#n87'>87</a>
<a id='n88' href='#n88'>88</a>
<a id='n89' href='#n89'>89</a>
<a id='n90' href='#n90'>90</a>
<a id='n91' href='#n91'>91</a>
<a id='n92' href='#n92'>92</a>
<a id='n93' href='#n93'>93</a>
<a id='n94' href='#n94'>94</a>
<a id='n95' href='#n95'>95</a>
<a id='n96' href='#n96'>96</a>
<a id='n97' href='#n97'>97</a>
<a id='n98' href='#n98'>98</a>
<a id='n99' href='#n99'>99</a>
<a id='n100' href='#n100'>100</a>
<a id='n101' href='#n101'>101</a>
<a id='n102' href='#n102'>102</a>
<a id='n103' href='#n103'>103</a>
<a id='n104' href='#n104'>104</a>
<a id='n105' href='#n105'>105</a>
<a id='n106' href='#n106'>106</a>
<a id='n107' href='#n107'>107</a>
<a id='n108' href='#n108'>108</a>
<a id='n109' href='#n109'>109</a>
<a id='n110' href='#n110'>110</a>
<a id='n111' href='#n111'>111</a>
<a id='n112' href='#n112'>112</a>
<a id='n113' href='#n113'>113</a>
<a id='n114' href='#n114'>114</a>
<a id='n115' href='#n115'>115</a>
<a id='n116' href='#n116'>116</a>
<a id='n117' href='#n117'>117</a>
</pre></td>
<td class='lines'><pre><code><style>.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */</style><div class="highlight"><pre><span></span><span class="gh">#</span> xds-gdb: wrapper on gdb for XDS
<span class="sb">`xds-gdb`</span> is a wrapper on gdb debugger for X(cross) Development System.
This tool allows you to debug an application built with an xds-server without
the need to install gdb or any cross tool.
Two debugging models are supported:
<span class="k">1.</span> native debugging
<span class="k">1.</span> XDS remote debugging requiring an XDS server and allowing cross debug your
application.
By default XDS remote debug is used and you need to define <span class="sb">`XDS_NATIVE_GDB`</span>
variable to use native gdb debug mode instead.
<span class="k">> </span><span class="ge">**SEE ALSO**: [xds-server](https://github.com/iotbzh/xds-server), a web server</span>
used to remotely cross build applications.
<span class="k">> </span><span class="ge">**SEE ALSO**: [xds-exec](https://github.com/iotbzh/xds-exec),</span>
wrappers on <span class="sb">`exec`</span> command that allows to cross build your application through <span class="sb">`xds-server`</span>.
<span class="gu">##</span> Configuration
<span class="sb">`xds-gdb`</span> configuration is defined by variables (see listed below).
These variables may be set using :
<span class="k">-</span> environment variables (inherited),
<span class="k">-</span> or a config file set with <span class="sb">`XDS_CONFIG`</span> environment variable, for example:
<span class="sb">`XDS_CONFIG=/tmp/my_xds_gdb_config.env xds-gdb`</span>
<span class="k">-</span> or by setting variables within a gdb ini file (see details below),
<span class="k">-</span> or a "user" config file located in following directory (first found is taken):
<span class="k">1.</span> $(CURRENT_DIRECTORY)/.xds-gdb.env
<span class="k">1.</span> $(CURRENT_DIRECTORY)/../xds-gdb.env
<span class="k">1.</span> $(CURRENT_DIRECTORY)/target/xds-gdb.env
<span class="k">1.</span> $(HOME)/.config/xds/xds-gdb.env
<span class="gu">###</span> Configuration Variables
<span class="sb">`XDS_CONFIG`</span> :
Config file defining <span class="sb">`XDS_xxx`</span> configuration variables. Variables of this file
will overwrite inherited environment variables. Variables definition may be
prefixed or not by "export" keyword.
Here is an example of config file
<span class="s">```bash</span>
cat <span class="nv">$HOME</span>/myProject/xds-gdb.env
<span class="nb">export</span> <span class="nv">XDS_SERVER_URL</span><span class="o">=</span>http://xds-docker:8000
<span class="nb">export</span> <span class="nv">XDS_PROJECT_ID</span><span class="o">=</span>IW7B4EE-DBY4Z74_myProject
<span class="nb">export</span> <span class="nv">XDS_SDK_ID</span><span class="o">=</span>poky-agl_aarch64_4.0.1
<span class="s">```</span>
<span class="sb">`XDS_LOGLEVEL`</span>
Set logging level (supported levels: panic, fatal, error, warn, info, debug)
<span class="sb">`XDS_LOGFILE`</span>
Set logging file, default <span class="sb">`/tmp/xds-gdb.log`</span>.
<span class="sb">`XDS_NATIVE_GDB`</span>
Use native gdb mode instead of remote XDS server mode.
<span class="sb">`XDS_PROJECT_ID`</span> <span class="ge">*(mandatory with XDS server mode)*</span>
Project ID you want to build
<span class="sb">`XDS_RPATH`</span>
Relative path into project
<span class="sb">`XDS_SDK_ID`</span> <span class="ge">*(mandatory with XDS server mode)*</span>
Cross Sdk ID to use to build project
<span class="sb">`XDS_SERVER_URL`</span> <span class="ge">*(mandatory with XDS server mode)*</span>
Remote XDS server url
<span class="gu">###</span> Configuration variables set within gdb init command file
Above <span class="sb">`XDS_xxx`</span> variables may also be defined within gdb init command file
(see --command or -x option of genuine Gdb).
You must respect the following syntax: commented line including <span class="sb">`:XDS-ENV:`</span> tag
Example of gdb init file where we define project and sdk ID:
<span class="s">```bash</span>
<span class="c1"># :XDS-ENV: XDS_PROJECT_ID=IW7B4EE-DBY4Z74_myProject</span>
<span class="c1"># :XDS-ENV: XDS_SDK_ID=poky-agl_aarch64_4.0.1</span>
<span class="s">```</span>
<span class="gu">##</span> How to build xds-gdb from scratch
<span class="gu">###</span> Prerequisites
You must install and setup [<span class="nt">Go</span>](<span class="na">https://golang.org/doc/install</span>) version 1.7 or
higher to compile this tool.
<span class="gu">###</span> Building
Clone this repo into your <span class="sb">`$GOPATH/src/github.com/iotbzh`</span> and use delivered Makefile:
<span class="s">```bash</span>
<span class="nb">export</span> <span class="nv">GOPATH</span><span class="o">=</span><span class="k">$(</span>realpath ~/workspace_go<span class="k">)</span>
mkdir -p <span class="nv">$GOPATH</span>/src/github.com/iotbzh
<span class="nb">cd</span> <span class="nv">$GOPATH</span>/src/github.com/iotbzh
git clone https://github.com/iotbzh/xds-gdb.git
<span class="nb">cd</span> xds-gdb
make
<span class="s">```</span>
<span class="gu">##</span> Debug
Visual Studio Code launcher settings can be found into <span class="sb">`.vscode/launch.json`</span>.
</pre></div>
</code></pre></td></tr></table>
</div> <!-- class=content -->
<div id="lfcollabprojects-footer">
<div class="gray-diagonal">
<div class="footer-inner">
<p>Copyright © 2015 The Linux Foundation. All rights reserved.</p>
<p>
Linux Foundation, Linux Standard Base, LSB, LSB Certified, IAccessible2,
MeeGo are registered trademarks of the Linux Foundation.
</p>
<p>
Linux is a registered
<a href="http://www.linuxfoundation.org/programs/legal/trademark"
>trademark</a
>
of Linus Torvalds. Please see our
<a href="https://www.linuxfoundation.org/privacy">privacy policy</a>.
</p>
</div>
</div>
</div>
</div> <!-- id=cgit -->
</body>
</html>