visor/pkg/sentry/platform/kvm/kvm_const_arm64.go

// Copyright 2019 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package kvm

// KVM ioctls for Arm64.
const (
	_KVM_GET_ONE_REG = 0x4010aeab
	_KVM_SET_ONE_REG = 0x4010aeac

	_KVM_ARM_TARGET_GENERIC_V8 = 5
	_KVM_ARM_PREFERRED_TARGET  = 0x8020aeaf
	_KVM_ARM_VCPU_INIT         = 0x4020aeae
	_KVM_ARM64_REGS_PSTATE     = 0x6030000000100042
	_KVM_ARM64_REGS_SP_EL1     = 0x6030000000100044
	_KVM_ARM64_REGS_R0         = 0x6030000000100000
	_KVM_ARM64_REGS_R1         = 0x6030000000100002
	_KVM_ARM64_REGS_R2         = 0x6030000000100004
	_KVM_ARM64_REGS_R3         = 0x6030000000100006
	_KVM_ARM64_REGS_R8         = 0x6030000000100010
	_KVM_ARM64_REGS_R18        = 0x6030000000100024
	_KVM_ARM64_REGS_PC         = 0x6030000000100040
	_KVM_ARM64_REGS_MAIR_EL1   = 0x603000000013c510
	_KVM_ARM64_REGS_TCR_EL1    = 0x603000000013c102
	_KVM_ARM64_REGS_TTBR0_EL1  = 0x603000000013c100
	_KVM_ARM64_REGS_TTBR1_EL1  = 0x603000000013c101
	_KVM_ARM64_REGS_SCTLR_EL1  = 0x603000000013c080
	_KVM_ARM64_REGS_CPACR_EL1  = 0x603000000013c082
	_KVM_ARM64_REGS_VBAR_EL1   = 0x603000000013c600
	_KVM_ARM64_REGS_TIMER_CNT  = 0x603000000013df1a
	_KVM_ARM64_REGS_CNTFRQ_EL0 = 0x603000000013df00

	_KVM_ARM64_REGS_MDSCR_EL1   = 0x6030000000138012
	_KVM_ARM64_REGS_CNTKCTL_EL1 = 0x603000000013c708
	_KVM_ARM64_REGS_TPIDR_EL1   = 0x603000000013c684

	// Pointer authentication key registers (op0=3, op1=0, CRn=2,
	// CRm={1,2,3}). These are only accessible when the vCPU was
	// initialized with the PTRAUTH features.
	_KVM_ARM64_REGS_APIAKEYLO_EL1 = 0x603000000013c108
	_KVM_ARM64_REGS_APIAKEYHI_EL1 = 0x603000000013c109
	_KVM_ARM64_REGS_APIBKEYLO_EL1 = 0x603000000013c10a
	_KVM_ARM64_REGS_APIBKEYHI_EL1 = 0x603000000013c10b
	_KVM_ARM64_REGS_APDAKEYLO_EL1 = 0x603000000013c110
	_KVM_ARM64_REGS_APDAKEYHI_EL1 = 0x603000000013c111
	_KVM_ARM64_REGS_APDBKEYLO_EL1 = 0x603000000013c112
	_KVM_ARM64_REGS_APDBKEYHI_EL1 = 0x603000000013c113
	_KVM_ARM64_REGS_APGAKEYLO_EL1 = 0x603000000013c118
	_KVM_ARM64_REGS_APGAKEYHI_EL1 = 0x603000000013c119
)

// Arm64: Architectural Feature Access Control Register EL1.
const (
	_FPEN_NOTRAP = 3
	_FPEN_SHIFT  = 20
)

// Arm64: System Control Register EL1.
const (
	_SCTLR_M           = 1 << 0
	_SCTLR_C           = 1 << 2
	_SCTLR_I           = 1 << 12
	_SCTLR_DZE         = 1 << 14
	_SCTLR_UCT         = 1 << 15
	_SCTLR_UCI         = 1 << 26
	_SCTLR_EL1_DEFAULT = _SCTLR_M | _SCTLR_C | _SCTLR_I | _SCTLR_UCT | _SCTLR_UCI | _SCTLR_DZE
)

// Arm64: Counter-timer Kernel Control Register el1.
const (
	_CNTKCTL_EL0PCTEN = 1 << 0
	_CNTKCTL_EL0VCTEN = 1 << 1

	_CNTKCTL_EL1_DEFAULT = _CNTKCTL_EL0PCTEN | _CNTKCTL_EL0VCTEN
)

// Arm64: Translation Control Register EL1.
const (
	_TCR_IPS_40BITS = 2 << 32 // PA=40
	_TCR_IPS_48BITS = 5 << 32 // PA=48

	_TCR_T0SZ_OFFSET = 0
	_TCR_T1SZ_OFFSET = 16
	_TCR_IRGN0_SHIFT = 8
	_TCR_IRGN1_SHIFT = 24
	_TCR_ORGN0_SHIFT = 10
	_TCR_ORGN1_SHIFT = 26
	_TCR_SH0_SHIFT   = 12
	_TCR_SH1_SHIFT   = 28
	_TCR_TG0_SHIFT   = 14
	_TCR_TG1_SHIFT   = 30

	_TCR_T0SZ_VA48 = 64 - 48 // VA=48
	_TCR_T1SZ_VA48 = 64 - 48 // VA=48

	_TCR_A1     = 1 << 22
	_TCR_ASID16 = 1 << 36
	_TCR_TBI0   = 1 << 37

	_TCR_TXSZ_VA48 = (_TCR_T0SZ_VA48 << _TCR_T0SZ_OFFSET) | (_TCR_T1SZ_VA48 << _TCR_T1SZ_OFFSET)

	_TCR_TG0_4K  = 0 << _TCR_TG0_SHIFT // 4K
	_TCR_TG0_64K = 1 << _TCR_TG0_SHIFT // 64K

	_TCR_TG1_4K = 2 << _TCR_TG1_SHIFT

	_TCR_TG_FLAGS = _TCR_TG0_4K | _TCR_TG1_4K

	_TCR_IRGN0_WBWA = 1 << _TCR_IRGN0_SHIFT
	_TCR_IRGN1_WBWA = 1 << _TCR_IRGN1_SHIFT
	_TCR_IRGN_WBWA  = _TCR_IRGN0_WBWA | _TCR_IRGN1_WBWA

	_TCR_ORGN0_WBWA = 1 << _TCR_ORGN0_SHIFT
	_TCR_ORGN1_WBWA = 1 << _TCR_ORGN1_SHIFT

	_TCR_ORGN_WBWA = _TCR_ORGN0_WBWA | _TCR_ORGN1_WBWA

	_TCR_SHARED = (3 << _TCR_SH0_SHIFT) | (3 << _TCR_SH1_SHIFT)

	_TCR_CACHE_FLAGS = _TCR_IRGN_WBWA | _TCR_ORGN_WBWA
)

// Arm64: Memory Attribute Indirection Register EL1.
const (
	_MT_ATTR_DEVICE_nGnRnE = 0x00
	_MT_ATTR_DEVICE_nGnRE  = 0x04
	_MT_ATTR_DEVICE_GRE    = 0x0c
	_MT_ATTR_NORMAL_NC     = 0x44
	_MT_ATTR_NORMAL_WT     = 0xbb
	_MT_ATTR_NORMAL        = 0xff
	_MT_ATTR_MASK          = 0xff
)

const (
	_KVM_ARM_VCPU_POWER_OFF       = 0 // CPU is started in OFF state
	_KVM_ARM_VCPU_PSCI_0_2        = 2 // CPU uses PSCI v0.2
	_KVM_ARM_VCPU_PTRAUTH_ADDRESS = 5 // vCPU uses address authentication
	_KVM_ARM_VCPU_PTRAUTH_GENERIC = 6 // vCPU uses generic authentication
)

// Arm64: Exception Syndrome Register EL1.
const (
	_ESR_ELx_EC_SHIFT = 26
	_ESR_ELx_EC_MASK  = 0x3F << _ESR_ELx_EC_SHIFT

	_ESR_ELx_EC_IMP_DEF  = 0x1f
	_ESR_ELx_EC_IABT_LOW = 0x20
	_ESR_ELx_EC_IABT_CUR = 0x21
	_ESR_ELx_EC_PC_ALIGN = 0x22

	_ESR_ELx_CM  = 1 << 8
	_ESR_ELx_WNR = 1 << 6

	_ESR_ELx_FSC = 0x3F

	_ESR_SEGV_MAPERR_L0 = 0x4
	_ESR_SEGV_MAPERR_L1 = 0x5
	_ESR_SEGV_MAPERR_L2 = 0x6
	_ESR_SEGV_MAPERR_L3 = 0x7

	_ESR_SEGV_ACCERR_L1 = 0x9
	_ESR_SEGV_ACCERR_L2 = 0xa
	_ESR_SEGV_ACCERR_L3 = 0xb

	_ESR_SEGV_PEMERR_L1 = 0xd
	_ESR_SEGV_PEMERR_L2 = 0xe
	_ESR_SEGV_PEMERR_L3 = 0xf

	// Custom ISS field definitions for system error.
	_ESR_ELx_SERR_NMI = 0x1
)

// Arm64: MMIO base address used to dispatch hypercalls.
const (
	// on Arm64, the MMIO address must be 64-bit aligned.
	// Currently, we only need 1 hypercall: hypercall_vmexit.
	_AARCH64_HYPERCALL_MMIO_SIZE = 1 << 3
)