server.go 48 KB

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