1 /* Deals with getting Keep Server blocks from API Server and Keep Servers. */
10 "git.curoverse.com/arvados.git/sdk/go/arvadosclient"
11 "git.curoverse.com/arvados.git/sdk/go/blockdigest"
12 "git.curoverse.com/arvados.git/sdk/go/keepclient"
13 "git.curoverse.com/arvados.git/sdk/go/logger"
14 "git.curoverse.com/arvados.git/services/datamanager/loggerutil"
24 // ServerAddress struct
25 type ServerAddress struct {
26 SSL bool `json:"service_ssl_flag"`
27 Host string `json:"service_host"`
28 Port int `json:"service_port"`
29 UUID string `json:"uuid"`
30 ServiceType string `json:"service_type"`
33 // BlockInfo is info about a particular block returned by the server
34 type BlockInfo struct {
35 Digest blockdigest.DigestWithSize
36 Mtime int64 // TODO(misha): Replace this with a timestamp.
39 // BlockServerInfo is info about a specified block given by a server
40 type BlockServerInfo struct {
42 Mtime int64 // TODO(misha): Replace this with a timestamp.
45 // ServerContents struct
46 type ServerContents struct {
47 BlockDigestToInfo map[blockdigest.DigestWithSize]BlockInfo
50 // ServerResponse struct
51 type ServerResponse struct {
53 Contents ServerContents
57 type ReadServers struct {
59 KeepServerIndexToAddress []ServerAddress
60 KeepServerAddressToIndex map[ServerAddress]int
61 ServerToContents map[ServerAddress]ServerContents
62 BlockToServers map[blockdigest.DigestWithSize][]BlockServerInfo
63 BlockReplicationCounts map[int]int
66 // GetKeepServersParams struct
67 type GetKeepServersParams struct {
68 Client arvadosclient.ArvadosClient
73 // ServiceList consists of the addresses of all the available kee servers
74 type ServiceList struct {
75 ItemsAvailable int `json:"items_available"`
76 KeepServers []ServerAddress `json:"items"`
80 // TODO(misha): Change this to include the UUID as well.
81 func (s ServerAddress) String() string {
85 // URL of the keep server
86 func (s ServerAddress) URL() string {
88 return fmt.Sprintf("https://%s:%d", s.Host, s.Port)
90 return fmt.Sprintf("http://%s:%d", s.Host, s.Port)
93 // GetKeepServersAndSummarize gets keep servers from api
94 func GetKeepServersAndSummarize(params GetKeepServersParams) (results ReadServers, err error) {
95 results, err = GetKeepServers(params)
96 log.Printf("Returned %d keep disks", len(results.ServerToContents))
98 results.Summarize(params.Logger)
99 log.Printf("Replication level distribution: %v",
100 results.BlockReplicationCounts)
105 // GetKeepServers from api server
106 func GetKeepServers(params GetKeepServersParams) (results ReadServers, err error) {
107 sdkParams := arvadosclient.Dict{
108 "filters": [][]string{[]string{"service_type", "!=", "proxy"}},
110 if params.Limit > 0 {
111 sdkParams["limit"] = params.Limit
114 var sdkResponse ServiceList
115 err = params.Client.List("keep_services", sdkParams, &sdkResponse)
121 // Currently, only "disk" types are supported. Stop if any other service types are found.
122 for _, server := range sdkResponse.KeepServers {
123 if server.ServiceType != "disk" {
124 return results, fmt.Errorf("Unsupported service type %q found for: %v", server.ServiceType, server)
128 if params.Logger != nil {
129 params.Logger.Update(func(p map[string]interface{}, e map[string]interface{}) {
130 keepInfo := logger.GetOrCreateMap(p, "keep_info")
131 keepInfo["num_keep_servers_available"] = sdkResponse.ItemsAvailable
132 keepInfo["num_keep_servers_received"] = len(sdkResponse.KeepServers)
133 keepInfo["keep_servers"] = sdkResponse.KeepServers
137 log.Printf("Received keep services list: %+v", sdkResponse)
139 if len(sdkResponse.KeepServers) < sdkResponse.ItemsAvailable {
140 return results, fmt.Errorf("Did not receive all available keep servers: %+v", sdkResponse)
143 results.KeepServerIndexToAddress = sdkResponse.KeepServers
144 results.KeepServerAddressToIndex = make(map[ServerAddress]int)
145 for i, address := range results.KeepServerIndexToAddress {
146 results.KeepServerAddressToIndex[address] = i
149 log.Printf("Got Server Addresses: %v", results)
151 // Send off all the index requests concurrently
152 responseChan := make(chan ServerResponse)
153 for _, keepServer := range sdkResponse.KeepServers {
154 // The above keepsServer variable is reused for each iteration, so
155 // it would be shared across all goroutines. This would result in
156 // us querying one server n times instead of n different servers
157 // as we intended. To avoid this we add it as an explicit
158 // parameter which gets copied. This bug and solution is described
159 // in https://golang.org/doc/effective_go.html#channels
160 go func(keepServer ServerAddress) {
161 responseChan <- GetServerContents(params.Logger,
167 results.ServerToContents = make(map[ServerAddress]ServerContents)
168 results.BlockToServers = make(map[blockdigest.DigestWithSize][]BlockServerInfo)
170 // Read all the responses
171 for i := range sdkResponse.KeepServers {
172 _ = i // Here to prevent go from complaining.
173 response := <-responseChan
175 // There might have been an error during GetServerContents; so check if the response is empty
176 if response.Address.Host == "" {
177 return results, fmt.Errorf("Error during GetServerContents; no host info found")
180 log.Printf("Received channel response from %v containing %d files",
182 len(response.Contents.BlockDigestToInfo))
183 results.ServerToContents[response.Address] = response.Contents
184 serverIndex := results.KeepServerAddressToIndex[response.Address]
185 for _, blockInfo := range response.Contents.BlockDigestToInfo {
186 results.BlockToServers[blockInfo.Digest] = append(
187 results.BlockToServers[blockInfo.Digest],
188 BlockServerInfo{ServerIndex: serverIndex,
189 Mtime: blockInfo.Mtime})
195 // GetServerContents of the keep server
196 func GetServerContents(arvLogger *logger.Logger,
197 keepServer ServerAddress,
198 arv arvadosclient.ArvadosClient) (response ServerResponse) {
200 err := GetServerStatus(arvLogger, keepServer, arv)
202 loggerutil.LogErrorMessage(arvLogger, fmt.Sprintf("Error during GetServerStatus: %v", err))
203 return ServerResponse{}
206 req, err := CreateIndexRequest(arvLogger, keepServer, arv)
208 loggerutil.LogErrorMessage(arvLogger, fmt.Sprintf("Error building CreateIndexRequest: %v", err))
209 return ServerResponse{}
212 resp, err := arv.Client.Do(req)
214 loggerutil.LogErrorMessage(arvLogger,
215 fmt.Sprintf("Error fetching %s: %v. Response was %+v",
219 return ServerResponse{}
222 response, err = ReadServerResponse(arvLogger, keepServer, resp)
224 loggerutil.LogErrorMessage(arvLogger,
225 fmt.Sprintf("Error during ReadServerResponse %v", err))
226 return ServerResponse{}
232 // GetServerStatus get keep server status by invoking /status.json
233 func GetServerStatus(arvLogger *logger.Logger,
234 keepServer ServerAddress,
235 arv arvadosclient.ArvadosClient) error {
236 url := fmt.Sprintf("http://%s:%d/status.json",
240 if arvLogger != nil {
242 arvLogger.Update(func(p map[string]interface{}, e map[string]interface{}) {
243 keepInfo := logger.GetOrCreateMap(p, "keep_info")
244 serverInfo := make(map[string]interface{})
245 serverInfo["status_request_sent_at"] = now
246 serverInfo["host"] = keepServer.Host
247 serverInfo["port"] = keepServer.Port
249 keepInfo[keepServer.UUID] = serverInfo
253 resp, err := arv.Client.Get(url)
255 return fmt.Errorf("Error getting keep status from %s: %v", url, err)
256 } else if resp.StatusCode != 200 {
257 return fmt.Errorf("Received error code %d in response to request "+
259 resp.StatusCode, url, resp.Status)
262 var keepStatus map[string]interface{}
263 decoder := json.NewDecoder(resp.Body)
265 err = decoder.Decode(&keepStatus)
267 return fmt.Errorf("Error decoding keep status from %s: %v", url, err)
270 if arvLogger != nil {
272 arvLogger.Update(func(p map[string]interface{}, e map[string]interface{}) {
273 keepInfo := logger.GetOrCreateMap(p, "keep_info")
274 serverInfo := keepInfo[keepServer.UUID].(map[string]interface{})
275 serverInfo["status_response_processed_at"] = now
276 serverInfo["status"] = keepStatus
283 // CreateIndexRequest to the keep server
284 func CreateIndexRequest(arvLogger *logger.Logger,
285 keepServer ServerAddress,
286 arv arvadosclient.ArvadosClient) (req *http.Request, err error) {
287 url := fmt.Sprintf("http://%s:%d/index", keepServer.Host, keepServer.Port)
288 log.Println("About to fetch keep server contents from " + url)
290 if arvLogger != nil {
292 arvLogger.Update(func(p map[string]interface{}, e map[string]interface{}) {
293 keepInfo := logger.GetOrCreateMap(p, "keep_info")
294 serverInfo := keepInfo[keepServer.UUID].(map[string]interface{})
295 serverInfo["index_request_sent_at"] = now
299 req, err = http.NewRequest("GET", url, nil)
301 return req, fmt.Errorf("Error building http request for %s: %v", url, err)
304 req.Header.Add("Authorization", "OAuth2 "+arv.ApiToken)
308 // ReadServerResponse reads reasponse from keep server
309 func ReadServerResponse(arvLogger *logger.Logger,
310 keepServer ServerAddress,
311 resp *http.Response) (response ServerResponse, err error) {
313 if resp.StatusCode != 200 {
314 return response, fmt.Errorf("Received error code %d in response to request "+
316 resp.StatusCode, keepServer.String(), resp.Status)
319 if arvLogger != nil {
321 arvLogger.Update(func(p map[string]interface{}, e map[string]interface{}) {
322 keepInfo := logger.GetOrCreateMap(p, "keep_info")
323 serverInfo := keepInfo[keepServer.UUID].(map[string]interface{})
324 serverInfo["index_response_received_at"] = now
328 response.Address = keepServer
329 response.Contents.BlockDigestToInfo =
330 make(map[blockdigest.DigestWithSize]BlockInfo)
331 reader := bufio.NewReader(resp.Body)
332 numLines, numDuplicates, numSizeDisagreements := 0, 0, 0
335 line, err := reader.ReadString('\n')
337 return response, fmt.Errorf("Index from %s truncated at line %d",
338 keepServer.String(), numLines)
339 } else if err != nil {
340 return response, fmt.Errorf("Error reading index response from %s at line %d: %v",
341 keepServer.String(), numLines, err)
344 if _, err := reader.Peek(1); err == nil {
345 extra, _ := reader.ReadString('\n')
346 return response, fmt.Errorf("Index from %s had trailing data at line %d after EOF marker: %s",
347 keepServer.String(), numLines+1, extra)
348 } else if err != io.EOF {
349 return response, fmt.Errorf("Index from %s had read error after EOF marker at line %d: %v",
350 keepServer.String(), numLines, err)
355 blockInfo, err := parseBlockInfoFromIndexLine(line)
357 return response, fmt.Errorf("Error parsing BlockInfo from index line "+
358 "received from %s: %v",
363 if storedBlock, ok := response.Contents.BlockDigestToInfo[blockInfo.Digest]; ok {
364 // This server returned multiple lines containing the same block digest.
366 // Keep the block that's newer.
367 if storedBlock.Mtime < blockInfo.Mtime {
368 response.Contents.BlockDigestToInfo[blockInfo.Digest] = blockInfo
371 response.Contents.BlockDigestToInfo[blockInfo.Digest] = blockInfo
375 log.Printf("%s index contained %d lines with %d duplicates with "+
376 "%d size disagreements",
380 numSizeDisagreements)
382 if arvLogger != nil {
384 arvLogger.Update(func(p map[string]interface{}, e map[string]interface{}) {
385 keepInfo := logger.GetOrCreateMap(p, "keep_info")
386 serverInfo := keepInfo[keepServer.UUID].(map[string]interface{})
388 serverInfo["processing_finished_at"] = now
389 serverInfo["lines_received"] = numLines
390 serverInfo["duplicates_seen"] = numDuplicates
391 serverInfo["size_disagreements_seen"] = numSizeDisagreements
398 func parseBlockInfoFromIndexLine(indexLine string) (blockInfo BlockInfo, err error) {
399 tokens := strings.Fields(indexLine)
400 if len(tokens) != 2 {
401 err = fmt.Errorf("Expected 2 tokens per line but received a "+
402 "line containing %v instead.",
406 var locator blockdigest.BlockLocator
407 if locator, err = blockdigest.ParseBlockLocator(tokens[0]); err != nil {
408 err = fmt.Errorf("%v Received error while parsing line \"%s\"",
412 if len(locator.Hints) > 0 {
413 err = fmt.Errorf("Block locator in index line should not contain hints "+
419 blockInfo.Mtime, err = strconv.ParseInt(tokens[1], 10, 64)
424 blockdigest.DigestWithSize{Digest: locator.Digest,
425 Size: uint32(locator.Size)}
429 // Summarize results from keep server
430 func (readServers *ReadServers) Summarize(arvLogger *logger.Logger) {
431 readServers.BlockReplicationCounts = make(map[int]int)
432 for _, infos := range readServers.BlockToServers {
433 replication := len(infos)
434 readServers.BlockReplicationCounts[replication]++
437 if arvLogger != nil {
438 arvLogger.Update(func(p map[string]interface{}, e map[string]interface{}) {
439 keepInfo := logger.GetOrCreateMap(p, "keep_info")
440 keepInfo["distinct_blocks_stored"] = len(readServers.BlockToServers)
445 // TrashRequest struct
446 type TrashRequest struct {
447 Locator string `json:"locator"`
448 BlockMtime int64 `json:"block_mtime"`
451 // TrashList is an array of TrashRequest objects
452 type TrashList []TrashRequest
454 // SendTrashLists to trash queue
455 func SendTrashLists(kc *keepclient.KeepClient, spl map[string]TrashList) (errs []error) {
457 barrier := make(chan error)
461 for url, v := range spl {
463 log.Printf("Sending trash list to %v", url)
465 go (func(url string, v TrashList) {
466 pipeReader, pipeWriter := io.Pipe()
468 enc := json.NewEncoder(pipeWriter)
473 req, err := http.NewRequest("PUT", fmt.Sprintf("%s/trash", url), pipeReader)
475 log.Printf("Error creating trash list request for %v error: %v", url, err.Error())
480 req.Header.Add("Authorization", "OAuth2 "+kc.Arvados.ApiToken)
483 var resp *http.Response
484 if resp, err = client.Do(req); err != nil {
485 log.Printf("Error sending trash list to %v error: %v", url, err.Error())
490 log.Printf("Sent trash list to %v: response was HTTP %v", url, resp.Status)
492 io.Copy(ioutil.Discard, resp.Body)
495 if resp.StatusCode != 200 {
496 barrier <- errors.New(fmt.Sprintf("Got HTTP code %v", resp.StatusCode))
504 for i := 0; i < count; i++ {
507 errs = append(errs, b)