server.go 26 KB

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