mirror of
https://github.com/status-im/consul.git
synced 2025-01-18 01:32:11 +00:00
02259ef964
The renaming of files from oss -> ce caused incorrect snapshots to be created due to ce writes now happening prior to ent writes. When this happens various entities will attempt to be restored from the snapshot prior to a partition existing and will cause a panic to occur.
115 lines
3.1 KiB
Go
115 lines
3.1 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package fsm
|
|
|
|
import (
|
|
"fmt"
|
|
"time"
|
|
|
|
"github.com/armon/go-metrics"
|
|
"github.com/armon/go-metrics/prometheus"
|
|
"github.com/hashicorp/go-raftchunking"
|
|
"github.com/hashicorp/raft"
|
|
|
|
"github.com/hashicorp/consul-net-rpc/go-msgpack/codec"
|
|
"github.com/hashicorp/consul/agent/consul/state"
|
|
"github.com/hashicorp/consul/agent/structs"
|
|
raftstorage "github.com/hashicorp/consul/internal/storage/raft"
|
|
)
|
|
|
|
var cePersister, entPersister persister
|
|
|
|
var SnapshotSummaries = []prometheus.SummaryDefinition{
|
|
{
|
|
Name: []string{"fsm", "persist"},
|
|
Help: "Measures the time it takes to persist the FSM to a raft snapshot.",
|
|
},
|
|
}
|
|
|
|
// snapshot is used to provide a snapshot of the current
|
|
// state in a way that can be accessed concurrently with operations
|
|
// that may modify the live state.
|
|
type snapshot struct {
|
|
state *state.Snapshot
|
|
chunkState *raftchunking.State
|
|
storageSnapshot *raftstorage.Snapshot
|
|
}
|
|
|
|
// SnapshotHeader is the first entry in our snapshot
|
|
type SnapshotHeader struct {
|
|
// LastIndex is the last index that affects the data.
|
|
// This is used when we do the restore for watchers.
|
|
LastIndex uint64
|
|
}
|
|
|
|
// persister is a function used to help snapshot the FSM state.
|
|
type persister func(s *snapshot, sink raft.SnapshotSink, encoder *codec.Encoder) error
|
|
|
|
// restorer is a function used to load back a snapshot of the FSM state.
|
|
type restorer func(header *SnapshotHeader, restore *state.Restore, decoder *codec.Decoder) error
|
|
|
|
// restorers is a map of restore functions by message type.
|
|
var restorers map[structs.MessageType]restorer
|
|
|
|
// registerRestorer adds a new helper. This should be called at package
|
|
// init() time.
|
|
func registerRestorer(msg structs.MessageType, fn restorer) {
|
|
if restorers == nil {
|
|
restorers = make(map[structs.MessageType]restorer)
|
|
}
|
|
if restorers[msg] != nil {
|
|
panic(fmt.Errorf("Message %d is already registered", msg))
|
|
}
|
|
restorers[msg] = fn
|
|
}
|
|
|
|
// Persist saves the FSM snapshot out to the given sink.
|
|
func (s *snapshot) Persist(sink raft.SnapshotSink) error {
|
|
defer metrics.MeasureSince([]string{"fsm", "persist"}, time.Now())
|
|
|
|
// Write the header
|
|
header := SnapshotHeader{
|
|
LastIndex: s.state.LastIndex(),
|
|
}
|
|
encoder := codec.NewEncoder(sink, structs.MsgpackHandle)
|
|
if err := encoder.Encode(&header); err != nil {
|
|
sink.Cancel()
|
|
return err
|
|
}
|
|
|
|
// Run all the persisters to write the FSM state.
|
|
for _, fn := range []persister{
|
|
// The enterprise version MUST be executed first, otherwise the snapshot will
|
|
// not properly function during restore due to missing tenancy objects.
|
|
entPersister,
|
|
cePersister,
|
|
} {
|
|
// Check for nil, since the enterprise version may not exist in CE.
|
|
if fn == nil {
|
|
continue
|
|
}
|
|
if err := fn(s, sink, encoder); err != nil {
|
|
sink.Cancel()
|
|
return err
|
|
}
|
|
}
|
|
|
|
// Persist chunking state
|
|
if s.chunkState == nil {
|
|
return nil
|
|
}
|
|
if _, err := sink.Write([]byte{byte(structs.ChunkingStateType)}); err != nil {
|
|
return err
|
|
}
|
|
if err := encoder.Encode(s.chunkState); err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (s *snapshot) Release() {
|
|
s.state.Close()
|
|
}
|