资讯专栏INFORMATION COLUMN

前端魔法堂——调用栈,异常实例中的宝藏

wangjuntytl / 1495人阅读

摘要:前言在上一篇前端魔法堂异常不仅仅是中我们描述出一副异常及如何捕获异常的画像,但仅仅如此而已。调用方从右到左的顺序将参数压入栈中,在被调用方执行完成后,由被调用方负责清理栈中的参数也称为栈平衡。

前言

 在上一篇《前端魔法堂——异常不仅仅是try/catch》中我们描述出一副异常及如何捕获异常的画像,但仅仅如此而已。试想一下,我们穷尽一切捕获异常实例,然后仅仅为告诉用户,运维和开发人员页面报了一个哪个哪个类型的错误吗?答案是否定的。我们的目的是收集刚刚足够的现场证据,好让我们能马上重现问题,快速修复,提供更优质的用户体验。那么问题就落在“收集足够的现场证据”,那么我们又需要哪些现场证据呢?那就是异常信息调用栈栈帧局部状态。(异常信息我们已经获取了)
 本文将围绕上调用栈栈帧局部状态叙述,准开开车^_^

概要

 本篇将叙述如下内容:

什么是调用栈?

如何获取调用栈?

什么是栈帧局部状态?又如何获取呢?

一.什么是调用栈?

 既然我们要获取调用栈信息,那么起码要弄清楚什么是调用栈吧!下面我们分别从两个层次来理解~

印象派

 倘若主要工作内容为应用开发,那么我们对调用栈的印象如下就差不多了:

function funcA (a, b){
  return a + b
}

function funcB (a){
  let b = 3
  return funcA(a, b)
}

function main(){
  let a = 5
  funcB(a)
}

main()

 那么每次调用函数时就会生成一个栈帧,并压入调用栈,栈帧中存储对应函数的局部变量;当该函数执行完成后,其对应的栈帧就会弹出调用栈。
 因此调用main()时,调用栈如下

----------------<--栈顶
|function: main|
|let a = 5     |
|return void(0)|
----------------<--栈底

 调用funcB()时,调用栈如下

----------------<--栈顶
|function:funcB|
|let b = 3     |
|return funcA()|
----------------
|function: main|
|let a = 5     |
|return void(0)|
----------------<--栈底

 调用funcA()时,调用栈如下

----------------<--栈顶
|function:funcA|
|return a + b  |
----------------
|function:funcB|
|let b = 3     |
|return funcA()|
----------------
|function: main|
|let a = 5     |
|return void(0)|
----------------<--栈底

funcA()执行完成后,调用栈如下

----------------<--栈顶
|function:funcB|
|let b = 3     |
|return funcA()|
----------------
|function: main|
|let a = 5     |
|return void(0)|
----------------<--栈底

funcB()执行完成后,调用栈如下

----------------<--栈顶
|function: main|
|let a = 5     |
|return void(0)|
----------------<--栈底

main()执行完成后,调用栈如下

----------------<--栈顶
----------------<--栈底

 现在我们对调用栈有了大概的印象了,但大家有没有留意上面记录"栈帧中存储对应函数的局部变量",栈帧中仅仅存储对应函数的局部变量,那么入参呢?难道会作为局部变量吗?这个我们要从理论的层面才能得到解答呢。

理论派

 这里我们要引入一个简单的C程序,透过其对应的汇编指令来讲解了。我会尽我所能用通俗易懂的语言描述这一切的,若有错误请各位指正!!

前提知识

Intel X86架构中调用栈的栈底位于高位地址,而栈顶位于低位地址。(和印象派中示意图的方向刚好相反)

调用栈涉及的寄存器有

ESP/RSP, 暂存栈顶地址
EBP/RBP, 暂存栈帧起始地址
EIP, 暂存下一个CPU指令的内存地址,当CPU执行完当前指令后,从EIP读取下一条指令的内存地址,然后继续执行

操作指令

PUSH ,将ESP向低位地址移动操作数所需的空间,然后将操作数压入调用栈中
POP ,从调用栈中读取数据暂存到操作数指定的寄存器或内存空间中,然后向高位地址移动操作数对应的空间字节数
MOV ,,数据传送指令。用于将一个数据从源地址传送到目标地址,且不破坏源地址的内容
ADD ,,两数相加不带进位,然后将结果保存到目标地址上
RET,相当于POP EIP。就是从堆栈中出栈,然后将值保存到EIP寄存器中
LEAVE,相当于MOV EBP ESP,然后再POP EBP。就是将栈顶指向当前栈帧地址,然后将调用者的栈帧地址暂存到EBP中

每个函数调用前汇编器都会加入以下前言(Prolog),用于保存栈帧和返回地址

push   %rbp      ;将调用者的栈帧指针压入调用栈
mov    %rsp,%rbp ;现在栈顶指向刚入栈的RBP内容,要将其设置为栈帧的起始位置

 现在们结合实例来理解吧!
C语言

#include 

int add(int a, int b){
  return a + b;
}
int add2(int a){
  int sum = add(0, a);
  return sum + 2;
}

void main(){
  add2(2);
}

然后执行以下命令编译带调试信息的可执行文件,和dump文件

$ gcc -g -o main main.c
$ objdump -d main > main.dump

下面我们截取main、add2和add对应的汇编指令来讲解

main函数对应的汇编指令

0x40050f 
push %rbp 0x400510 mov %rsp,%rbp ;将2暂存到寄存器EDI中 0x400513 mov $0x2,%edi ;执行call指令前,EIP寄存器已经存储下一条指令的地址0x40051d了 ;首先将EIP寄存器的值入栈,当函数返回时用于恢复之前的执行序列 ;然后才是执行JUMP指令跳转到add2函数中开始执行其第一条指令 0x400518 callq 0x4004ea ;什么都不做 0x40051d nop ;设置RBP为指向main函数调用方的栈帧地址 0x40051e pop %rbp ;设置EIP指向main函数返回后将要执行的指令的地址 0x40051f retq

下面是执行add2函数第一条指令前的调用栈快照

+++++++++++++++++ 高位地址
99 |   110    | -- 存放main函数调用方的栈帧地址 <-- EBP
+++++++++++++++++
98 | 0x40051d | -- EIP的值,存放add2返回后将执行的指令的地址 <-- ESP
+++++++++++++++++ 低位地址

add2函数对应的汇编指令

0x4004ea                  push   %rbp
0x4004eb                mov    %rsp,%rbp
0x4004ee                sub    $0x18,%rsp      ;栈顶向低位移动24个字节,为后续操作预留堆栈空间
0x4004f2                mov    %edi,-0x14(%rbp);从EDI寄存器中读取参数,并存放到堆栈空间中
0x4004f5               mov    -0x14(%rbp),%eax;从堆栈空间中读取参数,放进EAX寄存器中
0x4004f8               mov    %eax,%esi       ;从EAX寄存器中读取参数,存放到ESI寄存器中
0x4004fa               mov    $0x0,%edi       ;将0存放到EDI寄存器中
;执行call指令前,EIP寄存器已经存储下一条指令的地址0x400504了
;首先将EIP寄存器的值入栈,当函数返回时用于恢复之前的执行序列
;然后才是执行JUMP指令跳转到add函数中开始执行其第一条指令
0x4004ff               callq  0x4004d6 
0x400504               mov    %eax,-0x4(%rbp) ;读取add的返回值(存储在EAX寄存器中),存放到堆栈空间中
0x400507               mov    -0x4(%rbp),%eax ;又将add的返回值存放到EAX寄存器中(这是有多无聊啊~~)
0x40050a               add    $0x2,%eax       ;读取EAX寄存器的值与2相加,结果存放到EAX寄存器中
0x40050d               leaveq                 ;让栈顶指针指向main函数的栈帧地址,然后让EBP指向main函数的栈帧地址
0x40050e               retq                   ;让EIP指向add2返回后将执行的指令的地址

下面是执行完add2函数中mov %rsp,%rbp的调用栈快照

+++++++++++++++++ 高位地址
99 |    110   | -- 存放main函数调用方的栈帧地址
+++++++++++++++++
98 | 0x40051d | -- 存放EIP的值,add2返回后将执行的指令的地址
+++++++++++++++++
97 |    99    | -- 存放add2函数调用方(即main函数)的栈帧地址<-- ESP,EBP
+++++++++++++++++ 低位地址

下面是执行add函数第一条指令前的调用栈快照

+++++++++++++++++ 高位地址
99 |    110   | -- 存放main函数调用方的栈帧地址
+++++++++++++++++
98 | 0x40051d | -- 存放EIP的值,add2返回后将执行的指令的地址
+++++++++++++++++
97 |    99    | -- 存放add2函数调用方(即main函数)的栈帧地址<-- EBP
+++++++++++++++++
96 |   0xXX   |
+++++++++++++++++
.................
76 |   0x02   | -- 这是`mov %edi,-0x14(%rbp)`的执行结果
+++++++++++++++++
.................
+++++++++++++++++
73 |   0xXX   |
+++++++++++++++++
72 | 0x400504 | -- EIP的值,存放add返回后将执行的指令的地址 <-- ESP
+++++++++++++++++ 低位地址

add函数对应的汇编指令

0x4004d6                   push   %rbp
0x4004d7                 mov    %rsp,%rbp
0x4004da                 mov    %edi,-0x4(%rbp)
0x4004dd                 mov    %esi,-0x8(%rbp)
0x4004e0                mov    -0x4(%rbp),%edx
0x4004e3                mov    -0x8(%rbp),%eax
0x4004e6                add    %edx,%eax
0x4004e8                pop    %rbp
0x4004e9                retq

下面是add函数执行完mov %rsp,%rbp的调用栈快照

+++++++++++++++++ 高位地址
99 |    110   | -- 存放main函数调用方的栈帧地址
+++++++++++++++++
98 | 0x40051d | -- 存放EIP的值,add2返回后将执行的指令的地址
+++++++++++++++++
97 |    99    | -- 存放add2函数调用方(即main函数)的栈帧地址
+++++++++++++++++
96 |   0xXX   |
+++++++++++++++++
.................
76 |   0x02   | -- 这是`mov %edi,-0x14(%rbp)`的执行结果
+++++++++++++++++
.................
+++++++++++++++++
73 |   0xXX   |
+++++++++++++++++
72 | 0x400504 | -- EIP的值,存放add返回后将执行的指令的地址
+++++++++++++++++
71 |    97    | -- 存放add函数调用方(即add函数)的栈帧地址<-- EBP,ESP
+++++++++++++++++ 低位地址

下面就是一系列弹出栈帧的过程了
当add函数执行完retq的调用栈快照

+++++++++++++++++ 高位地址
99 |    110   | -- 存放main函数调用方的栈帧地址
+++++++++++++++++
98 | 0x40051d | -- 存放EIP的值,add2返回后将执行的指令的地址
+++++++++++++++++
97 |    99    | -- 存放add2函数调用方(即main函数)的栈帧地址 <-- EBP
+++++++++++++++++
96 |   0xXX   |
+++++++++++++++++
.................
76 |   0x02   | -- 这是`mov %edi,-0x14(%rbp)`的执行结果
+++++++++++++++++
.................
+++++++++++++++++
73 |   0xXX   | <-- ESP
+++++++++++++++++ 低位地址

然后就不断弹出栈帧了~~~
 从上面看到函数入参是先存储到寄存器中,然后在函数体内读取到栈帧所在空间中(局部变量、临时变量)。那么从调用栈中我们能获取函数的调用流和入参信息,从而恢复案发现场^_^

插播:函数的调用方式

 其实函数入参的传递方式不止上述这种,还有以下3种

cdecl调用约定
 调用方从右到左的顺序将参数压入栈中,在被调用方执行完成后,由调用方负责清理栈中的参数(也称为栈平衡)。

stdcall调用约定
 巨硬自称的一种调用约定,并不是实际上的标准调用约定。调用方从右到左的顺序将参数压入栈中,在被调用方执行完成后,由被调用方负责清理栈中的参数(也称为栈平衡)。

fastcall调用约定
 是stdcall的变体,调用方从右到左的顺序将参数压入栈中,最右边的两个参数则不压入栈中,而是分别存储在ECX和EDX寄存器中,在被调用方执行完成后,由被调用方负责清理栈中的参数(也称为栈平衡)。

 但不管哪种,最终还是会在函数体内读取到当前栈帧空间中。

二. 如何获取调用栈?

 上面写的这么多,可是我们现在写的是JavaScript哦,那到底怎么才能读取调用栈的信息呢?

抛个异常看看

 IE10+的Error实例中包含一个stack属性
示例

function add(a, b){
  let sum = a + b
  throw Error("Capture Call Stack!")
  return sum
}

function add2(a){
  return 2 + add(0, a)
}

function main(){
  add2(2)
}

try{
  main()
} catch (e){
  console.log(e.stack)
}

Chrome回显

Error: Capture Call Stack!
    at add (index.html:16)
    at add2 (index.html:21)
    at main (index.html:25)
    at index.html:29

FireFox回显

add@file:///home/john/index.html:16:9
add2@file:///home/john/index.html:21:14
main@file:///home/john/index.html:25:3
@file:///home/john/index.html:29:3
V8的Error.captureStackTrace函数

 V8引擎向JavaScript提供了其Stack Trace API中的captureStackTrace函数,用于获取调用Error.captureStackTrace时的调用栈快照。函数签名如下

@static
@method captureStackTrace(targetObject, constructorOpt)
@param {Object} targetObject - 为targetObject添加.stack属性,该属性保存调用Error.captureStackTrace时的调用栈快照
@param {Function} constructorOpt= - 调用栈快照不断作出栈操作,直到constructorOpt所指向的函数刚好出栈为止,然后保存到targetObject的stack属性中
@return {undefined}

示例

function add(a, b){
  let sum = a + b
  let targetObj = {}

  Error.captureStackTrace(targetObj)
  console.log(targetObj.stack)

  Error.captureStackTrace(targetObj, add)
  console.log(targetObj.stack)

  return sum
}

function add2(a){
  return 2 + add(0, a)
}

function main(){
  add2(2)
}

main()

Chrome回显

Error
    at add (index.html:18)
    at add2 (index.html:28)
    at main (index.html:32)
    at index.html:35
Error
    at add2 (index.html:28)
    at main (index.html:32)
    at index.html:35
控制台的console.trace函数

 还有最后一招console.trace,不过实际用处不大
示例

function add(a, b){
  let sum = a + b
  console.trace()

  return sum
}

function add2(a){
  return 2 + add(0, a)
}

function main(){
  add2(2)
}

main()

Chrome回显

add    @    index.html:16
add2    @    index.html:22
main    @    index.html:26
(anonymous)    @    index.html:29

 上述三种方式(实际就两种可用啦)都只能获取函数调用流,函数入参、局部变量等信息全都灰飞烟灭了?上面不是说好这些信息调用栈都有嘛,干嘛不给我呢?其实想想都知道调用栈中有这么多信息,其实我们只需一小部分,全盘托出并不是什么好设计。其实我们只要再获取栈帧局部状态就好了。

三. 什么是栈帧局部状态?又如何获取呢?

 所谓栈帧局部状态其实就是函数入参和局部变量,试想如果我们得到add函数调用时的入参是a=0b=2sum=2,那么不就得到完整案发现场了吗?那问题就是如何获得了。要不我们做个Monkey Patch

自定义一个异常类来承载栈帧局部状态

function StackTraceError(e, env){
  if (this instanceof StackTraceError);else return new StackTraceError(e, env)
  this.e = e
  this.env = env
}
let proto = StackTraceError.prototype = Object.create(Error.prototype)
proto.name = "StackTraceError"
proto.message = "Internal error."
proto.constructor = StackTraceError
proto.valueOf = proto.toString = function(){
  let curr = this, q = [], files = []
  do {
    if (curr.stack){
      let stack = String(curr.stack)
      let segs = stack.split("
").map(seg => seg.trim())
      files = segs.filter(seg => seg != "Error")
    }
    else{
      q.unshift({name: curr.name,
                 msg: curr.message,
                 env: curr.env})
    }
  } while (curr = curr.e)

  let frames = []
  let c = files.length, i = 0
  while (i < c){
    let file = files[i]
    let e = q[i]
    let frame = {
      name: e && e.name,
      msg: e && e.msg,
      env: e && e.env,
      file: file
    }
    frames.push(JSON.stringify(frame))
    i += 1
  }
  return frames.join("
")
}

每个函数定义都通过try/catch捕获栈帧局部状态

function add(a, b){
  try{
    var sum = a + b
    throw Error()
  }
  catch(e){
    throw StackTraceError(e, ["a:", a, "b", b, "sum", sum].join("::"))
  }
  return sum
}

function add2(a){
  try{
    return 2 + add(0, a)
  }
  catch(e){
    throw StackTraceError(e, ["a", a].join("::"))
  }
}

function main(){
  try{
    add2(2)
  }
  catch(e){
    throw StackTraceError(e, "")
  }
}

try{
  main()
} catch(e){
  console.log(e+"")
}

chrome下

{"name":"StackTraceError","msg":"Internal error.","env":"a::0::b::2::sum::2","file":"at add (file:///home/john/index.html:57:11)"}
{"name":"StackTraceError","msg":"Internal error.","env":"a:;2","file":"at add2 (file:///home/john/index.html:67:16)"}
{"name":"StackTraceError","msg":"Internal error.","env":"","file":"at main (file:///home/john/index.html:76:5)"}
{"file":"at file:///home/john/index.html:84:3"}

 上面这种做法有三个问题

V8引擎不会对包含try/catch的函数进行优化,如果每个函数都包含try/catch那会严重影响执行效率。

这种方式显然不能让每个开发人员手写,必须通过预编译器来静态织入,开发难度有点大哦。

sum这种临时变量其实并不用记录,因为它可以被运算出来,只要记录ab即可。

 假如我们写的全是纯函数(就是相同入参必定得到相同的返回值,函数内部不依赖外部状态,如加法一样,1+1永远等于2),那么我们只需捕获入口/公用函数的入参即可恢复整个案发现场了。

function add(a, b){
  var sum = a + b
  throw Error()
  return sum
}

function add2(a){
  try{
    return 2 + add(0, a)
  }
  catch(e){
    throw {error:e, env:["a:", a].join("::")})
  }
}

function main(){
  add2(2)
}

try{
  main()
} catch(e){
  console.log(e+"")
}

 然后我们就可以拿着报错信息从add2逐步调试到add中了。假如用ClojureScript我们还可以定义个macro简化一下

;; 私有函数
(defn- add [a b]
  (let [sum (+ a b)]
    (throw (Error.))
    sum))
;; 入口/公用函数
(defn-pub add2 [a]
  (+ 2 (add 0 a)))

(defn main []
  (add2 2))

(try
 (main)
 (catch e
  (println e)))

defn-pub macro的定义

(defmacro defn-pub [name args & body]
  (let [e (gensym)
        arg-names (mapv str args)]
    `(def ~name
       (fn ~args
         (try ~@body
           (catch js/Object ~e
             (throw (clj->js {:e ~e, :env (zipmap ~arg-names ~args)}))))))))
总结

 写到这里其实也没有一个很好的方式去捕获案发现场证据,在入口/公用函数中加入try/catch是我现阶段能想到比较可行的方式,请各位多多指点。
尊重原创,转载请注明转自:http://www.cnblogs.com/fsjohn... ^_^肥仔John

参考

http://www.cnblogs.com/exiaha...
http://blog.csdn.net/qiu26584...
http://lucasfcosta.com/2017/0...
http://blog.shaochuancs.com/a...

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/89298.html

相关文章

  • 前端魔法——异常不仅仅是try/catch

    摘要:我打算分成前端魔法堂异常不仅仅是和前端魔法堂调用栈,异常实例中的宝藏两篇分别叙述内置自定义异常类,捕获运行时异常语法异常网络请求异常事件,什么是调用栈和如何获取调用栈的相关信息。 前言  编程时我们往往拿到的是业务流程正确的业务说明文档或规范,但实际开发中却布满荆棘和例外情况,而这些例外中包含业务用例的例外,也包含技术上的例外。对于业务用例的例外我们别无它法,必须要求实施人员与用户共同...

    bladefury 评论0 收藏0
  • 2017-10-26 前端日报

    摘要:前端日报精选浅谈前端和移动端的事件机制字符串转数字陷阱前端魔法堂调用栈,异常实例中的宝藏一份完美的前端清单专为现代网站和极致的开发者打造居中办法学习笔记中文开发如何在里面优雅的解决跨域,路由冲突问题超详细前端学习译响应式脑电波如何使 2017-10-26 前端日报 精选 浅谈前端和移动端的事件机制JavaScript 字符串转数字:陷阱前端魔法堂——调用栈,异常实例中的宝藏一份完美的前...

    jindong 评论0 收藏0
  • JS魔法之实战:纯前端的图片预览

    摘要:一前言图片上传是一个普通不过的功能,而图片预览就是就是上传功能中必不可少的子功能了。偶然从上找到纯前端图片预览的相关资料,经过整理后记录下来以便日后查阅。类型为,表示在读取文件时发生的错误,只读。 一、前言   图片上传是一个普通不过的功能,而图片预览就是就是上传功能中必不可少的子功能了。在这之前,我曾经通过订阅input[type=file]元素的onchange事件,一旦更改路径...

    岳光 评论0 收藏0
  • JS魔法:那些困扰你的DOM集合类型

    摘要:五的子类对象会返回一个集合对象,集合内存储类型的元素。七的子类初看很有可能以为集合元素就是单选表单元素,其实可以存储任意类型的表单元素。八的子类开始,将返回子类的对象,其行为特征和一致。但在前,我们应该先了解清楚的类型的特征。 一、前言                            大家先看看下面的js,猜猜结果会怎样吧! 可选答案: ①. 获取id属性值为id的节点元素 ②...

    468122151 评论0 收藏0
  • JS魔法:深究JS异步编程模型

    摘要:而同步和异步则是描述另一个方面。异步将数据从内核空间拷贝到用户空间的操作由系统自动处理,然后通知应用程序直接使用数据即可。 前言  上周5在公司作了关于JS异步编程模型的技术分享,可能是内容太干的缘故吧,最后从大家的表情看出这条粉肠到底在说啥?的结果:(下面是PPT的讲义,具体的PPT和示例代码在https://github.com/fsjohnhuan...上,有兴趣就上去看看吧! ...

    idealcn 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<