プログラミング言語 Go [text.Baldanders.info]

バージョンの埋め込みと表示

2026-07-17T18:15:52+09:00

まずは，こんな感じにバージョン情報を表示するコードを考える。

package main

var Version = "v1.2.3"

func main() {
    println(Version)
}

これを実行すれば v1.2.3 と表示される。

実際の運用としてバージョンが上がるたびに変数 Version の内容を書き換える必要がある。また Git でソースコード管理する場合はリリースバージョンに対してバージョンタグを付けることが多いので，それとの整合を保つ必要がある。実はこれが割と煩雑な作業なのである。

そこで Go でビルドしたツールのバージョン表記について，以下の2つの方法を記しておく。

ビルド時にバージョン文字列を埋め込む

これは割と昔からある方法で， go build コマンドの -ldflags オプションを使って変数に値を埋め込む。

$ go build -ldflags="-X main.Version=v9.9.9" -o a.out

$ ./a.out
v9.9.9

Git でバージョンタグを打っている場合は

$ go build -ldflags="-X main.Version=`git describe --tags`" -o a.out

などと Git コマンドの出力を埋め込む手もある（bash シェルの場合）。

もしビルドに GoReleaser を使っているのであれば .goreleaser.yml の中で

builds:
-
  ldflags: -X main.Version=v{{ .Version }}

のように書くことで対応できる。

GoReleaser はマルチプラットフォームのコマンドラインツールで，複数プラットフォーム向けの実行バイナリを一度に作ってくれるので重宝している。また GitHub Actions にも対応していて，ビルドしたバイナリを GitHub Release に自動でアップロードし，リリースノートまで書いてくれる。ホンマ助かる。

ただし，この方法は go install では使えないし，そもそもユーザに「go build 時に -ldflags でバージョンを埋め込んでね」とお願いするのもおかしな話である¹。

ビルド情報を表示する

これは Go 1.18 から追加されたらしいのだが runtime/debug パッケージの ReadBuildInfo() 関数を使うと，ビルド時の情報を取得できる。たとえば，こんな感じ。

package main

import "runtime/debug"

var Version = ""

func replaceVersion(v string) string {
    if v != "" {
        return v
    }
    if info, ok := debug.ReadBuildInfo(); ok {
        if info.Main.Version != "" {
            return info.Main.Version
        }
        var revision, dirty string
        for _, v := range info.Settings {
            switch v.Key {
            case "vcs.revision":
                revision = v.Value
            case "vcs.modified":
                if v.Value == "true" {
                    dirty = "+dirty"
                }
            }
        }
        if revision != "" {
            return revision + dirty
        }
    }
    return "(version not set)"
}

func main() {
    println(replaceVersion(Version))
}

debug.ReadBuildInfo() 関数の返り値である BuildInfo 構造体の内容は以下の通り。

type BuildInfo struct {
    // GoVersion is the version of the Go toolchain that built the binary
    // (for example, "go1.19.2").
    GoVersion string `json:",omitempty"`

    // Path is the package path of the main package for the binary
    // (for example, "golang.org/x/tools/cmd/stringer").
    Path string `json:",omitempty"`

    // Main describes the module that contains the main package for the binary.
    Main Module `json:""`

    // Deps describes all the dependency modules, both direct and indirect,
    // that contributed packages to the build of this binary.
    Deps []*Module `json:",omitempty"`

    // Settings describes the build settings used to build the binary.
    Settings []BuildSetting `json:",omitempty"`
}

Module 構造体はこんな感じかな。

type Module struct {
    Path    string  `json:",omitempty"` // module path
    Version string  `json:",omitempty"` // module version
    Sum     string  `json:",omitempty"` // checksum
    Replace *Module `json:",omitempty"` // replaced by this module
}

つまり go.mod でモジュールとして定義・管理されている場合は BuildInfo.Main.Version にバージョンが入っている。

作成した replaceVersion() 関数を含むコードを Git で commit し v0.1.0 のバージョンタグを打った状態でビルド&実行すると以下のように表示された。

$ go build -o a.out && ./a.out
v0.1.0

ちなみに go.mod でモジュールとして定義されている場合でも，バージョン管理されていない場合は (devel) という文字列が返ってくるようだ。

$ go build -o a.out && ./a.out
(devel)

replaceVersion() 関数では BuildInfo.Main.Version で値を取れない場合には BuildInfo.Settings 配列から情報を取得している。 BuildSetting 構造体は以下の通り key-value 形式になっている。

type BuildSetting struct {
    // Key and Value describe the build setting.
    // Key must not contain an equals sign, space, tab, or newline.
    Key string `json:",omitempty"`
    // Value must not contain newlines ('\n').
    Value string `json:",omitempty"`
}

このうち Key には以下の値が入ってるらしい。

Key の値	Value の内容
`-buildmode`	the buildmode flag used (typically `"exe"`)
`-compiler`	the compiler toolchain flag used (typically `"gc"`)
`CGO_ENABLED`	the effective `CGO_ENABLED` environment variable
`CGO_CFLAGS`	the effective `CGO_CFLAGS` environment variable
`CGO_CPPFLAGS`	the effective `CGO_CPPFLAGS` environment variable
`CGO_CXXFLAGS`	the effective `CGO_CXXFLAGS` environment variable
`CGO_LDFLAGS`	the effective `CGO_LDFLAGS` environment variable
`DefaultGODEBUG`	the effective `GODEBUG` settings
`GOARCH`	the architecture target
`GOAMD64/GOARM/GO386/etc`	the architecture feature level for `GOARCH`
`GOOS`	the operating system target
`GOFIPS140`	the frozen FIPS 140-3 module version, if any
`vcs`	the version control system for the source tree where the build ran
`vcs.revision`	the revision identifier for the current commit or checkout
`vcs.time`	the modification time associated with `vcs.revision`, in RFC3339 format
`vcs.modified`	`"true"` or `"false"` indicating whether the source tree had local modifications

replaceVersion() 関数では VCS (Version Control System) のリビジョン情報（vcs.revision および vcs.modified）を使ってバージョンを表示している。ここまで至れり尽くせりなら，大抵のパターンで使えるだろう。

go run ではビルド情報がセットされない

以上は go build あるいは go install でビルドした場合の話だが go run で即時実行した場合はビルド情報がセットされないようだ。先程のコード例の場合は

$ go run main.go
(version not set)

と表示されビルド情報からバージョンを取得できなかったことが分かる。まぁ go run による実行でバージョンを気にする人はいないと思うので，これはこれで問題ないだろう。

ブックマーク

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

[Comment] 著者のひとりは（あの「バイブル」とも呼ばれる）通称 “K&R” の K のほうである。この本は Go 言語の教科書と言ってもいいだろう。と思ったら絶版状態らしい（2025-01 現在）。復刊を望む！

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

Go言語 100Tips ありがちなミスを把握し、実装を最適化する impress top gearシリーズ: Teiva Harsanyi (著), 柴田芳樹 (著); インプレス 2023-08-18 (Release 2023-08-18); Kindle版; B0CFL1DK8Q (ASIN); 評価

[Comment] 版元で PDF 版を購入可能。事実上の Effective Go とも言える充実の内容。オリジナルは敢えてタイトルに “tips” という単語を入れるのを避けたのに邦題が「100 Tips」とかなっていて，原作者がお怒りとの噂（あくまで噂）

reviewed by Spiegel on 2023-08-18 (powered by PA-APIv5)

Go言語で学ぶ並行プログラミング　他言語にも適用できる原則とベストプラクティス impress top gearシリーズ: James Cutajar (著), 柴田芳樹 (著); インプレス 2024-12-04 (Release 2024-12-04); Kindle版; B0DNYMMBBQ (ASIN); 評価

[Comment] 読書会のために購入。インプレス社の本は Kindle 版より版元で PDF 版を買うのがオススメ。「並行処理」について原理的な解説から丁寧に書かれている。 Go で解説されているが Go 以外の言語でも応用できる。

reviewed by Spiegel on 2025-01-25 (powered by PA-APIv5)

実用 Go言語第2版: 文法はシンプルで学びやすいという特徴を持つGo言語。システム開発の現場でも使われる機会が増えていますが、複雑な要件を実現するにはプログラミング言語が提供するシンプルな構成要素（文法やライブラリ）を、さまざまに組み合わせます。本書は「よりGoらしく書くには」「実用的なアプリケーションを書くには」といった観点からGoを使うポイントを紹介します。構造体やインタフェース、またJSON、CSVファイル、Excel、固定長ファイルの扱い方、ログやテスト、環境構築など、また初版の発行後、Goに追加されたジェネリクスについても紹介。現場に即した幅広いトピックについて、「Goらしいプログラムの書き方」を、その背景と共に教えてくれる先輩のような書籍です。; Release 2025-12-01; 評価

プロダクトによっては Makefile やビルド用のスクリプトを用意してるものもある。まぁ，大抵はそれなりの環境を用意しないとビルドできないことが多いのだが。 ↩︎

任意のイテレータを作る

2026-07-06T22:53:06+09:00

Go でイテレータを組む機会があったので，思い出しつつ，簡単なメモを残しておく。なお Go のイテレータは 1.23 から導入されている。

たとえば配列（または slice）や連想配列（map）であれば for-range 構文で以下のように書ける。

package main

func main() {
	nums := []int{1, 2, 3}
	for _, num := range nums {
		println(num)
	}

	planets := map[string]float64{
		"Mercury": 0.055,
		"Venus":   0.815,
		"Earth":   1.0,
	}
	for planet, mass := range planets {
		println(planet, ":", mass)
	}
}

配列や連想配列以外でも for-range 構文が使えれば何かと便利だろう。 Go ではこれを range over function という仕組みで実現している。

Range Over Function Types - The Go Programming Language

Range Over Functions

具体的には以下の3つの関数型を使う。

The improved for/range statement doesn’t support arbitrary function types. As of Go 1.23 it now supports ranging over functions that take a single argument. The single argument must itself be a function that takes zero to two arguments and returns a bool; by convention, we call it the yield function.
func(yield func() bool)
func(yield func(V) bool)
func(yield func(K, V) bool)

via Range Over Function Types

例として，3つの乱数を返すイテレータを作ってみよう。こんな感じかな。

package main

import "math/rand/v2"

func randoms(count int) func(func(int) bool) {
	return func(yield func(int) bool) {
		for range count { // range over int (from 0 to count-1)
			if !yield(rand.Int()) {
				return
			}
		}
	}
}

func main() {
	for n := range randoms(3) {
		println(n)
	}
}

強調部分がイテレータの本体である。これを実行すると，以下のような出力になる。

$ go run sample1a.go
27723168966634698
2343875658410196265
4739277610031835691

このように yield() 関数を呼び出した回数だけ for-range ループが回っていることが分かる。 yield() 関数は何をしているかというと，引数の値をループに push して，処理を継続する場合は true を返している。

ちなみに yield() 関数の返り値のチェックをサボるとどうなるかというと，たとえば

package main

import "math/rand/v2"

func randoms2(count int) func(func(int, int) bool) {
	return func(yield func(int, int) bool) {
		for i := range count { // range over int (from 0 to count-1)
			yield(i+1, rand.Int())
		}
	}
}

func main() {
	for i, n := range randoms2(3) {
		println(i, n)
		if i >= 2 {
			break
		}
	}
}

のように，3回出力するイテレータに対して何らかの理由で2回で中断したとすると

$ go run sample1b.go
1 5146054532611686492
2 7588979459646265126
panic: runtime error: range function continued iteration after function for loop body returned false

goroutine 1 [running]:
main.main-range1(...)
	/path/to/sample1b.go:16
main.main.randoms2.func1(...)
	/path/to/sample1b.go:10
main.main()
	/path/to/sample1b.go:16 +0xcd
exit status 2

などと panic を吐く。怖いですねぇ（笑）

試しに上のコードの randoms2() 関数を

func randoms2(count int) func(func(int, int) bool) {
	return func(yield func(int, int) bool) {
		for i := range count { // range over int (from 0 to count-1)
			println("calling", i+1)
			if !yield(i+1, rand.Int()) {
				println("return false from yield")
				return
			}
		}
	}
}

などとデバッグ文を入れて書き直すと

$ go run sample1c.go
calling 1
1 682324887426579321
calling 2
2 5758210549060056534
return false from yield

のように出力される。 yield() 関数の呼び出しは2回までで，2回目に false を返していることが分かるだろう。

iter パッケージ

イテレータを比較的簡単に取り扱えるようにするため iter パッケージが用意されていて，イテレータを以下のように定義している。

type Seq[V any] func(yield func(V) bool)

type Seq2[K, V any] func(yield func(K, V) bool)

前節の randoms() 関数であれば

import (
	"iter"
	"math/rand/v2"
)

func randoms(count int) iter.Seq[int] {
	return func(yield func(int) bool) {
		for range count { // range over int (from 0 to count-1)
			if !yield(rand.Int()) {
				return
			}
		}
	}
}

のように書き直せる。ん？大して変わらんな（笑）

もうひとつ。 iter パッケージには iter.Pull() および iter.Pull2() 関数が用意されていて，たとえば先程の randoms() 関数の呼び出し側で，以下のように，push-style から pull-style に変形できる。

func main() {
	next, stop := iter.Pull(randoms(3))
	defer stop()
	for {
		n, ok := next()
		if !ok {
			break
		}
		println(n)
	}
}

これはアリだろう。

slices パッケージ

slices パッケージにもイテレータ関連の関数が追加された。たとえば All() 関数を使って

package main

import "slices"

func main() {
	nums := []int{1, 2, 3}
	for i, num := range slices.All(nums) {
		println(i, ":", num)
	}
}

のように slice をイテレータに変換する。記述が増えただけで見た目は変わらんやんけ！と思うかも知れないが

package main

import (
	"iter"
	"slices"
)

func main() {
	nums := []int{1, 2, 3}
	next, stop := iter.Pull(slices.Values(nums))
	defer stop()
	for {
		num, ok := next()
		if !ok {
			break
		}
		println(num)
	}
}

のように pull-style に変形できるのはいいかもしれない。また，イテレータに変換する際に Backward() 関数で逆順に並び替えたり Chunk() 関数で slice を分割することもできる。

Collect() 関数を使ってイテレータを slice に変換することもできる。前節の randoms() 関数であれば

func main() {
	randlist := slices.Collect(randoms(3))
	fmt.Println("randlist:", randlist)
}

のように書く。また AppendSeq() 関数で既にある slice インスタンスにイテレータの出力を追加したり，Sorted() 関数等を使った並び替えもできる。

maps パッケージ

maps パッケージにもイテレータ関連の関数が追加された。ここでは簡単に関数名だけ紹介する。

All : map 型を iter.Seq2 型に変換する
Keys : map 型のキーを iter.Seq 型に変換する
Values : map 型の値を iter.Seq 型に変換する
Collect : iter.Seq2 型を map 型に変換する
Insert : 既にある map インスタンスに iter.Seq2 型の出力を追加する

改訂版：土用期間中の干支を数え上げる

以前書いた「第五の季節：土用」という記事で，拙作の goark/koyomi パッケージを使って，土用期間中の干支を数え上げるコードを紹介した。こんな感じ。

package main

import (
	"fmt"
	"time"

	"github.com/goark/koyomi/value"
	"github.com/goark/koyomi/zodiac"
)

func main() {
	start := value.NewDateYMD(2026, time.July, 20)   //土用の入り
	end := value.NewDateYMD(2026, time.August, 7)    //立秋
	for d := start; d.Before(end); d = d.AddDay(1) { //1日単位で立秋の前日まで出力する
		干, 支 := zodiac.ZodiacDayNumber(d)
		fmt.Printf("Day %v is %v%v\n", d, 干, 支)
	}
}

実行結果は以下の通り。

$ go run sample6a.go
Day 2026-07-20 is 乙未
Day 2026-07-21 is 丙申
Day 2026-07-22 is 丁酉
Day 2026-07-23 is 戊戌
Day 2026-07-24 is 己亥
Day 2026-07-25 is 庚子
Day 2026-07-26 is 辛丑
Day 2026-07-27 is 壬寅
Day 2026-07-28 is 癸卯
Day 2026-07-29 is 甲辰
Day 2026-07-30 is 乙巳
Day 2026-07-31 is 丙午
Day 2026-08-01 is 丁未
Day 2026-08-02 is 戊申
Day 2026-08-03 is 己酉
Day 2026-08-04 is 庚戌
Day 2026-08-05 is 辛亥
Day 2026-08-06 is 壬子

次の土用の丑の日は7月26日か。

それはともかく，コード中の for 文がカッコ悪いなぁと以前から思ってたので，今回の勉強ついでに，指定期間の日付を出力するイテレータを実装してみた。これを使うと，こんな感じに書き直せる。

package main

import (
	"fmt"
	"time"

	"github.com/goark/koyomi/value"
	"github.com/goark/koyomi/zodiac"
)

func main() {
	seq, err := value.NewDateYMD(2026, time.July, 20).IterDay( //土用の入りから
		1, //1日単位で
		value.NewDateYMD(2026, time.August, 7).AddDay(-1), //立秋の前日まで出力する
	)
	if err != nil {
		fmt.Println(err)
		return
	}
	for d := range seq {
		干, 支 := zodiac.ZodiacDayNumber(d)
		fmt.Printf("Day %v is %v%v\n", d, 干, 支)
	}
}

どうよ。こっちのほうが少し見やすいべ。 Before() とか After() とか直感的に分かりにくいメソッドが隠蔽できるだけでもだいぶありがたい。

ブックマーク

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

効率的なGo ―データ指向によるGoアプリケーションの性能最適化: Bartłomiej Płotka (著), 山口能迪 (翻訳); オライリー・ジャパン 2024-02-24; 単行本（ソフトカバー）; 4814400535 (ASIN), 9784814400539 (EAN), 4814400535 (ISBN); 評価

[Comment] 版元で Ebook を買える。Go言語のリファレンス本ではない。フトウェア工学，プログラミング（の考え方）を学ぶ教科書的な位置づけかなぁ。

reviewed by Spiegel on 2024-04-21 (powered by PA-APIv5)

Go言語で学ぶ並行プログラミング　他言語にも適用できる原則とベストプラクティス impress top gearシリーズ: James Cutajar (著), 柴田芳樹 (著); インプレス 2024-12-04 (Release 2024-12-04); Kindle版; B0DNYMMBBQ (ASIN); 評価

reviewed by Spiegel on 2025-01-25 (powered by PA-APIv5)

Go 公式のモジュール照会 API を試す

2026-05-22T12:37:48+09:00

公開された Go パッケージやモジュールのメタデータを照会する API が公開されたそうだ。

Built for stability and efficient caching, the API uses a stateless, GET-only architecture. Primary endpoints are currently hosted under the /v1beta path. Following a period of community feedback and confirmed stability, we intend to transition toward a formal v1 release.

via Introducing the pkg.go.dev API

というわけで現時点では v1beta として提供されている。エンドポイントは以下の通り：

Endpoint Description

/v1beta/package/{path} Information about the package at {path}.

/v1beta/module/{path} Information about the module at {path}.

/v1beta/versions/{path} Versions of the module at {path}.

/v1beta/packages/{path} Information about packages of the module at {path}.

/v1beta/search?q={query} Search results for a given query.

/v1beta/symbols/{path} List of symbols declared by the package at {path}.

/v1beta/imported-by/{path} Paths of packages importing the package at {path}.

/v1beta/vulns/{path} Vulnerabilities of the module or package at {path}.

Endpoint	Description
`/v1beta/package/{path}`	Information about the package at `{path}`.
`/v1beta/module/{path}`	Information about the module at `{path}`.
`/v1beta/versions/{path}`	Versions of the module at `{path}`.
`/v1beta/packages/{path}`	Information about packages of the module at `{path}`.
`/v1beta/search?q={query}`	Search results for a given query.
`/v1beta/symbols/{path}`	List of symbols declared by the package at `{path}`.
`/v1beta/imported-by/{path}`	Paths of packages importing the package at `{path}`.
`/v1beta/vulns/{path}`	Vulnerabilities of the module or package at `{path}`.

via Introducing the pkg.go.dev API

たとえば標準の errors パッケージの情報を取得するには，以下の URL を指定すればいい。

$ curl -s https://pkg.go.dev/v1beta/package/errors | jq .
{
  "modulePath": "std",
  "version": "v1.26.3",
  "isLatest": true,
  "isStandardLibrary": true,
  "goos": "all",
  "goarch": "all",
  "path": "errors",
  "name": "errors",
  "synopsis": "Package errors implements functions to manipulate errors.",
  "isRedistributable": true
}

もちろん標準以外の公開パッケージも取得できる。

$ curl -s https://pkg.go.dev/v1beta/package/github.com/goark/errs | jq .
{
  "modulePath": "github.com/goark/errs",
  "version": "v1.3.4",
  "isLatest": true,
  "isStandardLibrary": false,
  "goos": "all",
  "goarch": "all",
  "path": "github.com/goark/errs",
  "name": "errs",
  "synopsis": "Package errs implements functions to manipulate error instances.",
  "isRedistributable": true
}

モジュールの情報も取れる。

$ curl -s https://pkg.go.dev/v1beta/module/github.com/goark/errs | jq .
{
  "path": "github.com/goark/errs",
  "version": "v1.3.4",
  "commitTime": "2026-05-09T04:07:47Z",
  "isLatest": true,
  "isRedistributable": true,
  "isStandardLibrary": false,
  "hasGoMod": true,
  "repoUrl": "https://github.com/goark/errs"
}

面白いところでは脆弱性情報も取得できるようだ。たとえば昨年の golang.org/x/crypto v0.45.0 における脆弱性情報であれば

$ curl -s https://pkg.go.dev/v1beta/vulns/golang.org/x/crypto?version=v0.45.0 | jq .
{
  "items": [
    {
      "id": "GO-2026-5005",
      "summary": "",
      "details": "Invoking key constraints not enforced in golang.org/x/crypto/ssh/agent",
      "fixedVersion": ""
    },
    {
      "id": "GO-2026-5006",
      "summary": "",
      "details": "Invoking agent constraints dropped when forwarding keys in golang.org/x/crypto/ssh/agent",
      "fixedVersion": ""
    },

    ...

    {
      "id": "GO-2026-5033",
      "summary": "",
      "details": "Invoking pathological inputs can lead to client panic in golang.org/x/crypto/ssh/agent",
      "fixedVersion": ""
    }
  ],
  "total": 13
}

という感じに取得できる（数が多いので途中を端折ってる。あしからず）。 CVE ID ベースじゃないんだな。

CLI ツールも提供されているようだ。 Go のビルド環境があれば以下のコマンドでインストールできる。

$ go install golang.org/x/pkgsite/cmd/internal/pkgsite-cli@latest

ただ，パッケージのパスを見れば分かるように，あくまで API 利用のリファレンス実装という位置づけっぽい。

自作ツールで依存関係を可視化する goark/depm があるのだが，こいつは内部で go コマンドを呼んでいる。これを API ベースに書き換えたら面白いかな。いや，ますます遅くなりそうだな。ちょっと考えるところだ。

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

効率的なGo ―データ指向によるGoアプリケーションの性能最適化: Bartłomiej Płotka (著), 山口能迪 (翻訳); オライリー・ジャパン 2024-02-24; 単行本（ソフトカバー）; 4814400535 (ASIN), 9784814400539 (EAN), 4814400535 (ISBN); 評価

reviewed by Spiegel on 2024-04-21 (powered by PA-APIv5)

Go言語で学ぶ並行プログラミング　他言語にも適用できる原則とベストプラクティス impress top gearシリーズ: James Cutajar (著), 柴田芳樹 (著); インプレス 2024-12-04 (Release 2024-12-04); Kindle版; B0DNYMMBBQ (ASIN); 評価

reviewed by Spiegel on 2025-01-25 (powered by PA-APIv5)

Close 関数のエラーを無視しない（『効率的なGo』読書会より）

2025-11-15T20:04:13+09:00

『効率的なGo』の読書会は無事に最終回を迎えた。今回は，読書会最終回の範囲（11章最適化パターン）から個人的に気になった部分を取り上げる。

Close 関数のエラーを無視しない

以下のサンプルコードを起点にする。

package main

import (
	"fmt"
	"os"
)

func doWithFile(filename string) error {
	f, err := os.Open(filename)
	if err != nil {
		return err
	}
	defer f.Close()

	// Perform file operations here...

	return nil
}

func main() {
	err := doWithFile("example.txt")
	if err != nil {
		fmt.Fprintln(os.Stderr, err)
		panic(err)
	}
}

注目するのは defer f.Close() の部分。 f.Close() メソッドはエラーを返す可能性があるが，このコードではエラーを捨てている。この手のサンプルコードはよく見るし私も過去記事で書いたような気がするが，エラーハンドリングの観点からは悪いコードということになる。

ファイルアクセスではクローズ処理の際にバッファに残ってるデータをフラッシュする場合がある。特に zip ファイルの書き込み処理とかでは終端レコードをクローズ時に書き込んだりするので，絶対にエラーを無視してはいけない。

一般的にクロージング・メソッドを含むパッケージや構造体ではクローズ処理時のエラーを適切に処理する必要がある。だからといって defer を使わないのはもったいない。今回の場合は以下のように書き換える。

func doWithFile(filename string) (err error) {
	f, err := os.Open(filename)
	if err != nil {
		return err
	}
	defer func() {
		if cerr := f.Close(); cerr != nil && cerr != os.ErrClosed {
			err = errors.Join(err, cerr)
		}
	}()

	// Perform file operations here...

	return err
}

ポイントは2つ。

返り値を err error と名前付きにすること
defer 処理を無名関数 func() { ... }() で囲み，内部で適切にエラー処理を行うこと

最近の Go は（errors.Join() など）複数エラーを記述できるようになったのでハンドリングが簡潔になった¹。よしよし。

最後まで読み切ってからクローズする

次のサンプルコードはこれ。 HTTP レスポンスデータを処理する関数である。

func doWithResp(resp *http.Response) (err error) {
	defer func() {
		if cerr := resp.Body.Close(); cerr != nil && cerr != os.ErrClosed {
			err = errors.Join(err, cerr)
		}
	}()

	if resp.StatusCode != http.StatusOK {
		return fmt.Errorf("bad status: %s", resp.Status)
	}

	// Perform operations with the response

	return err
}

net/http パッケージのドキュメントには冒頭に

The caller must close the response body when finished with it:

resp, err := http.Get("http://example.com/")
if err != nil {
	// handle error
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
// ...

via http package - net/http - Go Packages

と書かれていて，必ず http.Response.Body.Close() メソッドを呼び出すよう指示されている。クローズ処理を行わないと内部でゴルーチン・リークが発生するらしい。

ただ http.Response.Body に関しては，ただクローズするだけでは駄目で，クローズする前にデータを最後まで読み切ることが推奨されている。

If the Body is not both read to EOF and closed, the Client’s underlying RoundTripper (typically Transport) may not be able to re-use a persistent TCP connection to the server for a subsequent “keep-alive” request.

via http package - net/http - Go Packages

これについては『Go言語 100Tips』にも解説がある。

もう 1 つ覚えておくべき重要なことは、ボディをクローズするときの動作は、そのボディから読み込んだかどうかによって異なることです。

読み込まずにボディをクローズすると、デフォルトの HTTP トランスポートがコネクションをクローズするかもしれません。

読み込んだ後にボディをクローズしても、デフォルトの HTTP トランスポートはコネクションをクローズしないので、再利用できる可能性があります。

したがって、getStatusCode が繰り返し呼ばれ、キープアライブ（keep-alive）のコネクションを使いたい場合、必要がないと思ってもボディを読み込むべきです。

『Go言語 100Tips』 10. No.79：一時的な資源をクローズしないより

これを踏まえて，最初のサンプルコードを書き換えると以下のようになる。

func doWithResp(resp *http.Response) (err error) {
	defer func() {
		_, rerr := io.Copy(io.Discard, resp.Body)
		if cerr := resp.Body.Close(); cerr != nil && cerr != os.ErrClosed {
			err = errors.Join(err, rerr, cerr)
		}
		err = errors.Join(err, rerr)
	}()

	if resp.StatusCode != http.StatusOK {
		return fmt.Errorf("bad status: %s", resp.Status)
	}

	// Perform operations with the response

	return err
}

余談

『効率的なGo』は，ちぃっと難しかった。何が難しいって書籍内参照が前の章や後の章に飛びまくって「何だっけこれ？」ってなることが多くて。まるで longjump だらけのスパゲッティコードを読んでる気分だった。これを曲がりなりにも理解するにはあと2,3回は周回する必要があるかな。

『効率的なGo』では標準パッケージの中身にも踏み込んでカスタマイズしたパッケージ置き換えるといったことも行っている。今回挙げた例についても，エラーハンドリングに関しては独自のパッケージが用意されている。参考になるだろう。

今回の読書会の最後の方で話題になったのだが，2025年12月に『実用 Go言語第2版』が出るそうで。買わなきゃ。先日買った『初めてのGo言語第2版』もまだ読み終わってないんだけど。

参考図書

効率的なGo ―データ指向によるGoアプリケーションの性能最適化: Bartłomiej Płotka (著), 山口能迪 (翻訳); オライリー・ジャパン 2024-02-24; 単行本（ソフトカバー）; 4814400535 (ASIN), 9784814400539 (EAN), 4814400535 (ISBN); 評価

reviewed by Spiegel on 2024-04-21 (powered by PA-APIv5)

Go言語 100Tips ありがちなミスを把握し、実装を最適化する impress top gearシリーズ: Teiva Harsanyi (著), 柴田芳樹 (著); インプレス 2023-08-18 (Release 2023-08-18); Kindle版; B0CFL1DK8Q (ASIN); 評価

reviewed by Spiegel on 2023-08-18 (powered by PA-APIv5)

初めてのGo言語第2版 ―他言語プログラマーのためのイディオマティックGo実践ガイド: Jon Bodner (著), 武舎広幸 (翻訳); オライリー・ジャパン 2025-08-05 (Release 2025-08-05); 単行本（ソフトカバー）; 4814401191 (ASIN), 9784814401192 (EAN), 4814401191 (ISBN); 評価

[Comment] 第2版。 Generics の説明が大幅に改訂されたらしい。練習問題も追加されている。

reviewed by Spiegel on 2025-11-02 (powered by PA-APIv5)

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

拙作の goark/errs パッケージもよろしく（宣伝）。こちらも複数エラーに対応している他，エラーの出力を JSON 形式に出来る。 ↩︎

並行処理を待ち合わせる（WaitGroup と Barrier パターン）

2025-11-09T19:39:03+09:00

Go の goroutine は起動すると外側から直接制御する方法がない。とはいっても goroutine 間で同期を取ることは多く，そのための仕組みがいくつか提供されている。この記事では比較的簡単な実装である，複数の goroutine を待ち合わせる方法を紹介する。

タスクの完了を待ち合わせる

まずは5つの goroutine を起動し，それぞれ某かのタスクを実行するプログラムを考える。まずは素朴に以下のコードで¹。

package main
package main

import (
	"fmt"
	"math/rand/v2"
	"time"
)

func main() {
	tasks := 5 // Number of tasks
	for t := range tasks {
		go func() {
			fmt.Println("Start Task:", t+1)
			time.Sleep(time.Duration(rand.IntN(5)+1) * time.Second) // Random duration between 1 and 5 seconds
			fmt.Println("End Task:", t+1)
		}()
	}
	fmt.Println("All Complete")
}

（Go の関数は全て関数閉包（closure）として機能するため goroutine として定義した関数はループ変数 t を close over している。この for-range ブロックのループ変数 t は，ループするごとに新たにインスタンスが生成されている点に注意）

実際には，このコードはうまく動かない。実行するとこんな感じ：

$ go run sample1.go
All Complete

実はメイン goroutine が終了する際に他の goroutine も強制終了されてしまうため，このような結果になる。これを安直に解決する手段として，メイン goroutine を適当な時間スリープさせる方法がある。たとえばこんな感じ¹：

package main

import (
	"fmt"
	"math/rand/v2"
	"time"
)

func main() {
	tasks := 5 // Number of tasks
	for t := range tasks {
		go func() {
			fmt.Println("Start Task:", t+1)
			time.Sleep(time.Duration(rand.IntN(5)+1) * time.Second) // Random duration between 1 and 5 seconds
			fmt.Println("End Task:", t+1)
		}()
	}
	time.Sleep(10 * time.Second)
	fmt.Println("All Complete")
}

これを実行すると確かに

$ go run sample1b.go
Start Task: 5
Start Task: 4
Start Task: 2
Start Task: 1
Start Task: 3
End Task: 3
End Task: 5
End Task: 4
End Task: 1
End Task: 2
All Complete

などと一見うまく動いているようだが，このスリープ時間には根拠がないため（10秒もあれば全タスク完了してるやろ？），条件が変わればうまく動かなくなる可能性がある。

複数のタスクの完了を待ち合わせるために，標準パッケージには sync.WaitGroup が用意されている。使い方はこんな感じ：

package main

import (
	"fmt"
	"math/rand/v2"
	"sync"
	"time"
)

func main() {
	tasks := 5             // Number of tasks
	wg := sync.WaitGroup{} // WaitGroup to synchronize goroutines
	wg.Add(tasks)          // Add the number of tasks to the WaitGroup
	for t := range tasks {
		go func() {
			defer wg.Done() // Ensure Done is called when the goroutine completes
			fmt.Println("Start Task:", t+1)
			time.Sleep(time.Duration(rand.IntN(5)+1) * time.Second) // Random duration between 1 and 5 seconds
			fmt.Println("End Task:", t+1)
		}()
	}
	wg.Wait() // Wait for all goroutines to finish
	fmt.Println("All Complete")
}

これは goroutine の総数があらかじめ分かっている場合だが goroutine 数が動的に変化する場合でも使える。

package main

import (
	"fmt"
	"math/rand/v2"
	"sync"
	"time"
)

func main() {
	wg := sync.WaitGroup{} // WaitGroup to synchronize goroutines
	for t := 1; ; t++ {
		wg.Add(1) // Add a task to the WaitGroup
		go func() {
			defer wg.Done() // Ensure Done is called when the goroutine completes
			fmt.Println("Start Task:", t)
			time.Sleep(time.Duration(rand.IntN(5)+1) * time.Second) // Random duration between 1 and 5 seconds
			fmt.Println("End Task:", t)
		}()
		if rand.IntN(6) > 4 { // Randomly decide to stop adding tasks
			break
		}
	}
	wg.Wait() // Wait for all goroutines to finish
	fmt.Println("All Complete")
}

ポイントは goroutine を起動する直前に wg.Add(1) を呼び出すことである。実行結果はこんな感じ。

$ go run sample1d.go
Start Task: 3
Start Task: 1
Start Task: 2
End Task: 2
End Task: 1
End Task: 3
All Complete

for ブロックのループ変数について

先ほどのサンプルコードでは for ブロック

for t := 1; ; t++ {
    ...
}

で宣言したループ変数 t をそのまま goroutine 内で参照しているが，古いバージョンの Go では意図しない出力になる。これはループ変数 t が for ブロック内で単一のインスタンスになっていて，ループするごとに値が上書きされるためである。この問題を回避するために以下のように t を shadowing する方法が推奨されていた。

for t := 1; ; t++ {
    t := t // Shadowing to capture the current value of t
    ...
}

最近のバージョン（1.22 以降）では for ブロック内でループ変数が内部の関数（閉包）から直接参照されている場合は暗黙的に shadowing が行われる。上述のような記述は不要になったわけだ。

WaitGroup.Go メソッド

Go 1.25 で sync.WaitGroup に Go() メソッドが追加された。実装はこんな感じ。

// Go calls f in a new goroutine and adds that task to the [WaitGroup].
// When f returns, the task is removed from the WaitGroup.
//
// The function f must not panic.
//
// If the WaitGroup is empty, Go must happen before a [WaitGroup.Wait].
// Typically, this simply means Go is called to start tasks before Wait is called.
// If the WaitGroup is not empty, Go may happen at any time.
// This means a goroutine started by Go may itself call Go.
// If a WaitGroup is reused to wait for several independent sets of tasks,
// new Go calls must happen after all previous Wait calls have returned.
//
// In the terminology of [the Go memory model], the return from f
// "synchronizes before" the return of any Wait call that it unblocks.
//
// [the Go memory model]: https://go.dev/ref/mem
func (wg *WaitGroup) Go(f func()) {
	wg.Add(1)
	go func() {
		defer wg.Done()
		f()
	}()
}

つまり，Go() メソッド内部で Add(1) と Done() が呼び出され，かつ引数の関数 f を goroutine として起動する。これを使うと，以下のようにコードが簡潔になる。

package main

import (
	"fmt"
	"math/rand/v2"
	"sync"
	"time"
)

func main() {
	tasks := 5             // Number of tasks
	wg := sync.WaitGroup{} // WaitGroup to synchronize goroutines
	for t := range tasks {
		wg.Go(func() {
			fmt.Println("Start Task:", t+1)
			time.Sleep(time.Duration(rand.IntN(5)+1) * time.Second) // Random duration between 1 and 5 seconds
			fmt.Println("End Task:", t+1)
		})
	}
	wg.Wait() // Wait for all goroutines to finish
	fmt.Println("All Complete")
}

この辺も定番の慣用句（idiom）だったので，Go() メソッドの追加は嬉しい改善点と言えるだろう。

タスクの開始を待ち合わせる

前節とは異なり，特定の条件が成立するまで各 goroutine を停止し，条件が成立したら一斉に実行を再開したい場合がある。条件が成立するまでタスクを止めるため，この実装パターンをバリア（Barrier）と呼ぶ。

Go の標準パッケージにはバリア・パターンを直接提供する仕組みはないが，条件変数を制御する sync.Cond を用いて比較的簡単に実装できる。

前節のコードを元に，指定した数の goroutine の起動が揃うまで待機し，揃った時点で一斉にタスクを開始するコードを実装してみよう。まずはバリアパターンを駆動する構造体 Barrier を定義する。

type Barrier struct {
	total int // Number of goroutines to wait for
	count int // Current count of arrived goroutines
	cond  *sync.Cond // Condition variable to manage waiting and signaling
}

この構造体の初期化関数を以下のように定義する。

func NewBarrier(total int) *Barrier {
	return &Barrier{
		total: total,
		count: 0,
		cond:  sync.NewCond(&sync.Mutex{}),
	}
}

さらに Barrier に対して Wait() メソッドを定義する。

func (b *Barrier) Wait() {
	b.cond.L.Lock()         // Acquire the lock before modifying count
	defer b.cond.L.Unlock() // Ensure the lock is released when done
	b.count++               // Increment the count of arrived goroutines
	if b.count >= b.total {
		b.count = 0
		b.cond.Broadcast() // Wake up all waiting goroutines
	} else {
		b.cond.Wait() // Wait until the barrier is released
	}
}

Wait() メソッドが呼ばれるたびに count がインクリメントされ，count が total に達したら cond.Broadcast() メソッドで全ての待機中 goroutine を起こす。

Barrier を使った main() 関数はこんな感じ：

func main() {
	tasks := 5                   // Number of tasks
	barrier := NewBarrier(tasks) // Create a barrier for the tasks
	for t := range tasks {
		go func() {
			time.Sleep(time.Duration(rand.IntN(3)+1) * time.Second) // Simulate preparation time
			fmt.Println("Ready Task:", t+1)
			barrier.Wait() // Wait at the barrier
			fmt.Println("Start Task:", t+1)
			time.Sleep(time.Duration(rand.IntN(5)+1) * time.Second) // Random duration between 1 and 5 seconds
			fmt.Println("End Task:", t+1)
		}()
	}
	time.Sleep(10 * time.Second)
	fmt.Println("All Complete")
}

これを実行するとこんな感じになる。

$ go run sample2.go
Ready Task: 2
Ready Task: 3
Ready Task: 1
Ready Task: 4
Ready Task: 5
Start Task: 5
Start Task: 4
Start Task: 3
Start Task: 2
Start Task: 1
End Task: 2
End Task: 1
End Task: 3
End Task: 4
End Task: 5
All Complete

各 goroutine とも Ready 状態が揃ってからタスクを開始しているのが分かる²。

さらにこれに前節の完了待ち合わせ機能を入れたコード全体は以下の通り：

package main

import (
	"fmt"
	"math/rand/v2"
	"sync"
	"time"
)

type Barrier struct {
	total int        // Number of goroutines to wait for
	count int        // Current count of arrived goroutines
	cond  *sync.Cond // Condition variable to manage waiting and signaling
}

func NewBarrier(total int) *Barrier {
	return &Barrier{
		total: total,
		count: 0,
		cond:  sync.NewCond(&sync.Mutex{}),
	}
}

func (b *Barrier) Wait() {
	b.cond.L.Lock()         // Acquire the lock before modifying count
	defer b.cond.L.Unlock() // Ensure the lock is released when done
	b.count++               // Increment the count of arrived goroutines
	if b.count >= b.total {
		b.count = 0
		b.cond.Broadcast() // Wake up all waiting goroutines
	} else {
		b.cond.Wait() // Wait until the barrier is released
	}
}

func main() {
	tasks := 5                   // Number of tasks
	barrier := NewBarrier(tasks) // Create a barrier for the tasks
	wg := sync.WaitGroup{}       // WaitGroup to synchronize goroutines
	wg.Add(tasks)                // Add the number of tasks to the WaitGroup
	for t := range tasks {
		go func() {
			defer wg.Done()                                         // Ensure Done is called when the goroutine completes
			time.Sleep(time.Duration(rand.IntN(3)+1) * time.Second) // Simulate preparation time
			fmt.Println("Ready Task:", t+1)
			barrier.Wait() // Wait at the barrier
			fmt.Println("Start Task:", t+1)
			time.Sleep(time.Duration(rand.IntN(5)+1) * time.Second) // Random duration between 1 and 5 seconds
			fmt.Println("End Task:", t+1)
		}()
	}
	wg.Wait() // Wait for all goroutines to finish
	fmt.Println("All Complete")
}

起動条件は何でもいい。今回のように決められた数の goroutine が揃ったら即起動でもいいし，特定の時刻が来たら待機中の goroutine を起こすでもいいだろう。 Channel と組み合わせる方法もあるかも知れない。

ブックマーク

参考図書

Go言語で学ぶ並行プログラミング　他言語にも適用できる原則とベストプラクティス impress top gearシリーズ: James Cutajar (著), 柴田芳樹 (著); インプレス 2024-12-04 (Release 2024-12-04); Kindle版; B0DNYMMBBQ (ASIN); 評価

reviewed by Spiegel on 2025-01-25 (powered by PA-APIv5)

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

Go言語 100Tips ありがちなミスを把握し、実装を最適化する impress top gearシリーズ: Teiva Harsanyi (著), 柴田芳樹 (著); インプレス 2023-08-18 (Release 2023-08-18); Kindle版; B0CFL1DK8Q (ASIN); 評価

reviewed by Spiegel on 2023-08-18 (powered by PA-APIv5)

初めてのGo言語第2版 ―他言語プログラマーのためのイディオマティックGo実践ガイド: Jon Bodner (著), 武舎広幸 (翻訳); オライリー・ジャパン 2025-08-05 (Release 2025-08-05); 単行本（ソフトカバー）; 4814401191 (ASIN), 9784814401192 (EAN), 4814401191 (ISBN); 評価

[Comment] 第2版。 Generics の説明が大幅に改訂されたらしい。練習問題も追加されている。

reviewed by Spiegel on 2025-11-02 (powered by PA-APIv5)

for i := range n { ... } は Go 1.22 で導入された range over int と呼ばれる構文で，for i := 0; i < n; i++ { ... } と同じ意味になる。糖衣構文（syntactic sugar）の一種ですな。 ↩︎ ↩︎
今回の記事は『Go言語で学ぶ並行プログラミング』を参考にしている。 sync.Cond の Broadcast() メソッドは待機中の全ての goroutine を起こすため，実際には起こされたタイミングで本当に条件を満たしているかどうか確認する処理が必要かもしれない。もし条件を満たしていなければ再び Wait() する。 ↩︎

struct2flag でコマンドライン解析【追記あり】

2025-10-13T03:28:30+09:00

flag 標準パッケージによるコマンドライン解析

いきなりだが，以下のコードから始める。

package main

import (
    "flag"
    "fmt"
    "strings"
)

var n = flag.Bool("n", false, "omit trailing newline")
var sep = flag.String("s", " ", "separator")

func main() {
    flag.Parse()
    fmt.Print(strings.Join(flag.Args(), *sep))
    if !*n {
        fmt.Println()
    }
}

『プログラミング言語Go』p.36-37より

これはコマンドラインの文字列をそのまま出力するプログラムで，こんなふうに動作する。

$ go run echo4.go May the Force be with you
May the Force be with you

-s オプションで区切り文字を指定できる。こんな感じ。

$ go run echo4.go -s / May the Force be with you
May/the/Force/be/with/you

また -n オプションを指定すると，末尾の改行が抑制される。さらに -h オプションでヘルプが表示される。

$ go run echo4.go -h
Usage of /home/username/.cache/go-build/06/06a6e71bb093bd1ebbb176c5042329730592597ae86dcb2ca99b3759e1aecb18-d/echo4:
  -n    omit trailing newline
  -s string
        separator (default " ")

これらオプションの解析を行っているのが標準パッケージ flag である。上述のコード例は簡単なのでアレでいいのだが，オプションに紐付けられた変数をひとつずつ定義して取り回しするのは面倒なので，普通は構造体にまとめる。例えばこんな感じ（エラーハンドリングをサボっているがご容赦）。

package main

import (
    "flag"
    "fmt"
    "strings"
)

type Flags struct {
    N   bool
    Sep string
}

func (f *Flags) Bind() {
    flag.BoolVar(&f.N, "n", false, "omit trailing newline")
    flag.StringVar(&f.Sep, "s", " ", "separator")
}

func main() {
    f := &Flags{}
    f.Bind()
    flag.Parse()
    fmt.Print(strings.Join(flag.Args(), f.Sep))
    if !f.N {
        fmt.Println()
    }
}

オプションを構造体にまとめるメリットはもうひとつあって，それは facade パターンを構成してコマンドライン制御とロジックを簡単に分離できることである。例えばこんな感じ。

package main

import (
    "flag"
    "fmt"
    "strings"
)

type Flags struct {
    N    bool
    Sep  string
    Strs []string
}

func (f *Flags) Bind() {
    flag.BoolVar(&f.N, "n", false, "omit trailing newline")
    flag.StringVar(&f.Sep, "s", " ", "separator")
}

func Echo(f *Flags) {
    fmt.Print(strings.Join(f.Strs, f.Sep))
    if !f.N {
        fmt.Println()
    }
}

func main() {
    f := &Flags{}
    f.Bind()
    flag.Parse()
    f.Strs = flag.Args()

    Echo(f)
}

これで main() 関数はコマンドライン制御に徹してロジックを Echo() 関数に任せることができる。一方で Echo() 関数は渡される Flags 構造体にのみ依存しているのでコマンドライン制御の詳細を知らなくて済む。この例では全てが main パッケージにまとまってるので分かりにくいが，ロジックを別パッケージにすることはよくあるので，テストのしやすさも考慮してこのパターンを意識するのは大事である。

とはいえ，ロジックが変われば要求される情報も変わるし，上の例でいう Flags 構造体の中身も変わる。そうなると Flags.Bind() メソッドの中身も変える必要があるが，このメソッドで構造体の要素をひとつづつ flag パッケージに紐付けているので，これを書くのが地味に面倒くさいのである。そもそも flag パッケージに紐付ける処理が構造体側にあるのもイマイチだよね。

struct2flag でコマンドライン解析

というところで github.com/hymkor/struct2flag パッケージの登場である。これを使ってコードを書き直してみる。

package main

import (
    "flag"
    "fmt"
    "strings"

    "github.com/hymkor/struct2flag"
)

type Flags struct {
    N    bool   `flag:"n,omit trailing newline"`
    Sep  string `flag:"s,separator"`
    Strs []string
}

func NewFlags() *Flags {
    return &Flags{N: false, Sep: " ", Strs: []string{}}
}

func Echo(f *Flags) {
    fmt.Print(strings.Join(f.Strs, f.Sep))
    if !f.N {
        fmt.Println()
    }
}

func main() {
    f := NewFlags()
    struct2flag.BindDefault(f)
    flag.Parse()
    f.Strs = flag.Args()

    Echo(f)
}

struct2flag を使うことにより flag との紐づけ情報は Flags 構造体定義のタグとインスタンス生成・初期化を行う NewFlags() 関数に集約される（インスタンスの値が各オプションの既定値として登録されるため）。

struct2flag を使うメリットはいくつかあって

main() 関数側はオプション値を格納する構造体の詳細を知らなくてもよい
構造体のタグが各要素の簡単な説明になっている
struct2flag の中身がシンプルで標準以外の依存パッケージがない

といったところであろう。

私は，ちゃんとしたコマンドラインツールを作るときはサブコマンドや GNU 拡張シンタックスが使える cobra を使ったりしているのだが，ちょっとしたツールには大げさなんだよね，これ。かといって flag を素のまま使うのは微妙に鬱陶しくて，結局コマンドラインオプション無しで main() 関数に直接値を埋め込んでしまうことが多い。

struct2flag なら構造体にタグを書くだけで済むし flag を素のまま使うよりは気軽にコマンドラインオプションを構成できるので，ちょっとしたツールにはいい感じである。

公開してくださった @zetamatta@mstdn.jp さんに感謝 🙇

【2025-10-18 追記】オプションの既定値を設定ファイルから取得する

前節では Flags 構造体の初期値を固定値にしていたが，これを設定ファイルから取得できるようにしてみる。設定ファイルの内容は以下の JSON 形式とする。

{
  "no_newline": true,
  "separator": "/"
}

さらに Flags 構造体のタグを以下のように書き換える。

type Flags struct {
    N    bool   `flag:"n,omit trailing newline" json:"no_newline"`
    Sep  string `flag:"s,separator" json:"separator"`
    Strs []string
}

読み込む処理は以下の通り（main() 関数のみ表示）。

const configPath = "echo/config.json"

func main() {
    f := NewFlags()
    if conf, err := os.UserConfigDir(); err == nil {
        if data, err := os.ReadFile(filepath.Join(conf, configPath)); err == nil {
            if err := json.Unmarshal(data, f); err != nil {
                fmt.Fprintln(os.Stderr, err)
                return
            }
        }
    }
    struct2flag.BindDefault(f)
    flag.Parse()
    f.Strs = flag.Args()

    Echo(f)
}

これで設定ファイルが存在する場合はその内容を規定値とし，存在しない場合（または読み込みに失敗した場合）はスルーする。 os.UserConfigDir() って何？って方は（ちょっと古いけど）拙文「go-homedir はもう要らない」あたりを参考にどうぞ。

実行結果はこんな感じ。

$ go run echo4e.go May the Force be with you
May/the/Force/be/with/you

オプション値を設定ファイルで取得できるようにすると何が嬉しいかというと，バッチ処理を構成しやすくなるのよ。設定ファイル自体が「どういう条件でコマンドを実行したか」という証跡になるし，コマンドラインを短くできるのも嬉しい。

【2025-10-18 追記】オプションの既定値を環境変数から取得する

struct2flag の作者の方が構造体のタグと環境変数を紐付けて取得するパッケージ github.com/hymkor/struct2env も公開された。構造体のタグはこんな感じに定義する。

type Flags struct {
    N    bool   `flag:"n,omit trailing newline" env:"NO_NEWLINE"`
    Sep  string `flag:"s,separator" env:"SEPARATOR"`
    Strs []string
}

読み込む処理は以下の通り（main() 関数のみ表示）。

func main() {
    f := NewFlags()
    struct2env.Bind(f)
    struct2flag.BindDefault(f)
    flag.Parse()
    f.Strs = flag.Args()

    Echo(f)
}

実行結果はこんな感じ。

$ env SEPARATOR=/ go run echo4f.go May the Force be with you
May/the/Force/be/with/you

まぁ，今回みたいにコマンドラインオプションと環境変数で同じ情報を取得するのはメリットが薄いかもしれないけど（Docker 環境では重宝するかも），ある値は環境変数から取得し別の値はコマンドラインから取得する，みたいな使い方はアリかなと思ったりする。ともかく，環境変数の情報を（構造体のタグ付けで）一度に取得できるのはかなり便利である。

【2025-10-19 追記】別解

struct2env ほど便利ではないが，一応別解もある。

func main() {
    f := NewFlags()
    struct2flag.BindDefault(f)
    flag.VisitAll(func(f *flag.Flag) {
        if s := os.Getenv(strings.ToUpper(f.Name)); s != "" {
            _ = f.Value.Set(s)
        }
    })
    flag.Parse()
    f.Strs = flag.Args()

    Echo(f)
}

これはオプション名と同名の環境変数を探して既定値としてセットするもので，実行するとこんな感じになる。

$ env S=/ go run echo4g.go May the Force be with you
May/the/Force/be/with/you

標準パッケージのみで構成できるのがメリットだが，このままだと1文字のオプション名もそのまま環境変数名として検索されることになるので，実際に使うには変換ルールを工夫する必要があるかもしれない。それを考えると struct2env のほうが自由度が高くていいかも。

ブックマーク

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

“Philosophers” を Go で解く（CLI）

2025-09-03T18:34:53+09:00

コマンドライン・インタフェース

実際に問題を解く前にコマンドライン・インタフェースを整えておく。 CLI には spf13/cobra パッケージを使用する。詳細については，ちょっと古い内容だが「Cobra でテストしやすい CLI を構成する」を参考にどうぞ。この記事では結果だけ示す。

$ go run github.com/spiegel-im-spiegel/philo -h
Simulation for philosophers' problem.

Usage:
  philo [flags]
  philo [command]

Available Commands:
  help        Help about any command
  version     print the version number

Flags:
      --debug   for debug
  -h, --help    help for philo

Use "philo [command] --help" for more information about a command.

なおリポジトリは以下にある。

Philosophers - I never thought philosophy would be so deadly

パラメータの定義

問題で指示されているパラメータを今一度挙げる。

シンボル型説明

NumPhilos int 哲学者およびフォークの数（$\ge 2$）

TimeDie int 餓死するまでの時間（$\gt 0\,\mathrm{ms}$）

TimeEat int 「食べる」時間（$\gt 0\,\mathrm{ms}$）

TimeSleep int 「眠る」時間（$\gt 0\,\mathrm{ms}$）

TimeThink int 「考える」時間（$\ge 0\,\mathrm{ms}$）

NumEat int 各哲学者が最低限食事を行う回数（$\ge 0$）

これをコマンドラインから設定できるようにする。先に指定したパラメータを格納する型を定義しよう。

// Params holds tunable configuration values for a Dining Philosophers simulation.
type Params struct {
	NumPhilos int // Total number of philosophers (and forks). Must be >= 2.
	TimeDie   int // Maximum time in milliseconds a philosopher can go without eating before being considered dead.
	TimeEat   int // Time in milliseconds a philosopher spends eating (holding both forks).
	TimeSleep int // Time in milliseconds a philosopher sleeps after eating.
	TimeThink int // Optional target time in milliseconds a philosopher thinks after sleeping.
	NumEat    int // Optional target number of meals each philosopher must consume; if == 0 the simulation runs until a death occurs.
}

// String returns a human-readable summary of the Params configuration,
// listing the number of philosophers, each lifecycle duration (die, eat,
// sleep, think in milliseconds), and the required number of meals.
// Example:
//
//	Philosophers: 5, Die: 800ms, Eat: 200ms, Sleep: 200ms, Think: 0ms, Eat Count: 3
func (p *Params) String() string {
	return fmt.Sprintf("Philosophers: %d, Die: %dms, Eat: %dms, Sleep: %dms, Think: %dms, Eat Count: %d",
		p.NumPhilos, p.TimeDie, p.TimeEat, p.TimeSleep, p.TimeThink, p.NumEat)
}

いやぁ，今どきは AI がコメントを書いてくれるから楽でいいね（笑）これを前節の CLI と接続する。こんな感じ。

$ go run github.com/spiegel-im-spiegel/philo -h
Simulation for philosophers' problem.

Usage:
  philo [flags]
  philo [command]

Available Commands:
  help        Help about any command
  version     print the version number

Flags:
      --debug              for debug
  -h, --help               help for philo
  -m, --must-eat int       number of times each philosopher must eat (default 3)
  -p, --philosophers int   number of philosophers (default 5)
  -d, --to-die int         time to die (ms) (default 200)
  -e, --to-eat int         time to eat (ms) (default 20)
  -s, --to-sleep int       time to sleep (ms) (default 80)
  -t, --to-think int       time to think (ms) (default 80)

Use "philo [command] --help" for more information about a command.

デフォルト値は適当で。今のところはパラメータの内容を表示するだけの処理にしておく。

$ go run github.com/spiegel-im-spiegel/philo -h
Philosophers: 5, Die: 200ms, Eat: 20ms, Sleep: 80ms, Think: 80ms, Eat Count: 3

CLI 部分はここまで。これで本来のシミュレーション・ロジックを組み込む準備は完了である。次回から実際に問題を解いていく。

参考図書

Go言語で学ぶ並行プログラミング　他言語にも適用できる原則とベストプラクティス impress top gearシリーズ: James Cutajar (著), 柴田芳樹 (著); インプレス 2024-12-04 (Release 2024-12-04); Kindle版; B0DNYMMBBQ (ASIN); 評価

reviewed by Spiegel on 2025-01-25 (powered by PA-APIv5)

Go言語による並行処理: Katherine Cox-Buday (著), 山口能迪 (翻訳); オライリージャパン 2018-10-26; 単行本（ソフトカバー）; 4873118468 (ASIN), 9784873118468 (EAN), 4873118468 (ISBN); 評価

[Comment] Eブック版もある。感想はこちら。 Go 言語で並行処理を書くならこの本は必読書になるだろう。

reviewed by Spiegel on 2020-01-13 (powered by PA-APIv5)

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

Go言語 100Tips ありがちなミスを把握し、実装を最適化する impress top gearシリーズ: Teiva Harsanyi (著), 柴田芳樹 (著); インプレス 2023-08-18 (Release 2023-08-18); Kindle版; B0CFL1DK8Q (ASIN); 評価

reviewed by Spiegel on 2023-08-18 (powered by PA-APIv5)

Goならわかるシステムプログラミング第2版: 渋川よしき (著), ごっちん (イラスト); ラムダノート 2022-03-23; 単行本（ソフトカバー）; 4908686122 (ASIN), 9784908686122 (EAN), 4908686122 (ISBN); 評価

[Comment] 第1版はとてもためになる内容だったので第2版も PDF 版で確保しておく。

reviewed by Spiegel on 2022-10-08 (powered by PA-APIv5)

“Philosophers” を Go で解く（問題編）

2025-09-02T15:05:52+09:00

先日書いた読書感想文の最後の方で「食事する哲学者の問題」を紹介したが，今回から数回に渡ってこの問題を Go で解く記事を書いてみる。

読書会で教えて頂いたテキストは “Philosophers - I never thought philosophy would be so deadly” というのだが，ググっても（フリーで使えそうな）オリジナルっぽい文書が見つからないので，問題について説明するところから始めたいと思う（今回のために多少アレンジしている。あしからず）。

基本ルール

まず，基本のルールについて。

円卓に2人以上の哲学者が座っている
哲学者は「食べる」→「眠る」→「考える」のローテーションを逐次繰り返す。哲学者間で行動の差異はない
- 「食べる」間は「眠る」「考える」を行わない
- 「眠る」間は「食べる」「考える」を行わない
- 「考える」間は「食べる」「眠る」を行わない
円卓の中央には大きなスパゲッティボールがあり，哲学者は食事の際はそれぞれボールからスパゲッティを取って「食べる」
スパゲッティを取って食べるためのフォークは哲学者の人数分だけあり，各哲学者から見て左右に1本ずつ配置されている
「食べる」際はフォークが必ず2本必要。各哲学者は左右にある2本のフォークを取って「食べる」を開始する（他のフォークは使わない）
- フォークを使っている間は他の哲学者は同じフォークを使えない
- 「食べる」が終わったらフォークを戻し，他の哲学者が使えるようにする
「食べる」が終わったら「眠る」を開始する。「眠る」は一定時間行う
「眠る」が終わったら「考える」を開始する。「考える」は次の「食べる」を開始するまで継続する
哲学者はお互いの状態を知らず，コミュニケーションすることもない
哲学者は一定時間「食べる」をしないと餓死する

スパゲッティ・フォーク・哲学者の配置を簡単に図示してみる（図は哲学者が5人の場合）。

via “SE 350 Textbook Notes - Sentences” (CC-BY-NC)

同じフォークを哲学者同士で使い回すんかい！とか，スパゲッティの補充はどうするの？とか生々しい話はいったん考えない。まぁ，哲学者って ~~頭おかしい~~ 変わり者が多そうだし（笑）

このルール下で餓死者を出さずに全員が一定回数以上食事を行うにはどうすればいいか，という問いである。このシミュレーションを Go で組んでみよう，というわけだ。

パラメータおよび終了条件

シミュレーションに必要な各種パラメータを以下に示す。

シンボル	型	説明
`NumPhilos`	`int`	哲学者およびフォークの数（$\ge 2$）
`TimeDie`	`int`	餓死するまでの時間（$\gt 0\,\mathrm{ms}$）
`TimeEat`	`int`	「食べる」時間（$\gt 0\,\mathrm{ms}$）
`TimeSleep`	`int`	「眠る」時間（$\gt 0\,\mathrm{ms}$）
`TimeThink`	`int`	「考える」時間（$\ge 0\,\mathrm{ms}$）
`NumEat`	`int`	各哲学者が最低限食事を行う回数（$\ge 0$）

シミュレーションの終了条件は以下の通り：

哲学者はシミュレーション開始または食事を開始してから TimeDie ミリ秒以内に次の食事を始めないと餓死する
哲学者の誰か1人が餓死した場合または全員が NumEat 回以上食事を行った場合はシミュレーションを終了する
- デッドロックを検出した場合は餓死確定とみなしてシミュレーションを終了する（Go ランタイムの標準機能¹）
- NumEat が 0 の場合は誰かが餓死しない限り処理を継続する

その他注意事項およびヒント

パラメータを含め，変数をグローバル変数として配置しない
以下のイベントに対してログを出力する。タイムスタンプはミリ秒単位
- 哲学者 X がフォークを持った
- 哲学者 X がフォークを戻した
- 哲学者 X が「食べる」を開始した
- 哲学者 X が「寝る」を開始した
- 哲学者 X が「考える」を開始した
- 哲学者 X が餓死した
シミュレーション部分に関しては Go の標準パッケージのみ使用する
哲学者の行動は goroutine による並行処理として実装する
フォークは哲学者間の共有資源とみなし mutex を使って排他制御を行う²
スパゲッティは無尽蔵かつ専有不可であるとみなし，排他制御の対象としない

こんなところかな。さぁ，みんなで考えよう！（続く）

参考図書

Go言語で学ぶ並行プログラミング　他言語にも適用できる原則とベストプラクティス impress top gearシリーズ: James Cutajar (著), 柴田芳樹 (著); インプレス 2024-12-04 (Release 2024-12-04); Kindle版; B0DNYMMBBQ (ASIN); 評価

reviewed by Spiegel on 2025-01-25 (powered by PA-APIv5)

Go言語による並行処理: Katherine Cox-Buday (著), 山口能迪 (翻訳); オライリージャパン 2018-10-26; 単行本（ソフトカバー）; 4873118468 (ASIN), 9784873118468 (EAN), 4873118468 (ISBN); 評価

[Comment] Eブック版もある。感想はこちら。 Go 言語で並行処理を書くならこの本は必読書になるだろう。

reviewed by Spiegel on 2020-01-13 (powered by PA-APIv5)

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

Go言語 100Tips ありがちなミスを把握し、実装を最適化する impress top gearシリーズ: Teiva Harsanyi (著), 柴田芳樹 (著); インプレス 2023-08-18 (Release 2023-08-18); Kindle版; B0CFL1DK8Q (ASIN); 評価

reviewed by Spiegel on 2023-08-18 (powered by PA-APIv5)

Goならわかるシステムプログラミング第2版: 渋川よしき (著), ごっちん (イラスト); ラムダノート 2022-03-23; 単行本（ソフトカバー）; 4908686122 (ASIN), 9784908686122 (EAN), 4908686122 (ISBN); 評価

[Comment] 第1版はとてもためになる内容だったので第2版も PDF 版で確保しておく。

reviewed by Spiegel on 2022-10-08 (powered by PA-APIv5)

Go ランタイムは全ての goroutine が停止するとデッドロックとみなしてプロセスを終了する。なお Sleep 等のタイマーやネットワーク通信などの一時停止状態は除く。 ↩︎
Go の標準パッケージでは semaphore は（ユーザが利用できる形では）提供されていない。事実上の準標準パッケージとしては golang.org/x/sync/semaphore が重み付きセマフォ（weighted semaphore）として公開されている。 ↩︎

『Go言語で学ぶ並行プログラミング』の練習問題より

2025-04-17T19:47:01+09:00

今回は読書会じゃなくて Bluesky からのネタ¹。

Go言語で学ぶ並行プログラミングの4章の hello world みたいな練習問題、すでにめっちゃ難しいんだけど、この答えの 26行目は lock とらないでいいの？ (4.3 練習問題 1) github.com/cutajarj/Con...

[image or embed]
— ikawaha (@ikawaha.bsky.social) April 16, 2025 at 11:57 PM

「4.3 練習問題」の1というのがこれ。

リスト 4.15（もともとは第 3 章から）は、共有変数へのアクセスを保護するためのミューテックスを使っていません。これは悪い習慣です。このプログラムを変更して、共有変数 seconds へのアクセスをミューテックスで保護するようにしてください。ヒント：変数をコピーする必要があるかもしれません。

『Go言語で学ぶ並行プログラミング』4.3節よりより

んで「リスト 4.15」というのがこちら：

package main

import (
    "fmt"
    "time"
)
func countdown(seconds *int) {
    for *seconds > 0 {
        time.Sleep(1 * time.Second)
        *seconds -= 1
    }
}

func main() {
    count := 5
    go countdown(&count)
    for count > 0 {
        time.Sleep(500 * time.Millisecond)
        fmt.Println(count)
    }
}

簡単なカウントダウンのプログラムだけど，カウントダウンを goroutine で実行しているのがポイント。 main() の count 変数が2つの goroutine で使われているの（countdown() 関数側は seconds）がお分かりだろうか。

で，この問題の回答は GitHub リポジトリで公開されている。こんな感じ：

package main

import (
    "fmt"
    "sync"
    "time"
)

func countdown(seconds *int, mutex *sync.Mutex) {
    mutex.Lock()
    remaining := *seconds
    mutex.Unlock()
    for remaining > 0 {
        time.Sleep(1 * time.Second)
        mutex.Lock()
        *seconds -= 1
        remaining = *seconds
        mutex.Unlock()
    }
}

func main() {
    mutex := sync.Mutex{}
    count := 5
    go countdown(&count, &mutex)
    remaining := count
    for remaining > 0 {
        time.Sleep(500 * time.Millisecond)
        mutex.Lock()
        fmt.Println(count)
        remaining = count
        mutex.Unlock()
    }
}

上で強調している行はロック取ってないよね，というのが最初のポストの内容というわけだ。

ちょっとややこしいのだが，もともとこの練習問題の回答としては

func main() {
    mutex := sync.Mutex{}
    count := 5
    go countdown(&count, &mutex)
    for count  > 0 {
        time.Sleep(500 * time.Millisecond)
        mutex.Lock()
        fmt.Println(count)
        mutex.Unlock()
    }
}

が提示されていたらしい（countdown() 関数は省略して main() 関数のみ挙げている）。これだと for ループの条件文で count を直接参照しているので拙いよね，という指摘があったのだが，この指摘に対応しようとして失敗しているように見える。

おそらく main() 関数を修正するのであれば以下が妥当だと思う。

func main() {
    mutex := sync.Mutex{}
    count := 5
    remaining := count
    go countdown(&count, &mutex)
    for remaining > 0 {
        fmt.Println(remaining)
        time.Sleep(500 * time.Millisecond)
        mutex.Lock()
        remaining = count
        mutex.Unlock()
    }
}

まず remaining 変数の初期化宣言を goroutine 起動前に行う。さらに for ループ内の fmt.Println() を remaining 変数を参照するよう変更する（こうすることで fmt.Println() をロックの外に出せる。なお，上のコードではカウント 0 を出力しないよう fmt.Println() 関数の位置を変えている）。

といったところだろうか。

問題は最初の回答コードでも，その後の不完全修正コードでも，たぶん支障なく動いてしまうところなんだよね。だってカウントダウンさせてる int 型の共有変数を参照してるだけだもん。参照時に多少の不整合が起きても，おそらく見た目では分からない。

著者の方も指摘に対して

Thank you for spotting this. This is proof that race conditions are easy to miss!

via GitHub Issue #2

と返しておられる通り，並行処理のデバッグがいかに難しいか分かる。ただ，共有変数 count へアクセスする際に「不変式が真²」であることをきちんと保証するためには，この実装をサボってはいけない。

Go に詳しい方なら「for 文で回さなくても channel を使えばいいし，なんなら atomic パッケージも使えるぢゃん」と思うだろう（そしてそれは正しい）が『Go言語で学ぶ並行プログラミング』では4章でようやく sync.Mutex が登場したところで， channel は7章， atomic パッケージは12章で登場する。あしからず。なお『Go言語で学ぶ並行プログラミング』本編には言及が見当たらないが sync.Mutex は再入不可である³。

参考図書

Go言語で学ぶ並行プログラミング　他言語にも適用できる原則とベストプラクティス impress top gearシリーズ: James Cutajar (著), 柴田芳樹 (著); インプレス 2024-12-04 (Release 2024-12-04); Kindle版; B0DNYMMBBQ (ASIN); 評価

reviewed by Spiegel on 2025-01-25 (powered by PA-APIv5)

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

Go言語 100Tips ありがちなミスを把握し、実装を最適化する impress top gearシリーズ: Teiva Harsanyi (著), 柴田芳樹 (著); インプレス 2023-08-18 (Release 2023-08-18); Kindle版; B0CFL1DK8Q (ASIN); 評価

reviewed by Spiegel on 2023-08-18 (powered by PA-APIv5)

Go言語による並行処理: Katherine Cox-Buday (著), 山口能迪 (翻訳); オライリージャパン 2018-10-26; 単行本（ソフトカバー）; 4873118468 (ASIN), 9784873118468 (EAN), 4873118468 (ISBN); 評価

[Comment] Eブック版もある。感想はこちら。 Go 言語で並行処理を書くならこの本は必読書になるだろう。

reviewed by Spiegel on 2020-01-13 (powered by PA-APIv5)

𝕏 の TL はホンマにウザいので，エンジニアの方々は Bluesky に来て欲しい，マジで。 ↩︎
不変式の話は『プログラミング言語Go』に出てくる。また『Go言語で学ぶ並行プログラミング』の「訳者あとがき」でも『プログラミング言語Go』の内容を紹介する形で説明がある。でも『プログラミング言語Go』は絶版状態なんだよなぁ orz ↩︎
再入云々については『Go言語で学ぶ並行プログラミング』の「訳者あとがき」に解説がある。たとえば Java のミューテックスは再入可能なため，その辺の差異について認識しておく必要がある。 ↩︎

条件変数とセマフォ（『Go言語で学ぶ並行プログラミング』読書会3回目）

2025-03-22T23:49:15+09:00

「第3回『Go言語で学ぶ並行プログラミング』オンライン読書会」の話題より。ちなみに第2回は記事にしていない。あしからず。

条件変数

条件変数（condition variable）は，ミューテックス（mutex）と組み合わせて，並行処理を特定の条件が発生するまで待たせたいときに使う。

Go では標準パッケージの sync.Cond 型で提供されている。こんな感じで使う。

cond := sync.NewCond(&sync.Mutex{})

ちなみに Java では

final Lock lock = new ReentrantLock();
final Condition condLock  = lock.newCondition();

みたいな感じにミューテックス・インスタンスから生成する。おそらく言語やライブラリやフレームワークによって色々あるだろう。

それはさておき『Go言語で学ぶ並行プログラミング』に出ていた例題は

Stingy と Spendy の２人の登場人物（goroutine）
２人は共通の銀行口座を持っていて現在100ドルの残高がある
Stingy は毎回10ドルずつ100万回入金する
Spendy は毎回50ドルずつ20万回出金する
銀行口座の残高をマイナスにしてはいけない（← ここが条件変数の条件）

という要件で入出金の様子をコードで書くというもの。過程をすっ飛ばして最終形を挙げておく。

package main

import (
    "fmt"
    "os"
    "sync"
    "time"
)

func main() {
    money := 100
    mutex := sync.Mutex{}
    cond := sync.NewCond(&mutex)
    go stingy(&money, cond)
    go spendy(&money, cond)
    time.Sleep(2 * time.Second)
    mutex.Lock()
    fmt.Println("Money in bank account: ", money)
    mutex.Unlock()
}

func stingy(money *int, cond *sync.Cond) {
    for i := 0; i < 1000000; i++ {
        cond.L.Lock()
        *money += 10
        cond.Signal()
        cond.L.Unlock()
    }
    fmt.Println("Stingy Done")
}

func spendy(money *int, cond *sync.Cond) {
    for i := 0; i < 200000; i++ {
        cond.L.Lock()
        for *money < 50 {
            cond.Wait()
        }
        *money -= 50
        if *money < 0 {
            fmt.Println("Money is negative!")
            os.Exit(1)
        }
        cond.L.Unlock()
    }
    fmt.Println("Spendy Done")
}

『Go言語で学ぶ並行プログラミング』第5章より

spendy() 関数内 cond.Wait() の動作は分かりにくいかもしれないが，内部ではミューテックスを解放して待ち状態に入っている。その後 Signal() を受け取ったらミューテックスを再取得して続きの処理を再開する。ここで *money < 50 の条件に合致すればループを抜けて出金操作を行うわけだ（合致しなければ再び Wait()）。

このコードの注意点は2つ。ひとつは Signal() や Wait() の前後は必ず Lock() ... Unlock() で囲っておくこと。もうひとつは Wait() 付近で条件を記述する際は if 文ではなく for 文でループを構成すること。後者はわかりやすいよね。前者は，たとえば以下のようなコードがあって

package main

import (
    "fmt"
    "sync"
)

/*
Note: this program has a bug for demonstration purposes
We demonstrate how to fix this problem in the next listing
*/
func doWork(cond *sync.Cond) {
    fmt.Println("Work started")
    fmt.Println("Work finished")
    cond.Signal()
}

func main() {
    cond := sync.NewCond(&sync.Mutex{})
    cond.L.Lock()
    for i := 0; i < 50000; i++ {
        go doWork(cond)
        fmt.Println("Waiting for child goroutine")
        cond.Wait()
        fmt.Println("Child goroutine finished")
    }
    cond.L.Unlock()
}

『Go言語で学ぶ並行プログラミング』第5章より

これを実行すると大抵は（Wait() で受ける相手が起動する前に Signal() を投げちゃうので）デッドロック状態になるのだが¹，状態によっては上手く動いてしまうことがあるのよ。動いたり動かなかったりするってのが一番厄介。

ちなみに Java の条件変数の場合は，ロックをせずにシグナルを投げようとすると例外が発生するらしい。

そういえばシグナルを投げるメソッドには Broadcast() もあり，こちらは Wait() で一時停止している全ての goroutine が起こされる。 Signal() と Broadcast() のどちらを使うかは状況によると思うが，読書会主催の柴田芳樹さんは対象の goroutine のうちどれが起きるのか明確に分からない場合は（ひとつだけ起こしたい場合でも）なるべく Signal() ではなく Broadcast() を使うべきだと言っておられた。 Wait() で待ち状態になっている側も，どういうタイミングで起こされるか分からないので，起こされたら必ず条件判定を行って条件に合致しなければ再び Wait() するという処理が必要になる。だからループを構成するんだねぇ。

書き込み優先な RWMutex

Go では，共有資源に対して

書き込みを行うスレッド（goroutine）はひとつだけ
読み込み専用スレッドは複数ある

場合に読み込み側と書き込み側で優先度の異なるロックをかける sync.RWMutex 型ってのがある。『Go言語で学ぶ並行プログラミング』の第4章では，標準の sync.RWMutex を使わずリーダー・ライター・ミューテックスを自作している。

ただし第4章で作ったのは読み込み優先の実装だったので，読み込み側が次々とロックを取ってしまうと，いつまで経っても書き込み側がロックを取れない事態になる²。この場合はデッドロックにもならないので，これはこれで厄介である。これを解消するためには書き込み側を優先するロックにする必要がある。第5章では，条件変数を用いて，自作リーダー・ライター・ミューテックスを書き込み優先に修正するくだりがある。

『Go言語で学ぶ並行プログラミング』は比較的簡単なサンプルコードで仕組みを紹介しているのがとてもいいと思う。

ちなみに標準の sync.RWMutex は書き込み優先である。

If any goroutine calls RWMutex.Lock while the lock is already held by one or more readers, concurrent calls to RWMutex.RLock will block until the writer has acquired (and released) the lock, to ensure that the lock eventually becomes available to the writer. Note that this prohibits recursive read-locking. A RWMutex.RLock cannot be upgraded into a RWMutex.Lock, nor can a RWMutex.Lock be downgraded into a RWMutex.RLock.

だから第4章では標準の sync.RWMutex を使わなかったんだねぇ。ここで繋がったよ（笑）

セマフォ

セマフォ（semaphore）は並行処理の同時実行数を制御する仕組みである。たとえば計算資源をフルに使わせたくない場合に，ある時点の並行処理の同時実行数を（おそらくプロセッサ数以下に）抑える目的で使ったりする。

『Go言語で学ぶ並行プログラミング』では条件変数を使ってセマフォを自作している。一方 Go の標準パッケージにセマフォはないが golang.org/x/sync/semaphore パッケージを使うことでセマフォを扱うことができる。こちらはほぼ標準パッケージに近いのでバンバン使っていいだろう。

この記事では golang.org/x/sync/semaphore パッケージに載っているサンプルコードを挙げておく。

package main

import (
    "context"
    "fmt"
    "log"
    "runtime"

    "golang.org/x/sync/semaphore"
)

// Example_workerPool demonstrates how to use a semaphore to limit the number of
// goroutines working on parallel tasks.
//
// This use of a semaphore mimics a typical “worker pool” pattern, but without
// the need to explicitly shut down idle workers when the work is done.
func main() {
    ctx := context.TODO()

    var (
        maxWorkers = runtime.GOMAXPROCS(0)
        sem        = semaphore.NewWeighted(int64(maxWorkers))
        out        = make([]int, 32)
    )

    // Compute the output using up to maxWorkers goroutines at a time.
    for i := range out {
        // When maxWorkers goroutines are in flight, Acquire blocks until one of the
        // workers finishes.
        if err := sem.Acquire(ctx, 1); err != nil {
            log.Printf("Failed to acquire semaphore: %v", err)
            break
        }

        go func(i int) {
            defer sem.Release(1)
            out[i] = collatzSteps(i + 1)
        }(i)
    }

    // Acquire all of the tokens to wait for any remaining workers to finish.
    //
    // If you are already waiting for the workers by some other means (such as an
    // errgroup.Group), you can omit this final Acquire call.
    if err := sem.Acquire(ctx, int64(maxWorkers)); err != nil {
        log.Printf("Failed to acquire semaphore: %v", err)
    }

    fmt.Println(out)

}

// collatzSteps computes the number of steps to reach 1 under the Collatz
// conjecture. (See https://en.wikipedia.org/wiki/Collatz_conjecture.)
func collatzSteps(n int) (steps int) {
    if n <= 0 {
        panic("nonpositive input")
    }

    for ; n > 1; steps++ {
        if steps < 0 {
            panic("too many steps")
        }

        if n%2 == 0 {
            n /= 2
            continue
        }

        const maxInt = int(^uint(0) >> 1)
        if n > (maxInt-1)/3 {
            panic("overflow")
        }
        n = 3*n + 1
    }

    return steps
}

via semaphore package - golang.org/x/sync/semaphore - Go Packages

コラッツ予想？このサンプルでは，メイン以外の goroutine の間では共有資源の異なるアドレスにアクセスするためデータ競合（data race）は起きないことに注意。データ競合が発生し得るのであればミューテックスを使ってアクセス制御を行う必要がある。

golang.org/x/sync/semaphore パッケージで実装されているセマフォは「重み付きセマフォ（weighted semaphore）」と呼ぶらしい。 Acquire() および Release() で獲得数・解放数を指定できる。上のサンプルコードでは最後の sem.Acquire(ctx, int64(maxWorkers)) でメイン以外の goroutine が稼働していないことを確認している（稼働していれば待ちになる）。なお Release() 時にカウントがマイナスになると panic を吐くようだ。

今回はここまで

次回は第6章の「バリア（barrier）」の話からである。楽しみ！

ブックマーク

cutajarj/ConcurrentProgrammingWithGo: Listings from manning book : 『Go言語で学ぶ並行プログラミング』に出てくるサンプルコード

参考図書

Go言語で学ぶ並行プログラミング　他言語にも適用できる原則とベストプラクティス impress top gearシリーズ: James Cutajar (著), 柴田芳樹 (著); インプレス 2024-12-04 (Release 2024-12-04); Kindle版; B0DNYMMBBQ (ASIN); 評価

reviewed by Spiegel on 2025-01-25 (powered by PA-APIv5)

Go言語 100Tips ありがちなミスを把握し、実装を最適化する impress top gearシリーズ: Teiva Harsanyi (著), 柴田芳樹 (著); インプレス 2023-08-18 (Release 2023-08-18); Kindle版; B0CFL1DK8Q (ASIN); 評価

reviewed by Spiegel on 2023-08-18 (powered by PA-APIv5)

Go言語による並行処理: Katherine Cox-Buday (著), 山口能迪 (翻訳); オライリージャパン 2018-10-26; 単行本（ソフトカバー）; 4873118468 (ASIN), 9784873118468 (EAN), 4873118468 (ISBN); 評価

[Comment] Eブック版もある。感想はこちら。 Go 言語で並行処理を書くならこの本は必読書になるだろう。

reviewed by Spiegel on 2020-01-13 (powered by PA-APIv5)

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

Go ではメインを含む全ての goroutine が待機状態になって（タイマーやシグナル等で）起こされる見込みがない状態を検出するとデッドロック（deadlock）と見なして panic を投げる。だから Go の並行処理ではデッドロックは検出しやすく，それゆえにデバッグも（比較的）しやすい。 ↩︎
リーダー・ライター・ミューテックスで書き込み側がいつまでもロックを獲得できない状態を writer-starvation と呼ぶ。『Go言語で学ぶ並行プログラミング』における “starvation” の定義は「他の貪欲な実行によって資源が長時間（または無期限に）利用できなくなり、共有資源へのアクセスを得ることができない状況を指します」としている。書き込み側が starvation になるから writer-starvation ということらしい。辞書的な “starvation” の意味は「食糧の不足によって栄養失調が続き、体調の維持が困難になっている状態」みたいな意味だそうな。継続的な飢餓状態ってことやね。 ↩︎

プログラミング言語 Go [text.Baldanders.info]

バージョンの埋め込みと表示

ビルド時にバージョン文字列を埋め込む

ビルド情報を表示する

go run ではビルド情報がセットされない

ブックマーク

参考図書

任意のイテレータを作る

Range Over Functions

iter パッケージ

slices パッケージ

maps パッケージ

改訂版： 土用期間中の干支を数え上げる

ブックマーク

参考図書

Go 公式のモジュール照会 API を試す

参考図書

Close 関数のエラーを無視しない（『効率的なGo』読書会より）

Close 関数のエラーを無視しない

最後まで読み切ってからクローズする

余談

参考図書

並行処理を待ち合わせる（WaitGroup と Barrier パターン）

タスクの完了を待ち合わせる

for ブロックのループ変数について

WaitGroup.Go メソッド

タスクの開始を待ち合わせる

ブックマーク

参考図書

struct2flag でコマンドライン解析【追記あり】

flag 標準パッケージによるコマンドライン解析

struct2flag でコマンドライン解析

【2025-10-18 追記】オプションの既定値を設定ファイルから取得する

【2025-10-18 追記】オプションの既定値を環境変数から取得する

【2025-10-19 追記】別解

ブックマーク

参考図書

“Philosophers” を Go で解く（CLI）

目次

コマンドライン・インタフェース

パラメータの定義

参考図書

“Philosophers” を Go で解く（問題編）

目次

基本ルール

パラメータおよび終了条件

その他 注意事項およびヒント

参考図書

『Go言語で学ぶ並行プログラミング』の練習問題より

参考図書

条件変数とセマフォ（『Go言語で学ぶ並行プログラミング』読書会3回目）

条件変数

書き込み優先な RWMutex

セマフォ

今回はここまで

ブックマーク

参考図書

改訂版：土用期間中の干支を数え上げる

その他注意事項およびヒント