インラインアセンブリ "\ n->"＃sym "％0" #val とは何なんですか？

Question

リンク内容

   #define DEFINE(sym, val) \
        asm volatile("\n->" #sym " %0 " #val : : "i" (val)) 

上記のインラインアセンブリは一体なんですか？

①"\n->" #sym " %0 " #val
②: : "i" (val)

「1」
関連ありそう質問
コメントを見ると

"\n->" #sym " %0 " #val

上記自体が１つの文字列として要約されると書かれています。

リンク内容
"\n->" #sym " %0 " #val
↓
"\n->""sym" "％0" "val"

だと思っていましたがやっぱ違いますよね？

「2」
関連ありそうな内容のリンクを貼りました。
すべて拝見しましたがよくわかりませんでした・・・。

: : "i" (val)

は

:"=i"(val)
:"i"(val)

にでもなるのかなと思っていましたが
PTXがなんちゃらとか書かれているので
やっぱ違うのでしょうか？

リンク内容
リンク内容
リンク内容

検索にかけて調べていたのですが結局成果は１つもなしで分からずじ終いに終わりました。
分からないので教えてください。

Comments

[ikadzuchi]

コードは打ち直すのではなくコピー&ペーストしてください。
転記ミスがあると回答者が間違った問題を考えてしまい時間の無駄です。

[kazuyakazuya]

＞コードは打ち直すのではなくコピー&ペーストしてください。

どっかミスっていましたか？
（すべてコピペのはずだけど・・・）

[thkana]

少なくともCのプログラムで'、'とか'＃'とかありえない。

[kazuyakazuya]

#define DEFINE(sym, val) \
asm volatile("\n->" #sym " %0 " #val : : "i" (val))

これですか？

https://elixir.bootlin.com/linux/v2.6.17.8/source/arch/alpha/kernel/asm-offsets.c#L13

だったら間違いなくそのように書かれていますが・・・

[ikadzuchi]

すべてコピペというのは質問内での話でしょうか。
そうではなく「リンク内容」のページからコピペしてほしいのです。
軽く見て全角文字になっている箇所とスペースの有無が異なる箇所が以下のようにあります。(あと2行目のインデントも無い)
#define DEFINE全角（sym、val全角）\スペース
asm volatile全角（スペース"\スペースn->"全角＃sym "スペース無し全角％0スペース無し" #val全角：全角： "i"全角（val全角）全角）スペース×2

> これですか？
それはコピペしたものですね。質問文もそのようにしていただきたいのです。

[kazuyakazuya]

訂正いたしました。

[ikadzuchi]

OKです。

Answer 1

Kbuildとセットで読む必要があります。

というのも、asm-offsets.cは通常の.cファイルと目的が違い
最終的に作りたいのはasm-offsets.hなのです。

そのために、インラインアセンブラの.s生成機能を文書生成機として用い
sedによって置換を行っています。

---

DEFINE(TI_TASK, offsetof(struct thread_info, task));
DEFINE(TI_FLAGS, offsetof(struct thread_info, flags));

↓

-> TI_TASK $0 offsetof(struct thread_info, task)
-> TI_FLAGS $16 offsetof(struct thread_info, flags)

↓

#define TI_TASK 0 /* offsetof(struct thread_info, task) */
#define TI_FLAGS 16 /* offsetof(struct thread_info, flags) */

Comments

[kazuyakazuya]

回答ありがとうございます。

正直今のところ言っている意味が分かりませんが
まずそもそもKbuildとは何ですか？
（今回の話とどう関係してくるのでしょうか？）
条件コンパイルみたいなものですか？

[asm]

Kbuildはビルドスクリプトです。
Makefileのファイル名だけ変わったやつですね。

[kazuyakazuya]

asm-offsets.h　とは結局何をするためのものなんですか？

[asm]

OSを作った場合
自作OSをコンパイルするホストと、自作OS上で動くターゲット　２つのコンパイラがあります。
sizeof(構造体)などの結果はホストのコンパイラに依存し場合によってはターゲットでのsizeof(構造体)とは別になることがあります。

というわけで、ホストコンパイラでそういった数値を計算させヘッダに定数としてまとめてるわけですね

[kazuyakazuya]

今私はgccを使っていますがそれはホストコンパイラですよね？
逆にターゲットコンパイラとは具体的になんでしょうか？

仮に自作OSを作ったとして
ホストコンパイラを使わずわざわざターゲットコンパイラを作って利用する理由がよく
わからないです・・・。

[asm]

セルフホスティングは機能のアピールとして有用だと思いますが。

失礼しました読み違えていたようです。
> Generate definitions needed by assembly language modules.
ですので、この場合アセンブリ用の定義でした。

[kazuyakazuya]

つまり、Kbuild以降の話は間違いで
これらはただのプログラム実行用のマクロ定義ということですか？

[asm]

ターゲットコンパイラの話は今回関係なかったということです。
Kbuildによってasm-offsets.cからasm-offsets.hが生成されているのは間違いありません。

ただのマクロ定義というのはあっているような間違っているような微妙な感じです。
確かに生成された.hファイル自体は単なる定数のマクロ定義といっていいですが
.cファイルを主に見ていくと、コンパイラによる処理のあとに#define命令を生成しています。

[kazuyakazuya]

追記された内容を見ると
マクロ名DEFINE　引数は（要約）
1：定義したいマクロ名
2: 処理内容　構造体の要素のオフセット
という感じで新たにプログラム内でマクロを定義できるもの（？）のように見えるのですが
この理解は合っていますか？

[asm]

プログラム内とは少し違うように思います。
あくまでも、「コンパイル」（と少しの後処理）することで「ヘッダ」を生成するための命令です。

DEFINE(TI_TASK, offsetof(struct thread_info, task))
↓
(CPPによる置換)
↓
asm volatile("\n->TI_TASK %0 offsetof(struct thread_info, task)" : : "i" (offsetof(struct thread_info, task)))
↓
(gccによる.sへのコンパイル)
↓

-> TI_TASK 0 offsetof(struct thread_info, task)
↓
(sedによる文字列処理によって.hファイルを生成)
↓
#define TI_TASK 0 /* offsetof(struct thread_info, task) */

です。

[kazuyakazuya]

では最後に・・・

DEFINE(TI_TASK, offsetof(struct thread_info, task));

↓

#define TI_FLAGS 16 /* offsetof(struct thread_info, flags) */

上記のようになるようですが
https://elixir.bootlin.com/linux/v2.6.17.8/source/Kbuild
これをどのように見れば上記のように置き換えられるのですか？

[asm]

まず、
arch/$(ARCH)/kernel/asm-offsets.s: arch/$(ARCH)/kernel/asm-offsets.c FORCE
この行の意味は、asm-offsets.cからasm-offsets.sを作る　という意味です。

次に
$(obj)/$(offsets-file): arch/$(ARCH)/kernel/asm-offsets.s Kbuild
とあるので同様に
offsets-file := include/asm-$(ARCH)/asm-offsets.h
がasm-offsets.sから作られています。

.c→.sについては、/scripts/Kbuild.includeや/scripts/Makefile.buildを読んだりと大変な割に
$(call if_changed_dep,cc_s_c)から想像できる「.cが変化してたら$(CC)を用いて.sへコンパイル」と大差ないので省略します。

.s→.hは$(call cmd,offsets)によってcmd_offsetsが呼び出され
cmd_offsetsで、sed -ne $(sed-y) $<; によって依存ファイル(.s)から
"/^->/{s:^->([^ ]*) [$$#]*([^ ]*) (.*):#define \1 \2 /* \3 */:; s:->::; p;}"
で正規表現による置換を行った結果として
#define ～
になっています。

[kazuyakazuya]

（書き方悪かったので再度）
Kbuildというカーネルをビルドするためのコマンド集（・・・？）があり

-> TI_TASK 0 offsetof(struct thread_info, task)

ここまで展開された式がそのsedコマンドによってさらに以下のように展開されるということですよね？

#define TI_TASK 0

最初から#define TI_TASK 0 このように定義していればsedコマンドを使わずに済む気がするのですが
どうしてもsedコマンドを使わなければいけない理由でもあるのでしょうか？

[asm]

0というのはoffsetof(struct thread_info, task)の結果です。
その結果を得るためにはCコンパイラによる計算が必要です。

そして、Cコンパイラはhファイルへ出力するようにはできていません。

[kazuyakazuya]

つまり・・・
コンパイルのより先にプリプロセッサによりマクロの置き換えが行われるから
offsetofの結果に応じてマクロを定義することができない。
から～・・・という感じですか？

(sedによる文字列処理によって.hファイルを生成)
↓
#define TI_TASK 0 /* offsetof(struct thread_info, task) */

このsedによる文字の置き換えで具体的に何を置き換えているんですか？

[asm]

> offsetofの結果に応じてマクロを定義することができない。
そうです。

.sファイルに出力された「-> TI_TASK 0 offsetof(struct thread_info, task)」といった文字列を
「#define TI_TASK 0 /* offsetof(struct thread_info, task) */」に置換したものを集めています。

[kazuyakazuya]

DEFINE(TI_TASK, offsetof(struct thread_info, task))
↓
(CPPによる置換)
↓
asm volatile("\n->TI_TASK %0 offsetof(struct thread_info, task)" : : "i" (offsetof(struct thread_info, task)))
↓
(gccによる.sへのコンパイル)
↓

-> TI_TASK 0 offsetof(struct thread_info, task)
↓
(sedによる文字列処理によって.hファイルを生成)
↓
#define TI_TASK 0 /* offsetof(struct thread_info, task) */

プリプロセッサによる置換は
asm volatile("\n->TI_TASK %0 offsetof(struct thread_info, task)" : : "i" (offsetof(struct thread_info, task)))
この時点で行われているから
新たに#define TI_TASK 0 を定義しても意味ない気がするのですが
どういった手順で置換されるのでしょうか？

[asm]

> 新たに#define TI_TASK 0 を定義しても意味ない気がするのですが

いいえ、新たに
#define TI_TASK 0
が定義されているasm-offsets.hが生成されます。

それを、別のソースからincludeする事で使うことができます。

[kazuyakazuya]

既にプリプロセッサに置換されたあとに
#defineでマクロ定義しても意味ないのではないか？ということです

[asm]

生産したasm-offsets.hを、別のソースから#includeします。
asm-offsets.cとは関係ないのでCPPからやり直しです。(#includeの時点でCPP必要ですが)

[kazuyakazuya]

なんか前提から認識がおかしい部分があると思うのですが・・・

asm-offsets.hに#define TI_TASK 0が定義されると思うのですが
プリプロセッサによる置換はいつ行われているんですか？

(CPPによる置換)
↓
asm volatile("\n->TI_TASK %0 offsetof(struct thread_info, task)" : : "i" (offsetof(struct thread_info, task)))

それとも
その後ですか？

[asm]

asm-offsets.cのコンパイルとしては、そのCPPによる置換という部分がプリプロセッサによる置換で正しいです。

asm-offsets.hとしては、それを利用するソースのコンパイル時なのでその後です。

Answer 2

// gen.c
#define DEFINE(sym, val) \
        asm volatile("\n->" #sym " %0 " #val : : "i" (val))

#define BLANK() asm volatile("\n->" : : )

void foo(void)
{
    DEFINE(SIZE_PTR, sizeof(void*));
}

gcc -fverbose-asm -S gen.c -o gen.s

結果

        .file   "gen.c"
 # GNU C17 (GCC) version 9.1.0 (x86_64-pc-msys)
 #      compiled by GNU C version 9.1.0, GMP version 6.1.2, MPFR version 4.0.2, MPC version 1.1.0, isl version isl-0.21-GMP

 # warning: GMP header version 6.1.2 differs from library version 6.2.0.
 # GGC heuristics: --param ggc-min-expand=100 --param ggc-min-heapsize=131072
 # 渡されたオプション:
 # -idirafter /usr/lib/gcc/x86_64-pc-msys/9.1.0/../../../../lib/../include/w32api
 # -idirafter /usr/lib/gcc/x86_64-pc-msys/9.1.0/../../../../x86_64-pc-msys/lib/../lib/../../include/w32api
 # gen.c -mtune=generic -march=x86-64 -auxbase-strip gen.s -fverbose-asm
 # 有効オプション:  -faggressive-loop-optimizations -fassume-phsa
 # -fasynchronous-unwind-tables -fauto-inc-dec -fcommon
 # -fdelete-null-pointer-checks -fdwarf2-cfi-asm -fearly-inlining
 # -feliminate-unused-debug-types -ffp-int-builtin-inexact -ffunction-cse
 # -fgcse-lm -fgnu-runtime -fgnu-unique -fident -finline-atomics
 # -fipa-stack-alignment -fira-hoist-pressure -fira-share-save-slots
 # -fira-share-spill-slots -fivopts -fkeep-inline-dllexport
 # -fkeep-static-consts -fleading-underscore -flifetime-dse
 # -flto-odr-type-merging -fmath-errno -fmerge-debug-strings -fpeephole
 # -fpic -fplt -fprefetch-loop-arrays -freg-struct-return
 # -fsched-critical-path-heuristic -fsched-dep-count-heuristic
 # -fsched-group-heuristic -fsched-interblock -fsched-last-insn-heuristic
 # -fsched-rank-heuristic -fsched-spec -fsched-spec-insn-heuristic
 # -fsched-stalled-insns-dep -fschedule-fusion -fsemantic-interposition
 # -fset-stack-executable -fshow-column -fshrink-wrap-separate
 # -fsigned-zeros -fsplit-ivs-in-unroller -fssa-backprop -fstdarg-opt
 # -fstrict-volatile-bitfields -fsync-libcalls -ftrapping-math
 # -ftree-cselim -ftree-forwprop -ftree-loop-if-convert -ftree-loop-im
 # -ftree-loop-ivcanon -ftree-loop-optimize -ftree-parallelize-loops=
 # -ftree-phiprop -ftree-reassoc -ftree-scev-cprop -funit-at-a-time
 # -funwind-tables -fverbose-asm -fzero-initialized-in-bss
 # -m128bit-long-double -m64 -m80387 -maccumulate-outgoing-args
 # -malign-double -malign-stringops -mavx256-split-unaligned-load
 # -mavx256-split-unaligned-store -mfancy-math-387 -mfentry -mfp-ret-in-387
 # -mfxsr -mieee-fp -mlong-double-80 -mmmx -mno-sse4 -mpush-args -mred-zone
 # -msse -msse2 -mstack-arg-probe -mstackrealign -mvzeroupper

        .text
        .globl  foo
        .def    foo;    .scl    2;      .type   32;     .endef
        .seh_proc       foo
foo:
        pushq   %rbp     #
        .seh_pushreg    %rbp
        movq    %rsp, %rbp       #,
        .seh_setframe   %rbp, 0
        .seh_endprologue
 # gen.c:8:     DEFINE(SIZE_PTR, sizeof(void*));
/APP
 # 8 "gen.c" 1

->SIZE_PTR $8 sizeof(void*)      #
 # 0 "" 2
 # gen.c:9: }
/NO_APP
        nop
        popq    %rbp     #
        ret
        .seh_endproc
        .ident  "GCC: (GNU) 9.1.0"

ここから、行頭の->を目印に抽出して置換し

// gen.h
#define SIZE_PTR 8 /* sizeof(void*) */

を作り

# other.S
#include "gen.h"
push SIZE_PTR

gcc -c other.S (拡張子が大文字のSな事に注意)

的に使います。

Comments

[kazuyakazuya]

ということはアセンブルした段階でsizeofの結果が出ているということですか？

[asm]

そうですね。

[kazuyakazuya]

実際にやってみてできました。
詳しく対応していただきありがとうございました。