Documentation
¶
Overview ¶
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2024, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2024, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2024, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2024, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2024, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2024, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2024, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2024, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2024, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2024, NVIDIA CORPORATION. All rights reserved.
Package core provides core metadata and in-cluster API
- Copyright (c) 2018-2024, NVIDIA CORPORATION. All rights reserved.
Index ¶
- Constants
- func FreeCOI(a *CopyParams)
- func FreeLOM(lom *LOM)
- func FreePutParams(a *PutParams)
- func HrwFQN(bck *cmn.Bck, contentType, objName string) (fqn string, digest uint64, err error)
- func InMaintOrDecomm(smap *meta.Smap, tsi *meta.Snode, xact Xact) (err error)
- func ParseObjLoc(loc string) (tname, mpname string)
- func Pinit()
- func ResolveFQN(fqn string) (parsedFQN fs.ParsedFQN, hrwFQN string, err error)
- func Term()
- func Tinit(t Target, tstats cos.StatsUpdater, runHK bool)
- func UncacheBck(b *meta.Bck)
- func UncacheMountpath(mi *fs.Mountpath)
- type AllRunningInOut
- type BackendProvider
- type CRMD
- type CT
- func (ct *CT) Bck() *meta.Bck
- func (ct *CT) Bucket() *cmn.Bck
- func (ct *CT) CacheIdx() int
- func (ct *CT) Clone(ctType string) *CT
- func (ct *CT) ContentType() string
- func (ct *CT) Digest() uint64
- func (ct *CT) FQN() string
- func (ct *CT) LoadFromFS() error
- func (ct *CT) Lock(exclusive bool)
- func (ct *CT) Make(toType string, pref ...string) string
- func (ct *CT) Mountpath() *fs.Mountpath
- func (ct *CT) MtimeUnix() int64
- func (ct *CT) ObjectName() string
- func (ct *CT) SizeBytes() int64
- func (ct *CT) Uname() string
- func (ct *CT) Unlock(exclusive bool)
- func (ct *CT) Write(reader io.Reader, size int64, workFQN ...string) (err error)
- type CopyParams
- type DM
- type DP
- type ExtraArgsPut
- type GetReaderResult
- type LDP
- type LIF
- type LOM
- func (lom *LOM) AcquireAtimefs() error
- func (lom *LOM) AddCopy(copyFQN string, mpi *fs.Mountpath) error
- func (lom *LOM) Atime() time.Time
- func (lom *LOM) AtimeUnix() int64
- func (lom *LOM) Bck() *meta.Bck
- func (lom *LOM) Bprops() *cmn.Bprops
- func (lom *LOM) Bucket() *cmn.Bck
- func (lom *LOM) CacheIdx() int
- func (lom *LOM) CheckRemoteMD(locked, sync bool) (res CRMD)
- func (lom *LOM) Checksum() *cos.Cksum
- func (lom *LOM) CksumConf() *cmn.CksumConf
- func (lom *LOM) CksumType() string
- func (lom *LOM) CloneMD(fqn string) *LOM
- func (lom *LOM) Cname() string
- func (lom *LOM) ComputeCksum(cksumType string) (cksum *cos.CksumHash, err error)
- func (lom *LOM) ComputeSetCksum() (*cos.Cksum, error)
- func (lom *LOM) Copy(mi *fs.Mountpath, buf []byte) (err error)
- func (lom *LOM) Copy2FQN(dstFQN string, buf []byte) (dst *LOM, err error)
- func (lom *LOM) CopyAttrs(oah cos.OAH, skipCksum bool)
- func (lom *LOM) CreateFile(fqn string) (fh *os.File, err error)
- func (lom *LOM) CreateFileRW(fqn string) (fh *os.File, err error)
- func (lom *LOM) DelAllCopies() (err error)
- func (lom *LOM) DelCopies(copiesFQN ...string) (err error)
- func (lom *LOM) DelExtraCopies(fqn ...string) (removed bool, err error)
- func (lom *LOM) Digest() uint64
- func (lom *LOM) DowngradeLock()
- func (lom *LOM) ECEnabled() bool
- func (lom *LOM) EqCksum(cksum *cos.Cksum) bool
- func (lom *LOM) Equal(rem cos.OAH) bool
- func (lom *LOM) FromFS() error
- func (lom *LOM) GetCopies() fs.MPI
- func (lom *LOM) GetCustomKey(key string) (string, bool)
- func (lom *LOM) GetCustomMD() cos.StrKVs
- func (lom *LOM) HasCopies() bool
- func (lom *LOM) HrwTarget(smap *meta.Smap) (tsi *meta.Snode, local bool, err error)
- func (lom *LOM) IncVersion() error
- func (lom *LOM) InitBck(bck *cmn.Bck) (err error)
- func (lom *LOM) InitCT(ct *CT)
- func (lom *LOM) InitFQN(fqn string, expbck *cmn.Bck) (err error)
- func (lom *LOM) IsCopy() bool
- func (lom *LOM) IsHRW() bool
- func (lom *LOM) IsLocked() (int, bool)
- func (lom *LOM) LBGet() (fqn string)
- func (lom *LOM) LIF() (lif LIF)
- func (lom *LOM) LeastUtilNoCopy() (mi *fs.Mountpath)
- func (lom *LOM) Load(cacheit, locked bool) error
- func (lom *LOM) LoadLatest(latest bool) (oa *cmn.ObjAttrs, deleted bool, err error)
- func (lom *LOM) LoadMetaFromFS() error
- func (lom *LOM) LoadUnsafe() (err error)
- func (lom *LOM) Location() string
- func (lom *LOM) Lock(exclusive bool)
- func (lom *LOM) MirrorConf() *cmn.MirrorConf
- func (lom *LOM) Mountpath() *fs.Mountpath
- func (lom *LOM) NewDeferROC() (cos.ReadOpenCloser, error)
- func (lom *LOM) NumCopies() int
- func (lom *LOM) ObjAttrs() *cmn.ObjAttrs
- func (lom *LOM) ObjectName() string
- func (lom *LOM) Persist() (err error)
- func (lom *LOM) PersistMain() (err error)
- func (lom *LOM) Recache()
- func (lom *LOM) Remove(force ...bool) (err error)
- func (lom *LOM) RenameFrom(workfqn string) error
- func (lom *LOM) RestoreToLocation() (exists bool)
- func (lom *LOM) SetAtimeUnix(tu int64)
- func (lom *LOM) SetCksum(cksum *cos.Cksum)
- func (lom *LOM) SetCustomKey(key, value string)
- func (lom *LOM) SetCustomMD(md cos.StrKVs)
- func (lom *LOM) SetSize(size int64)
- func (lom *LOM) SetVersion(ver string)
- func (lom *LOM) SizeBytes(special ...bool) int64
- func (lom *LOM) String() string
- func (lom *LOM) ToMpath() (mi *fs.Mountpath, isHrw bool)
- func (lom *LOM) TryLock(exclusive bool) bool
- func (lom *LOM) Uname() string
- func (lom *LOM) Uncache()
- func (lom *LOM) UncacheUnless()
- func (lom *LOM) Unlock(exclusive bool)
- func (lom *LOM) UpgradeLock() (finished bool)
- func (lom *LOM) ValidateContentChecksum() (err error)
- func (lom *LOM) ValidateMetaChecksum() error
- func (lom *LOM) ValidateWarmGet(qparam string) bool
- func (lom *LOM) Version(special ...bool) string
- func (lom *LOM) VersionConf() cmn.VersionConf
- func (lom *LOM) WritePolicy() (p apc.WritePolicy)
- type NLP
- type Node
- type NodeMemCap
- type Notif
- type NotifMsg
- type OnFinishObj
- type PromoteParams
- type PutParams
- type QuiCB
- type QuiRes
- type Snap
- type Stats
- type Target
- type TargetLoc
- type TargetPut
- type Upon
- type Xact
Constants ¶
const ( RemoteDeletedDelCount = "remote.deleted.del.n" // lcache stats LcacheCollisionCount = "lcache.collision.n" LcacheEvictedCount = "lcache.evicted.n" LcacheFlushColdCount = "lcache.flush.cold.n" )
core stats
const ( XattrLOM = "user.ais.lom" // on-disk xattr name DumpLomEnvVar = "AIS_DUMP_LOM" )
const ( Targets = iota // 0 (core.Targets) used as default value for NewStreamBundle Proxies AllNodes SelectedNodes )
const ( UponTerm = Upon(1 << iota) // success or fail is separately provided via error UponProgress // periodic (BytesCount, ObjCount) )
enum: when to notify
const ( QuiInactiveCB = QuiRes(iota) // e.g., no pending requests (NOTE: used exclusively by `quicb` callbacks) QuiActive // active (e.g., receiving data) QuiActiveRet // active that immediately breaks waiting for quiecscence QuiDone // all done QuiAborted // aborted QuiTimeout // timeout Quiescent // idle => quiescent )
Variables ¶
This section is empty.
Functions ¶
func FreeCOI ¶
func FreeCOI(a *CopyParams)
func FreePutParams ¶
func FreePutParams(a *PutParams)
func InMaintOrDecomm ¶
func ParseObjLoc ¶
func UncacheBck ¶
func UncacheMountpath ¶
NOTE: watch https://github.com/golang/go/pull/61702 for `sync.Map.Clear`, likely Go 22
Types ¶
type AllRunningInOut ¶
type BackendProvider ¶
type BackendProvider interface {
Provider() string
CreateBucket(bck *meta.Bck) (errCode int, err error)
ListObjects(bck *meta.Bck, msg *apc.LsoMsg, lst *cmn.LsoResult) (errCode int, err error)
ListBuckets(qbck cmn.QueryBcks) (bcks cmn.Bcks, errCode int, err error)
PutObj(r io.ReadCloser, lom *LOM, extraArgs *ExtraArgsPut) (errCode int, err error)
DeleteObj(lom *LOM) (errCode int, err error)
// head
HeadBucket(ctx context.Context, bck *meta.Bck) (bckProps cos.StrKVs, errCode int, err error)
HeadObj(ctx context.Context, lom *LOM) (objAttrs *cmn.ObjAttrs, errCode int, err error)
// get
GetObj(ctx context.Context, lom *LOM, owt cmn.OWT) (errCode int, err error) // calls GetObjReader
GetObjReader(ctx context.Context, lom *LOM, offset, length int64) GetReaderResult
}
type CT ¶
type CT struct {
// contains filtered or unexported fields
}
func NewCTFromBO ¶
func NewCTFromLOM ¶
Construct CT from LOM and change ContentType and FQN
func (*CT) ContentType ¶
func (*CT) LoadFromFS ¶
func (*CT) ObjectName ¶
type CopyParams ¶
type CopyParams struct {
DP DP // transform via: ext/etl/dp.go or core/ldp.go
Xact Xact
Config *cmn.Config
BckTo *meta.Bck
ObjnameTo string
Buf []byte
OWT cmn.OWT
Finalize bool // copies and EC (as in poi.finalize())
DryRun bool
LatestVer bool // can be used without changing bucket's 'versioning.validate_warm_get'; see also: QparamLatestVer
Sync bool // ditto - bucket's 'versioning.synchronize'
}
intra-cluster data path: control structures and types
func AllocCOI ¶
func AllocCOI() (a *CopyParams)
type DP ¶
type DP interface {
Reader(lom *LOM, latestVer, sync bool) (reader cos.ReadOpenCloser, oah cos.OAH, err error)
}
data provider
type GetReaderResult ¶
type LOM ¶
type LOM struct {
ObjName string
FQN string
HrwFQN string // (=> main replica)
// contains filtered or unexported fields
}
func AllocLomFromHdr ¶
lom <= transport.ObjHdr (NOTE: caller must call freeLOM)
func (*LOM) CheckRemoteMD ¶
NOTE: - [PRECONDITION]: `versioning.validate_warm_get` || QparamLatestVer - [Sync] when Sync option is used (via bucket config and/or `sync` argument) caller MUST take wlock or rlock - [MAY] delete remotely-deleted (non-existing) object and increment associated stats counter
Returns NotFound also after having removed local replica (the Sync option)
func (*LOM) ComputeCksum ¶
func (*LOM) Copy ¶
increment the object's num copies by (well) copying the former (compare with lom.Copy2FQN below)
func (*LOM) Copy2FQN ¶
copy object => any local destination recommended for copying between different buckets (compare with lom.Copy() above) NOTE: `lom` source must be w-locked
func (*LOM) CreateFile ¶
(compare with cos.CreateFile)
func (*LOM) DelAllCopies ¶
func (*LOM) DelExtraCopies ¶
DelExtraCopies deletes obj replicas that are not part of the lom.md.copies metadata (cleanup)
func (*LOM) DowngradeLock ¶
func (lom *LOM) DowngradeLock()
func (*LOM) GetCopies ¶
GetCopies returns all copies NOTE: a) copies include lom.FQN aka "main repl.", and b) caller must take a lock
func (*LOM) IncVersion ¶
func (*LOM) IsCopy ¶
given an existing (on-disk) object, determines whether it is a _copy_ (compare with isMirror below)
func (*LOM) LeastUtilNoCopy ¶
returns the least utilized mountpath that does _not_ have a copy of this `lom` yet (compare with leastUtilCopy())
func (*LOM) Load ¶
no lock is taken when locked by an immediate caller, or otherwise is known to be locked otherwise, try Rlock temporarily _if and only when_ reading from fs
(compare w/ LoadUnsafe() below)
func (*LOM) LoadLatest ¶
NOTE: must be locked; NOTE: Sync == false (ie., not deleting)
func (*LOM) LoadMetaFromFS ¶
NOTE: used in tests, ignores `dirty`
func (*LOM) LoadUnsafe ¶
usage: fast (and unsafe) loading object metadata except atime - no locks compare with conventional Load() above
func (*LOM) MirrorConf ¶
func (lom *LOM) MirrorConf() *cmn.MirrorConf
func (*LOM) NewDeferROC ¶
func (lom *LOM) NewDeferROC() (cos.ReadOpenCloser, error)
is called under rlock; unlocks on fail
func (*LOM) PersistMain ¶
func (*LOM) RestoreToLocation ¶
RestoreObjectFromAny tries to restore the object at its default location. Returns true if object exists, false otherwise TODO: locking vs concurrent restore: consider (read-lock object + write-lock meta) split
func (*LOM) SetAtimeUnix ¶
func (*LOM) SetCustomKey ¶
func (*LOM) SetCustomMD ¶
func (*LOM) SetVersion ¶
func (*LOM) ToMpath ¶
must be called under w-lock returns mountpath destination to copy this object, or nil if no copying is required - checks hrw location first, and - checks copies (if any) against the current configuation and available mountpaths; - does not check `fstat` in either case (TODO: configurable or scrub);
func (*LOM) UpgradeLock ¶
func (*LOM) ValidateContentChecksum ¶
ValidateDiskChecksum validates if checksum stored in lom's in-memory metadata matches object's content checksum. Use lom.ValidateMetaChecksum() to check lom's checksum vs on-disk metadata.
func (*LOM) ValidateMetaChecksum ¶
ValidateMetaChecksum validates whether checksum stored in lom's in-memory metadata matches checksum stored on disk. Use lom.ValidateContentChecksum() to recompute and check object's content checksum.
func (*LOM) ValidateWarmGet ¶
func (*LOM) VersionConf ¶
func (lom *LOM) VersionConf() cmn.VersionConf
func (*LOM) WritePolicy ¶
func (lom *LOM) WritePolicy() (p apc.WritePolicy)
type NLP ¶
type NLP interface {
Lock()
TryLock(timeout time.Duration) bool
TryRLock(timeout time.Duration) bool
Unlock()
}
pair
type Node ¶
type Node interface {
SID() string
String() string
Snode() *meta.Snode
Bowner() meta.Bowner
Sowner() meta.Sowner
ClusterStarted() bool
NodeStarted() bool
}
cluster node
type NodeMemCap ¶
type Notif ¶
type Notif interface {
OnFinishedCB() func(Notif, error, bool)
OnProgressCB() func(Notif)
NotifyInterval() time.Duration // notify interval in secs
LastNotifTime() int64 // time last notified
SetLastNotified(now int64)
Upon(u Upon) bool
Subscribers() []string
ToNotifMsg(aborted bool) NotifMsg
}
intra-cluster notification interface
type NotifMsg ¶
type NotifMsg struct {
UUID string `json:"uuid"` // xaction UUID
NodeID string `json:"node_id"` // notifier node ID
Kind string `json:"kind"` // xaction `Kind`
ErrMsg string `json:"err"` // error.Error()
Data []byte `json:"message"` // (e.g. usage: custom progress stats)
AbortedX bool `json:"aborted"` // true if aborted (see related: Snap.AbortedX)
}
intra-cluster notification message
type OnFinishObj ¶
intra-cluster data path: control structures and types
type PromoteParams ¶
type PromoteParams struct {
Bck *meta.Bck // destination bucket
Cksum *cos.Cksum // checksum to validate
Config *cmn.Config // during xaction
Xact Xact // responsible xaction
apc.PromoteArgs // all of the above
}
intra-cluster data path: control structures and types
type PutParams ¶
type PutParams struct {
Reader io.ReadCloser
Cksum *cos.Cksum // checksum to check
Atime time.Time
Xact Xact
WorkTag string // (=> work fqn)
Size int64
OWT cmn.OWT
SkipEC bool // don't erasure-code when finalizing
ColdGET bool // this PUT is in fact a cold-GET
}
intra-cluster data path: control structures and types
func AllocPutParams ¶
func AllocPutParams() (a *PutParams)
type Snap ¶
type Snap struct {
// xaction-specific stats counters
Ext any `json:"ext"`
// common static props
StartTime time.Time `json:"start-time"`
EndTime time.Time `json:"end-time"`
Bck cmn.Bck `json:"bck"`
SrcBck cmn.Bck `json:"src-bck"`
DstBck cmn.Bck `json:"dst-bck"`
ID string `json:"id"`
Kind string `json:"kind"`
// extended error info
AbortErr string `json:"abort-err"`
Err string `json:"err"`
// rebalance-only
RebID int64 `json:"glob.id,string"`
// common runtime: stats counters (above) and state
Stats Stats `json:"stats"`
AbortedX bool `json:"aborted"`
IdleX bool `json:"is_idle"`
}
type Stats ¶
type Stats struct {
Objs int64 `json:"loc-objs,string"` // locally processed
Bytes int64 `json:"loc-bytes,string"` //
OutObjs int64 `json:"out-objs,string"` // transmit
OutBytes int64 `json:"out-bytes,string"` //
InObjs int64 `json:"in-objs,string"` // receive
InBytes int64 `json:"in-bytes,string"`
}
type Target ¶
type Target interface {
TargetLoc
// (for intra-cluster data-net comm - no streams)
DataClient() *http.Client
// core object (+ PutObject above)
FinalizeObj(lom *LOM, workFQN string, xctn Xact, owt cmn.OWT) (errCode int, err error)
EvictObject(lom *LOM) (errCode int, err error)
DeleteObject(lom *LOM, evict bool) (errCode int, err error)
GetCold(ctx context.Context, lom *LOM, owt cmn.OWT) (errCode int, err error)
GetColdBlob(lom *LOM, oa *cmn.ObjAttrs) (xctn Xact, err error)
CopyObject(lom *LOM, dm DM, coi *CopyParams) (int64, error)
Promote(params *PromoteParams) (errCode int, err error)
HeadObjT2T(lom *LOM, si *meta.Snode) bool
BMDVersionFixup(r *http.Request, bck ...cmn.Bck)
}
all of the above; for implementations, see `ais/tgtimpl.go` and `ais/htrun.go`
var (
T Target
)
target only
type TargetLoc ¶
type TargetLoc interface {
TargetPut
// backend
Backend(*meta.Bck) BackendProvider
// FS health and Health
FSHC(err error, path string)
Health(si *meta.Snode, timeout time.Duration, query url.Values) (body []byte, errCode int, err error)
}
local target node
type TargetPut ¶
type TargetPut interface {
NodeMemCap
// local PUT
PutObject(lom *LOM, params *PutParams) (err error)
}
a node that can also write objects
type Xact ¶
type Xact interface {
Run(*sync.WaitGroup)
ID() string
Kind() string
Bck() *meta.Bck
FromTo() (*meta.Bck, *meta.Bck)
StartTime() time.Time
EndTime() time.Time
Finished() bool
Running() bool
Quiesce(time.Duration, QuiCB) QuiRes
// abrt
IsAborted() bool
AbortErr() error
AbortedAfter(time.Duration) error
ChanAbort() <-chan error
// err (info)
AddErr(error, ...int)
Snap() *Snap // (struct below)
// reporting: log, err
String() string
Name() string
Cname() string
// modifiers
Finish()
Abort(error) bool
AddNotif(n Notif)
// common stats
Objs() int64
ObjsAdd(int, int64) // locally processed
OutObjsAdd(int, int64) // transmit
InObjsAdd(int, int64) // receive
InBytes() int64
OutBytes() int64
}