server.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833
  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. snapCount uint64
  101. r raftNode
  102. w wait.Wait
  103. stop chan struct{}
  104. done chan struct{}
  105. errorc chan error
  106. id types.ID
  107. attributes Attributes
  108. Cluster *Cluster
  109. store store.Store
  110. stats *stats.ServerStats
  111. lstats *stats.LeaderStats
  112. SyncTicker <-chan time.Time
  113. reqIDGen *idutil.Generator
  114. }
  115. // NewServer creates a new EtcdServer from the supplied configuration. The
  116. // configuration is considered static for the lifetime of the EtcdServer.
  117. func NewServer(cfg *ServerConfig) (*EtcdServer, error) {
  118. st := store.New(StoreAdminPrefix, StoreKeysPrefix)
  119. var w *wal.WAL
  120. var n raft.Node
  121. var s *raft.MemoryStorage
  122. var id types.ID
  123. walVersion, err := wal.DetectVersion(cfg.DataDir)
  124. if err != nil {
  125. return nil, err
  126. }
  127. if walVersion == wal.WALUnknown {
  128. return nil, fmt.Errorf("unknown wal version in data dir %s", cfg.DataDir)
  129. }
  130. haveWAL := walVersion != wal.WALNotExist
  131. ss := snap.New(cfg.SnapDir())
  132. switch {
  133. case !haveWAL && !cfg.NewCluster:
  134. existingCluster, err := GetClusterFromRemotePeers(getRemotePeerURLs(cfg.Cluster, cfg.Name), cfg.Transport)
  135. if err != nil {
  136. return nil, fmt.Errorf("cannot fetch cluster info from peer urls: %v", err)
  137. }
  138. if err := ValidateClusterAndAssignIDs(cfg.Cluster, existingCluster); err != nil {
  139. return nil, fmt.Errorf("error validating peerURLs %s: %v", existingCluster, err)
  140. }
  141. cfg.Cluster.UpdateIndex(existingCluster.index)
  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. str, 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, str); 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. snapCount: cfg.SnapCount,
  214. errorc: make(chan error, 1),
  215. store: st,
  216. r: raftNode{
  217. Node: n,
  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. }
  248. // start prepares and starts server in a new goroutine. It is no longer safe to
  249. // modify a server's fields after it has been sent to Start.
  250. // This function is just used for testing.
  251. func (s *EtcdServer) start() {
  252. if s.snapCount == 0 {
  253. log.Printf("etcdserver: set snapshot count to default %d", DefaultSnapCount)
  254. s.snapCount = DefaultSnapCount
  255. }
  256. s.w = wait.New()
  257. s.done = make(chan struct{})
  258. s.stop = make(chan struct{})
  259. s.stats.Initialize()
  260. // TODO: if this is an empty log, writes all peer infos
  261. // into the first entry
  262. go s.run()
  263. }
  264. func (s *EtcdServer) purgeFile() {
  265. var serrc, werrc <-chan error
  266. if s.cfg.MaxSnapFiles > 0 {
  267. serrc = fileutil.PurgeFile(s.cfg.SnapDir(), "snap", s.cfg.MaxSnapFiles, purgeFileInterval, s.done)
  268. }
  269. if s.cfg.MaxWALFiles > 0 {
  270. werrc = fileutil.PurgeFile(s.cfg.WALDir(), "wal", s.cfg.MaxWALFiles, purgeFileInterval, s.done)
  271. }
  272. select {
  273. case e := <-werrc:
  274. log.Fatalf("etcdserver: failed to purge wal file %v", e)
  275. case e := <-serrc:
  276. log.Fatalf("etcdserver: failed to purge snap file %v", e)
  277. case <-s.done:
  278. return
  279. }
  280. }
  281. func (s *EtcdServer) ID() types.ID { return s.id }
  282. func (s *EtcdServer) RaftHandler() http.Handler { return s.r.transport.Handler() }
  283. func (s *EtcdServer) Process(ctx context.Context, m raftpb.Message) error {
  284. if s.Cluster.IsIDRemoved(types.ID(m.From)) {
  285. log.Printf("etcdserver: reject message from removed member %s", types.ID(m.From).String())
  286. return httptypes.NewHTTPError(http.StatusForbidden, "cannot process message from removed member")
  287. }
  288. if m.Type == raftpb.MsgApp {
  289. s.stats.RecvAppendReq(types.ID(m.From).String(), m.Size())
  290. }
  291. return s.r.Step(ctx, m)
  292. }
  293. func (s *EtcdServer) ReportUnreachable(id uint64) { s.r.ReportUnreachable(id) }
  294. func (s *EtcdServer) ReportSnapshot(id uint64, status raft.SnapshotStatus) {
  295. s.r.ReportSnapshot(id, status)
  296. }
  297. func (s *EtcdServer) run() {
  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. confState := snap.Metadata.ConfState
  303. snapi := snap.Metadata.Index
  304. appliedi := snapi
  305. // TODO: get rid of the raft initialization in etcd server
  306. s.r.s = s
  307. s.r.applyc = make(chan apply)
  308. go s.r.run()
  309. defer close(s.done)
  310. var shouldstop bool
  311. for {
  312. select {
  313. case apply := <-s.r.apply():
  314. // apply snapshot
  315. if !raft.IsEmptySnap(apply.snapshot) {
  316. if apply.snapshot.Metadata.Index <= appliedi {
  317. log.Panicf("etcdserver: snapshot index [%d] should > appliedi[%d] + 1",
  318. apply.snapshot.Metadata.Index, appliedi)
  319. }
  320. if err := s.store.Recovery(apply.snapshot.Data); err != nil {
  321. log.Panicf("recovery store error: %v", err)
  322. }
  323. // Avoid snapshot recovery overwriting newer cluster and
  324. // transport setting, which may block the communication.
  325. if s.Cluster.index < apply.snapshot.Metadata.Index {
  326. s.Cluster.Recover()
  327. // recover raft transport
  328. s.r.transport.RemoveAllPeers()
  329. for _, m := range s.Cluster.Members() {
  330. if m.ID == s.ID() {
  331. continue
  332. }
  333. s.r.transport.AddPeer(m.ID, m.PeerURLs)
  334. }
  335. }
  336. appliedi = apply.snapshot.Metadata.Index
  337. snapi = appliedi
  338. confState = apply.snapshot.Metadata.ConfState
  339. log.Printf("etcdserver: recovered from incoming snapshot at index %d", snapi)
  340. }
  341. // apply entries
  342. if len(apply.entries) != 0 {
  343. firsti := apply.entries[0].Index
  344. if firsti > appliedi+1 {
  345. log.Panicf("etcdserver: first index of committed entry[%d] should <= appliedi[%d] + 1", firsti, appliedi)
  346. }
  347. var ents []raftpb.Entry
  348. if appliedi+1-firsti < uint64(len(apply.entries)) {
  349. ents = apply.entries[appliedi+1-firsti:]
  350. }
  351. if appliedi, shouldstop = s.apply(ents, &confState); shouldstop {
  352. go s.stopWithDelay(10*100*time.Millisecond, fmt.Errorf("the member has been permanently removed from the cluster"))
  353. }
  354. }
  355. // wait for the raft routine to finish the disk writes before triggering a
  356. // snapshot. or applied index might be greater than the last index in raft
  357. // storage, since the raft routine might be slower than apply routine.
  358. apply.done <- struct{}{}
  359. // trigger snapshot
  360. if appliedi-snapi > s.snapCount {
  361. log.Printf("etcdserver: start to snapshot (applied: %d, lastsnap: %d)", appliedi, snapi)
  362. s.snapshot(appliedi, confState)
  363. snapi = appliedi
  364. }
  365. case err := <-s.errorc:
  366. log.Printf("etcdserver: %s", err)
  367. log.Printf("etcdserver: the data-dir used by this member must be removed.")
  368. return
  369. case <-s.stop:
  370. return
  371. }
  372. }
  373. // TODO: wait for the stop of raft node routine?
  374. }
  375. // Stop stops the server gracefully, and shuts down the running goroutine.
  376. // Stop should be called after a Start(s), otherwise it will block forever.
  377. func (s *EtcdServer) Stop() {
  378. select {
  379. case s.stop <- struct{}{}:
  380. case <-s.done:
  381. return
  382. }
  383. <-s.done
  384. }
  385. func (s *EtcdServer) stopWithDelay(d time.Duration, err error) {
  386. time.Sleep(d)
  387. select {
  388. case s.errorc <- err:
  389. default:
  390. }
  391. }
  392. // StopNotify returns a channel that receives a empty struct
  393. // when the server is stopped.
  394. func (s *EtcdServer) StopNotify() <-chan struct{} { return s.done }
  395. // Do interprets r and performs an operation on s.store according to r.Method
  396. // and other fields. If r.Method is "POST", "PUT", "DELETE", or a "GET" with
  397. // Quorum == true, r will be sent through consensus before performing its
  398. // respective operation. Do will block until an action is performed or there is
  399. // an error.
  400. func (s *EtcdServer) Do(ctx context.Context, r pb.Request) (Response, error) {
  401. r.ID = s.reqIDGen.Next()
  402. if r.Method == "GET" && r.Quorum {
  403. r.Method = "QGET"
  404. }
  405. switch r.Method {
  406. case "POST", "PUT", "DELETE", "QGET":
  407. data, err := r.Marshal()
  408. if err != nil {
  409. return Response{}, err
  410. }
  411. ch := s.w.Register(r.ID)
  412. // TODO: benchmark the cost of time.Now()
  413. // might be sampling?
  414. start := time.Now()
  415. s.r.Propose(ctx, data)
  416. proposePending.Inc()
  417. defer proposePending.Dec()
  418. select {
  419. case x := <-ch:
  420. proposeDurations.Observe(float64(time.Since(start).Nanoseconds() / int64(time.Millisecond)))
  421. resp := x.(Response)
  422. return resp, resp.err
  423. case <-ctx.Done():
  424. proposeFailed.Inc()
  425. s.w.Trigger(r.ID, nil) // GC wait
  426. return Response{}, parseCtxErr(ctx.Err())
  427. case <-s.done:
  428. return Response{}, ErrStopped
  429. }
  430. case "GET":
  431. switch {
  432. case r.Wait:
  433. wc, err := s.store.Watch(r.Path, r.Recursive, r.Stream, r.Since)
  434. if err != nil {
  435. return Response{}, err
  436. }
  437. return Response{Watcher: wc}, nil
  438. default:
  439. ev, err := s.store.Get(r.Path, r.Recursive, r.Sorted)
  440. if err != nil {
  441. return Response{}, err
  442. }
  443. return Response{Event: ev}, nil
  444. }
  445. case "HEAD":
  446. ev, err := s.store.Get(r.Path, r.Recursive, r.Sorted)
  447. if err != nil {
  448. return Response{}, err
  449. }
  450. return Response{Event: ev}, nil
  451. default:
  452. return Response{}, ErrUnknownMethod
  453. }
  454. }
  455. func (s *EtcdServer) SelfStats() []byte { return s.stats.JSON() }
  456. func (s *EtcdServer) LeaderStats() []byte {
  457. lead := atomic.LoadUint64(&s.r.lead)
  458. if lead != uint64(s.id) {
  459. return nil
  460. }
  461. return s.lstats.JSON()
  462. }
  463. func (s *EtcdServer) StoreStats() []byte { return s.store.JsonStats() }
  464. func (s *EtcdServer) AddMember(ctx context.Context, memb Member) error {
  465. // TODO: move Member to protobuf type
  466. b, err := json.Marshal(memb)
  467. if err != nil {
  468. return err
  469. }
  470. cc := raftpb.ConfChange{
  471. Type: raftpb.ConfChangeAddNode,
  472. NodeID: uint64(memb.ID),
  473. Context: b,
  474. }
  475. return s.configure(ctx, cc)
  476. }
  477. func (s *EtcdServer) RemoveMember(ctx context.Context, id uint64) error {
  478. cc := raftpb.ConfChange{
  479. Type: raftpb.ConfChangeRemoveNode,
  480. NodeID: id,
  481. }
  482. return s.configure(ctx, cc)
  483. }
  484. func (s *EtcdServer) UpdateMember(ctx context.Context, memb Member) error {
  485. b, err := json.Marshal(memb)
  486. if err != nil {
  487. return err
  488. }
  489. cc := raftpb.ConfChange{
  490. Type: raftpb.ConfChangeUpdateNode,
  491. NodeID: uint64(memb.ID),
  492. Context: b,
  493. }
  494. return s.configure(ctx, cc)
  495. }
  496. // Implement the RaftTimer interface
  497. func (s *EtcdServer) Index() uint64 { return atomic.LoadUint64(&s.r.index) }
  498. func (s *EtcdServer) Term() uint64 { return atomic.LoadUint64(&s.r.term) }
  499. // Only for testing purpose
  500. // TODO: add Raft server interface to expose raft related info:
  501. // Index, Term, Lead, Committed, Applied, LastIndex, etc.
  502. func (s *EtcdServer) Lead() uint64 { return atomic.LoadUint64(&s.r.lead) }
  503. func (s *EtcdServer) Leader() types.ID { return types.ID(s.Lead()) }
  504. // configure sends a configuration change through consensus and
  505. // then waits for it to be applied to the server. It
  506. // will block until the change is performed or there is an error.
  507. func (s *EtcdServer) configure(ctx context.Context, cc raftpb.ConfChange) error {
  508. cc.ID = s.reqIDGen.Next()
  509. ch := s.w.Register(cc.ID)
  510. if err := s.r.ProposeConfChange(ctx, cc); err != nil {
  511. s.w.Trigger(cc.ID, nil)
  512. return err
  513. }
  514. select {
  515. case x := <-ch:
  516. if err, ok := x.(error); ok {
  517. return err
  518. }
  519. if x != nil {
  520. log.Panicf("return type should always be error")
  521. }
  522. return nil
  523. case <-ctx.Done():
  524. s.w.Trigger(cc.ID, nil) // GC wait
  525. return parseCtxErr(ctx.Err())
  526. case <-s.done:
  527. return ErrStopped
  528. }
  529. }
  530. // sync proposes a SYNC request and is non-blocking.
  531. // This makes no guarantee that the request will be proposed or performed.
  532. // The request will be cancelled after the given timeout.
  533. func (s *EtcdServer) sync(timeout time.Duration) {
  534. ctx, cancel := context.WithTimeout(context.Background(), timeout)
  535. req := pb.Request{
  536. Method: "SYNC",
  537. ID: s.reqIDGen.Next(),
  538. Time: time.Now().UnixNano(),
  539. }
  540. data := pbutil.MustMarshal(&req)
  541. // There is no promise that node has leader when do SYNC request,
  542. // so it uses goroutine to propose.
  543. go func() {
  544. s.r.Propose(ctx, data)
  545. cancel()
  546. }()
  547. }
  548. // publish registers server information into the cluster. The information
  549. // is the JSON representation of this server's member struct, updated with the
  550. // static clientURLs of the server.
  551. // The function keeps attempting to register until it succeeds,
  552. // or its server is stopped.
  553. func (s *EtcdServer) publish(retryInterval time.Duration) {
  554. b, err := json.Marshal(s.attributes)
  555. if err != nil {
  556. log.Printf("etcdserver: json marshal error: %v", err)
  557. return
  558. }
  559. req := pb.Request{
  560. Method: "PUT",
  561. Path: MemberAttributesStorePath(s.id),
  562. Val: string(b),
  563. }
  564. for {
  565. ctx, cancel := context.WithTimeout(context.Background(), retryInterval)
  566. _, err := s.Do(ctx, req)
  567. cancel()
  568. switch err {
  569. case nil:
  570. log.Printf("etcdserver: published %+v to cluster %s", s.attributes, s.Cluster.ID())
  571. return
  572. case ErrStopped:
  573. log.Printf("etcdserver: aborting publish because server is stopped")
  574. return
  575. default:
  576. log.Printf("etcdserver: publish error: %v", err)
  577. }
  578. }
  579. }
  580. func (s *EtcdServer) send(ms []raftpb.Message) {
  581. for _, m := range ms {
  582. if !s.Cluster.IsIDRemoved(types.ID(m.To)) {
  583. m.To = 0
  584. }
  585. }
  586. s.r.transport.Send(ms)
  587. }
  588. // apply takes entries received from Raft (after it has been committed) and
  589. // applies them to the current state of the EtcdServer.
  590. // The given entries should not be empty.
  591. func (s *EtcdServer) apply(es []raftpb.Entry, confState *raftpb.ConfState) (uint64, bool) {
  592. var applied uint64
  593. var shouldstop bool
  594. var err error
  595. for i := range es {
  596. e := es[i]
  597. switch e.Type {
  598. case raftpb.EntryNormal:
  599. var r pb.Request
  600. pbutil.MustUnmarshal(&r, e.Data)
  601. s.w.Trigger(r.ID, s.applyRequest(r))
  602. case raftpb.EntryConfChange:
  603. var cc raftpb.ConfChange
  604. pbutil.MustUnmarshal(&cc, e.Data)
  605. shouldstop, err = s.applyConfChange(cc, confState)
  606. s.w.Trigger(cc.ID, err)
  607. default:
  608. log.Panicf("entry type should be either EntryNormal or EntryConfChange")
  609. }
  610. atomic.StoreUint64(&s.r.index, e.Index)
  611. atomic.StoreUint64(&s.r.term, e.Term)
  612. applied = e.Index
  613. }
  614. return applied, shouldstop
  615. }
  616. // applyRequest interprets r as a call to store.X and returns a Response interpreted
  617. // from store.Event
  618. func (s *EtcdServer) applyRequest(r pb.Request) Response {
  619. f := func(ev *store.Event, err error) Response {
  620. return Response{Event: ev, err: err}
  621. }
  622. expr := timeutil.UnixNanoToTime(r.Expiration)
  623. switch r.Method {
  624. case "POST":
  625. return f(s.store.Create(r.Path, r.Dir, r.Val, true, expr))
  626. case "PUT":
  627. exists, existsSet := pbutil.GetBool(r.PrevExist)
  628. switch {
  629. case existsSet:
  630. if exists {
  631. return f(s.store.Update(r.Path, r.Val, expr))
  632. }
  633. return f(s.store.Create(r.Path, r.Dir, r.Val, false, expr))
  634. case r.PrevIndex > 0 || r.PrevValue != "":
  635. return f(s.store.CompareAndSwap(r.Path, r.PrevValue, r.PrevIndex, r.Val, expr))
  636. default:
  637. if storeMemberAttributeRegexp.MatchString(r.Path) {
  638. id := mustParseMemberIDFromKey(path.Dir(r.Path))
  639. var attr Attributes
  640. if err := json.Unmarshal([]byte(r.Val), &attr); err != nil {
  641. log.Panicf("unmarshal %s should never fail: %v", r.Val, err)
  642. }
  643. s.Cluster.UpdateAttributes(id, attr)
  644. }
  645. return f(s.store.Set(r.Path, r.Dir, r.Val, expr))
  646. }
  647. case "DELETE":
  648. switch {
  649. case r.PrevIndex > 0 || r.PrevValue != "":
  650. return f(s.store.CompareAndDelete(r.Path, r.PrevValue, r.PrevIndex))
  651. default:
  652. return f(s.store.Delete(r.Path, r.Dir, r.Recursive))
  653. }
  654. case "QGET":
  655. return f(s.store.Get(r.Path, r.Recursive, r.Sorted))
  656. case "SYNC":
  657. s.store.DeleteExpiredKeys(time.Unix(0, r.Time))
  658. return Response{}
  659. default:
  660. // This should never be reached, but just in case:
  661. return Response{err: ErrUnknownMethod}
  662. }
  663. }
  664. // applyConfChange applies a ConfChange to the server. It is only
  665. // invoked with a ConfChange that has already passed through Raft
  666. func (s *EtcdServer) applyConfChange(cc raftpb.ConfChange, confState *raftpb.ConfState) (bool, error) {
  667. if err := s.Cluster.ValidateConfigurationChange(cc); err != nil {
  668. cc.NodeID = raft.None
  669. s.r.ApplyConfChange(cc)
  670. return false, err
  671. }
  672. *confState = *s.r.ApplyConfChange(cc)
  673. switch cc.Type {
  674. case raftpb.ConfChangeAddNode:
  675. m := new(Member)
  676. if err := json.Unmarshal(cc.Context, m); err != nil {
  677. log.Panicf("unmarshal member should never fail: %v", err)
  678. }
  679. if cc.NodeID != uint64(m.ID) {
  680. log.Panicf("nodeID should always be equal to member ID")
  681. }
  682. s.Cluster.AddMember(m)
  683. if m.ID == s.id {
  684. log.Printf("etcdserver: added local member %s %v to cluster %s", m.ID, m.PeerURLs, s.Cluster.ID())
  685. } else {
  686. s.r.transport.AddPeer(m.ID, m.PeerURLs)
  687. log.Printf("etcdserver: added member %s %v to cluster %s", m.ID, m.PeerURLs, s.Cluster.ID())
  688. }
  689. case raftpb.ConfChangeRemoveNode:
  690. id := types.ID(cc.NodeID)
  691. s.Cluster.RemoveMember(id)
  692. if id == s.id {
  693. return true, nil
  694. } else {
  695. s.r.transport.RemovePeer(id)
  696. log.Printf("etcdserver: removed member %s from cluster %s", id, s.Cluster.ID())
  697. }
  698. case raftpb.ConfChangeUpdateNode:
  699. m := new(Member)
  700. if err := json.Unmarshal(cc.Context, m); err != nil {
  701. log.Panicf("unmarshal member should never fail: %v", err)
  702. }
  703. if cc.NodeID != uint64(m.ID) {
  704. log.Panicf("nodeID should always be equal to member ID")
  705. }
  706. s.Cluster.UpdateRaftAttributes(m.ID, m.RaftAttributes)
  707. if m.ID == s.id {
  708. log.Printf("etcdserver: update local member %s %v in cluster %s", m.ID, m.PeerURLs, s.Cluster.ID())
  709. } else {
  710. s.r.transport.UpdatePeer(m.ID, m.PeerURLs)
  711. log.Printf("etcdserver: update member %s %v in cluster %s", m.ID, m.PeerURLs, s.Cluster.ID())
  712. }
  713. }
  714. return false, nil
  715. }
  716. // TODO: non-blocking snapshot
  717. func (s *EtcdServer) snapshot(snapi uint64, confState raftpb.ConfState) {
  718. clone := s.store.Clone()
  719. go func() {
  720. d, err := clone.SaveNoCopy()
  721. // TODO: current store will never fail to do a snapshot
  722. // what should we do if the store might fail?
  723. if err != nil {
  724. log.Panicf("etcdserver: store save should never fail: %v", err)
  725. }
  726. snap, err := s.r.raftStorage.CreateSnapshot(snapi, &confState, d)
  727. if err != nil {
  728. // the snapshot was done asynchronously with the progress of raft.
  729. // raft might have already got a newer snapshot.
  730. if err == raft.ErrSnapOutOfDate {
  731. return
  732. }
  733. log.Panicf("etcdserver: unexpected create snapshot error %v", err)
  734. }
  735. if err := s.r.storage.SaveSnap(snap); err != nil {
  736. log.Fatalf("etcdserver: save snapshot error: %v", err)
  737. }
  738. log.Printf("etcdserver: saved snapshot at index %d", snap.Metadata.Index)
  739. // keep some in memory log entries for slow followers.
  740. compacti := uint64(1)
  741. if snapi > numberOfCatchUpEntries {
  742. compacti = snapi - numberOfCatchUpEntries
  743. }
  744. err = s.r.raftStorage.Compact(compacti)
  745. if err != nil {
  746. // the compaction was done asynchronously with the progress of raft.
  747. // raft log might already been compact.
  748. if err == raft.ErrCompacted {
  749. return
  750. }
  751. log.Panicf("etcdserver: unexpected compaction error %v", err)
  752. }
  753. log.Printf("etcdserver: compacted raft log at %d", compacti)
  754. }()
  755. }
  756. func (s *EtcdServer) PauseSending() { s.r.pauseSending() }
  757. func (s *EtcdServer) ResumeSending() { s.r.resumeSending() }