server.go 25 KB

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