server.go 27 KB

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