1.1. bash

1.2. 環境とツール

2.1. システム構成

図2.1. bashの基本アーキテクチャ図

2.2. 主なデータ構造

/* A structure which represents a word. */
typedef struct word_desc {
  char *word; /* Zero terminated string. */
  int flags; /* Flags associated with this word. */
} WORD_DESC;

/* A linked list of words. */
typedef struct word_list {
  struct word_list *next;
  WORD_DESC *word;
} WORD_LIST;

bashはWORD_DESCやWORD_LIST構造体を使って、さらにセマンティックな処理が必要な文字列をカプセル化することができる。

WORD_DESC 構造体は、文字ポインタをラップする層であり、文字列記述子と呼ばれることがある。WORD_DESC 構造体は、フラグビットのコレクションを文字ポインタに付加します。フラグビットには、W_HASDOLLAR、W_QUOTED、W_DQUOTE、W_GLOBEXPなどがあり、それぞれ文字列に"$"、引用符、ダブルクォート、ワイルドカードなどが含まれることを示し、変数置換やワイルドカード展開などの際に該当する文字列を扱いやすくするために用意されているものです。

WORD_LIST 構造体は、WORD_DESC オブジェクトの連鎖である。

/* What a command looks like.
typedef struct command {
  enum command_type type; /* FOR CASE WHILE IF CONNECTION or SIMPLE. */
  int flags; /* Flags controlling execution environment. */
  int line; /* line number the command starts on */
  REDIRECT *redirects; /* Special redirects for FOR CASE, etc. */
  union {
    struct for_com *For;
    struct case_com *Case;
    struct while_com *While;
    struct if_com *If;
    struct connection *Connection;
    struct simple_com *Simple;
    struct function_def *Function_def;
    struct group_com *Group;
#if defined (SELECT_COMMAND)
    struct select_com *Select;
#endif
#if defined (DPAREN_ARITHMETIC)
    struct arith_com *Arith;
#endif
#if defined (COND_COMMAND)
    struct cond_com *Cond;
#endif
#if defined (ARITH_FOR_COMMAND)
    struct arith_for_com *ArithFor;
#endif
    struct subshell_com *Subshell;
  } value;
} COMMAND;

COMMAND 構成は、bash コマンドを記述します。quot;command" の概念は、構文パーサーが区切り文字、パイプ、制御文を通して解析する比較的独立した実行単位を指し、内部または外部のコマンド、関数、制御構造、算術式などが含まれます。

列挙型パラメータは、コマンドオブジェクトが表現するコマンドが上記のどのタイプに属するかを示す。整数変数flagsは、以下のような実行環境に関するフラグビットの集合を記録する。

/* Possible values for command->flags. */
#define CMD_WANT_SUBSHELL 0x01 /* User wants a subshell: ( command ) */
#define CMD_FORCE_SUBSHELL 0x02 /* Shell needs to force a subshell. */
#define CMD_INVERT_RETURN 0x04 /* Invert the exit value. */
#define CMD_IGNORE_RETURN 0x08 /* Ignore the exit value. for set -e. */
#define CMD_NO_FUNCTIONS 0x10 /* Ignore functions during command lookup. */
#define CMD_INHIBIT_EXPANSION 0x20 /* Do not expand the command words. */
#define CMD_NO_FORK 0x40 /* Don't fork; just call execve */
#define CMD_TIME_PIPELINE 0x80 /* Time a pipeline */
#define CMD_TIME_POSIX 0x100 /* time -p; use POSIX.2 time output spec.
#define CMD_AMPERSAND 0x200 /* command & */
#define CMD_STDIN_REDIR 0x400 /* async command needs implicit </dev/null */
#define CMD_COMMAND_BUILTIN 0x0800 /* command executed by `command' builtin */

整数変数 line は、このコマンドがスクリプトの中で何行目にあるかを示す。ポインタ redirects は、このコマンドのリダイレクト情報を記述した REDIRECT 構造体オブジェクトを指します。最後に、異なるコマンドタイプのために、COMMAND構造体は、異なるコマンドタイプのための特定の内部構造体のユニオンを含んでいます。

内部コマンド、外部コマンドには、主にコマンド名とコマンドラインパラメータを記録する、ユニオンのsimple_com構造体を使用します。これらは、WORD_LIST チェーンテーブル構造体に格納され、テーブル要素ノードは、WORD_DESC 構造体である。

分岐やループなどの制御構造については、その内部構造には主に当該制御フローに対応するコマンドへのポインタが含まれる。例えば、while_com構造体はテスト条件とループ本体に対応するコマンドへのポインタを含み、if_com構造体はテスト条件、真値実行体、偽値実行体に対応するコマンドへのポインタを含む。

関数定義の場合、function_def 構造体は、関数名を表す WORD_DESC 構造体へのポインタ、関数に対応するコマンドへのポインタ、関数が指定されているファイル名へのポインタからなる。

/* Structure describing a redirection.
   (or translator in redir.c) encountered an out-of-range file descriptor. */
typedef struct redirect {
  struct redirect *next; /* Next element, or NULL. */
  int redirector; /* Descriptor to be redirected. */
  int flags; /* Flag value for `open'. */
  enum r_instruction instruction; /* What to do with the information. */
  REDIRECTEE redirectee; /* File descriptor or filename */
  char *here_doc_eof; /* The word that appeared in <<foo. */
} REDIRECT;

REDIRECT構造体は、コマンドの入出力リダイレクトを定義するものです。1つのコマンドに対して複数の（入力、出力、エラー）リダイレクトを設定できるので、REDIRECT構造体自体に次のREDIRECTオブジェクトへのポインタがあり、コマンドに対してリダイレクトの連鎖を形成することができます。

整数のパラメータ redirector はリダイレクト元のファイルディスクリプタであり、フラグビットのセット flags はターゲットファイルのオープン方法を定義する。命令列挙はリダイレクトの具体的なタイプを定義し、それらは以下のものを含む。

/* Instructions describing what kind of thing to do for a redirection. */
enum r_instruction {
  r_output_direction, r_input_direction, r_inputa_direction,
  r_appending_to, r_reading_until, r_reading_string,
  r_duplicating_input, r_duplicating_output, r_deblank_reading_until,
  r_close_this, r_err_and_out, r_input_output, r_output_force,
  r_duplicating_input_word, r_duplicating_output_word,
  r_move_input, r_move_output, r_move_input_word, r_move_output_word
};

リダイレクトの対象はREDIRECTEEユニオンに記録され、ファイル名やファイルディスクリプタにすることができる。定義は以下の通りである。

/* What a redirection descriptor looks like. If the redirection instruction
   If the redirection instruction is ri_duplicating_input or ri_duplicating_output, use DEST, otherwise use the file in FILENAME.
   Out-of-range descriptors are identified by a
   negative DEST. */

typedef union {
  int dest; /* Place to redirect REDIRECTOR to, or ... */
  WORD_DESC *filename; /* filename to redirect to. */
} REDIRECTEE;

また、Here Document 型リダイレクションの場合、REDIRECT 構造体の here_doc_eof ポインタは Here Document を指す。

bash自体のシェル変数と、その中で実行される関数のローカル変数のコンテキストは、VAR_CONTEXT構造体に格納されています。

/* A variable context. */
typedef struct var_context {
  char *name; /* empty or NULL means global context */
  int scope; /* 0 means global context */
  int flags;
  struct var_context *up; /* previous function calls */
  struct var_context *down; /* down towards global context */
  HASH_TABLE *table; /* variables at this scope */
} VAR_CONTEXT;

VAR_CONTEXT の文字ポインタ name は，空の場合は bash のグローバルコンテキストを格納することを示し，それ以外の場合は関数のローカルコンテキストを示し，name はその関数名を指す．整数変数 scope は，このコンテキストのスタック上の階層数であり，0 はグローバルコンテキストを意味し，関数呼び出しのスコープが深くなるごとに 1 ずつ増加し，コンテキストのスコープが反映される．フラグのセットは，コンテキストがローカルか，関数に属しているか，内部コマンドに属しているか，一時的に作成されていないかを記録します．上下のポインタは，関数呼び出しスタック内の前と次のローカルコンテキストを指します．ハッシュテーブルの内容は、そのコンテキストの変数名と値の組である。

bashの変数は型を強調しないので、文字列と考えることができます。その格納構造は次の通りである。

typedef struct variable {
  char *name; /* Symbol that the user types. */
  char *value; /* Value that is returned. */
  char *exportstr; /* String for the environment. */
  sh_var_value_func_t *dynamic_value; /* Function called to return a `dynamic'
				   value for a variable, like $SECONDS
				   or $RANDOM. */
  sh_var_assign_func_t *assign_func; /* Function called when this `special
				   variable' is assigned a value in
				   bind_variable. */
  int attributes; /* export, readonly, array, invisible... */ */
  int context; /* Which context this variable belongs to. */
} SHELL_VAR;

文字ポインタの name と value は、それぞれコンテキスト変数の名前と値の文字列を指します。export環境変数の場合、exportstrは"name=value"のような形の文字列を指します。RANDOMのように動的に変化する値を返す変数については、関数ポインタ dynamic_value がその値を生成した関数を指す。特定の変数については、assign_func へのポインタにより、値を代入する際のコールバック関数を設定することができる。整数型変数属性は、コンテキスト変数がエクスポートされているか、読み取り専用か、非表示かなどのアクセシビリティを記録する。integer variable context は、コンテキスト変数がアクセス可能なスコープ内のローカル変数スタックのどのレベルに属しているかを記録します。

3.1. ルート

• shell.c/shell.h

  shell.c には main() 関数があり、シェルの起動時および実行時の状態をある程度定義し、さまざまな起動パラメータや環境変数などに基づいてシェルの作業状態（制限モードなどを含む）を初期化し、eval.c の対話型 reader_loop() 関数に入り、終了するまでコマンドをパースしています。

  初期化関数 shell_initialize() は variables.c の initialize_shell_variables() や set.c の initialize_shell_options() など一連のサブモジュール初期化関数を呼び出します。新しい機能モジュールを追加したい場合は、ここにその初期化呼び出しを記述してください。

  run_startup_files() 関数は ~/.profile, ~/.bash_profile, ~/.bash_login 設定ファイルを実行し、bash が sshd と rshd のどちらで起動されたかを判断します。ログインシェルでは ~/.bashrc は実行されません。非ログイン対話型シェル、または sshd や rshd によって起動されたシェルでは ~/.bashrc が実行されます。

  run_one_command() 関数は、-c 引数を指定してコマンドを実行するモードを処理します。

  open_shell_script()関数は、スクリプトファイルを実行するモードを扱います。

  終了関数exit_shell()は、ジョブのハングアップや履歴の保存などのアフターケアに使用します。

• eval.c

  シェルコマンドの実行を読み取り、解釈する。メインループは reader_loop() 関数で、 read_command() が構文解析器 y.tab.c 内の parse_command() を呼び、 parse_command() が yyparse() を呼び出してコマンドを取得した後、 reader_loop() が execute_cmd.c の execute_command() を呼び出してコマンドの実行を行います。

  注：トークン検索の優先順位：alias> keyword> function> internal command> script or executable.

• execute_cmd.c/execute_cmd.h

  コマンドを実行する（COMMAND構造体）。外部呼び出しインターフェースはexecute_command()で、内部ではexecute_command_internal()でコマンドが実行される。execute_command_internal()にはオプションでパイプラインリダイレクトとバックグラウンド動作用のパラメータが含まれる。

  異なるタイプのコマンド（制御構造、関数、演算など）に対して、execute_command_internal()は適切な機能を実現するために異なる関数を呼び出す。execute_builtin() は内部コマンドを実行し、 execute_disk_command() は外部ファイルを実行します。 execute_disk_command() は jobs.c または nojobs.c で make_child() を呼び出して新しいプロセスをフォークします。

  ファイルディスクリプタのビットマップは、このファイルで管理されます。

• make_cmd.c/make_cmd.h

  様々なコマンド、リダイレクト、その他の構文構造の例を構築するために必要な関数です。シンタックスパーサー、redir.c などから呼び出されます。

  make_redirection()は、コマンド構造体のリダイレクトパラメータを記入するところ。

• copy_command.c

  様々なCOMMAND構造体を再帰的にコピーするために使用される一連の関数。

  作者注：これは主に関数定義を作るために必要ですが、他の人が必要とすることはないでしょう。

• dispose_command.c/dispose_command.h

  COMMAND 構造体によって占有されているリソースをクリーンアップし、 dispose_redirects() によってリダイレクト文をクリーンアップしています。

• print_cmd.c

  コマンド構造体を印刷可能な文字列に変換します。execute_cmd.c の execute_command_internal() で呼び出される。

• redir.c/redir.h

  入出力リダイレクトの実装。コマンド構造体の redirects パラメータは、実行前に make_cmd.c によって埋められ、主に execute_cmd.c によって外部から呼び出されてリダイレクション処理が実行される。

  外部インタフェースは do_redirections() で、コマンド構造体を解析してリダイレクトパラメータを求め、内部的には do_redirection_internal() に委ねる。そして、リダイレクトの種類に応じて、redir_open() が通常の open(), redir_special_open(), noclobber_open() 関数を用いてリダイレクト先のファイル記述子をそれぞれオープンする。新しいリダイレクト方法 (例: FTP へのリダイレクト) を追加するには、ここにコードを追加することを検討してください。

  リダイレクトの原則については 参照 Unix/Linuxプログラミングチュートリアル実践編」の10.3項をご覧ください。

• paser.y

  yaccの構文定義ファイルです。

• y.tab.c/y.tab.h

  yaccが生成する構文解析器。

  トークンを解析し、make_cmd.c の関数を呼び出し、 execute_cmd.c の関数の実行を容易にするためのコマンド構造を生成する。

  これには、コマンド構造体のリダイレクトパラメータを記入するための make_redirection() の呼び出しが含まれる。

• alias.c/alias.h

  追加、削除、確認、変更など、エイリアス操作関連関数。内部コマンドのエイリアスは、このファイルにある関数を呼び出すことで実装されます。

• array.c/array.h/arrayfunc.c/arrayfunc.c

  文字列配列の定義と、配列に対するいくつかの高度な操作を実装した関連関数です。bashプログラムの文字列配列の中には、ここで定義されたARRAY構造体を使用するものがあります。

• bashansi.h

  コンパイラによって異なるシステムヘッダーファイルのインクルード関係を処理します。

• bashhist.c/bashhist.h

  コマンドヒストリー機能に関する機能（ヒストリーの開始、停止、インクリメント、チェックなど）です。

• bashintl.h

  locate.h、gettext.hなどの国際化対応を導入する。

• bashjmp.h

  setjmp.hをラップして、longjmp()の状態パラメータをいくつか定義しています。

• bashline.c/bashline.h

  コマンドの自動補完、emacsやviのような行編集機能などに対応するためのreadlineライブラリとのインターフェイスです。

• bashtypes.h

  単語の種類を定義する。

• bracecomp.c/braces.c

  braces ワイルドカードファイル名機能を使用する関数です。

• buildins.h

  内部コマンド構造体の基本構造を定義しています。

• command.h

  各種コマンドの構造体定義（制御構造、関数、演算処理、リダイレクトなど）。

• config.h/config-top.h/config-bot.h

  config.h は configure によって生成され、どの機能を bash にコンパイルするかを決定します。新しい機能を追加したい場合は、 "switch" マクロ定義を追加します。

• conftypes.h

  ホストアーキテクチャとオペレーティングシステムのタイプの名前を定義します。

• error.c/error.h

  エラー処理とレポート機能。

• expr.c

  算術式を処理する。外部呼び出しインタフェースはevalexp()です。

• externs.h

  独自のヘッダーファイルで宣言されていないいくつかの関数をソースファイル内で宣言します。

• findcmd.c/findcmd.h

  コマンド名で検索します。主にPATH変数の位置から外部の実行プログラムを探す。

• flags.c/flags.h

  標準のShフラグや非標準のフラグなど、個々のランタイムフラグを格納し、処理する。

• general.c/general.h

  多くのファイルに共通するような、基本的で不便なカテゴリの関数をいくつか紹介します。

• hashcmd.c/hashcmd.h

  ハッシュテーブルを管理します。主にコマンド名とフルパスの対応付けに使用します。

• hashlib.c/hashlib.h

  ハッシュテーブルのデータ構造です。

• input.c/input.h

  入力ストリームのバッファリングを処理する。

• jobs.c/jobs.h

  ジョブの制御です。主なエントリポイントはmake_child()で、プロセスの作成と実行に使用されます。

  jobs、fg、bg、killなどのコマンドの内部実装はこちらです。

  ジョブ管理の詳細なプロセスについては、まだ解析されていません。

• nojobs.c

  ジョブ制御を実装していないOS上で、jobs.cの代わりにコンパイルされます。

• リスト.c

  リンクされたテーブルのデータ構造。

• ロケール.c

  環境変数 "LC_" ファミリーの操作を含む、国際化に関連する関数です。

• lsignames.h/signames.h

  signames.h は、コンパイル時のヘルパーである mksignames によって生成され、そのソースコードは support サブディレクトリにあります。

• mailcheck.c/mailcheck.h

  アカウントのメールボックスをチェックする関数です。

• mksyntax.c

  mksyntax は字句解析ファイル syntax.c の生成に使用されます。

• syntax.c/syntax.h

  syntax.cはmksyntaxが生成する字句解析ファイル、syntax.hは字句解析作業に必要なマクロやフラグビットなどを定義しています。

• パーサー h

  parse.y と bashhist.c で必要となるデリミタスタック構造体 (struct dstack) の定義です。

• パッチレベル.h

  bashの修正バージョン番号を記録する。

• pathexp.c/pathexp.h

  ワイルドカード(グロビング)ライブラリへのインターフェイス。

• pathnames.h

  いくつかのオペレーティングシステム設定ファイルのパスを記録します。

• pcomplete.c/pcomplete.h/pcomplib.c

  プログラマブルコマンド補完機能。

• quit.h

  SIGINT信号に対する応答である汎用例外終了マクロを定義しています。

• sig.c/sig.h/siglist.c/siglist.h

  信号処理関連の関数です。

• stringlib.c

  文字列処理関連関数。文字列-整数キー-値ペア構造(ALIST)からデータ項目を検索する機能などが含まれます。

• サブスト.c/サブスト.h

  パラメータ、コマンドの置換・展開、演算、パス展開、引用符などを担当します。

• test.c/test.h

  GNUテストプログラム、様々な条件比較項目、一般的にシェルスクリプトで使用されます。

• トラップ.c

  trapコマンドを操作するために必要ないくつかのオブジェクトの関数です。

• unwind_prot.c/unwind_prot.h

  汎用的な関数実行の保護と終了処理機構。

• 変数.c/変数.h

  シェル変数を扱う。シェル変数と関数はそれぞれライフサイクルの異なるハッシュテーブルを使用して格納します。

  変数のリストは現在の環境によって初期化されます。bashはmain()のchar **env引数で渡された環境から開始します。

  関数の場合、スタックはローカル変数のコンテキストの保持と切り替えに使用されます。

• version.c/version.h

  bashのバージョン番号を表示します。

• xmalloc.c/xmalloc.h

  セキュア版 malloc ラッパー。

3.2. その他のディレクトリ

• ビルトイン

  このディレクトリには、内部コマンドのソースコードが含まれています。

  各内部コマンドはdefファイルであり、MakefileのDEFSRCはすべての内部コマンドのdefファイルを宣言しています。

  mkbuiltins は *.def ファイルを処理してコマンドの *.c ソースプログラムを生成し、 builins.c, builtext.h を生成する。builins.c と builtext.h はそれぞれの内部コマンドのインデックスと等価である。

  最後にすべてのファイルをコンパイルして、libbuiltins.aを得る。

  この例 テストは内部コマンドを追加します。

• クロスビルド

  このディレクトリのファイルは、他のシステムでのクロスビルドのためにキャッシュされる設定結果です。

• CWRU

  CWRUのものと思われる未解析の雑多なファイル。

• ドクター

  テ・ドックス

• 例

  スクリプトの例（拡張bashの検証に使用できる）。

• インクルード/ライブラリ

  bashに必要なヘッダ、ライブラリファイル（ソースコード）です。

• ポ

  国際化のための言語定義ファイル。

• サポート

  コンパイル時に必要なサポートツールとそのソースコードです。

• テスト

  makeテストに使用するテストスクリプトで、拡張bashの検証に使用することができます。

4.1. コマンドの構文解析と実行

4.2. リダイレクトの実装

4.3. 内部コマンド（ビルトイン）構築

例 4.1. 新しいquot;linjian"コマンドの作成

int linjian_builtin (list)
     WORD_LIST *list;
{
  printf ("This is a built-in for test by Lin Jian.\n");
  if (list)
    printf ("Parameter: %s\n", list->word->word);
  return (EXECUTION_SUCCESS);
}

# working under the original bash:.
lj@lj-laptop:~/bash-3.2$ ps
  PID TTY TIME CMD
 6212 pts/2 00:00:00 bash
 9893 pts/2 00:00:00 ps
lj@lj-laptop:~/bash-3.2$ linjian
-bash: linjian: command not found 
#Go to the modified bash.
lj@lj-laptop:~/bash-3.2$ . /bash
lj@lj-laptop:~/bash-3.2$ ps
  PID TTY TIME CMD
 6212 pts/2 00:00:00 bash
 9904 pts/2 00:00:00 bash
 9922 pts/2 00:00:00 ps
lj@lj-laptop:~/bash-3.2$ linjian hello!
This is a built-in for test by Lin Jian.
Parameter: hello!
lj@lj-laptop:~/bash-3.2$ type linjian
linjian is a shell builtin

4.4. 環境変数とコンテキスト

4.5. sshdからbashを起動する

4.6. サブシェル

5.1. bashのプログラミングスタイル