server.go 49 KB

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