File: histogram.go

package info (click to toggle)
golang-github-cloudflare-circl 1.6.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 18,060 kB
  • sloc: asm: 20,492; ansic: 1,292; makefile: 68
file content (144 lines) | stat: -rw-r--r-- 3,984 bytes parent folder | download | duplicates (2)
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
// Package histogram is a VDAF for aggregating integer measurements into buckets.
package histogram

import (
	"github.com/cloudflare/circl/vdaf/prio3/arith"
	"github.com/cloudflare/circl/vdaf/prio3/arith/fp128"
	"github.com/cloudflare/circl/vdaf/prio3/internal/flp"
	"github.com/cloudflare/circl/vdaf/prio3/internal/prio3"
)

type (
	poly        = fp128.Poly
	Vec         = fp128.Vec
	Fp          = fp128.Fp
	AggShare    = prio3.AggShare[Vec, Fp]
	InputShare  = prio3.InputShare[Vec, Fp]
	Nonce       = prio3.Nonce
	OutShare    = prio3.OutShare[Vec, Fp]
	PrepMessage = prio3.PrepMessage
	PrepShare   = prio3.PrepShare[Vec, Fp]
	PrepState   = prio3.PrepState[Vec, Fp]
	PublicShare = prio3.PublicShare
	VerifyKey   = prio3.VerifyKey
)

// Histogram is a verifiable distributed aggregation function in which each
// measurement increments by one the histogram bucket, out of a set of fixed
// buckets, and the aggregate result counts the number of measurements in each
// bucket.
type Histogram struct {
	p prio3.Prio3[uint64, []uint64, *flpHistogram, Vec, Fp, *Fp]
}

func New(numShares uint8, length, chunkLen uint, context []byte) (h *Histogram, err error) {
	const histogramID = 4
	h = new(Histogram)
	h.p, err = prio3.New(newFlpHistogram(length, chunkLen), histogramID, numShares, context)
	if err != nil {
		return nil, err
	}

	return h, nil
}

func (h *Histogram) Params() prio3.Params { return h.p.Params() }

func (h *Histogram) Shard(measurement uint64, nonce *Nonce, rand []byte,
) (PublicShare, []InputShare, error) {
	return h.p.Shard(measurement, nonce, rand)
}

func (h *Histogram) PrepInit(
	verifyKey *VerifyKey,
	nonce *Nonce,
	aggID uint8,
	publicShare PublicShare,
	inputShare InputShare,
) (*PrepState, *PrepShare, error) {
	return h.p.PrepInit(verifyKey, nonce, aggID, publicShare, inputShare)
}

func (h *Histogram) PrepSharesToPrep(prepShares []PrepShare) (*PrepMessage, error) {
	return h.p.PrepSharesToPrep(prepShares)
}

func (h *Histogram) PrepNext(state *PrepState, msg *PrepMessage) (*OutShare, error) {
	return h.p.PrepNext(state, msg)
}

func (h *Histogram) AggregateInit() AggShare { return h.p.AggregateInit() }

func (h *Histogram) AggregateUpdate(aggShare *AggShare, outShare *OutShare) {
	h.p.AggregateUpdate(aggShare, outShare)
}

func (h *Histogram) Unshard(aggShares []AggShare, numMeas uint) (aggregate *[]uint64, err error) {
	return h.p.Unshard(aggShares, numMeas)
}

type flpHistogram struct {
	flp.FLP[flp.GadgetParallelSumInnerMul, poly, Vec, Fp, *Fp]
	length   uint
	chunkLen uint
}

func newFlpHistogram(length, chunkLen uint) *flpHistogram {
	h := new(flpHistogram)
	numGadgetCalls := (length + chunkLen - 1) / chunkLen
	h.length = length
	h.chunkLen = chunkLen
	h.Valid.MeasurementLen = length
	h.Valid.JointRandLen = numGadgetCalls
	h.Valid.OutputLen = length
	h.Valid.EvalOutputLen = 2
	h.Gadget = flp.GadgetParallelSumInnerMul{Count: chunkLen}
	h.NumGadgetCalls = numGadgetCalls
	h.FLP.Eval = h.Eval
	return h
}

func (h *flpHistogram) Eval(
	out Vec, g flp.Gadget[poly, Vec, Fp, *Fp], numCalls uint,
	meas, jointRand Vec, numShares uint8,
) {
	var invShares Fp
	invShares.InvUint64(uint64(numShares))
	out[0] = flp.RangeCheck(g, numCalls, h.chunkLen, &invShares, meas, jointRand)

	sumCheck := &out[1]
	sumCheck.SubAssign(&invShares)
	for i := range meas {
		sumCheck.AddAssign(&meas[i])
	}
}

func (h *flpHistogram) Encode(measurement uint64) (out Vec, err error) {
	if measurement > uint64(h.length) {
		return nil, flp.ErrMeasurementValue
	}

	out = arith.NewVec[Vec](h.Valid.MeasurementLen)
	out[measurement].SetOne()

	return
}

func (h *flpHistogram) Truncate(meas Vec) Vec { return meas }

func (h *flpHistogram) Decode(output Vec, numMeas uint) (*[]uint64, error) {
	if len(output) < int(h.Valid.OutputLen) {
		return nil, flp.ErrOutputLen
	}

	var err error
	out := make([]uint64, len(output))
	for i := range output {
		out[i], err = output[i].GetUint64()
		if err != nil {
			return nil, err
		}
	}

	return &out, nil
}