Expand description
Declarations for the C API for the XLS dynamic shared object.
Structs§
- CBits
Rope - CDslx
Array Type Annotation - CDslx
Attribute - CDslx
Call Graph - CDslx
Colon Ref - CDslx
Constant Def - CDslx
Enum Def - CDslx
Enum Member - CDslx
Expr - CDslx
Function - CDslx
Import - CDslx
Import Data - CDslx
Interp Value - CDslx
Invocation - CDslx
Invocation Callee Data - CDslx
Invocation Callee Data Array - CDslx
Invocation Data - CDslx
Invocation Rewrite Rule - CDslx
Module - CDslx
Module Member - CDslx
Param - CDslx
Parametric Binding - CDslx
Parametric Env - CDslx
Quickcheck - CDslx
Struct Def - CDslx
Struct Member - CDslx
SumDef - CDslx
Type - CDslx
Type Alias - CDslx
Type Annotation - CDslx
Type Definition - CDslx
Type Dim - CDslx
Type Info - CDslx
Type Ref - CDslx
Type RefType Annotation - CDslx
Typechecked Module - CIrAnalysis
- CIrBits
- CIrFunction
- CIrFunction
Base - CIrFunction
Jit - CIrFunction
Type - CIrInterval
Set - CIrPackage
- CIrType
- CIrValue
- CSchedule
AndCodegen Result - CTrace
Message - CXls
AotExec Context - Opaque context for the libxls AOT C API.
- XlsDslx
Function Specialization Request - XlsDslx
Parametric EnvItem - XlsIr
Analysis Options
Constants§
- DSLX_
STDLIB_ PATH - XLS_
CALLING_ CONVENTION_ IMPLICIT_ TOKEN - XLS_
CALLING_ CONVENTION_ PROC_ NEXT - XLS_
CALLING_ CONVENTION_ TYPICAL - XLS_
DSLX_ ATTRIBUTE_ ARGUMENT_ KIND_ INT_ KEY_ VALUE - XLS_
DSLX_ ATTRIBUTE_ ARGUMENT_ KIND_ STRING - XLS_
DSLX_ ATTRIBUTE_ ARGUMENT_ KIND_ STRING_ KEY_ VALUE - XLS_
DSLX_ ATTRIBUTE_ ARGUMENT_ KIND_ STRING_ LITERAL - XLS_
DSLX_ ATTRIBUTE_ KIND_ CFG - XLS_
DSLX_ ATTRIBUTE_ KIND_ DSLX_ FORMAT_ DISABLE - XLS_
DSLX_ ATTRIBUTE_ KIND_ EXTERN_ VERILOG - XLS_
DSLX_ ATTRIBUTE_ KIND_ QUICKCHECK - XLS_
DSLX_ ATTRIBUTE_ KIND_ SV_ TYPE - XLS_
DSLX_ ATTRIBUTE_ KIND_ TEST - XLS_
DSLX_ ATTRIBUTE_ KIND_ TEST_ PROC - XLS_
DSO_ PATH - Path describing where the libxls shared library was materialized.
- XLS_
IR_ ANALYSIS_ LEVEL_ FAST - XLS_
IR_ ANALYSIS_ LEVEL_ RANGE_ WITH_ CONTEXT
Functions§
- xls_
aot_ ⚠compile_ function - xls_
aot_ ⚠entrypoint_ trampoline - xls_
aot_ ⚠entrypoints_ proto_ free - xls_
aot_ ⚠exec_ context_ clear_ events - xls_
aot_ ⚠exec_ context_ create - xls_
aot_ ⚠exec_ context_ free - xls_
aot_ ⚠exec_ context_ get_ assert_ message - xls_
aot_ ⚠exec_ context_ get_ trace_ message - xls_
aot_ ⚠object_ code_ free - xls_
bits_ ⚠abs - xls_
bits_ ⚠add - xls_
bits_ ⚠and - xls_
bits_ ⚠eq - xls_
bits_ ⚠free - xls_
bits_ ⚠get_ bit - xls_
bits_ ⚠get_ bit_ count - xls_
bits_ ⚠make_ bits_ from_ bytes - xls_
bits_ ⚠make_ sbits - xls_
bits_ ⚠make_ ubits - xls_
bits_ ⚠ne - xls_
bits_ ⚠negate - xls_
bits_ ⚠not - xls_
bits_ ⚠or - xls_
bits_ ⚠rope_ append_ bits - xls_
bits_ ⚠rope_ free - xls_
bits_ ⚠rope_ get_ bits - xls_
bits_ ⚠sdiv - xls_
bits_ ⚠sge - xls_
bits_ ⚠sgt - xls_
bits_ ⚠shift_ left_ logical - xls_
bits_ ⚠shift_ right_ arithmetic - xls_
bits_ ⚠shift_ right_ logical - xls_
bits_ ⚠sle - xls_
bits_ ⚠slt - xls_
bits_ ⚠smod - xls_
bits_ ⚠smul - xls_
bits_ ⚠sub - xls_
bits_ ⚠to_ bytes - xls_
bits_ ⚠to_ debug_ string - xls_
bits_ ⚠to_ int64 - xls_
bits_ ⚠to_ string - xls_
bits_ ⚠to_ uint64 - xls_
bits_ ⚠udiv - xls_
bits_ ⚠uge - xls_
bits_ ⚠ugt - xls_
bits_ ⚠ule - xls_
bits_ ⚠ult - xls_
bits_ ⚠umod - xls_
bits_ ⚠umul - xls_
bits_ ⚠width_ slice - xls_
bits_ ⚠xor - xls_
bytes_ ⚠free - xls_
c_ ⚠str_ free - xls_
c_ ⚠strs_ free - xls_
convert_ ⚠dslx_ path_ to_ ir - xls_
convert_ ⚠dslx_ path_ to_ ir_ with_ warnings - xls_
convert_ ⚠dslx_ to_ ir - xls_
convert_ ⚠dslx_ to_ ir_ with_ warnings - xls_
create_ ⚠bits_ rope - xls_
dslx_ ⚠array_ type_ annotation_ get_ element_ type - xls_
dslx_ ⚠attribute_ get_ argument_ count - xls_
dslx_ ⚠attribute_ get_ argument_ kind - xls_
dslx_ ⚠attribute_ get_ key_ value_ argument_ key - xls_
dslx_ ⚠attribute_ get_ key_ value_ int_ argument_ value - xls_
dslx_ ⚠attribute_ get_ key_ value_ string_ argument_ value - xls_
dslx_ ⚠attribute_ get_ kind - xls_
dslx_ ⚠attribute_ get_ string_ argument - xls_
dslx_ ⚠attribute_ get_ string_ literal_ argument - xls_
dslx_ ⚠attribute_ to_ string - xls_
dslx_ ⚠call_ graph_ free - xls_
dslx_ ⚠call_ graph_ get_ callee_ count - xls_
dslx_ ⚠call_ graph_ get_ callee_ function - xls_
dslx_ ⚠call_ graph_ get_ function - xls_
dslx_ ⚠call_ graph_ get_ function_ count - xls_
dslx_ ⚠colon_ ref_ get_ attr - xls_
dslx_ ⚠colon_ ref_ resolve_ import_ subject - xls_
dslx_ ⚠constant_ def_ get_ name - xls_
dslx_ ⚠constant_ def_ get_ value - xls_
dslx_ ⚠constant_ def_ to_ string - xls_
dslx_ ⚠enum_ def_ get_ identifier - xls_
dslx_ ⚠enum_ def_ get_ member - xls_
dslx_ ⚠enum_ def_ get_ member_ count - xls_
dslx_ ⚠enum_ def_ get_ underlying - xls_
dslx_ ⚠enum_ def_ to_ string - xls_
dslx_ ⚠enum_ member_ get_ name - xls_
dslx_ ⚠enum_ member_ get_ value - xls_
dslx_ ⚠expr_ get_ owner_ module - xls_
dslx_ ⚠expr_ to_ string - xls_
dslx_ ⚠function_ get_ attribute - xls_
dslx_ ⚠function_ get_ attribute_ count - xls_
dslx_ ⚠function_ get_ body - xls_
dslx_ ⚠function_ get_ identifier - xls_
dslx_ ⚠function_ get_ param - xls_
dslx_ ⚠function_ get_ param_ count - xls_
dslx_ ⚠function_ get_ parametric_ binding - xls_
dslx_ ⚠function_ get_ parametric_ binding_ count - xls_
dslx_ ⚠function_ get_ return_ type - xls_
dslx_ ⚠function_ is_ parametric - xls_
dslx_ ⚠function_ is_ public - xls_
dslx_ ⚠function_ to_ string - xls_
dslx_ ⚠import_ data_ create - xls_
dslx_ ⚠import_ data_ free - xls_
dslx_ ⚠import_ get_ subject - xls_
dslx_ ⚠import_ get_ subject_ count - xls_
dslx_ ⚠interp_ value_ clone - xls_
dslx_ ⚠interp_ value_ convert_ to_ ir - xls_
dslx_ ⚠interp_ value_ free - xls_
dslx_ ⚠interp_ value_ from_ string - xls_
dslx_ ⚠interp_ value_ make_ array - xls_
dslx_ ⚠interp_ value_ make_ enum - xls_
dslx_ ⚠interp_ value_ make_ sbits - xls_
dslx_ ⚠interp_ value_ make_ tuple - xls_
dslx_ ⚠interp_ value_ make_ ubits - xls_
dslx_ ⚠interp_ value_ to_ string - xls_
dslx_ ⚠invocation_ callee_ data_ array_ free - xls_
dslx_ ⚠invocation_ callee_ data_ array_ get - xls_
dslx_ ⚠invocation_ callee_ data_ array_ get_ count - xls_
dslx_ ⚠invocation_ callee_ data_ clone - xls_
dslx_ ⚠invocation_ callee_ data_ free - xls_
dslx_ ⚠invocation_ callee_ data_ get_ callee_ bindings - xls_
dslx_ ⚠invocation_ callee_ data_ get_ caller_ bindings - xls_
dslx_ ⚠invocation_ callee_ data_ get_ derived_ type_ info - xls_
dslx_ ⚠invocation_ callee_ data_ get_ invocation - xls_
dslx_ ⚠invocation_ data_ get_ callee - xls_
dslx_ ⚠invocation_ data_ get_ caller - xls_
dslx_ ⚠invocation_ data_ get_ invocation - xls_
dslx_ ⚠module_ get_ member - xls_
dslx_ ⚠module_ get_ member_ count - xls_
dslx_ ⚠module_ get_ name - xls_
dslx_ ⚠module_ get_ type_ definition_ as_ enum_ def - xls_
dslx_ ⚠module_ get_ type_ definition_ as_ struct_ def - xls_
dslx_ ⚠module_ get_ type_ definition_ as_ sum_ def - xls_
dslx_ ⚠module_ get_ type_ definition_ as_ type_ alias - xls_
dslx_ ⚠module_ get_ type_ definition_ count - xls_
dslx_ ⚠module_ get_ type_ definition_ kind - xls_
dslx_ ⚠module_ member_ from_ constant_ def - xls_
dslx_ ⚠module_ member_ from_ enum_ def - xls_
dslx_ ⚠module_ member_ from_ function - xls_
dslx_ ⚠module_ member_ from_ quickcheck - xls_
dslx_ ⚠module_ member_ from_ struct_ def - xls_
dslx_ ⚠module_ member_ from_ sum_ def - xls_
dslx_ ⚠module_ member_ from_ type_ alias - xls_
dslx_ ⚠module_ member_ get_ constant_ def - xls_
dslx_ ⚠module_ member_ get_ enum_ def - xls_
dslx_ ⚠module_ member_ get_ function - xls_
dslx_ ⚠module_ member_ get_ import - xls_
dslx_ ⚠module_ member_ get_ kind - xls_
dslx_ ⚠module_ member_ get_ quickcheck - xls_
dslx_ ⚠module_ member_ get_ struct_ def - xls_
dslx_ ⚠module_ member_ get_ sum_ def - xls_
dslx_ ⚠module_ member_ get_ type_ alias - xls_
dslx_ ⚠module_ to_ string - xls_
dslx_ ⚠param_ get_ name - xls_
dslx_ ⚠param_ get_ type_ annotation - xls_
dslx_ ⚠parametric_ binding_ get_ default_ generic_ type - xls_
dslx_ ⚠parametric_ binding_ get_ expr - xls_
dslx_ ⚠parametric_ binding_ get_ identifier - xls_
dslx_ ⚠parametric_ binding_ get_ type_ annotation - xls_
dslx_ ⚠parametric_ env_ clone - xls_
dslx_ ⚠parametric_ env_ create - xls_
dslx_ ⚠parametric_ env_ equals - xls_
dslx_ ⚠parametric_ env_ free - xls_
dslx_ ⚠parametric_ env_ get_ binding_ count - xls_
dslx_ ⚠parametric_ env_ get_ binding_ identifier - xls_
dslx_ ⚠parametric_ env_ get_ binding_ value - xls_
dslx_ ⚠parametric_ env_ hash - xls_
dslx_ ⚠parametric_ env_ less_ than - xls_
dslx_ ⚠parametric_ env_ to_ string - xls_
dslx_ ⚠parse_ and_ typecheck - xls_
dslx_ ⚠quickcheck_ get_ count - Retrieves the test-case count for the Quickcheck. Returns true and sets
*result_outwhen the Quickcheck has a counted test-case specifier; returns false when the Quickcheck is marked exhaustive (in which case*result_outis not modified). - xls_
dslx_ ⚠quickcheck_ get_ function - xls_
dslx_ ⚠quickcheck_ is_ exhaustive - Returns true iff the Quickcheck has the
exhaustivetest-cases specifier. - xls_
dslx_ ⚠quickcheck_ to_ string - xls_
dslx_ ⚠replace_ invocations_ in_ module - xls_
dslx_ ⚠struct_ def_ get_ identifier - xls_
dslx_ ⚠struct_ def_ get_ member - xls_
dslx_ ⚠struct_ def_ get_ member_ count - xls_
dslx_ ⚠struct_ def_ get_ parametric_ binding - xls_
dslx_ ⚠struct_ def_ get_ parametric_ binding_ count - xls_
dslx_ ⚠struct_ def_ is_ parametric - xls_
dslx_ ⚠struct_ def_ to_ string - xls_
dslx_ ⚠struct_ member_ get_ name - xls_
dslx_ ⚠struct_ member_ get_ type - xls_
dslx_ ⚠sum_ def_ get_ identifier - xls_
dslx_ ⚠sum_ def_ get_ variant_ count - xls_
dslx_ ⚠sum_ def_ is_ parametric - xls_
dslx_ ⚠sum_ def_ to_ string - xls_
dslx_ ⚠type_ alias_ get_ identifier - xls_
dslx_ ⚠type_ alias_ get_ type_ annotation - xls_
dslx_ ⚠type_ alias_ to_ string - xls_
dslx_ ⚠type_ annotation_ get_ array_ type_ annotation - xls_
dslx_ ⚠type_ annotation_ get_ type_ ref_ type_ annotation - xls_
dslx_ ⚠type_ array_ get_ element_ type - xls_
dslx_ ⚠type_ array_ get_ size - xls_
dslx_ ⚠type_ definition_ get_ colon_ ref - xls_
dslx_ ⚠type_ definition_ get_ type_ alias - xls_
dslx_ ⚠type_ dim_ free - xls_
dslx_ ⚠type_ dim_ get_ as_ bool - xls_
dslx_ ⚠type_ dim_ get_ as_ int64 - xls_
dslx_ ⚠type_ dim_ is_ parametric - xls_
dslx_ ⚠type_ get_ enum_ def - xls_
dslx_ ⚠type_ get_ struct_ def - xls_
dslx_ ⚠type_ get_ total_ bit_ count - xls_
dslx_ ⚠type_ info_ build_ function_ call_ graph - xls_
dslx_ ⚠type_ info_ build_ function_ call_ graph_ for_ module - xls_
dslx_ ⚠type_ info_ get_ all_ invocation_ callee_ data - xls_
dslx_ ⚠type_ info_ get_ const_ expr - xls_
dslx_ ⚠type_ info_ get_ imported_ type_ info - xls_
dslx_ ⚠type_ info_ get_ requires_ implicit_ token - xls_
dslx_ ⚠type_ info_ get_ root_ invocation_ data - xls_
dslx_ ⚠type_ info_ get_ type_ constant_ def - xls_
dslx_ ⚠type_ info_ get_ type_ enum_ def - xls_
dslx_ ⚠type_ info_ get_ type_ struct_ def - xls_
dslx_ ⚠type_ info_ get_ type_ struct_ member - xls_
dslx_ ⚠type_ info_ get_ type_ sum_ def - xls_
dslx_ ⚠type_ info_ get_ type_ type_ annotation - Gets the concrete type for a TypeAnnotation AST node.
- xls_
dslx_ ⚠type_ info_ get_ unique_ invocation_ callee_ data - xls_
dslx_ ⚠type_ is_ array - xls_
dslx_ ⚠type_ is_ bits_ like - xls_
dslx_ ⚠type_ is_ enum - xls_
dslx_ ⚠type_ is_ signed_ bits - xls_
dslx_ ⚠type_ is_ struct - xls_
dslx_ ⚠type_ ref_ get_ type_ definition - xls_
dslx_ ⚠type_ ref_ type_ annotation_ get_ parametric_ count - xls_
dslx_ ⚠type_ ref_ type_ annotation_ get_ parametric_ expr - xls_
dslx_ ⚠type_ ref_ type_ annotation_ get_ type_ ref - xls_
dslx_ ⚠type_ struct_ get_ member_ count - xls_
dslx_ ⚠type_ struct_ get_ member_ type - xls_
dslx_ ⚠type_ to_ string - xls_
dslx_ ⚠typechecked_ module_ clone_ removing_ functions - xls_
dslx_ ⚠typechecked_ module_ clone_ removing_ members - xls_
dslx_ ⚠typechecked_ module_ free - xls_
dslx_ ⚠typechecked_ module_ get_ module - xls_
dslx_ ⚠typechecked_ module_ get_ type_ info - xls_
dslx_ ⚠typechecked_ module_ insert_ function_ specializations - xls_
format_ ⚠preference_ from_ string - xls_
function_ ⚠get_ name - xls_
function_ ⚠get_ param_ name - xls_
function_ ⚠get_ type - xls_
function_ ⚠jit_ free - xls_
function_ ⚠jit_ run - xls_
function_ ⚠ptr_ array_ free - xls_
function_ ⚠to_ string - xls_
function_ ⚠to_ z3_ smtlib - xls_
function_ ⚠type_ get_ param_ count - xls_
function_ ⚠type_ get_ param_ type - xls_
function_ ⚠type_ get_ return_ type - xls_
function_ ⚠type_ to_ string - xls_
init_ ⚠xls - xls_
interpret_ ⚠function - xls_
interval_ ⚠set_ free - xls_
interval_ ⚠set_ get_ interval_ bounds - xls_
interval_ ⚠set_ get_ interval_ count - xls_
ir_ ⚠analysis_ at_ least_ one_ bit_ true - xls_
ir_ ⚠analysis_ at_ most_ one_ bit_ true - xls_
ir_ ⚠analysis_ create_ from_ package - xls_
ir_ ⚠analysis_ create_ from_ package_ with_ options - xls_
ir_ ⚠analysis_ exactly_ one_ bit_ true - xls_
ir_ ⚠analysis_ free - xls_
ir_ ⚠analysis_ get_ intervals_ for_ node_ id - xls_
ir_ ⚠analysis_ get_ known_ bits_ for_ node_ id - xls_
ir_ ⚠analysis_ implies - xls_
ir_ ⚠analysis_ known_ not_ equals - xls_
make_ ⚠function_ jit - xls_
mangle_ ⚠dslx_ name - xls_
mangle_ ⚠dslx_ name_ full - xls_
optimize_ ⚠ir - xls_
package_ ⚠create - xls_
package_ ⚠free - xls_
package_ ⚠get_ array_ type - xls_
package_ ⚠get_ bits_ type - xls_
package_ ⚠get_ function - xls_
package_ ⚠get_ functions - xls_
package_ ⚠get_ token_ type - xls_
package_ ⚠get_ top - xls_
package_ ⚠get_ tuple_ type - xls_
package_ ⚠get_ type_ for_ value - xls_
package_ ⚠set_ top_ by_ name - xls_
package_ ⚠to_ string - xls_
parse_ ⚠ir_ package - xls_
parse_ ⚠typed_ value - xls_
schedule_ ⚠and_ codegen_ package - xls_
schedule_ ⚠and_ codegen_ result_ free - xls_
schedule_ ⚠and_ codegen_ result_ get_ verilog_ text - xls_
trace_ ⚠messages_ free - xls_
type_ ⚠get_ flat_ bit_ count - xls_
type_ ⚠get_ kind - xls_
type_ ⚠get_ leaf_ count - xls_
type_ ⚠to_ string - xls_
value_ ⚠clone - xls_
value_ ⚠eq - xls_
value_ ⚠flatten_ to_ bits - xls_
value_ ⚠free - xls_
value_ ⚠from_ bits - xls_
value_ ⚠from_ bits_ owned - xls_
value_ ⚠get_ bits - xls_
value_ ⚠get_ element - xls_
value_ ⚠get_ element_ count - xls_
value_ ⚠get_ kind - xls_
value_ ⚠make_ array - Returns an error:
- xls_
value_ ⚠make_ false - xls_
value_ ⚠make_ sbits - xls_
value_ ⚠make_ token - xls_
value_ ⚠make_ true - xls_
value_ ⚠make_ tuple - xls_
value_ ⚠make_ ubits - xls_
value_ ⚠to_ string - xls_
value_ ⚠to_ string_ format_ preference - xls_
verify_ ⚠package