-
Notifications
You must be signed in to change notification settings - Fork 16
/
smc_run.8
112 lines (105 loc) · 2.38 KB
/
smc_run.8
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
.\" smc_run.8
.\"
.\"
.\" Copyright IBM Corp. 2017
.\" Author(s): Ursula Braun <ubraun@linux.ibm.com>
.\" ----------------------------------------------------------------------
.\"
.TH SMC_RUN 8 "January 2017" "smc-tools" "Linux Programmer's Manual "
.SH NAME
smc_run \- start a TCP socket program with the capability to use SMC as
networking protocol
.SH SYNOPSIS
.B smc_run
.RB [ \-dhrtv ] [ \-r
.IR SIZE ]
.RB [-t
.IR SIZE ]
.I program
.I parameters
.SH DESCRIPTION
.B smc_run
starts a
.IR program
specified as argument with its
.IR parameters ,
allowing to use the SMC protocol for program-used TCP socket connections.
.br
The script specifies libsmc-preload.so as a preload shared library for the
Linux program loader, and may adjust transmit and receive buffer sizes to
.I SIZE
by setting socket options SO_RCVBUF and SO_SNDBUF respectively.
.I SIZE
can be specified in Bytes or using metric prefixes k and m, e.g.
8k...1024k/1m.
.br
The preload library libsmc-preload.so intercepts a few TCP socket calls and
triggers the equivalent execution through SMC.
.br
Note: If it is not possibile to use
.IR smc_run ,
the libsmc-preload.so may be installed as apreload library via environment
variable LD_PRELOAD. Use environment varibles SMC_SNDBUF and SMC_RCVBUF to
request specific transmit and receive buffer sizes respectively. Supports
metric prefixes k and m.
The following options can be specified:
.TP
.BR "\-d"
Display additional diagnostic messages during the program execution.
.TP
.BR "\-h"
Display a brief usage information.
.TP
.BR "\-r " \fISIZE
Request receive buffer size
.IR SIZE .
.br
.BR Notes :
.RS
.IP \[bu] 2
May be overridden by the application.
.IP \[bu]
Increases net.core.rmem_max if necessary.
.RE
.TP
.BR "\-t " \fISIZE
Request transmit buffer size
.IR SIZE .
.br
.BR Notes :
.RS
.IP \[bu] 2
May be overridden by the application.
.IP \[bu]
Increases net.core.wmem_max if necessary.
.RE
.TP
.BR "\-v"
Display version information.
.SH RETURN CODES
On success, the
.IR smc_run
command returns 0.
If an error occurs
.IR smc_run
writes a message to stdout and completes with a return code other
than 0.
.TP
.B 1
An invalid option was specified.
.P
.SH EXAMPLES
.B Run program foo using SMC, requesting a receive buffer size of 512KB
.RS 4
.PP
$ smc_run -r 512k ./foo
.P
.SH SEE ALSO
.BR af_smc (7),
.BR smc_chk (8)
.BR smc_pnet (8),
.BR smc_rnics (8),
.BR smcd (8),
.BR smcr (8),
.BR smcss (8),
.BR tcp (7)