1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
use std::collections::BTreeMap;

use eth_types::Field;
use halo2_proofs::plonk::{Advice, Column, ConstraintSystem};

use super::cell_manager::{
    CellManagerColumns, CellPlacement, CellPlacementStrategy, CellPlacementValue, CellType,
};

#[derive(Clone, Debug, Default)]
pub(crate) struct CMFixedWidthStrategyDistribution(BTreeMap<CellType, Vec<Column<Advice>>>);

impl CMFixedWidthStrategyDistribution {
    pub(crate) fn add(&mut self, cell_type: CellType, advice: Column<Advice>) {
        if let Some(v) = self.0.get_mut(&cell_type) {
            v.push(advice);
        } else {
            self.0.insert(cell_type, vec![advice]);
        }
    }

    #[allow(dead_code, reason = "this method will be used outside tests")]
    pub(crate) fn get(&self, cell_type: CellType) -> Option<&Vec<Column<Advice>>> {
        self.0.get(&cell_type)
    }
}

/// CMFixedWidthStrategy is a Cell Placement strategy that places the cells in the column that has
/// less height for a given CellType.
/// When a cell is queried for a CellType the strategy will find the column of that Cell Type that
/// has a lower height and add it there.
#[derive(Clone, Debug)]
pub(crate) struct CMFixedWidthStrategy {
    advices: CMFixedWidthStrategyDistribution,
    height_offset: usize,

    next: BTreeMap<CellType, (usize, usize)>,

    perm_substitution: bool,
    max_height: usize,
}

impl CMFixedWidthStrategy {
    /// Creates a CMFixedWidthStrategy from a CMFixedWidthStrategyDistribution that contains advice
    /// columns categorized by Cell Type.
    /// The argument height_offset will be added to the rotation of the Cells, which is useful for a
    /// next step.
    pub fn new(
        advices: CMFixedWidthStrategyDistribution,
        height_offset: usize,
    ) -> CMFixedWidthStrategy {
        CMFixedWidthStrategy {
            advices,
            height_offset,
            next: BTreeMap::default(),
            perm_substitution: false,
            max_height: usize::max_value(),
        }
    }

    /// Enables the StoragePhase1 to StoragePermutation.
    /// When enabled if a  StoragePhase1 Cell is requested but the height would be lower if placed
    /// on a StoragePermutation column, then the StoragePermutation is used.
    pub fn with_perm_substitution(mut self) -> Self {
        self.perm_substitution = true;

        self
    }

    /// Sets a max height, if the strategy chooses a height that is over this, it will panic.
    pub fn with_max_height(mut self, max_height: usize) -> Self {
        self.max_height = max_height;

        self
    }

    fn get_next(&self, cell_type: &CellType) -> (usize, usize) {
        *self.next.get(cell_type).unwrap_or(&(0, 0))
    }

    fn set_next(&mut self, cell_type: &CellType, column_idx: usize, row: usize) {
        self.next.insert(*cell_type, (column_idx, row));
    }

    fn cells_used(&self, cell_type: &CellType, columns: &CellManagerColumns) -> usize {
        let (next_column_idx, next_row) = self.get_next(cell_type);
        let current_row = if next_column_idx == 0 {
            if next_row == 0 {
                return 0;
            }

            next_row - 1
        } else {
            next_row
        };

        let filled_rows_cells = if current_row == 0 {
            0
        } else {
            (current_row - 1) * columns.get_cell_type_width(*cell_type)
        };

        filled_rows_cells + next_column_idx
    }
}

impl CellPlacementStrategy for CMFixedWidthStrategy {
    type Stats = BTreeMap<CellType, (usize, usize, usize)>;
    type Affinity = ();

    fn on_creation(&mut self, columns: &mut CellManagerColumns) {
        for (cell_type, advices) in self.advices.0.iter() {
            for column in advices.iter() {
                columns.add_column(*cell_type, *column)
            }
        }
    }

    fn place_cell<F: Field>(
        &mut self,
        columns: &mut CellManagerColumns,
        meta: &mut ConstraintSystem<F>,
        cell_type: CellType,
    ) -> CellPlacement {
        let (mut column_idx, mut row) = self.get_next(&cell_type);
        if self.perm_substitution && cell_type == CellType::StoragePhase1 {
            let (_, row_perm) = self.get_next(&CellType::StoragePermutation);
            if row_perm < row {
                return self.place_cell(columns, meta, CellType::StoragePermutation);
            }
        }

        if row > self.max_height {
            panic!(
                "CMFixedWidthStrategy: max_height reached ({})",
                self.max_height
            )
        }

        let column = columns
            .get_column(cell_type, column_idx)
            .expect("column not found");
        let rotation = self.height_offset + row;
        let placement = CellPlacement {
            column: column.clone(),
            rotation,
        };

        column_idx += 1;
        if column_idx >= columns.get_cell_type_width(cell_type) {
            column_idx = 0;
            row += 1;
        }

        self.set_next(&cell_type, column_idx, row);

        placement
    }

    fn get_height(&self) -> usize {
        self.next
            .keys()
            .map(|cell_type| {
                let next = self.get_next(cell_type);
                if next.0 == 0 {
                    next.1
                } else {
                    next.1 + 1
                }
            })
            .max()
            .unwrap_or(0)
    }

    fn get_stats(&self, columns: &CellManagerColumns) -> Self::Stats {
        let mut data = BTreeMap::new();
        for cell_type in self.next.keys() {
            let next = self.get_next(cell_type);
            let height = if next.0 == 0 { next.1 } else { next.1 + 1 };
            data.insert(
                *cell_type,
                (
                    columns.get_cell_type_width(*cell_type),
                    height,
                    self.cells_used(cell_type, columns),
                ),
            );
        }
        data
    }

    fn place_cell_value(
        &mut self,
        _columns: &mut CellManagerColumns,
        _cell_type: CellType,
    ) -> CellPlacementValue {
        unimplemented!()
    }

    fn place_cell_with_affinity<F: Field>(
        &mut self,
        _columns: &mut CellManagerColumns,
        _meta: &mut ConstraintSystem<F>,
        _cell_type: CellType,
        _affinity: Self::Affinity,
    ) -> CellPlacement {
        unimplemented!()
    }

    fn place_cell_value_with_affinity(
        &mut self,
        _columns: &mut CellManagerColumns,
        _cell_type: CellType,
        _affinity: Self::Affinity,
    ) -> CellPlacementValue {
        unimplemented!()
    }
}

#[derive(Debug, Clone)]
pub(crate) struct CMFixedHeightStrategy {
    row_width: Vec<usize>,
    cell_type: CellType,

    num_unused_cells: usize,
}

impl CMFixedHeightStrategy {
    pub(crate) fn new(height: usize, cell_type: CellType) -> CMFixedHeightStrategy {
        CMFixedHeightStrategy {
            row_width: vec![0; height],
            cell_type,

            num_unused_cells: Default::default(),
        }
    }
}

impl CellPlacementStrategy for CMFixedHeightStrategy {
    type Affinity = usize;

    fn on_creation(&mut self, _columns: &mut CellManagerColumns) {
        // We don't need to do anything as the columns are created on demand
    }

    fn place_cell<F: Field>(
        &mut self,
        columns: &mut CellManagerColumns,
        meta: &mut ConstraintSystem<F>,
        cell_type: CellType,
    ) -> CellPlacement {
        assert_eq!(
            cell_type, self.cell_type,
            "CMFixedHeightStrategy can only work with one cell type"
        );

        let (row_idx, column_idx) = self.get_next();

        let placement = self.place_cell_at_pos(columns, meta, row_idx, column_idx);

        self.inc_row_width(row_idx);

        placement
    }

    fn get_height(&self) -> usize {
        self.row_width.len()
    }

    type Stats = ();

    fn get_stats(&self, _columns: &CellManagerColumns) -> Self::Stats {
        // This CM strategy has not statistics.
    }

    /// Deprecated: share cells between configure and synthesize instead.
    fn place_cell_value(
        &mut self,
        _columns: &mut CellManagerColumns,
        cell_type: CellType,
    ) -> CellPlacementValue {
        assert_eq!(
            cell_type, self.cell_type,
            "CMFixedHeightStrategy can only work with one cell type"
        );

        let (row_idx, column_idx) = self.get_next();

        self.inc_row_width(row_idx);

        CellPlacementValue {
            column_idx,
            rotation: row_idx,
        }
    }

    fn place_cell_with_affinity<F: Field>(
        &mut self,
        columns: &mut CellManagerColumns,
        meta: &mut ConstraintSystem<F>,
        cell_type: CellType,
        affnity: Self::Affinity,
    ) -> CellPlacement {
        assert_eq!(
            cell_type, self.cell_type,
            "CMFixedHeightStrategy can only work with one cell type"
        );

        let row_idx = affnity;
        let column_idx = self.row_width[row_idx];

        let placement = self.place_cell_at_pos(columns, meta, row_idx, column_idx);

        self.inc_row_width(row_idx);

        placement
    }

    /// Deprecated: share cells between configure and synthesize instead.
    fn place_cell_value_with_affinity(
        &mut self,
        _columns: &mut CellManagerColumns,
        cell_type: CellType,
        affinity: Self::Affinity,
    ) -> CellPlacementValue {
        assert_eq!(
            cell_type, self.cell_type,
            "CMFixedHeightStrategy can only work with one cell type"
        );

        let row_idx = affinity;
        let column_idx = self.row_width[row_idx];

        self.inc_row_width(row_idx);

        CellPlacementValue {
            column_idx,
            rotation: row_idx,
        }
    }
}

impl CMFixedHeightStrategy {
    pub fn start_region(&mut self) -> usize {
        // Make sure all rows start at the same column
        let width = *self.row_width.iter().max().unwrap_or(&0usize);
        for row in self.row_width.iter_mut() {
            self.num_unused_cells += width - *row;
            *row = width;
        }
        width
    }

    pub fn get_num_unused_cells(&self) -> usize {
        self.num_unused_cells
    }

    fn get_next(&mut self) -> (usize, usize) {
        let mut best_row_idx = 0usize;
        let mut best_row_with = usize::MAX;
        for (row_idx, row_width) in self.row_width.iter().enumerate() {
            if *row_width < best_row_with {
                best_row_with = *row_width;
                best_row_idx = row_idx;
            }
        }

        (best_row_idx, best_row_with)
    }

    fn inc_row_width(&mut self, row_idx: usize) {
        self.row_width[row_idx] += 1;
    }

    fn place_cell_at_pos<F: Field>(
        &mut self,
        columns: &mut CellManagerColumns,
        meta: &mut ConstraintSystem<F>,
        row_idx: usize,
        column_idx: usize,
    ) -> CellPlacement {
        let column = if column_idx < columns.get_cell_type_width(self.cell_type) {
            columns
                .get_column(self.cell_type, column_idx)
                .expect("column not found")
        } else {
            let advice = meta.advice_column();

            columns.add_column(self.cell_type, advice);

            columns
                .get_column(self.cell_type, column_idx)
                .expect("column not found")
        };

        CellPlacement {
            column: column.clone(),
            rotation: row_idx,
        }
    }
}