server.go 25 KB

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