# Machine Integers¶

Kind2 supports both signed and unsigned versions of C-style machine integers of width 8, 16, 32, and 64.

## Declarations¶

Machine integer variables can be declared as global, local, or as input/ouput of nodes. Signed machine integers are declared as type `intN` and unsigned machine integers are declared as type `uintN` where N is the width (8, 16, 32, or 64).

The following

```x : uint8;
y : int16;
```

declares a variable `x` of type unsigned machine integer of width 8, and variable `y` of type signed machine integer of width 16.

## Values¶

Machine integers values can be constructed using implicit conversion functions applied to integer literals. The implicit conversion functions are of the form `uintN` for unsigned machine integers and `intN` for signed machine integers.

The following

```x = uint8 27;
y = int16 -5012;
```

defines `x` to have value `27`, and `y` to have value `-5012`, given that `x` is a variable of type `uint8` and `y` is a variable of type `int16`.

## Semantics¶

Machine integers of width `x` represent binary numbers of size `x`. Signed machine integers are represented using 2’s complement.

The bounds of machine integers are specified here for convenience:

```uint8  : 0 to 255
uint16 : 0 to 65535
uint32 : 0 to 4294967295
uint64 : 0 to 18446744073709551615
int8   : -128 to 127
int16  : -32768 to 32767
int32  : -2147483648 to 2147483647
int64  : -9223372036854775808 to 9223372036854775807
```

When the conversion functions are used for literals that are out of this range, they are converted to a machine integer that is in range using the modulo operation, as in C. For instance, in the following

```x = uint8 256;
y = int16 32768;
```

`x` evaluates to `0` and `y` to `-3268`, given that `x` is a variable of type `uint8` and `y` is a variable of type `int16`.

Conversions are allowed between machine integers of different widths, as long as both types are either signed or unsigned. Values remain unchanged when converted from a smaller to a larger width; values are adjusted modulo the range of the destination type when converted from larger to smaller width. The following code illustrates this.

```a : int8;
b : int16;
c : uint16;
d : uint8;
a = int8 120;
b = int16 a; -- b == int16 120
c = uint16 300;
d = uint8 c; -- c == uint8 44
```

## Operations¶

Kind2 allows the following operations over the machine integer types.

### Arithmetic Operations¶

Addition (`+`), subtraction (`-`), multiplication (`*`), division (`div`), modulo (`mod`), and unary negation (`-`) are allowed on either signed or unsigned machine integers, and return a machine integer with the same sign and same width as the input(s).

```a, a1, a2 : uint8;
b : uint16;
c : uint32;
d : uint64;
e, f : int8;
a1 = (uint8 5);
a2 = (uint8 22);
a = a1 + a2;
b = (uint16 20) * (uint16 200);
c = (uint32 500) div (uint32 5);
d = (uint64 25) mod (uint64 10);
e = (int8 -5) + (- (int8 10));
f = (int8 10) - (int8 -5);
```

### Logical Operations¶

Conjunction (`&&`), disjunction (`||`), and negation (`!`) are performed in a bitwise fashion over the binary equivalent of their machine integer inputs. Conjunction and disjunction are binary, while negation is unary. All 3 operations return a machine integer that has the same sign and same width as its input(s).

```a, b, b1, b2, c : uint8;
a = (uint8 0) && (uint8 45); --a = (uint8 0)
b1 = (uint8 255);
b2 = (uint8 45);
b = b1 && b2; --b = (uint8 45)
c = !(uint8 0); --c = (uint8 255)
```

### Shift Operations¶

Left shift (`lsh`) and right shift (`rsh`) operations are binary operations: the first input is either signed or unsigned, the second input is unsigned, and the sign of the output matches that of the first input; both inputs and the output have the same width.

Right shifting when the first operand is signed, results in an arithmetic right shift, where the bit shifted in matches the sign bit.

A left shift is equivalent to multiplication by 2, and a right shift is equivalent to division by 2, as long as the result can fit into the machine integer of the same width. In other words, the left shift operator shifts towards the most-significant bit and the right shift operator shifts towards the least-significant bit.

```a, b, c : bool;
a = (uint8 0) lsh (uint8 10) = (uint8 0); --true
b = (uint8 255) rsh (uint8 12) = (uint8 255); --true
c = (int8 -1) lsh (uint8 1) = (int8 -2); --true
```

### Comparison Operations¶

The following comparison operations are all binary: `>`, `<`, `>=`, `<=`, `=`. They input machine integers of the same size and sign, and output a boolean value.

```a : bool;
a = (int8 -12) < (int8 12); --true
```

## Limitations¶

Currently, only SMT solvers cvc5 and Z3 support logics that allows the usage of integers and machine integers together. To use any of the other supported SMT solvers, the Lustre input must contain only machine integers.

Moreover, the IC3QE engine requires either cvc5 or Z3, and the IC3IA engine requires MathSAT, cvc5, or Z3, to run on models with machine integers. If these requirements are not satisfied, Kind 2 runs with the corresponding IC3 model checking engine disabled.