server.go 49 KB

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