bbperf 0.0.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,128 @@
1
+ Metadata-Version: 2.4
2
+ Name: bbperf
3
+ Version: 0.0.1
4
+ Summary: An end-to-end performance and bufferbloat measurement tool
5
+ Project-URL: Homepage, https://github.com/cloudflare/bbperf
6
+ Project-URL: Issues, https://github.com/cloudflare/bbperf/issues
7
+ Author-email: Mike Freemon <mfreemon@cloudflare.com>
8
+ License-Expression: Apache-2.0
9
+ License-File: LICENSE
10
+ Classifier: Environment :: Console
11
+ Classifier: License :: OSI Approved :: Apache Software License
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Topic :: System :: Networking
15
+ Requires-Python: >=3.9
16
+ Description-Content-Type: text/markdown
17
+
18
+ <p align="center"><strong>bbperf</strong> <em>- An end-to-end performance and bufferbloat measurement tool</em></p>
19
+
20
+ `bbperf` measures the following for both TCP and UDP:
21
+
22
+ * End-to-end latency, both unloaded and loaded
23
+ * Throughput
24
+ * Bandwidth Delay Product (BDP)
25
+ * Usage of buffers between the endpoints
26
+ * Bufferbloat (when the usage of buffers is excessive)
27
+
28
+ For UDP, it also measures:
29
+
30
+ * Packet rates
31
+ * Packet loss rates
32
+
33
+ Features that distinguish this tool from existing tools include:
34
+
35
+ * Latency, both unloaded and loaded, is measured by the same flow that is under test.
36
+
37
+ Other tools will commonly measure latency using a different flow or different protocol. One of the reasons why using different protocols and/or different flows is not desirable is because fair queuing will cause the latency of those other flows to be much lower (better) than the flow that matters.
38
+
39
+ * Bufferbloat is calculated
40
+
41
+ It is often assumed that TCP receive buffers are the only source of bufferbloat. While that is common, it misses many other locations where bufferbloat may occur. This tool reports the effects of all sources of bufferbloat, not just TCP receive buffers.
42
+
43
+ * Automatic generation of graphs
44
+
45
+ ### Usage
46
+
47
+ To run a test:
48
+
49
+ 1. Start the server on one host
50
+ ```
51
+ $ bbperf.py -s
52
+ ```
53
+
54
+ 2. Run the client on another host
55
+ ```
56
+ $ bbperf.py -c <ip address of server> [additional options as desired]
57
+ ```
58
+
59
+ `bbperf` will use port 5301 between the client and server (by default).
60
+
61
+ The first 5 seconds performs a calibration, during which it captures the unloaded latency between endpoints.
62
+
63
+ The direction of data flow is from the client to the server. That is reversed when the "-R" option is specified.
64
+
65
+ ```
66
+ $ bbperf.py --help
67
+ usage: bbperf.py [-h] [-v] [-s] [-c SERVER_IP] [-p SERVER_PORT] [-R] [-t SECONDS] [-u] [-b BANDWIDTH] [-g] [-k]
68
+
69
+ bbperf: end to end performance and bufferbloat measurement tool
70
+
71
+ options:
72
+ -h, --help show this help message and exit
73
+ -v, --verbosity increase output verbosity
74
+ -s, --server run in server mode
75
+ -c SERVER_IP, --client SERVER_IP
76
+ run in client mode
77
+ -p SERVER_PORT, --port SERVER_PORT
78
+ server port (default: 5301)
79
+ -R, --reverse data flow in download direction (server to client)
80
+ -t SECONDS, --time SECONDS
81
+ duration of run in seconds
82
+ -u, --udp run in UDP mode (default: TCP mode)
83
+ -b BANDWIDTH, --bandwidth BANDWIDTH
84
+ n[kmgKMG] | n[kmgKMG]pps
85
+ -g, --graph generate graph (requires gnuplot)
86
+ -k, --keep keep data file
87
+ ```
88
+
89
+ Output from `bbperf` includes the following information:
90
+ ```
91
+ sent_time time when a packet was sent
92
+ recv_time time when a packet was received
93
+ sender_pps packets per second sent
94
+ sender_Mbps bits per second sent
95
+ receiver_pps packets per second received
96
+ receiver_Mbps bits per second received
97
+ unloaded_rtt_ms unloaded RTT in milliseconds (determined during calibration)
98
+ rtt_ms RTT in milliseconds
99
+ BDP_bytes Calculated BDP in bytes
100
+ buffered_bytes Actual bytes in flight
101
+ bloat Ratio of buffered bytes to BDP
102
+ pkts_dropped number of packets dropped (UDP only)
103
+ drop% percentage of packets dropped (UDP only)
104
+ ```
105
+
106
+ ### Installation
107
+
108
+ `bbperf` is available via PyPI repository (pypi.org) and can be installed using pip.
109
+
110
+ ```
111
+ python3 -m venv bbperf-venv
112
+ . bbperf-venv/bin/active
113
+ pip install bbperf
114
+
115
+ bbperf.py [options]
116
+ ```
117
+
118
+ In the event python3 is not already installed on the host:
119
+
120
+ ```
121
+ apt-get install python3 python3-pip (Debian/Ubuntu)
122
+ dnf install python3 python3-pip (Fedora/RHEL)
123
+ ```
124
+
125
+ ---
126
+ Copyright (c) 2024 Cloudflare, Inc.<br/>
127
+ Licensed under the Apache 2.0 license found in the LICENSE file or at https://www.apache.org/licenses/LICENSE-2.0
128
+
@@ -0,0 +1,24 @@
1
+ bbperf/.gitignore,sha256=7fX2Bi1NFZNOS7vATE7-pFB06IPP1AFmFMyyQdUGzLo,27
2
+ bbperf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
3
+ bbperf/bbperf.py,sha256=5b9MfJem7tAYb9LfmgfFe3UurHplK8Z1V86IB0F5L0I,2029
4
+ bbperf/calibration.py,sha256=jRX436vyTtnXFtHwNeIAGOAeNIRy0hNaYwwlBtplarw,925
5
+ bbperf/client.py,sha256=AJzN1ZGFAV1GI4txJICQyniO7f_tZcDSribj0WpJSVI,6736
6
+ bbperf/const.py,sha256=VDbhIumS-5n3ORiIvUxyZR16wWav7s1Um5ONHJPWxlc,585
7
+ bbperf/control_receiver_thread.py,sha256=XiVpCNQ5NGcduTGUcj1EnTShSwKP1t8S5Xs1dsa9oLI,3193
8
+ bbperf/data_receiver_thread.py,sha256=RureW9Y0EB9_53kkhF7iXD7caiNnZ0BYWekMnRhe3yw,4560
9
+ bbperf/data_sender_thread.py,sha256=1-jZTc5NfSo-3R7hsnYEuue-1KVyoOqI3q43LUFMw_Q,7166
10
+ bbperf/data_udp_ping_sender_thread.py,sha256=MOMk-bdfmLNy0FThQIfmDjZY1rEpfyQ5-b_tvc_Qt2s,1305
11
+ bbperf/exceptions.py,sha256=Zpf3AdqxnUq3fDTGzvq8XsDe-uCIFi4-K9rr6ki_Kjc,208
12
+ bbperf/graph.py,sha256=lceqxUY_zSGm8i-AuxzEArJiRvUERxJlNujsurP4fyU,1108
13
+ bbperf/output.py,sha256=f9yxAdJ7G5DhCI9qS06q0JvTlOYFesvkFDm9u8VVRIE,8132
14
+ bbperf/run_test.sh,sha256=a3eXHYYj_Tk1Fckvi7lUeESJeqhbk0KdqD4r6C1t4fs,1121
15
+ bbperf/server.py,sha256=QFxpiSo7tjwpJ017DRVPFO-HN2FaiVNifjMdMG-BKV4,5591
16
+ bbperf/tcp-graph.gp,sha256=PsxAFccD4L_evXaemGKvAwczvDjdsEZ98kvgtzu9XwY,1312
17
+ bbperf/tcp_control_connection_class.py,sha256=8iTcBD7kn2Czu3ognUQOO_vQFwTEALYarpqMSKnVPL0,5341
18
+ bbperf/udp-graph.gp,sha256=yxJPiHKS7zfycLJtss31W9b36EIurdcPurecoIBhuoA,1557
19
+ bbperf/util.py,sha256=E0tZzlYwGFyydPk6VOXZmOqu_q7wRhH5FTBaZJZMFT4,2524
20
+ bbperf-0.0.1.dist-info/METADATA,sha256=r4IBEZjSWvoMg75wK__sA6cz3wge4dtxbnlo0V6xduM,4547
21
+ bbperf-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
22
+ bbperf-0.0.1.dist-info/entry_points.txt,sha256=cJK7Z98XipWiXTQiAhP5WGyg3v52nlgqDxHzQTvl_uo,50
23
+ bbperf-0.0.1.dist-info/licenses/LICENSE,sha256=NQj9fV-y1K7hOgMeUstDqJJv4PAGn95cRv95RS-TnD0,562
24
+ bbperf-0.0.1.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.27.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ bbperf = bbperf.bbperf:mainline
@@ -0,0 +1,14 @@
1
+ Copyright (c) 2024 Cloudflare, Inc.
2
+
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+
7
+ http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ Unless required by applicable law or agreed to in writing, software
10
+ distributed under the License is distributed on an "AS IS" BASIS,
11
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ See the License for the specific language governing permissions and
13
+ limitations under the License.
14
+