[IDE] Debug Adapter Protocol

1. 调试器(debugger)

编程语言是用debugger调试的,
有些debugger可以用来调试多种编程语言,例如,GDB
它支持Assembly,C,C++,Go,Rust,等等。

有些编程语言有自己的debugger,例如,Haskell的GHCi
有些debugger集成到了IDE中,例如,DrRacket中。

因为无法用平凡的办法证明程序没有错误,所以能对程序进行调试还是很必要的,

Programs don’t become more reliable as they are debugged; the bugs just get harder to find.
—— Cynic’s First Law of Debugging

2. 编辑器扩展

编辑器为了能对特定的编程语言进行调试,需要增加编写扩展,
例如,Emacs可以使用python-mode,调用pdb调试python代码。
内部都是调用了相应编程语言的debugger,调试功能也大同小异。

一般而言,不同的编辑器需要单独编写自己的调试模块或者扩展,
并且,同一个编辑器中,不同编程语言的调试模块也是不同的,如下图。


这样不论对编辑器开发者而言,还是对语言供应商而言,都是一个灾难。

3. DAP

介于此,微软提出了Debug Adapter Protocol
各编辑器通过相同的协议与debugger通信。

可是,让现有的debugger满足这个协议是非常困难的,因此,还需要增加一层,
就是为各个debugger编写适配器(Debug Adapter),整体架构如下图。


不同的编辑器通过统一的DAP(Debug Adapter Protocol)协议与各个debugger对应的适配器(Debug Adapter)通信,
这样大大降低了开发难度,创造了一个双赢局面。

The Debug Adapter Protocol is a win for both debugger/runtime providers and tooling vendors!

4. 工作原理

调试过程总共涉及了三个角色,
编辑器(Editor,IDE),调试适配器(Debug Adapter),调试器(debuger)(包括被调试对象(debuggee))。

(1)调试会话(debug session)
调试过程是通过会话(session)来完成的,会话指的是编辑器与调试适配器(Debug Adapter)之间的交互过程。
它们之间通过DAP(Debug Adapter Protocol)通信。

总共有两种会话模式,single session mode 和 multi session mode。
前者调试适配器(Debug Adapter)进程是由编辑器启动的,通过标准输入输出进行交互,调试结束后,该进程会被终止。
后者,编辑器会假定调试适配器(Debug Adapter)已经启动了,然后通过唯一端口号与调试适配器(Debug Adapter)建立连接。
编辑器终止会话,只是与调试适配器(Debug Adapter)断开连接。

(2)初始化
DAP(Debug Adapter Protocol)定义了很多调试特性,并且这个特性列表还在不断增加,
为了避免使用版本号进行区分,为了兼容性考虑,
编辑器和调试适配器(Debug Adapter)之间,在初始化时,要互相通信,
借此让编辑器了解,调试适配器(Debug Adapter)支持哪些调试特性,这些特性合集称为能力(capabilities)。

(3)调试方式
调试配置器(Debug Adapter)有两种方式启动调试,launch 和 attach。

attach方式,调试适配器(Debug Adapter)会通过调试器(debugger)与一个已经在运行的程序建立连接,
用户可以启动和终止这个程序。

launch方式,由调试适配器(Debug Adapter)启动被调试的程序,通过调试器(debugger)与之建立连接,
被调试程序的启动和终止都是由调试适配器(Debug Adapter)负责的。

(4)设置断点
断点以及异常相关的配置,是在程序启动之前由编辑器传递给调试适配器(Debug Adapter)的,
因为不同的调试器(debugger)对于何时使用断点信息有不同的原则,
一些调试器(debugger)要提前知道断点信息,有些则不用。

因此,编辑器会在启动调试之前,先把断点信息传递给调试适配器(Debug Adapter)。


(5)调用栈信息与局部变量
调试适配器(Debug Adapter)会在断点处,向调试器(debugger)发送停止信号,
程序停止后,编辑器会再通过调试适配器(Debug Adapter)请求获取调用栈信息(stacktrace)。

在调试过程中,通常用户还需要查看局部变量的值,
编辑器会再次发送请求,通过调试适配器(Debug Adapter)获取所有的局部变量名以及它们的值。


参考

DAP: Overview
VSCode: Debugger Extension
Debug Adapter Protocol
GDB
Haskell: GHCi
Python: pdb
Python Programming In Emacs

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,053评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,527评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,779评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,685评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,699评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,609评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,989评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,654评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,890评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,634评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,716评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,394评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,976评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,950评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,191评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,849评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,458评论 2 342