core

package
v1.3.27 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 14, 2025 License: MIT Imports: 32 Imported by: 2

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-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-2025, 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-2025, NVIDIA CORPORATION. All rights reserved.

Package core provides core metadata and in-cluster API

  • Copyright (c) 2018-2025, NVIDIA CORPORATION. All rights reserved.

Package core provides core metadata and in-cluster API

  • Copyright (c) 2024-2025, 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

View Source 
const (
	RemoteDeletedDelCount = "remote.deleted.del.n"

	// lcache stats
	LcacheCollisionCount = "lcache.collision.n"
	LcacheEvictedCount   = "lcache.evicted.n"
	LcacheErrCount       = "err.lcache.n" // errPrefix + "lcache.n"
	LcacheFlushColdCount = "lcache.flush.cold.n"
)

core stats

View Source 
const (
	MetaverLOM   = 1 // LOM
	MetaverChunk = 2 // LOM chunk // TODO: niy
)
View Source 
const (
	Targets = iota // 0 (core.Targets) used as default value for NewStreamBundle
	Proxies
	AllNodes
	SelectedNodes
)
View Source 
const (
	UponTerm     = Upon(1 << iota) // success or fail is separately provided via error
	UponProgress                   // periodic (BytesCount, ObjCount)
)

enum: when to notify

View Source 
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
	QuiActiveDontBump                // active that does not increase inactivity duration (ie., keeps initial setting)
	QuiDone                          // all done
	QuiAborted                       // aborted
	QuiTimeout                       // timeout
	Quiescent                        // idle => quiescent
)
View Source 
const (
	AisBID = uint64(1 << 63)
)
View Source 
const (
	DumpLomEnvVar = "AIS_DUMP_LOM"
)

cmd/xmeta support

View Source 
const (
	XattrLOM = "user.ais.lom"
)

on-disk xattr names

Variables

This section is empty.

Functions

func FreeLOM 

func FreeLOM(lom *LOM)

func FreePutParams 

func FreePutParams(a *PutParams)

func HrwFQN 

func HrwFQN(bck *cmn.Bck, contentType, objName string) (fqn string, digest uint64, err error)

func InMaintOrDecomm 

func InMaintOrDecomm(smap *meta.Smap, tsi *meta.Snode, xact Xact) (err error)

func NewBID added in v1.3.26 

func NewBID(serial uint64, isAis bool) uint64

func ParseObjLoc 

func ParseObjLoc(loc string) (tname, mpname string)

func Pinit 

func Pinit()

func ResolveFQN 

func ResolveFQN(fqn string, parsed *fs.ParsedFQN) (hrwFQN string, err error)

func Term 

func Term()

func Tinit 

func Tinit(t Target, tstats cos.StatsUpdater, config *cmn.Config, runHK bool)

func UncacheBcks added in v1.3.26 

func UncacheBcks(wg *sync.WaitGroup, bcks ...*meta.Bck) bool

evict bucket

func UncacheMountpath 

func UncacheMountpath(mi *fs.Mountpath)

evict mountpath (see also: mempDropAll)

Types

type AllRunningInOut 

type AllRunningInOut struct {
	Kind    string
	Running []string
	Idle    []string // NOTE: returning only when not nil
}

type Backend added in v1.3.23 

type Backend interface {
	Provider() string
	MetricName(string) string

	CreateBucket(bck *meta.Bck) (ecode int, err error)
	ListObjects(bck *meta.Bck, msg *apc.LsoMsg, lst *cmn.LsoRes) (ecode int, err error)
	ListBuckets(qbck cmn.QueryBcks) (bcks cmn.Bcks, ecode int, err error)
	PutObj(r io.ReadCloser, lom *LOM, origReq *http.Request) (ecode int, err error)
	DeleteObj(lom *LOM) (ecode int, err error)

	// head
	HeadBucket(ctx context.Context, bck *meta.Bck) (bckProps cos.StrKVs, ecode int, err error)
	HeadObj(ctx context.Context, lom *LOM, origReq *http.Request) (objAttrs *cmn.ObjAttrs, ecode int, err error)

	// get
	GetObj(ctx context.Context, lom *LOM, owt cmn.OWT, origReq *http.Request) (ecode int, err error) // calls GetObjReader
	GetObjReader(ctx context.Context, lom *LOM, offset, length int64) GetReaderResult

	// bucket inventory
	GetBucketInv(bck *meta.Bck, ctx *LsoInvCtx) (ecode int, err error)
	ListObjectsInv(bck *meta.Bck, msg *apc.LsoMsg, lst *cmn.LsoRes, ctx *LsoInvCtx) error
}

type BlobParams added in v1.3.23 

type BlobParams struct {
	Lmfh     cos.LomWriter
	RspW     http.ResponseWriter // (GET)
	WriteSGL WriteSGL            // custom write
	Lom      *LOM
	Msg      *apc.BlobMsg
	Wfqn     string
}

intra-cluster data path: control structures and types

type CRMD 

type CRMD struct {
	Err      error
	ObjAttrs *cmn.ObjAttrs
	ErrCode  int
	Eq       bool
}

type CT 

type CT struct {
	// contains filtered or unexported fields
}

func NewCTFromBO 

func NewCTFromBO(bck *cmn.Bck, objName string, b meta.Bowner, ctType ...string) (ct *CT, err error)

func NewCTFromFQN 

func NewCTFromFQN(fqn string, b meta.Bowner) (ct *CT, err error)

func NewCTFromLOM 

func NewCTFromLOM(lom *LOM, ctType string) *CT

Construct CT from LOM and change ContentType and FQN

func (*CT) Bck 

func (ct *CT) Bck() *meta.Bck

func (*CT) Bucket 

func (ct *CT) Bucket() *cmn.Bck

func (*CT) Clone 

func (ct *CT) Clone(ctType string) *CT

Clone CT and change ContentType and FQN

func (*CT) Cname added in v1.3.24 

func (ct *CT) Cname() string

func (*CT) ContentType 

func (ct *CT) ContentType() string

func (*CT) Digest 

func (ct *CT) Digest() uint64

func (*CT) FQN 

func (ct *CT) FQN() string

func (*CT) LoadSliceFromFS added in v1.3.24 

func (ct *CT) LoadSliceFromFS() error

func (*CT) Lock 

func (ct *CT) Lock(exclusive bool)

func (*CT) Lsize added in v1.3.24 

func (ct *CT) Lsize() int64

func (*CT) Make 

func (ct *CT) Make(toType string) string

func (*CT) Mountpath 

func (ct *CT) Mountpath() *fs.Mountpath

func (*CT) MtimeUnix 

func (ct *CT) MtimeUnix() int64

func (*CT) ObjectName 

func (ct *CT) ObjectName() string

func (*CT) UnamePtr added in v1.3.24 

func (ct *CT) UnamePtr() *string

func (*CT) Unlock 

func (ct *CT) Unlock(exclusive bool)

func (*CT) Write 

func (ct *CT) Write(reader io.Reader, size int64, workFQN string) (err error)

Save CT to local drives. If workFQN is set, it saves in two steps: first, save to workFQN; second, rename workFQN to ct.fqn. If unset, it writes directly to ct.fqn

type DP 

type DP interface {
	Reader(lom *LOM, latestVer, sync bool) (reader cos.ReadOpenCloser, oah cos.OAH, err error)
}

data provider

type GetReaderResult 

type GetReaderResult struct {
	R        io.ReadCloser
	Err      error
	ExpCksum *cos.Cksum
	Size     int64
	ErrCode  int
}

type LDP 

type LDP struct{}

func (*LDP) Reader 

func (*LDP) Reader(lom *LOM, latestVer, sync bool) (cos.ReadOpenCloser, cos.OAH, error)

(compare with ext/etl/dp.go)

type LIF 

type LIF struct {
	// contains filtered or unexported fields
}

LOM In Flight (LIF)

func (*LIF) CacheIdx 

func (lif *LIF) CacheIdx() int

func (*LIF) LOM 

func (lif *LIF) LOM() (lom *LOM, err error)

LIF => LOF with a check for bucket existence

func (*LIF) Unlock 

func (lif *LIF) Unlock(exclusive bool)

type LOM 

type LOM struct {
	ObjName string
	FQN     string
	HrwFQN  *string // (=> main replica)
	// contains filtered or unexported fields
}

func AllocLOM 

func AllocLOM(objName string) *LOM

func (*LOM) AddCopy 

func (lom *LOM) AddCopy(copyFQN string, mpi *fs.Mountpath) error

NOTE: used only in tests

func (*LOM) AppendWork added in v1.3.24 

func (*LOM) AppendWork(wfqn string) (fh cos.LomWriter, err error)

append

func (*LOM) Atime 

func (lom *LOM) Atime() time.Time

func (*LOM) AtimeUnix 

func (lom *LOM) AtimeUnix() int64

func (*LOM) Bck 

func (lom *LOM) Bck() *meta.Bck

func (*LOM) Bprops 

func (lom *LOM) Bprops() *cmn.Bprops

func (*LOM) Bucket 

func (lom *LOM) Bucket() *cmn.Bck

func (*LOM) CacheIdx 

func (lom *LOM) CacheIdx() int

func (*LOM) CheckEq added in v1.3.24 

func (lom *LOM) CheckEq(rem cos.OAH) error

LOM == remote-object equality check

func (*LOM) CheckRemoteMD 

func (lom *LOM) CheckRemoteMD(locked, sync bool, origReq *http.Request) (res CRMD)

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

also returns `NotFound` after removing local replica - the Sync option

func (*LOM) Checksum 

func (lom *LOM) Checksum() *cos.Cksum

func (*LOM) CksumConf 

func (lom *LOM) CksumConf() *cmn.CksumConf

func (*LOM) CksumType 

func (lom *LOM) CksumType() string

func (*LOM) CloneMD 

func (lom *LOM) CloneMD(fqn string) *LOM

allocates and copies metadata (in particular, atime and uname) NOTE: cloned lom.bid() == 0 is possible - copying/transforming scenarios

func (*LOM) Cname 

func (lom *LOM) Cname() string

see also: transport.ObjHdr.Cname()

func (*LOM) ComputeCksum 

func (lom *LOM) ComputeCksum(cksumType string) (cksum *cos.CksumHash, _ error)

func (*LOM) ComputeSetCksum 

func (lom *LOM) ComputeSetCksum() (*cos.Cksum, error)

func (*LOM) Copy 

func (lom *LOM) Copy(mi *fs.Mountpath, buf []byte) (err error)

increment the object's num copies by (well) copying the former (compare with lom.Copy2FQN below)

func (*LOM) Copy2FQN 

func (lom *LOM) Copy2FQN(dstFQN string, buf []byte) (dst *LOM, err error)

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) CopyAttrs 

func (lom *LOM) CopyAttrs(oah cos.OAH, skipCksum bool)

func (*LOM) CopyVersion added in v1.3.24 

func (lom *LOM) CopyVersion(oah cos.OAH)

func (*LOM) Create added in v1.3.24 

func (lom *LOM) Create() (cos.LomWriter, error)

func (*LOM) CreatePart added in v1.3.24 

func (lom *LOM) CreatePart(wfqn string) (*os.File, error)

func (*LOM) CreateSlice added in v1.3.24 

func (lom *LOM) CreateSlice(wfqn string) (*os.File, error)

func (*LOM) CreateWork added in v1.3.24 

func (lom *LOM) CreateWork(wfqn string) (cos.LomWriter, error)

func (*LOM) DelAllCopies 

func (lom *LOM) DelAllCopies() (err error)

func (*LOM) DelCopies 

func (lom *LOM) DelCopies(copiesFQN ...string) (err error)

func (*LOM) DelExtraCopies 

func (lom *LOM) DelExtraCopies(fqn ...string) (removed bool, err error)

DelExtraCopies deletes obj replicas that are not part of the lom.md.copies metadata (cleanup)

func (*LOM) Digest 

func (lom *LOM) Digest() uint64

func (*LOM) DowngradeLock 

func (lom *LOM) DowngradeLock()

func (*LOM) ECEnabled 

func (lom *LOM) ECEnabled() bool

bprops accessors for convenience

func (*LOM) EqCksum 

func (lom *LOM) EqCksum(cksum *cos.Cksum) bool

func (*LOM) FromFS 

func (lom *LOM) FromFS() error

func (*LOM) Fstat added in v1.3.24 

func (lom *LOM) Fstat(getAtime bool) (size, atimefs int64, mtime time.Time, _ error)

low-level access to the os.FileInfo of a chunk or whole file

func (*LOM) GetCopies 

func (lom *LOM) GetCopies() fs.MPI

GetCopies returns all copies - copies include lom.FQN aka "main repl." - caller must take a lock

func (*LOM) GetCustomKey 

func (lom *LOM) GetCustomKey(key string) (string, bool)

func (*LOM) GetCustomMD 

func (lom *LOM) GetCustomMD() cos.StrKVs

custom metadata

func (*LOM) HasCopies 

func (lom *LOM) HasCopies() bool

func (*LOM) HrwTarget 

func (lom *LOM) HrwTarget(smap *meta.Smap) (tsi *meta.Snode, local bool, err error)

func (*LOM) IncVersion 

func (lom *LOM) IncVersion() error

func (*LOM) InitBck 

func (lom *LOM) InitBck(bck *cmn.Bck) (err error)

func (*LOM) InitCT 

func (lom *LOM) InitCT(ct *CT)

func (*LOM) InitFQN 

func (lom *LOM) InitFQN(fqn string, expbck *cmn.Bck) (err error)

func (*LOM) IsChunked added in v1.3.24 

func (lom *LOM) IsChunked(special ...bool) bool

chunks vs whole // TODO -- FIXME: NIY

func (*LOM) IsCopy 

func (lom *LOM) IsCopy() bool

given an existing (on-disk) object, determines whether it is a _copy_ (compare with isMirror below)

func (*LOM) IsFeatureSet added in v1.3.23 

func (lom *LOM) IsFeatureSet(f feat.Flags) bool

func (*LOM) IsFntl added in v1.3.26 

func (lom *LOM) IsFntl() bool

func (*LOM) IsHRW 

func (lom *LOM) IsHRW() bool

subj to resilvering

func (*LOM) LBGet 

func (lom *LOM) LBGet() (fqn string)

load-balanced GET

func (*LOM) LIF 

func (lom *LOM) LIF() (lif LIF)

constructor

func (*LOM) LeastUtilNoCopy 

func (lom *LOM) LeastUtilNoCopy() (mi *fs.Mountpath)

returns the least utilized mountpath that does _not_ have a copy of this `lom` yet (compare with leastUtilCopy())

func (*LOM) Load 

func (lom *LOM) Load(cacheit, locked bool) error

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 

func (lom *LOM) LoadLatest(latest bool) (oa *cmn.ObjAttrs, deleted bool, err error)

NOTE: Sync is false (ie., not deleting)

func (*LOM) LoadMetaFromFS 

func (lom *LOM) LoadMetaFromFS() error

NOTE usage: tests and `xmeta` only; ignores `dirty`

func (*LOM) LoadUnsafe 

func (lom *LOM) LoadUnsafe() (err error)

usage: fast (and unsafe) loading object metadata except atime - no locks compare with conventional Load() above

func (*LOM) Location 

func (lom *LOM) Location() string

func (*LOM) Lock 

func (lom *LOM) Lock(exclusive bool)

func (*LOM) Lsize added in v1.3.24 

func (lom *LOM) Lsize(special ...bool) int64

special a) when a new version is being created b) for usage in unit tests

func (*LOM) MirrorConf 

func (lom *LOM) MirrorConf() *cmn.MirrorConf

func (*LOM) Mountpath 

func (lom *LOM) Mountpath() *fs.Mountpath

func (*LOM) NewDeferROC 

func (lom *LOM) NewDeferROC() (cos.ReadOpenCloser, error)

is called under rlock; unlocks on fail

func (*LOM) NumCopies 

func (lom *LOM) NumCopies() int

func (*LOM) ObjAttrs 

func (lom *LOM) ObjAttrs() *cmn.ObjAttrs

func (*LOM) ObjectName 

func (lom *LOM) ObjectName() string

as fs.PartsFQN

func (*LOM) Open added in v1.3.24 

func (lom *LOM) Open() (fh cos.LomReader, err error)

same as above but return a reader

func (*LOM) OpenFile added in v1.3.23 

func (lom *LOM) OpenFile() (fh *os.File, _ error)

open read-only, return os.File

func (*LOM) OrigFntl added in v1.3.26 

func (lom *LOM) OrigFntl() []string

func (*LOM) Persist 

func (lom *LOM) Persist() (err error)

(caller must set atime; compare with the above)

func (*LOM) PersistMain 

func (lom *LOM) PersistMain() (err error)

func (*LOM) PopFntl added in v1.3.26 

func (lom *LOM) PopFntl(saved []string)

func (*LOM) PostInit added in v1.3.23 

func (lom *LOM) PostInit() (err error)

func (*LOM) PreInit added in v1.3.23 

func (lom *LOM) PreInit(fqn string) error

NOTE: to facilitate fast path filtering-out

func (*LOM) PushFntl added in v1.3.26 

func (lom *LOM) PushFntl(short []string) (saved []string)

func (*LOM) Recache 

func (lom *LOM) Recache()

store new or refresh existing

func (*LOM) RemoveMain added in v1.3.24 

func (lom *LOM) RemoveMain() error

func (*LOM) RemoveObj added in v1.3.24 

func (lom *LOM) RemoveObj(force ...bool) (err error)

func (*LOM) RenameFinalize added in v1.3.24 

func (lom *LOM) RenameFinalize(wfqn string) error

func (*LOM) RenameMainTo added in v1.3.24 

func (lom *LOM) RenameMainTo(wfqn string) error

func (*LOM) RenameToMain added in v1.3.24 

func (lom *LOM) RenameToMain(wfqn string) error

func (*LOM) RestoreToLocation 

func (lom *LOM) RestoreToLocation() (exists bool)

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 *LOM) SetAtimeUnix(tu int64)

func (*LOM) SetCksum 

func (lom *LOM) SetCksum(cksum *cos.Cksum)

func (*LOM) SetCustomKey 

func (lom *LOM) SetCustomKey(key, value string)

func (*LOM) SetCustomMD 

func (lom *LOM) SetCustomMD(md cos.StrKVs)

func (*LOM) SetSize 

func (lom *LOM) SetSize(size int64)

func (*LOM) SetVersion 

func (lom *LOM) SetVersion(ver string)

func (*LOM) ShortenFntl added in v1.3.26 

func (lom *LOM) ShortenFntl() []string

(compare with fs/content Gen())

func (*LOM) String 

func (lom *LOM) String() string

func (*LOM) TestAtime added in v1.3.26 

func (lom *LOM) TestAtime() error

usage: unit tests only

func (*LOM) ToMpath 

func (lom *LOM) ToMpath() (mi *fs.Mountpath, isHrw bool)

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) TryLock 

func (lom *LOM) TryLock(exclusive bool) bool

func (*LOM) Uname 

func (lom *LOM) Uname() string

func (*LOM) UnamePtr added in v1.3.24 

func (lom *LOM) UnamePtr() *string

func (*LOM) Uncache 

func (lom *LOM) Uncache()

func (*LOM) UncacheUnless 

func (lom *LOM) UncacheUnless()

remove from cache unless dirty

func (*LOM) Unlock 

func (lom *LOM) Unlock(exclusive bool)

func (*LOM) UpgradeLock 

func (lom *LOM) UpgradeLock() (finished bool)

func (*LOM) ValidateContentChecksum 

func (lom *LOM) ValidateContentChecksum() (err error)

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 

func (lom *LOM) ValidateMetaChecksum() error

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) Version 

func (lom *LOM) Version(special ...bool) string

func (*LOM) VersionConf 

func (lom *LOM) VersionConf() cmn.VersionConf

func (*LOM) VersionPtr added in v1.3.24 

func (lom *LOM) VersionPtr() *string

func (*LOM) WritePolicy 

func (lom *LOM) WritePolicy() (p apc.WritePolicy)

type LsoInvCtx added in v1.3.23 

type LsoInvCtx struct {
	Lmfh   cos.LomReader
	Lom    *LOM
	SGL    *memsys.SGL
	Name   string
	ID     string
	Schema []string
	Size   int64
	EOF    bool
}

type NLP 

type NLP interface {
	Lock()
	TryLock(timeout time.Duration) bool
	TryRLock(timeout time.Duration) bool
	Unlock()
}

pair

func NewNLP 

func NewNLP(name []byte) NLP

NOTE: currently, is only used to lock buckets

type Node 

type Node interface {
	SID() string
	String() string
	Snode() *meta.Snode

	Bowner() meta.Bowner
	Sowner() meta.Sowner

	ClusterStarted() bool
	NodeStarted() bool

	// Memory allocators
	PageMM() *memsys.MMSA
	ByteMM() *memsys.MMSA
}

cluster node

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

func (*NotifMsg) String 

func (msg *NotifMsg) String() (s string)

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 QuiCB 

type QuiCB func(elapsed time.Duration) QuiRes // see enum below

type QuiRes 

type QuiRes int

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"`
	CtlMsg    string    `json:"ctlmsg,omitempty"` // initiating control msg (added v3.26)

	// 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"`
}

func (*Snap) Finished 

func (snp *Snap) Finished() bool

func (*Snap) IsAborted 

func (snp *Snap) IsAborted() bool

func (*Snap) IsIdle 

func (snp *Snap) IsIdle() bool

func (*Snap) Running 

func (snp *Snap) Running() bool

func (*Snap) Started 

func (snp *Snap) Started() bool

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

	// target <=> target & target => backend (no streams)
	DataClient() *http.Client

	// core object (+ PutObject above)
	FinalizeObj(lom *LOM, workFQN string, xctn Xact, owt cmn.OWT) (ecode int, err error)
	EvictObject(lom *LOM) (ecode int, err error)
	DeleteObject(lom *LOM, evict bool) (ecode int, err error)

	GetCold(ctx context.Context, lom *LOM, owt cmn.OWT) (ecode int, err error)

	HeadCold(lom *LOM, origReq *http.Request) (objAttrs *cmn.ObjAttrs, ecode int, err error)

	Promote(params *PromoteParams) (ecode int, err error)
	HeadObjT2T(lom *LOM, si *meta.Snode) bool

	ECRestoreReq(ct *CT, si *meta.Snode, uuid string) error

	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

	fs.HC

	// backend
	Backend(*meta.Bck) Backend

	// Node health
	Health(si *meta.Snode, timeout time.Duration, query url.Values) (body []byte, ecode int, err error)
}

local target node

type TargetPut 

type TargetPut interface {
	Node

	// Space
	OOS(*fs.CapStatus, *cmn.Config, *fs.Tcdf) fs.CapStatus

	// xactions (jobs) now
	GetAllRunning(inout *AllRunningInOut, periodic bool)

	// PUT params.Reader => lom
	PutObject(lom *LOM, params *PutParams) (err error)

	// utilize blob downloader to cold-GET => (lom | custom write callback)
	GetColdBlob(params *BlobParams, oa *cmn.ObjAttrs) (xctn Xact, err error)
}

a node that can also write objects

type Upon 

type Upon int

type WriteSGL added in v1.3.23 

type WriteSGL func(*memsys.SGL) error

blob

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
}

Source Files

View all Source files

Directories

Path Synopsis
Package meta: cluster-level metadata
 Package meta: cluster-level metadata
Package mock provides a variety of mock implementations used for testing.
 Package mock provides a variety of mock implementations used for testing.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.