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
|
// Copyright (C) 2019-2023 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand. If not, see <https://www.gnu.org/licenses/>.
package agreement
import (
"fmt"
"io"
"os"
"path/filepath"
"github.com/algorand/go-algorand/config"
"github.com/algorand/go-algorand/logging"
"github.com/algorand/go-algorand/protocol"
)
//msgp:ignore cadaverEntryType
type cadaverEntryType int
const (
cadaverMetaEntry cadaverEntryType = iota
cadaverPlayerEntry
cadaverEventEntry
cadaverActionEntry
cadaverEOSEntry // denotes the end of a cadaver sequence
)
// CadaverMetadata contains informational metadata written to the top of every cadaver file
type CadaverMetadata struct {
NumOpened int
VersionCommitHash string
}
type cadaver struct {
overrideSetup bool // if true, do not execute code in trySetup
baseFilename string // no logging happens if this is ""
baseDirectory string // if empty, will be data directory
fileSizeTarget int64
out *cadaverHandle
numOpened int
failed error
prevRound round
prevPeriod period
}
func (c *cadaver) filename() string {
baseDir := c.baseDirectory
if baseDir == "" {
// Put cadaver files in our data directory
baseDir = config.GetCurrentVersion().DataDirectory
}
fmtstr := "%s.cdv"
return filepath.Join(baseDir, fmt.Sprintf(fmtstr, c.baseFilename))
}
func (c *cadaver) init() (err error) {
f, err := os.OpenFile(c.filename(), os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0600)
if err != nil {
return fmt.Errorf("cadaver: failed to create file %v: %v", c.filename(), err)
}
err = f.Chmod(0666)
if err != nil {
return err
}
c.out, err = makeCadaverHandle(f)
if err != nil {
return err
}
if c.out.bytesWritten > 0 {
// close out previous cadaver sequence
protocol.EncodeStream(c.out, cadaverEOSEntry)
}
protocol.EncodeStream(c.out, cadaverMetaEntry)
meta := CadaverMetadata{
NumOpened: c.numOpened,
VersionCommitHash: config.GetCurrentVersion().CommitHash,
}
protocol.EncodeStream(c.out, meta)
c.numOpened++
return nil
}
func (c *cadaver) trySetup() bool {
if c.overrideSetup {
return true
}
if c == nil {
return false
}
if c.baseFilename == "" {
return false
}
if c.failed != nil {
return false
}
if c.out == nil {
err := c.init()
if err != nil {
logging.Base().Warn(err)
c.failed = err
return false
}
}
if c.out.bytesWritten >= c.fileSizeTarget {
err := c.out.Close()
if err != nil {
logging.Base().Warnf("unable to close cadaver file : %v", err)
}
err = os.Rename(c.filename(), c.filename()+".archive")
if err != nil {
if os.IsNotExist(err) {
// we can't rename the cadaver file since it doesn't exists.
// this typically happens when it being externally deleted, and could happen
// far before we close the handle above.
logging.Base().Info(err)
} else {
logging.Base().Warn(err)
c.failed = err
return false
}
}
err = c.init()
if err != nil {
logging.Base().Warn(err)
c.failed = err
return false
}
}
return true
}
func (c *cadaver) trace(r round, p period, x player) (ok bool) {
if !c.trySetup() {
return false
}
if r != c.prevRound || p != c.prevPeriod {
c.prevRound = r
c.prevPeriod = p
protocol.EncodeStream(c.out, cadaverPlayerEntry)
protocol.EncodeStream(c.out, x)
}
return true
}
func (c *cadaver) traceInput(r round, p period, x player, e event) {
if !c.trace(r, p, x) {
return
}
protocol.EncodeStream(c.out, cadaverEventEntry)
protocol.EncodeStream(c.out, e.t())
protocol.EncodeStream(c.out, e)
}
func (c *cadaver) traceOutput(r round, p period, x player, a []action) {
if !c.trace(r, p, x) {
return
}
protocol.EncodeStream(c.out, cadaverActionEntry)
protocol.EncodeStream(c.out, len(a))
for _, a := range a {
protocol.EncodeStream(c.out, a.t())
protocol.EncodeStream(c.out, a)
}
}
type cadaverHandle struct {
io.WriteCloser
bytesWritten int64
}
func makeCadaverHandle(f *os.File) (h *cadaverHandle, err error) {
info, err := f.Stat()
if err != nil {
err = fmt.Errorf("cadaver: failed to stat file: %v", err)
return
}
h = new(cadaverHandle)
h.WriteCloser = f
h.bytesWritten = info.Size()
return
}
func (h *cadaverHandle) Write(p []byte) (n int, err error) {
n, err = h.WriteCloser.Write(p)
if err != nil {
return
}
h.bytesWritten += int64(n)
return
}
|
