server.go 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908
  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. confState = rd.Snapshot.Metadata.ConfState
  350. log.Printf("etcdserver: recovered from incoming snapshot at index %d", snapi)
  351. }
  352. // TODO(bmizerany): do this in the background, but take
  353. // care to apply entries in a single goroutine, and not
  354. // race them.
  355. if len(rd.CommittedEntries) != 0 {
  356. firsti := rd.CommittedEntries[0].Index
  357. if firsti > appliedi+1 {
  358. log.Panicf("etcdserver: first index of committed entry[%d] should <= appliedi[%d] + 1", firsti, appliedi)
  359. }
  360. var ents []raftpb.Entry
  361. if appliedi+1-firsti < uint64(len(rd.CommittedEntries)) {
  362. ents = rd.CommittedEntries[appliedi+1-firsti:]
  363. }
  364. if len(ents) > 0 {
  365. if appliedi, shouldstop = s.apply(ents, &confState); shouldstop {
  366. go s.stopWithDelay(10*100*time.Millisecond, fmt.Errorf("the member has been permanently removed from the cluster"))
  367. }
  368. }
  369. }
  370. s.r.Advance()
  371. if appliedi-snapi > s.r.snapCount {
  372. log.Printf("etcdserver: start to snapshot (applied: %d, lastsnap: %d)", appliedi, snapi)
  373. s.snapshot(appliedi, &confState)
  374. snapi = appliedi
  375. }
  376. case <-syncC:
  377. s.sync(defaultSyncTimeout)
  378. case err := <-s.errorc:
  379. log.Printf("etcdserver: %s", err)
  380. log.Printf("etcdserver: the data-dir used by this member must be removed.")
  381. return
  382. case <-s.stop:
  383. return
  384. }
  385. }
  386. }
  387. // Stop stops the server gracefully, and shuts down the running goroutine.
  388. // Stop should be called after a Start(s), otherwise it will block forever.
  389. func (s *EtcdServer) Stop() {
  390. select {
  391. case s.stop <- struct{}{}:
  392. case <-s.done:
  393. return
  394. }
  395. <-s.done
  396. }
  397. func (s *EtcdServer) stopWithDelay(d time.Duration, err error) {
  398. time.Sleep(d)
  399. select {
  400. case s.errorc <- err:
  401. default:
  402. }
  403. }
  404. // StopNotify returns a channel that receives a empty struct
  405. // when the server is stopped.
  406. func (s *EtcdServer) StopNotify() <-chan struct{} { return s.done }
  407. // Do interprets r and performs an operation on s.store according to r.Method
  408. // and other fields. If r.Method is "POST", "PUT", "DELETE", or a "GET" with
  409. // Quorum == true, r will be sent through consensus before performing its
  410. // respective operation. Do will block until an action is performed or there is
  411. // an error.
  412. func (s *EtcdServer) Do(ctx context.Context, r pb.Request) (Response, error) {
  413. r.ID = s.reqIDGen.Next()
  414. if r.Method == "GET" && r.Quorum {
  415. r.Method = "QGET"
  416. }
  417. switch r.Method {
  418. case "POST", "PUT", "DELETE", "QGET":
  419. data, err := r.Marshal()
  420. if err != nil {
  421. return Response{}, err
  422. }
  423. ch := s.w.Register(r.ID)
  424. s.r.Propose(ctx, data)
  425. select {
  426. case x := <-ch:
  427. resp := x.(Response)
  428. return resp, resp.err
  429. case <-ctx.Done():
  430. s.w.Trigger(r.ID, nil) // GC wait
  431. return Response{}, parseCtxErr(ctx.Err())
  432. case <-s.done:
  433. return Response{}, ErrStopped
  434. }
  435. case "GET":
  436. switch {
  437. case r.Wait:
  438. wc, err := s.store.Watch(r.Path, r.Recursive, r.Stream, r.Since)
  439. if err != nil {
  440. return Response{}, err
  441. }
  442. return Response{Watcher: wc}, nil
  443. default:
  444. ev, err := s.store.Get(r.Path, r.Recursive, r.Sorted)
  445. if err != nil {
  446. return Response{}, err
  447. }
  448. return Response{Event: ev}, nil
  449. }
  450. case "HEAD":
  451. ev, err := s.store.Get(r.Path, r.Recursive, r.Sorted)
  452. if err != nil {
  453. return Response{}, err
  454. }
  455. return Response{Event: ev}, nil
  456. default:
  457. return Response{}, ErrUnknownMethod
  458. }
  459. }
  460. func (s *EtcdServer) SelfStats() []byte { return s.stats.JSON() }
  461. func (s *EtcdServer) LeaderStats() []byte {
  462. lead := atomic.LoadUint64(&s.r.lead)
  463. if lead != uint64(s.id) {
  464. return nil
  465. }
  466. return s.lstats.JSON()
  467. }
  468. func (s *EtcdServer) StoreStats() []byte { return s.store.JsonStats() }
  469. func (s *EtcdServer) raftStatus() interface{} { return s.r.Status() }
  470. func (s *EtcdServer) AddMember(ctx context.Context, memb Member) error {
  471. // TODO: move Member to protobuf type
  472. b, err := json.Marshal(memb)
  473. if err != nil {
  474. return err
  475. }
  476. cc := raftpb.ConfChange{
  477. Type: raftpb.ConfChangeAddNode,
  478. NodeID: uint64(memb.ID),
  479. Context: b,
  480. }
  481. return s.configure(ctx, cc)
  482. }
  483. func (s *EtcdServer) RemoveMember(ctx context.Context, id uint64) error {
  484. cc := raftpb.ConfChange{
  485. Type: raftpb.ConfChangeRemoveNode,
  486. NodeID: id,
  487. }
  488. return s.configure(ctx, cc)
  489. }
  490. func (s *EtcdServer) UpdateMember(ctx context.Context, memb Member) error {
  491. b, err := json.Marshal(memb)
  492. if err != nil {
  493. return err
  494. }
  495. cc := raftpb.ConfChange{
  496. Type: raftpb.ConfChangeUpdateNode,
  497. NodeID: uint64(memb.ID),
  498. Context: b,
  499. }
  500. return s.configure(ctx, cc)
  501. }
  502. // Implement the RaftTimer interface
  503. func (s *EtcdServer) Index() uint64 { return atomic.LoadUint64(&s.r.index) }
  504. func (s *EtcdServer) Term() uint64 { return atomic.LoadUint64(&s.r.term) }
  505. // Only for testing purpose
  506. // TODO: add Raft server interface to expose raft related info:
  507. // Index, Term, Lead, Committed, Applied, LastIndex, etc.
  508. func (s *EtcdServer) Lead() uint64 { return atomic.LoadUint64(&s.r.lead) }
  509. func (s *EtcdServer) Leader() types.ID { return types.ID(s.Lead()) }
  510. // configure sends a configuration change through consensus and
  511. // then waits for it to be applied to the server. It
  512. // will block until the change is performed or there is an error.
  513. func (s *EtcdServer) configure(ctx context.Context, cc raftpb.ConfChange) error {
  514. cc.ID = s.reqIDGen.Next()
  515. ch := s.w.Register(cc.ID)
  516. if err := s.r.ProposeConfChange(ctx, cc); err != nil {
  517. s.w.Trigger(cc.ID, nil)
  518. return err
  519. }
  520. select {
  521. case x := <-ch:
  522. if err, ok := x.(error); ok {
  523. return err
  524. }
  525. if x != nil {
  526. log.Panicf("return type should always be error")
  527. }
  528. return nil
  529. case <-ctx.Done():
  530. s.w.Trigger(cc.ID, nil) // GC wait
  531. return parseCtxErr(ctx.Err())
  532. case <-s.done:
  533. return ErrStopped
  534. }
  535. }
  536. // sync proposes a SYNC request and is non-blocking.
  537. // This makes no guarantee that the request will be proposed or performed.
  538. // The request will be cancelled after the given timeout.
  539. func (s *EtcdServer) sync(timeout time.Duration) {
  540. ctx, cancel := context.WithTimeout(context.Background(), timeout)
  541. req := pb.Request{
  542. Method: "SYNC",
  543. ID: s.reqIDGen.Next(),
  544. Time: time.Now().UnixNano(),
  545. }
  546. data := pbutil.MustMarshal(&req)
  547. // There is no promise that node has leader when do SYNC request,
  548. // so it uses goroutine to propose.
  549. go func() {
  550. s.r.Propose(ctx, data)
  551. cancel()
  552. }()
  553. }
  554. // publish registers server information into the cluster. The information
  555. // is the JSON representation of this server's member struct, updated with the
  556. // static clientURLs of the server.
  557. // The function keeps attempting to register until it succeeds,
  558. // or its server is stopped.
  559. func (s *EtcdServer) publish(retryInterval time.Duration) {
  560. b, err := json.Marshal(s.attributes)
  561. if err != nil {
  562. log.Printf("etcdserver: json marshal error: %v", err)
  563. return
  564. }
  565. req := pb.Request{
  566. Method: "PUT",
  567. Path: MemberAttributesStorePath(s.id),
  568. Val: string(b),
  569. }
  570. for {
  571. ctx, cancel := context.WithTimeout(context.Background(), retryInterval)
  572. _, err := s.Do(ctx, req)
  573. cancel()
  574. switch err {
  575. case nil:
  576. log.Printf("etcdserver: published %+v to cluster %s", s.attributes, s.Cluster.ID())
  577. return
  578. case ErrStopped:
  579. log.Printf("etcdserver: aborting publish because server is stopped")
  580. return
  581. default:
  582. log.Printf("etcdserver: publish error: %v", err)
  583. }
  584. }
  585. }
  586. func (s *EtcdServer) send(ms []raftpb.Message) {
  587. for _, m := range ms {
  588. if !s.Cluster.IsIDRemoved(types.ID(m.To)) {
  589. m.To = 0
  590. }
  591. }
  592. s.r.transport.Send(ms)
  593. }
  594. // apply takes entries received from Raft (after it has been committed) and
  595. // applies them to the current state of the EtcdServer.
  596. // The given entries should not be empty.
  597. func (s *EtcdServer) apply(es []raftpb.Entry, confState *raftpb.ConfState) (uint64, bool) {
  598. var applied uint64
  599. var shouldstop bool
  600. var err error
  601. for i := range es {
  602. e := es[i]
  603. switch e.Type {
  604. case raftpb.EntryNormal:
  605. var r pb.Request
  606. pbutil.MustUnmarshal(&r, e.Data)
  607. s.w.Trigger(r.ID, s.applyRequest(r))
  608. case raftpb.EntryConfChange:
  609. var cc raftpb.ConfChange
  610. pbutil.MustUnmarshal(&cc, e.Data)
  611. shouldstop, err = s.applyConfChange(cc, confState)
  612. s.w.Trigger(cc.ID, err)
  613. default:
  614. log.Panicf("entry type should be either EntryNormal or EntryConfChange")
  615. }
  616. atomic.StoreUint64(&s.r.index, e.Index)
  617. atomic.StoreUint64(&s.r.term, e.Term)
  618. applied = e.Index
  619. }
  620. return applied, shouldstop
  621. }
  622. // applyRequest interprets r as a call to store.X and returns a Response interpreted
  623. // from store.Event
  624. func (s *EtcdServer) applyRequest(r pb.Request) Response {
  625. f := func(ev *store.Event, err error) Response {
  626. return Response{Event: ev, err: err}
  627. }
  628. expr := timeutil.UnixNanoToTime(r.Expiration)
  629. switch r.Method {
  630. case "POST":
  631. return f(s.store.Create(r.Path, r.Dir, r.Val, true, expr))
  632. case "PUT":
  633. exists, existsSet := pbutil.GetBool(r.PrevExist)
  634. switch {
  635. case existsSet:
  636. if exists {
  637. return f(s.store.Update(r.Path, r.Val, expr))
  638. }
  639. return f(s.store.Create(r.Path, r.Dir, r.Val, false, expr))
  640. case r.PrevIndex > 0 || r.PrevValue != "":
  641. return f(s.store.CompareAndSwap(r.Path, r.PrevValue, r.PrevIndex, r.Val, expr))
  642. default:
  643. if storeMemberAttributeRegexp.MatchString(r.Path) {
  644. id := mustParseMemberIDFromKey(path.Dir(r.Path))
  645. var attr Attributes
  646. if err := json.Unmarshal([]byte(r.Val), &attr); err != nil {
  647. log.Panicf("unmarshal %s should never fail: %v", r.Val, err)
  648. }
  649. s.Cluster.UpdateAttributes(id, attr)
  650. }
  651. return f(s.store.Set(r.Path, r.Dir, r.Val, expr))
  652. }
  653. case "DELETE":
  654. switch {
  655. case r.PrevIndex > 0 || r.PrevValue != "":
  656. return f(s.store.CompareAndDelete(r.Path, r.PrevValue, r.PrevIndex))
  657. default:
  658. return f(s.store.Delete(r.Path, r.Dir, r.Recursive))
  659. }
  660. case "QGET":
  661. return f(s.store.Get(r.Path, r.Recursive, r.Sorted))
  662. case "SYNC":
  663. s.store.DeleteExpiredKeys(time.Unix(0, r.Time))
  664. return Response{}
  665. default:
  666. // This should never be reached, but just in case:
  667. return Response{err: ErrUnknownMethod}
  668. }
  669. }
  670. // applyConfChange applies a ConfChange to the server. It is only
  671. // invoked with a ConfChange that has already passed through Raft
  672. func (s *EtcdServer) applyConfChange(cc raftpb.ConfChange, confState *raftpb.ConfState) (bool, error) {
  673. if err := s.Cluster.ValidateConfigurationChange(cc); err != nil {
  674. cc.NodeID = raft.None
  675. s.r.ApplyConfChange(cc)
  676. return false, err
  677. }
  678. *confState = *s.r.ApplyConfChange(cc)
  679. switch cc.Type {
  680. case raftpb.ConfChangeAddNode:
  681. m := new(Member)
  682. if err := json.Unmarshal(cc.Context, m); err != nil {
  683. log.Panicf("unmarshal member should never fail: %v", err)
  684. }
  685. if cc.NodeID != uint64(m.ID) {
  686. log.Panicf("nodeID should always be equal to member ID")
  687. }
  688. s.Cluster.AddMember(m)
  689. if m.ID == s.id {
  690. log.Printf("etcdserver: added local member %s %v to cluster %s", m.ID, m.PeerURLs, s.Cluster.ID())
  691. } else {
  692. s.r.transport.AddPeer(m.ID, m.PeerURLs)
  693. log.Printf("etcdserver: added member %s %v to cluster %s", m.ID, m.PeerURLs, s.Cluster.ID())
  694. }
  695. case raftpb.ConfChangeRemoveNode:
  696. id := types.ID(cc.NodeID)
  697. s.Cluster.RemoveMember(id)
  698. if id == s.id {
  699. return true, nil
  700. } else {
  701. s.r.transport.RemovePeer(id)
  702. log.Printf("etcdserver: removed member %s from cluster %s", id, s.Cluster.ID())
  703. }
  704. case raftpb.ConfChangeUpdateNode:
  705. m := new(Member)
  706. if err := json.Unmarshal(cc.Context, m); err != nil {
  707. log.Panicf("unmarshal member should never fail: %v", err)
  708. }
  709. if cc.NodeID != uint64(m.ID) {
  710. log.Panicf("nodeID should always be equal to member ID")
  711. }
  712. s.Cluster.UpdateRaftAttributes(m.ID, m.RaftAttributes)
  713. if m.ID == s.id {
  714. log.Printf("etcdserver: update local member %s %v in cluster %s", m.ID, m.PeerURLs, s.Cluster.ID())
  715. } else {
  716. s.r.transport.UpdatePeer(m.ID, m.PeerURLs)
  717. log.Printf("etcdserver: update member %s %v in cluster %s", m.ID, m.PeerURLs, s.Cluster.ID())
  718. }
  719. }
  720. return false, nil
  721. }
  722. // TODO: non-blocking snapshot
  723. func (s *EtcdServer) snapshot(snapi uint64, confState *raftpb.ConfState) {
  724. d, err := s.store.Save()
  725. // TODO: current store will never fail to do a snapshot
  726. // what should we do if the store might fail?
  727. if err != nil {
  728. log.Panicf("etcdserver: store save should never fail: %v", err)
  729. }
  730. err = s.r.raftStorage.Compact(snapi, confState, d)
  731. if err != nil {
  732. // the snapshot was done asynchronously with the progress of raft.
  733. // raft might have already got a newer snapshot and called compact.
  734. if err == raft.ErrCompacted {
  735. return
  736. }
  737. log.Panicf("etcdserver: unexpected compaction error %v", err)
  738. }
  739. log.Printf("etcdserver: compacted log at index %d", snapi)
  740. if err := s.r.storage.Cut(); err != nil {
  741. log.Panicf("etcdserver: rotate wal file should never fail: %v", err)
  742. }
  743. snap, err := s.r.raftStorage.Snapshot()
  744. if err != nil {
  745. log.Panicf("etcdserver: snapshot error: %v", err)
  746. }
  747. if err := s.r.storage.SaveSnap(snap); err != nil {
  748. log.Fatalf("etcdserver: save snapshot error: %v", err)
  749. }
  750. log.Printf("etcdserver: saved snapshot at index %d", snap.Metadata.Index)
  751. }
  752. func (s *EtcdServer) PauseSending() { s.r.pauseSending() }
  753. func (s *EtcdServer) ResumeSending() { s.r.resumeSending() }
  754. // isBootstrapped tries to check if the given member has been bootstrapped
  755. // in the given cluster.
  756. func isBootstrapped(cfg *ServerConfig) bool {
  757. cl := cfg.Cluster
  758. member := cfg.Name
  759. us := getOtherPeerURLs(cl, member)
  760. rcl, err := getClusterFromPeers(us, false, cfg.Transport)
  761. if err != nil {
  762. return false
  763. }
  764. id := cl.MemberByName(member).ID
  765. m := rcl.Member(id)
  766. if m == nil {
  767. return false
  768. }
  769. if len(m.ClientURLs) > 0 {
  770. return true
  771. }
  772. return false
  773. }
  774. // GetClusterFromPeers takes a set of URLs representing etcd peers, and
  775. // attempts to construct a Cluster by accessing the members endpoint on one of
  776. // these URLs. The first URL to provide a response is used. If no URLs provide
  777. // a response, or a Cluster cannot be successfully created from a received
  778. // response, an error is returned.
  779. func GetClusterFromPeers(urls []string, tr *http.Transport) (*Cluster, error) {
  780. return getClusterFromPeers(urls, true, tr)
  781. }
  782. // If logerr is true, it prints out more error messages.
  783. func getClusterFromPeers(urls []string, logerr bool, tr *http.Transport) (*Cluster, error) {
  784. cc := &http.Client{
  785. Transport: tr,
  786. Timeout: time.Second,
  787. }
  788. for _, u := range urls {
  789. resp, err := cc.Get(u + "/members")
  790. if err != nil {
  791. if logerr {
  792. log.Printf("etcdserver: could not get cluster response from %s: %v", u, err)
  793. }
  794. continue
  795. }
  796. b, err := ioutil.ReadAll(resp.Body)
  797. if err != nil {
  798. if logerr {
  799. log.Printf("etcdserver: could not read the body of cluster response: %v", err)
  800. }
  801. continue
  802. }
  803. var membs []*Member
  804. if err := json.Unmarshal(b, &membs); err != nil {
  805. if logerr {
  806. log.Printf("etcdserver: could not unmarshal cluster response: %v", err)
  807. }
  808. continue
  809. }
  810. id, err := types.IDFromString(resp.Header.Get("X-Etcd-Cluster-ID"))
  811. if err != nil {
  812. if logerr {
  813. log.Printf("etcdserver: could not parse the cluster ID from cluster res: %v", err)
  814. }
  815. continue
  816. }
  817. return NewClusterFromMembers("", id, membs), nil
  818. }
  819. return nil, fmt.Errorf("etcdserver: could not retrieve cluster information from the given urls")
  820. }
  821. // getOtherPeerURLs returns peer urls of other members in the cluster. The
  822. // returned list is sorted in ascending lexicographical order.
  823. func getOtherPeerURLs(cl ClusterInfo, self string) []string {
  824. us := make([]string, 0)
  825. for _, m := range cl.Members() {
  826. if m.Name == self {
  827. continue
  828. }
  829. us = append(us, m.PeerURLs...)
  830. }
  831. sort.Strings(us)
  832. return us
  833. }