server.go 27 KB

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