v3_server.go 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692
  1. // Copyright 2015 The etcd Authors
  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. "bytes"
  17. "encoding/binary"
  18. "time"
  19. "github.com/gogo/protobuf/proto"
  20. "github.com/coreos/etcd/auth"
  21. pb "github.com/coreos/etcd/etcdserver/etcdserverpb"
  22. "github.com/coreos/etcd/etcdserver/membership"
  23. "github.com/coreos/etcd/lease"
  24. "github.com/coreos/etcd/lease/leasehttp"
  25. "github.com/coreos/etcd/mvcc"
  26. "github.com/coreos/etcd/raft"
  27. "golang.org/x/net/context"
  28. )
  29. const (
  30. // the max request size that raft accepts.
  31. // TODO: make this a flag? But we probably do not want to
  32. // accept large request which might block raft stream. User
  33. // specify a large value might end up with shooting in the foot.
  34. maxRequestBytes = 1.5 * 1024 * 1024
  35. // In the health case, there might be a small gap (10s of entries) between
  36. // the applied index and committed index.
  37. // However, if the committed entries are very heavy to apply, the gap might grow.
  38. // We should stop accepting new proposals if the gap growing to a certain point.
  39. maxGapBetweenApplyAndCommitIndex = 5000
  40. )
  41. type RaftKV interface {
  42. Range(ctx context.Context, r *pb.RangeRequest) (*pb.RangeResponse, error)
  43. Put(ctx context.Context, r *pb.PutRequest) (*pb.PutResponse, error)
  44. DeleteRange(ctx context.Context, r *pb.DeleteRangeRequest) (*pb.DeleteRangeResponse, error)
  45. Txn(ctx context.Context, r *pb.TxnRequest) (*pb.TxnResponse, error)
  46. Compact(ctx context.Context, r *pb.CompactionRequest) (*pb.CompactionResponse, error)
  47. }
  48. type Lessor interface {
  49. // LeaseGrant sends LeaseGrant request to raft and apply it after committed.
  50. LeaseGrant(ctx context.Context, r *pb.LeaseGrantRequest) (*pb.LeaseGrantResponse, error)
  51. // LeaseRevoke sends LeaseRevoke request to raft and apply it after committed.
  52. LeaseRevoke(ctx context.Context, r *pb.LeaseRevokeRequest) (*pb.LeaseRevokeResponse, error)
  53. // LeaseRenew renews the lease with given ID. The renewed TTL is returned. Or an error
  54. // is returned.
  55. LeaseRenew(ctx context.Context, id lease.LeaseID) (int64, error)
  56. // LeaseTimeToLive retrieves lease information.
  57. LeaseTimeToLive(ctx context.Context, r *pb.LeaseTimeToLiveRequest) (*pb.LeaseTimeToLiveResponse, error)
  58. }
  59. type Authenticator interface {
  60. AuthEnable(ctx context.Context, r *pb.AuthEnableRequest) (*pb.AuthEnableResponse, error)
  61. AuthDisable(ctx context.Context, r *pb.AuthDisableRequest) (*pb.AuthDisableResponse, error)
  62. Authenticate(ctx context.Context, r *pb.AuthenticateRequest) (*pb.AuthenticateResponse, error)
  63. UserAdd(ctx context.Context, r *pb.AuthUserAddRequest) (*pb.AuthUserAddResponse, error)
  64. UserDelete(ctx context.Context, r *pb.AuthUserDeleteRequest) (*pb.AuthUserDeleteResponse, error)
  65. UserChangePassword(ctx context.Context, r *pb.AuthUserChangePasswordRequest) (*pb.AuthUserChangePasswordResponse, error)
  66. UserGrantRole(ctx context.Context, r *pb.AuthUserGrantRoleRequest) (*pb.AuthUserGrantRoleResponse, error)
  67. UserGet(ctx context.Context, r *pb.AuthUserGetRequest) (*pb.AuthUserGetResponse, error)
  68. UserRevokeRole(ctx context.Context, r *pb.AuthUserRevokeRoleRequest) (*pb.AuthUserRevokeRoleResponse, error)
  69. RoleAdd(ctx context.Context, r *pb.AuthRoleAddRequest) (*pb.AuthRoleAddResponse, error)
  70. RoleGrantPermission(ctx context.Context, r *pb.AuthRoleGrantPermissionRequest) (*pb.AuthRoleGrantPermissionResponse, error)
  71. RoleGet(ctx context.Context, r *pb.AuthRoleGetRequest) (*pb.AuthRoleGetResponse, error)
  72. RoleRevokePermission(ctx context.Context, r *pb.AuthRoleRevokePermissionRequest) (*pb.AuthRoleRevokePermissionResponse, error)
  73. RoleDelete(ctx context.Context, r *pb.AuthRoleDeleteRequest) (*pb.AuthRoleDeleteResponse, error)
  74. UserList(ctx context.Context, r *pb.AuthUserListRequest) (*pb.AuthUserListResponse, error)
  75. RoleList(ctx context.Context, r *pb.AuthRoleListRequest) (*pb.AuthRoleListResponse, error)
  76. }
  77. func (s *EtcdServer) Range(ctx context.Context, r *pb.RangeRequest) (*pb.RangeResponse, error) {
  78. if !r.Serializable {
  79. err := s.linearizableReadNotify(ctx)
  80. if err != nil {
  81. return nil, err
  82. }
  83. }
  84. var resp *pb.RangeResponse
  85. var err error
  86. chk := func(ai *auth.AuthInfo) error {
  87. return s.authStore.IsRangePermitted(ai, r.Key, r.RangeEnd)
  88. }
  89. get := func() { resp, err = s.applyV3Base.Range(nil, r) }
  90. if serr := s.doSerialize(ctx, chk, get); serr != nil {
  91. return nil, serr
  92. }
  93. return resp, err
  94. }
  95. func (s *EtcdServer) Put(ctx context.Context, r *pb.PutRequest) (*pb.PutResponse, error) {
  96. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{Put: r})
  97. if err != nil {
  98. return nil, err
  99. }
  100. return resp.(*pb.PutResponse), nil
  101. }
  102. func (s *EtcdServer) DeleteRange(ctx context.Context, r *pb.DeleteRangeRequest) (*pb.DeleteRangeResponse, error) {
  103. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{DeleteRange: r})
  104. if err != nil {
  105. return nil, err
  106. }
  107. return resp.(*pb.DeleteRangeResponse), nil
  108. }
  109. func (s *EtcdServer) Txn(ctx context.Context, r *pb.TxnRequest) (*pb.TxnResponse, error) {
  110. if isTxnReadonly(r) {
  111. if !isTxnSerializable(r) {
  112. err := s.linearizableReadNotify(ctx)
  113. if err != nil {
  114. return nil, err
  115. }
  116. }
  117. var resp *pb.TxnResponse
  118. var err error
  119. chk := func(ai *auth.AuthInfo) error {
  120. return checkTxnAuth(s.authStore, ai, r)
  121. }
  122. get := func() { resp, err = s.applyV3Base.Txn(r) }
  123. if serr := s.doSerialize(ctx, chk, get); serr != nil {
  124. return nil, serr
  125. }
  126. return resp, err
  127. }
  128. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{Txn: r})
  129. if err != nil {
  130. return nil, err
  131. }
  132. return resp.(*pb.TxnResponse), nil
  133. }
  134. func isTxnSerializable(r *pb.TxnRequest) bool {
  135. for _, u := range r.Success {
  136. if r := u.GetRequestRange(); r == nil || !r.Serializable {
  137. return false
  138. }
  139. }
  140. for _, u := range r.Failure {
  141. if r := u.GetRequestRange(); r == nil || !r.Serializable {
  142. return false
  143. }
  144. }
  145. return true
  146. }
  147. func isTxnReadonly(r *pb.TxnRequest) bool {
  148. for _, u := range r.Success {
  149. if r := u.GetRequestRange(); r == nil {
  150. return false
  151. }
  152. }
  153. for _, u := range r.Failure {
  154. if r := u.GetRequestRange(); r == nil {
  155. return false
  156. }
  157. }
  158. return true
  159. }
  160. func (s *EtcdServer) Compact(ctx context.Context, r *pb.CompactionRequest) (*pb.CompactionResponse, error) {
  161. result, err := s.processInternalRaftRequestOnce(ctx, pb.InternalRaftRequest{Compaction: r})
  162. if r.Physical && result != nil && result.physc != nil {
  163. <-result.physc
  164. // The compaction is done deleting keys; the hash is now settled
  165. // but the data is not necessarily committed. If there's a crash,
  166. // the hash may revert to a hash prior to compaction completing
  167. // if the compaction resumes. Force the finished compaction to
  168. // commit so it won't resume following a crash.
  169. s.be.ForceCommit()
  170. }
  171. if err != nil {
  172. return nil, err
  173. }
  174. if result.err != nil {
  175. return nil, result.err
  176. }
  177. resp := result.resp.(*pb.CompactionResponse)
  178. if resp == nil {
  179. resp = &pb.CompactionResponse{}
  180. }
  181. if resp.Header == nil {
  182. resp.Header = &pb.ResponseHeader{}
  183. }
  184. resp.Header.Revision = s.kv.Rev()
  185. return resp, nil
  186. }
  187. func (s *EtcdServer) LeaseGrant(ctx context.Context, r *pb.LeaseGrantRequest) (*pb.LeaseGrantResponse, error) {
  188. // no id given? choose one
  189. for r.ID == int64(lease.NoLease) {
  190. // only use positive int64 id's
  191. r.ID = int64(s.reqIDGen.Next() & ((1 << 63) - 1))
  192. }
  193. resp, err := s.raftRequestOnce(ctx, pb.InternalRaftRequest{LeaseGrant: r})
  194. if err != nil {
  195. return nil, err
  196. }
  197. return resp.(*pb.LeaseGrantResponse), nil
  198. }
  199. func (s *EtcdServer) LeaseRevoke(ctx context.Context, r *pb.LeaseRevokeRequest) (*pb.LeaseRevokeResponse, error) {
  200. resp, err := s.raftRequestOnce(ctx, pb.InternalRaftRequest{LeaseRevoke: r})
  201. if err != nil {
  202. return nil, err
  203. }
  204. return resp.(*pb.LeaseRevokeResponse), nil
  205. }
  206. func (s *EtcdServer) LeaseRenew(ctx context.Context, id lease.LeaseID) (int64, error) {
  207. ttl, err := s.lessor.Renew(id)
  208. if err == nil { // already requested to primary lessor(leader)
  209. return ttl, nil
  210. }
  211. if err != lease.ErrNotPrimary {
  212. return -1, err
  213. }
  214. cctx, cancel := context.WithTimeout(ctx, s.Cfg.ReqTimeout())
  215. defer cancel()
  216. // renewals don't go through raft; forward to leader manually
  217. for cctx.Err() == nil && err != nil {
  218. leader, lerr := s.waitLeader(cctx)
  219. if lerr != nil {
  220. return -1, lerr
  221. }
  222. for _, url := range leader.PeerURLs {
  223. lurl := url + leasehttp.LeasePrefix
  224. ttl, err = leasehttp.RenewHTTP(cctx, id, lurl, s.peerRt)
  225. if err == nil || err == lease.ErrLeaseNotFound {
  226. return ttl, err
  227. }
  228. }
  229. }
  230. return -1, ErrTimeout
  231. }
  232. func (s *EtcdServer) LeaseTimeToLive(ctx context.Context, r *pb.LeaseTimeToLiveRequest) (*pb.LeaseTimeToLiveResponse, error) {
  233. if s.Leader() == s.ID() {
  234. // primary; timetolive directly from leader
  235. le := s.lessor.Lookup(lease.LeaseID(r.ID))
  236. if le == nil {
  237. return nil, lease.ErrLeaseNotFound
  238. }
  239. // TODO: fill out ResponseHeader
  240. resp := &pb.LeaseTimeToLiveResponse{Header: &pb.ResponseHeader{}, ID: r.ID, TTL: int64(le.Remaining().Seconds()), GrantedTTL: le.TTL()}
  241. if r.Keys {
  242. ks := le.Keys()
  243. kbs := make([][]byte, len(ks))
  244. for i := range ks {
  245. kbs[i] = []byte(ks[i])
  246. }
  247. resp.Keys = kbs
  248. }
  249. return resp, nil
  250. }
  251. cctx, cancel := context.WithTimeout(ctx, s.Cfg.ReqTimeout())
  252. defer cancel()
  253. // forward to leader
  254. for cctx.Err() == nil {
  255. leader, err := s.waitLeader(cctx)
  256. if err != nil {
  257. return nil, err
  258. }
  259. for _, url := range leader.PeerURLs {
  260. lurl := url + leasehttp.LeaseInternalPrefix
  261. resp, err := leasehttp.TimeToLiveHTTP(cctx, lease.LeaseID(r.ID), r.Keys, lurl, s.peerRt)
  262. if err == nil {
  263. return resp.LeaseTimeToLiveResponse, nil
  264. }
  265. if err == lease.ErrLeaseNotFound {
  266. return nil, err
  267. }
  268. }
  269. }
  270. return nil, ErrTimeout
  271. }
  272. func (s *EtcdServer) waitLeader(ctx context.Context) (*membership.Member, error) {
  273. leader := s.cluster.Member(s.Leader())
  274. for leader == nil {
  275. // wait an election
  276. dur := time.Duration(s.Cfg.ElectionTicks) * time.Duration(s.Cfg.TickMs) * time.Millisecond
  277. select {
  278. case <-time.After(dur):
  279. leader = s.cluster.Member(s.Leader())
  280. case <-s.stopping:
  281. return nil, ErrStopped
  282. case <-ctx.Done():
  283. return nil, ErrNoLeader
  284. }
  285. }
  286. if leader == nil || len(leader.PeerURLs) == 0 {
  287. return nil, ErrNoLeader
  288. }
  289. return leader, nil
  290. }
  291. func (s *EtcdServer) Alarm(ctx context.Context, r *pb.AlarmRequest) (*pb.AlarmResponse, error) {
  292. resp, err := s.raftRequestOnce(ctx, pb.InternalRaftRequest{Alarm: r})
  293. if err != nil {
  294. return nil, err
  295. }
  296. return resp.(*pb.AlarmResponse), nil
  297. }
  298. func (s *EtcdServer) AuthEnable(ctx context.Context, r *pb.AuthEnableRequest) (*pb.AuthEnableResponse, error) {
  299. resp, err := s.raftRequestOnce(ctx, pb.InternalRaftRequest{AuthEnable: r})
  300. if err != nil {
  301. return nil, err
  302. }
  303. return resp.(*pb.AuthEnableResponse), nil
  304. }
  305. func (s *EtcdServer) AuthDisable(ctx context.Context, r *pb.AuthDisableRequest) (*pb.AuthDisableResponse, error) {
  306. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthDisable: r})
  307. if err != nil {
  308. return nil, err
  309. }
  310. return resp.(*pb.AuthDisableResponse), nil
  311. }
  312. func (s *EtcdServer) Authenticate(ctx context.Context, r *pb.AuthenticateRequest) (*pb.AuthenticateResponse, error) {
  313. if err := s.linearizableReadNotify(ctx); err != nil {
  314. return nil, err
  315. }
  316. var resp proto.Message
  317. for {
  318. checkedRevision, err := s.AuthStore().CheckPassword(r.Name, r.Password)
  319. if err != nil {
  320. if err != auth.ErrAuthNotEnabled {
  321. plog.Errorf("invalid authentication request to user %s was issued", r.Name)
  322. }
  323. return nil, err
  324. }
  325. st, err := s.AuthStore().GenTokenPrefix()
  326. if err != nil {
  327. return nil, err
  328. }
  329. internalReq := &pb.InternalAuthenticateRequest{
  330. Name: r.Name,
  331. Password: r.Password,
  332. SimpleToken: st,
  333. }
  334. resp, err = s.raftRequestOnce(ctx, pb.InternalRaftRequest{Authenticate: internalReq})
  335. if err != nil {
  336. return nil, err
  337. }
  338. if checkedRevision == s.AuthStore().Revision() {
  339. break
  340. }
  341. plog.Infof("revision when password checked is obsolete, retrying")
  342. }
  343. return resp.(*pb.AuthenticateResponse), nil
  344. }
  345. func (s *EtcdServer) UserAdd(ctx context.Context, r *pb.AuthUserAddRequest) (*pb.AuthUserAddResponse, error) {
  346. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserAdd: r})
  347. if err != nil {
  348. return nil, err
  349. }
  350. return resp.(*pb.AuthUserAddResponse), nil
  351. }
  352. func (s *EtcdServer) UserDelete(ctx context.Context, r *pb.AuthUserDeleteRequest) (*pb.AuthUserDeleteResponse, error) {
  353. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserDelete: r})
  354. if err != nil {
  355. return nil, err
  356. }
  357. return resp.(*pb.AuthUserDeleteResponse), nil
  358. }
  359. func (s *EtcdServer) UserChangePassword(ctx context.Context, r *pb.AuthUserChangePasswordRequest) (*pb.AuthUserChangePasswordResponse, error) {
  360. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserChangePassword: r})
  361. if err != nil {
  362. return nil, err
  363. }
  364. return resp.(*pb.AuthUserChangePasswordResponse), nil
  365. }
  366. func (s *EtcdServer) UserGrantRole(ctx context.Context, r *pb.AuthUserGrantRoleRequest) (*pb.AuthUserGrantRoleResponse, error) {
  367. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserGrantRole: r})
  368. if err != nil {
  369. return nil, err
  370. }
  371. return resp.(*pb.AuthUserGrantRoleResponse), nil
  372. }
  373. func (s *EtcdServer) UserGet(ctx context.Context, r *pb.AuthUserGetRequest) (*pb.AuthUserGetResponse, error) {
  374. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserGet: r})
  375. if err != nil {
  376. return nil, err
  377. }
  378. return resp.(*pb.AuthUserGetResponse), nil
  379. }
  380. func (s *EtcdServer) UserList(ctx context.Context, r *pb.AuthUserListRequest) (*pb.AuthUserListResponse, error) {
  381. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserList: r})
  382. if err != nil {
  383. return nil, err
  384. }
  385. return resp.(*pb.AuthUserListResponse), nil
  386. }
  387. func (s *EtcdServer) UserRevokeRole(ctx context.Context, r *pb.AuthUserRevokeRoleRequest) (*pb.AuthUserRevokeRoleResponse, error) {
  388. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserRevokeRole: r})
  389. if err != nil {
  390. return nil, err
  391. }
  392. return resp.(*pb.AuthUserRevokeRoleResponse), nil
  393. }
  394. func (s *EtcdServer) RoleAdd(ctx context.Context, r *pb.AuthRoleAddRequest) (*pb.AuthRoleAddResponse, error) {
  395. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthRoleAdd: r})
  396. if err != nil {
  397. return nil, err
  398. }
  399. return resp.(*pb.AuthRoleAddResponse), nil
  400. }
  401. func (s *EtcdServer) RoleGrantPermission(ctx context.Context, r *pb.AuthRoleGrantPermissionRequest) (*pb.AuthRoleGrantPermissionResponse, error) {
  402. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthRoleGrantPermission: r})
  403. if err != nil {
  404. return nil, err
  405. }
  406. return resp.(*pb.AuthRoleGrantPermissionResponse), nil
  407. }
  408. func (s *EtcdServer) RoleGet(ctx context.Context, r *pb.AuthRoleGetRequest) (*pb.AuthRoleGetResponse, error) {
  409. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthRoleGet: r})
  410. if err != nil {
  411. return nil, err
  412. }
  413. return resp.(*pb.AuthRoleGetResponse), nil
  414. }
  415. func (s *EtcdServer) RoleList(ctx context.Context, r *pb.AuthRoleListRequest) (*pb.AuthRoleListResponse, error) {
  416. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthRoleList: r})
  417. if err != nil {
  418. return nil, err
  419. }
  420. return resp.(*pb.AuthRoleListResponse), nil
  421. }
  422. func (s *EtcdServer) RoleRevokePermission(ctx context.Context, r *pb.AuthRoleRevokePermissionRequest) (*pb.AuthRoleRevokePermissionResponse, error) {
  423. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthRoleRevokePermission: r})
  424. if err != nil {
  425. return nil, err
  426. }
  427. return resp.(*pb.AuthRoleRevokePermissionResponse), nil
  428. }
  429. func (s *EtcdServer) RoleDelete(ctx context.Context, r *pb.AuthRoleDeleteRequest) (*pb.AuthRoleDeleteResponse, error) {
  430. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthRoleDelete: r})
  431. if err != nil {
  432. return nil, err
  433. }
  434. return resp.(*pb.AuthRoleDeleteResponse), nil
  435. }
  436. func (s *EtcdServer) raftRequestOnce(ctx context.Context, r pb.InternalRaftRequest) (proto.Message, error) {
  437. result, err := s.processInternalRaftRequestOnce(ctx, r)
  438. if err != nil {
  439. return nil, err
  440. }
  441. if result.err != nil {
  442. return nil, result.err
  443. }
  444. return result.resp, nil
  445. }
  446. func (s *EtcdServer) raftRequest(ctx context.Context, r pb.InternalRaftRequest) (proto.Message, error) {
  447. for {
  448. resp, err := s.raftRequestOnce(ctx, r)
  449. if err != auth.ErrAuthOldRevision {
  450. return resp, err
  451. }
  452. }
  453. }
  454. // doSerialize handles the auth logic, with permissions checked by "chk", for a serialized request "get". Returns a non-nil error on authentication failure.
  455. func (s *EtcdServer) doSerialize(ctx context.Context, chk func(*auth.AuthInfo) error, get func()) error {
  456. for {
  457. ai, err := s.AuthInfoFromCtx(ctx)
  458. if err != nil {
  459. return err
  460. }
  461. if ai == nil {
  462. // chk expects non-nil AuthInfo; use empty credentials
  463. ai = &auth.AuthInfo{}
  464. }
  465. if err = chk(ai); err != nil {
  466. if err == auth.ErrAuthOldRevision {
  467. continue
  468. }
  469. return err
  470. }
  471. // fetch response for serialized request
  472. get()
  473. // empty credentials or current auth info means no need to retry
  474. if ai.Revision == 0 || ai.Revision == s.authStore.Revision() {
  475. return nil
  476. }
  477. // avoid TOCTOU error, retry of the request is required.
  478. }
  479. }
  480. func (s *EtcdServer) processInternalRaftRequestOnce(ctx context.Context, r pb.InternalRaftRequest) (*applyResult, error) {
  481. ai := s.getAppliedIndex()
  482. ci := s.getCommittedIndex()
  483. if ci > ai+maxGapBetweenApplyAndCommitIndex {
  484. return nil, ErrTooManyRequests
  485. }
  486. r.Header = &pb.RequestHeader{
  487. ID: s.reqIDGen.Next(),
  488. }
  489. authInfo, err := s.AuthInfoFromCtx(ctx)
  490. if err != nil {
  491. return nil, err
  492. }
  493. if authInfo != nil {
  494. r.Header.Username = authInfo.Username
  495. r.Header.AuthRevision = authInfo.Revision
  496. }
  497. data, err := r.Marshal()
  498. if err != nil {
  499. return nil, err
  500. }
  501. if len(data) > maxRequestBytes {
  502. return nil, ErrRequestTooLarge
  503. }
  504. id := r.ID
  505. if id == 0 {
  506. id = r.Header.ID
  507. }
  508. ch := s.w.Register(id)
  509. cctx, cancel := context.WithTimeout(ctx, s.Cfg.ReqTimeout())
  510. defer cancel()
  511. start := time.Now()
  512. s.r.Propose(cctx, data)
  513. proposalsPending.Inc()
  514. defer proposalsPending.Dec()
  515. select {
  516. case x := <-ch:
  517. return x.(*applyResult), nil
  518. case <-cctx.Done():
  519. proposalsFailed.Inc()
  520. s.w.Trigger(id, nil) // GC wait
  521. return nil, s.parseProposeCtxErr(cctx.Err(), start)
  522. case <-s.done:
  523. return nil, ErrStopped
  524. }
  525. }
  526. // Watchable returns a watchable interface attached to the etcdserver.
  527. func (s *EtcdServer) Watchable() mvcc.WatchableKV { return s.KV() }
  528. func (s *EtcdServer) linearizableReadLoop() {
  529. var rs raft.ReadState
  530. for {
  531. ctx := make([]byte, 8)
  532. binary.BigEndian.PutUint64(ctx, s.reqIDGen.Next())
  533. select {
  534. case <-s.readwaitc:
  535. case <-s.stopping:
  536. return
  537. }
  538. nextnr := newNotifier()
  539. s.readMu.Lock()
  540. nr := s.readNotifier
  541. s.readNotifier = nextnr
  542. s.readMu.Unlock()
  543. cctx, cancel := context.WithTimeout(context.Background(), s.Cfg.ReqTimeout())
  544. if err := s.r.ReadIndex(cctx, ctx); err != nil {
  545. cancel()
  546. if err == raft.ErrStopped {
  547. return
  548. }
  549. plog.Errorf("failed to get read index from raft: %v", err)
  550. nr.notify(err)
  551. continue
  552. }
  553. cancel()
  554. var (
  555. timeout bool
  556. done bool
  557. )
  558. for !timeout && !done {
  559. select {
  560. case rs = <-s.r.readStateC:
  561. done = bytes.Equal(rs.RequestCtx, ctx)
  562. if !done {
  563. // a previous request might time out. now we should ignore the response of it and
  564. // continue waiting for the response of the current requests.
  565. plog.Warningf("ignored out-of-date read index response (want %v, got %v)", rs.RequestCtx, ctx)
  566. }
  567. case <-time.After(s.Cfg.ReqTimeout()):
  568. plog.Warningf("timed out waiting for read index response")
  569. nr.notify(ErrTimeout)
  570. timeout = true
  571. case <-s.stopping:
  572. return
  573. }
  574. }
  575. if !done {
  576. continue
  577. }
  578. if ai := s.getAppliedIndex(); ai < rs.Index {
  579. select {
  580. case <-s.applyWait.Wait(rs.Index):
  581. case <-s.stopping:
  582. return
  583. }
  584. }
  585. // unblock all l-reads requested at indices before rs.Index
  586. nr.notify(nil)
  587. }
  588. }
  589. func (s *EtcdServer) linearizableReadNotify(ctx context.Context) error {
  590. s.readMu.RLock()
  591. nc := s.readNotifier
  592. s.readMu.RUnlock()
  593. // signal linearizable loop for current notify if it hasn't been already
  594. select {
  595. case s.readwaitc <- struct{}{}:
  596. default:
  597. }
  598. // wait for read state notification
  599. select {
  600. case <-nc.c:
  601. return nc.err
  602. case <-ctx.Done():
  603. return ctx.Err()
  604. case <-s.done:
  605. return ErrStopped
  606. }
  607. }
  608. func (s *EtcdServer) AuthInfoFromCtx(ctx context.Context) (*auth.AuthInfo, error) {
  609. if s.Cfg.ClientCertAuthEnabled {
  610. authInfo := s.AuthStore().AuthInfoFromTLS(ctx)
  611. if authInfo != nil {
  612. return authInfo, nil
  613. }
  614. }
  615. return s.AuthStore().AuthInfoFromCtx(ctx)
  616. }