# uber-go/automaxprocs architecture

> Architecture diagram of the GitHub repository uber-go/automaxprocs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/uber-go/automaxprocs
- Repository: https://github.com/uber-go/automaxprocs

## Overview

automaxprocs is a small Go library that adjusts Go’s GOMAXPROCS to match a Linux container CPU quota. The documented workflow is to blank-import the top-level package, which invokes the configurable maxprocs API; that API obtains a quota-derived value and applies it to the Go runtime. Linux quota discovery supports both cgroups v1 and v2. The excerpts show the key dispatch and parsing relationships; unsampled cgroup internals are represented without inferred calls.

Main entry points: [`internal/runtime/cpu_quota_linux.go`](https://github.com/uber-go/automaxprocs/blob/master/internal/runtime/cpu_quota_linux.go) (Quota conversion), [`internal/cgroups/cgroups.go`](https://github.com/uber-go/automaxprocs/blob/master/internal/cgroups/cgroups.go) (Cgroups v1 quota), [`maxprocs/maxprocs.go`](https://github.com/uber-go/automaxprocs/blob/master/maxprocs/maxprocs.go) (Configure GOMAXPROCS), [`internal/cgroups/cgroups2.go`](https://github.com/uber-go/automaxprocs/blob/master/internal/cgroups/cgroups2.go) (Cgroups v2 quota)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Entry and API"]
  node_autoinit["Auto initialization<br/>[automaxprocs.go]"]
  node_set["Configure GOMAXPROCS<br/>[maxprocs.go]"]
end

subgraph group_quota["Quota resolution"]
  node_quota_dispatch["Quota conversion<br/>[cpu_quota_linux.go]"]
  node_quota_policy["Quota status and rounding<br/>[runtime.go]"]
  node_unsupported["Non-Linux fallback"]
end

subgraph group_cgroups["Cgroup discovery"]
  node_v1["Cgroups v1 quota<br/>[cgroups.go]"]
  node_v2["Cgroups v2 quota<br/>[cgroups2.go]"]
  node_subsystems["Proc cgroup parser<br/>[subsys.go]"]
  node_mounts["Mountinfo parser<br/>[mountpoint.go]"]
  node_cgroup_files["Cgroup file access<br/>[cgroup.go]"]
end

node_app(("Go application"))
node_goruntime["Go runtime"]

node_app -->|"blank imports"| node_autoinit
node_autoinit -->|"invokes"| node_set
node_set -->|"requests quota"| node_quota_dispatch
node_set -->|"sets GOMAXPROCS"| node_goruntime
node_quota_dispatch -->|"tries first"| node_v2
node_quota_dispatch -->|"falls back"| node_v1
node_quota_dispatch -->|"uses status types"| node_quota_policy
node_v1 -->|"parses proc entries"| node_subsystems
node_v1 -->|"parses mountinfo"| node_mounts
node_v1 -->|"creates accessors"| node_cgroup_files
node_v2 -->|"parses proc entries"| node_subsystems
node_v2 -->|"checks mountinfo"| node_mounts

click node_autoinit "https://github.com/uber-go/automaxprocs/blob/master/automaxprocs.go"
click node_set "https://github.com/uber-go/automaxprocs/blob/master/maxprocs/maxprocs.go"
click node_quota_dispatch "https://github.com/uber-go/automaxprocs/blob/master/internal/runtime/cpu_quota_linux.go"
click node_quota_policy "https://github.com/uber-go/automaxprocs/blob/master/internal/runtime/runtime.go"
click node_unsupported "https://github.com/uber-go/automaxprocs/blob/master/internal/runtime/cpu_quota_unsupported.go"
click node_v1 "https://github.com/uber-go/automaxprocs/blob/master/internal/cgroups/cgroups.go"
click node_v2 "https://github.com/uber-go/automaxprocs/blob/master/internal/cgroups/cgroups2.go"
click node_subsystems "https://github.com/uber-go/automaxprocs/blob/master/internal/cgroups/subsys.go"
click node_mounts "https://github.com/uber-go/automaxprocs/blob/master/internal/cgroups/mountpoint.go"
click node_cgroup_files "https://github.com/uber-go/automaxprocs/blob/master/internal/cgroups/cgroup.go"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_autoinit,node_set toneBlue
class node_quota_dispatch,node_quota_policy,node_unsupported toneAmber
class node_v1,node_v2,node_subsystems,node_mounts,node_cgroup_files toneMint
class node_app,node_goruntime toneIndigo
```

## Components

### Entry and API

- [Auto initialization](https://github.com/uber-go/automaxprocs/blob/master/automaxprocs.go): `automaxprocs.go`
- [Configure GOMAXPROCS](https://github.com/uber-go/automaxprocs/blob/master/maxprocs/maxprocs.go): `maxprocs/maxprocs.go`

### Quota resolution

- [Quota conversion](https://github.com/uber-go/automaxprocs/blob/master/internal/runtime/cpu_quota_linux.go): `internal/runtime/cpu_quota_linux.go`
- [Quota status and rounding](https://github.com/uber-go/automaxprocs/blob/master/internal/runtime/runtime.go): `internal/runtime/runtime.go`
- [Non-Linux fallback](https://github.com/uber-go/automaxprocs/blob/master/internal/runtime/cpu_quota_unsupported.go): `internal/runtime/cpu_quota_unsupported.go`

### Cgroup discovery

- [Cgroups v1 quota](https://github.com/uber-go/automaxprocs/blob/master/internal/cgroups/cgroups.go): `internal/cgroups/cgroups.go`
- [Cgroups v2 quota](https://github.com/uber-go/automaxprocs/blob/master/internal/cgroups/cgroups2.go): `internal/cgroups/cgroups2.go`
- [Proc cgroup parser](https://github.com/uber-go/automaxprocs/blob/master/internal/cgroups/subsys.go): `internal/cgroups/subsys.go`
- [Mountinfo parser](https://github.com/uber-go/automaxprocs/blob/master/internal/cgroups/mountpoint.go): `internal/cgroups/mountpoint.go`
- [Cgroup file access](https://github.com/uber-go/automaxprocs/blob/master/internal/cgroups/cgroup.go): `internal/cgroups/cgroup.go`

### Other components

- **Go application**
- **Go runtime**

## Connections

- Go application → Auto initialization: blank imports (evidence: `README.md`)
- Auto initialization → Configure GOMAXPROCS: invokes (evidence: `automaxprocs.go`)
- Configure GOMAXPROCS → Quota conversion: requests quota (evidence: `maxprocs/maxprocs.go`)
- Configure GOMAXPROCS → Go runtime: sets GOMAXPROCS (evidence: `maxprocs/maxprocs.go`)
- Quota conversion → Cgroups v2 quota: tries first (evidence: `internal/runtime/cpu_quota_linux.go`)
- Quota conversion → Cgroups v1 quota: falls back (evidence: `internal/runtime/cpu_quota_linux.go`)
- Quota conversion → Quota status and rounding: uses status types (evidence: `internal/runtime/cpu_quota_linux.go`)
- Cgroups v1 quota → Proc cgroup parser: parses proc entries (evidence: `internal/cgroups/cgroups.go`)
- Cgroups v1 quota → Mountinfo parser: parses mountinfo (evidence: `internal/cgroups/cgroups.go`)
- Cgroups v1 quota → Cgroup file access: creates accessors (evidence: `internal/cgroups/cgroups.go`)
- Cgroups v2 quota → Proc cgroup parser: parses proc entries (evidence: `internal/cgroups/cgroups2.go`)
- Cgroups v2 quota → Mountinfo parser: checks mountinfo (evidence: `internal/cgroups/cgroups2.go`)
