kyle-sylvestre / tug Goto Github PK

View Code? Open in Web Editor NEW

112.0 5.0 8.0 3.6 MB

GDB frontend made with Dear ImGui

License: GNU General Public License v3.0

Makefile 1.19% C++ 96.41% C 2.39%

gdb-frontend debugger gdb

tug's Introduction

Tug

GDB frontend made with Dear ImGui

Tugboat captain is the GDB archer fish mascot https://sourceware.org/gdb/mascot/
Jamie Guinan's original archer fish logo and the vector versions by Andreas Arnez are licensed under CC BY-SA 3.0 US. https://creativecommons.org/licenses/by-sa/3.0/us/

Building the Project

Install gcc, gdb, and make
For X11 based systems, install additional packages
Debian, Ubuntu, Linux Mint: sudo apt-get install xorg-dev
Fedora, RHEL: sudo dnf install libXcursor-devel libXi-devel libXinerama-devel libXrandr-devel
FreeBSD: pkg install xorgproto
Run command "make DEBUG=0", output executable is ./build_release/tug

Debugging an Executable

NOTE: Tug defaults to the gdb filename returned by the command "which gdb"

run program from command line
tug --exe [program to debug filename] --gdb [gdb filename]

run tug
click "Debug" menu button
fill in gdb filename and debug filename, args are optional
click "Start" button

Source Window

CTRL-F: open text search mode, N = next match, SHIFT-N = previous match, ESC to exit
CTRL-G: open goto line window, ENTER to jump to input line, ESC to exit
hover over any word to query its value, right click it to create a new watch within the control window
add/remove breakpoint by clicking the empty column to the left of the line number

Control Window

program execution buttons

"---" = jump to next executed line inside source window
"|>" = start/continue program
"||" = pause program
"-->" = step into
"/\>" = step over
"</\" = step out

GDB Console Command Line

repeat last command on hitting enter on an empty line (GDB emulation)
cycle command history by pressing up/down arrow while clicked on the box
hit tab while typing to see all the autocompletions, hit tab/shift tab to cycle through them

Resources

GDB Machine Interpreter:
https://sourceware.org/gdb/download/onlinedocs/gdb#GDB_002fMI

GLFW:
https://www.glfw.org/download.html
https://www.glfw.org/docs/latest/compile.html

tug's People

Contributors

Stargazers

Watchers

Forkers

zeta1999 hdinc gmh5225 jiaoyongqi c4llv07e huguang6 crackercat aiekick

tug's Issues

make non-stop mode optional

GDB MI Error: The target does not support running in non-stop mode.
seen on FreeBSD and MSYS2

Great work - question

Lovely to see another imgui example and a native GDB GUI. Thanks!

Question: How to build it?

What toolchain do you use to build Tug? Looks like g++ on Windows. Is this correct?

Are there any additional dependencies?

Some more detail. Getting different results running in a VS code terminal (1) and Msys64 (2).

Cannot see how this would build on any Posix system due to different casing in #include <GLFW/glfw3.h> and path/to/Tug/third-party/glfw

where g++
R:\apps\msys64\usr\bin\g++.exe

$ g++ --version
g++ (GCC) 11.2.0
Copyright (C) 2021 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

make -v
GNU Make 4.3
Built for x86_64-pc-msys
Copyright (C) 1988-2020 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

(1) Probably fails due to make inability to expand SRC := $(shell find . -name "*.cpp") correctly.

R:\src\test\Tug>make
File not found - *.cpp
g++ -o tug.elf  -I./third-party -I./src -std=c++11 -g -O0 -Wall -Wformat -Wextra -Wshadow -pedantic -fsanitize=undefined,address  -L./third-party/glfw -lglfw -lGL -lpthread
/usr/lib/gcc/x86_64-pc-msys/11.2.0/../../../../x86_64-pc-msys/bin/ld: cannot find -lglfw
/usr/lib/gcc/x86_64-pc-msys/11.2.0/../../../../x86_64-pc-msys/bin/ld: cannot find -lGL
/usr/lib/gcc/x86_64-pc-msys/11.2.0/../../../../x86_64-pc-msys/bin/ld: cannot find -lasan
/usr/lib/gcc/x86_64-pc-msys/11.2.0/../../../../x86_64-pc-msys/bin/ld: cannot find -lubsan
collect2: error: ld returned 1 exit status
make: *** [Makefile:12: tug.elf] Error 1

(2)

 MSYS /r/src/test/Tug
$ make > log 2>&1
 MSYS /r/src/test/Tug
$ head log
g++ -I./third-party -I./src -std=c++11 -g -O0 -Wall -Wformat -Wextra -Wshadow -pedantic -fsanitize=undefined,address  -L./third-party/glfw -lglfw -lGL -lpthread -c -o src/gdb.o src/gdb.cpp
In file included from src/gdb.cpp:24:
src/common.h: In function ‘String GetAtomString(Span, const Record&)’:
src/common.h:77:92: error: expected unqualified-id before ‘=’ token
   77 |     char __gdb_buf[128]; tsnprintf(__gdb_buf, "gdb --pid %d", (int)getpid()); int __unused = system(__gdb_buf); __unused = __unused; exit(1);\
      |                                                                                            ^
src/common.h:448:5: note: in expansion of macro ‘Assert’
  448 |     Assert(s.index + s.length <= rec.buf.size());
      |     ^~~~~~
src/common.h:77:122: error: expected primary-expression before ‘=’ token

MTIA.

please provide a release version

Hello, and thanks for your effort.

I want to see your package in void repo. but VoidLinux has a policy that every package should have a release version to be able to add.

Can you please provide a release version?