Safe Haskell	None
Language	GHC2021

Ecluse.Composition.MemoryPlan.Types

Description

The memory plan's public vocabulary: the resolved plan and the tenants that carry a shape of their own. resolveMemoryPlan solves for these, and the composition root builds every byte-valued bound from them.

Synopsis

data MemoryPlan = MemoryPlan {
- mpRuntimeReserveBytes :: Int
- mpCacheAggregateBytes :: Int
- mpCacheMaxEntries :: Int
- mpMaxResponseBytes :: Int
- mpMaxRequestBytes :: Int
- mpAdmissionCapacity :: Int
- mpPublishTenant :: Maybe PublishTenant
- mpMirrorArtifactTenant :: Maybe MirrorArtifactTenant
- mpQueueMemoryMaxDepth :: Int
- mpQueueTenantBytes :: Int
- mpFixedBufferBytes :: Int
- mpTransientBudget :: TransientBudget
- mpDegradations :: [Text]
- mpOverrideViolations :: [Text]
}
newtype PublishTenant = PublishTenant {
- ptAggregateBytes :: Int
}
newtype MirrorArtifactTenant = MirrorArtifactTenant {
- matMaxBytes :: Int
}
data QueueTenantDemand
queueTenantDemand :: MirrorRuntimePlan -> QueueTenantDemand
data TransientBudget = TransientBudget {
- tbLiveTargetBytes :: Maybe Int
- tbExplainedBytes :: Int
- tbBootBytes :: Int
- tbLiveCeilingBytes :: Maybe Int
- tbFloorBytes :: Int
- tbOverflowLiveBytes :: Maybe Int
}

Documentation

data MemoryPlan Source #

The resolved plan: every byte-valued bound the composition root builds with, each an explicit config value or its tenant-derived default. Override violations are the one refusal.

Constructors

MemoryPlan

Fields

mpRuntimeReserveBytes :: Int
Tenant 1, taken off the top. Zero with no ceiling datapoint.
mpCacheAggregateBytes :: Int
Tenant 3: one shared byte bound for all eligible local cache stores.
mpCacheMaxEntries :: Int
mpMaxResponseBytes :: Int
The fixed metadata ingest ceiling, independent of memory and CPU admission.
mpMaxRequestBytes :: Int
The per-request (publish body) wire cap Q, enforced at the publish read site.
mpAdmissionCapacity :: Int
CPU-derived concurrency, or the exact explicit operator pin.
mpPublishTenant :: Maybe PublishTenant
Tenant 5, present only when a publication target is configured.
mpMirrorArtifactTenant :: Maybe MirrorArtifactTenant
Tenant 7, present only when some mount mirrors. Carries the worker's cap.
mpQueueMemoryMaxDepth :: Int
The in-memory queue's depth cap (the build parameter, always resolved).
mpQueueTenantBytes :: Int
Tenant 6: the bytes the depth charges. Zero unless the memory backend runs.
mpFixedBufferBytes :: Int
Tenant 2: the enqueue buffer, charged whenever any mount mirrors.
mpTransientBudget :: TransientBudget
The live data metadata requests may hold at once, which the memory meter enforces.
mpDegradations :: [Text]
Shed-ladder and explicit-control warnings.
mpOverrideViolations :: [Text]
The pins the plan blames for a residual overshoot it cannot shed around. The boot and check-config refuse on these with exit 2.

Instances

Instances details

Show MemoryPlan Source #
Instance details Defined in Ecluse.Composition.MemoryPlan.Types Methods showsPrec :: Int -> MemoryPlan -> ShowS # show :: MemoryPlan -> String # showList :: [MemoryPlan] -> ShowS #
Eq MemoryPlan Source #
Instance details Defined in Ecluse.Composition.MemoryPlan.Types Methods (==) :: MemoryPlan -> MemoryPlan -> Bool # (/=) :: MemoryPlan -> MemoryPlan -> Bool #

newtype PublishTenant Source #

The publish tenant: the aggregate byte-admission for concurrently buffered bodies.

Constructors

PublishTenant
Fields ptAggregateBytes :: Int

Instances

Instances details

Show PublishTenant Source #
Instance details Defined in Ecluse.Composition.MemoryPlan.Types Methods showsPrec :: Int -> PublishTenant -> ShowS # show :: PublishTenant -> String # showList :: [PublishTenant] -> ShowS #
Eq PublishTenant Source #
Instance details Defined in Ecluse.Composition.MemoryPlan.Types Methods (==) :: PublishTenant -> PublishTenant -> Bool # (/=) :: PublishTenant -> PublishTenant -> Bool #

newtype MirrorArtifactTenant Source #

The mirror-artifact tenant, present only when some mount mirrors. The plan charges its heap as matMaxBytes scaled by mirrorArtifactEnvelopeMultiplier.

Constructors

MirrorArtifactTenant
Fields matMaxBytes :: Int The worker's per-artifact fetch byte cap (the tarball bound `B`).

Instances

Instances details

Show MirrorArtifactTenant Source #
Instance details Defined in Ecluse.Composition.MemoryPlan.Types Methods showsPrec :: Int -> MirrorArtifactTenant -> ShowS # show :: MirrorArtifactTenant -> String # showList :: [MirrorArtifactTenant] -> ShowS #
Eq MirrorArtifactTenant Source #
Instance details Defined in Ecluse.Composition.MemoryPlan.Types Methods (==) :: MirrorArtifactTenant -> MirrorArtifactTenant -> Bool # (/=) :: MirrorArtifactTenant -> MirrorArtifactTenant -> Bool #

data QueueTenantDemand Source #

Whether the memory plan owes the in-memory queue a tenant, projected from the backend selection (planMirrorRuntime).

Constructors

NoQueueTenant	No mount mirrors: no queue tenant, no enqueue buffer.
MirroringWithoutMemoryQueue	Mirroring rides a durable backend, so the plan charges the enqueue buffer alone.
MemoryQueueTenant	Mirroring rides the in-memory queue: its depth is a tenant of this plan.

Instances

Instances details

Show QueueTenantDemand Source #
Instance details Defined in Ecluse.Composition.MemoryPlan.Types Methods showsPrec :: Int -> QueueTenantDemand -> ShowS # show :: QueueTenantDemand -> String # showList :: [QueueTenantDemand] -> ShowS #
Eq QueueTenantDemand Source #
Instance details Defined in Ecluse.Composition.MemoryPlan.Types Methods (==) :: QueueTenantDemand -> QueueTenantDemand -> Bool # (/=) :: QueueTenantDemand -> QueueTenantDemand -> Bool #

queueTenantDemand :: MirrorRuntimePlan -> QueueTenantDemand Source #

Project the queue-tenant demand from the resolved mirror runtime plan.

data TransientBudget Source #

The budget the boot hands the meter and the sampler, in bytes of live data.

Constructors

TransientBudget

Fields

tbLiveTargetBytes :: Maybe Int
The live data the heap holds in the collector's normal regime. Nothing without a ceiling.
tbExplainedBytes :: Int
Live data outside the budget: the idle process and the other tenants.
tbBootBytes :: Int
The budget at boot.
tbLiveCeilingBytes :: Maybe Int
The live data the sampler lets charges and the measured remainder reach together.
tbFloorBytes :: Int
The least the sampler may shrink the budget to.
tbOverflowLiveBytes :: Maybe Int
The live data at which the copying collector overflows the ceiling.

Instances

Instances details

Show TransientBudget Source #
Instance details Defined in Ecluse.Composition.MemoryPlan.Types Methods showsPrec :: Int -> TransientBudget -> ShowS # show :: TransientBudget -> String # showList :: [TransientBudget] -> ShowS #
Eq TransientBudget Source #
Instance details Defined in Ecluse.Composition.MemoryPlan.Types Methods (==) :: TransientBudget -> TransientBudget -> Bool # (/=) :: TransientBudget -> TransientBudget -> Bool #