-
Notifications
You must be signed in to change notification settings - Fork 0
/
log.go
234 lines (209 loc) · 6.43 KB
/
log.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
package log
import (
"io"
"os"
"path"
"sort"
"strconv"
"strings"
"sync"
api "github.com/ac0mz/proglog/api/v1"
)
// Log はセグメントの集合体であるsegmentsと書き込み対象のactiveSegmentを保持する。
// Dirにセグメントを保存する。
type Log struct {
mu sync.RWMutex
Dir string
Config Config
activeSegment *segment
segments []*segment
}
// NewLog はLogインスタンスを作成する。引数のConfigの値が未指定の場合はデフォルト値を設定する。
func NewLog(dir string, c Config) (*Log, error) {
if c.Segment.MaxStoreBytes == 0 {
c.Segment.MaxStoreBytes = 1024
}
if c.Segment.MaxIndexBytes == 0 {
c.Segment.MaxIndexBytes = 1024
}
l := &Log{
Dir: dir,
Config: c,
}
return l, l.setup()
}
// setup はセグメントの準備を行う。
func (l *Log) setup() error {
// ストレージ上に存在するセグメントの一覧を取得
files, err := os.ReadDir(l.Dir)
if err != nil {
return err
}
var baseOffsets []uint64
for _, file := range files {
// 各セグメントのファイル名からベースオフセットの値を導出してスライスに格納
offStr := strings.TrimSuffix(
file.Name(),
path.Ext(file.Name()),
)
off, _ := strconv.ParseUint(offStr, 10, 0)
baseOffsets = append(baseOffsets, off)
}
sort.Slice(baseOffsets, func(i, j int) bool {
// セグメントのスライスを古い順でソートする準備として、ベースオフセットをソート
return baseOffsets[i] < baseOffsets[j]
})
for i := 0; i < len(baseOffsets); i++ {
// 既存セグメント(インデックスとストア)を作成
if err := l.newSegment(baseOffsets[i]); err != nil {
return err
}
// baseOffsetsはインデックスとストアの2つの重複を含んでいるため、重複しているものをスキップ
i++
}
if l.segments == nil {
// 既存セグメントが存在しない場合、最初のセグメントを作成
if err = l.newSegment(l.Config.Segment.InitialOffset); err != nil {
return err
}
}
return nil
}
// newSegment は新たなセグメントを作成し、アクティブセグメントとする。
// 新規作成されたセグメントはセグメントのスライス末尾に追加される。
func (l *Log) newSegment(off uint64) error {
s, err := newSegment(l.Dir, off, l.Config)
if err != nil {
return err
}
l.segments = append(l.segments, s)
l.activeSegment = s
return nil
}
// Append はログにレコードを追加する。
// アクティブセグメントが最大サイズに到達していた場合、新たなセグメントを作成する。
func (l *Log) Append(record *api.Record) (uint64, error) {
// NOTE: 当該実装を最適化すれば、セグメント毎にロックを獲得することも可能
l.mu.Lock()
defer l.mu.Unlock()
highestOffset, err := l.highestOffset()
if err != nil {
return 0, err
}
if l.activeSegment.isMaxed() {
err = l.newSegment(highestOffset + 1)
if err != nil {
return 0, err
}
}
off, err := l.activeSegment.Append(record)
if err != nil {
return 0, err
}
return off, nil
}
// Read は指定されたオフセットに保存されているレコードをセグメントから読み出す。
func (l *Log) Read(off uint64) (*api.Record, error) {
l.mu.RLock()
defer l.mu.RUnlock()
var s *segment
for _, segment := range l.segments {
if segment.baseOffset <= off && off < segment.nextOffset {
// 指定されたオフセットがbaseOffset以上、かつnextOffsetより小さい最初のレコード
// ※古い順でセグメントが並んでおり、セグメントのbaseOffsetがセグメント内の最小オフセットのため
s = segment
break
}
}
if s == nil {
return nil, api.ErrOffsetOutOfRange{Offset: off}
}
return s.Read(off)
}
// Close はセグメントをすべて閉じる。
func (l *Log) Close() error {
l.mu.Lock()
defer l.mu.Unlock()
for _, segment := range l.segments {
if err := segment.Close(); err != nil {
return err
}
}
return nil
}
// Remove はログを閉じて、そのログのデータを削除する。
func (l *Log) Remove() error {
if err := l.Close(); err != nil {
return err
}
return os.RemoveAll(l.Dir)
}
// Reset はログを削除して、置き換える新たなログを作成する。
func (l *Log) Reset() error {
if err := l.Remove(); err != nil {
return err
}
return l.setup()
}
// LowestOffset は最古のオフセットを返却する。
func (l *Log) LowestOffset() (uint64, error) {
l.mu.RLock()
defer l.mu.RUnlock()
return l.segments[0].baseOffset, nil
}
// HighestOffset は現時点で最新のオフセット(nextOffsetの直前)を返却する。
func (l *Log) HighestOffset() (uint64, error) {
l.mu.RLock()
defer l.mu.RUnlock()
return l.highestOffset()
}
// highestOffset は現時点で最新のオフセットを返却する。
func (l *Log) highestOffset() (uint64, error) {
off := l.segments[len(l.segments)-1].nextOffset
if off == 0 {
return 0, nil
}
return off - 1, nil
}
// Truncate は最大オフセットがlowestよりも小さいセグメントをすべて削除する。
// ディスク容量を空けるためのメンテナンス用途として使用が想定される。
func (l *Log) Truncate(lowest uint64) error {
l.mu.Lock()
defer l.mu.Unlock()
var segments []*segment
for _, s := range l.segments {
if s.nextOffset <= lowest+1 {
if err := s.Remove(); err != nil {
return err
}
continue
}
segments = append(segments, s)
}
l.segments = segments
return nil
}
// Reader はログ全体を読み込むためのio.Readerを返却する。
// 合意形成の連携においてスナップショット、およびログの復旧ををサポートする場合に利用する。
func (l *Log) Reader() io.Reader {
l.mu.RLock()
defer l.mu.RUnlock()
readers := make([]io.Reader, len(l.segments))
for i, segment := range l.segments {
readers[i] = &originReader{segment.store, 0}
}
// セグメントのストアを連結
return io.MultiReader(readers...)
}
// originReader は次の理由からストアを保持する。
// 1. io.Readerインタフェースを満たし、それをio.MultiReader呼び出し時に渡すため。
// 2. ストアの最初から読み込みを開始し、そのファイル全体を読み込むことを保証するため。
type originReader struct {
*store
off int64
}
func (o originReader) Read(p []byte) (int, error) {
n, err := o.ReadAt(p, o.off)
o.off += int64(n)
return n, err
}