server.go 27 KB

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