Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/airportyh/time-traveling-debugger

A attempt to implement a viable record/replay debugger.
https://github.com/airportyh/time-traveling-debugger

Last synced: about 2 months ago
JSON representation

A attempt to implement a viable record/replay debugger.

Awesome Lists containing this project

README 

        
# Time Traveling Debugger



This project is an attempt to build a usable, practical, useful and viable

time-travel debugger.



A time-traveling debugger works by recording the each state in the

execution of a program into a database - we call that the history file - 

and then allowing the programmer to navigate through this file to 

investigate the cause of bugs.



## Subprojects



* [Python Rewind](https://github.com/airportyh/cpython) - a modified version of Python (fork) that generates a log file as a program is executed. That log contains info that is needed to recreate the past

states of the program.

* [recreate](./recreate) - a C-based program (replacement for recreate.py) that reads the log file created by Python Rewind and generates the history of the program in a

SQLite-based history file.

* [timenav](./timenav) - a Python-based terminal UI debugger based on the SQLite-based history file. It also aims to be a use case for the debugger

itself as the debugger will be developed with the help of the debugger itself - a case of

dog-fooding.

* [Oui](./timenav/oui) - a terminal UI toolkit in Python

* [history-api](./history-api) (deprecated) - a Node.js/Express-based REST API endpoint which returns a program's past states based on its SQLite-based history file. Debugger frontends are driven

off this API.

* [term-debugger](./term-debugger) (deprecated) - a terminal-based step debugger frontend written in Node.js

and EcmaScript modules.

* [zoom-debugger](./zoom-debugger)(deprecated)  - a HTML5 Canvas-based ZUI debugger frontend written in TypeScript with Webpack as the bundler.

* [json-like](./json-like) (deprecated) - a parser for a JSON-like data format with features specific to

the time-traveling debugger, written in JavaScript.

* [play-lang](./play-lang) (deprecated) - a small programming language with built-in time-travel support.

A program executed written in Play automatically generates a SQLite-based history file.

* [rrui](./rrui) (deprecated) - a wrapper debugger around rr

* [det-replay](./det-replay) - a simple demonstrate of deterministic replay



## Setup



This section is for developers who want to test out or modify the code.

This has only been tested on OSX and Linux, apologies to Windows users. If you are on an unsupported

platform and is interested in testing this out, let us know by submitting an issue.



1. Clone this repo and cd into the project directory.

2. `. add-path` - this will add the project's `bin` directory to your path.

3. Get Python Rewind via git submodule: `get-python`

4. Build Python Rewind:

    * `cd cpython`

    * `./configure`

    * `./make`

5. Now the command line tools below should be available.



## Command-Line Tools



Once setup is complete, you are provided with a set of command-line tools:



1. `pyrewind` - used exactly like the `python` command, it invokes the modified version

of Python with time-travel support if used with `.py` files. When you execute a `.py` file,

a log file with the `.rewind` suffix is created. For example: `pyrewind fib.py` will generate

a file called `fib.rewind`. Time-travel support is turned off when `pyrewind` is used as a 

REPL or used to execute a built-in module.

2. `recreate` - this program takes a `.rewind` file as input and generates a SQLite-based

history file as output with the `.sqlite` suffix. For example: `recreate fib.rewind` will

create a SQLite database called `fib.sqlite`. This database file can in turn by used to

debug the originating program using one of the debugger frontends.

3. `debug` - starts the terminal-based step debugger. This command takes a `.rewind` log file or a history file as input. For example: `debug fib.sqlite` or `debug fib.rewind`. 

If the input is a `.rewind` log file, it will call the `recreate` command to convert it to

a `.sqlite` file before launching the debugger. This debugger has a ncurses-style GUI 

and is controlled using one-stroke keyboard commands similar less and nano. 

It also supports mouse and scroll-wheel interactions for terminals that support it.

4. `zoom` - starts the zoom debugger (deprecated). This command also takes a history file as input. For

example: `zoom fib.sqlite`. Running this command spawns a browser window within which

the HTML5 canvas-based debugger executes.



## Videos about the Time Traveling Debugger



I have been documenting work on the time-traveling debugger in video format. You can find all the videos

in [this playlist](https://tobyho.com/video-series/Time-Traveling-Debugger.html). Notable videos are:



* [Time Travel Debugging (in Python)](https://www.youtube.com/watch?v=HlndMuAguEk)

* [Dream of the Time Machine](https://www.youtube.com/watch?v=xwhm7g9GjuY)

* [Introducing the Deep-Zoom Debugger (5 minutes)](https://www.youtube.com/watch?v=QE54x1ahHa4)

* [Deep Zoom Debugger Demo with Huiqi](https://www.youtube.com/watch?v=lVb9bt7wDy8)

* [How Time-Traveling Works](https://www.youtube.com/watch?v=u6HR_bQfzDE)

* [Time Traveling Debugger for Python](https://www.youtube.com/watch?v=h80C9zzyf7k)

* [rr and Record Replay Debuggers](https://www.youtube.com/watch?v=cCf7hiZvJrY)



## Dependencies



This project is dependent on the following technologies:



* Node.js / Express

* Python 3

* SQLite

* better-sqlite3

* Nearley.js / Moo.js

* TypeScript

* HTML5 Canvas

* Webpack

* gcc / automake



## Other Projects, Products and Papers on Time Travel Debugging



* [Replay.io](https://replay.io/) - time-travel debugger for JavaScript webapps based on Firefox. [[Talk](https://www.youtube.com/watch?v=rDq1AN1kSn4)], [[Reading](https://trac.webkit.org/wiki/WebReplayMechanics)].

* [rr](https://rr-project.org/) - time-travel debugger for C and C++. [[Talk](https://www.youtube.com/watch?v=H4iNuufAe_8)], [[Paper](https://arxiv.org/pdf/1705.05937.pdf)].

* [Timelapse](https://github.com/burg/replay-staging) - a time-travel debugger for JavaScript webapps based on Safari. [[Video](https://www.youtube.com/watch?v=ugHAzyQ6H00)], [[Reading](https://trac.webkit.org/wiki/WebReplayMechanics)], [[Paper](https://homes.cs.washington.edu/~mernst/pubs/record-replay-uist2013.pdf)].

* [ozcode](https://oz-code.com/) - a replay debugger for .NET

* [ODB (Omniscient Debugger)](https://github.com/OmniscientDebugger/LewisOmniscientDebugger) - an omniscient debugger for Java. [[Talk](https://youtu.be/xpI8hIgOyko)], [[Paper](https://arxiv.org/abs/cs/0310016)].

* [Arnold](https://github.com/endplay/omniplay) an eidetic Linux-based system. [[Paper](https://www.cc.gatech.edu/~ddevecsery6/papers/devecsery14.pdf)]

* [Paper: A Review of Reverse Debugging](http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.338.3420)

* [Sayid](https://github.com/clojure-emacs/sayid) - Omniscient debugger for Clojure. [[Video](https://youtu.be/ipDhvd1NsmE)].

* [Time Traveling in Microsoft WinDBG (Windows Debugger)](https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/time-travel-debugging-overview). [[Video](https://channel9.msdn.com/Shows/Defrag-Tools/Defrag-Tools-185-Time-Travel-Debugging-Introduction)], [[Talk](https://www.youtube.com/watch?v=l1YJTg_A914)].

* Time Traveling Debugger in Microsoft's Chakra JS Engine. [[Talk](https://channel9.msdn.com/blogs/Marron/Time-Travel-Debugging-for-JavaScriptHTML)], [[Docs](https://github.com/nodejs/node-chakracore/blob/master/TTD-README.md)].

* [Paper: Repeatable Reverse Engineering for the Greater Good with PANDA](https://www.ll.mit.edu/sites/default/files/publication/doc/2018-04/2014_10_01_Dolan-Gavitt_B_TechReport_FP.pdf)