package curve.chunkserver

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ChunkServerStatus (ChunkServerStatusRequest, ChunkServerStatusResponse)

  chunkserver.proto:37

  message ChunkServerStatusRequest

  chunkserver.proto:29

  (message has no fields)

  message ChunkServerStatusResponse

  chunkserver.proto:32

  • required bool copysetLoadFin = 1

• rpc DeleteChunk (ChunkRequest, ChunkResponse)

  chunk.proto:147

• rpc ReadChunk (ChunkRequest, ChunkResponse)

  chunk.proto:148

• rpc WriteChunk (ChunkRequest, ChunkResponse)

  chunk.proto:149

• rpc ReadChunkSnapshot (ChunkRequest, ChunkResponse)

  chunk.proto:151

• rpc DeleteChunkSnapshotOrCorrectSn (ChunkRequest, ChunkResponse)

  chunk.proto:152

• rpc GetChunkInfo (GetChunkInfoRequest, GetChunkInfoResponse)

  chunk.proto:154

  message GetChunkInfoRequest

  chunk.proto:99

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • required uint64 chunkId = 3

  message GetChunkInfoResponse

  chunk.proto:105

  • required CHUNK_OP_STATUS status = 1

  • optional string redirect = 2

    自己不是 leader，重定向给 leader

  • repeated uint64 chunkSn = 3

    chunk 版本号 和 snapshot 版本号

• rpc GetChunkHash (GetChunkHashRequest, GetChunkHashResponse)

  chunk.proto:155

  message GetChunkHashRequest

  chunk.proto:111

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • required uint64 chunkId = 3

  • required uint32 offset = 4

  • required uint32 length = 5

  message GetChunkHashResponse

  chunk.proto:119

  • required CHUNK_OP_STATUS status = 1

  • optional string hash = 2

    能标志chunk数据状态的hash值，一般是crc32c

• rpc CreateCloneChunk (ChunkRequest, ChunkResponse)

  chunk.proto:157

• rpc CreateS3CloneChunk (CreateS3CloneChunkRequest, CreateS3CloneChunkResponse)

  chunk.proto:159

  message CreateS3CloneChunkRequest

  chunk.proto:124

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • required uint64 chunkId = 3

  • optional uint64 correctedSn = 4

  • optional string chunkLocationInfo = 5

  message CreateS3CloneChunkResponse

  chunk.proto:132

  • required CHUNK_OP_STATUS status = 1

  • optional string redirect = 2

    自己不是 leader，重定向给 leader

• rpc RecoverChunk (ChunkRequest, ChunkResponse)

  chunk.proto:161

• rpc UpdateEpoch (UpdateEpochRequest, UpdateEpochResponse)

  chunk.proto:163

  message UpdateEpochRequest

  chunk.proto:137

  • required uint64 fileId = 1

  • required uint64 epoch = 2

  message UpdateEpochResponse

  chunk.proto:142

  • required CHUNK_OP_STATUS status = 1

service

• rpc add_peer (AddPeerRequest, AddPeerResponse)

  cli.proto:104

  message AddPeerRequest

  cli.proto:27

  这里都用 logicPoolId, copysetId,进入 rpc service 之后，会转换成 string 类型的 groupId，在传给 raft | groupId | | logicPoolId | copysetId |

  • required uint32 logicPoolId = 1

    logicPoolId 实际上 uint16，但是 proto 没有 uint16

  • required uint32 copysetId = 2

  • required string leader_id = 3

  • required string peer_id = 4

  message AddPeerResponse

  cli.proto:34

  • repeated string old_peers = 1

  • repeated string new_peers = 2

• rpc remove_peer (RemovePeerRequest, RemovePeerResponse)

  cli.proto:105

  message RemovePeerRequest

  cli.proto:39

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • required string leader_id = 3

  • required string peer_id = 4

  message RemovePeerResponse

  cli.proto:46

  • repeated string old_peers = 1

  • repeated string new_peers = 2

• rpc change_peers (ChangePeersRequest, ChangePeersResponse)

  cli.proto:106

  message ChangePeersRequest

  cli.proto:51

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • required string leader_id = 3

  • repeated string new_peers = 4

  message ChangePeersResponse

  cli.proto:58

  • repeated string old_peers = 1

  • repeated string new_peers = 2

• rpc reset_peer (ResetPeerRequest, ResetPeerResponse)

  cli.proto:107

  message ResetPeerRequest

  cli.proto:69

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • required string peer_id = 3

  • repeated string old_peers = 4

  • repeated string new_peers = 5

  message ResetPeerResponse

  cli.proto:86

  (message has no fields)

• rpc snapshot (SnapshotRequest, SnapshotResponse)

  cli.proto:108

  message SnapshotRequest

  cli.proto:63

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • optional string peer_id = 3

  message SnapshotResponse

  cli.proto:89

  (message has no fields)

• rpc get_leader (GetLeaderRequest, GetLeaderResponse)

  cli.proto:109

  message GetLeaderRequest

  cli.proto:92

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • optional string peer_id = 3

  message GetLeaderResponse

  cli.proto:98

  • required string leader_id = 1

• rpc transfer_leader (TransferLeaderRequest, TransferLeaderResponse)

  cli.proto:110

  message TransferLeaderRequest

  cli.proto:77

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • required string leader_id = 3

  • optional string peer_id = 4

  message TransferLeaderResponse

  cli.proto:84

  (message has no fields)

service

• rpc AddPeer (AddPeerRequest2, AddPeerResponse2)

  cli2.proto:110

  message AddPeerRequest2

  cli2.proto:27

  cli.proto 供老的使用保证

  • required uint32 logicPoolId = 1

    逻辑池id

  • required uint32 copysetId = 2

    复制组id

  • required common.Peer leader = 3

    leader

  • required common.Peer addPeer = 4

    新增peer

  message AddPeerResponse2

  cli2.proto:34

  • repeated common.Peer oldPeers = 1

    老配置

  • repeated common.Peer newPeers = 2

    新配置

• rpc RemovePeer (RemovePeerRequest2, RemovePeerResponse2)

  cli2.proto:111

  message RemovePeerRequest2

  cli2.proto:39

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • required common.Peer leader = 3

  • required common.Peer removePeer = 4

  message RemovePeerResponse2

  cli2.proto:46

  • repeated common.Peer oldPeers = 1

  • repeated common.Peer newPeers = 2

• rpc ChangePeers (ChangePeersRequest2, ChangePeersResponse2)

  cli2.proto:112

  message ChangePeersRequest2

  cli2.proto:60

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • required common.Peer leader = 3

  • repeated common.Peer newPeers = 4

  message ChangePeersResponse2

  cli2.proto:67

  • repeated common.Peer oldPeers = 1

  • repeated common.Peer newPeers = 2

• rpc GetLeader (GetLeaderRequest2, GetLeaderResponse2)

  cli2.proto:113

  message GetLeaderRequest2

  cli2.proto:87

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • optional common.Peer peer = 3

    可以不指定peer查leader

  message GetLeaderResponse2

  cli2.proto:93

  • required common.Peer leader = 1

    通过peer判空来判断是否返回leader

• rpc TransferLeader (TransferLeaderRequest2, TransferLeaderResponse2)

  cli2.proto:114

  message TransferLeaderRequest2

  cli2.proto:51

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • required common.Peer leader = 3

  • required common.Peer transferee = 4

  message TransferLeaderResponse2

  cli2.proto:58

  (message has no fields)

• rpc ResetPeer (ResetPeerRequest2, ResetPeerResponse2)

  cli2.proto:115

  message ResetPeerRequest2

  cli2.proto:97

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • required common.Peer requestPeer = 3

  • repeated common.Peer oldPeers = 4

  • repeated common.Peer newPeers = 5

  message ResetPeerResponse2

  cli2.proto:105

  (message has no fields)

• rpc Snapshot (SnapshotRequest2, SnapshotResponse2)

  cli2.proto:116

  message SnapshotRequest2

  cli2.proto:72

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • optional common.Peer peer = 3

  message SnapshotResponse2

  cli2.proto:78

  (message has no fields)

• rpc SnapshotAll (SnapshotAllRequest, SnapshotAllResponse)

  cli2.proto:117

  message SnapshotAllRequest

  cli2.proto:81

  (message has no fields)

  message SnapshotAllResponse

  cli2.proto:84

  (message has no fields)

• rpc Get (ConfigRequest, ConfigResponse)

  configuration.proto:39

• rpc Set (ConfigRequest, ConfigResponse)

  configuration.proto:40

• rpc Dump (ConfigRequest, ConfigResponse)

  configuration.proto:41

• rpc CreateCopysetNode (CopysetRequest, CopysetResponse)

  copyset.proto:96

• rpc CreateCopysetNode2 (CopysetRequest2, CopysetResponse2)

  copyset.proto:98

  message CopysetRequest2

  copyset.proto:60

  • repeated Copyset copysets = 1

  message CopysetResponse2

  copyset.proto:64

  • optional COPYSET_OP_STATUS status = 1

• rpc DeleteBrokenCopyset (CopysetRequest, CopysetResponse)

  copyset.proto:100

• rpc GetCopysetStatus (CopysetStatusRequest, CopysetStatusResponse)

  copyset.proto:102

  message CopysetStatusRequest

  copyset.proto:68

  • required uint32 logicPoolId = 1

  • required uint32 copysetId = 2

  • required common.Peer peer = 3

  • required bool queryHash = 4

    考虑到计算copyset hash值是一个非常耗时的操作，所以设置一个bool变量可以选择不查

  message CopysetStatusResponse

  copyset.proto:76

  大部分字段只能是optional，因为copyset node可能不存在

  • required COPYSET_OP_STATUS status = 1

    op状态

  • optional uint32 state = 2

    copyset状态

  • optional common.Peer peer = 3

    peer

  • optional common.Peer leader = 4

    leader

  • optional bool readOnly = 5

    是否只读

  • optional int64 term = 6

    当前任期

  • optional int64 committedIndex = 7

    当前的committed index

  • optional int64 knownAppliedIndex = 8

    当前copyset已知的applied index，当前peer可能未apply

  • optional int64 pendingIndex = 9

    当前副本未决的op log index起始index

  • optional int64 pendingQueueSize = 10

    当前副本未决的op log queue的长度

  • optional int64 applyingIndex = 11

    当前副本正在apply的op log index

  • optional int64 firstIndex = 12

    当前副本第一条op log index(包括盘和memory)

  • optional int64 lastIndex = 13

    当前副本最后一条op log index(包括盘和memory)

  • optional int64 diskIndex = 14

    当前副本已经持久化的最大op log index(不包含memory)

  • optional uint64 epoch = 15

    当前copyset配置版本

  • optional string hash = 16

    当前copyset的数据hash值

• rpc ScheduleJob (IntegrityRequest, IntegrityResponse)

  integrity.proto:56

• rpc CancelJob (IntegrityRequest, IntegrityResponse)

  integrity.proto:57

• rpc PauseJob (IntegrityRequest, IntegrityResponse)

  integrity.proto:58

• rpc ResumeJob (IntegrityRequest, IntegrityResponse)

  integrity.proto:59

• rpc ListJobs (IntegrityRequest, IntegrityResponse)

  integrity.proto:60

• rpc FollowScanMap (FollowScanMapRequest, FollowScanMapResponse)

  scan.proto:42

  message FollowScanMapRequest

  scan.proto:33

  • required ScanMap scanMap = 1

  message FollowScanMapResponse

  scan.proto:37

  • required sint32 retCode = 1

Used in: ChunkResponse, CreateS3CloneChunkResponse, GetChunkHashResponse, GetChunkInfoResponse, UpdateEpochResponse

• CHUNK_OP_STATUS_SUCCESS = 0

  成功

• CHUNK_OP_STATUS_REDIRECTED = 1

  不是 leader，重定向

• CHUNK_OP_STATUS_DISK_FAIL = 2

  磁盘返回错误

• CHUNK_OP_STATUS_CRC_FAIL = 3

  CRC 校验失败

• CHUNK_OP_STATUS_INVALID_REQUEST = 4

  请求参数不对

• CHUNK_OP_STATUS_NOSPACE = 5

  空间不够

• CHUNK_OP_STATUS_COPYSET_NOTEXIST = 6

  copyset 不存在

• CHUNK_OP_STATUS_CHUNK_NOTEXIST = 7

  chunk或其快照文件不存在

• CHUNK_OP_STATUS_FAILURE_UNKNOWN = 8

  其他错误

• CHUNK_OP_STATUS_OVERLOAD = 9

  过载，表示服务端有过多请求未处理返回

• CHUNK_OP_STATUS_BACKWARD = 10

  请求的版本落后当前chunk的版本

• CHUNK_OP_STATUS_CHUNK_EXIST = 11

  chunk已存在

• CHUNK_OP_STATUS_EPOCH_TOO_OLD = 12

  request epoch too old

For chunk

Used in: ChunkRequest

• CHUNK_OP_DELETE = 0

  删除 chunk

• CHUNK_OP_READ = 1

  读 chunk

• CHUNK_OP_WRITE = 2

  写 chunk

• CHUNK_OP_READ_SNAP = 3

  read chunk snapshot

• CHUNK_OP_DELETE_SNAP = 4

  TODO(wudemiao): 后期替换成CHUNK_OP_DELETE_SNAP_OR_CORRECT_SN， 保证和chunkserver的接口一致

  delete chunk snapshot

• CHUNK_OP_CREATE_CLONE = 5

  创建clone chunk

• CHUNK_OP_RECOVER = 6

  恢复clone chunk

• CHUNK_OP_PASTE = 7

  paste chunk 内部请求

• CHUNK_OP_UNKNOWN = 8

  unknown Op

• CHUNK_OP_SCAN = 9

  scan oprequest

Used in: ConfigResponse

• CONFIG_OP_STATUS_SUCCESS = 0

• CONFIG_OP_STATUS_FAILURE_UNKNOWN = 1

Used in: CopysetResponse, CopysetResponse2, CopysetStatusResponse

• COPYSET_OP_STATUS_SUCCESS = 0

• COPYSET_OP_STATUS_EXIST = 1

  copyset node 已经存在

• COPYSET_OP_STATUS_COPYSET_NOTEXIST = 2

• COPYSET_OP_STATUS_FAILURE_UNKNOWN = 3

• COPYSET_OP_STATUS_COPYSET_IS_HEALTHY = 4

read/write 的实际数据在 rpc 的 attachment 中

Used as request type in: ChunkService.CreateCloneChunk, ChunkService.DeleteChunk, ChunkService.DeleteChunkSnapshotOrCorrectSn, ChunkService.ReadChunk, ChunkService.ReadChunkSnapshot, ChunkService.RecoverChunk, ChunkService.WriteChunk

• required CHUNK_OP_TYPE opType = 1

  for all

• required uint32 logicPoolId = 2

  for all // logicPoolId 实际上 uint16，但是 proto 没有 uint16

• required uint32 copysetId = 3

  for all

• required uint64 chunkId = 4

  for all

• optional uint64 appliedIndex = 5

  for read

• optional uint32 offset = 6

  for read/write

• optional uint32 size = 7

  for read/write/clone 读取数据大小/写入数据大小/创建快照请求中表示请求创建的chunk大小

• optional QosRequestParas deltaRho = 8

  for read/write

• optional uint64 sn = 9

  for write/read snapshot 写请求中表示文件当前版本号，读快照请求中表示请求的chunk的版本号

• optional uint64 correctedSn = 10

  for CreateCloneChunk/DeleteChunkSnapshotOrCorrectedSn 用于修改chunk的correctedSn

• optional string location = 11

  for CreateCloneChunk

• optional string cloneFileSource = 12

  for write/read

• optional uint64 cloneFileOffset = 13

  for write/read

• optional uint64 sendScanMapTimeoutMs = 14

  for scan chunk

• optional uint32 sendScanMapRetryTimes = 15

  for scan chunk

• optional uint64 sendScanMapRetryIntervalUs = 16

  for scan chunk

• optional bool readMetaPage = 17

  for scan chunk

• optional uint64 fileId = 18

  for io fence

• optional uint64 epoch = 19

  for io fence

Used as response type in: ChunkService.CreateCloneChunk, ChunkService.DeleteChunk, ChunkService.DeleteChunkSnapshotOrCorrectSn, ChunkService.ReadChunk, ChunkService.ReadChunkSnapshot, ChunkService.RecoverChunk, ChunkService.WriteChunk

• required CHUNK_OP_STATUS status = 1

• optional string redirect = 2

  自己不是 leader，重定向给 leader

• optional uint64 appliedIndex = 3

  返回当前最新的 committedIndex, 注意 read 和 write 都要返回

• optional QosResponseParas phaseCost = 4

  for read/write

• optional uint64 chunkSn = 5

  for GetChunkInfo 表示chunk文件版本号，0表示不存在

• optional uint64 snapSn = 6

  for GetChunkInfo 表示chunk文件快照的版本号，0表示不存在

• required uint32 version = 1

• required uint32 id = 2

• required string token = 3

• required uint32 checksum = 4

copyset epoch message，用于epoch序列化和反序列化

• required uint32 logicPoolId = 1

• required uint32 copysetId = 2

• required uint64 epoch = 3

• required uint32 checksum = 4

Config service

Used as request type in: ConfigService.Dump, ConfigService.Get, ConfigService.Set

• required string key = 1

• optional string value = 2

Used as response type in: ConfigService.Dump, ConfigService.Get, ConfigService.Set

• required CONFIG_OP_STATUS status = 1

• optional string value = 2

Used in: CopysetRequest2

• required uint32 logicPoolId = 1

• required uint32 copysetId = 2

• repeated common.Peer peers = 3

Used as request type in: CopysetService.CreateCopysetNode, CopysetService.DeleteBrokenCopyset

• required uint32 logicPoolId = 1

  logicPoolId 实际上 uint16，但是 proto 没有 uint16

• required uint32 copysetId = 2

• repeated string peerid = 3

  当前复制组配置，可以为空

Used as response type in: CopysetService.CreateCopysetNode, CopysetService.DeleteBrokenCopyset

• optional COPYSET_OP_STATUS status = 1

• optional string redirect = 2

  自己不是 leader，重定向给 leader

attach pb meta

• repeated CurveSnapshotPbAttachMeta.File files = 2

Used in: CurveSnapshotPbAttachMeta

• required string name = 1

• optional LocalFileMeta meta = 2

Used in: LocalFileMeta

• FILE_SOURCE_LOCAL = 0

• FILE_SOURCE_REFERENCE = 1

Integrity service

Used in: IntegrityJob

• INTEGRITY_OP_STATE_WAITING = 0

• INTEGRITY_OP_STATE_RUNNING = 1

• INTEGRITY_OP_STATE_CANCELED = 2

• INTEGRITY_OP_STATE_FINISHED = 3

• INTEGRITY_OP_STATE_PAUSED = 4

• INTEGRITY_OP_STATE_FAILED = 5

Used in: IntegrityResponse

• INTEGRITY_OP_STATUS_SUCCESS = 0

• INTEGRITY_OP_STATUS_FAILURE_UNKNOWN = 1

Used in: IntegrityRequest, IntegrityResponse

• required int32 id = 1

• required int32 copyset = 2

• required INTEGRITY_JOB_STATE state = 3

• required int32 progress = 4

• required int32 sched_time = 5

• required int32 start_time = 6

Used as request type in: IntegrityService.CancelJob, IntegrityService.ListJobs, IntegrityService.PauseJob, IntegrityService.ResumeJob, IntegrityService.ScheduleJob

• required IntegrityJob job = 1

Used as response type in: IntegrityService.CancelJob, IntegrityService.ListJobs, IntegrityService.PauseJob, IntegrityService.ResumeJob, IntegrityService.ScheduleJob

• required INTEGRITY_OP_STATUS status = 1

• repeated IntegrityJob job = 2

Used in: CurveSnapshotPbAttachMeta.File

• optional bytes user_meta = 1

• optional FileSource source = 2

• optional string checksum = 3

Qos 参数

Used in: ChunkRequest

• optional uint32 clientId = 1

• optional int32 dmclockDelta = 2

• optional int32 dmclockRho = 3

Used in: ChunkResponse

• optional int32 phase = 1

  0: 代表 reservation 阶段; 1: 代表 priority 阶段

• optional int32 cost = 2

Used in: FollowScanMapRequest, mds.heartbeat.CopySetInfo

• required uint32 logicalPoolId = 1

• required uint32 copysetId = 2

• required uint64 chunkId = 3

• required uint64 index = 4

• required uint32 crc = 5

• required uint64 offset = 6

• required uint64 len = 7