server.go 25 KB

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