Merge pull request #885 from devlights/add-os-open-benchmark

Author: devlights

examples/singleapp/os_open_benchmark/README.md

@@ -0,0 +1,22 @@
+# これは何？
+
+ファイル処理をする際に、[os.Open](https://pkg.go.dev/os@go1.23.5#Open)を毎回実施するのと、開きっぱなしで処理するのとでは、どれくらいパフォーマンスが違うのかについてのサンプルです。
+
+以下の記事を見て、自分用にサンプルとしてここに追加しました。
+
+- [os.Open自体のオーバーヘッドについて](https://qiita.com/Uchijo/items/9337a199040e06b96118)
+
+## 実行結果
+
+```sh
+ $ task -d examples/singleapp/os_open_benchmark/
+task: [default] go test . -bench=. -run=^$
+goos: linux
+goarch: amd64
+pkg: github.com/devlights/try-golang/examples/singleapp/os_open_benchmark
+cpu: AMD EPYC 7B13
+BenchmarkOsOpenEvery-16           118224              9920 ns/op
+BenchmarkOsOpenKeep-16            751408              1526 ns/op
+PASS
+ok      github.com/devlights/try-golang/examples/singleapp/os_open_benchmark    3.862s
+```

examples/singleapp/os_open_benchmark/Taskfile.yml

@@ -0,0 +1,10 @@
+# https://taskfile.dev
+
+version: '3'
+
+tasks:
+  default:
+    cmds:
+      - go vet .
+      - staticcheck .
+      - go test . -bench=. -run=^$

examples/singleapp/os_open_benchmark/benchmark_test.go

@@ -0,0 +1,81 @@
+package main
+
+import (
+	"io"
+	"os"
+	"testing"
+)
+
+var (
+	fname string
+	buf   = make([]byte, 10)
+)
+
+func setup() {
+	f, err := os.CreateTemp("", "trygolang-tmp-")
+	if err != nil {
+		panic(err)
+	}
+	defer f.Close()
+
+	_, err = f.Write([]byte("helloworld\n"))
+	if err != nil {
+		panic(err)
+	}
+
+	fname = f.Name()
+}
+
+func teardown() {
+	err := os.Remove(fname)
+	if err != nil {
+		panic(err)
+	}
+}
+
+func BenchmarkOsOpenEvery(b *testing.B) {
+	setup()
+	b.Cleanup(teardown)
+	b.ResetTimer()
+
+	for range b.N {
+		f, err := os.Open(fname)
+		if err != nil {
+			panic(err)
+		}
+		defer f.Close()
+
+		clear(buf)
+
+		_, err = f.Read(buf)
+		if err != nil {
+			panic(err)
+		}
+	}
+}
+
+func BenchmarkOsOpenKeep(b *testing.B) {
+	setup()
+	b.Cleanup(teardown)
+	b.ResetTimer()
+
+	f, err := os.Open(fname)
+	if err != nil {
+		panic(err)
+	}
+	defer f.Close()
+
+	for range b.N {
+		_, err = f.Seek(0, io.SeekStart)
+		if err != nil {
+			panic(err)
+		}
+
+		clear(buf)
+
+		_, err = f.Read(buf)
+		if err != nil {
+			panic(err)
+		}
+	}
+}