server.go 25 KB

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