ENCODEKEY128 instruction (Key Locker)

Forms

Every encoding of ENCODEKEY128 that Intel XED knows, one row per XED instruction form (iform). How to read the notation.

Instruction	Encoding	Requires
`ENCODEKEY128 r32, r32` ENCODEKEY128_GPR32u8_GPR32u8	`F3 0F 38 FA /r`	KL + KLENABLED

Latency and throughput

What the scheduling models of LLVM 23.1.2 give for each form, not measurements: latency / reciprocal throughput in cycles, the ports under them. A row is a model, or models that agree; a dash, a form that its processors lack. Memory forms: latency from the address, ports without the load and store units. Which processors each model covers.

Model	`r32, r32`
Alder Lake	100 / 0.25p0156

Operation

What the forms do, in pseudocode that our tests run against results recorded on real processors. How to read.

if not cr4 >> 19 & 1:            # CR4.KL; clear without Key Locker
    fault(UD)
if not cpuid_leaf(0x19, 0)[1] & 1:
    fault(UD)                    # AESKLE: the AES instructions of
                                 # Key Locker not enabled
if cr0 >> 2 & 1 or not cr4 >> 9 & 1:
    fault(UD)                    # CR0.EM set, CR4.OSFXSR clear
if cr0 >> 3 & 1:
    fault(NM)                    # CR0.TS
r = src.read()                   # restrictions in bits 2:0: CPL 0
                                 # only, no encrypting, no decrypting
can = cpuid_leaf(0x19, 0)[0] & 7 # those the processor supports
if r & ~can:
    fault(GP, 0)                 # any other bit set
h = wrap_key(xmm[0], r)          # metadata: r, key type 0 (AES-128)
                                 # in bits 27:24
dest.write(iwkey >> 384 & 0x1F)  # NoBackup in bit 0, KeySource 4:1
xmm[0] = r                       # the handle: the metadata,
xmm[1] = low(h, 128)             # the integrity tag,
xmm[2] = h >> 128                # the encrypted key
xmm[4] = 0                       # bits 127:0 of each; the manual
xmm[5] = 0                       # says nothing of the bits above
xmm[6] = 0
of = sf = zf = af = pf = cf = 0

Run on AMD Zen 5 (EPYC 9645): 2 cases. Its cases ran where CPUID reported no Key Locker, and every one raised an exception.

Operands

What each form reads and writes, as Intel XED records it: the operands of its syntax, in order, and the implicit ones that the syntax does not name. How to read.

Operand	Kind	Action
`ENCODEKEY128 r32, r32`
`r32`	explicit	write
`r32`	explicit	read
`XMM0`	implicit	read, write
`XMM1`	implicit	write
`XMM2`	implicit	write
`XMM4`	implicit	write
`XMM5`	implicit	write
`XMM6`	implicit	write
`RFLAGS`	implicit	write

Flags

0 cleared; blank: not affected. How to read.

OF	SF	ZF	AF	PF	CF
All forms
0	0	0	0	0	0

CPUID and processors

Each form belongs to an XED ISA set. A form can be used when the processor reports every CPUID bit of one of its ISA set's alternatives.

CPUID requirements and processors of the XED ISA sets above. Alternatives are separated by “or”; processors follow XED’s chip model, whose AMD processors end with Zen 2, and the CPU data of this site for Zen 3 to Zen 6.

ISA set	CPUID	Processors
`KEYLOCKER` Key Locker	KL + KLENABLED `CPUID.(EAX=07H,ECX=0):ECX[23]` KL `CPUID.(EAX=19H,ECX=0):EBX[0]` KLENABLED	Tiger Lake, Alder Lake, Arrow Lake, Panther Lake, Nova Lake, Sierra Forest, Clearwater Forest

ENCODEKEY128