1
2SMCSS(8)                   Linux Programmer's Manual                  SMCSS(8)
3
4
5

NAME

7       smcss - print information about the AF_SMC sockets and link groups.
8
9

SYNOPSIS

11       smcss [--debug|-d] [--smcd|-D] [--wide|-W]
12
13       smcss {--all|-a} [--debug|-d] [--smcd|-D] [--wide|-W]
14
15       smcss [--debug|-d] [--smcr|-R] [--wide|-W]
16
17       smcss {--all|-a} [--debug|-d] [--smcr|-R] [--wide|-W]
18
19       smcss {--listening|-l} [--wide|-W]
20
21       smcss {--version|-v}
22
23       smcss {--help|-h}
24
25

DESCRIPTION

27       smcss  prints  information  about  the  Linux  AF_SMC  sockets and link
28       groups.  The type of information printed is  controlled  by  the  first
29       argument, as follows:
30
31       (none)
32              displays a list of connecting, closing, or connected SMC sockets
33              with basic information.
34
35
36       -a, --all
37              displays all types of SMC sockets: listening, opening,  closing,
38              and connected.
39
40
41       -l, --listening
42              shows listening sockets only. These are omitted by default.
43
44

OPTIONS

46       -d, --debug
47              displays additional debug information, such as shutdown state.
48
49
50       -D, --smcd
51              displays  additional  SMC-D  specific  information.  Shows SMC-D
52              sockets only.
53
54
55       -R, --smcr
56              displays additional  SMC-R  specific  information.  Shows  SMC-R
57              sockets only.
58
59
60       -W, --wide
61              do not truncate IP addresses.
62
63

OUTPUT

65   State
66       The state of the socket.  The state can be one of these values:
67
68       INIT   The  SMC  socket  is  being initialized. It is not connected nor
69              listening yet.
70
71       CLOSED The SMC socket is closed. It is not connected nor listening any‐
72              more.
73
74       LISTEN The  SMC socket is a listening socket, waiting for incoming con‐
75              nection requests.
76
77       ACTIVE The SMC socket has an established connection.   In  this  state,
78              the  TCP  connection is fully established, rendezvous processing
79              has been completed, and SMC peers can exchange data via RDMA.
80
81       PEERCLW1
82              No further data will be sent to the peer.
83
84       PEERCLW2
85              No further data will be sent to or received from the peer.
86
87       APPLCLW1
88              No further data will be received from the peer.
89
90       APPLCLW2
91              No further data will be received from or sent to the peer.
92
93       APPLFINCLW
94              The peer has closed the socket.
95
96       PEERFINCLW
97              The socket is closed locally.
98
99       PEERABORTW
100              The socket was abnormally closed locally.
101
102       PROCESSABORT
103              The peer has closed the socket abnormally.
104
105   UID
106       User ID of the SMC socket.
107
108   Inode
109       Inode attribute of the socket.
110
111   Local Address
112       Address and port number of the local end of the SMC socket.   The  dis‐
113       played  address is truncated when it ends with '..'.  -W, --wide can be
114       used to display addresses untruncated.
115
116   Peer Address
117       Address and port number of the remote end of the socket.  Analogous  to
118       "Local Address".
119
120   Intf
121       When the socket is explicitly bound with setsockopt option SO_BINDTODE‐
122       VICE then Intf shows the interface number of  the  Ethernet  device  to
123       which the socket is bound.
124
125   Mode
126       SMCD   The SMC socket uses SMC-D for data exchange.
127
128       SMCR   The SMC socket uses SMC-R for data exchange.
129
130       TCP    The  SMC socket uses the TCP protocol for data exchange, because
131              an SMC connection could not be established.
132
133   ShutD
134       <->    The SMC socket has not been shut down.
135
136       R->    The SMC socket is shut down one-way and cannot receive data.
137
138       <-W    The SMC socket is shut down one-way and cannot send data.
139
140       R-W    The SMC socket is shut down in both ways and cannot  receive  or
141              send data.
142
143   Token
144       Unique ID of the SMC socket connection.
145
146   Sndbuf
147       Size of the to-be-sent window of the SMC socket connection.
148
149   Rcvbuf
150       Size  of  the  receiving window of the SMC socket connection (filled by
151       peer).
152
153   Peerbuf
154       Size of the peer receiving window of the SMC socket connection (to fill
155       during RDMA-transfer).
156
157   rxprod-Cursor
158       Describes  the  current  cursor location of the "Rcvbuf" for data to be
159       received from the peer.
160
161   rxcons-Cursor
162       Describes the current cursor location of the "Peerbuf" for data sent to
163       peer and confirmed by the peer.
164
165   rxFlags
166       SMC socket connection flags set by and received from the peer.
167
168   txprod-Cursor
169       Describes the current cursor location of the "Peerbuf" for data sent to
170       peer.
171
172   txcons-Cursor
173       Describes the current cursor location of the "Rcvbuf" for data received
174       from the peer and confirmed to the peer.
175
176   txFlags
177       SMC socket connection flags set locally and sent to the peer.
178
179   txprep-Cursor
180       Describes  the  current  cursor location of the "Sndbuf" for data to be
181       sent.  The data is to be moved to the "Peerbuf" by using RDMA-write.
182
183   txsent-Cursor
184       Describes the current cursor location of the "Sndbuf"  for  data  sent.
185       The data was moved to the "Peerbuf" by using RDMA-write.
186
187   txfin-Cursor
188       Describes the current cursor location of the "Sndbuf" for data sent and
189       send completion confirmed.  The data was  moved  to  the  "Peerbuf"  by
190       using RDMA-write and completion was confirmed.
191
192   Role
193       CLNT   The link group of the SMC socket is used for client connections.
194
195       SERV   The link group of the SMC socket is used for server connections.
196
197   IB-Device
198       Name  of the RoCE device used by the link group to which the SMC socket
199       belongs.
200
201   Port
202       Port of the RoCE device used by the link group to which the SMC  socket
203       belongs.
204
205   Linkid
206       Unique  link  ID  of  the  link  within the link group to which the SMC
207       socket belongs.
208
209   GID
210       Gid of the RoCE port used by the link group to  which  the  SMC  socket
211       belongs.
212
213   Peer-GID
214       Gid  of  the  Foreign RoCE port used by the link group to which the SMC
215       socket belongs.
216
217   VLAN
218       tbd.
219

RETURN CODES

221       Successful smcss commands return 0 and  display  the  requested  socket
222       state  table  or  link  group  information.   If an error occurs, smcss
223       writes a message to stderr and completes with a return code other  than
224       0.
225

AUTHOR

227       This man page was written by
228       Ursula Braun <ubraun@linux.ibm.com>
229
230       Copyright (c) IBM Corp. 2017, 2018
231
232       Published under the terms and conditions of the EPL
233       (Eclipse Public License).
234
235

SEE ALSO

237       af_smc(7), smc_run(8) smc_pnet(8)
238
239
240
241smc-tools                          June 2018                          SMCSS(8)
Impressum