Skip to content

Commit 7af3475

Browse files
committed
add documentation for mm-link log files in man page
1 parent 9f0dcb7 commit 7af3475

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

man/mm-link.1

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.\" First parameter, NAME, should be all caps
33
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
44
.\" other parameters are allowed: see man(7), man(1)
5-
.TH mm-link 1 "February 2014"
5+
.TH mm-link 1 "October 2018"
66
.\" Please adjust this date whenever revising the manpage.
77
.\"
88
.\" Some roff macros, for reference:
@@ -50,6 +50,49 @@ link rate.
5050

5151
To exit mm-link, simply type "exit" or CTRL-D inside mm-link.
5252

53+
.SH OUTPUT
54+
mm-link can optionally log detailed performance information for both the uplink and downlink, specified with the \fB--uplink-log\fR and \fB--downlink-log\fR flags respectively. A log file has the following format:
55+
56+
.EX
57+
# mahimahi mm-link (name of link) [/path/to/trace] > /path/to/log
58+
# command line: [command used to run mm-link]
59+
# queue: [queue information]
60+
# init timestamp: [start time of mm-link]
61+
# base timestamp: [starting log timestamp]
62+
[# mahimahi config: [mahimahi shell prefix]]
63+
[log lines]
64+
.EE
65+
66+
Each log line is one of the following:
67+
68+
[timestamp] # packet_size
69+
.
70+
.IP ""
71+
.RS
72+
An unused delivery opportunity.
73+
.RE
74+
75+
[timestamp] + packet_size
76+
.
77+
.IP ""
78+
.RS
79+
A packet arrival to the link, it may be dropped later
80+
.RE
81+
82+
[timestamp] - packet_size
83+
.
84+
.IP ""
85+
.RS
86+
A successful packet delivery
87+
.RE
88+
89+
[timestamp] d packets_dropped bytes_dropped
90+
.
91+
.IP ""
92+
.RS
93+
A dropped packet (or multiple packets)
94+
.RE
95+
5396
.SH EXAMPLE
5497

5598
.nf

0 commit comments

Comments
 (0)