htmintrin.h revision 353358
1210284Sjmallett/*===---- htmintrin.h - Standard header for PowerPC HTM ---------------===*\ 2232812Sjmallett * 3215990Sjmallett * Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4210284Sjmallett * See https://llvm.org/LICENSE.txt for license information. 5210284Sjmallett * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6215990Sjmallett * 7215990Sjmallett\*===----------------------------------------------------------------------===*/ 8215990Sjmallett 9210284Sjmallett#ifndef __HTMINTRIN_H 10215990Sjmallett#define __HTMINTRIN_H 11215990Sjmallett 12210284Sjmallett#ifndef __HTM__ 13215990Sjmallett#error "HTM instruction set not enabled" 14215990Sjmallett#endif 15215990Sjmallett 16215990Sjmallett#ifdef __powerpc__ 17215990Sjmallett 18232812Sjmallett#include <stdint.h> 19215990Sjmallett 20215990Sjmalletttypedef uint64_t texasr_t; 21215990Sjmalletttypedef uint32_t texasru_t; 22215990Sjmalletttypedef uint32_t texasrl_t; 23215990Sjmalletttypedef uintptr_t tfiar_t; 24215990Sjmalletttypedef uintptr_t tfhar_t; 25215990Sjmallett 26215990Sjmallett#define _HTM_STATE(CR0) ((CR0 >> 1) & 0x3) 27215990Sjmallett#define _HTM_NONTRANSACTIONAL 0x0 28215990Sjmallett#define _HTM_SUSPENDED 0x1 29232812Sjmallett#define _HTM_TRANSACTIONAL 0x2 30215990Sjmallett 31215990Sjmallett#define _TEXASR_EXTRACT_BITS(TEXASR,BITNUM,SIZE) \ 32215990Sjmallett (((TEXASR) >> (63-(BITNUM))) & ((1<<(SIZE))-1)) 33215990Sjmallett#define _TEXASRU_EXTRACT_BITS(TEXASR,BITNUM,SIZE) \ 34215990Sjmallett (((TEXASR) >> (31-(BITNUM))) & ((1<<(SIZE))-1)) 35215990Sjmallett 36215990Sjmallett#define _TEXASR_FAILURE_CODE(TEXASR) \ 37215990Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 7, 8) 38210284Sjmallett#define _TEXASRU_FAILURE_CODE(TEXASRU) \ 39210284Sjmallett _TEXASRU_EXTRACT_BITS(TEXASRU, 7, 8) 40210284Sjmallett 41210284Sjmallett#define _TEXASR_FAILURE_PERSISTENT(TEXASR) \ 42210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 7, 1) 43210284Sjmallett#define _TEXASRU_FAILURE_PERSISTENT(TEXASRU) \ 44210284Sjmallett _TEXASRU_EXTRACT_BITS(TEXASRU, 7, 1) 45215990Sjmallett 46210284Sjmallett#define _TEXASR_DISALLOWED(TEXASR) \ 47210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 8, 1) 48210284Sjmallett#define _TEXASRU_DISALLOWED(TEXASRU) \ 49210284Sjmallett _TEXASRU_EXTRACT_BITS(TEXASRU, 8, 1) 50210284Sjmallett 51210284Sjmallett#define _TEXASR_NESTING_OVERFLOW(TEXASR) \ 52232812Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 9, 1) 53210284Sjmallett#define _TEXASRU_NESTING_OVERFLOW(TEXASRU) \ 54210284Sjmallett _TEXASRU_EXTRACT_BITS(TEXASRU, 9, 1) 55210284Sjmallett 56210284Sjmallett#define _TEXASR_FOOTPRINT_OVERFLOW(TEXASR) \ 57210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 10, 1) 58210284Sjmallett#define _TEXASRU_FOOTPRINT_OVERFLOW(TEXASRU) \ 59210284Sjmallett _TEXASRU_EXTRACT_BITS(TEXASRU, 10, 1) 60210284Sjmallett 61210284Sjmallett#define _TEXASR_SELF_INDUCED_CONFLICT(TEXASR) \ 62210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 11, 1) 63210284Sjmallett#define _TEXASRU_SELF_INDUCED_CONFLICT(TEXASRU) \ 64210284Sjmallett _TEXASRU_EXTRACT_BITS(TEXASRU, 11, 1) 65210284Sjmallett 66210284Sjmallett#define _TEXASR_NON_TRANSACTIONAL_CONFLICT(TEXASR) \ 67210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 12, 1) 68210284Sjmallett#define _TEXASRU_NON_TRANSACTIONAL_CONFLICT(TEXASRU) \ 69210284Sjmallett _TEXASRU_EXTRACT_BITS(TEXASRU, 12, 1) 70232812Sjmallett 71232812Sjmallett#define _TEXASR_TRANSACTION_CONFLICT(TEXASR) \ 72232812Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 13, 1) 73232812Sjmallett#define _TEXASRU_TRANSACTION_CONFLICT(TEXASRU) \ 74232812Sjmallett _TEXASRU_EXTRACT_BITS(TEXASRU, 13, 1) 75210284Sjmallett 76210284Sjmallett#define _TEXASR_TRANSLATION_INVALIDATION_CONFLICT(TEXASR) \ 77210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 14, 1) 78210284Sjmallett#define _TEXASRU_TRANSLATION_INVALIDATION_CONFLICT(TEXASRU) \ 79210284Sjmallett _TEXASRU_EXTRACT_BITS(TEXASRU, 14, 1) 80210284Sjmallett 81210284Sjmallett#define _TEXASR_IMPLEMENTAION_SPECIFIC(TEXASR) \ 82210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 15, 1) 83215990Sjmallett#define _TEXASRU_IMPLEMENTAION_SPECIFIC(TEXASRU) \ 84215990Sjmallett _TEXASRU_EXTRACT_BITS(TEXASRU, 15, 1) 85215990Sjmallett 86215990Sjmallett#define _TEXASR_INSTRUCTION_FETCH_CONFLICT(TEXASR) \ 87210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 16, 1) 88210284Sjmallett#define _TEXASRU_INSTRUCTION_FETCH_CONFLICT(TEXASRU) \ 89210284Sjmallett _TEXASRU_EXTRACT_BITS(TEXASRU, 16, 1) 90210284Sjmallett 91210284Sjmallett#define _TEXASR_ABORT(TEXASR) \ 92210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 31, 1) 93210284Sjmallett#define _TEXASRU_ABORT(TEXASRU) \ 94210284Sjmallett _TEXASRU_EXTRACT_BITS(TEXASRU, 31, 1) 95210284Sjmallett 96210284Sjmallett 97210284Sjmallett#define _TEXASR_SUSPENDED(TEXASR) \ 98210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 32, 1) 99210284Sjmallett 100210284Sjmallett#define _TEXASR_PRIVILEGE(TEXASR) \ 101210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 35, 2) 102210284Sjmallett 103215990Sjmallett#define _TEXASR_FAILURE_SUMMARY(TEXASR) \ 104210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 36, 1) 105215990Sjmallett 106210284Sjmallett#define _TEXASR_TFIAR_EXACT(TEXASR) \ 107210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 37, 1) 108210284Sjmallett 109210284Sjmallett#define _TEXASR_ROT(TEXASR) \ 110210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 38, 1) 111210284Sjmallett 112210284Sjmallett#define _TEXASR_TRANSACTION_LEVEL(TEXASR) \ 113210284Sjmallett _TEXASR_EXTRACT_BITS(TEXASR, 63, 12) 114210284Sjmallett 115210284Sjmallett#endif /* __powerpc */ 116210284Sjmallett 117210284Sjmallett#ifdef __s390__ 118210284Sjmallett 119210284Sjmallett/* Condition codes generated by tbegin */ 120210284Sjmallett#define _HTM_TBEGIN_STARTED 0 121210284Sjmallett#define _HTM_TBEGIN_INDETERMINATE 1 122210284Sjmallett#define _HTM_TBEGIN_TRANSIENT 2 123210284Sjmallett#define _HTM_TBEGIN_PERSISTENT 3 124215990Sjmallett 125210284Sjmallett/* The abort codes below this threshold are reserved for machine use. */ 126210284Sjmallett#define _HTM_FIRST_USER_ABORT_CODE 256 127210284Sjmallett 128210284Sjmallett/* The transaction diagnostic block is it is defined in the Principles 129210284Sjmallett of Operation chapter 5-91. */ 130210284Sjmallett 131210284Sjmallettstruct __htm_tdb { 132210284Sjmallett unsigned char format; /* 0 */ 133210284Sjmallett unsigned char flags; 134210284Sjmallett unsigned char reserved1[4]; 135210284Sjmallett unsigned short nesting_depth; 136210284Sjmallett unsigned long long abort_code; /* 8 */ 137210284Sjmallett unsigned long long conflict_token; /* 16 */ 138210284Sjmallett unsigned long long atia; /* 24 */ 139210284Sjmallett unsigned char eaid; /* 32 */ 140215990Sjmallett unsigned char dxc; 141210284Sjmallett unsigned char reserved2[2]; 142215990Sjmallett unsigned int program_int_id; 143210284Sjmallett unsigned long long exception_id; /* 40 */ 144210284Sjmallett unsigned long long bea; /* 48 */ 145210284Sjmallett unsigned char reserved3[72]; /* 56 */ 146210284Sjmallett unsigned long long gprs[16]; /* 128 */ 147210284Sjmallett} __attribute__((__packed__, __aligned__ (8))); 148210284Sjmallett 149210284Sjmallett 150210284Sjmallett/* Helper intrinsics to retry tbegin in case of transient failure. */ 151210284Sjmallett 152210284Sjmallettstatic __inline int __attribute__((__always_inline__, __nodebug__)) 153210284Sjmallett__builtin_tbegin_retry_null (int __retry) 154210284Sjmallett{ 155210284Sjmallett int cc, i = 0; 156210284Sjmallett 157210284Sjmallett while ((cc = __builtin_tbegin(0)) == _HTM_TBEGIN_TRANSIENT 158210284Sjmallett && i++ < __retry) 159210284Sjmallett __builtin_tx_assist(i); 160210284Sjmallett 161210284Sjmallett return cc; 162210284Sjmallett} 163215990Sjmallett 164210284Sjmallettstatic __inline int __attribute__((__always_inline__, __nodebug__)) 165215990Sjmallett__builtin_tbegin_retry_tdb (void *__tdb, int __retry) 166210284Sjmallett{ 167210284Sjmallett int cc, i = 0; 168210284Sjmallett 169210284Sjmallett while ((cc = __builtin_tbegin(__tdb)) == _HTM_TBEGIN_TRANSIENT 170210284Sjmallett && i++ < __retry) 171210284Sjmallett __builtin_tx_assist(i); 172210284Sjmallett 173210284Sjmallett return cc; 174210284Sjmallett} 175210284Sjmallett 176210284Sjmallett#define __builtin_tbegin_retry(tdb, retry) \ 177210284Sjmallett (__builtin_constant_p(tdb == 0) && tdb == 0 ? \ 178210284Sjmallett __builtin_tbegin_retry_null(retry) : \ 179210284Sjmallett __builtin_tbegin_retry_tdb(tdb, retry)) 180210284Sjmallett 181210284Sjmallettstatic __inline int __attribute__((__always_inline__, __nodebug__)) 182210284Sjmallett__builtin_tbegin_retry_nofloat_null (int __retry) 183210284Sjmallett{ 184210284Sjmallett int cc, i = 0; 185210284Sjmallett 186210284Sjmallett while ((cc = __builtin_tbegin_nofloat(0)) == _HTM_TBEGIN_TRANSIENT 187210284Sjmallett && i++ < __retry) 188210284Sjmallett __builtin_tx_assist(i); 189210284Sjmallett 190210284Sjmallett return cc; 191210284Sjmallett} 192210284Sjmallett 193210284Sjmallettstatic __inline int __attribute__((__always_inline__, __nodebug__)) 194210284Sjmallett__builtin_tbegin_retry_nofloat_tdb (void *__tdb, int __retry) 195210284Sjmallett{ 196210284Sjmallett int cc, i = 0; 197210284Sjmallett 198210284Sjmallett while ((cc = __builtin_tbegin_nofloat(__tdb)) == _HTM_TBEGIN_TRANSIENT 199210284Sjmallett && i++ < __retry) 200210284Sjmallett __builtin_tx_assist(i); 201210284Sjmallett 202210284Sjmallett return cc; 203210284Sjmallett} 204210284Sjmallett 205210284Sjmallett#define __builtin_tbegin_retry_nofloat(tdb, retry) \ 206210284Sjmallett (__builtin_constant_p(tdb == 0) && tdb == 0 ? \ 207210284Sjmallett __builtin_tbegin_retry_nofloat_null(retry) : \ 208215990Sjmallett __builtin_tbegin_retry_nofloat_tdb(tdb, retry)) 209210284Sjmallett 210210284Sjmallett#endif /* __s390__ */ 211215990Sjmallett 212210284Sjmallett#endif /* __HTMINTRIN_H */ 213210284Sjmallett