blob: ae91432e9771170f2704ff071759545525ef9502 [file] [log] [blame] [view]
Weiwei Liu4f1afac2016-04-02 19:08:38 -07001# Face Benchmark
2
3**face-benchmark** is a program to test the performance of the face system. It runs
4on a node between n consumer nodes and n producer nodes. It creates a left face and
5a right face for each pair of consumer node and producer node respectively. The left
6and right faces in each pair are tied to each other at the Interest/Data/Nack layer,
7which means that anything received on the left face is sent to the corresponding
8right face, and anything received on the right face is sent to the corresponding
9left face. The program passively waits for an incoming connection from one side which
10triggers an outgoing connection to the other side. The FacePersistency is set to
11"on-demand" for all incoming faces, and "persistent" for all outgoing faces.
12
13The FaceUris for each face pair can be configured via a configuration file. Each
14line of the configuration file consists of a left FaceUri and a right FaceUri
15separated by a space. FaceUri schemes "tcp4" and "udp4" are supported. The left face
16and right face are allowed to have different FaceUri schemes. All FaceUris MUST be
17in canonical form.
18
19Usage example:
20
211. Configure FaceUris in `face-benchmark.conf`
222. On the router node, run `./face-benchmark face-benchmark.conf`
233. Run NFD on the consumer/producer node pairs