server.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839
  1. // Copyright 2015 CoreOS, Inc.
  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. "log"
  20. "math/rand"
  21. "net/http"
  22. "path"
  23. "regexp"
  24. "sync/atomic"
  25. "time"
  26. "github.com/coreos/etcd/discovery"
  27. "github.com/coreos/etcd/etcdserver/etcdhttp/httptypes"
  28. pb "github.com/coreos/etcd/etcdserver/etcdserverpb"
  29. "github.com/coreos/etcd/etcdserver/stats"
  30. "github.com/coreos/etcd/pkg/fileutil"
  31. "github.com/coreos/etcd/pkg/idutil"
  32. "github.com/coreos/etcd/pkg/metrics"
  33. "github.com/coreos/etcd/pkg/pbutil"
  34. "github.com/coreos/etcd/pkg/timeutil"
  35. "github.com/coreos/etcd/pkg/types"
  36. "github.com/coreos/etcd/pkg/wait"
  37. "github.com/coreos/etcd/raft"
  38. "github.com/coreos/etcd/raft/raftpb"
  39. "github.com/coreos/etcd/rafthttp"
  40. "github.com/coreos/etcd/snap"
  41. "github.com/coreos/etcd/store"
  42. "github.com/coreos/etcd/wal"
  43. "github.com/coreos/etcd/Godeps/_workspace/src/golang.org/x/net/context"
  44. )
  45. const (
  46. // owner can make/remove files inside the directory
  47. privateDirMode = 0700
  48. defaultSyncTimeout = time.Second
  49. DefaultSnapCount = 10000
  50. // TODO: calculate based on heartbeat interval
  51. defaultPublishRetryInterval = 5 * time.Second
  52. StoreAdminPrefix = "/0"
  53. StoreKeysPrefix = "/1"
  54. purgeFileInterval = 30 * time.Second
  55. )
  56. var (
  57. storeMembersPrefix = path.Join(StoreAdminPrefix, "members")
  58. storeRemovedMembersPrefix = path.Join(StoreAdminPrefix, "removed_members")
  59. storeMemberAttributeRegexp = regexp.MustCompile(path.Join(storeMembersPrefix, "[[:xdigit:]]{1,16}", attributesSuffix))
  60. )
  61. func init() {
  62. rand.Seed(time.Now().UnixNano())
  63. }
  64. type Response struct {
  65. Event *store.Event
  66. Watcher store.Watcher
  67. err error
  68. }
  69. type Server interface {
  70. // Start performs any initialization of the Server necessary for it to
  71. // begin serving requests. It must be called before Do or Process.
  72. // Start must be non-blocking; any long-running server functionality
  73. // should be implemented in goroutines.
  74. Start()
  75. // Stop terminates the Server and performs any necessary finalization.
  76. // Do and Process cannot be called after Stop has been invoked.
  77. Stop()
  78. // ID returns the ID of the Server.
  79. ID() types.ID
  80. // Leader returns the ID of the leader Server.
  81. Leader() types.ID
  82. // Do takes a request and attempts to fulfill it, returning a Response.
  83. Do(ctx context.Context, r pb.Request) (Response, error)
  84. // Process takes a raft message and applies it to the server's raft state
  85. // machine, respecting any timeout of the given context.
  86. Process(ctx context.Context, m raftpb.Message) error
  87. // AddMember attempts to add a member into the cluster. It will return
  88. // ErrIDRemoved if member ID is removed from the cluster, or return
  89. // ErrIDExists if member ID exists in the cluster.
  90. AddMember(ctx context.Context, memb Member) error
  91. // RemoveMember attempts to remove a member from the cluster. It will
  92. // return ErrIDRemoved if member ID is removed from the cluster, or return
  93. // ErrIDNotFound if member ID is not in the cluster.
  94. RemoveMember(ctx context.Context, id uint64) error
  95. // UpdateMember attempts to update a existing member in the cluster. It will
  96. // return ErrIDNotFound if the member ID does not exist.
  97. UpdateMember(ctx context.Context, updateMemb Member) error
  98. }
  99. // EtcdServer is the production implementation of the Server interface
  100. type EtcdServer struct {
  101. cfg *ServerConfig
  102. r raftNode
  103. w wait.Wait
  104. stop chan struct{}
  105. done chan struct{}
  106. errorc chan error
  107. id types.ID
  108. attributes Attributes
  109. Cluster *Cluster
  110. store store.Store
  111. stats *stats.ServerStats
  112. lstats *stats.LeaderStats
  113. SyncTicker <-chan time.Time
  114. reqIDGen *idutil.Generator
  115. }
  116. // NewServer creates a new EtcdServer from the supplied configuration. The
  117. // configuration is considered static for the lifetime of the EtcdServer.
  118. func NewServer(cfg *ServerConfig) (*EtcdServer, error) {
  119. st := store.New(StoreAdminPrefix, StoreKeysPrefix)
  120. var w *wal.WAL
  121. var n raft.Node
  122. var s *raft.MemoryStorage
  123. var id types.ID
  124. walVersion, err := wal.DetectVersion(cfg.DataDir)
  125. if err != nil {
  126. return nil, err
  127. }
  128. if walVersion == wal.WALUnknown {
  129. return nil, fmt.Errorf("unknown wal version in data dir %s", cfg.DataDir)
  130. }
  131. haveWAL := walVersion != wal.WALNotExist
  132. ss := snap.New(cfg.SnapDir())
  133. switch {
  134. case !haveWAL && !cfg.NewCluster:
  135. us := getOtherPeerURLs(cfg.Cluster, cfg.Name)
  136. existingCluster, err := GetClusterFromPeers(us, cfg.Transport)
  137. if err != nil {
  138. return nil, fmt.Errorf("cannot fetch cluster info from peer urls: %v", err)
  139. }
  140. if err := ValidateClusterAndAssignIDs(cfg.Cluster, existingCluster); err != nil {
  141. return nil, fmt.Errorf("error validating peerURLs %s: %v", existingCluster, err)
  142. }
  143. cfg.Cluster.SetID(existingCluster.id)
  144. cfg.Cluster.SetStore(st)
  145. cfg.Print()
  146. id, n, s, w = startNode(cfg, nil)
  147. case !haveWAL && cfg.NewCluster:
  148. if err := cfg.VerifyBootstrapConfig(); err != nil {
  149. return nil, err
  150. }
  151. m := cfg.Cluster.MemberByName(cfg.Name)
  152. if isMemberBootstrapped(cfg.Cluster, cfg.Name, cfg.Transport) {
  153. return nil, fmt.Errorf("member %s has already been bootstrapped", m.ID)
  154. }
  155. if cfg.ShouldDiscover() {
  156. s, err := discovery.JoinCluster(cfg.DiscoveryURL, cfg.DiscoveryProxy, m.ID, cfg.Cluster.String())
  157. if err != nil {
  158. return nil, err
  159. }
  160. if cfg.Cluster, err = NewClusterFromString(cfg.Cluster.token, s); err != nil {
  161. return nil, err
  162. }
  163. }
  164. cfg.Cluster.SetStore(st)
  165. cfg.PrintWithInitial()
  166. id, n, s, w = startNode(cfg, cfg.Cluster.MemberIDs())
  167. case haveWAL:
  168. // Run the migrations.
  169. if err := upgradeWAL(cfg.DataDir, cfg.Name, walVersion); err != nil {
  170. return nil, err
  171. }
  172. if err := fileutil.IsDirWriteable(cfg.DataDir); err != nil {
  173. return nil, fmt.Errorf("cannot write to data directory: %v", err)
  174. }
  175. if err := fileutil.IsDirWriteable(cfg.MemberDir()); err != nil {
  176. return nil, fmt.Errorf("cannot write to member directory: %v", err)
  177. }
  178. if cfg.ShouldDiscover() {
  179. log.Printf("etcdserver: discovery token ignored since a cluster has already been initialized. Valid log found at %q", cfg.WALDir())
  180. }
  181. snapshot, err := ss.Load()
  182. if err != nil && err != snap.ErrNoSnapshot {
  183. return nil, err
  184. }
  185. if snapshot != nil {
  186. if err := st.Recovery(snapshot.Data); err != nil {
  187. log.Panicf("etcdserver: recovered store from snapshot error: %v", err)
  188. }
  189. log.Printf("etcdserver: recovered store from snapshot at index %d", snapshot.Metadata.Index)
  190. }
  191. cfg.Cluster = NewClusterFromStore(cfg.Cluster.token, st)
  192. cfg.Print()
  193. if snapshot != nil {
  194. log.Printf("etcdserver: loaded cluster information from store: %s", cfg.Cluster)
  195. }
  196. if !cfg.ForceNewCluster {
  197. id, n, s, w = restartNode(cfg, snapshot)
  198. } else {
  199. id, n, s, w = restartAsStandaloneNode(cfg, snapshot)
  200. }
  201. default:
  202. return nil, fmt.Errorf("unsupported bootstrap config")
  203. }
  204. sstats := &stats.ServerStats{
  205. Name: cfg.Name,
  206. ID: id.String(),
  207. }
  208. lstats := stats.NewLeaderStats(id.String())
  209. srv := &EtcdServer{
  210. cfg: cfg,
  211. errorc: make(chan error, 1),
  212. store: st,
  213. r: raftNode{
  214. Node: n,
  215. snapCount: cfg.SnapCount,
  216. ticker: time.Tick(time.Duration(cfg.TickMs) * time.Millisecond),
  217. raftStorage: s,
  218. storage: NewStorage(w, ss),
  219. },
  220. id: id,
  221. attributes: Attributes{Name: cfg.Name, ClientURLs: cfg.ClientURLs.StringSlice()},
  222. Cluster: cfg.Cluster,
  223. stats: sstats,
  224. lstats: lstats,
  225. SyncTicker: time.Tick(500 * time.Millisecond),
  226. reqIDGen: idutil.NewGenerator(uint8(id), time.Now()),
  227. }
  228. tr := rafthttp.NewTransporter(cfg.Transport, id, cfg.Cluster.ID(), srv, srv.errorc, sstats, lstats)
  229. // add all the remote members into sendhub
  230. for _, m := range cfg.Cluster.Members() {
  231. if m.ID != id {
  232. tr.AddPeer(m.ID, m.PeerURLs)
  233. }
  234. }
  235. srv.r.transport = tr
  236. return srv, nil
  237. }
  238. // Start prepares and starts server in a new goroutine. It is no longer safe to
  239. // modify a server's fields after it has been sent to Start.
  240. // It also starts a goroutine to publish its server information.
  241. func (s *EtcdServer) Start() {
  242. s.start()
  243. go s.publish(defaultPublishRetryInterval)
  244. go s.purgeFile()
  245. metrics.Publish("raft.status", expvar.Func(s.raftStatus))
  246. }
  247. // start prepares and starts server in a new goroutine. It is no longer safe to
  248. // modify a server's fields after it has been sent to Start.
  249. // This function is just used for testing.
  250. func (s *EtcdServer) start() {
  251. if s.r.snapCount == 0 {
  252. log.Printf("etcdserver: set snapshot count to default %d", DefaultSnapCount)
  253. s.r.snapCount = DefaultSnapCount
  254. }
  255. s.w = wait.New()
  256. s.done = make(chan struct{})
  257. s.stop = make(chan struct{})
  258. s.stats.Initialize()
  259. // TODO: if this is an empty log, writes all peer infos
  260. // into the first entry
  261. go s.run()
  262. }
  263. func (s *EtcdServer) purgeFile() {
  264. var serrc, werrc <-chan error
  265. if s.cfg.MaxSnapFiles > 0 {
  266. serrc = fileutil.PurgeFile(s.cfg.SnapDir(), "snap", s.cfg.MaxSnapFiles, purgeFileInterval, s.done)
  267. }
  268. if s.cfg.MaxWALFiles > 0 {
  269. werrc = fileutil.PurgeFile(s.cfg.WALDir(), "wal", s.cfg.MaxWALFiles, purgeFileInterval, s.done)
  270. }
  271. select {
  272. case e := <-werrc:
  273. log.Fatalf("etcdserver: failed to purge wal file %v", e)
  274. case e := <-serrc:
  275. log.Fatalf("etcdserver: failed to purge snap file %v", e)
  276. case <-s.done:
  277. return
  278. }
  279. }
  280. func (s *EtcdServer) ID() types.ID { return s.id }
  281. func (s *EtcdServer) RaftHandler() http.Handler { return s.r.transport.Handler() }
  282. func (s *EtcdServer) Process(ctx context.Context, m raftpb.Message) error {
  283. if s.Cluster.IsIDRemoved(types.ID(m.From)) {
  284. log.Printf("etcdserver: reject message from removed member %s", types.ID(m.From).String())
  285. return httptypes.NewHTTPError(http.StatusForbidden, "cannot process message from removed member")
  286. }
  287. if m.Type == raftpb.MsgApp {
  288. s.stats.RecvAppendReq(types.ID(m.From).String(), m.Size())
  289. }
  290. return s.r.Step(ctx, m)
  291. }
  292. func (s *EtcdServer) run() {
  293. var syncC <-chan time.Time
  294. var shouldstop bool
  295. // load initial state from raft storage
  296. snap, err := s.r.raftStorage.Snapshot()
  297. if err != nil {
  298. log.Panicf("etcdserver: get snapshot from raft storage error: %v", err)
  299. }
  300. // snapi indicates the index of the last submitted snapshot request
  301. snapi := snap.Metadata.Index
  302. appliedi := snap.Metadata.Index
  303. confState := snap.Metadata.ConfState
  304. defer func() {
  305. s.r.Stop()
  306. s.r.transport.Stop()
  307. if err := s.r.storage.Close(); err != nil {
  308. log.Panicf("etcdserver: close storage error: %v", err)
  309. }
  310. close(s.done)
  311. }()
  312. // TODO: make raft loop a method on raftNode
  313. for {
  314. select {
  315. case <-s.r.ticker:
  316. s.r.Tick()
  317. case rd := <-s.r.Ready():
  318. if rd.SoftState != nil {
  319. atomic.StoreUint64(&s.r.lead, rd.SoftState.Lead)
  320. if rd.RaftState == raft.StateLeader {
  321. syncC = s.SyncTicker
  322. // TODO: remove the nil checking
  323. // current test utility does not provide the stats
  324. if s.stats != nil {
  325. s.stats.BecomeLeader()
  326. }
  327. } else {
  328. syncC = nil
  329. }
  330. }
  331. // apply snapshot to storage if it is more updated than current snapi
  332. if !raft.IsEmptySnap(rd.Snapshot) && rd.Snapshot.Metadata.Index > snapi {
  333. if err := s.r.storage.SaveSnap(rd.Snapshot); err != nil {
  334. log.Fatalf("etcdserver: save snapshot error: %v", err)
  335. }
  336. s.r.raftStorage.ApplySnapshot(rd.Snapshot)
  337. snapi = rd.Snapshot.Metadata.Index
  338. log.Printf("etcdserver: saved incoming snapshot at index %d", snapi)
  339. }
  340. if err := s.r.storage.Save(rd.HardState, rd.Entries); err != nil {
  341. log.Fatalf("etcdserver: save state and entries error: %v", err)
  342. }
  343. s.r.raftStorage.Append(rd.Entries)
  344. s.send(rd.Messages)
  345. // recover from snapshot if it is more updated than current applied
  346. if !raft.IsEmptySnap(rd.Snapshot) && rd.Snapshot.Metadata.Index > appliedi {
  347. if err := s.store.Recovery(rd.Snapshot.Data); err != nil {
  348. log.Panicf("recovery store error: %v", err)
  349. }
  350. s.Cluster.Recover()
  351. // recover raft transport
  352. s.r.transport.RemoveAllPeers()
  353. for _, m := range s.Cluster.Members() {
  354. if m.ID == s.ID() {
  355. continue
  356. }
  357. s.r.transport.AddPeer(m.ID, m.PeerURLs)
  358. }
  359. appliedi = rd.Snapshot.Metadata.Index
  360. confState = rd.Snapshot.Metadata.ConfState
  361. log.Printf("etcdserver: recovered from incoming snapshot at index %d", snapi)
  362. }
  363. // TODO(bmizerany): do this in the background, but take
  364. // care to apply entries in a single goroutine, and not
  365. // race them.
  366. if len(rd.CommittedEntries) != 0 {
  367. firsti := rd.CommittedEntries[0].Index
  368. if firsti > appliedi+1 {
  369. log.Panicf("etcdserver: first index of committed entry[%d] should <= appliedi[%d] + 1", firsti, appliedi)
  370. }
  371. var ents []raftpb.Entry
  372. if appliedi+1-firsti < uint64(len(rd.CommittedEntries)) {
  373. ents = rd.CommittedEntries[appliedi+1-firsti:]
  374. }
  375. if len(ents) > 0 {
  376. if appliedi, shouldstop = s.apply(ents, &confState); shouldstop {
  377. go s.stopWithDelay(10*100*time.Millisecond, fmt.Errorf("the member has been permanently removed from the cluster"))
  378. }
  379. }
  380. }
  381. s.r.Advance()
  382. if appliedi-snapi > s.r.snapCount {
  383. log.Printf("etcdserver: start to snapshot (applied: %d, lastsnap: %d)", appliedi, snapi)
  384. s.snapshot(appliedi, &confState)
  385. snapi = appliedi
  386. }
  387. case <-syncC:
  388. s.sync(defaultSyncTimeout)
  389. case err := <-s.errorc:
  390. log.Printf("etcdserver: %s", err)
  391. log.Printf("etcdserver: the data-dir used by this member must be removed.")
  392. return
  393. case <-s.stop:
  394. return
  395. }
  396. }
  397. }
  398. // Stop stops the server gracefully, and shuts down the running goroutine.
  399. // Stop should be called after a Start(s), otherwise it will block forever.
  400. func (s *EtcdServer) Stop() {
  401. select {
  402. case s.stop <- struct{}{}:
  403. case <-s.done:
  404. return
  405. }
  406. <-s.done
  407. }
  408. func (s *EtcdServer) stopWithDelay(d time.Duration, err error) {
  409. time.Sleep(d)
  410. select {
  411. case s.errorc <- err:
  412. default:
  413. }
  414. }
  415. // StopNotify returns a channel that receives a empty struct
  416. // when the server is stopped.
  417. func (s *EtcdServer) StopNotify() <-chan struct{} { return s.done }
  418. // Do interprets r and performs an operation on s.store according to r.Method
  419. // and other fields. If r.Method is "POST", "PUT", "DELETE", or a "GET" with
  420. // Quorum == true, r will be sent through consensus before performing its
  421. // respective operation. Do will block until an action is performed or there is
  422. // an error.
  423. func (s *EtcdServer) Do(ctx context.Context, r pb.Request) (Response, error) {
  424. r.ID = s.reqIDGen.Next()
  425. if r.Method == "GET" && r.Quorum {
  426. r.Method = "QGET"
  427. }
  428. switch r.Method {
  429. case "POST", "PUT", "DELETE", "QGET":
  430. data, err := r.Marshal()
  431. if err != nil {
  432. return Response{}, err
  433. }
  434. ch := s.w.Register(r.ID)
  435. s.r.Propose(ctx, data)
  436. select {
  437. case x := <-ch:
  438. resp := x.(Response)
  439. return resp, resp.err
  440. case <-ctx.Done():
  441. s.w.Trigger(r.ID, nil) // GC wait
  442. return Response{}, parseCtxErr(ctx.Err())
  443. case <-s.done:
  444. return Response{}, ErrStopped
  445. }
  446. case "GET":
  447. switch {
  448. case r.Wait:
  449. wc, err := s.store.Watch(r.Path, r.Recursive, r.Stream, r.Since)
  450. if err != nil {
  451. return Response{}, err
  452. }
  453. return Response{Watcher: wc}, nil
  454. default:
  455. ev, err := s.store.Get(r.Path, r.Recursive, r.Sorted)
  456. if err != nil {
  457. return Response{}, err
  458. }
  459. return Response{Event: ev}, nil
  460. }
  461. case "HEAD":
  462. ev, err := s.store.Get(r.Path, r.Recursive, r.Sorted)
  463. if err != nil {
  464. return Response{}, err
  465. }
  466. return Response{Event: ev}, nil
  467. default:
  468. return Response{}, ErrUnknownMethod
  469. }
  470. }
  471. func (s *EtcdServer) SelfStats() []byte { return s.stats.JSON() }
  472. func (s *EtcdServer) LeaderStats() []byte {
  473. lead := atomic.LoadUint64(&s.r.lead)
  474. if lead != uint64(s.id) {
  475. return nil
  476. }
  477. return s.lstats.JSON()
  478. }
  479. func (s *EtcdServer) StoreStats() []byte { return s.store.JsonStats() }
  480. func (s *EtcdServer) raftStatus() interface{} { return s.r.Status() }
  481. func (s *EtcdServer) AddMember(ctx context.Context, memb Member) error {
  482. // TODO: move Member to protobuf type
  483. b, err := json.Marshal(memb)
  484. if err != nil {
  485. return err
  486. }
  487. cc := raftpb.ConfChange{
  488. Type: raftpb.ConfChangeAddNode,
  489. NodeID: uint64(memb.ID),
  490. Context: b,
  491. }
  492. return s.configure(ctx, cc)
  493. }
  494. func (s *EtcdServer) RemoveMember(ctx context.Context, id uint64) error {
  495. cc := raftpb.ConfChange{
  496. Type: raftpb.ConfChangeRemoveNode,
  497. NodeID: id,
  498. }
  499. return s.configure(ctx, cc)
  500. }
  501. func (s *EtcdServer) UpdateMember(ctx context.Context, memb Member) error {
  502. b, err := json.Marshal(memb)
  503. if err != nil {
  504. return err
  505. }
  506. cc := raftpb.ConfChange{
  507. Type: raftpb.ConfChangeUpdateNode,
  508. NodeID: uint64(memb.ID),
  509. Context: b,
  510. }
  511. return s.configure(ctx, cc)
  512. }
  513. // Implement the RaftTimer interface
  514. func (s *EtcdServer) Index() uint64 { return atomic.LoadUint64(&s.r.index) }
  515. func (s *EtcdServer) Term() uint64 { return atomic.LoadUint64(&s.r.term) }
  516. // Only for testing purpose
  517. // TODO: add Raft server interface to expose raft related info:
  518. // Index, Term, Lead, Committed, Applied, LastIndex, etc.
  519. func (s *EtcdServer) Lead() uint64 { return atomic.LoadUint64(&s.r.lead) }
  520. func (s *EtcdServer) Leader() types.ID { return types.ID(s.Lead()) }
  521. // configure sends a configuration change through consensus and
  522. // then waits for it to be applied to the server. It
  523. // will block until the change is performed or there is an error.
  524. func (s *EtcdServer) configure(ctx context.Context, cc raftpb.ConfChange) error {
  525. cc.ID = s.reqIDGen.Next()
  526. ch := s.w.Register(cc.ID)
  527. if err := s.r.ProposeConfChange(ctx, cc); err != nil {
  528. s.w.Trigger(cc.ID, nil)
  529. return err
  530. }
  531. select {
  532. case x := <-ch:
  533. if err, ok := x.(error); ok {
  534. return err
  535. }
  536. if x != nil {
  537. log.Panicf("return type should always be error")
  538. }
  539. return nil
  540. case <-ctx.Done():
  541. s.w.Trigger(cc.ID, nil) // GC wait
  542. return parseCtxErr(ctx.Err())
  543. case <-s.done:
  544. return ErrStopped
  545. }
  546. }
  547. // sync proposes a SYNC request and is non-blocking.
  548. // This makes no guarantee that the request will be proposed or performed.
  549. // The request will be cancelled after the given timeout.
  550. func (s *EtcdServer) sync(timeout time.Duration) {
  551. ctx, cancel := context.WithTimeout(context.Background(), timeout)
  552. req := pb.Request{
  553. Method: "SYNC",
  554. ID: s.reqIDGen.Next(),
  555. Time: time.Now().UnixNano(),
  556. }
  557. data := pbutil.MustMarshal(&req)
  558. // There is no promise that node has leader when do SYNC request,
  559. // so it uses goroutine to propose.
  560. go func() {
  561. s.r.Propose(ctx, data)
  562. cancel()
  563. }()
  564. }
  565. // publish registers server information into the cluster. The information
  566. // is the JSON representation of this server's member struct, updated with the
  567. // static clientURLs of the server.
  568. // The function keeps attempting to register until it succeeds,
  569. // or its server is stopped.
  570. func (s *EtcdServer) publish(retryInterval time.Duration) {
  571. b, err := json.Marshal(s.attributes)
  572. if err != nil {
  573. log.Printf("etcdserver: json marshal error: %v", err)
  574. return
  575. }
  576. req := pb.Request{
  577. Method: "PUT",
  578. Path: MemberAttributesStorePath(s.id),
  579. Val: string(b),
  580. }
  581. for {
  582. ctx, cancel := context.WithTimeout(context.Background(), retryInterval)
  583. _, err := s.Do(ctx, req)
  584. cancel()
  585. switch err {
  586. case nil:
  587. log.Printf("etcdserver: published %+v to cluster %s", s.attributes, s.Cluster.ID())
  588. return
  589. case ErrStopped:
  590. log.Printf("etcdserver: aborting publish because server is stopped")
  591. return
  592. default:
  593. log.Printf("etcdserver: publish error: %v", err)
  594. }
  595. }
  596. }
  597. func (s *EtcdServer) send(ms []raftpb.Message) {
  598. for _, m := range ms {
  599. if !s.Cluster.IsIDRemoved(types.ID(m.To)) {
  600. m.To = 0
  601. }
  602. }
  603. s.r.transport.Send(ms)
  604. }
  605. // apply takes entries received from Raft (after it has been committed) and
  606. // applies them to the current state of the EtcdServer.
  607. // The given entries should not be empty.
  608. func (s *EtcdServer) apply(es []raftpb.Entry, confState *raftpb.ConfState) (uint64, bool) {
  609. var applied uint64
  610. var shouldstop bool
  611. var err error
  612. for i := range es {
  613. e := es[i]
  614. switch e.Type {
  615. case raftpb.EntryNormal:
  616. var r pb.Request
  617. pbutil.MustUnmarshal(&r, e.Data)
  618. s.w.Trigger(r.ID, s.applyRequest(r))
  619. case raftpb.EntryConfChange:
  620. var cc raftpb.ConfChange
  621. pbutil.MustUnmarshal(&cc, e.Data)
  622. shouldstop, err = s.applyConfChange(cc, confState)
  623. s.w.Trigger(cc.ID, err)
  624. default:
  625. log.Panicf("entry type should be either EntryNormal or EntryConfChange")
  626. }
  627. atomic.StoreUint64(&s.r.index, e.Index)
  628. atomic.StoreUint64(&s.r.term, e.Term)
  629. applied = e.Index
  630. }
  631. return applied, shouldstop
  632. }
  633. // applyRequest interprets r as a call to store.X and returns a Response interpreted
  634. // from store.Event
  635. func (s *EtcdServer) applyRequest(r pb.Request) Response {
  636. f := func(ev *store.Event, err error) Response {
  637. return Response{Event: ev, err: err}
  638. }
  639. expr := timeutil.UnixNanoToTime(r.Expiration)
  640. switch r.Method {
  641. case "POST":
  642. return f(s.store.Create(r.Path, r.Dir, r.Val, true, expr))
  643. case "PUT":
  644. exists, existsSet := pbutil.GetBool(r.PrevExist)
  645. switch {
  646. case existsSet:
  647. if exists {
  648. return f(s.store.Update(r.Path, r.Val, expr))
  649. }
  650. return f(s.store.Create(r.Path, r.Dir, r.Val, false, expr))
  651. case r.PrevIndex > 0 || r.PrevValue != "":
  652. return f(s.store.CompareAndSwap(r.Path, r.PrevValue, r.PrevIndex, r.Val, expr))
  653. default:
  654. if storeMemberAttributeRegexp.MatchString(r.Path) {
  655. id := mustParseMemberIDFromKey(path.Dir(r.Path))
  656. var attr Attributes
  657. if err := json.Unmarshal([]byte(r.Val), &attr); err != nil {
  658. log.Panicf("unmarshal %s should never fail: %v", r.Val, err)
  659. }
  660. s.Cluster.UpdateAttributes(id, attr)
  661. }
  662. return f(s.store.Set(r.Path, r.Dir, r.Val, expr))
  663. }
  664. case "DELETE":
  665. switch {
  666. case r.PrevIndex > 0 || r.PrevValue != "":
  667. return f(s.store.CompareAndDelete(r.Path, r.PrevValue, r.PrevIndex))
  668. default:
  669. return f(s.store.Delete(r.Path, r.Dir, r.Recursive))
  670. }
  671. case "QGET":
  672. return f(s.store.Get(r.Path, r.Recursive, r.Sorted))
  673. case "SYNC":
  674. s.store.DeleteExpiredKeys(time.Unix(0, r.Time))
  675. return Response{}
  676. default:
  677. // This should never be reached, but just in case:
  678. return Response{err: ErrUnknownMethod}
  679. }
  680. }
  681. // applyConfChange applies a ConfChange to the server. It is only
  682. // invoked with a ConfChange that has already passed through Raft
  683. func (s *EtcdServer) applyConfChange(cc raftpb.ConfChange, confState *raftpb.ConfState) (bool, error) {
  684. if err := s.Cluster.ValidateConfigurationChange(cc); err != nil {
  685. cc.NodeID = raft.None
  686. s.r.ApplyConfChange(cc)
  687. return false, err
  688. }
  689. *confState = *s.r.ApplyConfChange(cc)
  690. switch cc.Type {
  691. case raftpb.ConfChangeAddNode:
  692. m := new(Member)
  693. if err := json.Unmarshal(cc.Context, m); err != nil {
  694. log.Panicf("unmarshal member should never fail: %v", err)
  695. }
  696. if cc.NodeID != uint64(m.ID) {
  697. log.Panicf("nodeID should always be equal to member ID")
  698. }
  699. s.Cluster.AddMember(m)
  700. if m.ID == s.id {
  701. log.Printf("etcdserver: added local member %s %v to cluster %s", m.ID, m.PeerURLs, s.Cluster.ID())
  702. } else {
  703. s.r.transport.AddPeer(m.ID, m.PeerURLs)
  704. log.Printf("etcdserver: added member %s %v to cluster %s", m.ID, m.PeerURLs, s.Cluster.ID())
  705. }
  706. case raftpb.ConfChangeRemoveNode:
  707. id := types.ID(cc.NodeID)
  708. s.Cluster.RemoveMember(id)
  709. if id == s.id {
  710. return true, nil
  711. } else {
  712. s.r.transport.RemovePeer(id)
  713. log.Printf("etcdserver: removed member %s from cluster %s", id, s.Cluster.ID())
  714. }
  715. case raftpb.ConfChangeUpdateNode:
  716. m := new(Member)
  717. if err := json.Unmarshal(cc.Context, m); err != nil {
  718. log.Panicf("unmarshal member should never fail: %v", err)
  719. }
  720. if cc.NodeID != uint64(m.ID) {
  721. log.Panicf("nodeID should always be equal to member ID")
  722. }
  723. s.Cluster.UpdateRaftAttributes(m.ID, m.RaftAttributes)
  724. if m.ID == s.id {
  725. log.Printf("etcdserver: update local member %s %v in cluster %s", m.ID, m.PeerURLs, s.Cluster.ID())
  726. } else {
  727. s.r.transport.UpdatePeer(m.ID, m.PeerURLs)
  728. log.Printf("etcdserver: update member %s %v in cluster %s", m.ID, m.PeerURLs, s.Cluster.ID())
  729. }
  730. }
  731. return false, nil
  732. }
  733. // TODO: non-blocking snapshot
  734. func (s *EtcdServer) snapshot(snapi uint64, confState *raftpb.ConfState) {
  735. d, err := s.store.Save()
  736. // TODO: current store will never fail to do a snapshot
  737. // what should we do if the store might fail?
  738. if err != nil {
  739. log.Panicf("etcdserver: store save should never fail: %v", err)
  740. }
  741. err = s.r.raftStorage.Compact(snapi, confState, d)
  742. if err != nil {
  743. // the snapshot was done asynchronously with the progress of raft.
  744. // raft might have already got a newer snapshot and called compact.
  745. if err == raft.ErrCompacted {
  746. return
  747. }
  748. log.Panicf("etcdserver: unexpected compaction error %v", err)
  749. }
  750. log.Printf("etcdserver: compacted log at index %d", snapi)
  751. if err := s.r.storage.Cut(); err != nil {
  752. log.Panicf("etcdserver: rotate wal file should never fail: %v", err)
  753. }
  754. snap, err := s.r.raftStorage.Snapshot()
  755. if err != nil {
  756. log.Panicf("etcdserver: snapshot error: %v", err)
  757. }
  758. if err := s.r.storage.SaveSnap(snap); err != nil {
  759. log.Fatalf("etcdserver: save snapshot error: %v", err)
  760. }
  761. log.Printf("etcdserver: saved snapshot at index %d", snap.Metadata.Index)
  762. }
  763. func (s *EtcdServer) PauseSending() { s.r.pauseSending() }
  764. func (s *EtcdServer) ResumeSending() { s.r.resumeSending() }