Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[インデックス 17237] ファイルの概要

このドキュメントは、Go言語のランタイムにおけるWindowsビルドの修正に関するコミット（インデックス 17237）について、その技術的な詳細と背景を包括的に解説します。

コミット

  • コミットハッシュ: dd50dac56cdbbec2086b851e4b86f3ba2247b75d
  • 作者: Dmitriy Vyukov dvyukov@google.com
  • コミット日時: 2013年8月14日 22:18:49 +0400
  • 変更ファイル: src/pkg/runtime/mem_windows.c

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/dd50dac56cdbbec2086b851e4b86f3ba2247b75d

元コミット内容

runtime: fix windows build

R=golang-dev
CC=golang-dev
https://golang.org/cl/12941043

変更の背景

このコミットは、GoランタイムのWindowsビルドにおける潜在的な問題を修正することを目的としています。具体的には、GoランタイムがWindows APIのメモリ管理関数であるVirtualFreeおよびVirtualAllocを呼び出す際に、戻り値の型とエラーチェックの方法がWindows APIの仕様と完全に一致していなかったことが原因です。

Windows APIのこれらの関数は、成功時にはLPVOID（void*に相当）型のポインタを返し、失敗時にはNULLを返します。しかし、元のGoランタイムのCコードでは、これらの戻り値をuintptr（符号なし整数）型の変数で受け取り、エラーチェックを0との比較で行っていました。

C言語ではNULLは通常(void*)0として定義されますが、void*とuintptrの間には型変換のセマンティクスの違いが存在します。特に、ポインタを整数型にキャストして0と比較することは、コンパイラやアーキテクチャによっては警告を生成したり、予期せぬ動作を引き起こす可能性がありました。この不一致が、Windows環境でのGoランタイムのビルドプロセスにおいて問題を引き起こす可能性があったため、この修正が導入されました。

この変更により、GoランタイムのCコードがWindows APIの関数シグネチャに厳密に準拠し、より堅牢で移植性の高いメモリ管理が実現されます。

前提知識の解説

このコミットの理解を深めるために、以下の概念について解説します。

  • Goランタイム (Go Runtime): Go言語で書かれたプログラムを実行するために不可欠な低レベルのコンポーネント群です。これには、ガベージコレクション、ゴルーチンのスケジューリング、メモリ割り当て、システムコールとのインターフェースなどが含まれます。Goプログラムは、このランタイムの助けを借りてOS上で動作します。
  • Windows API (Application Programming Interface): Microsoft Windowsオペレーティングシステムが提供する関数、データ構造、およびプロトコルのセットです。アプリケーション開発者はWindows APIを利用して、ファイルシステムへのアクセス、メモリ管理、プロセスとスレッドの制御、グラフィカルユーザーインターフェースの描画など、OSの様々な機能を利用します。
  • VirtualAlloc 関数: Windows APIのメモリ管理関数の一つです。プロセスのアドレス空間内でメモリ領域を予約、コミット、または解放するために使用されます。
    • 予約 (Reserve): 仮想アドレス空間を確保しますが、物理メモリは割り当てません。
    • コミット (Commit): 予約された仮想アドレス空間に物理メモリ（またはページファイル上の領域）を割り当て、そのメモリをアクセス可能にします。
    • デコミット (Decommit): コミットされたメモリから物理メモリの割り当てを解除しますが、仮想アドレス空間は予約されたままにします。
  • VirtualFree 関数: VirtualAllocによって予約またはコミットされた仮想アドレス空間内のメモリ領域を解放またはデコミットするために使用されるWindows API関数です。
  • uintptr 型 (Go): Go言語における組み込みの数値型の一つで、ポインタを保持するのに十分な大きさを持つ符号なし整数型です。主に、GoのポインタとC言語のポインタの間で相互運用する際や、低レベルのメモリ操作を行う際に使用されます。uintptrはポインタの値を整数として扱うため、ポインタ演算は可能ですが、ガベージコレクタの対象外となります。
  • void * 型 (C言語): C言語における汎用ポインタ型です。特定のデータ型を指すのではなく、任意の型のデータへのポインタを指すことができます。void *型のポインタは、他のポインタ型に明示的にキャストすることなく、そのポインタが指すデータにアクセスすることはできません。Windows API関数は、しばしばメモリブロックへのポインタをvoid *として返します。
  • nil (Go) / NULL (C言語): ポインタが有効なメモリアドレスを指していないことを示す特殊な値です。Go言語ではnilが使用され、C言語ではNULLが使用されます。C言語のNULLは、通常、プリプロセッサマクロによって(void*)0または単に0として定義されます。これは、ポインタが「何も指していない」状態を表すために使用されます。
  • MEM_DECOMMIT フラグ: VirtualFree関数に渡されるフラグの一つです。このフラグを指定すると、指定されたメモリ領域の物理ストレージの割り当てが解除されますが、仮想アドレス空間は予約されたままになります。
  • MEM_COMMIT フラグ: VirtualAlloc関数に渡されるフラグの一つです。このフラグを指定すると、指定されたメモリ領域に物理ストレージが割り当てられ、そのメモリがアクセス可能になります。
  • PAGE_READWRITE フラグ: VirtualAlloc関数に渡されるフラグの一つです。このフラグを指定すると、コミットされたメモリ領域が読み取りおよび書き込み可能であることを示します。

技術的詳細

このコミットは、Goランタイムのsrc/pkg/runtime/mem_windows.cファイル内のruntime·SysUnused関数とruntime·SysUsed関数における、Windows APIのVirtualFreeおよびVirtualAlloc関数の戻り値の処理方法を修正しています。

元の実装では、VirtualFreeおよびVirtualAllocの戻り値をuintptr型の変数rで受け取っていました。そして、VirtualFreeの呼び出し後にはif(r == 0)という条件でエラーをチェックしていました。

しかし、Windows APIのドキュメントによると、VirtualFreeおよびVirtualAllocは成功時にはLPVOID（void*）を返し、失敗時にはNULLを返します。C言語においてNULLは通常(void*)0として定義されますが、uintptr（整数型）とvoid*（ポインタ型）の間には厳密な型変換のルールが存在します。ポインタを整数型にキャストして0と比較することは、一部のコンパイラや環境で型ミスマッチの警告を生成したり、最適化の際に予期せぬ動作を引き起こす可能性がありました。

この修正では、以下の変更が行われました。

  1. 戻り値の型変更: VirtualFreeおよびVirtualAllocの戻り値を受け取る変数の型をuintptrからvoid *に変更しました。これにより、Windows APIが返すLPVOID型に直接対応し、型安全性が向上します。
  2. エラーチェックの変更: VirtualFreeの戻り値のエラーチェックをif(r == 0)からif(r == nil)に変更しました。GoランタイムのCコードでは、nilはC言語のNULLポインタに相当します。この変更により、Windows APIが失敗時に返すNULLとの比較がより正確かつセマンティックに正しい形になりました。

runtime·stdcallは、GoランタイムがWindows API関数を呼び出すための内部的なヘルパー関数です。これは、Goの低レベルコードからCの標準呼び出し規約（__stdcall）を使用するWindows API関数を安全に呼び出すためのラッパーとして機能します。

この修正は、GoランタイムのWindowsビルドの堅牢性を高め、異なるコンパイラやWindowsのバージョン間での互換性の問題を回避することを目的としています。

コアとなるコードの変更箇所

--- a/src/pkg/runtime/mem_windows.c
+++ b/src/pkg/runtime/mem_windows.c
@@ -32,17 +32,17 @@ runtime·SysAlloc(uintptr n)
 void
 runtime·SysUnused(void *v, uintptr n)
 {
-	uintptr r;
+	void *r;

 	r = runtime·stdcall(runtime·VirtualFree, 3, v, n, (uintptr)MEM_DECOMMIT);\n-\tif(r == 0)\n+\tif(r == nil)\n     	\truntime·throw(\"runtime: failed to decommit pages\");
 }\n \n     void
 runtime·SysUsed(void *v, uintptr n)
 {
-	uintptr r;
+	void *r;

 	r = runtime·stdcall(runtime·VirtualAlloc, 4, v, n, (uintptr)MEM_COMMIT, (uintptr)PAGE_READWRITE);\n     	if(r != v)\n```

## コアとなるコードの解説

上記の差分は、`src/pkg/runtime/mem_windows.c`ファイル内の2つの主要な関数、`runtime·SysUnused`と`runtime·SysUsed`に対する変更を示しています。

1.  **`runtime·SysUnused` 関数**:
    *   この関数は、Goランタイムが使用しなくなったメモリ領域をWindows OSにデコミット（物理メモリの割り当てを解除）するために、`VirtualFree`関数を呼び出します。
    *   **変更前**: `uintptr r;` と宣言されており、`VirtualFree`の戻り値を`uintptr`型の変数`r`で受け取っていました。エラーチェックは`if(r == 0)`で行われていました。
    *   **変更後**: `void *r;` に変更されました。これにより、`VirtualFree`が返す`LPVOID`（`void*`）型に直接対応するようになりました。エラーチェックも`if(r == nil)`に変更され、C言語の`NULL`ポインタとの比較に統一されました。これは、`VirtualFree`が失敗時に`NULL`を返すというWindows APIの仕様に合致しています。

2.  **`runtime·SysUsed` 関数**:
    *   この関数は、Goランタイムが使用する新しいメモリ領域をWindows OSからコミット（物理メモリを割り当ててアクセス可能にする）するために、`VirtualAlloc`関数を呼び出します。
    *   **変更前**: `uintptr r;` と宣言されており、`VirtualAlloc`の戻り値を`uintptr`型の変数`r`で受け取っていました。
    *   **変更後**: `void *r;` に変更されました。これにより、`VirtualAlloc`が返す`LPVOID`（`void*`）型に直接対応するようになりました。
    *   この関数では、`VirtualAlloc`の戻り値`r`が引数として渡されたアドレス`v`と異なる場合にエラーと判断しています（`if(r != v)`）。この比較自体は`uintptr`でも`void*`でも論理的には問題ありませんが、戻り値の型を`void*`に統一することで、コード全体の一貫性と型安全性が向上します。

これらの変更は、GoランタイムがWindows APIとより正確かつ安全に連携できるようにするための重要な修正であり、特に低レベルのメモリ管理における潜在的なバグやビルドエラーを防ぐ効果があります。

## 関連リンク

*   Go Code Review (CL 12941043): [https://golang.org/cl/12941043](https://golang.org/cl/12941043)

## 参考にした情報源リンク

*   `VirtualAlloc` function (Microsoft Docs): [https://learn.microsoft.com/en-us/windows/win32/api/memoryapi/nf-memoryapi-virtualalloc](https://learn.microsoft.com/en-us/windows/win32/api/memoryapi/nf-memoryapi-virtualalloc)
*   `VirtualFree` function (Microsoft Docs): [https://learn.microsoft.com/en-us/windows/win32/api/memoryapi/nf-memoryapi-virtualfree](https://learn.microsoft.com/en-us/windows/win32/api/memoryapi/nf-memoryapi-virtualfree)
*   Go言語の`uintptr`に関する情報 (非公式ながら一般的な解説): [https://go.dev/ref/spec#Numeric_types](https://go.dev/ref/spec#Numeric_types) (Go言語の公式仕様における数値型に関する記述)
*   C言語における`NULL`ポインタの概念 (一般的なCプログラミングの知識に基づく)