v3_server.go 21 KB

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