server.go 45 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552
  1. // Copyright 2015 The etcd Authors
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. package etcdserver
  15. import (
  16. "encoding/json"
  17. "expvar"
  18. "fmt"
  19. "math"
  20. "math/rand"
  21. "net/http"
  22. "os"
  23. "path"
  24. "regexp"
  25. "sync"
  26. "sync/atomic"
  27. "time"
  28. "github.com/coreos/etcd/alarm"
  29. "github.com/coreos/etcd/auth"
  30. "github.com/coreos/etcd/compactor"
  31. "github.com/coreos/etcd/discovery"
  32. "github.com/coreos/etcd/etcdserver/api"
  33. "github.com/coreos/etcd/etcdserver/api/v2http/httptypes"
  34. pb "github.com/coreos/etcd/etcdserver/etcdserverpb"
  35. "github.com/coreos/etcd/etcdserver/membership"
  36. "github.com/coreos/etcd/etcdserver/stats"
  37. "github.com/coreos/etcd/lease"
  38. "github.com/coreos/etcd/mvcc"
  39. "github.com/coreos/etcd/mvcc/backend"
  40. "github.com/coreos/etcd/pkg/fileutil"
  41. "github.com/coreos/etcd/pkg/idutil"
  42. "github.com/coreos/etcd/pkg/pbutil"
  43. "github.com/coreos/etcd/pkg/runtime"
  44. "github.com/coreos/etcd/pkg/schedule"
  45. "github.com/coreos/etcd/pkg/types"
  46. "github.com/coreos/etcd/pkg/wait"
  47. "github.com/coreos/etcd/raft"
  48. "github.com/coreos/etcd/raft/raftpb"
  49. "github.com/coreos/etcd/rafthttp"
  50. "github.com/coreos/etcd/snap"
  51. "github.com/coreos/etcd/store"
  52. "github.com/coreos/etcd/version"
  53. "github.com/coreos/etcd/wal"
  54. "github.com/coreos/go-semver/semver"
  55. "github.com/coreos/pkg/capnslog"
  56. "golang.org/x/net/context"
  57. )
  58. const (
  59. DefaultSnapCount = 10000
  60. StoreClusterPrefix = "/0"
  61. StoreKeysPrefix = "/1"
  62. // HealthInterval is the minimum time the cluster should be healthy
  63. // before accepting add member requests.
  64. HealthInterval = 5 * time.Second
  65. purgeFileInterval = 30 * time.Second
  66. // monitorVersionInterval should be smaller than the timeout
  67. // on the connection. Or we will not be able to reuse the connection
  68. // (since it will timeout).
  69. monitorVersionInterval = rafthttp.ConnWriteTimeout - time.Second
  70. databaseFilename = "db"
  71. // max number of in-flight snapshot messages etcdserver allows to have
  72. // This number is more than enough for most clusters with 5 machines.
  73. maxInFlightMsgSnap = 16
  74. releaseDelayAfterSnapshot = 30 * time.Second
  75. // maxPendingRevokes is the maximum number of outstanding expired lease revocations.
  76. maxPendingRevokes = 16
  77. )
  78. var (
  79. plog = capnslog.NewPackageLogger("github.com/coreos/etcd", "etcdserver")
  80. storeMemberAttributeRegexp = regexp.MustCompile(path.Join(membership.StoreMembersPrefix, "[[:xdigit:]]{1,16}", "attributes"))
  81. )
  82. func init() {
  83. rand.Seed(time.Now().UnixNano())
  84. expvar.Publish(
  85. "file_descriptor_limit",
  86. expvar.Func(
  87. func() interface{} {
  88. n, _ := runtime.FDLimit()
  89. return n
  90. },
  91. ),
  92. )
  93. }
  94. type Response struct {
  95. Event *store.Event
  96. Watcher store.Watcher
  97. err error
  98. }
  99. type Server interface {
  100. // Start performs any initialization of the Server necessary for it to
  101. // begin serving requests. It must be called before Do or Process.
  102. // Start must be non-blocking; any long-running server functionality
  103. // should be implemented in goroutines.
  104. Start()
  105. // Stop terminates the Server and performs any necessary finalization.
  106. // Do and Process cannot be called after Stop has been invoked.
  107. Stop()
  108. // ID returns the ID of the Server.
  109. ID() types.ID
  110. // Leader returns the ID of the leader Server.
  111. Leader() types.ID
  112. // Do takes a request and attempts to fulfill it, returning a Response.
  113. Do(ctx context.Context, r pb.Request) (Response, error)
  114. // Process takes a raft message and applies it to the server's raft state
  115. // machine, respecting any timeout of the given context.
  116. Process(ctx context.Context, m raftpb.Message) error
  117. // AddMember attempts to add a member into the cluster. It will return
  118. // ErrIDRemoved if member ID is removed from the cluster, or return
  119. // ErrIDExists if member ID exists in the cluster.
  120. AddMember(ctx context.Context, memb membership.Member) error
  121. // RemoveMember attempts to remove a member from the cluster. It will
  122. // return ErrIDRemoved if member ID is removed from the cluster, or return
  123. // ErrIDNotFound if member ID is not in the cluster.
  124. RemoveMember(ctx context.Context, id uint64) error
  125. // UpdateMember attempts to update an existing member in the cluster. It will
  126. // return ErrIDNotFound if the member ID does not exist.
  127. UpdateMember(ctx context.Context, updateMemb membership.Member) error
  128. // ClusterVersion is the cluster-wide minimum major.minor version.
  129. // Cluster version is set to the min version that an etcd member is
  130. // compatible with when first bootstrap.
  131. //
  132. // ClusterVersion is nil until the cluster is bootstrapped (has a quorum).
  133. //
  134. // During a rolling upgrades, the ClusterVersion will be updated
  135. // automatically after a sync. (5 second by default)
  136. //
  137. // The API/raft component can utilize ClusterVersion to determine if
  138. // it can accept a client request or a raft RPC.
  139. // NOTE: ClusterVersion might be nil when etcd 2.1 works with etcd 2.0 and
  140. // the leader is etcd 2.0. etcd 2.0 leader will not update clusterVersion since
  141. // this feature is introduced post 2.0.
  142. ClusterVersion() *semver.Version
  143. }
  144. // EtcdServer is the production implementation of the Server interface
  145. type EtcdServer struct {
  146. // inflightSnapshots holds count the number of snapshots currently inflight.
  147. inflightSnapshots int64 // must use atomic operations to access; keep 64-bit aligned.
  148. appliedIndex uint64 // must use atomic operations to access; keep 64-bit aligned.
  149. committedIndex uint64 // must use atomic operations to access; keep 64-bit aligned.
  150. // consistIndex used to hold the offset of current executing entry
  151. // It is initialized to 0 before executing any entry.
  152. consistIndex consistentIndex // must use atomic operations to access; keep 64-bit aligned.
  153. Cfg *ServerConfig
  154. readych chan struct{}
  155. r raftNode
  156. snapCount uint64
  157. w wait.Wait
  158. readMu sync.RWMutex
  159. // read routine notifies etcd server that it waits for reading by sending an empty struct to
  160. // readwaitC
  161. readwaitc chan struct{}
  162. // readNotifier is used to notify the read routine that it can process the request
  163. // when there is no error
  164. readNotifier *notifier
  165. // stop signals the run goroutine should shutdown.
  166. stop chan struct{}
  167. // stopping is closed by run goroutine on shutdown.
  168. stopping chan struct{}
  169. // done is closed when all goroutines from start() complete.
  170. done chan struct{}
  171. errorc chan error
  172. id types.ID
  173. attributes membership.Attributes
  174. cluster *membership.RaftCluster
  175. store store.Store
  176. applyV2 ApplierV2
  177. // applyV3 is the applier with auth and quotas
  178. applyV3 applierV3
  179. // applyV3Base is the core applier without auth or quotas
  180. applyV3Base applierV3
  181. applyWait wait.WaitTime
  182. kv mvcc.ConsistentWatchableKV
  183. lessor lease.Lessor
  184. bemu sync.Mutex
  185. be backend.Backend
  186. authStore auth.AuthStore
  187. alarmStore *alarm.AlarmStore
  188. stats *stats.ServerStats
  189. lstats *stats.LeaderStats
  190. SyncTicker <-chan time.Time
  191. // compactor is used to auto-compact the KV.
  192. compactor *compactor.Periodic
  193. // peerRt used to send requests (version, lease) to peers.
  194. peerRt http.RoundTripper
  195. reqIDGen *idutil.Generator
  196. // forceVersionC is used to force the version monitor loop
  197. // to detect the cluster version immediately.
  198. forceVersionC chan struct{}
  199. msgSnapC chan raftpb.Message
  200. // wg is used to wait for the go routines that depends on the server state
  201. // to exit when stopping the server.
  202. wg sync.WaitGroup
  203. }
  204. // NewServer creates a new EtcdServer from the supplied configuration. The
  205. // configuration is considered static for the lifetime of the EtcdServer.
  206. func NewServer(cfg *ServerConfig) (srv *EtcdServer, err error) {
  207. st := store.New(StoreClusterPrefix, StoreKeysPrefix)
  208. var (
  209. w *wal.WAL
  210. n raft.Node
  211. s *raft.MemoryStorage
  212. id types.ID
  213. cl *membership.RaftCluster
  214. )
  215. if terr := fileutil.TouchDirAll(cfg.DataDir); terr != nil {
  216. return nil, fmt.Errorf("cannot access data directory: %v", terr)
  217. }
  218. haveWAL := wal.Exist(cfg.WALDir())
  219. if err = fileutil.TouchDirAll(cfg.SnapDir()); err != nil {
  220. plog.Fatalf("create snapshot directory error: %v", err)
  221. }
  222. ss := snap.New(cfg.SnapDir())
  223. bepath := path.Join(cfg.SnapDir(), databaseFilename)
  224. beExist := fileutil.Exist(bepath)
  225. be := backend.NewDefaultBackend(bepath)
  226. defer func() {
  227. if err != nil {
  228. be.Close()
  229. }
  230. }()
  231. prt, err := rafthttp.NewRoundTripper(cfg.PeerTLSInfo, cfg.peerDialTimeout())
  232. if err != nil {
  233. return nil, err
  234. }
  235. var (
  236. remotes []*membership.Member
  237. snapshot *raftpb.Snapshot
  238. )
  239. switch {
  240. case !haveWAL && !cfg.NewCluster:
  241. if err = cfg.VerifyJoinExisting(); err != nil {
  242. return nil, err
  243. }
  244. cl, err = membership.NewClusterFromURLsMap(cfg.InitialClusterToken, cfg.InitialPeerURLsMap)
  245. if err != nil {
  246. return nil, err
  247. }
  248. existingCluster, gerr := GetClusterFromRemotePeers(getRemotePeerURLs(cl, cfg.Name), prt)
  249. if gerr != nil {
  250. return nil, fmt.Errorf("cannot fetch cluster info from peer urls: %v", gerr)
  251. }
  252. if err = membership.ValidateClusterAndAssignIDs(cl, existingCluster); err != nil {
  253. return nil, fmt.Errorf("error validating peerURLs %s: %v", existingCluster, err)
  254. }
  255. if !isCompatibleWithCluster(cl, cl.MemberByName(cfg.Name).ID, prt) {
  256. return nil, fmt.Errorf("incompatible with current running cluster")
  257. }
  258. remotes = existingCluster.Members()
  259. cl.SetID(existingCluster.ID())
  260. cl.SetStore(st)
  261. cl.SetBackend(be)
  262. cfg.Print()
  263. id, n, s, w = startNode(cfg, cl, nil)
  264. case !haveWAL && cfg.NewCluster:
  265. if err = cfg.VerifyBootstrap(); err != nil {
  266. return nil, err
  267. }
  268. cl, err = membership.NewClusterFromURLsMap(cfg.InitialClusterToken, cfg.InitialPeerURLsMap)
  269. if err != nil {
  270. return nil, err
  271. }
  272. m := cl.MemberByName(cfg.Name)
  273. if isMemberBootstrapped(cl, cfg.Name, prt, cfg.bootstrapTimeout()) {
  274. return nil, fmt.Errorf("member %s has already been bootstrapped", m.ID)
  275. }
  276. if cfg.ShouldDiscover() {
  277. var str string
  278. str, err = discovery.JoinCluster(cfg.DiscoveryURL, cfg.DiscoveryProxy, m.ID, cfg.InitialPeerURLsMap.String())
  279. if err != nil {
  280. return nil, &DiscoveryError{Op: "join", Err: err}
  281. }
  282. var urlsmap types.URLsMap
  283. urlsmap, err = types.NewURLsMap(str)
  284. if err != nil {
  285. return nil, err
  286. }
  287. if checkDuplicateURL(urlsmap) {
  288. return nil, fmt.Errorf("discovery cluster %s has duplicate url", urlsmap)
  289. }
  290. if cl, err = membership.NewClusterFromURLsMap(cfg.InitialClusterToken, urlsmap); err != nil {
  291. return nil, err
  292. }
  293. }
  294. cl.SetStore(st)
  295. cl.SetBackend(be)
  296. cfg.PrintWithInitial()
  297. id, n, s, w = startNode(cfg, cl, cl.MemberIDs())
  298. case haveWAL:
  299. if err = fileutil.IsDirWriteable(cfg.MemberDir()); err != nil {
  300. return nil, fmt.Errorf("cannot write to member directory: %v", err)
  301. }
  302. if err = fileutil.IsDirWriteable(cfg.WALDir()); err != nil {
  303. return nil, fmt.Errorf("cannot write to WAL directory: %v", err)
  304. }
  305. if cfg.ShouldDiscover() {
  306. plog.Warningf("discovery token ignored since a cluster has already been initialized. Valid log found at %q", cfg.WALDir())
  307. }
  308. snapshot, err = ss.Load()
  309. if err != nil && err != snap.ErrNoSnapshot {
  310. return nil, err
  311. }
  312. if snapshot != nil {
  313. if err = st.Recovery(snapshot.Data); err != nil {
  314. plog.Panicf("recovered store from snapshot error: %v", err)
  315. }
  316. plog.Infof("recovered store from snapshot at index %d", snapshot.Metadata.Index)
  317. }
  318. cfg.Print()
  319. if !cfg.ForceNewCluster {
  320. id, cl, n, s, w = restartNode(cfg, snapshot)
  321. } else {
  322. id, cl, n, s, w = restartAsStandaloneNode(cfg, snapshot)
  323. }
  324. cl.SetStore(st)
  325. cl.SetBackend(be)
  326. cl.Recover(api.UpdateCapability)
  327. if cl.Version() != nil && !cl.Version().LessThan(semver.Version{Major: 3}) && !beExist {
  328. os.RemoveAll(bepath)
  329. return nil, fmt.Errorf("database file (%v) of the backend is missing", bepath)
  330. }
  331. default:
  332. return nil, fmt.Errorf("unsupported bootstrap config")
  333. }
  334. if terr := fileutil.TouchDirAll(cfg.MemberDir()); terr != nil {
  335. return nil, fmt.Errorf("cannot access member directory: %v", terr)
  336. }
  337. sstats := &stats.ServerStats{
  338. Name: cfg.Name,
  339. ID: id.String(),
  340. }
  341. sstats.Initialize()
  342. lstats := stats.NewLeaderStats(id.String())
  343. srv = &EtcdServer{
  344. readych: make(chan struct{}),
  345. Cfg: cfg,
  346. snapCount: cfg.SnapCount,
  347. errorc: make(chan error, 1),
  348. store: st,
  349. r: raftNode{
  350. Node: n,
  351. ticker: time.Tick(time.Duration(cfg.TickMs) * time.Millisecond),
  352. raftStorage: s,
  353. storage: NewStorage(w, ss),
  354. readStateC: make(chan raft.ReadState, 1),
  355. },
  356. id: id,
  357. attributes: membership.Attributes{Name: cfg.Name, ClientURLs: cfg.ClientURLs.StringSlice()},
  358. cluster: cl,
  359. stats: sstats,
  360. lstats: lstats,
  361. SyncTicker: time.Tick(500 * time.Millisecond),
  362. peerRt: prt,
  363. reqIDGen: idutil.NewGenerator(uint16(id), time.Now()),
  364. forceVersionC: make(chan struct{}),
  365. msgSnapC: make(chan raftpb.Message, maxInFlightMsgSnap),
  366. }
  367. srv.applyV2 = &applierV2store{store: srv.store, cluster: srv.cluster}
  368. srv.be = be
  369. minTTL := time.Duration((3*cfg.ElectionTicks)/2) * time.Duration(cfg.TickMs) * time.Millisecond
  370. // always recover lessor before kv. When we recover the mvcc.KV it will reattach keys to its leases.
  371. // If we recover mvcc.KV first, it will attach the keys to the wrong lessor before it recovers.
  372. srv.lessor = lease.NewLessor(srv.be, int64(math.Ceil(minTTL.Seconds())))
  373. srv.kv = mvcc.New(srv.be, srv.lessor, &srv.consistIndex)
  374. if beExist {
  375. kvindex := srv.kv.ConsistentIndex()
  376. // TODO: remove kvindex != 0 checking when we do not expect users to upgrade
  377. // etcd from pre-3.0 release.
  378. if snapshot != nil && kvindex < snapshot.Metadata.Index {
  379. if kvindex != 0 {
  380. return nil, fmt.Errorf("database file (%v index %d) does not match with snapshot (index %d).", bepath, kvindex, snapshot.Metadata.Index)
  381. }
  382. plog.Warningf("consistent index never saved (snapshot index=%d)", snapshot.Metadata.Index)
  383. }
  384. }
  385. srv.consistIndex.setConsistentIndex(srv.kv.ConsistentIndex())
  386. srv.authStore = auth.NewAuthStore(srv.be)
  387. if h := cfg.AutoCompactionRetention; h != 0 {
  388. srv.compactor = compactor.NewPeriodic(h, srv.kv, srv)
  389. srv.compactor.Run()
  390. }
  391. srv.applyV3Base = &applierV3backend{srv}
  392. if err = srv.restoreAlarms(); err != nil {
  393. return nil, err
  394. }
  395. // TODO: move transport initialization near the definition of remote
  396. tr := &rafthttp.Transport{
  397. TLSInfo: cfg.PeerTLSInfo,
  398. DialTimeout: cfg.peerDialTimeout(),
  399. ID: id,
  400. URLs: cfg.PeerURLs,
  401. ClusterID: cl.ID(),
  402. Raft: srv,
  403. Snapshotter: ss,
  404. ServerStats: sstats,
  405. LeaderStats: lstats,
  406. ErrorC: srv.errorc,
  407. }
  408. if err = tr.Start(); err != nil {
  409. return nil, err
  410. }
  411. // add all remotes into transport
  412. for _, m := range remotes {
  413. if m.ID != id {
  414. tr.AddRemote(m.ID, m.PeerURLs)
  415. }
  416. }
  417. for _, m := range cl.Members() {
  418. if m.ID != id {
  419. tr.AddPeer(m.ID, m.PeerURLs)
  420. }
  421. }
  422. srv.r.transport = tr
  423. return srv, nil
  424. }
  425. // Start prepares and starts server in a new goroutine. It is no longer safe to
  426. // modify a server's fields after it has been sent to Start.
  427. // It also starts a goroutine to publish its server information.
  428. func (s *EtcdServer) Start() {
  429. s.start()
  430. s.goAttach(func() { s.publish(s.Cfg.ReqTimeout()) })
  431. s.goAttach(s.purgeFile)
  432. s.goAttach(func() { monitorFileDescriptor(s.stopping) })
  433. s.goAttach(s.monitorVersions)
  434. s.goAttach(s.linearizableReadLoop)
  435. }
  436. // start prepares and starts server in a new goroutine. It is no longer safe to
  437. // modify a server's fields after it has been sent to Start.
  438. // This function is just used for testing.
  439. func (s *EtcdServer) start() {
  440. if s.snapCount == 0 {
  441. plog.Infof("set snapshot count to default %d", DefaultSnapCount)
  442. s.snapCount = DefaultSnapCount
  443. }
  444. s.w = wait.New()
  445. s.applyWait = wait.NewTimeList()
  446. s.done = make(chan struct{})
  447. s.stop = make(chan struct{})
  448. s.stopping = make(chan struct{})
  449. s.readwaitc = make(chan struct{}, 1)
  450. s.readNotifier = newNotifier()
  451. if s.ClusterVersion() != nil {
  452. plog.Infof("starting server... [version: %v, cluster version: %v]", version.Version, version.Cluster(s.ClusterVersion().String()))
  453. } else {
  454. plog.Infof("starting server... [version: %v, cluster version: to_be_decided]", version.Version)
  455. }
  456. // TODO: if this is an empty log, writes all peer infos
  457. // into the first entry
  458. go s.run()
  459. }
  460. func (s *EtcdServer) purgeFile() {
  461. var serrc, werrc <-chan error
  462. if s.Cfg.MaxSnapFiles > 0 {
  463. serrc = fileutil.PurgeFile(s.Cfg.SnapDir(), "snap", s.Cfg.MaxSnapFiles, purgeFileInterval, s.done)
  464. }
  465. if s.Cfg.MaxWALFiles > 0 {
  466. werrc = fileutil.PurgeFile(s.Cfg.WALDir(), "wal", s.Cfg.MaxWALFiles, purgeFileInterval, s.done)
  467. }
  468. select {
  469. case e := <-werrc:
  470. plog.Fatalf("failed to purge wal file %v", e)
  471. case e := <-serrc:
  472. plog.Fatalf("failed to purge snap file %v", e)
  473. case <-s.stopping:
  474. return
  475. }
  476. }
  477. func (s *EtcdServer) ID() types.ID { return s.id }
  478. func (s *EtcdServer) Cluster() *membership.RaftCluster { return s.cluster }
  479. func (s *EtcdServer) RaftHandler() http.Handler { return s.r.transport.Handler() }
  480. func (s *EtcdServer) Lessor() lease.Lessor { return s.lessor }
  481. func (s *EtcdServer) Process(ctx context.Context, m raftpb.Message) error {
  482. if s.cluster.IsIDRemoved(types.ID(m.From)) {
  483. plog.Warningf("reject message from removed member %s", types.ID(m.From).String())
  484. return httptypes.NewHTTPError(http.StatusForbidden, "cannot process message from removed member")
  485. }
  486. if m.Type == raftpb.MsgApp {
  487. s.stats.RecvAppendReq(types.ID(m.From).String(), m.Size())
  488. }
  489. return s.r.Step(ctx, m)
  490. }
  491. func (s *EtcdServer) IsIDRemoved(id uint64) bool { return s.cluster.IsIDRemoved(types.ID(id)) }
  492. func (s *EtcdServer) ReportUnreachable(id uint64) { s.r.ReportUnreachable(id) }
  493. // ReportSnapshot reports snapshot sent status to the raft state machine,
  494. // and clears the used snapshot from the snapshot store.
  495. func (s *EtcdServer) ReportSnapshot(id uint64, status raft.SnapshotStatus) {
  496. s.r.ReportSnapshot(id, status)
  497. }
  498. type etcdProgress struct {
  499. confState raftpb.ConfState
  500. snapi uint64
  501. appliedi uint64
  502. }
  503. func (s *EtcdServer) run() {
  504. snap, err := s.r.raftStorage.Snapshot()
  505. if err != nil {
  506. plog.Panicf("get snapshot from raft storage error: %v", err)
  507. }
  508. s.r.start(s)
  509. // asynchronously accept apply packets, dispatch progress in-order
  510. sched := schedule.NewFIFOScheduler()
  511. ep := etcdProgress{
  512. confState: snap.Metadata.ConfState,
  513. snapi: snap.Metadata.Index,
  514. appliedi: snap.Metadata.Index,
  515. }
  516. defer func() {
  517. close(s.stopping)
  518. sched.Stop()
  519. // wait for gouroutines before closing raft so wal stays open
  520. s.wg.Wait()
  521. // must stop raft after scheduler-- etcdserver can leak rafthttp pipelines
  522. // by adding a peer after raft stops the transport
  523. s.r.stop()
  524. // kv, lessor and backend can be nil if running without v3 enabled
  525. // or running unit tests.
  526. if s.lessor != nil {
  527. s.lessor.Stop()
  528. }
  529. if s.kv != nil {
  530. s.kv.Close()
  531. }
  532. if s.be != nil {
  533. s.be.Close()
  534. }
  535. if s.compactor != nil {
  536. s.compactor.Stop()
  537. }
  538. close(s.done)
  539. }()
  540. var expiredLeaseC <-chan []*lease.Lease
  541. if s.lessor != nil {
  542. expiredLeaseC = s.lessor.ExpiredLeasesC()
  543. }
  544. for {
  545. select {
  546. case ap := <-s.r.apply():
  547. var ci uint64
  548. if len(ap.entries) != 0 {
  549. ci = ap.entries[len(ap.entries)-1].Index
  550. }
  551. if ap.snapshot.Metadata.Index > ci {
  552. ci = ap.snapshot.Metadata.Index
  553. }
  554. if ci != 0 {
  555. s.setCommittedIndex(ci)
  556. }
  557. f := func(context.Context) { s.applyAll(&ep, &ap) }
  558. sched.Schedule(f)
  559. case leases := <-expiredLeaseC:
  560. s.goAttach(func() {
  561. // Increases throughput of expired leases deletion process through parallelization
  562. c := make(chan struct{}, maxPendingRevokes)
  563. for _, lease := range leases {
  564. select {
  565. case c <- struct{}{}:
  566. case <-s.stopping:
  567. return
  568. }
  569. lid := lease.ID
  570. s.goAttach(func() {
  571. s.LeaseRevoke(context.TODO(), &pb.LeaseRevokeRequest{ID: int64(lid)})
  572. <-c
  573. })
  574. }
  575. })
  576. case err := <-s.errorc:
  577. plog.Errorf("%s", err)
  578. plog.Infof("the data-dir used by this member must be removed.")
  579. return
  580. case <-s.stop:
  581. return
  582. }
  583. }
  584. }
  585. func (s *EtcdServer) applyAll(ep *etcdProgress, apply *apply) {
  586. s.applySnapshot(ep, apply)
  587. st := time.Now()
  588. s.applyEntries(ep, apply)
  589. d := time.Since(st)
  590. entriesNum := len(apply.entries)
  591. if entriesNum != 0 && d > time.Duration(entriesNum)*warnApplyDuration {
  592. plog.Warningf("apply entries took too long [%v for %d entries]", d, len(apply.entries))
  593. plog.Warningf("avoid queries with large range/delete range!")
  594. }
  595. proposalsApplied.Set(float64(ep.appliedi))
  596. s.applyWait.Trigger(ep.appliedi)
  597. // wait for the raft routine to finish the disk writes before triggering a
  598. // snapshot. or applied index might be greater than the last index in raft
  599. // storage, since the raft routine might be slower than apply routine.
  600. <-apply.raftDone
  601. s.triggerSnapshot(ep)
  602. select {
  603. // snapshot requested via send()
  604. case m := <-s.msgSnapC:
  605. merged := s.createMergedSnapshotMessage(m, ep.appliedi, ep.confState)
  606. s.sendMergedSnap(merged)
  607. default:
  608. }
  609. }
  610. func (s *EtcdServer) applySnapshot(ep *etcdProgress, apply *apply) {
  611. if raft.IsEmptySnap(apply.snapshot) {
  612. return
  613. }
  614. plog.Infof("applying snapshot at index %d...", ep.snapi)
  615. defer plog.Infof("finished applying incoming snapshot at index %d", ep.snapi)
  616. if apply.snapshot.Metadata.Index <= ep.appliedi {
  617. plog.Panicf("snapshot index [%d] should > appliedi[%d] + 1",
  618. apply.snapshot.Metadata.Index, ep.appliedi)
  619. }
  620. snapfn, err := s.r.storage.DBFilePath(apply.snapshot.Metadata.Index)
  621. if err != nil {
  622. plog.Panicf("get database snapshot file path error: %v", err)
  623. }
  624. fn := path.Join(s.Cfg.SnapDir(), databaseFilename)
  625. if err := os.Rename(snapfn, fn); err != nil {
  626. plog.Panicf("rename snapshot file error: %v", err)
  627. }
  628. newbe := backend.NewDefaultBackend(fn)
  629. // always recover lessor before kv. When we recover the mvcc.KV it will reattach keys to its leases.
  630. // If we recover mvcc.KV first, it will attach the keys to the wrong lessor before it recovers.
  631. if s.lessor != nil {
  632. plog.Info("recovering lessor...")
  633. s.lessor.Recover(newbe, s.kv)
  634. plog.Info("finished recovering lessor")
  635. }
  636. plog.Info("restoring mvcc store...")
  637. if err := s.kv.Restore(newbe); err != nil {
  638. plog.Panicf("restore KV error: %v", err)
  639. }
  640. s.consistIndex.setConsistentIndex(s.kv.ConsistentIndex())
  641. plog.Info("finished restoring mvcc store")
  642. // Closing old backend might block until all the txns
  643. // on the backend are finished.
  644. // We do not want to wait on closing the old backend.
  645. s.bemu.Lock()
  646. oldbe := s.be
  647. go func() {
  648. plog.Info("closing old backend...")
  649. defer plog.Info("finished closing old backend")
  650. if err := oldbe.Close(); err != nil {
  651. plog.Panicf("close backend error: %v", err)
  652. }
  653. }()
  654. s.be = newbe
  655. s.bemu.Unlock()
  656. plog.Info("recovering alarms...")
  657. if err := s.restoreAlarms(); err != nil {
  658. plog.Panicf("restore alarms error: %v", err)
  659. }
  660. plog.Info("finished recovering alarms")
  661. if s.authStore != nil {
  662. plog.Info("recovering auth store...")
  663. s.authStore.Recover(newbe)
  664. plog.Info("finished recovering auth store")
  665. }
  666. plog.Info("recovering store v2...")
  667. if err := s.store.Recovery(apply.snapshot.Data); err != nil {
  668. plog.Panicf("recovery store error: %v", err)
  669. }
  670. plog.Info("finished recovering store v2")
  671. s.cluster.SetBackend(s.be)
  672. plog.Info("recovering cluster configuration...")
  673. s.cluster.Recover(api.UpdateCapability)
  674. plog.Info("finished recovering cluster configuration")
  675. plog.Info("removing old peers from network...")
  676. // recover raft transport
  677. s.r.transport.RemoveAllPeers()
  678. plog.Info("finished removing old peers from network")
  679. plog.Info("adding peers from new cluster configuration into network...")
  680. for _, m := range s.cluster.Members() {
  681. if m.ID == s.ID() {
  682. continue
  683. }
  684. s.r.transport.AddPeer(m.ID, m.PeerURLs)
  685. }
  686. plog.Info("finished adding peers from new cluster configuration into network...")
  687. ep.appliedi = apply.snapshot.Metadata.Index
  688. ep.snapi = ep.appliedi
  689. ep.confState = apply.snapshot.Metadata.ConfState
  690. }
  691. func (s *EtcdServer) applyEntries(ep *etcdProgress, apply *apply) {
  692. if len(apply.entries) == 0 {
  693. return
  694. }
  695. firsti := apply.entries[0].Index
  696. if firsti > ep.appliedi+1 {
  697. plog.Panicf("first index of committed entry[%d] should <= appliedi[%d] + 1", firsti, ep.appliedi)
  698. }
  699. var ents []raftpb.Entry
  700. if ep.appliedi+1-firsti < uint64(len(apply.entries)) {
  701. ents = apply.entries[ep.appliedi+1-firsti:]
  702. }
  703. if len(ents) == 0 {
  704. return
  705. }
  706. var shouldstop bool
  707. if ep.appliedi, shouldstop = s.apply(ents, &ep.confState); shouldstop {
  708. go s.stopWithDelay(10*100*time.Millisecond, fmt.Errorf("the member has been permanently removed from the cluster"))
  709. }
  710. }
  711. func (s *EtcdServer) triggerSnapshot(ep *etcdProgress) {
  712. if ep.appliedi-ep.snapi <= s.snapCount {
  713. return
  714. }
  715. plog.Infof("start to snapshot (applied: %d, lastsnap: %d)", ep.appliedi, ep.snapi)
  716. s.snapshot(ep.appliedi, ep.confState)
  717. ep.snapi = ep.appliedi
  718. }
  719. func (s *EtcdServer) isMultiNode() bool {
  720. return s.cluster != nil && len(s.cluster.MemberIDs()) > 1
  721. }
  722. func (s *EtcdServer) isLeader() bool {
  723. return uint64(s.ID()) == s.Lead()
  724. }
  725. // transferLeadership transfers the leader to the given transferee.
  726. // TODO: maybe expose to client?
  727. func (s *EtcdServer) transferLeadership(ctx context.Context, lead, transferee uint64) error {
  728. now := time.Now()
  729. interval := time.Duration(s.Cfg.TickMs) * time.Millisecond
  730. plog.Infof("%s starts leadership transfer from %s to %s", s.ID(), types.ID(lead), types.ID(transferee))
  731. s.r.TransferLeadership(ctx, lead, transferee)
  732. for s.Lead() != transferee {
  733. select {
  734. case <-ctx.Done(): // time out
  735. return ErrTimeoutLeaderTransfer
  736. case <-time.After(interval):
  737. }
  738. }
  739. // TODO: drain all requests, or drop all messages to the old leader
  740. plog.Infof("%s finished leadership transfer from %s to %s (took %v)", s.ID(), types.ID(lead), types.ID(transferee), time.Since(now))
  741. return nil
  742. }
  743. // TransferLeadership transfers the leader to the chosen transferee.
  744. func (s *EtcdServer) TransferLeadership() error {
  745. if !s.isLeader() {
  746. plog.Printf("skipped leadership transfer for stopping non-leader member")
  747. return nil
  748. }
  749. if !s.isMultiNode() {
  750. plog.Printf("skipped leadership transfer for single member cluster")
  751. return nil
  752. }
  753. transferee, ok := longestConnected(s.r.transport, s.cluster.MemberIDs())
  754. if !ok {
  755. return ErrUnhealthy
  756. }
  757. tm := s.Cfg.ReqTimeout()
  758. ctx, cancel := context.WithTimeout(context.TODO(), tm)
  759. err := s.transferLeadership(ctx, s.Lead(), uint64(transferee))
  760. cancel()
  761. return err
  762. }
  763. // HardStop stops the server without coordination with other members in the cluster.
  764. func (s *EtcdServer) HardStop() {
  765. select {
  766. case s.stop <- struct{}{}:
  767. case <-s.done:
  768. return
  769. }
  770. <-s.done
  771. }
  772. // Stop stops the server gracefully, and shuts down the running goroutine.
  773. // Stop should be called after a Start(s), otherwise it will block forever.
  774. // When stopping leader, Stop transfers its leadership to one of its peers
  775. // before stopping the server.
  776. func (s *EtcdServer) Stop() {
  777. if err := s.TransferLeadership(); err != nil {
  778. plog.Warningf("%s failed to transfer leadership (%v)", s.ID(), err)
  779. }
  780. s.HardStop()
  781. }
  782. // ReadyNotify returns a channel that will be closed when the server
  783. // is ready to serve client requests
  784. func (s *EtcdServer) ReadyNotify() <-chan struct{} { return s.readych }
  785. func (s *EtcdServer) stopWithDelay(d time.Duration, err error) {
  786. select {
  787. case <-time.After(d):
  788. case <-s.done:
  789. }
  790. select {
  791. case s.errorc <- err:
  792. default:
  793. }
  794. }
  795. // StopNotify returns a channel that receives a empty struct
  796. // when the server is stopped.
  797. func (s *EtcdServer) StopNotify() <-chan struct{} { return s.done }
  798. func (s *EtcdServer) SelfStats() []byte { return s.stats.JSON() }
  799. func (s *EtcdServer) LeaderStats() []byte {
  800. lead := atomic.LoadUint64(&s.r.lead)
  801. if lead != uint64(s.id) {
  802. return nil
  803. }
  804. return s.lstats.JSON()
  805. }
  806. func (s *EtcdServer) StoreStats() []byte { return s.store.JsonStats() }
  807. func (s *EtcdServer) AddMember(ctx context.Context, memb membership.Member) error {
  808. if s.Cfg.StrictReconfigCheck {
  809. // by default StrictReconfigCheck is enabled; reject new members if unhealthy
  810. if !s.cluster.IsReadyToAddNewMember() {
  811. plog.Warningf("not enough started members, rejecting member add %+v", memb)
  812. return ErrNotEnoughStartedMembers
  813. }
  814. if !isConnectedFullySince(s.r.transport, time.Now().Add(-HealthInterval), s.ID(), s.cluster.Members()) {
  815. plog.Warningf("not healthy for reconfigure, rejecting member add %+v", memb)
  816. return ErrUnhealthy
  817. }
  818. }
  819. // TODO: move Member to protobuf type
  820. b, err := json.Marshal(memb)
  821. if err != nil {
  822. return err
  823. }
  824. cc := raftpb.ConfChange{
  825. Type: raftpb.ConfChangeAddNode,
  826. NodeID: uint64(memb.ID),
  827. Context: b,
  828. }
  829. return s.configure(ctx, cc)
  830. }
  831. func (s *EtcdServer) RemoveMember(ctx context.Context, id uint64) error {
  832. // by default StrictReconfigCheck is enabled; reject removal if leads to quorum loss
  833. if err := s.mayRemoveMember(types.ID(id)); err != nil {
  834. return err
  835. }
  836. cc := raftpb.ConfChange{
  837. Type: raftpb.ConfChangeRemoveNode,
  838. NodeID: id,
  839. }
  840. return s.configure(ctx, cc)
  841. }
  842. func (s *EtcdServer) mayRemoveMember(id types.ID) error {
  843. if !s.Cfg.StrictReconfigCheck {
  844. return nil
  845. }
  846. if !s.cluster.IsReadyToRemoveMember(uint64(id)) {
  847. plog.Warningf("not enough started members, rejecting remove member %s", id)
  848. return ErrNotEnoughStartedMembers
  849. }
  850. // downed member is safe to remove since it's not part of the active quorum
  851. if t := s.r.transport.ActiveSince(id); id != s.ID() && t.IsZero() {
  852. return nil
  853. }
  854. // protect quorum if some members are down
  855. m := s.cluster.Members()
  856. active := numConnectedSince(s.r.transport, time.Now().Add(-HealthInterval), s.ID(), m)
  857. if (active - 1) < 1+((len(m)-1)/2) {
  858. plog.Warningf("reconfigure breaks active quorum, rejecting remove member %s", id)
  859. return ErrUnhealthy
  860. }
  861. return nil
  862. }
  863. func (s *EtcdServer) UpdateMember(ctx context.Context, memb membership.Member) error {
  864. b, err := json.Marshal(memb)
  865. if err != nil {
  866. return err
  867. }
  868. cc := raftpb.ConfChange{
  869. Type: raftpb.ConfChangeUpdateNode,
  870. NodeID: uint64(memb.ID),
  871. Context: b,
  872. }
  873. return s.configure(ctx, cc)
  874. }
  875. // Implement the RaftTimer interface
  876. func (s *EtcdServer) Index() uint64 { return atomic.LoadUint64(&s.r.index) }
  877. func (s *EtcdServer) Term() uint64 { return atomic.LoadUint64(&s.r.term) }
  878. // Lead is only for testing purposes.
  879. // TODO: add Raft server interface to expose raft related info:
  880. // Index, Term, Lead, Committed, Applied, LastIndex, etc.
  881. func (s *EtcdServer) Lead() uint64 { return atomic.LoadUint64(&s.r.lead) }
  882. func (s *EtcdServer) Leader() types.ID { return types.ID(s.Lead()) }
  883. func (s *EtcdServer) IsPprofEnabled() bool { return s.Cfg.EnablePprof }
  884. // configure sends a configuration change through consensus and
  885. // then waits for it to be applied to the server. It
  886. // will block until the change is performed or there is an error.
  887. func (s *EtcdServer) configure(ctx context.Context, cc raftpb.ConfChange) error {
  888. cc.ID = s.reqIDGen.Next()
  889. ch := s.w.Register(cc.ID)
  890. start := time.Now()
  891. if err := s.r.ProposeConfChange(ctx, cc); err != nil {
  892. s.w.Trigger(cc.ID, nil)
  893. return err
  894. }
  895. select {
  896. case x := <-ch:
  897. if err, ok := x.(error); ok {
  898. return err
  899. }
  900. if x != nil {
  901. plog.Panicf("return type should always be error")
  902. }
  903. return nil
  904. case <-ctx.Done():
  905. s.w.Trigger(cc.ID, nil) // GC wait
  906. return s.parseProposeCtxErr(ctx.Err(), start)
  907. case <-s.stopping:
  908. return ErrStopped
  909. }
  910. }
  911. // sync proposes a SYNC request and is non-blocking.
  912. // This makes no guarantee that the request will be proposed or performed.
  913. // The request will be canceled after the given timeout.
  914. func (s *EtcdServer) sync(timeout time.Duration) {
  915. ctx, cancel := context.WithTimeout(context.Background(), timeout)
  916. req := pb.Request{
  917. Method: "SYNC",
  918. ID: s.reqIDGen.Next(),
  919. Time: time.Now().UnixNano(),
  920. }
  921. data := pbutil.MustMarshal(&req)
  922. // There is no promise that node has leader when do SYNC request,
  923. // so it uses goroutine to propose.
  924. s.goAttach(func() {
  925. s.r.Propose(ctx, data)
  926. cancel()
  927. })
  928. }
  929. // publish registers server information into the cluster. The information
  930. // is the JSON representation of this server's member struct, updated with the
  931. // static clientURLs of the server.
  932. // The function keeps attempting to register until it succeeds,
  933. // or its server is stopped.
  934. func (s *EtcdServer) publish(timeout time.Duration) {
  935. b, err := json.Marshal(s.attributes)
  936. if err != nil {
  937. plog.Panicf("json marshal error: %v", err)
  938. return
  939. }
  940. req := pb.Request{
  941. Method: "PUT",
  942. Path: membership.MemberAttributesStorePath(s.id),
  943. Val: string(b),
  944. }
  945. for {
  946. ctx, cancel := context.WithTimeout(context.Background(), timeout)
  947. _, err := s.Do(ctx, req)
  948. cancel()
  949. switch err {
  950. case nil:
  951. close(s.readych)
  952. plog.Infof("published %+v to cluster %s", s.attributes, s.cluster.ID())
  953. return
  954. case ErrStopped:
  955. plog.Infof("aborting publish because server is stopped")
  956. return
  957. default:
  958. plog.Errorf("publish error: %v", err)
  959. }
  960. }
  961. }
  962. // TODO: move this function into raft.go
  963. func (s *EtcdServer) send(ms []raftpb.Message) {
  964. sentAppResp := false
  965. for i := len(ms) - 1; i >= 0; i-- {
  966. if s.cluster.IsIDRemoved(types.ID(ms[i].To)) {
  967. ms[i].To = 0
  968. }
  969. if ms[i].Type == raftpb.MsgAppResp {
  970. if sentAppResp {
  971. ms[i].To = 0
  972. } else {
  973. sentAppResp = true
  974. }
  975. }
  976. if ms[i].Type == raftpb.MsgSnap {
  977. // There are two separate data store: the store for v2, and the KV for v3.
  978. // The msgSnap only contains the most recent snapshot of store without KV.
  979. // So we need to redirect the msgSnap to etcd server main loop for merging in the
  980. // current store snapshot and KV snapshot.
  981. select {
  982. case s.msgSnapC <- ms[i]:
  983. default:
  984. // drop msgSnap if the inflight chan if full.
  985. }
  986. ms[i].To = 0
  987. }
  988. if ms[i].Type == raftpb.MsgHeartbeat {
  989. ok, exceed := s.r.td.Observe(ms[i].To)
  990. if !ok {
  991. // TODO: limit request rate.
  992. plog.Warningf("failed to send out heartbeat on time (exceeded the %dms timeout for %v)", s.Cfg.TickMs, exceed)
  993. plog.Warningf("server is likely overloaded")
  994. }
  995. }
  996. }
  997. s.r.transport.Send(ms)
  998. }
  999. func (s *EtcdServer) sendMergedSnap(merged snap.Message) {
  1000. atomic.AddInt64(&s.inflightSnapshots, 1)
  1001. s.r.transport.SendSnapshot(merged)
  1002. s.goAttach(func() {
  1003. select {
  1004. case ok := <-merged.CloseNotify():
  1005. // delay releasing inflight snapshot for another 30 seconds to
  1006. // block log compaction.
  1007. // If the follower still fails to catch up, it is probably just too slow
  1008. // to catch up. We cannot avoid the snapshot cycle anyway.
  1009. if ok {
  1010. select {
  1011. case <-time.After(releaseDelayAfterSnapshot):
  1012. case <-s.stopping:
  1013. }
  1014. }
  1015. atomic.AddInt64(&s.inflightSnapshots, -1)
  1016. case <-s.stopping:
  1017. return
  1018. }
  1019. })
  1020. }
  1021. // apply takes entries received from Raft (after it has been committed) and
  1022. // applies them to the current state of the EtcdServer.
  1023. // The given entries should not be empty.
  1024. func (s *EtcdServer) apply(es []raftpb.Entry, confState *raftpb.ConfState) (uint64, bool) {
  1025. var applied uint64
  1026. var shouldstop bool
  1027. for i := range es {
  1028. e := es[i]
  1029. switch e.Type {
  1030. case raftpb.EntryNormal:
  1031. s.applyEntryNormal(&e)
  1032. case raftpb.EntryConfChange:
  1033. var cc raftpb.ConfChange
  1034. pbutil.MustUnmarshal(&cc, e.Data)
  1035. removedSelf, err := s.applyConfChange(cc, confState)
  1036. shouldstop = shouldstop || removedSelf
  1037. s.w.Trigger(cc.ID, err)
  1038. default:
  1039. plog.Panicf("entry type should be either EntryNormal or EntryConfChange")
  1040. }
  1041. atomic.StoreUint64(&s.r.index, e.Index)
  1042. atomic.StoreUint64(&s.r.term, e.Term)
  1043. applied = e.Index
  1044. }
  1045. return applied, shouldstop
  1046. }
  1047. // applyEntryNormal apples an EntryNormal type raftpb request to the EtcdServer
  1048. func (s *EtcdServer) applyEntryNormal(e *raftpb.Entry) {
  1049. shouldApplyV3 := false
  1050. if e.Index > s.consistIndex.ConsistentIndex() {
  1051. // set the consistent index of current executing entry
  1052. s.consistIndex.setConsistentIndex(e.Index)
  1053. shouldApplyV3 = true
  1054. }
  1055. defer s.setAppliedIndex(e.Index)
  1056. // raft state machine may generate noop entry when leader confirmation.
  1057. // skip it in advance to avoid some potential bug in the future
  1058. if len(e.Data) == 0 {
  1059. select {
  1060. case s.forceVersionC <- struct{}{}:
  1061. default:
  1062. }
  1063. return
  1064. }
  1065. var raftReq pb.InternalRaftRequest
  1066. if !pbutil.MaybeUnmarshal(&raftReq, e.Data) { // backward compatible
  1067. var r pb.Request
  1068. pbutil.MustUnmarshal(&r, e.Data)
  1069. s.w.Trigger(r.ID, s.applyV2Request(&r))
  1070. return
  1071. }
  1072. if raftReq.V2 != nil {
  1073. req := raftReq.V2
  1074. s.w.Trigger(req.ID, s.applyV2Request(req))
  1075. return
  1076. }
  1077. // do not re-apply applied entries.
  1078. if !shouldApplyV3 {
  1079. return
  1080. }
  1081. id := raftReq.ID
  1082. if id == 0 {
  1083. id = raftReq.Header.ID
  1084. }
  1085. var ar *applyResult
  1086. needResult := s.w.IsRegistered(id)
  1087. if needResult || !noSideEffect(&raftReq) {
  1088. if !needResult && raftReq.Txn != nil {
  1089. removeNeedlessRangeReqs(raftReq.Txn)
  1090. }
  1091. ar = s.applyV3.Apply(&raftReq)
  1092. }
  1093. if ar == nil {
  1094. return
  1095. }
  1096. if ar.err != ErrNoSpace || len(s.alarmStore.Get(pb.AlarmType_NOSPACE)) > 0 {
  1097. s.w.Trigger(id, ar)
  1098. return
  1099. }
  1100. plog.Errorf("applying raft message exceeded backend quota")
  1101. s.goAttach(func() {
  1102. a := &pb.AlarmRequest{
  1103. MemberID: uint64(s.ID()),
  1104. Action: pb.AlarmRequest_ACTIVATE,
  1105. Alarm: pb.AlarmType_NOSPACE,
  1106. }
  1107. r := pb.InternalRaftRequest{Alarm: a}
  1108. s.processInternalRaftRequest(context.TODO(), r)
  1109. s.w.Trigger(id, ar)
  1110. })
  1111. }
  1112. // applyConfChange applies a ConfChange to the server. It is only
  1113. // invoked with a ConfChange that has already passed through Raft
  1114. func (s *EtcdServer) applyConfChange(cc raftpb.ConfChange, confState *raftpb.ConfState) (bool, error) {
  1115. if err := s.cluster.ValidateConfigurationChange(cc); err != nil {
  1116. cc.NodeID = raft.None
  1117. s.r.ApplyConfChange(cc)
  1118. return false, err
  1119. }
  1120. *confState = *s.r.ApplyConfChange(cc)
  1121. switch cc.Type {
  1122. case raftpb.ConfChangeAddNode:
  1123. m := new(membership.Member)
  1124. if err := json.Unmarshal(cc.Context, m); err != nil {
  1125. plog.Panicf("unmarshal member should never fail: %v", err)
  1126. }
  1127. if cc.NodeID != uint64(m.ID) {
  1128. plog.Panicf("nodeID should always be equal to member ID")
  1129. }
  1130. s.cluster.AddMember(m)
  1131. if m.ID != s.id {
  1132. s.r.transport.AddPeer(m.ID, m.PeerURLs)
  1133. }
  1134. case raftpb.ConfChangeRemoveNode:
  1135. id := types.ID(cc.NodeID)
  1136. s.cluster.RemoveMember(id)
  1137. if id == s.id {
  1138. return true, nil
  1139. }
  1140. s.r.transport.RemovePeer(id)
  1141. case raftpb.ConfChangeUpdateNode:
  1142. m := new(membership.Member)
  1143. if err := json.Unmarshal(cc.Context, m); err != nil {
  1144. plog.Panicf("unmarshal member should never fail: %v", err)
  1145. }
  1146. if cc.NodeID != uint64(m.ID) {
  1147. plog.Panicf("nodeID should always be equal to member ID")
  1148. }
  1149. s.cluster.UpdateRaftAttributes(m.ID, m.RaftAttributes)
  1150. if m.ID != s.id {
  1151. s.r.transport.UpdatePeer(m.ID, m.PeerURLs)
  1152. }
  1153. }
  1154. return false, nil
  1155. }
  1156. // TODO: non-blocking snapshot
  1157. func (s *EtcdServer) snapshot(snapi uint64, confState raftpb.ConfState) {
  1158. clone := s.store.Clone()
  1159. // commit kv to write metadata (for example: consistent index) to disk.
  1160. // KV().commit() updates the consistent index in backend.
  1161. // All operations that update consistent index must be called sequentially
  1162. // from applyAll function.
  1163. // So KV().Commit() cannot run in parallel with apply. It has to be called outside
  1164. // the go routine created below.
  1165. s.KV().Commit()
  1166. s.goAttach(func() {
  1167. d, err := clone.SaveNoCopy()
  1168. // TODO: current store will never fail to do a snapshot
  1169. // what should we do if the store might fail?
  1170. if err != nil {
  1171. plog.Panicf("store save should never fail: %v", err)
  1172. }
  1173. snap, err := s.r.raftStorage.CreateSnapshot(snapi, &confState, d)
  1174. if err != nil {
  1175. // the snapshot was done asynchronously with the progress of raft.
  1176. // raft might have already got a newer snapshot.
  1177. if err == raft.ErrSnapOutOfDate {
  1178. return
  1179. }
  1180. plog.Panicf("unexpected create snapshot error %v", err)
  1181. }
  1182. // SaveSnap saves the snapshot and releases the locked wal files
  1183. // to the snapshot index.
  1184. if err = s.r.storage.SaveSnap(snap); err != nil {
  1185. plog.Fatalf("save snapshot error: %v", err)
  1186. }
  1187. plog.Infof("saved snapshot at index %d", snap.Metadata.Index)
  1188. // When sending a snapshot, etcd will pause compaction.
  1189. // After receives a snapshot, the slow follower needs to get all the entries right after
  1190. // the snapshot sent to catch up. If we do not pause compaction, the log entries right after
  1191. // the snapshot sent might already be compacted. It happens when the snapshot takes long time
  1192. // to send and save. Pausing compaction avoids triggering a snapshot sending cycle.
  1193. if atomic.LoadInt64(&s.inflightSnapshots) != 0 {
  1194. plog.Infof("skip compaction since there is an inflight snapshot")
  1195. return
  1196. }
  1197. // keep some in memory log entries for slow followers.
  1198. compacti := uint64(1)
  1199. if snapi > numberOfCatchUpEntries {
  1200. compacti = snapi - numberOfCatchUpEntries
  1201. }
  1202. err = s.r.raftStorage.Compact(compacti)
  1203. if err != nil {
  1204. // the compaction was done asynchronously with the progress of raft.
  1205. // raft log might already been compact.
  1206. if err == raft.ErrCompacted {
  1207. return
  1208. }
  1209. plog.Panicf("unexpected compaction error %v", err)
  1210. }
  1211. plog.Infof("compacted raft log at %d", compacti)
  1212. })
  1213. }
  1214. // CutPeer drops messages to the specified peer.
  1215. func (s *EtcdServer) CutPeer(id types.ID) {
  1216. tr, ok := s.r.transport.(*rafthttp.Transport)
  1217. if ok {
  1218. tr.CutPeer(id)
  1219. }
  1220. }
  1221. // MendPeer recovers the message dropping behavior of the given peer.
  1222. func (s *EtcdServer) MendPeer(id types.ID) {
  1223. tr, ok := s.r.transport.(*rafthttp.Transport)
  1224. if ok {
  1225. tr.MendPeer(id)
  1226. }
  1227. }
  1228. func (s *EtcdServer) PauseSending() { s.r.pauseSending() }
  1229. func (s *EtcdServer) ResumeSending() { s.r.resumeSending() }
  1230. func (s *EtcdServer) ClusterVersion() *semver.Version {
  1231. if s.cluster == nil {
  1232. return nil
  1233. }
  1234. return s.cluster.Version()
  1235. }
  1236. // monitorVersions checks the member's version every monitorVersionInterval.
  1237. // It updates the cluster version if all members agrees on a higher one.
  1238. // It prints out log if there is a member with a higher version than the
  1239. // local version.
  1240. func (s *EtcdServer) monitorVersions() {
  1241. for {
  1242. select {
  1243. case <-s.forceVersionC:
  1244. case <-time.After(monitorVersionInterval):
  1245. case <-s.stopping:
  1246. return
  1247. }
  1248. if s.Leader() != s.ID() {
  1249. continue
  1250. }
  1251. v := decideClusterVersion(getVersions(s.cluster, s.id, s.peerRt))
  1252. if v != nil {
  1253. // only keep major.minor version for comparison
  1254. v = &semver.Version{
  1255. Major: v.Major,
  1256. Minor: v.Minor,
  1257. }
  1258. }
  1259. // if the current version is nil:
  1260. // 1. use the decided version if possible
  1261. // 2. or use the min cluster version
  1262. if s.cluster.Version() == nil {
  1263. verStr := version.MinClusterVersion
  1264. if v != nil {
  1265. verStr = v.String()
  1266. }
  1267. s.goAttach(func() { s.updateClusterVersion(verStr) })
  1268. continue
  1269. }
  1270. // update cluster version only if the decided version is greater than
  1271. // the current cluster version
  1272. if v != nil && s.cluster.Version().LessThan(*v) {
  1273. s.goAttach(func() { s.updateClusterVersion(v.String()) })
  1274. }
  1275. }
  1276. }
  1277. func (s *EtcdServer) updateClusterVersion(ver string) {
  1278. if s.cluster.Version() == nil {
  1279. plog.Infof("setting up the initial cluster version to %s", version.Cluster(ver))
  1280. } else {
  1281. plog.Infof("updating the cluster version from %s to %s", version.Cluster(s.cluster.Version().String()), version.Cluster(ver))
  1282. }
  1283. req := pb.Request{
  1284. Method: "PUT",
  1285. Path: membership.StoreClusterVersionKey(),
  1286. Val: ver,
  1287. }
  1288. ctx, cancel := context.WithTimeout(context.Background(), s.Cfg.ReqTimeout())
  1289. _, err := s.Do(ctx, req)
  1290. cancel()
  1291. switch err {
  1292. case nil:
  1293. return
  1294. case ErrStopped:
  1295. plog.Infof("aborting update cluster version because server is stopped")
  1296. return
  1297. default:
  1298. plog.Errorf("error updating cluster version (%v)", err)
  1299. }
  1300. }
  1301. func (s *EtcdServer) parseProposeCtxErr(err error, start time.Time) error {
  1302. switch err {
  1303. case context.Canceled:
  1304. return ErrCanceled
  1305. case context.DeadlineExceeded:
  1306. curLeadElected := s.r.leadElectedTime()
  1307. prevLeadLost := curLeadElected.Add(-2 * time.Duration(s.Cfg.ElectionTicks) * time.Duration(s.Cfg.TickMs) * time.Millisecond)
  1308. if start.After(prevLeadLost) && start.Before(curLeadElected) {
  1309. return ErrTimeoutDueToLeaderFail
  1310. }
  1311. lead := types.ID(atomic.LoadUint64(&s.r.lead))
  1312. switch lead {
  1313. case types.ID(raft.None):
  1314. // TODO: return error to specify it happens because the cluster does not have leader now
  1315. case s.ID():
  1316. if !isConnectedToQuorumSince(s.r.transport, start, s.ID(), s.cluster.Members()) {
  1317. return ErrTimeoutDueToConnectionLost
  1318. }
  1319. default:
  1320. if !isConnectedSince(s.r.transport, start, lead) {
  1321. return ErrTimeoutDueToConnectionLost
  1322. }
  1323. }
  1324. return ErrTimeout
  1325. default:
  1326. return err
  1327. }
  1328. }
  1329. func (s *EtcdServer) KV() mvcc.ConsistentWatchableKV { return s.kv }
  1330. func (s *EtcdServer) Backend() backend.Backend {
  1331. s.bemu.Lock()
  1332. defer s.bemu.Unlock()
  1333. return s.be
  1334. }
  1335. func (s *EtcdServer) AuthStore() auth.AuthStore { return s.authStore }
  1336. func (s *EtcdServer) restoreAlarms() error {
  1337. s.applyV3 = s.newApplierV3()
  1338. as, err := alarm.NewAlarmStore(s)
  1339. if err != nil {
  1340. return err
  1341. }
  1342. s.alarmStore = as
  1343. if len(as.Get(pb.AlarmType_NOSPACE)) > 0 {
  1344. s.applyV3 = newApplierV3Capped(s.applyV3)
  1345. }
  1346. return nil
  1347. }
  1348. func (s *EtcdServer) getAppliedIndex() uint64 {
  1349. return atomic.LoadUint64(&s.appliedIndex)
  1350. }
  1351. func (s *EtcdServer) setAppliedIndex(v uint64) {
  1352. atomic.StoreUint64(&s.appliedIndex, v)
  1353. }
  1354. func (s *EtcdServer) getCommittedIndex() uint64 {
  1355. return atomic.LoadUint64(&s.committedIndex)
  1356. }
  1357. func (s *EtcdServer) setCommittedIndex(v uint64) {
  1358. atomic.StoreUint64(&s.committedIndex, v)
  1359. }
  1360. // goAttach creates a goroutine on a given function and tracks it using
  1361. // the etcdserver waitgroup.
  1362. func (s *EtcdServer) goAttach(f func()) {
  1363. s.wg.Add(1)
  1364. go func() {
  1365. defer s.wg.Done()
  1366. f()
  1367. }()
  1368. }