// Copyright (c) 2015-2021 MinIO, Inc. // // This file is part of MinIO Object Storage stack // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . package cache import ( "encoding/json" "errors" "os" "path/filepath" "strings" "github.com/minio/minio/internal/config" "github.com/minio/minio/internal/disk" "github.com/minio/pkg/ellipses" ) const ( // WriteBack allows staging and write back of cached content for single object uploads WriteBack = "writeback" // WriteThrough allows caching multipart uploads to disk synchronously WriteThrough = "writethrough" ) // Config represents cache config settings type Config struct { Enabled bool `json:"-"` Drives []string `json:"drives"` Expiry int `json:"expiry"` MaxUse int `json:"maxuse"` Quota int `json:"quota"` Exclude []string `json:"exclude"` After int `json:"after"` WatermarkLow int `json:"watermark_low"` WatermarkHigh int `json:"watermark_high"` Range bool `json:"range"` CacheCommitMode string `json:"commit"` } // UnmarshalJSON - implements JSON unmarshal interface for unmarshalling // json entries for CacheConfig. func (cfg *Config) UnmarshalJSON(data []byte) (err error) { type Alias Config _cfg := &struct { *Alias }{ Alias: (*Alias)(cfg), } if err = json.Unmarshal(data, _cfg); err != nil { return err } if _cfg.Expiry < 0 { return errors.New("config expiry value should not be negative") } if _cfg.MaxUse < 0 { return errors.New("config max use value should not be null or negative") } if _cfg.Quota < 0 { return errors.New("config quota value should not be null or negative") } if _cfg.After < 0 { return errors.New("cache after value should not be less than 0") } if _cfg.WatermarkLow < 0 || _cfg.WatermarkLow > 100 { return errors.New("config low watermark value should be between 0 and 100") } if _cfg.WatermarkHigh < 0 || _cfg.WatermarkHigh > 100 { return errors.New("config high watermark value should be between 0 and 100") } if _cfg.WatermarkLow > 0 && (_cfg.WatermarkLow >= _cfg.WatermarkHigh) { return errors.New("config low watermark value should be less than high watermark") } return nil } // Parses given cacheDrivesEnv and returns a list of cache drives. func parseCacheDrives(drives string) ([]string, error) { var drivesSlice []string if len(drives) == 0 { return drivesSlice, nil } drivesSlice = strings.Split(drives, cacheDelimiterLegacy) if len(drivesSlice) == 1 && drivesSlice[0] == drives { drivesSlice = strings.Split(drives, cacheDelimiter) } var endpoints []string for _, d := range drivesSlice { if len(d) == 0 { return nil, config.ErrInvalidCacheDrivesValue(nil).Msg("cache dir cannot be an empty path") } if ellipses.HasEllipses(d) { s, err := parseCacheDrivePaths(d) if err != nil { return nil, err } endpoints = append(endpoints, s...) } else { endpoints = append(endpoints, d) } } isCICD := os.Getenv("MINIO_CI_CD") != "" || os.Getenv("CI") != "" for _, d := range endpoints { if !filepath.IsAbs(d) { return nil, config.ErrInvalidCacheDrivesValue(nil).Msg("cache dir should be absolute path: %s", d) } if !isCICD { rootDsk, err := disk.IsRootDisk(d, "/") if err != nil { return nil, config.ErrInvalidCacheDrivesValue(nil).Msg("Invalid cache dir %s err : %s", d, err.Error()) } if rootDsk { return nil, config.ErrInvalidCacheDrivesValue(nil).Msg("cache dir cannot be part of root disk: %s", d) } } } return endpoints, nil } // Parses all arguments and returns a slice of drive paths following the ellipses pattern. func parseCacheDrivePaths(arg string) (ep []string, err error) { patterns, perr := ellipses.FindEllipsesPatterns(arg) if perr != nil { return []string{}, config.ErrInvalidCacheDrivesValue(nil).Msg(perr.Error()) } for _, lbls := range patterns.Expand() { ep = append(ep, strings.Join(lbls, "")) } return ep, nil } // Parses given cacheExcludesEnv and returns a list of cache exclude patterns. func parseCacheExcludes(excludes string) ([]string, error) { var excludesSlice []string if len(excludes) == 0 { return excludesSlice, nil } excludesSlice = strings.Split(excludes, cacheDelimiterLegacy) if len(excludesSlice) == 1 && excludesSlice[0] == excludes { excludesSlice = strings.Split(excludes, cacheDelimiter) } for _, e := range excludesSlice { if len(e) == 0 { return nil, config.ErrInvalidCacheExcludesValue(nil).Msg("cache exclude path (%s) cannot be empty", e) } if strings.HasPrefix(e, "/") { return nil, config.ErrInvalidCacheExcludesValue(nil).Msg("cache exclude pattern (%s) cannot start with / as prefix", e) } } return excludesSlice, nil } func parseCacheCommitMode(commitStr string) (string, error) { switch strings.ToLower(commitStr) { case WriteBack, WriteThrough: return strings.ToLower(commitStr), nil default: return "", config.ErrInvalidCacheCommitValue(nil).Msg("cache commit value must be `writeback` or `writethrough`") } }