server.go 50 KB

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