「Emacsのトラノマキ」連載第15回「Emacs Lispの実装」(袖山剛)

Tweet

* はじめに 今回は過去2回のLisp実装のまとめとして、Emacs Lispの実装をemacs-23.1のコードを追いながら解説していくことにします。 詳細に解説していると紙面がまるで足りないので、コードを読む上での取っ掛かりやツールを使ったコードの読み方などを紹介し 、今後自分でリーディングされる方の手助けとなればなと思います。 記事中のディレクトリパスの表記はemacs-23.1を解凍したディレクトリからの相対パスとします。 * 準備 ** GNU GLOBAL まずコードを読む上で便利なGNU GLOBALというソフトウェアの設定を行います。 GNU GLOBALは本連載の「Emacsの検索機能を使いこなす」の回で紹介している便利な検索機能を持ったソフトウェアです。 GNU GLOBAL オフィシャルサイト http://www.gnu.org/software/global/global.html 使い方を少しだけおさらいしておきます。 GNU GLOBALはemacs上で利用可能で、.emacs.elへ以下の設定を行います。 ================= .emacs.elの設定 ================= (autoload 'gtags-mode "gtags" "" t) (setq gtags-mode-hook '(lambda () (local-set-key "\M-t" 'gtags-find-tag) (local-set-key "\M-r" 'gtags-find-rtag) (local-set-key "\M-s" 'gtags-find-symbol) (local-set-key "\C-t" 'gtags-pop-stack) )) =================================================== 調べたい関数や変数にカーソルを合わせ以下のkeyで操作を行います。 =========================================================== M-t 関数の定義元へジャンプします。 M-r 関数の参照元の一覧を表示、選択でジャンプ M-s 変数の定義元と参照元の一覧を表示、選択でジャンプします。 C-t 操作一つ前のバッファに戻ります。 =========================================================== Cのマクロに対しても操作が有効なので、M-tで大元の定義場所もさくさく探しにいけます。 ** GDB また、コードリーディングをする上で非常に便利なツールとしてgdbというデバッガーが存在します。 gdbは一般的なデバッガーと同様、break pointを張り、コードをステップ実行する事が可能です。 使い方はemacs上で M-x gdb としデバッグしたいemacsバイナリのフルパスを引数として渡します。 また、gdbは既に起動しているプロセスにもアタッチする事が出来ます。 Emacsのコードリーディングではプロセスをアタッチする方法をお勧めします。 というのも、Emacs Lispの主要ソースファイルであるeval.cやlread.cでbreak pointを作り、その後にgdb上から emacsバイナリを立ち上げるとEmacsの初期化処理でステップが止まってしまい、意図的にbreakを張りたいところまで中々たどり着かないからです。 プロセスをアタッチする方法での立ち上げ方は以下のようにemacsのバイナリ指定の後にプロセスIDを指定します。 M-x gdb /hoge/fuga/emacs pid break pointの張り方は、下記のようにファイル名とコロンの後に行番号を指定します。 (gdb) break lread.c:2932 また下記のようにhoge変数が10となる時のみbreakを張るような条件指定付きのbreak pointを作る事も可能です。 (gdb) break lread.c:2932 if hoge == 10 break pointで止まった処理を再開させる時は continue (c) コマンドを実行します。 なお、breakを張っている時に対象ファイルをemacsで開いていると、ステップ実行に合わせて 自動でバッファ内を移動してくれるので非常に便利です。 図1はgdbをemacs上で動かし、*scratch*バッファで(+ 33 44)をC-jで評価した直後、break point部分で 処理が停止しているところです。この後、gdbでステップ実行(next)をしていく事でコードを追っていく事が出来ます。 図1 gdbをemacsから動かしているところ [emacs-gdb.png] * 概要 過去の記事でLispインタープリタの役割には大きく分けて3つの処理がある事を説明しました。 1つ目は与えられたプログラムをトークンに分割する事で、2つ目は分割されたトークンを元に構文木を作る事です。 Emacs Lispの実装では、この一つ目と二つ目の処理を主にsrc/lread.cのread系の関数(read0, read1, read_list, etc..)で行っています。 3つ目の処理は作られた構文木を評価する事で、Emacs Lispでは主にsrc/eval.cのeval関数でその処理を行っています。 また、listに対する処理を行う関数Fcar, Fcdr等はsrc/data.cで定義されています。 * 最初の一歩 S式がどのように評価されていくのか、取っ掛かりが無いと何処からコードを追えばいいのか中々わかりません。 そこで、まずはLisp対話用バッファである*scratch*に記述したS式をC-jで評価し、どのようにelisp内で処理が遷移していくのかを 見ていきます。 C-jがどのような関数にセットされているのかを調べるには*scratch*バッファで M-x describe-key (C-h k) を実行します。 関数 describe-key はkeyがどのLisp関数にバインドされているかを調べる関数です。 *scratch*バッファは lisp-interaction-mode というメジャーモードが割り当てられています。 このメジャーモードでのC-jキーをdescribe-keyで調べてみると、eval-print-last-sexpにバインドされている事が分かります。 この関数はS式(sexp)を評価して表示するという関数で、lisp-mode.elで定義されている事がわかります。 では lisp-mode.elの中を追ってみます。 - lisp/emacs-lisp/lisp-mode.el 544:(defun eval-print-last-sexp () ... 553: (interactive) 554: (let ((standard-output (current-buffer))) 555: (terpri) 556: (eval-last-sexp t) 557: (terpri))) terpriは改行を出力する関数で、eval-last-sexp関数を呼び出しています。 このeval-last-sexpは (eval-last-sexp-1 ...) という関数を呼び出しているだけなので eval-last-sexp-1 を見てみることにします。 - lisp/emacs-lisp/lisp-mode.el 692:(defun eval-last-sexp-1 (eval-last-sexp-arg-internal) ... 695: (let ((standard-output (if eval-last-sexp-arg-internal (current-buffer) t))) 696: (eval-last-sexp-print-value (eval (preceding-sexp))))) この関数の696行目を見てください。preceding-sexpがS式のパース、evalがパースされた構文木の評価、 eval-last-sexp-print-valueが結果の表示に該当しています。 preceding-sexp関数の役割は676行目の (read (current-buffer)) の処理でパースした構文木をexprにセットし、その値を返す事です。 read関数はCで実装された関数で、S式のパースの処理は全てここで行われています。 - lisp/emacs-lisp/lisp-mode.el 639:(defun preceding-sexp () 640: "Return sexp before the point." 641: (let ((opoint (point)) 642: ignore-quotes 643: expr) ... 676: (setq expr (read (current-buffer))) ... 689: expr))))) * Lispプリミティブ 前節のread関数のようにCで実装されたLisp関数の事をLispプリミティブと呼びます。 - src/lisp.h DEFUNマクロ 1699:#define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \ 1700: Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \ 1701: DECL_ALIGN (struct Lisp_Subr, sname) = \ 1702: { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \ 1703: fnname, minargs, maxargs, lname, intspec, 0}; \ 1704: Lisp_Object fnname 1705: 1706:/* Note that the weird token-substitution semantics of ANSI C makes 1707: this work for MANY and UNEVALLED. */ 1708:#define DEFUN_ARGS_MANY (int, Lisp_Object *) 1709:#define DEFUN_ARGS_UNEVALLED (Lisp_Object) 1710:#define DEFUN_ARGS_0 (void) 1711:#define DEFUN_ARGS_1 (Lisp_Object) 1712:#define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object) ... DEFUNはLispプリミティブを定義するためのマクロです。 lnameがLisp関数名、fnameがC関数名、snameはLispプリミティブを管理する構造体struct Lisp_Subrの変数名となってます。 minargs, maxargsは引数の最小値と最大値で、intspecはこの関数が対話的に呼び出せるかどうかの指示で0(NULL)の場合は 対話的に呼び出せません。docはこの関数の説明文字列です。 1700行目の"##"はトークン連結演算子マクロで例えばmaxargsが2の場合は Lisp_Object fname DEFUN_ARGS_2 のように展開されます。DEFUN_ARGS_2は1712行目のように定義されているので、最終的には Lisp_Object fname (Lisp_Object, Lisp_Object) と展開されます。 このマクロ中に出てくるLisp_Objectは、Lispの数値や文字列といったオブジェクトを表現するための共用体 で、src/lisp.hで定義されています。 - src/lisp.h Lisp_Object 253:typedef 254:union Lisp_Object 255:{ ... 258: EMACS_UINT i; 259: 260: struct 261: { 262: EMACS_INT val : VALBITS; 263: enum Lisp_Type type : GCTYPEBITS; 264: } s; 265: struct 266: { 267: EMACS_UINT val : VALBITS; 268: enum Lisp_Type type : GCTYPEBITS; 269: } u; 270:} 271:Lisp_Object; Lisp_Objectは下位3ビットでTypeを保持しています。 Lisp_TypeにはInt, Symbol, String等があり、オブジェクトの種類を表しています。詳しくはsrc/lisp.hの183行目を参照してください。 ほとんどのLisp_Objectは8Byteでアライメントされたポインタを保持しているだけで、実体はそのポインタの先にあります。 例外として整数型(Lisp_Int)があり、これは実体を上位の29bitを使って保持しています。 符号を除くと実際には28bitが整数値として使えます。なお、Emacs23.2では整数値は29bitまで使えるようになりました。 ありえるえりあ(http://dev.ariel-networks.com/Members/inoue/emacs23.2/view)の記事が参考になるので、気になる人は読んでみましょう。 * パース ではLisp関数preceding-sexpで呼ばれているLispプリミティブな関数readを見てみましょう。 src/lread.cの1889行目から定義されているFread関数はS式をパースする関数です。 - src/lread.c Fread関数 1889:DEFUN ("read", Fread, Sread, 0, 1, 0, 1890: doc: /* Read one Lisp expression as text from STREAM, return as Lisp object. ... 1900: (stream) 1901: Lisp_Object stream; 1902:{ ... 1924: ret = read_internal_start (string, start, end); 1925: return Fcons (ret, make_number (read_from_string_index)); 1926:} read関数の実体は1924行目のread_internal_start関数で、その返り値をcarとして持つconsセルを返します。 Fconsはsrc/alloc.cの2733行目で定義されているLispプリミティブです。 - src/lread.c read_internal_start関数 1928:/* Function to set up the global context we need in toplevel read 1929: calls. */ 1930:static Lisp_Object 1931:read_internal_start (stream, start, end) 1932: Lisp_Object stream; 1933: Lisp_Object start; /* Only used when stream is a string. */ 1934: Lisp_Object end; /* Only used when stream is a string. */ 1935:{ 1936: Lisp_Object retval; ... 1980: retval = read0 (stream); ... 1984: return retval; 1985:} read_internal_start関数は1928行目のコメントにあるとおり、read処理をする前に必要なグローバルコンテキストをセットする ための関数です。1936行目から1979行目までにグローバル変数に値を代入し、read0を呼びます。 - src/lread.c read0, read1関数 2005:static Lisp_Object 2006:read0 (readcharfun) 2007: Lisp_Object readcharfun; 2008:{ 2009: register Lisp_Object val; 2010: int c; 2011: 2012: val = read1 (readcharfun, &c, 0); 2013: if (!c) 2014: return val; ... 2308:static Lisp_Object 2309:read1 (readcharfun, pch, first_in_list) 2310: register Lisp_Object readcharfun; 2311: int *pch; 2312: int first_in_list; 2313:{ 2314: register int c; read0関数とread1関数は相互再帰をしています。read1関数はS式から文字を1つずつ取り出し、 token分割とパースを同時に行っています。read1の引数の意味は、readcharfunがパースすべきS式を保持しているLisp_Objectです。 first_in_listは非ゼロの時、listの最初の要素である事を意味します。 2314行目のローカル変数cがチェックしている1文字です。cが')'か']'の時にその値を*pchに渡しています。 cがそれ以外の値の時、*pchの値は0になっており、最終的にread0の2012行目でcに')'か']'がセットされます。 その変数cが0の時はシンタックスエラーとします。これはS式が対の括弧で閉じているかどうかのチェックです。 - src/lread.c 250:#define READCHAR readchar (readcharfun, NULL) 251:#define UNREAD(c) unreadchar (readcharfun, c) ... 254:#define READCHAR_REPORT_MULTIBYTE(multibyte) readchar (readcharfun, multibyte) token分割をするにはS式から1文字ずつ文字を取得する必要があります。 READCHARはreadcharfunから1文字取得するマクロで、UNREADは1文字元に戻すマクロです。 READCHAR_REPORT_MULTIBYTEはreadcharfunから1文字取得するマクロですが、マルチバイト 文字に対応しています。 - src/lread.c read1関数 2311:retry: 2312: 2313: c = READCHAR_REPORT_MULTIBYTE (&multibyte); 2314: if (c < 0) 2315: end_of_file_error (); 2316: 2317: switch (c) 2318: { 2319: case '(': 2320: return read_list (0, readcharfun); 2321: 2322: case '[': 2323: return read_vector (readcharfun, 0); 2324: 2325: case ')': 2326: case ']': 2327: { 2328: *pch = c; 2329: return Qnil; 2330: } read1関数を読み進めていくと、2313行目で1文字取得し、2317行目のswitch文で処理を振り分けています。 ここからがEmacs Lispパーサの主要部分です。 cが'('や'['の場合、すなわちS式がリストやベクトルの場合はそれぞれread_list, read_vectorが呼ばれ、 それらの関数内で再帰的にread0, read1が呼ばれ構文木を構築していきます。 この構文木はルートとなるLisp_Objectを頂点とし、以下のLisp_Consで表現される連結リストなどとして構築されていきます。 - src/lisp.h 629:struct Lisp_Cons 630: { ... 641: Lisp_Object car; 642: union 643: { 644: Lisp_Object cdr; 645: struct Lisp_Cons *chain; 646: } u; 647:#endif 648: }; ここで、パーサの例として数値パーサを見てみたいと思います。 gdbを使いbreak pointを (gdb) break lread.c:2942 とlread.cの2942行目で張っておきます。 - src/lread.c 数値のパース 2919: register char *p1; 2920: register Lisp_Object val; 2921: p1 = read_buffer; 2922: if (*p1 == '+' || *p1 == '-') p1++; 2923: /* Is it an integer? */ 2924: if (p1 != p) 2925: { 2926: while (p1 != p && (c = *p1) >= '0' && c < = '9') p1++; 2927: /* Integers can have trailing decimal points. */ 2928: if (p1 > read_buffer && p1 < p && *p1 == '.') p1++; 2929: if (p1 == p) 2930: /* It is an integer. */ 2931: { 2932: if (p1[-1] == '.') 2933: p1[-1] = '\0'; 2934: /* Fixme: if we have strtol, use that, and check 2935: for overflow. */ 2936: if (sizeof (int) == sizeof (EMACS_INT)) 2937: XSETINT (val, atoi (read_buffer)); 2938: else if (sizeof (long) == sizeof (EMACS_INT)) 2939: XSETINT (val, atol (read_buffer)); 2940: else 2941: abort (); 2942: return val; 2943: } 2944: } *scratch*で (+ 2 3) のようなS式をC-jで評価すると上記のbreak pointで処理が停止します。 (gdb) print read_buffer 読み込み中のbufferの中身を覗いてみると、「$6 = 0x84ab5c8 "2"」のようにアドレスと そのアドレス先が保持している中身の"2"が表示されている事がわかります。 "2"という値がLisp_Objectのvalにセットされread1の返り値としてreturnされます。 数値をパースしている主要部分は2926行目〜2929行目でポインタpはS式の区切りとなる"\"';()[]#" などの文字が発見された場所のポインタを指し示しています。 Emacsにはgdbでデバッグしやすいように便利な設定がしてあり、それが src/.gdbinit に定義されています。 .gdbinitはgdbで使えるマクロ集です。 - src/.gdbinit 512:define xtype 513: xgettype $ 514: output $type 515: echo \n 516: if $type == Lisp_Misc 517: xmisctype 518: else 519: if $type == Lisp_Vectorlike 520: xvectype 521: end 522: end 523:end 例えばxtypeマクロは今調べているカレントのオブジェクトのLisp Typeを調べます。 使い方は以下のようになります。 (gdb) print val $35 = <value optimized out> (gdb) xtype Lisp_Int (gdb) xint $36 = 0 (gdb) まずは調べたい変数をprintで表示し、カレントオブジェクトの$に暗黙的にセットします。 次にLisp Typeをxtypeマクロで調べ、typeに合わせたマクロをxintマクロ等(他にはxstring, xsymbolマクロ等があります)で呼び出しています。 * 評価 S式の評価は lisp/emacs-lisp/lisp-mode.el 696行目の"eval"によって行われます。 eval関数はLispプリミティブでsrc/eval.cで定義されています。 - src/eval.c Feval関数 2243:DEFUN ("eval", Feval, Seval, 1, 1, 0, 2244: doc: /* Evaluate FORM and return its value. */) 2245: (form) 2246: Lisp_Object form; 2247:{ 2248: Lisp_Object fun, val, original_fun, original_args; 2249: Lisp_Object funcar; ... 2280: original_fun = Fcar (form); 2281: original_args = Fcdr (form); formはevalの引数に与えられたS式で、2280,2281行目で関数部分(original_fun)と引数部分(original_args)に分離されます。 以後はこのoriginal_funに引数original_argsを適用し評価していきます。 - src/eval.c Fevalの主要部分 2304: if (SUBRP (fun)) 2305: { 2306: Lisp_Object numargs; 2307: Lisp_Object argvals[8]; 2308: Lisp_Object args_left; 2309: register int i, maxargs; 2310: 2311: args_left = original_args; 2312: numargs = Flength (args_left); ... 2320: if (XSUBR (fun)->max_args == UNEVALLED) 2321: { 2322: backtrace.evalargs = 0; 2323: val = (*XSUBR (fun)->function) (args_left); 2324: goto done; 2325: } 2326: 2327: if (XSUBR (fun)->max_args == MANY) 2328: { 2329: /* Pass a vector of evaluated arguments */ 2330: Lisp_Object *vals; 2331: register int argnum = 0; 2332: 2333: vals = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object)); ... 2339: while (!NILP (args_left)) 2340: { 2341: vals[argnum++] = Feval (Fcar (args_left)); 2342: args_left = Fcdr (args_left); 2343: gcpro3.nvars = argnum; 2344: } ... 2349: val = (*XSUBR (fun)->function) (XINT (numargs), vals); 2350: UNGCPRO; 2351: goto done; 2352: } ... 2358: maxargs = XSUBR (fun)->max_args; 2359: for (i = 0; i < maxargs; args_left = Fcdr (args_left)) 2360: { 2361: argvals[i] = Feval (Fcar (args_left)); 2362: gcpro3.nvars = ++i; 2363: } ... 2370: switch (i) 2371: { 2372: case 0: 2373: val = (*XSUBR (fun)->function) (); 2374: goto done; 2375: case 1: 2376: val = (*XSUBR (fun)->function) (argvals[0]); 2377: goto done; ... 2403: case 8: 2404: val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2], 2405: argvals[3], argvals[4], argvals[5], 2406: argvals[6], argvals[7]); 2407: goto done; 2304行目のSUBRPはS式のパース時(read時)にdefsubr関数(src/lread.c 3850行目)で定義されている関数かどうかチェックします。 すなわちLispプリミティブな関数かどうかをチェックしています。 次に引数のチェックが2320行目、2327行目にあります。これはDEFUNマクロでmaxargsに指定する値のチェックで UNEVALLEDは引数を評価しなくていい場合、MANYは可変長な引数をとれる場合に指定します。 UNEVALLEDの場合、2323行目で引数を評価せずに渡しています。MANYの場合2339行目〜2344行目で可変長引数をそれぞれ評価しています。 maxargsが数値で定義されている場合は2358行目からの処理になり、2359行目〜2363行目で引数を評価します。 2370行目からのswitch文で引数の数に応じた関数の呼び方をしています。 - src/eval.c 2417: if (COMPILEDP (fun)) 2418: val = apply_lambda (fun, original_args, 1); 2419: else 2420: { ... 2433: if (EQ (funcar, Qmacro)) 2434: val = Feval (apply1 (Fcdr (fun), original_args)); 2435: else if (EQ (funcar, Qlambda)) 2436: val = apply_lambda (fun, original_args, 1); 2437: else 2438: xsignal1 (Qinvalid_function, original_fun); 2439: } SUBRP以外の関数は2417行目〜2439行目で処理されます。 2417行目はバイトコードにコンパイル済みの式かどうかをチェックし、そうであればapply_lambda関数を呼び出しています。 2433行目はマクロかどうかのチェックで、マクロの場合は2434行目でマクロのbody部に引数(original_args)を適用(Fapply)した構文木を再度evalしています。 2435行目はlambda適用かどうかのチェックで、そうであればapply_lambdaを呼び出しています。 * 終わりに 今回はEmacs Lispの実装を、lisp-interaction-modeでS式を評価して掘り下げていくという視点で紹介しました。 解説した内容はEmacs Lisp実装のほんの一部にしかすぎません。gdbでLispプリミティブがどのように評価されていくのかを 調べてみたり、新しいLispプリミティブをDEFUNマクロを使って定義して遊んでみるのもいいかもしれません。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495

* はじめに   今回は過去2回のLisp実装のまとめとして、Emacs Lispの実装をemacs-23.1のコードを追いながら解説していくことにします。 詳細に解説していると紙面がまるで足りないので、コードを読む上での取っ掛かりやツールを使ったコードの読み方などを紹介し 、今後自分でリーディングされる方の手助けとなればなと思います。 記事中のディレクトリパスの表記はemacs-23.1を解凍したディレクトリからの相対パスとします。   * 準備 ** GNU GLOBAL   まずコードを読む上で便利なGNU GLOBALというソフトウェアの設定を行います。 GNU GLOBALは本連載の「Emacsの検索機能を使いこなす」の回で紹介している便利な検索機能を持ったソフトウェアです。   GNU GLOBAL オフィシャルサイト http://www.gnu.org/software/global/global.html   使い方を少しだけおさらいしておきます。   GNU GLOBALはemacs上で利用可能で、.emacs.elへ以下の設定を行います。   ================= .emacs.elの設定 ================= (autoload 'gtags-mode "gtags" "" t) (setq gtags-mode-hook       '(lambda ()          (local-set-key "\M-t" 'gtags-find-tag)          (local-set-key "\M-r" 'gtags-find-rtag)          (local-set-key "\M-s" 'gtags-find-symbol)          (local-set-key "\C-t" 'gtags-pop-stack)          )) ===================================================   調べたい関数や変数にカーソルを合わせ以下のkeyで操作を行います。   =========================================================== M-t 関数の定義元へジャンプします。 M-r 関数の参照元の一覧を表示、選択でジャンプ M-s 変数の定義元と参照元の一覧を表示、選択でジャンプします。 C-t 操作一つ前のバッファに戻ります。 =========================================================== Cのマクロに対しても操作が有効なので、M-tで大元の定義場所もさくさく探しにいけます。   ** GDB また、コードリーディングをする上で非常に便利なツールとしてgdbというデバッガーが存在します。 gdbは一般的なデバッガーと同様、break pointを張り、コードをステップ実行する事が可能です。   使い方はemacs上で M-x gdb としデバッグしたいemacsバイナリのフルパスを引数として渡します。 また、gdbは既に起動しているプロセスにもアタッチする事が出来ます。 Emacsのコードリーディングではプロセスをアタッチする方法をお勧めします。 というのも、Emacs Lispの主要ソースファイルであるeval.cやlread.cでbreak pointを作り、その後にgdb上から emacsバイナリを立ち上げるとEmacsの初期化処理でステップが止まってしまい、意図的にbreakを張りたいところまで中々たどり着かないからです。   プロセスをアタッチする方法での立ち上げ方は以下のようにemacsのバイナリ指定の後にプロセスIDを指定します。   M-x gdb /hoge/fuga/emacs pid   break pointの張り方は、下記のようにファイル名とコロンの後に行番号を指定します。   (gdb) break lread.c:2932   また下記のようにhoge変数が10となる時のみbreakを張るような条件指定付きのbreak pointを作る事も可能です。   (gdb) break lread.c:2932 if hoge == 10   break pointで止まった処理を再開させる時は continue (c) コマンドを実行します。 なお、breakを張っている時に対象ファイルをemacsで開いていると、ステップ実行に合わせて 自動でバッファ内を移動してくれるので非常に便利です。 図1はgdbをemacs上で動かし、*scratch*バッファで(+ 33 44)をC-jで評価した直後、break point部分で 処理が停止しているところです。この後、gdbでステップ実行(next)をしていく事でコードを追っていく事が出来ます。   図1 gdbをemacsから動かしているところ [emacs-gdb.png]   * 概要 過去の記事でLispインタープリタの役割には大きく分けて3つの処理がある事を説明しました。 1つ目は与えられたプログラムをトークンに分割する事で、2つ目は分割されたトークンを元に構文木を作る事です。 Emacs Lispの実装では、この一つ目と二つ目の処理を主にsrc/lread.cのread系の関数(read0, read1, read_list, etc..)で行っています。 3つ目の処理は作られた構文木を評価する事で、Emacs Lispでは主にsrc/eval.cのeval関数でその処理を行っています。 また、listに対する処理を行う関数Fcar, Fcdr等はsrc/data.cで定義されています。   * 最初の一歩 S式がどのように評価されていくのか、取っ掛かりが無いと何処からコードを追えばいいのか中々わかりません。 そこで、まずはLisp対話用バッファである*scratch*に記述したS式をC-jで評価し、どのようにelisp内で処理が遷移していくのかを 見ていきます。   C-jがどのような関数にセットされているのかを調べるには*scratch*バッファで M-x describe-key (C-h k) を実行します。 関数 describe-key はkeyがどのLisp関数にバインドされているかを調べる関数です。 *scratch*バッファは lisp-interaction-mode というメジャーモードが割り当てられています。 このメジャーモードでのC-jキーをdescribe-keyで調べてみると、eval-print-last-sexpにバインドされている事が分かります。 この関数はS式(sexp)を評価して表示するという関数で、lisp-mode.elで定義されている事がわかります。   では lisp-mode.elの中を追ってみます。   - lisp/emacs-lisp/lisp-mode.el 544:(defun eval-print-last-sexp () ... 553:  (interactive) 554:  (let ((standard-output (current-buffer))) 555:    (terpri) 556:    (eval-last-sexp t) 557:    (terpri)))   terpriは改行を出力する関数で、eval-last-sexp関数を呼び出しています。 このeval-last-sexpは (eval-last-sexp-1 ...) という関数を呼び出しているだけなので eval-last-sexp-1 を見てみることにします。   - lisp/emacs-lisp/lisp-mode.el 692:(defun eval-last-sexp-1 (eval-last-sexp-arg-internal) ... 695:  (let ((standard-output (if eval-last-sexp-arg-internal (current-buffer) t))) 696:    (eval-last-sexp-print-value (eval (preceding-sexp)))))   この関数の696行目を見てください。preceding-sexpがS式のパース、evalがパースされた構文木の評価、 eval-last-sexp-print-valueが結果の表示に該当しています。 preceding-sexp関数の役割は676行目の (read (current-buffer)) の処理でパースした構文木をexprにセットし、その値を返す事です。 read関数はCで実装された関数で、S式のパースの処理は全てここで行われています。   - lisp/emacs-lisp/lisp-mode.el 639:(defun preceding-sexp () 640:  "Return sexp before the point." 641:  (let ((opoint (point)) 642: ignore-quotes 643: expr) ... 676:   (setq expr (read (current-buffer))) ... 689:   expr)))))     * Lispプリミティブ 前節のread関数のようにCで実装されたLisp関数の事をLispプリミティブと呼びます。   - src/lisp.h  DEFUNマクロ 1699:#define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \ 1700:  Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \ 1701:  DECL_ALIGN (struct Lisp_Subr, sname) = \ 1702:    { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \ 1703:      fnname, minargs, maxargs, lname, intspec, 0}; \ 1704:  Lisp_Object fnname 1705: 1706:/* Note that the weird token-substitution semantics of ANSI C makes 1707:   this work for MANY and UNEVALLED.  */ 1708:#define DEFUN_ARGS_MANY (int, Lisp_Object *) 1709:#define DEFUN_ARGS_UNEVALLED (Lisp_Object) 1710:#define DEFUN_ARGS_0 (void) 1711:#define DEFUN_ARGS_1 (Lisp_Object) 1712:#define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object) ...   DEFUNはLispプリミティブを定義するためのマクロです。 lnameがLisp関数名、fnameがC関数名、snameはLispプリミティブを管理する構造体struct Lisp_Subrの変数名となってます。 minargs, maxargsは引数の最小値と最大値で、intspecはこの関数が対話的に呼び出せるかどうかの指示で0(NULL)の場合は 対話的に呼び出せません。docはこの関数の説明文字列です。 1700行目の"##"はトークン連結演算子マクロで例えばmaxargsが2の場合は   Lisp_Object fname DEFUN_ARGS_2   のように展開されます。DEFUN_ARGS_2は1712行目のように定義されているので、最終的には   Lisp_Object fname (Lisp_Object, Lisp_Object)   と展開されます。   このマクロ中に出てくるLisp_Objectは、Lispの数値や文字列といったオブジェクトを表現するための共用体 で、src/lisp.hで定義されています。   - src/lisp.h  Lisp_Object 253:typedef 254:union Lisp_Object 255:{ ... 258:    EMACS_UINT i; 259: 260:    struct 261:    { 262:      EMACS_INT val  : VALBITS; 263:      enum Lisp_Type type : GCTYPEBITS; 264:    } s; 265:    struct 266:    { 267:      EMACS_UINT val : VALBITS; 268:      enum Lisp_Type type : GCTYPEBITS; 269:    } u; 270:} 271:Lisp_Object;   Lisp_Objectは下位3ビットでTypeを保持しています。 Lisp_TypeにはInt, Symbol, String等があり、オブジェクトの種類を表しています。詳しくはsrc/lisp.hの183行目を参照してください。 ほとんどのLisp_Objectは8Byteでアライメントされたポインタを保持しているだけで、実体はそのポインタの先にあります。 例外として整数型(Lisp_Int)があり、これは実体を上位の29bitを使って保持しています。 符号を除くと実際には28bitが整数値として使えます。なお、Emacs23.2では整数値は29bitまで使えるようになりました。 ありえるえりあ(http://dev.ariel-networks.com/Members/inoue/emacs23.2/view)の記事が参考になるので、気になる人は読んでみましょう。     * パース ではLisp関数preceding-sexpで呼ばれているLispプリミティブな関数readを見てみましょう。 src/lread.cの1889行目から定義されているFread関数はS式をパースする関数です。   - src/lread.c  Fread関数 1889:DEFUN ("read", Fread, Sread, 0, 1, 0, 1890:       doc: /* Read one Lisp expression as text from STREAM, return as Lisp object. ... 1900:     (stream) 1901:     Lisp_Object stream; 1902:{ ... 1924:  ret = read_internal_start (string, start, end); 1925:  return Fcons (ret, make_number (read_from_string_index)); 1926:}   read関数の実体は1924行目のread_internal_start関数で、その返り値をcarとして持つconsセルを返します。 Fconsはsrc/alloc.cの2733行目で定義されているLispプリミティブです。   - src/lread.c  read_internal_start関数 1928:/* Function to set up the global context we need in toplevel read 1929:   calls. */ 1930:static Lisp_Object 1931:read_internal_start (stream, start, end) 1932:     Lisp_Object stream; 1933:     Lisp_Object start; /* Only used when stream is a string. */ 1934:     Lisp_Object end; /* Only used when stream is a string. */ 1935:{ 1936:  Lisp_Object retval; ... 1980:  retval = read0 (stream); ... 1984:  return retval; 1985:}   read_internal_start関数は1928行目のコメントにあるとおり、read処理をする前に必要なグローバルコンテキストをセットする ための関数です。1936行目から1979行目までにグローバル変数に値を代入し、read0を呼びます。   - src/lread.c  read0, read1関数 2005:static Lisp_Object 2006:read0 (readcharfun) 2007:     Lisp_Object readcharfun; 2008:{ 2009:  register Lisp_Object val; 2010:  int c; 2011: 2012:  val = read1 (readcharfun, &c, 0); 2013:  if (!c) 2014:    return val; ... 2308:static Lisp_Object 2309:read1 (readcharfun, pch, first_in_list) 2310:     register Lisp_Object readcharfun; 2311:     int *pch; 2312:     int first_in_list; 2313:{ 2314:  register int c;   read0関数とread1関数は相互再帰をしています。read1関数はS式から文字を1つずつ取り出し、 token分割とパースを同時に行っています。read1の引数の意味は、readcharfunがパースすべきS式を保持しているLisp_Objectです。 first_in_listは非ゼロの時、listの最初の要素である事を意味します。 2314行目のローカル変数cがチェックしている1文字です。cが')'か']'の時にその値を*pchに渡しています。 cがそれ以外の値の時、*pchの値は0になっており、最終的にread0の2012行目でcに')'か']'がセットされます。 その変数cが0の時はシンタックスエラーとします。これはS式が対の括弧で閉じているかどうかのチェックです。   - src/lread.c 250:#define READCHAR readchar (readcharfun, NULL) 251:#define UNREAD(c) unreadchar (readcharfun, c) ... 254:#define READCHAR_REPORT_MULTIBYTE(multibyte) readchar (readcharfun, multibyte)   token分割をするにはS式から1文字ずつ文字を取得する必要があります。 READCHARはreadcharfunから1文字取得するマクロで、UNREADは1文字元に戻すマクロです。 READCHAR_REPORT_MULTIBYTEはreadcharfunから1文字取得するマクロですが、マルチバイト 文字に対応しています。   - src/lread.c  read1関数 2311:retry: 2312: 2313:  c = READCHAR_REPORT_MULTIBYTE (&multibyte); 2314:  if (c < 0) 2315:    end_of_file_error (); 2316: 2317:  switch (c) 2318:    { 2319:    case '(': 2320:      return read_list (0, readcharfun); 2321: 2322:    case '[': 2323:      return read_vector (readcharfun, 0); 2324: 2325:    case ')': 2326:    case ']': 2327:      { 2328:     *pch = c; 2329:       return Qnil; 2330:      }   read1関数を読み進めていくと、2313行目で1文字取得し、2317行目のswitch文で処理を振り分けています。 ここからがEmacs Lispパーサの主要部分です。 cが'('や'['の場合、すなわちS式がリストやベクトルの場合はそれぞれread_list, read_vectorが呼ばれ、 それらの関数内で再帰的にread0, read1が呼ばれ構文木を構築していきます。 この構文木はルートとなるLisp_Objectを頂点とし、以下のLisp_Consで表現される連結リストなどとして構築されていきます。   - src/lisp.h   629:struct Lisp_Cons 630:  { ... 641:    Lisp_Object car; 642:    union 643:    { 644:      Lisp_Object cdr; 645:      struct Lisp_Cons *chain; 646:    } u; 647:#endif 648:  };   ここで、パーサの例として数値パーサを見てみたいと思います。 gdbを使いbreak pointを   (gdb) break lread.c:2942   とlread.cの2942行目で張っておきます。   - src/lread.c  数値のパース 2919:     register char *p1; 2920:     register Lisp_Object val; 2921:     p1 = read_buffer; 2922:     if (*p1 == '+' || *p1 == '-') p1++; 2923:     /* Is it an integer? */ 2924:     if (p1 != p) 2925:       { 2926:            while (p1 != p && (c = *p1) >= '0' && c < = '9') p1++; 2927:     /* Integers can have trailing decimal points.  */ 2928:     if (p1 > read_buffer && p1 < p && *p1 == '.') p1++; 2929:     if (p1 == p) 2930:         /* It is an integer. */ 2931:       { 2932:         if (p1[-1] == '.') 2933:           p1[-1] = '\0'; 2934:           /* Fixme: if we have strtol, use that, and check 2935:              for overflow.  */ 2936:         if (sizeof (int) == sizeof (EMACS_INT)) 2937:           XSETINT (val, atoi (read_buffer)); 2938:         else if (sizeof (long) == sizeof (EMACS_INT)) 2939:           XSETINT (val, atol (read_buffer)); 2940:         else 2941:           abort (); 2942:         return val; 2943:       } 2944:       }   *scratch*で (+ 2 3) のようなS式をC-jで評価すると上記のbreak pointで処理が停止します。   (gdb) print read_buffer   読み込み中のbufferの中身を覗いてみると、「$6 = 0x84ab5c8 "2"」のようにアドレスと そのアドレス先が保持している中身の"2"が表示されている事がわかります。 "2"という値がLisp_Objectのvalにセットされread1の返り値としてreturnされます。 数値をパースしている主要部分は2926行目〜2929行目でポインタpはS式の区切りとなる"\"';()[]#" などの文字が発見された場所のポインタを指し示しています。   Emacsにはgdbでデバッグしやすいように便利な設定がしてあり、それが src/.gdbinit に定義されています。 .gdbinitはgdbで使えるマクロ集です。   - src/.gdbinit 512:define xtype 513:  xgettype $ 514:  output $type 515:  echo \n 516:  if $type == Lisp_Misc 517:    xmisctype 518:  else 519:    if $type == Lisp_Vectorlike 520:      xvectype 521:    end 522:  end 523:end   例えばxtypeマクロは今調べているカレントのオブジェクトのLisp Typeを調べます。 使い方は以下のようになります。   (gdb) print val $35 = <value optimized out> (gdb) xtype Lisp_Int (gdb) xint $36 = 0 (gdb)   まずは調べたい変数をprintで表示し、カレントオブジェクトの$に暗黙的にセットします。 次にLisp Typeをxtypeマクロで調べ、typeに合わせたマクロをxintマクロ等(他にはxstring, xsymbolマクロ等があります)で呼び出しています。     * 評価 S式の評価は lisp/emacs-lisp/lisp-mode.el 696行目の"eval"によって行われます。 eval関数はLispプリミティブでsrc/eval.cで定義されています。   - src/eval.c  Feval関数 2243:DEFUN ("eval", Feval, Seval, 1, 1, 0, 2244:       doc: /* Evaluate FORM and return its value.  */) 2245:     (form) 2246:     Lisp_Object form; 2247:{ 2248:  Lisp_Object fun, val, original_fun, original_args; 2249:  Lisp_Object funcar; ... 2280:  original_fun = Fcar (form); 2281:  original_args = Fcdr (form);   formはevalの引数に与えられたS式で、2280,2281行目で関数部分(original_fun)と引数部分(original_args)に分離されます。 以後はこのoriginal_funに引数original_argsを適用し評価していきます。   - src/eval.c  Fevalの主要部分 2304:  if (SUBRP (fun)) 2305:    { 2306:      Lisp_Object numargs; 2307:      Lisp_Object argvals[8]; 2308:      Lisp_Object args_left; 2309:      register int i, maxargs; 2310: 2311:      args_left = original_args;   2312:      numargs = Flength (args_left); ... 2320:      if (XSUBR (fun)->max_args == UNEVALLED) 2321:      { 2322:        backtrace.evalargs = 0; 2323:        val = (*XSUBR (fun)->function) (args_left); 2324:        goto done; 2325:      } 2326: 2327:      if (XSUBR (fun)->max_args == MANY) 2328:      { 2329:      /* Pass a vector of evaluated arguments */ 2330:        Lisp_Object *vals; 2331:        register int argnum = 0; 2332: 2333:      vals = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object)); ... 2339:        while (!NILP (args_left)) 2340:          { 2341:            vals[argnum++] = Feval (Fcar (args_left)); 2342:            args_left = Fcdr (args_left); 2343:            gcpro3.nvars = argnum; 2344:          } ... 2349:        val = (*XSUBR (fun)->function) (XINT (numargs), vals); 2350:        UNGCPRO; 2351:        goto done; 2352:      } ... 2358:      maxargs = XSUBR (fun)->max_args; 2359:      for (i = 0; i < maxargs; args_left = Fcdr (args_left)) 2360:      { 2361:        argvals[i] = Feval (Fcar (args_left)); 2362:        gcpro3.nvars = ++i; 2363:      } ... 2370:      switch (i) 2371:      { 2372:      case 0: 2373:        val = (*XSUBR (fun)->function) (); 2374:        goto done; 2375:      case 1: 2376:        val = (*XSUBR (fun)->function) (argvals[0]); 2377:        goto done; ... 2403:      case 8: 2404:        val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2], 2405:       argvals[3], argvals[4], argvals[5], 2406:   argvals[6], argvals[7]); 2407:        goto done;   2304行目のSUBRPはS式のパース時(read時)にdefsubr関数(src/lread.c 3850行目)で定義されている関数かどうかチェックします。 すなわちLispプリミティブな関数かどうかをチェックしています。 次に引数のチェックが2320行目、2327行目にあります。これはDEFUNマクロでmaxargsに指定する値のチェックで UNEVALLEDは引数を評価しなくていい場合、MANYは可変長な引数をとれる場合に指定します。 UNEVALLEDの場合、2323行目で引数を評価せずに渡しています。MANYの場合2339行目〜2344行目で可変長引数をそれぞれ評価しています。 maxargsが数値で定義されている場合は2358行目からの処理になり、2359行目〜2363行目で引数を評価します。 2370行目からのswitch文で引数の数に応じた関数の呼び方をしています。   - src/eval.c   2417:  if (COMPILEDP (fun)) 2418:    val = apply_lambda (fun, original_args, 1); 2419:  else 2420:    { ... 2433:      if (EQ (funcar, Qmacro)) 2434:      val = Feval (apply1 (Fcdr (fun), original_args)); 2435:      else if (EQ (funcar, Qlambda)) 2436:      val = apply_lambda (fun, original_args, 1); 2437:      else 2438:      xsignal1 (Qinvalid_function, original_fun); 2439:    }   SUBRP以外の関数は2417行目〜2439行目で処理されます。 2417行目はバイトコードにコンパイル済みの式かどうかをチェックし、そうであればapply_lambda関数を呼び出しています。 2433行目はマクロかどうかのチェックで、マクロの場合は2434行目でマクロのbody部に引数(original_args)を適用(Fapply)した構文木を再度evalしています。 2435行目はlambda適用かどうかのチェックで、そうであればapply_lambdaを呼び出しています。     * 終わりに 今回はEmacs Lispの実装を、lisp-interaction-modeでS式を評価して掘り下げていくという視点で紹介しました。 解説した内容はEmacs Lisp実装のほんの一部にしかすぎません。gdbでLispプリミティブがどのように評価されていくのかを 調べてみたり、新しいLispプリミティブをDEFUNマクロを使って定義して遊んでみるのもいいかもしれません。

Tweet

Leave a Reply

Cancel

You must be logged in to post a comment.