saymrwulf/pasta_curves-source
1
0
Fork 0
mirror of https://github.com/saymrwulf/pasta_curves-source.git synced 2026-09-04 20:03:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #199 from zcash/upstream-perm-struct

Browse source 
Upstream Permutation struct into plonk::circuit
This commit is contained in:
str4d 2021-02-26 04:24:00 +13:00 committed by GitHub
commit 87362e22d4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 152 additions and 147 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
benches/plonk.rs
View file

@ -20,7 +20,7 @@ fn bench_with_k(name: &str, k: u32, c: &mut Criterion) {
// Initialize the polynomial commitment parameters
let params: Params<EqAffine> = Params::new(k);
#[derive(Copy, Clone)]
#[derive(Clone)]
struct PLONKConfig {
a: Column<Advice>,
b: Column<Advice>,
@ -31,7 +31,7 @@ fn bench_with_k(name: &str, k: u32, c: &mut Criterion) {
sc: Column<Fixed>,
sm: Column<Fixed>,
perm: usize,
perm: Permutation,
}
trait StandardCS<FF: FieldExt> {
@ -156,21 +156,13 @@ fn bench_with_k(name: &str, k: u32, c: &mut Criterion) {
))
}
fn copy(&mut self, left: Variable, right: Variable) -> Result<(), Error> {
let left_column = match left.0 {
x if x == self.config.a => 0,
x if x == self.config.b => 1,
x if x == self.config.c => 2,
_ => unreachable!(),
};
let right_column = match right.0 {
x if x == self.config.a => 0,
x if x == self.config.b => 1,
x if x == self.config.c => 2,
_ => unreachable!(),
};
self.cs
.copy(self.config.perm, left_column, left.1, right_column, right.1)
self.cs.copy(
&self.config.perm,
left.0.into(),
left.1,
right.0.into(),
right.1,
)
}
}

34
examples/circuit-layout.rs
View file

@ -2,7 +2,7 @@ use halo2::{
arithmetic::FieldExt,
dev::circuit_layout,
pasta::Fp,
plonk::{Advice, Assignment, Circuit, Column, ConstraintSystem, Error, Fixed},
plonk::{Advice, Assignment, Circuit, Column, ConstraintSystem, Error, Fixed, Permutation},
poly::Rotation,
};
use plotters::prelude::*;
@ -30,8 +30,8 @@ fn main() {
sl: Column<Fixed>,
sl2: Column<Fixed>,
perm: usize,
perm2: usize,
perm: Permutation,
perm2: Permutation,
}
trait StandardCS<FF: FieldExt> {
@ -195,26 +195,18 @@ fn main() {
))
}
fn copy(&mut self, left: Variable, right: Variable) -> Result<(), Error> {
let left_column = match left.0 {
x if x == self.config.a => 0,
x if x == self.config.b => 1,
x if x == self.config.c => 2,
_ => unreachable!(),
};
let right_column = match right.0 {
x if x == self.config.a => 0,
x if x == self.config.b => 1,
x if x == self.config.c => 2,
_ => unreachable!(),
};
self.cs
.copy(self.config.perm, left_column, left.1, right_column, right.1)?;
self.cs.copy(
self.config.perm2,
left_column,
&self.config.perm,
left.0.into(),
left.1,
right_column,
right.0.into(),
right.1,
)?;
self.cs.copy(
&self.config.perm2,
left.0.into(),
left.1,
right.0.into(),
right.1,
)
}

26
examples/performance_model.rs
View file

@ -17,7 +17,7 @@ use std::marker::PhantomData;
#[derive(Copy, Clone, Debug)]
pub struct Variable(Column<Advice>, usize);
#[derive(Copy, Clone)]
#[derive(Clone)]
struct PLONKConfig {
a: Column<Advice>,
b: Column<Advice>,
@ -29,7 +29,7 @@ struct PLONKConfig {
sm: Column<Fixed>,
sp: Column<Fixed>,
perm: usize,
perm: Permutation,
}
trait StandardCS<FF: FieldExt> {
@ -157,21 +157,13 @@ impl<'a, FF: FieldExt, CS: Assignment<FF>> StandardCS<FF> for StandardPLONK<'a,
))
}
fn copy(&mut self, left: Variable, right: Variable) -> Result<(), Error> {
let left_column = match left.0 {
x if x == self.config.a => 0,
x if x == self.config.b => 1,
x if x == self.config.c => 2,
_ => unreachable!(),
};
let right_column = match right.0 {
x if x == self.config.a => 0,
x if x == self.config.b => 1,
x if x == self.config.c => 2,
_ => unreachable!(),
};
self.cs
.copy(self.config.perm, left_column, left.1, right_column, right.1)
self.cs.copy(
&self.config.perm,
left.0.into(),
left.1,
right.0.into(),
right.1,
)
}
fn public_input<F>(&mut self, f: F) -> Result<Variable, Error>
where

6
examples/simple-example.rs
View file

@ -4,9 +4,11 @@ use std::marker::PhantomData;
use halo2::{
arithmetic::FieldExt,
circuit::{layouter::SingleChip, Cell, Chip, Layouter, Permutation},
circuit::{layouter::SingleChip, Cell, Chip, Layouter},
dev::VerifyFailure,
plonk::{Advice, Assignment, Circuit, Column, ConstraintSystem, Error, Fixed, Instance},
plonk::{
Advice, Assignment, Circuit, Column, ConstraintSystem, Error, Fixed, Instance, Permutation,
},
poly::Rotation,
};

20
src/circuit.rs
View file

@ -4,7 +4,7 @@ use std::{fmt, marker::PhantomData};
use crate::{
arithmetic::FieldExt,
plonk::{Advice, Any, Column, ConstraintSystem, Error, Fixed},
plonk::{Advice, Any, Column, Error, Fixed, Permutation},
};
pub mod layouter;
@ -73,24 +73,6 @@ pub struct Cell {
column: Column<Any>,
}
/// A permutation configured by a chip.
#[derive(Clone, Debug)]
pub struct Permutation {
index: usize,
mapping: Vec<Column<Any>>,
}
impl Permutation {
/// Configures a new permutation for the given columns.
pub fn new<F: FieldExt>(meta: &mut ConstraintSystem<F>, columns: &[Column<Any>]) -> Self {
let index = meta.permutation(columns);
Permutation {
index,
mapping: columns.iter().copied().collect(),
}
}
}
/// A region of the circuit in which a [`Chip`] can assign cells.
///
/// Inside a region, the chip may freely use relative offsets; the [`Layouter`] will

21
src/circuit/layouter.rs
View file

@ -5,8 +5,8 @@ use std::collections::{HashMap, HashSet};
use std::fmt;
use std::marker::PhantomData;
use super::{Cell, Chip, Layouter, Permutation, Region, RegionIndex, RegionStart};
use crate::plonk::{Advice, Any, Assignment, Column, Error, Fixed};
use super::{Cell, Chip, Layouter, Region, RegionIndex, RegionStart};
use crate::plonk::{Advice, Any, Assignment, Column, Error, Fixed, Permutation};
/// Helper trait for implementing a custom [`Layouter`].
///
@ -320,22 +320,11 @@ impl<'r, 'a, C: Chip, CS: Assignment<C::Field> + 'a> RegionLayouter<C>
left: Cell,
right: Cell,
) -> Result<(), Error> {
let left_column = permutation
.mapping
.iter()
.position(|c| c == &left.column)
.ok_or(Error::SynthesisError)?;
let right_column = permutation
.mapping
.iter()
.position(|c| c == &right.column)
.ok_or(Error::SynthesisError)?;
self.layouter.cs.copy(
permutation.index,
left_column,
permutation,
left.column,
*self.layouter.regions[*left.region_index] + left.row_offset,
right_column,
right.column,
*self.layouter.regions[*right.region_index] + right.row_offset,
)?;

30
src/dev.rs
View file

@ -5,8 +5,8 @@ use ff::Field;
use crate::{
arithmetic::{FieldExt, Group},
plonk::{
permutation, Advice, Assignment, Circuit, Column, ColumnType, ConstraintSystem, Error,
Expression, Fixed,
permutation, Advice, Any, Assignment, Circuit, Column, ColumnType, ConstraintSystem, Error,
Expression, Fixed, Permutation,
},
poly::Rotation,
};
@ -211,18 +211,34 @@ impl<F: Field + Group> Assignment<F> for MockProver<F> {
fn copy(
&mut self,
permutation: usize,
left_column: usize,
permutation: &Permutation,
left_column: Column<Any>,
left_row: usize,
right_column: usize,
right_column: Column<Any>,
right_row: usize,
) -> Result<(), crate::plonk::Error> {
// Check bounds first
if permutation >= self.permutations.len() {
if permutation.index() >= self.permutations.len() {
return Err(Error::BoundsFailure);
}
self.permutations[permutation].copy(left_column, left_row, right_column, right_row)
let left_column_index = permutation
.mapping()
.iter()
.position(|c| c == &left_column)
.ok_or(Error::SynthesisError)?;
let right_column_index = permutation
.mapping()
.iter()
.position(|c| c == &right_column)
.ok_or(Error::SynthesisError)?;
self.permutations[permutation.index()].copy(
left_column_index,
left_row,
right_column_index,
right_row,
)
}
fn push_namespace<NR, N>(&mut self, _: N)

10
src/dev/graph.rs
View file

@ -1,7 +1,9 @@
use ff::Field;
use tabbycat::{AttrList, Edge, GraphBuilder, GraphType, Identity, StmtList};
use crate::plonk::{Advice, Assignment, Circuit, Column, ConstraintSystem, Error, Fixed};
use crate::plonk::{
Advice, Any, Assignment, Circuit, Column, ConstraintSystem, Error, Fixed, Permutation,
};
pub mod layout;
@ -118,10 +120,10 @@ impl<F: Field> Assignment<F> for Graph {
fn copy(
&mut self,
_: &Permutation,
_: Column<Any>,
_: usize,
_: usize,
_: usize,
_: usize,
_: Column<Any>,
_: usize,
) -> Result<(), crate::plonk::Error> {
// Do nothing; we don't care about permutations in this context.

10
src/dev/graph/layout.rs
View file

@ -6,7 +6,9 @@ use plotters::{
use std::cmp;
use std::collections::HashSet;
use crate::plonk::{Advice, Any, Assignment, Circuit, Column, ConstraintSystem, Error, Fixed};
use crate::plonk::{
Advice, Any, Assignment, Circuit, Column, ConstraintSystem, Error, Fixed, Permutation,
};
/// Renders the circuit layout on the given drawing area.
///
@ -251,10 +253,10 @@ impl<F: Field> Assignment<F> for Layout {
fn copy(
&mut self,
_: &Permutation,
_: Column<Any>,
_: usize,
_: usize,
_: usize,
_: usize,
_: Column<Any>,
_: usize,
) -> Result<(), crate::plonk::Error> {
// Do nothing; we don't care about permutations in this context.

34
src/plonk.rs
View file

@ -210,7 +210,7 @@ fn test_proving() {
// Initialize the polynomial commitment parameters
let params: Params<EqAffine> = Params::new(K);
#[derive(Copy, Clone)]
#[derive(Clone)]
struct PLONKConfig {
a: Column<Advice>,
b: Column<Advice>,
@ -226,8 +226,8 @@ fn test_proving() {
sl: Column<Fixed>,
sl2: Column<Fixed>,
perm: usize,
perm2: usize,
perm: Permutation,
perm2: Permutation,
}
trait StandardCS<FF: FieldExt> {
@ -380,26 +380,18 @@ fn test_proving() {
))
}
fn copy(&mut self, left: Variable, right: Variable) -> Result<(), Error> {
let left_column = match left.0 {
x if x == self.config.a => 0,
x if x == self.config.b => 1,
x if x == self.config.c => 2,
_ => unreachable!(),
};
let right_column = match right.0 {
x if x == self.config.a => 0,
x if x == self.config.b => 1,
x if x == self.config.c => 2,
_ => unreachable!(),
};
self.cs
.copy(self.config.perm, left_column, left.1, right_column, right.1)?;
self.cs.copy(
self.config.perm2,
left_column,
&self.config.perm,
left.0.into(),
left.1,
right_column,
right.0.into(),
right.1,
)?;
self.cs.copy(
&self.config.perm2,
left.0.into(),
left.1,
right.0.into(),
right.1,
)
}

42
src/plonk/circuit.rs
View file

@ -7,6 +7,7 @@ use std::{
};
use super::{lookup, permutation, Error};
use crate::arithmetic::FieldExt;
use crate::poly::Rotation;
/// A column type
@ -126,6 +127,30 @@ impl TryFrom<Column<Any>> for Column<Instance> {
}
}
/// A permutation.
#[derive(Clone, Debug)]
pub struct Permutation {
index: usize,
mapping: Vec<Column<Any>>,
}
impl Permutation {
/// Configures a new permutation for the given columns.
pub fn new<F: FieldExt>(meta: &mut ConstraintSystem<F>, columns: &[Column<Any>]) -> Self {
meta.permutation(columns)
}
/// Returns index of permutation
pub fn index(&self) -> usize {
self.index
}
/// Returns mapping of permutation
pub fn mapping(&self) -> &[Column<Any>] {
&self.mapping
}
}
/// This trait allows a [`Circuit`] to direct some backend to assign a witness
/// for a constraint system.
pub trait Assignment<F: Field> {
@ -176,13 +201,13 @@ pub trait Assignment<F: Field> {
A: FnOnce() -> AR,
AR: Into<String>;
/// Assign two advice columns to have the same value
/// Assign two cells to have the same value
fn copy(
&mut self,
permutation: usize,
left_column: usize,
permutation: &Permutation,
left_column: Column<Any>,
left_row: usize,
right_column: usize,
right_column: Column<Any>,
right_row: usize,
) -> Result<(), Error>;
@ -448,8 +473,8 @@ impl<F: Field> ConstraintSystem<F> {
}
}
/// Add a permutation argument for some advice columns
pub fn permutation(&mut self, columns: &[Column<Any>]) -> usize {
/// Add a permutation argument for some columns
pub fn permutation(&mut self, columns: &[Column<Any>]) -> Permutation {
let index = self.permutations.len();
for column in columns {
@ -458,7 +483,10 @@ impl<F: Field> ConstraintSystem<F> {
self.permutations
.push(permutation::Argument::new(columns.to_vec()));
index
Permutation {
index,
mapping: columns.to_vec(),
}
}
/// Add a lookup argument for some input expressions and table expressions.

30
src/plonk/keygen.rs
View file

@ -2,8 +2,8 @@ use ff::Field;
use group::Curve;
use super::{
circuit::{Advice, Assignment, Circuit, Column, ConstraintSystem, Fixed},
permutation, Error, LagrangeCoeff, Polynomial, ProvingKey, VerifyingKey,
circuit::{Advice, Any, Assignment, Circuit, Column, ConstraintSystem, Fixed},
permutation, Error, LagrangeCoeff, Permutation, Polynomial, ProvingKey, VerifyingKey,
};
use crate::arithmetic::CurveAffine;
use crate::poly::{
@ -116,18 +116,34 @@ impl<F: Field> Assignment<F> for Assembly<F> {
fn copy(
&mut self,
permutation: usize,
left_column: usize,
permutation: &Permutation,
left_column: Column<Any>,
left_row: usize,
right_column: usize,
right_column: Column<Any>,
right_row: usize,
) -> Result<(), Error> {
// Check bounds first
if permutation >= self.permutations.len() {
if permutation.index() >= self.permutations.len() {
return Err(Error::BoundsFailure);
}
self.permutations[permutation].copy(left_column, left_row, right_column, right_row)
let left_column_index = permutation
.mapping()
.iter()
.position(|c| c == &left_column)
.ok_or(Error::SynthesisError)?;
let right_column_index = permutation
.mapping()
.iter()
.position(|c| c == &right_column)
.ok_or(Error::SynthesisError)?;
self.permutations[permutation.index()].copy(
left_column_index,
left_row,
right_column_index,
right_row,
)
}
fn push_namespace<NR, N>(&mut self, _: N)

10
src/plonk/prover.rs
View file

@ -3,9 +3,9 @@ use group::Curve;
use std::iter;
use super::{
circuit::{Advice, Assignment, Circuit, Column, ConstraintSystem, Fixed},
circuit::{Advice, Any, Assignment, Circuit, Column, ConstraintSystem, Fixed},
lookup, permutation, vanishing, ChallengeBeta, ChallengeGamma, ChallengeTheta, ChallengeX,
ChallengeY, Error, ProvingKey,
ChallengeY, Error, Permutation, ProvingKey,
};
use crate::arithmetic::{eval_polynomial, CurveAffine, FieldExt};
use crate::poly::{
@ -159,10 +159,10 @@ pub fn create_proof<C: CurveAffine, T: TranscriptWrite<C>, ConcreteCircuit: Circ
fn copy(
&mut self,
_: &Permutation,
_: Column<Any>,
_: usize,
_: usize,
_: usize,
_: usize,
_: Column<Any>,
_: usize,
) -> Result<(), Error> {
// We only care about advice columns here