[ruby-dev:36917] VMまわりのシンボルにも「rb_」を付けてほしい

斎藤と申します。連投ですみません。

さて、rb_等のprefixが付いていないシンボルに対して何らかの措置をとるパッチを
一通り投げました。それらは以下のようにしてチェックしたものです。

$ nm -gD libruby-trunk.so|grep -v ' U '|
> egrep -iv ' (rb|ruby|Init|onig|st|_)'| awk '{print $3}'

この中でdln_*とnode*は何か理由がある、と聞いたので放置しておくとすると、
残りはYARVで導入されたもののようです。それらを以下に挙げます。

insn_make_insn_table
insns_name_array
iseq_build_from_ary
iseq_compile
iseq_load
iseq_translate_threaded_code
vm_collect_local_variables_in_heap
vm_cref
vm_debug_print_post
vm_debug_print_pre
vm_debug_print_register
vm_env_dump_raw
vm_get_insns_address_table
vm_get_ruby_level_caller_cfp
vm_get_ruby_level_next_cfp
vm_get_sourceline
vm_invoke_proc
vm_jump_tag_but_local_jump
vm_localjump_error
vm_make_env_object
vm_make_jump_tag_but_local_jump
vm_make_proc
vm_proc_dump_raw
vm_stack_dump_each
vm_stack_dump_raw
vm_stack_dump_raw_current
vm_stack_dump_th
vm_stack_to_heap
vm_thread_dump_regs
vm_thread_dump_state

これらにも rb_ を付けていただけないでしょうか。

以前ささださんにお会いした時、少しお話ししたのですが、これらは外部で利用して
ほしくないために、意図的に rb_ を省いているということでした。

しかし、「外部から使われたくない」ことと、rb_ がない(これまでの規約に反する)
ことで「名前がかぶる」という可能性は、分けて考える必要があるのではないで
しょうか。

たとえば皆さんご存知のとおり、VMという言葉は言語処理系に限らず、様々なレベルで
使われる言葉です。よってvm_というprefixだけだと、どんなVMか分かりません。
RubyVMを組み込んだ他の種類のVMが実装されれば、当然vm_というprefixが使われる
可能性があるでしょう。もっと言えば、Virtual Machineかどうかさえ分かりません。

そういった可能性を考えず rb_ を省くのはあまりうれしくない、と自分は考えます。
「これはRubyである」というrb_ prefixを付けた上でならば、名前がぶつかれば
「rb_はRubyで使われるから避けてね」と説明できるでしょうし、C APIの作者からも
わかりやすくなると思います。

それで、外部からの利用を意図しているAPIと区別がつかずに困る、というのであれば、
それはドキュメントで明示するのが本筋ではないかと思うのですが、どうでしょうか。


以下、単なるアイデアの羅列ですが:

もしシンボル名だけで、APIとして利用できる・して欲しくないの区別をつけるならば、
「rb_」の前に「_」を付けて「_rb_foo()」にする、というのはどうでしょうか。
いかにも触りたくない感じになります。

もう一つ、librubyの外からは見えないが、.cの間では見える、という設定法があります。
GNU拡張になりますが、 __attribute__((visibility("hidden"))) というのを
設定すると、外部からは見えなくなるそうです。(これは Binary Hacks #29の
受け売りです...)
この方法の問題は、GCC3以降しか使えないという点です。GCC 2.xやMS Cでは見えて
しまう(と思う)ので、環境によって見えたり見えなかったりするシンボルができる、
ということになります。

もっとも、上記二つのアイデアを合わせればもっとそれらしくなるかもしれません。
つまり、使って欲しくない関数はGCC3以降では見えず、その他のコンパイラで
コンパイルした場合でも _rb_ 接頭辞によって、「使ってほしくない」という
メッセージが送れる、といった具合です。

羅列終わり。


今のところこのメールで触れた以外には、prefixを付けて回る必要はなさそうです。
つい先ほど作業を始めましたが、去年よりもだいぶ減っていたので非常に助かりました。
意識してコミットしていただき、本当にありがとうございました。

ーー
斎藤ただし