server.go 43 KB

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