v3_server.go 21 KB

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