Struct sunscreen_fhe_program::FheProgram

pub struct FheProgram {
    pub scheme: SchemeType,
    pub graph: StableGraph<NodeInfo, EdgeInfo>,
}

The intermediate representation for an FHE program used in the compiler back-end.

Other modules may transform these using the forward_traverse and reverse_traverse methods, or iterate over the graph member for analysis or execution.

The graph construction methods append_* take NodeIndex types as arguments. These indices must refer to other nodes in the graph.

Fields

scheme: SchemeType

The scheme type this FHE program will run under.

graph: StableGraph<NodeInfo, EdgeInfo>

The underlying dependency graph.

Implementations

impl FheProgram

pub fn new(scheme: SchemeType) -> Self

Create a new new empty intermediate representation.

pub fn render(&self) -> String

Write this graph into graphviz dot format. The returned string contains the file’s contents.

pub fn append_negate(&mut self, x: NodeIndex) -> NodeIndex

Appends a negate operation that depends on operand x.

pub fn append_multiply(&mut self, x: NodeIndex, y: NodeIndex) -> NodeIndex

Appends a multiply operation that depends on the operands x and y.

pub fn append_multiply_plaintext(
    &mut self,
    x: NodeIndex,
    y: NodeIndex
) -> NodeIndex

Appends a multiply operation that depends on the operands x and y.

pub fn append_add(&mut self, x: NodeIndex, y: NodeIndex) -> NodeIndex

Appends an add operation that depends on the operands x and y.

pub fn append_sub(&mut self, x: NodeIndex, y: NodeIndex) -> NodeIndex

Appends a subtract operation that depends on the operands x and y.

pub fn append_input_ciphertext(&mut self, id: usize) -> NodeIndex

Appends an input ciphertext with the given name.

pub fn append_input_plaintext(&mut self, id: usize) -> NodeIndex

Appends an input plaintext with the given name.

pub fn append_input_literal(&mut self, value: Literal) -> NodeIndex

Appends a constant literal unencrypted.

• value: The integer or floating-point value in the literal.

pub fn append_output_ciphertext(&mut self, x: NodeIndex) -> NodeIndex

Sppends a node designating x as an output of the FHE program.

pub fn append_relinearize(&mut self, x: NodeIndex) -> NodeIndex

Appends an operation that relinearizes x.

pub fn append_rotate_left(&mut self, x: NodeIndex, y: NodeIndex) -> NodeIndex

Appends an operation that rotates ciphertext x left by the literal node at y places.

Remarks

Recall that BFV has 2 rows in a Batched vector. This rotates each row. CKKS has one large vector.

pub fn append_rotate_right(&mut self, x: NodeIndex, y: NodeIndex) -> NodeIndex

Appends an operation that rotates ciphertext x right by the literal node at y places.

Remarks

Recall that BFV has 2 rows in a Batched vector. This rotates each row. CKKS has one large vector.

pub fn forward_traverse<F>(&mut self, callback: F)where
    F: FnMut(GraphQuery<'_>, NodeIndex) -> TransformList,

A specialized topological DAG traversal that allows the following graph mutations during traversal:

• Delete the current node
• Insert nodoes after current node
• Add new nodes with no dependencies

Any other graph mutation will likely result in unvisited nodes.

• callback: A closure that receives the current node index and an object allowing you to make graph queryes. This closure returns a transform list. forward_traverse will apply these transformations before continuing the traversal.

pub fn reverse_traverse<F>(&mut self, callback: F)where
    F: FnMut(GraphQuery<'_>, NodeIndex) -> TransformList,

A specialized reverse topological DAG traversal that allows the following graph mutations during traversal:

• Delete the current node
• Insert nodoes after current node
• Add new nodes with no dependencies

Any other graph mutation will likely result in unvisited nodes.

• callback: A closure that receives the current node index and an object allowing you to make graph queryes. This closure returns a transform list. reverse_traverse will apply these transformations before continuing the traversal.

pub fn remove_node(&mut self, id: NodeIndex)

Remove the given node.

pub fn get_outputs(&self) -> impl Iterator<Item = NodeIndex> + '_

Returns the node indices of output ciphertexts

pub fn num_inputs(&self) -> usize

Returns the number of inputs ciphertexts this FHE program takes.

pub fn prune(&self, nodes: &[NodeIndex]) -> FheProgram

Runs tree shaking and returns a derived FheProgram with only dependencies required to run the requested nodes.

• nodes: indices specifying a set of nodes in the graph. Prune return a new FheProgram containing nodes in the transitive closure of this set.

pub fn validate(&self) -> Result<()>

Validates this FheProgram for correctness.

pub fn requires_relin_keys(&self) -> bool

Whether or not this FHE program needs relin keys to run. Needed for relinearization.

pub fn requires_galois_keys(&self) -> bool

Whether or not this FHE program requires Galois keys to run. Needed for rotation and row swap operations.

Trait Implementations

impl Clone for FheProgram

fn clone(&self) -> FheProgram

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FheProgram

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FheProgram

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<FheProgram> for FheProgram

fn eq(&self, b: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FheProgram

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.