€•½     Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ$/translations/zh_CN/networking/rxrpc”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ$/translations/zh_TW/networking/rxrpc”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ$/translations/it_IT/networking/rxrpc”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ$/translations/ja_JP/networking/rxrpc”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ$/translations/ko_KR/networking/rxrpc”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ$/translations/sp_SP/networking/rxrpc”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ SPDX-License-Identifier: GPL-2.0”h]”hŒ SPDX-License-Identifier: GPL-2.0”…””}”hh£sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1h¡hhhžhhŸŒ>/var/lib/git/docbuild/linux/Documentation/networking/rxrpc.rst”h KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒRxRPC Network Protocol”h]”hŒRxRPC Network Protocol”…””}”(hh»hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hh¶hžhhŸh³h KubhŒ	paragraph”“”)”}”(hX  The RxRPC protocol driver provides a reliable two-phase transport on top of UDP
that can be used to perform RxRPC remote operations.  This is done over sockets
of AF_RXRPC family, using sendmsg() and recvmsg() with control data to send and
receive data, aborts and errors.”h]”hX  The RxRPC protocol driver provides a reliable two-phase transport on top of UDP
that can be used to perform RxRPC remote operations.  This is done over sockets
of AF_RXRPC family, using sendmsg() and recvmsg() with control data to send and
receive data, aborts and errors.”…””}”(hhËhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhÊ)”}”(hŒContents of this document:”h]”hŒContents of this document:”…””}”(hhÙhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhŒblock_quote”“”)”}”(hŒ÷(#) Overview.

(#) RxRPC protocol summary.

(#) AF_RXRPC driver model.

(#) Control messages.

(#) Socket options.

(#) Security.

(#) Example client usage.

(#) Example server usage.

(#) AF_RXRPC kernel interface.

(#) Configurable parameters.

”h]”hŒenumerated_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒ
Overview.
”h]”hÊ)”}”(hŒ	Overview.”h]”hŒ	Overview.”…””}”(hhøhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khhôubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhhïubhó)”}”(hŒRxRPC protocol summary.
”h]”hÊ)”}”(hŒRxRPC protocol summary.”h]”hŒRxRPC protocol summary.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhhïubhó)”}”(hŒAF_RXRPC driver model.
”h]”hÊ)”}”(hŒAF_RXRPC driver model.”h]”hŒAF_RXRPC driver model.”…””}”(hj(  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khj$  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhhïubhó)”}”(hŒControl messages.
”h]”hÊ)”}”(hŒControl messages.”h]”hŒControl messages.”…””}”(hj@  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khj<  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhhïubhó)”}”(hŒSocket options.
”h]”hÊ)”}”(hŒSocket options.”h]”hŒSocket options.”…””}”(hjX  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KhjT  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhhïubhó)”}”(hŒ
Security.
”h]”hÊ)”}”(hŒ	Security.”h]”hŒ	Security.”…””}”(hjp  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khjl  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhhïubhó)”}”(hŒExample client usage.
”h]”hÊ)”}”(hŒExample client usage.”h]”hŒExample client usage.”…””}”(hjˆ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khj„  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhhïubhó)”}”(hŒExample server usage.
”h]”hÊ)”}”(hŒExample server usage.”h]”hŒExample server usage.”…””}”(hj   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khjœ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhhïubhó)”}”(hŒAF_RXRPC kernel interface.
”h]”hÊ)”}”(hŒAF_RXRPC kernel interface.”h]”hŒAF_RXRPC kernel interface.”…””}”(hj¸  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khj´  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhhïubhó)”}”(hŒConfigurable parameters.

”h]”hÊ)”}”(hŒConfigurable parameters.”h]”hŒConfigurable parameters.”…””}”(hjÐ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K hjÌ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhhïubeh}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œarabic”Œprefix”Œ(”Œsuffix”Œ)”uh1híhhéubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h Khh¶hžhubhµ)”}”(hhh]”(hº)”}”(hŒOverview”h]”hŒOverview”…””}”(hjù  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjö  hžhhŸh³h K$ubhÊ)”}”(hX?  RxRPC is a two-layer protocol.  There is a session layer which provides
reliable virtual connections using UDP over IPv4 (or IPv6) as the transport
layer, but implements a real network protocol; and there's the presentation
layer which renders structured data to binary blobs and back again using XDR
(as does SunRPC)::”h]”hX@  RxRPC is a two-layer protocol.  There is a session layer which provides
reliable virtual connections using UDP over IPv4 (or IPv6) as the transport
layer, but implements a real network protocol; and thereâ€™s the presentation
layer which renders structured data to binary blobs and back again using XDR
(as does SunRPC):”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K&hjö  hžhubhŒliteral_block”“”)”}”(hŒÆ+-------------+
| Application |
+-------------+
|     XDR     |         Presentation
+-------------+
|    RxRPC    |         Session
+-------------+
|     UDP     |         Transport
+-------------+”h]”hŒÆ+-------------+
| Application |
+-------------+
|     XDR     |         Presentation
+-------------+
|    RxRPC    |         Session
+-------------+
|     UDP     |         Transport
+-------------+”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h K,hjö  hžhubhÊ)”}”(hŒAF_RXRPC provides:”h]”hŒAF_RXRPC provides:”…””}”(hj%  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K7hjö  hžhubhè)”}”(hX|  (1) Part of an RxRPC facility for both kernel and userspace applications by
    making the session part of it a Linux network protocol (AF_RXRPC).

(2) A two-phase protocol.  The client transmits a blob (the request) and then
    receives a blob (the reply), and the server receives the request and then
    transmits the reply.

(3) Retention of the reusable bits of the transport system set up for one call
    to speed up subsequent calls.

(4) A secure protocol, using the Linux kernel's key retention facility to
    manage security on the client end.  The server end must of necessity be
    more active in security negotiations.
”h]”hî)”}”(hhh]”(hó)”}”(hŒ‹Part of an RxRPC facility for both kernel and userspace applications by
making the session part of it a Linux network protocol (AF_RXRPC).
”h]”hÊ)”}”(hŒŠPart of an RxRPC facility for both kernel and userspace applications by
making the session part of it a Linux network protocol (AF_RXRPC).”h]”hŒŠPart of an RxRPC facility for both kernel and userspace applications by
making the session part of it a Linux network protocol (AF_RXRPC).”…””}”(hj>  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K9hj:  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj7  ubhó)”}”(hŒ©A two-phase protocol.  The client transmits a blob (the request) and then
receives a blob (the reply), and the server receives the request and then
transmits the reply.
”h]”hÊ)”}”(hŒ¨A two-phase protocol.  The client transmits a blob (the request) and then
receives a blob (the reply), and the server receives the request and then
transmits the reply.”h]”hŒ¨A two-phase protocol.  The client transmits a blob (the request) and then
receives a blob (the reply), and the server receives the request and then
transmits the reply.”…””}”(hjV  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K<hjR  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj7  ubhó)”}”(hŒiRetention of the reusable bits of the transport system set up for one call
to speed up subsequent calls.
”h]”hÊ)”}”(hŒhRetention of the reusable bits of the transport system set up for one call
to speed up subsequent calls.”h]”hŒhRetention of the reusable bits of the transport system set up for one call
to speed up subsequent calls.”…””}”(hjn  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K@hjj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj7  ubhó)”}”(hŒ´A secure protocol, using the Linux kernel's key retention facility to
manage security on the client end.  The server end must of necessity be
more active in security negotiations.
”h]”hÊ)”}”(hŒ³A secure protocol, using the Linux kernel's key retention facility to
manage security on the client end.  The server end must of necessity be
more active in security negotiations.”h]”hŒµA secure protocol, using the Linux kernelâ€™s key retention facility to
manage security on the client end.  The server end must of necessity be
more active in security negotiations.”…””}”(hj†  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KChj‚  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj7  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhj3  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h K9hjö  hžhubhÊ)”}”(hŒùAF_RXRPC does not provide XDR marshalling/presentation facilities.  That is
left to the application.  AF_RXRPC only deals in blobs.  Even the operation ID
is just the first four bytes of the request blob, and as such is beyond the
kernel's interest.”h]”hŒûAF_RXRPC does not provide XDR marshalling/presentation facilities.  That is
left to the application.  AF_RXRPC only deals in blobs.  Even the operation ID
is just the first four bytes of the request blob, and as such is beyond the
kernelâ€™s interest.”…””}”(hj¦  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KGhjö  hžhubhÊ)”}”(hŒSockets of AF_RXRPC family are:”h]”hŒSockets of AF_RXRPC family are:”…””}”(hj´  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KMhjö  hžhubhè)”}”(hŒ£(1) created as type SOCK_DGRAM;

(2) provided with a protocol of the type of underlying transport they're going
    to use - currently only PF_INET is supported.

”h]”hî)”}”(hhh]”(hó)”}”(hŒcreated as type SOCK_DGRAM;
”h]”hÊ)”}”(hŒcreated as type SOCK_DGRAM;”h]”hŒcreated as type SOCK_DGRAM;”…””}”(hjÍ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KOhjÉ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÆ  ubhó)”}”(hŒzprovided with a protocol of the type of underlying transport they're going
to use - currently only PF_INET is supported.

”h]”hÊ)”}”(hŒxprovided with a protocol of the type of underlying transport they're going
to use - currently only PF_INET is supported.”h]”hŒzprovided with a protocol of the type of underlying transport theyâ€™re going
to use - currently only PF_INET is supported.”…””}”(hjå  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KQhjá  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÆ  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhjÂ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h KOhjö  hžhubhÊ)”}”(hŒ•The Andrew File System (AFS) is an example of an application that uses this and
that has both kernel (filesystem) and userspace (utility) components.”h]”hŒ•The Andrew File System (AFS) is an example of an application that uses this and
that has both kernel (filesystem) and userspace (utility) components.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KUhjö  hžhubeh}”(h]”Œoverview”ah ]”h"]”Œoverview”ah$]”h&]”uh1h´hh¶hžhhŸh³h K$ubhµ)”}”(hhh]”(hº)”}”(hŒRxRPC Protocol Summary”h]”hŒRxRPC Protocol Summary”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj  hžhhŸh³h KZubhÊ)”}”(hŒ"An overview of the RxRPC protocol:”h]”hŒ"An overview of the RxRPC protocol:”…””}”(hj,  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K\hj  hžhubhè)”}”(hX¢  (#) RxRPC sits on top of another networking protocol (UDP is the only option
    currently), and uses this to provide network transport.  UDP ports, for
    example, provide transport endpoints.

(#) RxRPC supports multiple virtual "connections" from any given transport
    endpoint, thus allowing the endpoints to be shared, even to the same
    remote endpoint.

(#) Each connection goes to a particular "service".  A connection may not go
    to multiple services.  A service may be considered the RxRPC equivalent of
    a port number.  AF_RXRPC permits multiple services to share an endpoint.

(#) Client-originating packets are marked, thus a transport endpoint can be
    shared between client and server connections (connections have a
    direction).

(#) Up to a billion connections may be supported concurrently between one
    local transport endpoint and one service on one remote endpoint.  An RxRPC
    connection is described by seven numbers::

       Local address   }
       Local port      } Transport (UDP) address
       Remote address  }
       Remote port     }
       Direction
       Connection ID
       Service ID

(#) Each RxRPC operation is a "call".  A connection may make up to four
    billion calls, but only up to four calls may be in progress on a
    connection at any one time.

(#) Calls are two-phase and asymmetric: the client sends its request data,
    which the service receives; then the service transmits the reply data
    which the client receives.

(#) The data blobs are of indefinite size, the end of a phase is marked with a
    flag in the packet.  The number of packets of data making up one blob may
    not exceed 4 billion, however, as this would cause the sequence number to
    wrap.

(#) The first four bytes of the request data are the service operation ID.

(#) Security is negotiated on a per-connection basis.  The connection is
    initiated by the first data packet on it arriving.  If security is
    requested, the server then issues a "challenge" and then the client
    replies with a "response".  If the response is successful, the security is
    set for the lifetime of that connection, and all subsequent calls made
    upon it use that same security.  In the event that the server lets a
    connection lapse before the client, the security will be renegotiated if
    the client uses the connection again.

(#) Calls use ACK packets to handle reliability.  Data packets are also
    explicitly sequenced per call.

(#) There are two types of positive acknowledgment: hard-ACKs and soft-ACKs.
    A hard-ACK indicates to the far side that all the data received to a point
    has been received and processed; a soft-ACK indicates that the data has
    been received but may yet be discarded and re-requested.  The sender may
    not discard any transmittable packets until they've been hard-ACK'd.

(#) Reception of a reply data packet implicitly hard-ACK's all the data
    packets that make up the request.

(#) An call is complete when the request has been sent, the reply has been
    received and the final hard-ACK on the last packet of the reply has
    reached the server.

(#) An call may be aborted by either end at any time up to its completion.

”h]”hî)”}”(hhh]”(hó)”}”(hŒ·RxRPC sits on top of another networking protocol (UDP is the only option
currently), and uses this to provide network transport.  UDP ports, for
example, provide transport endpoints.
”h]”hÊ)”}”(hŒ¶RxRPC sits on top of another networking protocol (UDP is the only option
currently), and uses this to provide network transport.  UDP ports, for
example, provide transport endpoints.”h]”hŒ¶RxRPC sits on top of another networking protocol (UDP is the only option
currently), and uses this to provide network transport.  UDP ports, for
example, provide transport endpoints.”…””}”(hjE  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K^hjA  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hŒRxRPC supports multiple virtual "connections" from any given transport
endpoint, thus allowing the endpoints to be shared, even to the same
remote endpoint.
”h]”hÊ)”}”(hŒœRxRPC supports multiple virtual "connections" from any given transport
endpoint, thus allowing the endpoints to be shared, even to the same
remote endpoint.”h]”hŒ RxRPC supports multiple virtual â€œconnectionsâ€ from any given transport
endpoint, thus allowing the endpoints to be shared, even to the same
remote endpoint.”…””}”(hj]  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KbhjY  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hŒÝEach connection goes to a particular "service".  A connection may not go
to multiple services.  A service may be considered the RxRPC equivalent of
a port number.  AF_RXRPC permits multiple services to share an endpoint.
”h]”hÊ)”}”(hŒÜEach connection goes to a particular "service".  A connection may not go
to multiple services.  A service may be considered the RxRPC equivalent of
a port number.  AF_RXRPC permits multiple services to share an endpoint.”h]”hŒàEach connection goes to a particular â€œserviceâ€.  A connection may not go
to multiple services.  A service may be considered the RxRPC equivalent of
a port number.  AF_RXRPC permits multiple services to share an endpoint.”…””}”(hju  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kfhjq  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hŒ•Client-originating packets are marked, thus a transport endpoint can be
shared between client and server connections (connections have a
direction).
”h]”hÊ)”}”(hŒ”Client-originating packets are marked, thus a transport endpoint can be
shared between client and server connections (connections have a
direction).”h]”hŒ”Client-originating packets are marked, thus a transport endpoint can be
shared between client and server connections (connections have a
direction).”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kjhj‰  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hXU  Up to a billion connections may be supported concurrently between one
local transport endpoint and one service on one remote endpoint.  An RxRPC
connection is described by seven numbers::

   Local address   }
   Local port      } Transport (UDP) address
   Remote address  }
   Remote port     }
   Direction
   Connection ID
   Service ID
”h]”(hÊ)”}”(hŒ»Up to a billion connections may be supported concurrently between one
local transport endpoint and one service on one remote endpoint.  An RxRPC
connection is described by seven numbers::”h]”hŒºUp to a billion connections may be supported concurrently between one
local transport endpoint and one service on one remote endpoint.  An RxRPC
connection is described by seven numbers:”…””}”(hj¥  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Knhj¡  ubj  )”}”(hŒ‚Local address   }
Local port      } Transport (UDP) address
Remote address  }
Remote port     }
Direction
Connection ID
Service ID”h]”hŒ‚Local address   }
Local port      } Transport (UDP) address
Remote address  }
Remote port     }
Direction
Connection ID
Service ID”…””}”hj³  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h Krhj¡  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hŒ¡Each RxRPC operation is a "call".  A connection may make up to four
billion calls, but only up to four calls may be in progress on a
connection at any one time.
”h]”hÊ)”}”(hŒ Each RxRPC operation is a "call".  A connection may make up to four
billion calls, but only up to four calls may be in progress on a
connection at any one time.”h]”hŒ¤Each RxRPC operation is a â€œcallâ€.  A connection may make up to four
billion calls, but only up to four calls may be in progress on a
connection at any one time.”…””}”(hjË  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KzhjÇ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hŒ¨Calls are two-phase and asymmetric: the client sends its request data,
which the service receives; then the service transmits the reply data
which the client receives.
”h]”hÊ)”}”(hŒ§Calls are two-phase and asymmetric: the client sends its request data,
which the service receives; then the service transmits the reply data
which the client receives.”h]”hŒ§Calls are two-phase and asymmetric: the client sends its request data,
which the service receives; then the service transmits the reply data
which the client receives.”…””}”(hjã  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K~hjß  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hŒåThe data blobs are of indefinite size, the end of a phase is marked with a
flag in the packet.  The number of packets of data making up one blob may
not exceed 4 billion, however, as this would cause the sequence number to
wrap.
”h]”hÊ)”}”(hŒäThe data blobs are of indefinite size, the end of a phase is marked with a
flag in the packet.  The number of packets of data making up one blob may
not exceed 4 billion, however, as this would cause the sequence number to
wrap.”h]”hŒäThe data blobs are of indefinite size, the end of a phase is marked with a
flag in the packet.  The number of packets of data making up one blob may
not exceed 4 billion, however, as this would cause the sequence number to
wrap.”…””}”(hjû  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K‚hj÷  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hŒGThe first four bytes of the request data are the service operation ID.
”h]”hÊ)”}”(hŒFThe first four bytes of the request data are the service operation ID.”h]”hŒFThe first four bytes of the request data are the service operation ID.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K‡hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hX  Security is negotiated on a per-connection basis.  The connection is
initiated by the first data packet on it arriving.  If security is
requested, the server then issues a "challenge" and then the client
replies with a "response".  If the response is successful, the security is
set for the lifetime of that connection, and all subsequent calls made
upon it use that same security.  In the event that the server lets a
connection lapse before the client, the security will be renegotiated if
the client uses the connection again.
”h]”hÊ)”}”(hX  Security is negotiated on a per-connection basis.  The connection is
initiated by the first data packet on it arriving.  If security is
requested, the server then issues a "challenge" and then the client
replies with a "response".  If the response is successful, the security is
set for the lifetime of that connection, and all subsequent calls made
upon it use that same security.  In the event that the server lets a
connection lapse before the client, the security will be renegotiated if
the client uses the connection again.”h]”hX  Security is negotiated on a per-connection basis.  The connection is
initiated by the first data packet on it arriving.  If security is
requested, the server then issues a â€œchallengeâ€ and then the client
replies with a â€œresponseâ€.  If the response is successful, the security is
set for the lifetime of that connection, and all subsequent calls made
upon it use that same security.  In the event that the server lets a
connection lapse before the client, the security will be renegotiated if
the client uses the connection again.”…””}”(hj+  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K‰hj'  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hŒcCalls use ACK packets to handle reliability.  Data packets are also
explicitly sequenced per call.
”h]”hÊ)”}”(hŒbCalls use ACK packets to handle reliability.  Data packets are also
explicitly sequenced per call.”h]”hŒbCalls use ACK packets to handle reliability.  Data packets are also
explicitly sequenced per call.”…””}”(hjC  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K’hj?  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hXj  There are two types of positive acknowledgment: hard-ACKs and soft-ACKs.
A hard-ACK indicates to the far side that all the data received to a point
has been received and processed; a soft-ACK indicates that the data has
been received but may yet be discarded and re-requested.  The sender may
not discard any transmittable packets until they've been hard-ACK'd.
”h]”hÊ)”}”(hXi  There are two types of positive acknowledgment: hard-ACKs and soft-ACKs.
A hard-ACK indicates to the far side that all the data received to a point
has been received and processed; a soft-ACK indicates that the data has
been received but may yet be discarded and re-requested.  The sender may
not discard any transmittable packets until they've been hard-ACK'd.”h]”hXm  There are two types of positive acknowledgment: hard-ACKs and soft-ACKs.
A hard-ACK indicates to the far side that all the data received to a point
has been received and processed; a soft-ACK indicates that the data has
been received but may yet be discarded and re-requested.  The sender may
not discard any transmittable packets until theyâ€™ve been hard-ACKâ€™d.”…””}”(hj[  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K•hjW  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hŒfReception of a reply data packet implicitly hard-ACK's all the data
packets that make up the request.
”h]”hÊ)”}”(hŒeReception of a reply data packet implicitly hard-ACK's all the data
packets that make up the request.”h]”hŒgReception of a reply data packet implicitly hard-ACKâ€™s all the data
packets that make up the request.”…””}”(hjs  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K›hjo  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hŒŸAn call is complete when the request has been sent, the reply has been
received and the final hard-ACK on the last packet of the reply has
reached the server.
”h]”hÊ)”}”(hŒžAn call is complete when the request has been sent, the reply has been
received and the final hard-ACK on the last packet of the reply has
reached the server.”h]”hŒžAn call is complete when the request has been sent, the reply has been
received and the final hard-ACK on the last packet of the reply has
reached the server.”…””}”(hj‹  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kžhj‡  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubhó)”}”(hŒHAn call may be aborted by either end at any time up to its completion.

”h]”hÊ)”}”(hŒFAn call may be aborted by either end at any time up to its completion.”h]”hŒFAn call may be aborted by either end at any time up to its completion.”…””}”(hj£  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K¢hjŸ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj>  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhj:  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h K^hj  hžhubeh}”(h]”Œrxrpc-protocol-summary”ah ]”h"]”Œrxrpc protocol summary”ah$]”h&]”uh1h´hh¶hžhhŸh³h KZubhµ)”}”(hhh]”(hº)”}”(hŒAF_RXRPC Driver Model”h]”hŒAF_RXRPC Driver Model”…””}”(hjÎ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjË  hžhhŸh³h K¦ubhÊ)”}”(hŒAbout the AF_RXRPC driver:”h]”hŒAbout the AF_RXRPC driver:”…””}”(hjÜ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K¨hjË  hžhubhè)”}”(hX  (#) The AF_RXRPC protocol transparently uses internal sockets of the transport
    protocol to represent transport endpoints.

(#) AF_RXRPC sockets map onto RxRPC connection bundles.  Actual RxRPC
    connections are handled transparently.  One client socket may be used to
    make multiple simultaneous calls to the same service.  One server socket
    may handle calls from many clients.

(#) Additional parallel client connections will be initiated to support extra
    concurrent calls, up to a tunable limit.

(#) Each connection is retained for a certain amount of time [tunable] after
    the last call currently using it has completed in case a new call is made
    that could reuse it.

(#) Each internal UDP socket is retained [tunable] for a certain amount of
    time [tunable] after the last connection using it discarded, in case a new
    connection is made that could use it.

(#) A client-side connection is only shared between calls if they have
    the same key struct describing their security (and assuming the calls
    would otherwise share the connection).  Non-secured calls would also be
    able to share connections with each other.

(#) A server-side connection is shared if the client says it is.

(#) ACK'ing is handled by the protocol driver automatically, including ping
    replying.

(#) SO_KEEPALIVE automatically pings the other side to keep the connection
    alive [TODO].

(#) If an ICMP error is received, all calls affected by that error will be
    aborted with an appropriate network error passed through recvmsg().

”h]”hî)”}”(hhh]”(hó)”}”(hŒvThe AF_RXRPC protocol transparently uses internal sockets of the transport
protocol to represent transport endpoints.
”h]”hÊ)”}”(hŒuThe AF_RXRPC protocol transparently uses internal sockets of the transport
protocol to represent transport endpoints.”h]”hŒuThe AF_RXRPC protocol transparently uses internal sockets of the transport
protocol to represent transport endpoints.”…””}”(hjõ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kªhjñ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjî  ubhó)”}”(hŒøAF_RXRPC sockets map onto RxRPC connection bundles.  Actual RxRPC
connections are handled transparently.  One client socket may be used to
make multiple simultaneous calls to the same service.  One server socket
may handle calls from many clients.
”h]”hÊ)”}”(hŒ÷AF_RXRPC sockets map onto RxRPC connection bundles.  Actual RxRPC
connections are handled transparently.  One client socket may be used to
make multiple simultaneous calls to the same service.  One server socket
may handle calls from many clients.”h]”hŒ÷AF_RXRPC sockets map onto RxRPC connection bundles.  Actual RxRPC
connections are handled transparently.  One client socket may be used to
make multiple simultaneous calls to the same service.  One server socket
may handle calls from many clients.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K­hj	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjî  ubhó)”}”(hŒsAdditional parallel client connections will be initiated to support extra
concurrent calls, up to a tunable limit.
”h]”hÊ)”}”(hŒrAdditional parallel client connections will be initiated to support extra
concurrent calls, up to a tunable limit.”h]”hŒrAdditional parallel client connections will be initiated to support extra
concurrent calls, up to a tunable limit.”…””}”(hj%  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K²hj!  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjî  ubhó)”}”(hŒ¨Each connection is retained for a certain amount of time [tunable] after
the last call currently using it has completed in case a new call is made
that could reuse it.
”h]”hÊ)”}”(hŒ§Each connection is retained for a certain amount of time [tunable] after
the last call currently using it has completed in case a new call is made
that could reuse it.”h]”hŒ§Each connection is retained for a certain amount of time [tunable] after
the last call currently using it has completed in case a new call is made
that could reuse it.”…””}”(hj=  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kµhj9  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjî  ubhó)”}”(hŒ¸Each internal UDP socket is retained [tunable] for a certain amount of
time [tunable] after the last connection using it discarded, in case a new
connection is made that could use it.
”h]”hÊ)”}”(hŒ·Each internal UDP socket is retained [tunable] for a certain amount of
time [tunable] after the last connection using it discarded, in case a new
connection is made that could use it.”h]”hŒ·Each internal UDP socket is retained [tunable] for a certain amount of
time [tunable] after the last connection using it discarded, in case a new
connection is made that could use it.”…””}”(hjU  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K¹hjQ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjî  ubhó)”}”(hŒüA client-side connection is only shared between calls if they have
the same key struct describing their security (and assuming the calls
would otherwise share the connection).  Non-secured calls would also be
able to share connections with each other.
”h]”hÊ)”}”(hŒûA client-side connection is only shared between calls if they have
the same key struct describing their security (and assuming the calls
would otherwise share the connection).  Non-secured calls would also be
able to share connections with each other.”h]”hŒûA client-side connection is only shared between calls if they have
the same key struct describing their security (and assuming the calls
would otherwise share the connection).  Non-secured calls would also be
able to share connections with each other.”…””}”(hjm  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K½hji  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjî  ubhó)”}”(hŒ=A server-side connection is shared if the client says it is.
”h]”hÊ)”}”(hŒ<A server-side connection is shared if the client says it is.”h]”hŒ<A server-side connection is shared if the client says it is.”…””}”(hj…  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÂhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjî  ubhó)”}”(hŒRACK'ing is handled by the protocol driver automatically, including ping
replying.
”h]”hÊ)”}”(hŒQACK'ing is handled by the protocol driver automatically, including ping
replying.”h]”hŒSACKâ€™ing is handled by the protocol driver automatically, including ping
replying.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÄhj™  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjî  ubhó)”}”(hŒUSO_KEEPALIVE automatically pings the other side to keep the connection
alive [TODO].
”h]”hÊ)”}”(hŒTSO_KEEPALIVE automatically pings the other side to keep the connection
alive [TODO].”h]”hŒTSO_KEEPALIVE automatically pings the other side to keep the connection
alive [TODO].”…””}”(hjµ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÇhj±  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjî  ubhó)”}”(hŒŒIf an ICMP error is received, all calls affected by that error will be
aborted with an appropriate network error passed through recvmsg().

”h]”hÊ)”}”(hŒŠIf an ICMP error is received, all calls affected by that error will be
aborted with an appropriate network error passed through recvmsg().”h]”hŒŠIf an ICMP error is received, all calls affected by that error will be
aborted with an appropriate network error passed through recvmsg().”…””}”(hjÍ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÊhjÉ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjî  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhjê  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h KªhjË  hžhubhÊ)”}”(hŒ.Interaction with the user of the RxRPC socket:”h]”hŒ.Interaction with the user of the RxRPC socket:”…””}”(hjí  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÎhjË  hžhubhè)”}”(hX¸  (#) A socket is made into a server socket by binding an address with a
    non-zero service ID.

(#) In the client, sending a request is achieved with one or more sendmsgs,
    followed by the reply being received with one or more recvmsgs.

(#) The first sendmsg for a request to be sent from a client contains a tag to
    be used in all other sendmsgs or recvmsgs associated with that call.  The
    tag is carried in the control data.

(#) connect() is used to supply a default destination address for a client
    socket.  This may be overridden by supplying an alternate address to the
    first sendmsg() of a call (struct msghdr::msg_name).

(#) If connect() is called on an unbound client, a random local port will
    bound before the operation takes place.

(#) A server socket may also be used to make client calls.  To do this, the
    first sendmsg() of the call must specify the target address.  The server's
    transport endpoint is used to send the packets.

(#) Once the application has received the last message associated with a call,
    the tag is guaranteed not to be seen again, and so it can be used to pin
    client resources.  A new call can then be initiated with the same tag
    without fear of interference.

(#) In the server, a request is received with one or more recvmsgs, then the
    the reply is transmitted with one or more sendmsgs, and then the final ACK
    is received with a last recvmsg.

(#) When sending data for a call, sendmsg is given MSG_MORE if there's more
    data to come on that call.

(#) When receiving data for a call, recvmsg flags MSG_MORE if there's more
    data to come for that call.

(#) When receiving data or messages for a call, MSG_EOR is flagged by recvmsg
    to indicate the terminal message for that call.

(#) A call may be aborted by adding an abort control message to the control
    data.  Issuing an abort terminates the kernel's use of that call's tag.
    Any messages waiting in the receive queue for that call will be discarded.

(#) Aborts, busy notifications and challenge packets are delivered by recvmsg,
    and control data messages will be set to indicate the context.  Receiving
    an abort or a busy message terminates the kernel's use of that call's tag.

(#) The control data part of the msghdr struct is used for a number of things:

    (#) The tag of the intended or affected call.

    (#) Sending or receiving errors, aborts and busy notifications.

    (#) Notifications of incoming calls.

    (#) Sending debug requests and receiving debug replies [TODO].

(#) When the kernel has received and set up an incoming call, it sends a
    message to server application to let it know there's a new call awaiting
    its acceptance [recvmsg reports a special control message].  The server
    application then uses sendmsg to assign a tag to the new call.  Once that
    is done, the first part of the request data will be delivered by recvmsg.

(#) The server application has to provide the server socket with a keyring of
    secret keys corresponding to the security types it permits.  When a secure
    connection is being set up, the kernel looks up the appropriate secret key
    in the keyring and then sends a challenge packet to the client and
    receives a response packet.  The kernel then checks the authorisation of
    the packet and either aborts the connection or sets up the security.

(#) The name of the key a client will use to secure its communications is
    nominated by a socket option.

”h]”hî)”}”(hhh]”(hó)”}”(hŒXA socket is made into a server socket by binding an address with a
non-zero service ID.
”h]”hÊ)”}”(hŒWA socket is made into a server socket by binding an address with a
non-zero service ID.”h]”hŒWA socket is made into a server socket by binding an address with a
non-zero service ID.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÐhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hŒˆIn the client, sending a request is achieved with one or more sendmsgs,
followed by the reply being received with one or more recvmsgs.
”h]”hÊ)”}”(hŒ‡In the client, sending a request is achieved with one or more sendmsgs,
followed by the reply being received with one or more recvmsgs.”h]”hŒ‡In the client, sending a request is achieved with one or more sendmsgs,
followed by the reply being received with one or more recvmsgs.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÓhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hŒ¹The first sendmsg for a request to be sent from a client contains a tag to
be used in all other sendmsgs or recvmsgs associated with that call.  The
tag is carried in the control data.
”h]”hÊ)”}”(hŒ¸The first sendmsg for a request to be sent from a client contains a tag to
be used in all other sendmsgs or recvmsgs associated with that call.  The
tag is carried in the control data.”h]”hŒ¸The first sendmsg for a request to be sent from a client contains a tag to
be used in all other sendmsgs or recvmsgs associated with that call.  The
tag is carried in the control data.”…””}”(hj6  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÖhj2  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hŒÅconnect() is used to supply a default destination address for a client
socket.  This may be overridden by supplying an alternate address to the
first sendmsg() of a call (struct msghdr::msg_name).
”h]”hÊ)”}”(hŒÄconnect() is used to supply a default destination address for a client
socket.  This may be overridden by supplying an alternate address to the
first sendmsg() of a call (struct msghdr::msg_name).”h]”hŒÄconnect() is used to supply a default destination address for a client
socket.  This may be overridden by supplying an alternate address to the
first sendmsg() of a call (struct msghdr::msg_name).”…””}”(hjN  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÚhjJ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hŒnIf connect() is called on an unbound client, a random local port will
bound before the operation takes place.
”h]”hÊ)”}”(hŒmIf connect() is called on an unbound client, a random local port will
bound before the operation takes place.”h]”hŒmIf connect() is called on an unbound client, a random local port will
bound before the operation takes place.”…””}”(hjf  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÞhjb  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hŒÃA server socket may also be used to make client calls.  To do this, the
first sendmsg() of the call must specify the target address.  The server's
transport endpoint is used to send the packets.
”h]”hÊ)”}”(hŒÂA server socket may also be used to make client calls.  To do this, the
first sendmsg() of the call must specify the target address.  The server's
transport endpoint is used to send the packets.”h]”hŒÄA server socket may also be used to make client calls.  To do this, the
first sendmsg() of the call must specify the target address.  The serverâ€™s
transport endpoint is used to send the packets.”…””}”(hj~  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Káhjz  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hŒøOnce the application has received the last message associated with a call,
the tag is guaranteed not to be seen again, and so it can be used to pin
client resources.  A new call can then be initiated with the same tag
without fear of interference.
”h]”hÊ)”}”(hŒ÷Once the application has received the last message associated with a call,
the tag is guaranteed not to be seen again, and so it can be used to pin
client resources.  A new call can then be initiated with the same tag
without fear of interference.”h]”hŒ÷Once the application has received the last message associated with a call,
the tag is guaranteed not to be seen again, and so it can be used to pin
client resources.  A new call can then be initiated with the same tag
without fear of interference.”…””}”(hj–  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kåhj’  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hŒµIn the server, a request is received with one or more recvmsgs, then the
the reply is transmitted with one or more sendmsgs, and then the final ACK
is received with a last recvmsg.
”h]”hÊ)”}”(hŒ´In the server, a request is received with one or more recvmsgs, then the
the reply is transmitted with one or more sendmsgs, and then the final ACK
is received with a last recvmsg.”h]”hŒ´In the server, a request is received with one or more recvmsgs, then the
the reply is transmitted with one or more sendmsgs, and then the final ACK
is received with a last recvmsg.”…””}”(hj®  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kêhjª  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hŒcWhen sending data for a call, sendmsg is given MSG_MORE if there's more
data to come on that call.
”h]”hÊ)”}”(hŒbWhen sending data for a call, sendmsg is given MSG_MORE if there's more
data to come on that call.”h]”hŒdWhen sending data for a call, sendmsg is given MSG_MORE if thereâ€™s more
data to come on that call.”…””}”(hjÆ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KîhjÂ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hŒcWhen receiving data for a call, recvmsg flags MSG_MORE if there's more
data to come for that call.
”h]”hÊ)”}”(hŒbWhen receiving data for a call, recvmsg flags MSG_MORE if there's more
data to come for that call.”h]”hŒdWhen receiving data for a call, recvmsg flags MSG_MORE if thereâ€™s more
data to come for that call.”…””}”(hjÞ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KñhjÚ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hŒzWhen receiving data or messages for a call, MSG_EOR is flagged by recvmsg
to indicate the terminal message for that call.
”h]”hÊ)”}”(hŒyWhen receiving data or messages for a call, MSG_EOR is flagged by recvmsg
to indicate the terminal message for that call.”h]”hŒyWhen receiving data or messages for a call, MSG_EOR is flagged by recvmsg
to indicate the terminal message for that call.”…””}”(hjö  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kôhjò  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hŒÛA call may be aborted by adding an abort control message to the control
data.  Issuing an abort terminates the kernel's use of that call's tag.
Any messages waiting in the receive queue for that call will be discarded.
”h]”hÊ)”}”(hŒÚA call may be aborted by adding an abort control message to the control
data.  Issuing an abort terminates the kernel's use of that call's tag.
Any messages waiting in the receive queue for that call will be discarded.”h]”hŒÞA call may be aborted by adding an abort control message to the control
data.  Issuing an abort terminates the kernelâ€™s use of that callâ€™s tag.
Any messages waiting in the receive queue for that call will be discarded.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K÷hj
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hŒàAborts, busy notifications and challenge packets are delivered by recvmsg,
and control data messages will be set to indicate the context.  Receiving
an abort or a busy message terminates the kernel's use of that call's tag.
”h]”hÊ)”}”(hŒßAborts, busy notifications and challenge packets are delivered by recvmsg,
and control data messages will be set to indicate the context.  Receiving
an abort or a busy message terminates the kernel's use of that call's tag.”h]”hŒãAborts, busy notifications and challenge packets are delivered by recvmsg,
and control data messages will be set to indicate the context.  Receiving
an abort or a busy message terminates the kernelâ€™s use of that callâ€™s tag.”…””}”(hj&  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kûhj"  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hX!  The control data part of the msghdr struct is used for a number of things:

(#) The tag of the intended or affected call.

(#) Sending or receiving errors, aborts and busy notifications.

(#) Notifications of incoming calls.

(#) Sending debug requests and receiving debug replies [TODO].
”h]”(hÊ)”}”(hŒJThe control data part of the msghdr struct is used for a number of things:”h]”hŒJThe control data part of the msghdr struct is used for a number of things:”…””}”(hj>  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kÿhj:  ubhî)”}”(hhh]”(hó)”}”(hŒ*The tag of the intended or affected call.
”h]”hÊ)”}”(hŒ)The tag of the intended or affected call.”h]”hŒ)The tag of the intended or affected call.”…””}”(hjS  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MhjO  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjL  ubhó)”}”(hŒ<Sending or receiving errors, aborts and busy notifications.
”h]”hÊ)”}”(hŒ;Sending or receiving errors, aborts and busy notifications.”h]”hŒ;Sending or receiving errors, aborts and busy notifications.”…””}”(hjk  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhjg  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjL  ubhó)”}”(hŒ!Notifications of incoming calls.
”h]”hÊ)”}”(hŒ Notifications of incoming calls.”h]”hŒ Notifications of incoming calls.”…””}”(hjƒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjL  ubhó)”}”(hŒ;Sending debug requests and receiving debug replies [TODO].
”h]”hÊ)”}”(hŒ:Sending debug requests and receiving debug replies [TODO].”h]”hŒ:Sending debug requests and receiving debug replies [TODO].”…””}”(hj›  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj—  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjL  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhj:  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hXj  When the kernel has received and set up an incoming call, it sends a
message to server application to let it know there's a new call awaiting
its acceptance [recvmsg reports a special control message].  The server
application then uses sendmsg to assign a tag to the new call.  Once that
is done, the first part of the request data will be delivered by recvmsg.
”h]”hÊ)”}”(hXi  When the kernel has received and set up an incoming call, it sends a
message to server application to let it know there's a new call awaiting
its acceptance [recvmsg reports a special control message].  The server
application then uses sendmsg to assign a tag to the new call.  Once that
is done, the first part of the request data will be delivered by recvmsg.”h]”hXk  When the kernel has received and set up an incoming call, it sends a
message to server application to let it know thereâ€™s a new call awaiting
its acceptance [recvmsg reports a special control message].  The server
application then uses sendmsg to assign a tag to the new call.  Once that
is done, the first part of the request data will be delivered by recvmsg.”…””}”(hj¿  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M	hj»  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hX±  The server application has to provide the server socket with a keyring of
secret keys corresponding to the security types it permits.  When a secure
connection is being set up, the kernel looks up the appropriate secret key
in the keyring and then sends a challenge packet to the client and
receives a response packet.  The kernel then checks the authorisation of
the packet and either aborts the connection or sets up the security.
”h]”hÊ)”}”(hX°  The server application has to provide the server socket with a keyring of
secret keys corresponding to the security types it permits.  When a secure
connection is being set up, the kernel looks up the appropriate secret key
in the keyring and then sends a challenge packet to the client and
receives a response packet.  The kernel then checks the authorisation of
the packet and either aborts the connection or sets up the security.”h]”hX°  The server application has to provide the server socket with a keyring of
secret keys corresponding to the security types it permits.  When a secure
connection is being set up, the kernel looks up the appropriate secret key
in the keyring and then sends a challenge packet to the client and
receives a response packet.  The kernel then checks the authorisation of
the packet and either aborts the connection or sets up the security.”…””}”(hj×  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MhjÓ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubhó)”}”(hŒeThe name of the key a client will use to secure its communications is
nominated by a socket option.

”h]”hÊ)”}”(hŒcThe name of the key a client will use to secure its communications is
nominated by a socket option.”h]”hŒcThe name of the key a client will use to secure its communications is
nominated by a socket option.”…””}”(hjï  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhjë  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÿ  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhjû  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h KÐhjË  hžhubhÊ)”}”(hŒNotes on sendmsg:”h]”hŒNotes on sendmsg:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MhjË  hžhubhè)”}”(hXÍ  (#) MSG_WAITALL can be set to tell sendmsg to ignore signals if the peer is
    making progress at accepting packets within a reasonable time such that we
    manage to queue up all the data for transmission.  This requires the
    client to accept at least one packet per 2*RTT time period.

    If this isn't set, sendmsg() will return immediately, either returning
    EINTR/ERESTARTSYS if nothing was consumed or returning the amount of data
    consumed.

”h]”hî)”}”(hhh]”hó)”}”(hX±  MSG_WAITALL can be set to tell sendmsg to ignore signals if the peer is
making progress at accepting packets within a reasonable time such that we
manage to queue up all the data for transmission.  This requires the
client to accept at least one packet per 2*RTT time period.

If this isn't set, sendmsg() will return immediately, either returning
EINTR/ERESTARTSYS if nothing was consumed or returning the amount of data
consumed.

”h]”(hÊ)”}”(hX  MSG_WAITALL can be set to tell sendmsg to ignore signals if the peer is
making progress at accepting packets within a reasonable time such that we
manage to queue up all the data for transmission.  This requires the
client to accept at least one packet per 2*RTT time period.”h]”hX  MSG_WAITALL can be set to tell sendmsg to ignore signals if the peer is
making progress at accepting packets within a reasonable time such that we
manage to queue up all the data for transmission.  This requires the
client to accept at least one packet per 2*RTT time period.”…””}”(hj(  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj$  ubhÊ)”}”(hŒšIf this isn't set, sendmsg() will return immediately, either returning
EINTR/ERESTARTSYS if nothing was consumed or returning the amount of data
consumed.”h]”hŒœIf this isnâ€™t set, sendmsg() will return immediately, either returning
EINTR/ERESTARTSYS if nothing was consumed or returning the amount of data
consumed.”…””}”(hj6  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M!hj$  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj!  ubah}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h MhjË  hžhubhÊ)”}”(hŒNotes on recvmsg:”h]”hŒNotes on recvmsg:”…””}”(hjV  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M&hjË  hžhubhè)”}”(hX  (#) If there's a sequence of data messages belonging to a particular call on
    the receive queue, then recvmsg will keep working through them until:

    (a) it meets the end of that call's received data,

    (b) it meets a non-data message,

    (c) it meets a message belonging to a different call, or

    (d) it fills the user buffer.

    If recvmsg is called in blocking mode, it will keep sleeping, awaiting the
    reception of further data, until one of the above four conditions is met.

(2) MSG_PEEK operates similarly, but will return immediately if it has put any
    data in the buffer rather than sleeping until it can fill the buffer.

(3) If a data message is only partially consumed in filling a user buffer,
    then the remainder of that message will be left on the front of the queue
    for the next taker.  MSG_TRUNC will never be flagged.

(4) If there is more data to be had on a call (it hasn't copied the last byte
    of the last data message in that phase yet), then MSG_MORE will be
    flagged.

”h]”(hî)”}”(hhh]”hó)”}”(hXÔ  If there's a sequence of data messages belonging to a particular call on
the receive queue, then recvmsg will keep working through them until:

(a) it meets the end of that call's received data,

(b) it meets a non-data message,

(c) it meets a message belonging to a different call, or

(d) it fills the user buffer.

If recvmsg is called in blocking mode, it will keep sleeping, awaiting the
reception of further data, until one of the above four conditions is met.
”h]”(hÊ)”}”(hŒŽIf there's a sequence of data messages belonging to a particular call on
the receive queue, then recvmsg will keep working through them until:”h]”hŒIf thereâ€™s a sequence of data messages belonging to a particular call on
the receive queue, then recvmsg will keep working through them until:”…””}”(hjo  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M(hjk  ubhî)”}”(hhh]”(hó)”}”(hŒ/it meets the end of that call's received data,
”h]”hÊ)”}”(hŒ.it meets the end of that call's received data,”h]”hŒ0it meets the end of that callâ€™s received data,”…””}”(hj„  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M+hj€  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj}  ubhó)”}”(hŒit meets a non-data message,
”h]”hÊ)”}”(hŒit meets a non-data message,”h]”hŒit meets a non-data message,”…””}”(hjœ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M-hj˜  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj}  ubhó)”}”(hŒ5it meets a message belonging to a different call, or
”h]”hÊ)”}”(hŒ4it meets a message belonging to a different call, or”h]”hŒ4it meets a message belonging to a different call, or”…””}”(hj´  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M/hj°  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj}  ubhó)”}”(hŒit fills the user buffer.
”h]”hÊ)”}”(hŒit fills the user buffer.”h]”hŒit fills the user buffer.”…””}”(hjÌ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M1hjÈ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj}  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  Œ
loweralpha”jì  jí  jî  jï  uh1híhjk  ubhÊ)”}”(hŒ”If recvmsg is called in blocking mode, it will keep sleeping, awaiting the
reception of further data, until one of the above four conditions is met.”h]”hŒ”If recvmsg is called in blocking mode, it will keep sleeping, awaiting the
reception of further data, until one of the above four conditions is met.”…””}”(hjç  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M3hjk  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjh  ubah}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhjd  ubhî)”}”(hhh]”(hó)”}”(hŒ‘MSG_PEEK operates similarly, but will return immediately if it has put any
data in the buffer rather than sleeping until it can fill the buffer.
”h]”hÊ)”}”(hŒMSG_PEEK operates similarly, but will return immediately if it has put any
data in the buffer rather than sleeping until it can fill the buffer.”h]”hŒMSG_PEEK operates similarly, but will return immediately if it has put any
data in the buffer rather than sleeping until it can fill the buffer.”…””}”(hj	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M6hj	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj	  ubhó)”}”(hŒÇIf a data message is only partially consumed in filling a user buffer,
then the remainder of that message will be left on the front of the queue
for the next taker.  MSG_TRUNC will never be flagged.
”h]”hÊ)”}”(hŒÆIf a data message is only partially consumed in filling a user buffer,
then the remainder of that message will be left on the front of the queue
for the next taker.  MSG_TRUNC will never be flagged.”h]”hŒÆIf a data message is only partially consumed in filling a user buffer,
then the remainder of that message will be left on the front of the queue
for the next taker.  MSG_TRUNC will never be flagged.”…””}”(hj 	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M9hj	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj	  ubhó)”}”(hŒ—If there is more data to be had on a call (it hasn't copied the last byte
of the last data message in that phase yet), then MSG_MORE will be
flagged.

”h]”hÊ)”}”(hŒ•If there is more data to be had on a call (it hasn't copied the last byte
of the last data message in that phase yet), then MSG_MORE will be
flagged.”h]”hŒ—If there is more data to be had on a call (it hasnâ€™t copied the last byte
of the last data message in that phase yet), then MSG_MORE will be
flagged.”…””}”(hj8	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M=hj4	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhj	  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  Œstart”Kuh1híhjd  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h M(hjË  hžhubeh}”(h]”Œaf-rxrpc-driver-model”ah ]”h"]”Œaf_rxrpc driver model”ah$]”h&]”uh1h´hh¶hžhhŸh³h K¦ubhµ)”}”(hhh]”(hº)”}”(hŒControl Messages”h]”hŒControl Messages”…””}”(hjd	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hja	  hžhhŸh³h MCubhÊ)”}”(hŒAF_RXRPC makes use of control messages in sendmsg() and recvmsg() to multiplex
calls, to invoke certain actions and to report certain conditions.  These are:”h]”hŒAF_RXRPC makes use of control messages in sendmsg() and recvmsg() to multiplex
calls, to invoke certain actions and to report certain conditions.  These are:”…””}”(hjr	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MEhja	  hžhubhè)”}”(hXþ         ======================= === =========== ===============================
       MESSAGE ID              SRT DATA        MEANING
       ======================= === =========== ===============================
       RXRPC_USER_CALL_ID      sr- User ID     App's call specifier
       RXRPC_ABORT             srt Abort code  Abort code to issue/received
       RXRPC_ACK               -rt n/a         Final ACK received
       RXRPC_NET_ERROR         -rt error num   Network error on call
       RXRPC_BUSY              -rt n/a         Call rejected (server busy)
       RXRPC_LOCAL_ERROR       -rt error num   Local error encountered
       RXRPC_NEW_CALL          -r- n/a         New call received
       RXRPC_ACCEPT            s-- n/a         Accept new call
       RXRPC_EXCLUSIVE_CALL    s-- n/a         Make an exclusive client call
       RXRPC_UPGRADE_SERVICE   s-- n/a         Client call can be upgraded
       RXRPC_TX_LENGTH         s-- data len    Total length of Tx data
       ======================= === =========== ===============================

       (SRT = usable in Sendmsg / delivered by Recvmsg / Terminal message)

(#) RXRPC_USER_CALL_ID

    This is used to indicate the application's call ID.  It's an unsigned long
    that the app specifies in the client by attaching it to the first data
    message or in the server by passing it in association with an RXRPC_ACCEPT
    message.  recvmsg() passes it in conjunction with all messages except
    those of the RXRPC_NEW_CALL message.

(#) RXRPC_ABORT

    This is can be used by an application to abort a call by passing it to
    sendmsg, or it can be delivered by recvmsg to indicate a remote abort was
    received.  Either way, it must be associated with an RXRPC_USER_CALL_ID to
    specify the call affected.  If an abort is being sent, then error EBADSLT
    will be returned if there is no call with that user ID.

(#) RXRPC_ACK

    This is delivered to a server application to indicate that the final ACK
    of a call was received from the client.  It will be associated with an
    RXRPC_USER_CALL_ID to indicate the call that's now complete.

(#) RXRPC_NET_ERROR

    This is delivered to an application to indicate that an ICMP error message
    was encountered in the process of trying to talk to the peer.  An
    errno-class integer value will be included in the control message data
    indicating the problem, and an RXRPC_USER_CALL_ID will indicate the call
    affected.

(#) RXRPC_BUSY

    This is delivered to a client application to indicate that a call was
    rejected by the server due to the server being busy.  It will be
    associated with an RXRPC_USER_CALL_ID to indicate the rejected call.

(#) RXRPC_LOCAL_ERROR

    This is delivered to an application to indicate that a local error was
    encountered and that a call has been aborted because of it.  An
    errno-class integer value will be included in the control message data
    indicating the problem, and an RXRPC_USER_CALL_ID will indicate the call
    affected.

(#) RXRPC_NEW_CALL

    This is delivered to indicate to a server application that a new call has
    arrived and is awaiting acceptance.  No user ID is associated with this,
    as a user ID must subsequently be assigned by doing an RXRPC_ACCEPT.

(#) RXRPC_ACCEPT

    This is used by a server application to attempt to accept a call and
    assign it a user ID.  It should be associated with an RXRPC_USER_CALL_ID
    to indicate the user ID to be assigned.  If there is no call to be
    accepted (it may have timed out, been aborted, etc.), then sendmsg will
    return error ENODATA.  If the user ID is already in use by another call,
    then error EBADSLT will be returned.

(#) RXRPC_EXCLUSIVE_CALL

    This is used to indicate that a client call should be made on a one-off
    connection.  The connection is discarded once the call has terminated.

(#) RXRPC_UPGRADE_SERVICE

    This is used to make a client call to probe if the specified service ID
    may be upgraded by the server.  The caller must check msg_name returned to
    recvmsg() for the service ID actually in use.  The operation probed must
    be one that takes the same arguments in both services.

    Once this has been used to establish the upgrade capability (or lack
    thereof) of the server, the service ID returned should be used for all
    future communication to that server and RXRPC_UPGRADE_SERVICE should no
    longer be set.

(#) RXRPC_TX_LENGTH

    This is used to inform the kernel of the total amount of data that is
    going to be transmitted by a call (whether in a client request or a
    service response).  If given, it allows the kernel to encrypt from the
    userspace buffer directly to the packet buffers, rather than copying into
    the buffer and then encrypting in place.  This may only be given with the
    first sendmsg() providing data for a call.  EMSGSIZE will be generated if
    the amount of data actually given is different.

    This takes a parameter of __s64 type that indicates how much will be
    transmitted.  This may not be less than zero.
”•™      h]”(hè)”}”(hX  ======================= === =========== ===============================
MESSAGE ID              SRT DATA        MEANING
======================= === =========== ===============================
RXRPC_USER_CALL_ID      sr- User ID     App's call specifier
RXRPC_ABORT             srt Abort code  Abort code to issue/received
RXRPC_ACK               -rt n/a         Final ACK received
RXRPC_NET_ERROR         -rt error num   Network error on call
RXRPC_BUSY              -rt n/a         Call rejected (server busy)
RXRPC_LOCAL_ERROR       -rt error num   Local error encountered
RXRPC_NEW_CALL          -r- n/a         New call received
RXRPC_ACCEPT            s-- n/a         Accept new call
RXRPC_EXCLUSIVE_CALL    s-- n/a         Make an exclusive client call
RXRPC_UPGRADE_SERVICE   s-- n/a         Client call can be upgraded
RXRPC_TX_LENGTH         s-- data len    Total length of Tx data
======================= === =========== ===============================

(SRT = usable in Sendmsg / delivered by Recvmsg / Terminal message)
”h]”(hŒtable”“”)”}”(hhh]”hŒtgroup”“”)”}”(hhh]”(hŒcolspec”“”)”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j’	  hj	  ubj“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j’	  hj	  ubj“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j’	  hj	  ubj“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j’	  hj	  ubhŒthead”“”)”}”(hhh]”hŒrow”“”)”}”(hhh]”(hŒentry”“”)”}”(hhh]”hÊ)”}”(hŒ
MESSAGE ID”h]”hŒ
MESSAGE ID”…””}”(hjË	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MIhjÈ	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÃ	  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒSRT”h]”hŒSRT”…””}”(hjâ	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MIhjß	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÃ	  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒDATA”h]”hŒDATA”…””}”(hjù	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MIhjö	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÃ	  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒMEANING”h]”hŒMEANING”…””}”(hj
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MIhj
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÃ	  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj¾	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¼	  hj	  ubhŒtbody”“”)”}”(hhh]”(jÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_USER_CALL_ID”h]”hŒRXRPC_USER_CALL_ID”…””}”(hj;
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MKhj8
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj5
  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒsr-”h]”hŒsr-”…””}”(hjR
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MKhjO
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj5
  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒUser ID”h]”hŒUser ID”…””}”(hji
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MKhjf
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj5
  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒApp's call specifier”h]”hŒAppâ€™s call specifier”…””}”(hj€
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MKhj}
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj5
  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj2
  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_ABORT”h]”hŒRXRPC_ABORT”…””}”(hj 
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MLhj
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjš
  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒsrt”h]”hŒsrt”…””}”(hj·
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MLhj´
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjš
  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ
Abort code”h]”hŒ
Abort code”…””}”(hjÎ
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MLhjË
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjš
  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒAbort code to issue/received”h]”hŒAbort code to issue/received”…””}”(hjå
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MLhjâ
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjš
  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj2
  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒ	RXRPC_ACK”h]”hŒ	RXRPC_ACK”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MMhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÿ
  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ-rt”h]”hŒ-rt”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MMhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÿ
  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒn/a”h]”hŒn/a”…””}”(hj3  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MMhj0  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÿ
  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒFinal ACK received”h]”hŒFinal ACK received”…””}”(hjJ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MMhjG  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÿ
  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj2
  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_NET_ERROR”h]”hŒRXRPC_NET_ERROR”…””}”(hjj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MNhjg  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjd  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ-rt”h]”hŒ-rt”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MNhj~  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjd  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ	error num”h]”hŒ	error num”…””}”(hj˜  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MNhj•  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjd  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒNetwork error on call”h]”hŒNetwork error on call”…””}”(hj¯  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MNhj¬  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjd  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj2
  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒ
RXRPC_BUSY”h]”hŒ
RXRPC_BUSY”…””}”(hjÏ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MOhjÌ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÉ  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ-rt”h]”hŒ-rt”…””}”(hjæ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MOhjã  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÉ  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒn/a”h]”hŒn/a”…””}”(hjý  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MOhjú  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÉ  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒCall rejected (server busy)”h]”hŒCall rejected (server busy)”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MOhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÉ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj2
  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_LOCAL_ERROR”h]”hŒRXRPC_LOCAL_ERROR”…””}”(hj4  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MPhj1  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj.  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ-rt”h]”hŒ-rt”…””}”(hjK  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MPhjH  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj.  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ	error num”h]”hŒ	error num”…””}”(hjb  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MPhj_  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj.  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒLocal error encountered”h]”hŒLocal error encountered”…””}”(hjy  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MPhjv  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj.  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj2
  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_NEW_CALL”h]”hŒRXRPC_NEW_CALL”…””}”(hj™  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MQhj–  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj“  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ-r-”h]”hŒ-r-”…””}”(hj°  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MQhj­  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj“  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒn/a”h]”hŒn/a”…””}”(hjÇ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MQhjÄ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj“  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒNew call received”h]”hŒNew call received”…””}”(hjÞ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MQhjÛ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj“  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj2
  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_ACCEPT”h]”hŒRXRPC_ACCEPT”…””}”(hjþ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MRhjû  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjø  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒs--”h]”hŒs--”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MRhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjø  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒn/a”h]”hŒn/a”…””}”(hj,  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MRhj)  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjø  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒAccept new call”h]”hŒAccept new call”…””}”(hjC  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MRhj@  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjø  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj2
  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_EXCLUSIVE_CALL”h]”hŒRXRPC_EXCLUSIVE_CALL”…””}”(hjc  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MShj`  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj]  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒs--”h]”hŒs--”…””}”(hjz  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MShjw  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj]  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒn/a”h]”hŒn/a”…””}”(hj‘  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MShjŽ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj]  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒMake an exclusive client call”h]”hŒMake an exclusive client call”…””}”(hj¨  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MShj¥  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj]  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj2
  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_UPGRADE_SERVICE”h]”hŒRXRPC_UPGRADE_SERVICE”…””}”(hjÈ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MThjÅ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÂ  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒs--”h]”hŒs--”…””}”(hjß  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MThjÜ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÂ  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒn/a”h]”hŒn/a”…””}”(hjö  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MThjó  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÂ  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒClient call can be upgraded”h]”hŒClient call can be upgraded”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MThj
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÂ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj2
  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_TX_LENGTH”h]”hŒRXRPC_TX_LENGTH”…””}”(hj-  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MUhj*  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj'  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒs--”h]”hŒs--”…””}”(hjD  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MUhjA  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj'  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒdata len”h]”hŒdata len”…””}”(hj[  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MUhjX  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj'  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒTotal length of Tx data”h]”hŒTotal length of Tx data”…””}”(hjr  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MUhjo  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj'  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj2
  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j0
  hj	  ubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1j	  hjŠ	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jˆ	  hj„	  ubhÊ)”}”(hŒC(SRT = usable in Sendmsg / delivered by Recvmsg / Terminal message)”h]”hŒC(SRT = usable in Sendmsg / delivered by Recvmsg / Terminal message)”…””}”(hjŸ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MXhj„	  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h MHhj€	  ubhî)”}”(hhh]”(hó)”}”(hX\  RXRPC_USER_CALL_ID

This is used to indicate the application's call ID.  It's an unsigned long
that the app specifies in the client by attaching it to the first data
message or in the server by passing it in association with an RXRPC_ACCEPT
message.  recvmsg() passes it in conjunction with all messages except
those of the RXRPC_NEW_CALL message.
”h]”(hÊ)”}”(hŒRXRPC_USER_CALL_ID”h]”hŒRXRPC_USER_CALL_ID”…””}”(hjº  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MZhj¶  ubhÊ)”}”(hXG  This is used to indicate the application's call ID.  It's an unsigned long
that the app specifies in the client by attaching it to the first data
message or in the server by passing it in association with an RXRPC_ACCEPT
message.  recvmsg() passes it in conjunction with all messages except
those of the RXRPC_NEW_CALL message.”h]”hXK  This is used to indicate the applicationâ€™s call ID.  Itâ€™s an unsigned long
that the app specifies in the client by attaching it to the first data
message or in the server by passing it in association with an RXRPC_ACCEPT
message.  recvmsg() passes it in conjunction with all messages except
those of the RXRPC_NEW_CALL message.”…””}”(hjÈ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M\hj¶  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj³  ubhó)”}”(hXk  RXRPC_ABORT

This is can be used by an application to abort a call by passing it to
sendmsg, or it can be delivered by recvmsg to indicate a remote abort was
received.  Either way, it must be associated with an RXRPC_USER_CALL_ID to
specify the call affected.  If an abort is being sent, then error EBADSLT
will be returned if there is no call with that user ID.
”h]”(hÊ)”}”(hŒRXRPC_ABORT”h]”hŒRXRPC_ABORT”…””}”(hjà  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MbhjÜ  ubhÊ)”}”(hX]  This is can be used by an application to abort a call by passing it to
sendmsg, or it can be delivered by recvmsg to indicate a remote abort was
received.  Either way, it must be associated with an RXRPC_USER_CALL_ID to
specify the call affected.  If an abort is being sent, then error EBADSLT
will be returned if there is no call with that user ID.”h]”hX]  This is can be used by an application to abort a call by passing it to
sendmsg, or it can be delivered by recvmsg to indicate a remote abort was
received.  Either way, it must be associated with an RXRPC_USER_CALL_ID to
specify the call affected.  If an abort is being sent, then error EBADSLT
will be returned if there is no call with that user ID.”…””}”(hjî  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MdhjÜ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj³  ubhó)”}”(hŒØRXRPC_ACK

This is delivered to a server application to indicate that the final ACK
of a call was received from the client.  It will be associated with an
RXRPC_USER_CALL_ID to indicate the call that's now complete.
”h]”(hÊ)”}”(hŒ	RXRPC_ACK”h]”hŒ	RXRPC_ACK”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mjhj  ubhÊ)”}”(hŒÌThis is delivered to a server application to indicate that the final ACK
of a call was received from the client.  It will be associated with an
RXRPC_USER_CALL_ID to indicate the call that's now complete.”h]”hŒÎThis is delivered to a server application to indicate that the final ACK
of a call was received from the client.  It will be associated with an
RXRPC_USER_CALL_ID to indicate the call thatâ€™s now complete.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mlhj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj³  ubhó)”}”(hX8  RXRPC_NET_ERROR

This is delivered to an application to indicate that an ICMP error message
was encountered in the process of trying to talk to the peer.  An
errno-class integer value will be included in the control message data
indicating the problem, and an RXRPC_USER_CALL_ID will indicate the call
affected.
”h]”(hÊ)”}”(hŒRXRPC_NET_ERROR”h]”hŒRXRPC_NET_ERROR”…””}”(hj,  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mphj(  ubhÊ)”}”(hX&  This is delivered to an application to indicate that an ICMP error message
was encountered in the process of trying to talk to the peer.  An
errno-class integer value will be included in the control message data
indicating the problem, and an RXRPC_USER_CALL_ID will indicate the call
affected.”h]”hX&  This is delivered to an application to indicate that an ICMP error message
was encountered in the process of trying to talk to the peer.  An
errno-class integer value will be included in the control message data
indicating the problem, and an RXRPC_USER_CALL_ID will indicate the call
affected.”…””}”(hj:  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mrhj(  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj³  ubhó)”}”(hŒØRXRPC_BUSY

This is delivered to a client application to indicate that a call was
rejected by the server due to the server being busy.  It will be
associated with an RXRPC_USER_CALL_ID to indicate the rejected call.
”h]”(hÊ)”}”(hŒ
RXRPC_BUSY”h]”hŒ
RXRPC_BUSY”…””}”(hjR  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MxhjN  ubhÊ)”}”(hŒËThis is delivered to a client application to indicate that a call was
rejected by the server due to the server being busy.  It will be
associated with an RXRPC_USER_CALL_ID to indicate the rejected call.”h]”hŒËThis is delivered to a client application to indicate that a call was
rejected by the server due to the server being busy.  It will be
associated with an RXRPC_USER_CALL_ID to indicate the rejected call.”…””}”(hj`  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MzhjN  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj³  ubhó)”}”(hX4  RXRPC_LOCAL_ERROR

This is delivered to an application to indicate that a local error was
encountered and that a call has been aborted because of it.  An
errno-class integer value will be included in the control message data
indicating the problem, and an RXRPC_USER_CALL_ID will indicate the call
affected.
”h]”(hÊ)”}”(hŒRXRPC_LOCAL_ERROR”h]”hŒRXRPC_LOCAL_ERROR”…””}”(hjx  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M~hjt  ubhÊ)”}”(hX   This is delivered to an application to indicate that a local error was
encountered and that a call has been aborted because of it.  An
errno-class integer value will be included in the control message data
indicating the problem, and an RXRPC_USER_CALL_ID will indicate the call
affected.”h]”hX   This is delivered to an application to indicate that a local error was
encountered and that a call has been aborted because of it.  An
errno-class integer value will be included in the control message data
indicating the problem, and an RXRPC_USER_CALL_ID will indicate the call
affected.”…””}”(hj†  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M€hjt  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj³  ubhó)”}”(hŒèRXRPC_NEW_CALL

This is delivered to indicate to a server application that a new call has
arrived and is awaiting acceptance.  No user ID is associated with this,
as a user ID must subsequently be assigned by doing an RXRPC_ACCEPT.
”h]”(hÊ)”}”(hŒRXRPC_NEW_CALL”h]”hŒRXRPC_NEW_CALL”…””}”(hjž  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M†hjš  ubhÊ)”}”(hŒ×This is delivered to indicate to a server application that a new call has
arrived and is awaiting acceptance.  No user ID is associated with this,
as a user ID must subsequently be assigned by doing an RXRPC_ACCEPT.”h]”hŒ×This is delivered to indicate to a server application that a new call has
arrived and is awaiting acceptance.  No user ID is associated with this,
as a user ID must subsequently be assigned by doing an RXRPC_ACCEPT.”…””}”(hj¬  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mˆhjš  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj³  ubhó)”}”(hX•  RXRPC_ACCEPT

This is used by a server application to attempt to accept a call and
assign it a user ID.  It should be associated with an RXRPC_USER_CALL_ID
to indicate the user ID to be assigned.  If there is no call to be
accepted (it may have timed out, been aborted, etc.), then sendmsg will
return error ENODATA.  If the user ID is already in use by another call,
then error EBADSLT will be returned.
”h]”(hÊ)”}”(hŒRXRPC_ACCEPT”h]”hŒRXRPC_ACCEPT”…””}”(hjÄ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MŒhjÀ  ubhÊ)”}”(hX†  This is used by a server application to attempt to accept a call and
assign it a user ID.  It should be associated with an RXRPC_USER_CALL_ID
to indicate the user ID to be assigned.  If there is no call to be
accepted (it may have timed out, been aborted, etc.), then sendmsg will
return error ENODATA.  If the user ID is already in use by another call,
then error EBADSLT will be returned.”h]”hX†  This is used by a server application to attempt to accept a call and
assign it a user ID.  It should be associated with an RXRPC_USER_CALL_ID
to indicate the user ID to be assigned.  If there is no call to be
accepted (it may have timed out, been aborted, etc.), then sendmsg will
return error ENODATA.  If the user ID is already in use by another call,
then error EBADSLT will be returned.”…””}”(hjÒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MŽhjÀ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj³  ubhó)”}”(hŒ¥RXRPC_EXCLUSIVE_CALL

This is used to indicate that a client call should be made on a one-off
connection.  The connection is discarded once the call has terminated.
”h]”(hÊ)”}”(hŒRXRPC_EXCLUSIVE_CALL”h]”hŒRXRPC_EXCLUSIVE_CALL”…””}”(hjê  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M•hjæ  ubhÊ)”}”(hŒŽThis is used to indicate that a client call should be made on a one-off
connection.  The connection is discarded once the call has terminated.”h]”hŒŽThis is used to indicate that a client call should be made on a one-off
connection.  The connection is discarded once the call has terminated.”…””}”(hjø  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M—hjæ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj³  ubhó)”}”(hX  RXRPC_UPGRADE_SERVICE

This is used to make a client call to probe if the specified service ID
may be upgraded by the server.  The caller must check msg_name returned to
recvmsg() for the service ID actually in use.  The operation probed must
be one that takes the same arguments in both services.

Once this has been used to establish the upgrade capability (or lack
thereof) of the server, the service ID returned should be used for all
future communication to that server and RXRPC_UPGRADE_SERVICE should no
longer be set.
”h]”(hÊ)”}”(hŒRXRPC_UPGRADE_SERVICE”h]”hŒRXRPC_UPGRADE_SERVICE”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mšhj  ubhÊ)”}”(hX  This is used to make a client call to probe if the specified service ID
may be upgraded by the server.  The caller must check msg_name returned to
recvmsg() for the service ID actually in use.  The operation probed must
be one that takes the same arguments in both services.”h]”hX  This is used to make a client call to probe if the specified service ID
may be upgraded by the server.  The caller must check msg_name returned to
recvmsg() for the service ID actually in use.  The operation probed must
be one that takes the same arguments in both services.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mœhj  ubhÊ)”}”(hŒâOnce this has been used to establish the upgrade capability (or lack
thereof) of the server, the service ID returned should be used for all
future communication to that server and RXRPC_UPGRADE_SERVICE should no
longer be set.”h]”hŒâOnce this has been used to establish the upgrade capability (or lack
thereof) of the server, the service ID returned should be used for all
future communication to that server and RXRPC_UPGRADE_SERVICE should no
longer be set.”…””}”(hj,  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M¡hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj³  ubhó)”}”(hXd  RXRPC_TX_LENGTH

This is used to inform the kernel of the total amount of data that is
going to be transmitted by a call (whether in a client request or a
service response).  If given, it allows the kernel to encrypt from the
userspace buffer directly to the packet buffers, rather than copying into
the buffer and then encrypting in place.  This may only be given with the
first sendmsg() providing data for a call.  EMSGSIZE will be generated if
the amount of data actually given is different.

This takes a parameter of __s64 type that indicates how much will be
transmitted.  This may not be less than zero.
”h]”(hÊ)”}”(hŒRXRPC_TX_LENGTH”h]”hŒRXRPC_TX_LENGTH”…””}”(hjD  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M¦hj@  ubhÊ)”}”(hXÞ  This is used to inform the kernel of the total amount of data that is
going to be transmitted by a call (whether in a client request or a
service response).  If given, it allows the kernel to encrypt from the
userspace buffer directly to the packet buffers, rather than copying into
the buffer and then encrypting in place.  This may only be given with the
first sendmsg() providing data for a call.  EMSGSIZE will be generated if
the amount of data actually given is different.”h]”hXÞ  This is used to inform the kernel of the total amount of data that is
going to be transmitted by a call (whether in a client request or a
service response).  If given, it allows the kernel to encrypt from the
userspace buffer directly to the packet buffers, rather than copying into
the buffer and then encrypting in place.  This may only be given with the
first sendmsg() providing data for a call.  EMSGSIZE will be generated if
the amount of data actually given is different.”…””}”(hjR  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M¨hj@  ubhÊ)”}”(hŒrThis takes a parameter of __s64 type that indicates how much will be
transmitted.  This may not be less than zero.”h]”hŒrThis takes a parameter of __s64 type that indicates how much will be
transmitted.  This may not be less than zero.”…””}”(hj`  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M°hj@  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj³  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhj€	  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h MHhja	  hžhubhÊ)”}”(hŒÄThe symbol RXRPC__SUPPORTED is defined as one more than the highest control
message type supported.  At run time this can be queried by means of the
RXRPC_SUPPORTED_CMSG socket option (see below).”h]”hŒÄThe symbol RXRPC__SUPPORTED is defined as one more than the highest control
message type supported.  At run time this can be queried by means of the
RXRPC_SUPPORTED_CMSG socket option (see below).”…””}”(hj€  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M³hja	  hžhubeh}”(h]”Œcontrol-messages”ah ]”h"]”Œcontrol messages”ah$]”h&]”uh1h´hh¶hžhhŸh³h MCubeh}”(h]”Œrxrpc-network-protocol”ah ]”h"]”Œrxrpc network protocol”ah$]”h&]”uh1h´hhhžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒSOCKET OPTIONS”h]”hŒSOCKET OPTIONS”…””}”(hj¡  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjž  hžhhŸh³h MºubhÊ)”}”(hŒEAF_RXRPC sockets support a few socket options at the SOL_RXRPC level:”h]”hŒEAF_RXRPC sockets support a few socket options at the SOL_RXRPC level:”…””}”(hj¯  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M¼hjž  hžhubhè)”}”(hXÐ  (#) RXRPC_SECURITY_KEY

    This is used to specify the description of the key to be used.  The key is
    extracted from the calling process's keyrings with request_key() and
    should be of "rxrpc" type.

    The optval pointer points to the description string, and optlen indicates
    how long the string is, without the NUL terminator.

(#) RXRPC_SECURITY_KEYRING

    Similar to above but specifies a keyring of server secret keys to use (key
    type "keyring").  See the "Security" section.

(#) RXRPC_EXCLUSIVE_CONNECTION

    This is used to request that new connections should be used for each call
    made subsequently on this socket.  optval should be NULL and optlen 0.

(#) RXRPC_MIN_SECURITY_LEVEL

    This is used to specify the minimum security level required for calls on
    this socket.  optval must point to an int containing one of the following
    values:

    (a) RXRPC_SECURITY_PLAIN

        Encrypted checksum only.

    (b) RXRPC_SECURITY_AUTH

        Encrypted checksum plus packet padded and first eight bytes of packet
        encrypted - which includes the actual packet length.

    (c) RXRPC_SECURITY_ENCRYPT

        Encrypted checksum plus entire packet padded and encrypted, including
        actual packet length.

(#) RXRPC_UPGRADEABLE_SERVICE

    This is used to indicate that a service socket with two bindings may
    upgrade one bound service to the other if requested by the client.  optval
    must point to an array of two unsigned short ints.  The first is the
    service ID to upgrade from and the second the service ID to upgrade to.

(#) RXRPC_SUPPORTED_CMSG

    This is a read-only option that writes an int into the buffer indicating
    the highest control message type supported.

”h]”hî)”}”(hhh]”(hó)”}”(hX>  RXRPC_SECURITY_KEY

This is used to specify the description of the key to be used.  The key is
extracted from the calling process's keyrings with request_key() and
should be of "rxrpc" type.

The optval pointer points to the description string, and optlen indicates
how long the string is, without the NUL terminator.
”h]”(hÊ)”}”(hŒRXRPC_SECURITY_KEY”h]”hŒRXRPC_SECURITY_KEY”…””}”(hjÈ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M¾hjÄ  ubhÊ)”}”(hŒªThis is used to specify the description of the key to be used.  The key is
extracted from the calling process's keyrings with request_key() and
should be of "rxrpc" type.”h]”hŒ°This is used to specify the description of the key to be used.  The key is
extracted from the calling processâ€™s keyrings with request_key() and
should be of â€œrxrpcâ€ type.”…””}”(hjÖ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÀhjÄ  ubhÊ)”}”(hŒ}The optval pointer points to the description string, and optlen indicates
how long the string is, without the NUL terminator.”h]”hŒ}The optval pointer points to the description string, and optlen indicates
how long the string is, without the NUL terminator.”…””}”(hjä  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÄhjÄ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÁ  ubhó)”}”(hŒ‘RXRPC_SECURITY_KEYRING

Similar to above but specifies a keyring of server secret keys to use (key
type "keyring").  See the "Security" section.
”h]”(hÊ)”}”(hŒRXRPC_SECURITY_KEYRING”h]”hŒRXRPC_SECURITY_KEYRING”…””}”(hjü  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÇhjø  ubhÊ)”}”(hŒxSimilar to above but specifies a keyring of server secret keys to use (key
type "keyring").  See the "Security" section.”h]”hŒ€Similar to above but specifies a keyring of server secret keys to use (key
type â€œkeyringâ€).  See the â€œSecurityâ€ section.”…””}”(hj
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÉhjø  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÁ  ubhó)”}”(hŒ­RXRPC_EXCLUSIVE_CONNECTION

This is used to request that new connections should be used for each call
made subsequently on this socket.  optval should be NULL and optlen 0.
”h]”(hÊ)”}”(hŒRXRPC_EXCLUSIVE_CONNECTION”h]”hŒRXRPC_EXCLUSIVE_CONNECTION”…””}”(hj"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÌhj  ubhÊ)”}”(hŒThis is used to request that new connections should be used for each call
made subsequently on this socket.  optval should be NULL and optlen 0.”h]”hŒThis is used to request that new connections should be used for each call
made subsequently on this socket.  optval should be NULL and optlen 0.”…””}”(hj0  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÎhj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÁ  ubhó)”}”(hX  RXRPC_MIN_SECURITY_LEVEL

This is used to specify the minimum security level required for calls on
this socket.  optval must point to an int containing one of the following
values:

(a) RXRPC_SECURITY_PLAIN

    Encrypted checksum only.

(b) RXRPC_SECURITY_AUTH

    Encrypted checksum plus packet padded and first eight bytes of packet
    encrypted - which includes the actual packet length.

(c) RXRPC_SECURITY_ENCRYPT

    Encrypted checksum plus entire packet padded and encrypted, including
    actual packet length.
”h]”(hÊ)”}”(hŒRXRPC_MIN_SECURITY_LEVEL”h]”hŒRXRPC_MIN_SECURITY_LEVEL”…””}”(hjH  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÑhjD  ubhÊ)”}”(hŒšThis is used to specify the minimum security level required for calls on
this socket.  optval must point to an int containing one of the following
values:”h]”hŒšThis is used to specify the minimum security level required for calls on
this socket.  optval must point to an int containing one of the following
values:”…””}”(hjV  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÓhjD  ubhî)”}”(hhh]”(hó)”}”(hŒ/RXRPC_SECURITY_PLAIN

Encrypted checksum only.
”h]”(hÊ)”}”(hŒRXRPC_SECURITY_PLAIN”h]”hŒRXRPC_SECURITY_PLAIN”…””}”(hjk  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M×hjg  ubhÊ)”}”(hŒEncrypted checksum only.”h]”hŒEncrypted checksum only.”…””}”(hjy  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÙhjg  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjd  ubhó)”}”(hŒRXRPC_SECURITY_AUTH

Encrypted checksum plus packet padded and first eight bytes of packet
encrypted - which includes the actual packet length.
”h]”(hÊ)”}”(hŒRXRPC_SECURITY_AUTH”h]”hŒRXRPC_SECURITY_AUTH”…””}”(hj‘  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÛhj  ubhÊ)”}”(hŒzEncrypted checksum plus packet padded and first eight bytes of packet
encrypted - which includes the actual packet length.”h]”hŒzEncrypted checksum plus packet padded and first eight bytes of packet
encrypted - which includes the actual packet length.”…””}”(hjŸ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÝhj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjd  ubhó)”}”(hŒtRXRPC_SECURITY_ENCRYPT

Encrypted checksum plus entire packet padded and encrypted, including
actual packet length.
”h]”(hÊ)”}”(hŒRXRPC_SECURITY_ENCRYPT”h]”hŒRXRPC_SECURITY_ENCRYPT”…””}”(hj·  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Màhj³  ubhÊ)”}”(hŒ[Encrypted checksum plus entire packet padded and encrypted, including
actual packet length.”h]”hŒ[Encrypted checksum plus entire packet padded and encrypted, including
actual packet length.”…””}”(hjÅ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mâhj³  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjd  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jæ  jì  jí  jî  jï  uh1híhjD  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÁ  ubhó)”}”(hX8  RXRPC_UPGRADEABLE_SERVICE

This is used to indicate that a service socket with two bindings may
upgrade one bound service to the other if requested by the client.  optval
must point to an array of two unsigned short ints.  The first is the
service ID to upgrade from and the second the service ID to upgrade to.
”h]”(hÊ)”}”(hŒRXRPC_UPGRADEABLE_SERVICE”h]”hŒRXRPC_UPGRADEABLE_SERVICE”…””}”(hjé  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Måhjå  ubhÊ)”}”(hX  This is used to indicate that a service socket with two bindings may
upgrade one bound service to the other if requested by the client.  optval
must point to an array of two unsigned short ints.  The first is the
service ID to upgrade from and the second the service ID to upgrade to.”h]”hX  This is used to indicate that a service socket with two bindings may
upgrade one bound service to the other if requested by the client.  optval
must point to an array of two unsigned short ints.  The first is the
service ID to upgrade from and the second the service ID to upgrade to.”…””}”(hj÷  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mçhjå  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÁ  ubhó)”}”(hŒŒRXRPC_SUPPORTED_CMSG

This is a read-only option that writes an int into the buffer indicating
the highest control message type supported.

”h]”(hÊ)”}”(hŒRXRPC_SUPPORTED_CMSG”h]”hŒRXRPC_SUPPORTED_CMSG”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mìhj  ubhÊ)”}”(hŒtThis is a read-only option that writes an int into the buffer indicating
the highest control message type supported.”h]”hŒtThis is a read-only option that writes an int into the buffer indicating
the highest control message type supported.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mîhj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjÁ  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhj½  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h M¾hjž  hžhubeh}”(h]”Œsocket-options”ah ]”h"]”Œsocket options”ah$]”h&]”uh1h´hhhžhhŸh³h Mºubhµ)”}”(hhh]”(hº)”}”(hŒSECURITY”h]”hŒSECURITY”…””}”(hjH  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjE  hžhhŸh³h MôubhÊ)”}”(hX„  Currently, only the kerberos 4 equivalent protocol has been implemented
(security index 2 - rxkad).  This requires the rxkad module to be loaded and,
on the client, tickets of the appropriate type to be obtained from the AFS
kaserver or the kerberos server and installed as "rxrpc" type keys.  This is
normally done using the klog program.  An example simple klog program can be
found at:”h]”hXˆ  Currently, only the kerberos 4 equivalent protocol has been implemented
(security index 2 - rxkad).  This requires the rxkad module to be loaded and,
on the client, tickets of the appropriate type to be obtained from the AFS
kaserver or the kerberos server and installed as â€œrxrpcâ€ type keys.  This is
normally done using the klog program.  An example simple klog program can be
found at:”…””}”(hjV  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MöhjE  hžhubhè)”}”(hŒ0http://people.redhat.com/~dhowells/rxrpc/klog.c
”h]”hÊ)”}”(hŒ/http://people.redhat.com/~dhowells/rxrpc/klog.c”h]”hŒ	reference”“”)”}”(hjj  h]”hŒ/http://people.redhat.com/~dhowells/rxrpc/klog.c”…””}”(hjn  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”jj  uh1jl  hjh  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mýhjd  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h MýhjE  hžhubhÊ)”}”(hŒQThe payload provided to add_key() on the client should be of the following
form::”h]”hŒPThe payload provided to add_key() on the client should be of the following
form:”…””}”(hjˆ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÿhjE  hžhubj  )”}”(hX¶  struct rxrpc_key_sec2_v1 {
        uint16_t        security_index; /* 2 */
        uint16_t        ticket_length;  /* length of ticket[] */
        uint32_t        expiry;         /* time at which expires */
        uint8_t         kvno;           /* key version number */
        uint8_t         __pad[3];
        uint8_t         session_key[8]; /* DES session key */
        uint8_t         ticket[0];      /* the encrypted ticket */
};”h]”hX¶  struct rxrpc_key_sec2_v1 {
        uint16_t        security_index; /* 2 */
        uint16_t        ticket_length;  /* length of ticket[] */
        uint32_t        expiry;         /* time at which expires */
        uint8_t         kvno;           /* key version number */
        uint8_t         __pad[3];
        uint8_t         session_key[8]; /* DES session key */
        uint8_t         ticket[0];      /* the encrypted ticket */
};”…””}”hj–  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h MhjE  hžhubhÊ)”}”(hŒ>Where the ticket blob is just appended to the above structure.”h]”hŒ>Where the ticket blob is just appended to the above structure.”…””}”(hj¤  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MhjE  hžhubhÊ)”}”(hX6  For the server, keys of type "rxrpc_s" must be made available to the server.
They have a description of "<serviceID>:<securityIndex>" (eg: "52:2" for an
rxkad key for the AFS VL service).  When such a key is created, it should be
given the server's secret key as the instantiation data (see the example
below).”h]”hXD  For the server, keys of type â€œrxrpc_sâ€ must be made available to the server.
They have a description of â€œ<serviceID>:<securityIndex>â€ (eg: â€œ52:2â€ for an
rxkad key for the AFS VL service).  When such a key is created, it should be
given the serverâ€™s secret key as the instantiation data (see the example
below).”…””}”(hj²  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MhjE  hžhubhè)”}”(hŒ4add_key("rxrpc_s", "52:2", secret_key, 8, keyring);
”h]”hÊ)”}”(hŒ3add_key("rxrpc_s", "52:2", secret_key, 8, keyring);”h]”hŒ;add_key(â€œrxrpc_sâ€, â€œ52:2â€, secret_key, 8, keyring);”…””}”(hjÄ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MhjÀ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h MhjE  hžhubhÊ)”}”(hŒôA keyring is passed to the server socket by naming it in a sockopt.  The server
socket then looks the server secret keys up in this keyring when secure
incoming connections are made.  This can be seen in an example program that can
be found at:”h]”hŒôA keyring is passed to the server socket by naming it in a sockopt.  The server
socket then looks the server secret keys up in this keyring when secure
incoming connections are made.  This can be seen in an example program that can
be found at:”…””}”(hjØ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MhjE  hžhubhè)”}”(hŒ3http://people.redhat.com/~dhowells/rxrpc/listen.c

”h]”hÊ)”}”(hŒ1http://people.redhat.com/~dhowells/rxrpc/listen.c”h]”jm  )”}”(hjì  h]”hŒ1http://people.redhat.com/~dhowells/rxrpc/listen.c”…””}”(hjî  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”jì  uh1jl  hjê  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhjæ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h MhjE  hžhubeh}”(h]”Œsecurity”ah ]”h"]”Œsecurity”ah$]”h&]”uh1h´hhhžhhŸh³h Môubhµ)”}”(hhh]”(hº)”}”(hŒEXAMPLE CLIENT USAGE”h]”hŒEXAMPLE CLIENT USAGE”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj  hžhhŸh³h M!ubhÊ)”}”(hŒ%A client would issue an operation by:”h]”hŒ%A client would issue an operation by:”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M#hj  hžhubhè)”}”(hXø  (1) An RxRPC socket is set up by::

       client = socket(AF_RXRPC, SOCK_DGRAM, PF_INET);

    Where the third parameter indicates the protocol family of the transport
    socket used - usually IPv4 but it can also be IPv6 [TODO].

(2) A local address can optionally be bound::

       struct sockaddr_rxrpc srx = {
               .srx_family     = AF_RXRPC,
               .srx_service    = 0,  /* we're a client */
               .transport_type = SOCK_DGRAM,   /* type of transport socket */
               .transport.sin_family   = AF_INET,
               .transport.sin_port     = htons(7000), /* AFS callback */
               .transport.sin_address  = 0,  /* all local interfaces */
       };
       bind(client, &srx, sizeof(srx));

    This specifies the local UDP port to be used.  If not given, a random
    non-privileged port will be used.  A UDP port may be shared between
    several unrelated RxRPC sockets.  Security is handled on a basis of
    per-RxRPC virtual connection.

(3) The security is set::

       const char *key = "AFS:cambridge.redhat.com";
       setsockopt(client, SOL_RXRPC, RXRPC_SECURITY_KEY, key, strlen(key));

    This issues a request_key() to get the key representing the security
    context.  The minimum security level can be set::

       unsigned int sec = RXRPC_SECURITY_ENCRYPT;
       setsockopt(client, SOL_RXRPC, RXRPC_MIN_SECURITY_LEVEL,
                  &sec, sizeof(sec));

(4) The server to be contacted can then be specified (alternatively this can
    be done through sendmsg)::

       struct sockaddr_rxrpc srx = {
               .srx_family     = AF_RXRPC,
               .srx_service    = VL_SERVICE_ID,
               .transport_type = SOCK_DGRAM,   /* type of transport socket */
               .transport.sin_family   = AF_INET,
               .transport.sin_port     = htons(7005), /* AFS volume manager */
               .transport.sin_address  = ...,
       };
       connect(client, &srx, sizeof(srx));

(5) The request data should then be posted to the server socket using a series
    of sendmsg() calls, each with the following control message attached:

       ==================      ===================================
       RXRPC_USER_CALL_ID      specifies the user ID for this call
       ==================      ===================================

    MSG_MORE should be set in msghdr::msg_flags on all but the last part of
    the request.  Multiple requests may be made simultaneously.

    An RXRPC_TX_LENGTH control message can also be specified on the first
    sendmsg() call.

    If a call is intended to go to a destination other than the default
    specified through connect(), then msghdr::msg_name should be set on the
    first request message of that call.

(6) The reply data will then be posted to the server socket for recvmsg() to
    pick up.  MSG_MORE will be flagged by recvmsg() if there's more reply data
    for a particular call to be read.  MSG_EOR will be set on the terminal
    read for a call.

    All data will be delivered with the following control message attached:

       RXRPC_USER_CALL_ID      - specifies the user ID for this call

    If an abort or error occurred, this will be returned in the control data
    buffer instead, and MSG_EOR will be flagged to indicate the end of that
    call.
”h]”hî)”}”(hhh]”(hó)”}”(hŒØAn RxRPC socket is set up by::

   client = socket(AF_RXRPC, SOCK_DGRAM, PF_INET);

Where the third parameter indicates the protocol family of the transport
socket used - usually IPv4 but it can also be IPv6 [TODO].
”h]”(hÊ)”}”(hŒAn RxRPC socket is set up by::”h]”hŒAn RxRPC socket is set up by:”…””}”(hj:  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M%hj6  ubj  )”}”(hŒ/client = socket(AF_RXRPC, SOCK_DGRAM, PF_INET);”h]”hŒ/client = socket(AF_RXRPC, SOCK_DGRAM, PF_INET);”…””}”hjH  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h M'hj6  ubhÊ)”}”(hŒƒWhere the third parameter indicates the protocol family of the transport
socket used - usually IPv4 but it can also be IPv6 [TODO].”h]”hŒƒWhere the third parameter indicates the protocol family of the transport
socket used - usually IPv4 but it can also be IPv6 [TODO].”…””}”(hjV  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M)hj6  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj3  ubhó)”}”(hXÁ  A local address can optionally be bound::

   struct sockaddr_rxrpc srx = {
           .srx_family     = AF_RXRPC,
           .srx_service    = 0,  /* we're a client */
           .transport_type = SOCK_DGRAM,   /* type of transport socket */
           .transport.sin_family   = AF_INET,
           .transport.sin_port     = htons(7000), /* AFS callback */
           .transport.sin_address  = 0,  /* all local interfaces */
   };
   bind(client, &srx, sizeof(srx));

This specifies the local UDP port to be used.  If not given, a random
non-privileged port will be used.  A UDP port may be shared between
several unrelated RxRPC sockets.  Security is handled on a basis of
per-RxRPC virtual connection.
”h]”(hÊ)”}”(hŒ)A local address can optionally be bound::”h]”hŒ(A local address can optionally be bound:”…””}”(hjn  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M,hjj  ubj  )”}”(hX  struct sockaddr_rxrpc srx = {
        .srx_family     = AF_RXRPC,
        .srx_service    = 0,  /* we're a client */
        .transport_type = SOCK_DGRAM,   /* type of transport socket */
        .transport.sin_family   = AF_INET,
        .transport.sin_port     = htons(7000), /* AFS callback */
        .transport.sin_address  = 0,  /* all local interfaces */
};
bind(client, &srx, sizeof(srx));”h]”hX  struct sockaddr_rxrpc srx = {
        .srx_family     = AF_RXRPC,
        .srx_service    = 0,  /* we're a client */
        .transport_type = SOCK_DGRAM,   /* type of transport socket */
        .transport.sin_family   = AF_INET,
        .transport.sin_port     = htons(7000), /* AFS callback */
        .transport.sin_address  = 0,  /* all local interfaces */
};
bind(client, &srx, sizeof(srx));”…””}”hj|  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h M.hjj  ubhÊ)”}”(hŒëThis specifies the local UDP port to be used.  If not given, a random
non-privileged port will be used.  A UDP port may be shared between
several unrelated RxRPC sockets.  Security is handled on a basis of
per-RxRPC virtual connection.”h]”hŒëThis specifies the local UDP port to be used.  If not given, a random
non-privileged port will be used.  A UDP port may be shared between
several unrelated RxRPC sockets.  Security is handled on a basis of
per-RxRPC virtual connection.”…””}”(hjŠ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M8hjj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj3  ubhó)”}”(hX”  The security is set::

   const char *key = "AFS:cambridge.redhat.com";
   setsockopt(client, SOL_RXRPC, RXRPC_SECURITY_KEY, key, strlen(key));

This issues a request_key() to get the key representing the security
context.  The minimum security level can be set::

   unsigned int sec = RXRPC_SECURITY_ENCRYPT;
   setsockopt(client, SOL_RXRPC, RXRPC_MIN_SECURITY_LEVEL,
              &sec, sizeof(sec));
”h]”(hÊ)”}”(hŒThe security is set::”h]”hŒThe security is set:”…””}”(hj¢  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M=hjž  ubj  )”}”(hŒrconst char *key = "AFS:cambridge.redhat.com";
setsockopt(client, SOL_RXRPC, RXRPC_SECURITY_KEY, key, strlen(key));”h]”hŒrconst char *key = "AFS:cambridge.redhat.com";
setsockopt(client, SOL_RXRPC, RXRPC_SECURITY_KEY, key, strlen(key));”…””}”hj°  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h M?hjž  ubhÊ)”}”(hŒvThis issues a request_key() to get the key representing the security
context.  The minimum security level can be set::”h]”hŒuThis issues a request_key() to get the key representing the security
context.  The minimum security level can be set:”…””}”(hj¾  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MBhjž  ubj  )”}”(hŒunsigned int sec = RXRPC_SECURITY_ENCRYPT;
setsockopt(client, SOL_RXRPC, RXRPC_MIN_SECURITY_LEVEL,
           &sec, sizeof(sec));”h]”hŒunsigned int sec = RXRPC_SECURITY_ENCRYPT;
setsockopt(client, SOL_RXRPC, RXRPC_MIN_SECURITY_LEVEL,
           &sec, sizeof(sec));”…””}”hjÌ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h MEhjž  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj3  ubhó)”}”(hXó  The server to be contacted can then be specified (alternatively this can
be done through sendmsg)::

   struct sockaddr_rxrpc srx = {
           .srx_family     = AF_RXRPC,
           .srx_service    = VL_SERVICE_ID,
           .transport_type = SOCK_DGRAM,   /* type of transport socket */
           .transport.sin_family   = AF_INET,
           .transport.sin_port     = htons(7005), /* AFS volume manager */
           .transport.sin_address  = ...,
   };
   connect(client, &srx, sizeof(srx));
”h]”(hÊ)”}”(hŒcThe server to be contacted can then be specified (alternatively this can
be done through sendmsg)::”h]”hŒbThe server to be contacted can then be specified (alternatively this can
be done through sendmsg):”…””}”(hjä  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MIhjà  ubj  )”}”(hXr  struct sockaddr_rxrpc srx = {
        .srx_family     = AF_RXRPC,
        .srx_service    = VL_SERVICE_ID,
        .transport_type = SOCK_DGRAM,   /* type of transport socket */
        .transport.sin_family   = AF_INET,
        .transport.sin_port     = htons(7005), /* AFS volume manager */
        .transport.sin_address  = ...,
};
connect(client, &srx, sizeof(srx));”h]”hXr  struct sockaddr_rxrpc srx = {
        .srx_family     = AF_RXRPC,
        .srx_service    = VL_SERVICE_ID,
        .transport_type = SOCK_DGRAM,   /* type of transport socket */
        .transport.sin_family   = AF_INET,
        .transport.sin_port     = htons(7005), /* AFS volume manager */
        .transport.sin_address  = ...,
};
connect(client, &srx, sizeof(srx));”…””}”hjò  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h MLhjà  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj3  ubhó)”}”(hXÜ  The request data should then be posted to the server socket using a series
of sendmsg() calls, each with the following control message attached:

   ==================      ===================================
   RXRPC_USER_CALL_ID      specifies the user ID for this call
   ==================      ===================================

MSG_MORE should be set in msghdr::msg_flags on all but the last part of
the request.  Multiple requests may be made simultaneously.

An RXRPC_TX_LENGTH control message can also be specified on the first
sendmsg() call.

If a call is intended to go to a destination other than the default
specified through connect(), then msghdr::msg_name should be set on the
first request message of that call.
”h]”(hÊ)”}”(hŒThe request data should then be posted to the server socket using a series
of sendmsg() calls, each with the following control message attached:”h]”hŒThe request data should then be posted to the server socket using a series
of sendmsg() calls, each with the following control message attached:”…””}”(hj
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MVhj  ubhè)”}”(hŒ´==================      ===================================
RXRPC_USER_CALL_ID      specifies the user ID for this call
==================      ===================================
”h]”j‰	  )”}”(hhh]”jŽ	  )”}”(hhh]”(j“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j’	  hj  ubj“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”K#uh1j’	  hj  ubj1
  )”}”(hhh]”jÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_USER_CALL_ID”h]”hŒRXRPC_USER_CALL_ID”…””}”(hj?  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MZhj<  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj9  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ#specifies the user ID for this call”h]”hŒ#specifies the user ID for this call”…””}”(hjV  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MZhjS  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj9  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj6  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j0
  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1j	  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jˆ	  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h MYhj  ubhÊ)”}”(hŒƒMSG_MORE should be set in msghdr::msg_flags on all but the last part of
the request.  Multiple requests may be made simultaneously.”h]”hŒƒMSG_MORE should be set in msghdr::msg_flags on all but the last part of
the request.  Multiple requests may be made simultaneously.”…””}”(hj‰  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M]hj  ubhÊ)”}”(hŒUAn RXRPC_TX_LENGTH control message can also be specified on the first
sendmsg() call.”h]”hŒUAn RXRPC_TX_LENGTH control message can also be specified on the first
sendmsg() call.”…””}”(hj—  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M`hj  ubhÊ)”}”(hŒ¯If a call is intended to go to a destination other than the default
specified through connect(), then msghdr::msg_name should be set on the
first request message of that call.”h]”hŒ¯If a call is intended to go to a destination other than the default
specified through connect(), then msghdr::msg_name should be set on the
first request message of that call.”…””}”(hj¥  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mchj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj3  ubhó)”}”(hX  The reply data will then be posted to the server socket for recvmsg() to
pick up.  MSG_MORE will be flagged by recvmsg() if there's more reply data
for a particular call to be read.  MSG_EOR will be set on the terminal
read for a call.

All data will be delivered with the following control message attached:

   RXRPC_USER_CALL_ID      - specifies the user ID for this call

If an abort or error occurred, this will be returned in the control data
buffer instead, and MSG_EOR will be flagged to indicate the end of that
call.
”h]”(hÊ)”}”(hŒëThe reply data will then be posted to the server socket for recvmsg() to
pick up.  MSG_MORE will be flagged by recvmsg() if there's more reply data
for a particular call to be read.  MSG_EOR will be set on the terminal
read for a call.”h]”hŒíThe reply data will then be posted to the server socket for recvmsg() to
pick up.  MSG_MORE will be flagged by recvmsg() if thereâ€™s more reply data
for a particular call to be read.  MSG_EOR will be set on the terminal
read for a call.”…””}”(hj½  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mghj¹  ubhÊ)”}”(hŒGAll data will be delivered with the following control message attached:”h]”hŒGAll data will be delivered with the following control message attached:”…””}”(hjË  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mlhj¹  ubhè)”}”(hŒ>RXRPC_USER_CALL_ID      - specifies the user ID for this call
”h]”hÊ)”}”(hŒ=RXRPC_USER_CALL_ID      - specifies the user ID for this call”h]”hŒ=RXRPC_USER_CALL_ID      - specifies the user ID for this call”…””}”(hjÝ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MnhjÙ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h Mnhj¹  ubhÊ)”}”(hŒ–If an abort or error occurred, this will be returned in the control data
buffer instead, and MSG_EOR will be flagged to indicate the end of that
call.”h]”hŒ–If an abort or error occurred, this will be returned in the control data
buffer instead, and MSG_EOR will be flagged to indicate the end of that
call.”…””}”(hjñ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mphj¹  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj3  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhj/  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h M%hj  hžhubhÊ)”}”(hXÓ  A client may ask for a service ID it knows and ask that this be upgraded to a
better service if one is available by supplying RXRPC_UPGRADE_SERVICE on the
first sendmsg() of a call.  The client should then check srx_service in the
msg_name filled in by recvmsg() when collecting the result.  srx_service will
hold the same value as given to sendmsg() if the upgrade request was ignored by
the service - otherwise it will be altered to indicate the service ID the
server upgraded to.  Note that the upgraded service ID is chosen by the server.
The caller has to wait until it sees the service ID in the reply before sending
any more calls (further calls to the same destination will be blocked until the
probe is concluded).”h]”hXÓ  A client may ask for a service ID it knows and ask that this be upgraded to a
better service if one is available by supplying RXRPC_UPGRADE_SERVICE on the
first sendmsg() of a call.  The client should then check srx_service in the
msg_name filled in by recvmsg() when collecting the result.  srx_service will
hold the same value as given to sendmsg() if the upgrade request was ignored by
the service - otherwise it will be altered to indicate the service ID the
server upgraded to.  Note that the upgraded service ID is chosen by the server.
The caller has to wait until it sees the service ID in the reply before sending
any more calls (further calls to the same destination will be blocked until the
probe is concluded).”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mthj  hžhubhµ)”}”(hhh]”(hº)”}”(hŒExample Server Usage”h]”hŒExample Server Usage”…””}”(hj"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj  hžhhŸh³h MubhÊ)”}”(hŒFA server would be set up to accept operations in the following manner:”h]”hŒFA server would be set up to accept operations in the following manner:”…””}”(hj0  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mƒhj  hžhubhè)”}”(hXJ  (1) An RxRPC socket is created by::

       server = socket(AF_RXRPC, SOCK_DGRAM, PF_INET);

    Where the third parameter indicates the address type of the transport
    socket used - usually IPv4.

(2) Security is set up if desired by giving the socket a keyring with server
    secret keys in it::

       keyring = add_key("keyring", "AFSkeys", NULL, 0,
                         KEY_SPEC_PROCESS_KEYRING);

       const char secret_key[8] = {
               0xa7, 0x83, 0x8a, 0xcb, 0xc7, 0x83, 0xec, 0x94 };
       add_key("rxrpc_s", "52:2", secret_key, 8, keyring);

       setsockopt(server, SOL_RXRPC, RXRPC_SECURITY_KEYRING, "AFSkeys", 7);

    The keyring can be manipulated after it has been given to the socket. This
    permits the server to add more keys, replace keys, etc. while it is live.

(3) A local address must then be bound::

       struct sockaddr_rxrpc srx = {
               .srx_family     = AF_RXRPC,
               .srx_service    = VL_SERVICE_ID, /* RxRPC service ID */
               .transport_type = SOCK_DGRAM,   /* type of transport socket */
               .transport.sin_family   = AF_INET,
               .transport.sin_port     = htons(7000), /* AFS callback */
               .transport.sin_address  = 0,  /* all local interfaces */
       };
       bind(server, &srx, sizeof(srx));

    More than one service ID may be bound to a socket, provided the transport
    parameters are the same.  The limit is currently two.  To do this, bind()
    should be called twice.

(4) If service upgrading is required, first two service IDs must have been
    bound and then the following option must be set::

       unsigned short service_ids[2] = { from_ID, to_ID };
       setsockopt(server, SOL_RXRPC, RXRPC_UPGRADEABLE_SERVICE,
                  service_ids, sizeof(service_ids));

    This will automatically upgrade connections on service from_ID to service
    to_ID if they request it.  This will be reflected in msg_name obtained
    through recvmsg() when the request data is delivered to userspace.

(5) The server is then set to listen out for incoming calls::

       listen(server, 100);

(6) The kernel notifies the server of pending incoming connections by sending
    it a message for each.  This is received with recvmsg() on the server
    socket.  It has no data, and has a single dataless control message
    attached::

       RXRPC_NEW_CALL

    The address that can be passed back by recvmsg() at this point should be
    ignored since the call for which the message was posted may have gone by
    the time it is accepted - in which case the first call still on the queue
    will be accepted.

(7) The server then accepts the new call by issuing a sendmsg() with two
    pieces of control data and no actual data:

       ==================      ==============================
       RXRPC_ACCEPT            indicate connection acceptance
       RXRPC_USER_CALL_ID      specify user ID for this call
       ==================      ==============================

(8) The first request data packet will then be posted to the server socket for
    recvmsg() to pick up.  At that point, the RxRPC address for the call can
    be read from the address fields in the msghdr struct.

    Subsequent request data will be posted to the server socket for recvmsg()
    to collect as it arrives.  All but the last piece of the request data will
    be delivered with MSG_MORE flagged.

    All data will be delivered with the following control message attached:


       ==================      ===================================
       RXRPC_USER_CALL_ID      specifies the user ID for this call
       ==================      ===================================

(9) The reply data should then be posted to the server socket using a series
    of sendmsg() calls, each with the following control messages attached:

       ==================      ===================================
       RXRPC_USER_CALL_ID      specifies the user ID for this call
       ==================      ===================================

    MSG_MORE should be set in msghdr::msg_flags on all but the last message
    for a particular call.
”h]”hî)”}”(hhh]”(hó)”}”(hŒ·An RxRPC socket is created by::

   server = socket(AF_RXRPC, SOCK_DGRAM, PF_INET);

Where the third parameter indicates the address type of the transport
socket used - usually IPv4.
”h]”(hÊ)”}”(hŒAn RxRPC socket is created by::”h]”hŒAn RxRPC socket is created by:”…””}”(hjI  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M…hjE  ubj  )”}”(hŒ/server = socket(AF_RXRPC, SOCK_DGRAM, PF_INET);”h]”hŒ/server = socket(AF_RXRPC, SOCK_DGRAM, PF_INET);”…””}”hjW  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h M‡hjE  ubhÊ)”}”(hŒaWhere the third parameter indicates the address type of the transport
socket used - usually IPv4.”h]”hŒaWhere the third parameter indicates the address type of the transport
socket used - usually IPv4.”…””}”(hje  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M‰hjE  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjB  ubhó)”}”(hX6  Security is set up if desired by giving the socket a keyring with server
secret keys in it::

   keyring = add_key("keyring", "AFSkeys", NULL, 0,
                     KEY_SPEC_PROCESS_KEYRING);

   const char secret_key[8] = {
           0xa7, 0x83, 0x8a, 0xcb, 0xc7, 0x83, 0xec, 0x94 };
   add_key("rxrpc_s", "52:2", secret_key, 8, keyring);

   setsockopt(server, SOL_RXRPC, RXRPC_SECURITY_KEYRING, "AFSkeys", 7);

The keyring can be manipulated after it has been given to the socket. This
permits the server to add more keys, replace keys, etc. while it is live.
”h]”(hÊ)”}”(hŒ\Security is set up if desired by giving the socket a keyring with server
secret keys in it::”h]”hŒ[Security is set up if desired by giving the socket a keyring with server
secret keys in it:”…””}”(hj}  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MŒhjy  ubj  )”}”(hX/  keyring = add_key("keyring", "AFSkeys", NULL, 0,
                  KEY_SPEC_PROCESS_KEYRING);

const char secret_key[8] = {
        0xa7, 0x83, 0x8a, 0xcb, 0xc7, 0x83, 0xec, 0x94 };
add_key("rxrpc_s", "52:2", secret_key, 8, keyring);

setsockopt(server, SOL_RXRPC, RXRPC_SECURITY_KEYRING, "AFSkeys", 7);”h]”hX/  keyring = add_key("keyring", "AFSkeys", NULL, 0,
                  KEY_SPEC_PROCESS_KEYRING);

const char secret_key[8] = {
        0xa7, 0x83, 0x8a, 0xcb, 0xc7, 0x83, 0xec, 0x94 };
add_key("rxrpc_s", "52:2", secret_key, 8, keyring);

setsockopt(server, SOL_RXRPC, RXRPC_SECURITY_KEYRING, "AFSkeys", 7);”…””•       }”hj‹  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h Mhjy  ubhÊ)”}”(hŒ”The keyring can be manipulated after it has been given to the socket. This
permits the server to add more keys, replace keys, etc. while it is live.”h]”hŒ”The keyring can be manipulated after it has been given to the socket. This
permits the server to add more keys, replace keys, etc. while it is live.”…””}”(hj™  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M˜hjy  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjB  ubhó)”}”(hX‰  A local address must then be bound::

   struct sockaddr_rxrpc srx = {
           .srx_family     = AF_RXRPC,
           .srx_service    = VL_SERVICE_ID, /* RxRPC service ID */
           .transport_type = SOCK_DGRAM,   /* type of transport socket */
           .transport.sin_family   = AF_INET,
           .transport.sin_port     = htons(7000), /* AFS callback */
           .transport.sin_address  = 0,  /* all local interfaces */
   };
   bind(server, &srx, sizeof(srx));

More than one service ID may be bound to a socket, provided the transport
parameters are the same.  The limit is currently two.  To do this, bind()
should be called twice.
”h]”(hÊ)”}”(hŒ$A local address must then be bound::”h]”hŒ#A local address must then be bound:”…””}”(hj±  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M›hj­  ubj  )”}”(hXš  struct sockaddr_rxrpc srx = {
        .srx_family     = AF_RXRPC,
        .srx_service    = VL_SERVICE_ID, /* RxRPC service ID */
        .transport_type = SOCK_DGRAM,   /* type of transport socket */
        .transport.sin_family   = AF_INET,
        .transport.sin_port     = htons(7000), /* AFS callback */
        .transport.sin_address  = 0,  /* all local interfaces */
};
bind(server, &srx, sizeof(srx));”h]”hXš  struct sockaddr_rxrpc srx = {
        .srx_family     = AF_RXRPC,
        .srx_service    = VL_SERVICE_ID, /* RxRPC service ID */
        .transport_type = SOCK_DGRAM,   /* type of transport socket */
        .transport.sin_family   = AF_INET,
        .transport.sin_port     = htons(7000), /* AFS callback */
        .transport.sin_address  = 0,  /* all local interfaces */
};
bind(server, &srx, sizeof(srx));”…””}”hj¿  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h Mhj­  ubhÊ)”}”(hŒ«More than one service ID may be bound to a socket, provided the transport
parameters are the same.  The limit is currently two.  To do this, bind()
should be called twice.”h]”hŒ«More than one service ID may be bound to a socket, provided the transport
parameters are the same.  The limit is currently two.  To do this, bind()
should be called twice.”…””}”(hjÍ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M§hj­  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjB  ubhó)”}”(hXó  If service upgrading is required, first two service IDs must have been
bound and then the following option must be set::

   unsigned short service_ids[2] = { from_ID, to_ID };
   setsockopt(server, SOL_RXRPC, RXRPC_UPGRADEABLE_SERVICE,
              service_ids, sizeof(service_ids));

This will automatically upgrade connections on service from_ID to service
to_ID if they request it.  This will be reflected in msg_name obtained
through recvmsg() when the request data is delivered to userspace.
”h]”(hÊ)”}”(hŒxIf service upgrading is required, first two service IDs must have been
bound and then the following option must be set::”h]”hŒwIf service upgrading is required, first two service IDs must have been
bound and then the following option must be set:”…””}”(hjå  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M«hjá  ubj  )”}”(hŒšunsigned short service_ids[2] = { from_ID, to_ID };
setsockopt(server, SOL_RXRPC, RXRPC_UPGRADEABLE_SERVICE,
           service_ids, sizeof(service_ids));”h]”hŒšunsigned short service_ids[2] = { from_ID, to_ID };
setsockopt(server, SOL_RXRPC, RXRPC_UPGRADEABLE_SERVICE,
           service_ids, sizeof(service_ids));”…””}”hjó  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h M®hjá  ubhÊ)”}”(hŒÓThis will automatically upgrade connections on service from_ID to service
to_ID if they request it.  This will be reflected in msg_name obtained
through recvmsg() when the request data is delivered to userspace.”h]”hŒÓThis will automatically upgrade connections on service from_ID to service
to_ID if they request it.  This will be reflected in msg_name obtained
through recvmsg() when the request data is delivered to userspace.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M²hjá  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjB  ubhó)”}”(hŒSThe server is then set to listen out for incoming calls::

   listen(server, 100);
”h]”(hÊ)”}”(hŒ9The server is then set to listen out for incoming calls::”h]”hŒ8The server is then set to listen out for incoming calls:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M¶hj  ubj  )”}”(hŒlisten(server, 100);”h]”hŒlisten(server, 100);”…””}”hj'  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h M¸hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjB  ubhó)”}”(hXà  The kernel notifies the server of pending incoming connections by sending
it a message for each.  This is received with recvmsg() on the server
socket.  It has no data, and has a single dataless control message
attached::

   RXRPC_NEW_CALL

The address that can be passed back by recvmsg() at this point should be
ignored since the call for which the message was posted may have gone by
the time it is accepted - in which case the first call still on the queue
will be accepted.
”h]”(hÊ)”}”(hŒÝThe kernel notifies the server of pending incoming connections by sending
it a message for each.  This is received with recvmsg() on the server
socket.  It has no data, and has a single dataless control message
attached::”h]”hŒÜThe kernel notifies the server of pending incoming connections by sending
it a message for each.  This is received with recvmsg() on the server
socket.  It has no data, and has a single dataless control message
attached:”…””}”(hj?  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mºhj;  ubj  )”}”(hŒRXRPC_NEW_CALL”h]”hŒRXRPC_NEW_CALL”…””}”hjM  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h M¿hj;  ubhÊ)”}”(hŒíThe address that can be passed back by recvmsg() at this point should be
ignored since the call for which the message was posted may have gone by
the time it is accepted - in which case the first call still on the queue
will be accepted.”h]”hŒíThe address that can be passed back by recvmsg() at this point should be
ignored since the call for which the message was posted may have gone by
the time it is accepted - in which case the first call still on the queue
will be accepted.”…””}”(hj[  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÁhj;  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjB  ubhó)”}”(hXX  The server then accepts the new call by issuing a sendmsg() with two
pieces of control data and no actual data:

   ==================      ==============================
   RXRPC_ACCEPT            indicate connection acceptance
   RXRPC_USER_CALL_ID      specify user ID for this call
   ==================      ==============================
”h]”(hÊ)”}”(hŒoThe server then accepts the new call by issuing a sendmsg() with two
pieces of control data and no actual data:”h]”hŒoThe server then accepts the new call by issuing a sendmsg() with two
pieces of control data and no actual data:”…””}”(hjs  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÆhjo  ubhè)”}”(hŒÛ==================      ==============================
RXRPC_ACCEPT            indicate connection acceptance
RXRPC_USER_CALL_ID      specify user ID for this call
==================      ==============================
”h]”j‰	  )”}”(hhh]”jŽ	  )”}”(hhh]”(j“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j’	  hjˆ  ubj“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j’	  hjˆ  ubj1
  )”}”(hhh]”(jÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_ACCEPT”h]”hŒRXRPC_ACCEPT”…””}”(hj¨  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÊhj¥  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj¢  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒindicate connection acceptance”h]”hŒindicate connection acceptance”…””}”(hj¿  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÊhj¼  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj¢  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hjŸ  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_USER_CALL_ID”h]”hŒRXRPC_USER_CALL_ID”…””}”(hjß  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MËhjÜ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÙ  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒspecify user ID for this call”h]”hŒspecify user ID for this call”…””}”(hjö  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MËhjó  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjÙ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hjŸ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j0
  hjˆ  ubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1j	  hj…  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jˆ	  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h MÉhjo  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjB  ubhó)”}”(hXŒ  The first request data packet will then be posted to the server socket for
recvmsg() to pick up.  At that point, the RxRPC address for the call can
be read from the address fields in the msghdr struct.

Subsequent request data will be posted to the server socket for recvmsg()
to collect as it arrives.  All but the last piece of the request data will
be delivered with MSG_MORE flagged.

All data will be delivered with the following control message attached:


   ==================      ===================================
   RXRPC_USER_CALL_ID      specifies the user ID for this call
   ==================      ===================================
”h]”(hÊ)”}”(hŒÉThe first request data packet will then be posted to the server socket for
recvmsg() to pick up.  At that point, the RxRPC address for the call can
be read from the address fields in the msghdr struct.”h]”hŒÉThe first request data packet will then be posted to the server socket for
recvmsg() to pick up.  At that point, the RxRPC address for the call can
be read from the address fields in the msghdr struct.”…””}”(hj3  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÎhj/  ubhÊ)”}”(hŒ¸Subsequent request data will be posted to the server socket for recvmsg()
to collect as it arrives.  All but the last piece of the request data will
be delivered with MSG_MORE flagged.”h]”hŒ¸Subsequent request data will be posted to the server socket for recvmsg()
to collect as it arrives.  All but the last piece of the request data will
be delivered with MSG_MORE flagged.”…””}”(hjA  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÒhj/  ubhÊ)”}”(hŒGAll data will be delivered with the following control message attached:”h]”hŒGAll data will be delivered with the following control message attached:”…””}”(hjO  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÖhj/  ubhè)”}”(hŒ´==================      ===================================
RXRPC_USER_CALL_ID      specifies the user ID for this call
==================      ===================================
”h]”j‰	  )”}”(hhh]”jŽ	  )”}”(hhh]”(j“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j’	  hjd  ubj“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”K#uh1j’	  hjd  ubj1
  )”}”(hhh]”jÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_USER_CALL_ID”h]”hŒRXRPC_USER_CALL_ID”…””}”(hj„  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÚhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj~  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ#specifies the user ID for this call”h]”hŒ#specifies the user ID for this call”…””}”(hj›  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÚhj˜  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj~  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj{  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j0
  hjd  ubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1j	  hja  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jˆ	  hj]  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h MÙhj/  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjB  ubhó)”}”(hX®  The reply data should then be posted to the server socket using a series
of sendmsg() calls, each with the following control messages attached:

   ==================      ===================================
   RXRPC_USER_CALL_ID      specifies the user ID for this call
   ==================      ===================================

MSG_MORE should be set in msghdr::msg_flags on all but the last message
for a particular call.
”h]”(hÊ)”}”(hŒThe reply data should then be posted to the server socket using a series
of sendmsg() calls, each with the following control messages attached:”h]”hŒThe reply data should then be posted to the server socket using a series
of sendmsg() calls, each with the following control messages attached:”…””}”(hjØ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÝhjÔ  ubhè)”}”(hŒ´==================      ===================================
RXRPC_USER_CALL_ID      specifies the user ID for this call
==================      ===================================
”h]”j‰	  )”}”(hhh]”jŽ	  )”}”(hhh]”(j“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j’	  hjí  ubj“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”K#uh1j’	  hjí  ubj1
  )”}”(hhh]”jÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_USER_CALL_ID”h]”hŒRXRPC_USER_CALL_ID”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Máhj
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ#specifies the user ID for this call”h]”hŒ#specifies the user ID for this call”…””}”(hj$  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Máhj!  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j0
  hjí  ubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1j	  hjê  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jˆ	  hjæ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h MàhjÔ  ubhÊ)”}”(hŒ^MSG_MORE should be set in msghdr::msg_flags on all but the last message
for a particular call.”h]”hŒ^MSG_MORE should be set in msghdr::msg_flags on all but the last message
for a particular call.”…””}”(hjW  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MähjÔ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjB  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhj>  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h M…hj  hžhubhî)”}”(hhh]”(hó)”}”(hXø  The final ACK from the client will be posted for retrieval by recvmsg()
when it is received.  It will take the form of a dataless message with two
control messages attached:

   ==================      ===================================
   RXRPC_USER_CALL_ID      specifies the user ID for this call
   RXRPC_ACK               indicates final ACK (no data)
   ==================      ===================================

MSG_EOR will be flagged to indicate that this is the final message for
this call.
”h]”(hÊ)”}”(hŒ­The final ACK from the client will be posted for retrieval by recvmsg()
when it is received.  It will take the form of a dataless message with two
control messages attached:”h]”hŒ­The final ACK from the client will be posted for retrieval by recvmsg()
when it is received.  It will take the form of a dataless message with two
control messages attached:”…””}”(hj~  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mçhjz  ubhè)”}”(hŒê==================      ===================================
RXRPC_USER_CALL_ID      specifies the user ID for this call
RXRPC_ACK               indicates final ACK (no data)
==================      ===================================
”h]”j‰	  )”}”(hhh]”jŽ	  )”}”(hhh]”(j“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j’	  hj“  ubj“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”K#uh1j’	  hj“  ubj1
  )”}”(hhh]”(jÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_USER_CALL_ID”h]”hŒRXRPC_USER_CALL_ID”…””}”(hj³  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mìhj°  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj­  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ#specifies the user ID for this call”h]”hŒ#specifies the user ID for this call”…””}”(hjÊ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MìhjÇ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj­  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hjª  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒ	RXRPC_ACK”h]”hŒ	RXRPC_ACK”…””}”(hjê  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Míhjç  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjä  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒindicates final ACK (no data)”h]”hŒindicates final ACK (no data)”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Míhjþ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjä  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hjª  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j0
  hj“  ubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1j	  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jˆ	  hjŒ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h Mëhjz  ubhÊ)”}”(hŒQMSG_EOR will be flagged to indicate that this is the final message for
this call.”h]”hŒQMSG_EOR will be flagged to indicate that this is the final message for
this call.”…””}”(hj4  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mðhjz  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjw  hžhhŸh³h Nubhó)”}”(hXÿ  Up to the point the final packet of reply data is sent, the call can be
aborted by calling sendmsg() with a dataless message with the following
control messages attached:

   ==================      ===================================
   RXRPC_USER_CALL_ID      specifies the user ID for this call
   RXRPC_ABORT             indicates abort code (4 byte data)
   ==================      ===================================

Any packets waiting in the socket's receive queue will be discarded if
this is issued.
”h]”(hÊ)”}”(hŒªUp to the point the final packet of reply data is sent, the call can be
aborted by calling sendmsg() with a dataless message with the following
control messages attached:”h]”hŒªUp to the point the final packet of reply data is sent, the call can be
aborted by calling sendmsg() with a dataless message with the following
control messages attached:”…””}”(hjL  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MóhjH  ubhè)”}”(hŒï==================      ===================================
RXRPC_USER_CALL_ID      specifies the user ID for this call
RXRPC_ABORT             indicates abort code (4 byte data)
==================      ===================================
”h]”j‰	  )”}”(hhh]”jŽ	  )”}”(hhh]”(j“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j’	  hja  ubj“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”K#uh1j’	  hja  ubj1
  )”}”(hhh]”(jÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_USER_CALL_ID”h]”hŒRXRPC_USER_CALL_ID”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Møhj~  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj{  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ#specifies the user ID for this call”h]”hŒ#specifies the user ID for this call”…””}”(hj˜  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Møhj•  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj{  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hjx  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_ABORT”h]”hŒRXRPC_ABORT”…””}”(hj¸  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mùhjµ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj²  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ"indicates abort code (4 byte data)”h]”hŒ"indicates abort code (4 byte data)”…””}”(hjÏ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MùhjÌ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj²  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hjx  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j0
  hja  ubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1j	  hj^  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jˆ	  hjZ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h M÷hjH  ubhÊ)”}”(hŒVAny packets waiting in the socket's receive queue will be discarded if
this is issued.”h]”hŒXAny packets waiting in the socketâ€™s receive queue will be discarded if
this is issued.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MühjH  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjw  hžhhŸh³h Nubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  jR	  K
uh1híhj  hžhhŸh³h MçubhÊ)”}”(hŒµNote that all the communications for a particular service take place through
the one server socket, using control messages on sendmsg() and recvmsg() to
determine the call affected.”h]”hŒµNote that all the communications for a particular service take place through
the one server socket, using control messages on sendmsg() and recvmsg() to
determine the call affected.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mÿhj  hžhubeh}”(h]”Œexample-server-usage”ah ]”h"]”Œexample server usage”ah$]”h&]”uh1h´hj  hžhhŸh³h Mubhµ)”}”(hhh]”(hº)”}”(hŒAF_RXRPC Kernel Interface”h]”hŒAF_RXRPC Kernel Interface”…””}”(hj5  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj2  hžhhŸh³h MubhÊ)”}”(hŒŠThe AF_RXRPC module also provides an interface for use by in-kernel utilities
such as the AFS filesystem.  This permits such a utility to:”h]”hŒŠThe AF_RXRPC module also provides an interface for use by in-kernel utilities
such as the AFS filesystem.  This permits such a utility to:”…””}”(hjC  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj2  hžhubhè)”}”(hX  (1) Use different keys directly on individual client calls on one socket
    rather than having to open a whole slew of sockets, one for each key it
    might want to use.

(2) Avoid having RxRPC call request_key() at the point of issue of a call or
    opening of a socket.  Instead the utility is responsible for requesting a
    key at the appropriate point.  AFS, for instance, would do this during VFS
    operations such as open() or unlink().  The key is then handed through
    when the call is initiated.

(3) Request the use of something other than GFP_KERNEL to allocate memory.

(4) Avoid the overhead of using the recvmsg() call.  RxRPC messages can be
    intercepted before they get put into the socket Rx queue and the socket
    buffers manipulated directly.
”h]”hî)”}”(hhh]”(hó)”}”(hŒ Use different keys directly on individual client calls on one socket
rather than having to open a whole slew of sockets, one for each key it
might want to use.
”h]”hÊ)”}”(hŒŸUse different keys directly on individual client calls on one socket
rather than having to open a whole slew of sockets, one for each key it
might want to use.”h]”hŒŸUse different keys directly on individual client calls on one socket
rather than having to open a whole slew of sockets, one for each key it
might want to use.”…””}”(hj\  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M
hjX  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjU  ubhó)”}”(hXA  Avoid having RxRPC call request_key() at the point of issue of a call or
opening of a socket.  Instead the utility is responsible for requesting a
key at the appropriate point.  AFS, for instance, would do this during VFS
operations such as open() or unlink().  The key is then handed through
when the call is initiated.
”h]”hÊ)”}”(hX@  Avoid having RxRPC call request_key() at the point of issue of a call or
opening of a socket.  Instead the utility is responsible for requesting a
key at the appropriate point.  AFS, for instance, would do this during VFS
operations such as open() or unlink().  The key is then handed through
when the call is initiated.”h]”hX@  Avoid having RxRPC call request_key() at the point of issue of a call or
opening of a socket.  Instead the utility is responsible for requesting a
key at the appropriate point.  AFS, for instance, would do this during VFS
operations such as open() or unlink().  The key is then handed through
when the call is initiated.”…””}”(hjt  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhjp  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjU  ubhó)”}”(hŒGRequest the use of something other than GFP_KERNEL to allocate memory.
”h]”hÊ)”}”(hŒFRequest the use of something other than GFP_KERNEL to allocate memory.”h]”hŒFRequest the use of something other than GFP_KERNEL to allocate memory.”…””}”(hjŒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhjˆ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjU  ubhó)”}”(hŒ­Avoid the overhead of using the recvmsg() call.  RxRPC messages can be
intercepted before they get put into the socket Rx queue and the socket
buffers manipulated directly.
”h]”hÊ)”}”(hŒ¬Avoid the overhead of using the recvmsg() call.  RxRPC messages can be
intercepted before they get put into the socket Rx queue and the socket
buffers manipulated directly.”h]”hŒ¬Avoid the overhead of using the recvmsg() call.  RxRPC messages can be
intercepted before they get put into the socket Rx queue and the socket
buffers manipulated directly.”…””}”(hj¤  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj   ubah}”(h]”h ]”h"]”h$]”h&]”uh1hòhjU  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhjQ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h M
hj2  hžhubhÊ)”}”(hŒÓTo use the RxRPC facility, a kernel utility must still open an AF_RXRPC socket,
bind an address as appropriate and listen if it's to be a server socket, but
then it passes this to the kernel interface functions.”h]”hŒÕTo use the RxRPC facility, a kernel utility must still open an AF_RXRPC socket,
bind an address as appropriate and listen if itâ€™s to be a server socket, but
then it passes this to the kernel interface functions.”…””}”(hjÄ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj2  hžhubhÊ)”}”(hŒ.The kernel interface functions are as follows:”h]”hŒ.The kernel interface functions are as follows:”…””}”(hjÒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj2  hžhubhè)”}”(hXH4  (#) Begin a new client call::

       struct rxrpc_call *
       rxrpc_kernel_begin_call(struct socket *sock,
                               struct sockaddr_rxrpc *srx,
                               struct key *key,
                               unsigned long user_call_ID,
                               s64 tx_total_len,
                               gfp_t gfp,
                               rxrpc_notify_rx_t notify_rx,
                               bool upgrade,
                               bool intr,
                               unsigned int debug_id);

    This allocates the infrastructure to make a new RxRPC call and assigns
    call and connection numbers.  The call will be made on the UDP port that
    the socket is bound to.  The call will go to the destination address of a
    connected client socket unless an alternative is supplied (srx is
    non-NULL).

    If a key is supplied then this will be used to secure the call instead of
    the key bound to the socket with the RXRPC_SECURITY_KEY sockopt.  Calls
    secured in this way will still share connections if at all possible.

    The user_call_ID is equivalent to that supplied to sendmsg() in the
    control data buffer.  It is entirely feasible to use this to point to a
    kernel data structure.

    tx_total_len is the amount of data the caller is intending to transmit
    with this call (or -1 if unknown at this point).  Setting the data size
    allows the kernel to encrypt directly to the packet buffers, thereby
    saving a copy.  The value may not be less than -1.

    notify_rx is a pointer to a function to be called when events such as
    incoming data packets or remote aborts happen.

    upgrade should be set to true if a client operation should request that
    the server upgrade the service to a better one.  The resultant service ID
    is returned by rxrpc_kernel_recv_data().

    intr should be set to true if the call should be interruptible.  If this
    is not set, this function may not return until a channel has been
    allocated; if it is set, the function may return -ERESTARTSYS.

    debug_id is the call debugging ID to be used for tracing.  This can be
    obtained by atomically incrementing rxrpc_debug_id.

    If this function is successful, an opaque reference to the RxRPC call is
    returned.  The caller now holds a reference on this and it must be
    properly ended.

(#) Shut down a client call::

       void rxrpc_kernel_shutdown_call(struct socket *sock,
                                       struct rxrpc_call *call);

    This is used to shut down a previously begun call.  The user_call_ID is
    expunged from AF_RXRPC's knowledge and will not be seen again in
    association with the specified call.

(#) Release the ref on a client call::

       void rxrpc_kernel_put_call(struct socket *sock,
                                  struct rxrpc_call *call);

    This is used to release the caller's ref on an rxrpc call.

(#) Send data through a call::

       typedef void (*rxrpc_notify_end_tx_t)(struct sock *sk,
                                             unsigned long user_call_ID,
                                             struct sk_buff *skb);

       int rxrpc_kernel_send_data(struct socket *sock,
                                  struct rxrpc_call *call,
                                  struct msghdr *msg,
                                  size_t len,
                                  rxrpc_notify_end_tx_t notify_end_rx);

    This is used to supply either the request part of a client call or the
    reply part of a server call.  msg.msg_iovlen and msg.msg_iov specify the
    data buffers to be used.  msg_iov may not be NULL and must point
    exclusively to in-kernel virtual addresses.  msg.msg_flags may be given
    MSG_MORE if there will be subsequent data sends for this call.

    The msg must not specify a destination address, control data or any flags
    other than MSG_MORE.  len is the total amount of data to transmit.

    notify_end_rx can be NULL or it can be used to specify a function to be
    called when the call changes state to end the Tx phase.  This function is
    called with a spinlock held to prevent the last DATA packet from being
    transmitted until the function returns.

(#) Receive data from a call::

       int rxrpc_kernel_recv_data(struct socket *sock,
                                  struct rxrpc_call *call,
                                  void *buf,
                                  size_t size,
                                  size_t *_offset,
                                  bool want_more,
                                  u32 *_abort,
                                  u16 *_service)

     This is used to receive data from either the reply part of a client call
     or the request part of a service call.  buf and size specify how much
     data is desired and where to store it.  *_offset is added on to buf and
     subtracted from size internally; the amount copied into the buffer is
     added to *_offset before returning.

     want_more should be true if further data will be required after this is
     satisfied and false if this is the last item of the receive phase.

     There are three normal returns: 0 if the buffer was filled and want_more
     was true; 1 if the buffer was filled, the last DATA packet has been
     emptied and want_more was false; and -EAGAIN if the function needs to be
     called again.

     If the last DATA packet is processed but the buffer contains less than
     the amount requested, EBADMSG is returned.  If want_more wasn't set, but
     more data was available, EMSGSIZE is returned.

     If a remote ABORT is detected, the abort code received will be stored in
     ``*_abort`` and ECONNABORTED will be returned.

     The service ID that the call ended up with is returned into *_service.
     This can be used to see if a call got a service upgrade.

(#) Abort a call??

    ::

       void rxrpc_kernel_abort_call(struct socket *sock,
                                    struct rxrpc_call *call,
                                    u32 abort_code);

    This is used to abort a call if it's still in an abortable state.  The
    abort code specified will be placed in the ABORT message sent.

(#) Intercept received RxRPC messages::

       typedef void (*rxrpc_interceptor_t)(struct sock *sk,
                                           unsigned long user_call_ID,
                                           struct sk_buff *skb);

       void
       rxrpc_kernel_intercept_rx_messages(struct socket *sock,
                                          rxrpc_interceptor_t interceptor);

    This installs an interceptor function on the specified AF_RXRPC socket.
    All messages that would otherwise wind up in the socket's Rx queue are
    then diverted to this function.  Note that care must be taken to process
    the messages in the right order to maintain DATA message sequentiality.

    The interceptor function itself is provided with the address of the socket
    and handling the incoming message, the ID assigned by the kernel utility
    to the call and the socket buffer containing the message.

    The skb->mark field indicates the type of message:

       =============================== =======================================
       Mark                            Meaning
       =============================== =======================================
       RXRPC_SKB_MARK_DATA             Data message
       RXRPC_SKB_MARK_FINAL_ACK        Final ACK received for an incoming call
       RXRPC_SKB_MARK_BUSY             Client call rejected as server busy
       RXRPC_SKB_MARK_REMOTE_ABORT     Call aborted by peer
       RXRPC_SKB_MARK_NET_ERROR        Network error detected
       RXRPC_SKB_MARK_LOCAL_ERROR      Local error encountered
       RXRPC_SKB_MARK_NEW_CALL         New incoming call awaiting acceptance
       =============================== =======================================

    The remote abort message can be probed with rxrpc_kernel_get_abort_code().
    The two error messages can be probed with rxrpc_kernel_get_error_number().
    A new call can be accepted with rxrpc_kernel_accept_call().

    Data messages can have their contents extracted with the usual bunch of
    socket buffer manipulation functions.  A data message can be determined to
    be the last one in a sequence with rxrpc_kernel_is_data_last().  When a
    data message has been used up, rxrpc_kernel_data_consumed() should be
    called on it.

    Messages should be handled to rxrpc_kernel_free_skb() to dispose of.  It
    is possible to get extra refs on all types of message for later freeing,
    but this may pin the state of a call until the message is finally freed.

(#) Accept an incoming call::

       struct rxrpc_call *
       rxrpc_kernel_accept_call(struct socket *sock,
                                unsigned long user_call_ID);

    This is used to accept an incoming call and to assign it a call ID.  This
    function is similar to rxrpc_kernel_begin_call() and calls accepted must
    be ended in the same way.

    If this function is successful, an opaque reference to the RxRPC call is
    returned.  The caller now holds a reference on this and it must be
    properly ended.

(#) Reject an incoming call::

       int rxrpc_kernel_reject_call(struct socket *sock);

    This is used to reject the first incoming call on the socket's queue with
    a BUSY message.  -ENODATA is returned if there were no incoming calls.
    Other errors may be returned if the call had been aborted (-ECONNABORTED)
    or had timed out (-ETIME).

(#) Allocate a null key for doing anonymous security::

       struct key *rxrpc_get_null_key(const char *keyname);

    This is used to allocate a null RxRPC key that can be used to indicate
    anonymous security for a particular domain.

(#) Get the peer address of a call::

       void rxrpc_kernel_get_peer(struct socket *sock, struct rxrpc_call *call,
                                  struct sockaddr_rxrpc *_srx);

    This is used to find the remote peer address of a call.

(#) Set the total transmit data size on a call::

       void rxrpc_kernel_set_tx_length(struct socket *sock,
                                       struct rxrpc_call *call,
                                       s64 tx_total_len);

    This sets the amount of data that the caller is intending to transmit on a
    call.  It's intended to be used for setting the reply size as the request
    size should be set when the call is begun.  tx_total_len may not be less
    than zero.

(#) Get call RTT::

       u64 rxrpc_kernel_get_rtt(struct socket *sock, struct rxrpc_call *call);

    Get the RTT time to the peer in use by a call.  The value returned is in
    nanoseconds.

(#) Check call still alive::

       bool rxrpc_kernel_check_life(struct socket *sock,
                                    struct rxrpc_call *call,
                                    u32 *_life);
       void rxrpc_kernel_probe_life(struct socket *sock,
                                    struct rxrpc_call *call);

    The first function passes back in ``*_life`` a number that is updated when
    ACKs are received from the peer (notably including PING RESPONSE ACKs
    which we can elicit by sending PING ACKs to see if the call still exists
    on the server).  The caller should compare the numbers of two calls to see
    if the call is still alive after waiting for a suitable interval.  It also
    returns true as long as the call hasn't yet reached the completed state.

    This allows the caller to work out if the server is still contactable and
    if the call is still alive on the server while waiting for the server to
    process a client operation.

    The second function causes a ping ACK to be transmitted to try to provoke
    the peer into responding, which would then cause the value returned by the
    first function to change.  Note that this must be called in TASK_RUNNING
    state.

(#) Get remote client epoch::

       u32 rxrpc_kernel_get_epoch(struct socket *sock,
                                  struct rxrpc_call *call)

    This allows the epoch that's contained in packets of an incoming client
    call to be queried.  This value is returned.  The function always
    successful if the call is still in progress.  It shouldn't be called once
    the call has expired.  Note that calling this on a local client call only
    returns the local epoch.

    This value can be used to determine if the remote client has been
    restarted as it shouldn't change otherwise.

(#) Set the maximum lifespan on a call::

       void rxrpc_kernel_set_max_life(struct socket *sock,
                                      struct rxrpc_call *call,
                                      unsigned long hard_timeout)

    This sets the maximum lifespan on a call to hard_timeout (which is in
    jiffies).  In the event of the timeout occurring, the call will be
    aborted and -ETIME or -ETIMEDOUT will be returned.

(#) Apply the RXRPC_MIN_SECURITY_LEVEL sockopt to a socket from within in the
    kernel::

      int rxrpc_sock_set_min_security_level(struct sock *sk,
                                            unsigned int val);

    This specifies the minimum security level required for calls on this
    socket.

”h]”hî)”}”(hhh]”(hó)”}”(hXË  Begin a new client call::

   struct rxrpc_call *
   rxrpc_kernel_begin_call(struct socket *sock,
                           struct sockaddr_rxrpc *srx,
                           struct key *key,
                           unsigned long user_call_ID,
                           s64 tx_total_len,
                           gfp_t gfp,
                           rxrpc_notify_rx_t notify_rx,
                           bool upgrade,
                           bool intr,
                           unsigned int debug_id);

This allocates the infrastructure to make a new RxRPC call and assigns
call and connection numbers.  The call will be made on the UDP port that
the socket is bound to.  The call will go to the destination address of a
connected client socket unless an alternative is supplied (srx is
non-NULL).

If a key is supplied then this will be used to secure the call instead of
the key bound to the socket with the RXRPC_SECURITY_KEY sockopt.  Calls
secured in this way will still share connections if at all possible.

The user_call_ID is equivalent to that supplied to sendmsg() in the
control data buffer.  It is entirely feasible to use this to point to a
kernel data structure.

tx_total_len is the amount of data the caller is intending to transmit
with this call (or -1 if unknown at this point).  Setting the data size
allows the kernel to encrypt directly to the packet buffers, thereby
saving a copy.  The value may not be less than -1.

notify_rx is a pointer to a function to be called when events such as
incoming data packets or remote aborts happen.

upgrade should be set to true if a client operation should request that
the server upgrade the service to a better one.  The resultant service ID
is returned by rxrpc_kernel_recv_data().

intr should be set to true if the call should be interruptible.  If this
is not set, this function may not return until a channel has been
allocated; if it is set, the function may return -ERESTARTSYS.

debug_id is the call debugging ID to be used for tracing.  This can be
obtained by atomically incrementing rxrpc_debug_id.

If this function is successful, an opaque reference to the RxRPC call is
returned.  The caller now holds a reference on this and it must be
properly ended.
”h]”(hÊ)”}”(hŒBegin a new client call::”h]”hŒBegin a new client call:”…””}”(hjë  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M hjç  ubj  )”}”(hXÌ  struct rxrpc_call *
rxrpc_kernel_begin_call(struct socket *sock,
                        struct sockaddr_rxrpc *srx,
                        struct key *key,
                        unsigned long user_call_ID,
                        s64 tx_total_len,
                        gfp_t gfp,
                        rxrpc_notify_rx_t notify_rx,
                        bool upgrade,
                        bool intr,
                        unsigned int debug_id);”h]”hXÌ  struct rxrpc_call *
rxrpc_kernel_begin_call(struct socket *sock,
                        struct sockaddr_rxrpc *srx,
                        struct key *key,
                        unsigned long user_call_ID,
                        s64 tx_total_len,
                        gfp_t gfp,
                        rxrpc_notify_rx_t notify_rx,
                        bool upgrade,
                        bool intr,
                        unsigned int debug_id);”…””}”hjù  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h M"hjç  ubhÊ)”}”(hX&  This allocates the infrastructure to make a new RxRPC call and assigns
call and connection numbers.  The call will be made on the UDP port that
the socket is bound to.  The call will go to the destination address of a
connected client socket unless an alternative is supplied (srx is
non-NULL).”h]”hX&  This allocates the infrastructure to make a new RxRPC call and assigns
call and connection numbers.  The call will be made on the UDP port that
the socket is bound to.  The call will go to the destination address of a
connected client socket unless an alternative is supplied (srx is
non-NULL).”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M.hjç  ubhÊ)”}”(hŒÖIf a key is supplied then this will be used to secure the call instead of
the key bound to the socket with the RXRPC_SECURITY_KEY sockopt.  Calls
secured in this way will still share connections if at all possible.”h]”hŒÖIf a key is supplied then this will be used to secure the call instead of
the key bound to the socket with the RXRPC_SECURITY_KEY sockopt.  Calls
secured in this way will still share connections if at all possible.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M4hjç  ubhÊ)”}”(hŒ¢The user_call_ID is equivalent to that supplied to sendmsg() in the
control data buffer.  It is entirely feasible to use this to point to a
kernel data structure.”h]”hŒ¢The user_call_ID is equivalent to that supplied to sendmsg() in the
control data buffer.  It is entirely feasible to use this to point to a
kernel data structure.”…””}”(hj#  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M8hjç  ubhÊ)”}”(hX  tx_total_len is the amount of data the caller is intending to transmit
with this call (or -1 if unknown at this point).  Setting the data size
allows the kernel to encrypt directly to the packet buffers, thereby
saving a copy.  The value may not be less than -1.”h]”hX  tx_total_len is the amount of data the caller is intending to transmit
with this call (or -1 if unknown at this point).  Setting the data size
allows the kernel to encrypt directly to the packet buffers, thereby
saving a copy.  The value may not be less than -1.”…””}”(hj1  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M<hjç  ubhÊ)”}”(hŒtnotify_rx is a pointer to a function to be called when events such as
incoming data packets or remote aborts happen.”h]”hŒtnotify_rx is a pointer to a function to be called when events such as
incoming data packets or remote aborts happen.”…””}”(hj?  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MAhjç  ubhÊ)”}”(hŒºupgrade should be set to true if a client operation should request that
the server upgrade the service to a better one.  The resultant service ID
is returned by rxrpc_kernel_recv_data().”h]”hŒºupgrade should be set to true if a client operation should request that
the server upgrade the service to a better one.  The resultant service ID
is returned by rxrpc_kernel_recv_data().”…””}”(hjM  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MDhjç  ubhÊ)”}”(hŒÉintr should be set to true if the call should be interruptible.  If this
is not set, this function may not return until a channel has been
allocated; if it is set, the function may return -ERESTARTSYS.”h]”hŒÉintr should be set to true if the call should be interruptible.  If this
is not set, this function may not return until a channel has been
allocated; if it is set, the function may return -ERESTARTSYS.”…””}”(hj[  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MHhjç  ubhÊ)”}”(hŒzdebug_id is the call debugging ID to be used for tracing.  This can be
obtained by atomically incrementing rxrpc_debug_id.”h]”hŒzdebug_id is the call debugging ID to be used for tracing.  This can be
obtained by atomically incrementing rxrpc_debug_id.”…””}”(hji  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MLhjç  ubhÊ)”}”(hŒ›If this function is successful, an opaque reference to the RxRPC call is
returned.  The caller now holds a reference on this and it must be
properly ended.”h]”hŒ›If this function is successful, an opaque reference to the RxRPC call is
returned.  The caller now holds a reference on this and it must be
properly ended.”…””}”(hjw  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MOhjç  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hX?  Shut down a client call::

   void rxrpc_kernel_shutdown_call(struct socket *sock,
                                   struct rxrpc_call *call);

This is used to shut down a previously begun call.  The user_call_ID is
expunged from AF_RXRPC's knowledge and will not be seen again in
association with the specified call.
”h]”(hÊ)”}”(hŒShut down a client call::”h]”hŒShut down a client call:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MShj‹  ubj  )”}”(hŒnvoid rxrpc_kernel_shutdown_call(struct socket *sock,
                                struct rxrpc_call *call);”h]”hŒnvoid rxrpc_kernel_shutdown_call(struct socket *sock,
                                struct rxrpc_call *call);”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h MUhj‹  ubhÊ)”}”(hŒ­This is used to shut down a previously begun call.  The user_call_ID is
expunged from AF_RXRPC's knowledge and will not be seen again in
association with the specified call.”h]”hŒ¯This is used to shut down a previously begun call.  The user_call_ID is
expunged from AF_RXRPCâ€™s knowledge and will not be seen again in
association with the specified call.”…””}”(hj«  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MXhj‹  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hŒËRelease the ref on a client call::

   void rxrpc_kernel_put_call(struct socket *sock,
                              struct rxrpc_call *call);

This is used to release the caller's ref on an rxrpc call.
”h]”(hÊ)”}”(hŒ"Release the ref on a client call::”h]”hŒ!Release the ref on a client call:”…””}”(hjÃ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M\hj¿  ubj  )”}”(hŒdvoid rxrpc_kernel_put_call(struct socket *sock,
                           struct rxrpc_call *call);”h]”hŒdvoid rxrpc_kernel_put_call(struct socket *sock,
                           struct rxrpc_call *call);”…””}”hjÑ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h M^hj¿  ubhÊ)”}”(hŒ:This is used to release the caller's ref on an rxrpc call.”h]”hŒ<This is used to release the callerâ€™s ref on an rxrpc call.”…””}”(hjß  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mahj¿  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hXÎ  Send data through a call::

   typedef void (*rxrpc_notify_end_tx_t)(struct sock *sk,
                                         unsigned long user_call_ID,
                                         struct sk_buff *skb);

   int rxrpc_kernel_send_data(struct socket *sock,
                              struct rxrpc_call *call,
                              struct msghdr *msg,
                              size_t len,
                              rxrpc_notify_end_tx_t notify_end_rx);

This is used to supply either the request part of a client call or the
reply part of a server call.  msg.msg_iovlen and msg.msg_iov specify the
data buffers to be used.  msg_iov may not be NULL and must point
exclusively to in-kernel virtual addresses.  msg.msg_flags may be given
MSG_MORE if there will be subsequent data sends for this call.

The msg must not specify a destination address, control data or any flags
other than MSG_MORE.  len is the total amount of data to transmit.

notify_end_rx can be NULL or it can be used to specify a function to be
called when the call changes state to end the Tx phase.  This function is
called with a spinlock held to prevent the last DATA packet from being
transmitted until the function returns.
”h]”(hÊ)”}”(hŒSend data through a call::”h]”hŒSend data through a call:”…””}”(hj÷  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mchjó  ubj  )”}”(hX°  typedef void (*rxrpc_notify_end_tx_t)(struct sock *sk,
                                      unsigned long user_call_ID,
                                      struct sk_buff *skb);

int rxrpc_kernel_send_data(struct socket *sock,
                           struct rxrpc_call *call,
                           struct msghdr *msg,
                           size_t len,
                           rxrpc_notify_end_tx_t notify_end_rx);”h]”hX°  typedef void (*rxrpc_notify_end_tx_t)(struct sock *sk,
                                      unsigned long user_call_ID,
                                      struct sk_buff *skb);

int rxrpc_kernel_send_data(struct socket *sock,
                           struct rxrpc_call *call,
                           struct msghdr *msg,
                           size_t len,
                           rxrpc_notify_end_tx_t notify_end_rx);”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h Mehjó  ubhÊ)”}”(hXW  This is used to supply either the request part of a client call or the
reply part of a server call.  msg.msg_iovlen and msg.msg_iov specify the
data buffers to be used.  msg_iov may not be NULL and must point
exclusively to in-kernel virtual addresses.  msg.msg_flags may be given
MSG_MORE if there will be subsequent data sends for this call.”h]”hXW  This is used to supply either the request part of a client call or the
reply part of a server call.  msg.msg_iovlen and msg.msg_iov specify the
data buffers to be used.  msg_iov may not be NULL and must point
exclusively to in-kernel virtual addresses.  msg.msg_flags may be given
MSG_MORE if there will be subsequent data sends for this call.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mohjó  ubhÊ)”}”(hŒŒThe msg must not specify a destination address, control data or any flags
other than MSG_MORE.  len is the total amount of data to transmit.”h]”hŒŒThe msg must not specify a destination address, control data or any flags
other than MSG_MORE.  len is the total amount of data to transmit.”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Muhjó  ubhÊ)”}”(hX   notify_end_rx can be NULL or it can be used to specify a function to be
called when the call changes state to end the Tx phase.  This function is
called with a spinlock held to prevent the last DATA packet from being
transmitted until the function returns.”h]”hX   notify_end_rx can be NULL or it can be used to specify a function to be
called when the call changes state to end the Tx phase.  This function is
called with a spinlock held to prevent the last DATA packet from being
transmitted until the function returns.”…””}”(hj/  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mxhjó  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hX  Receive data from a call::

   int rxrpc_kernel_recv_data(struct socket *sock,
                              struct rxrpc_call *call,
                              void *buf,
                              size_t size,
                              size_t *_offset,
                              bool want_more,
                              u32 *_abort,
                              u16 *_service)

 This is used to receive data from either the reply part of a client call
 or the request part of a service call.  buf and size specify how much
 data is desired and where to store it.  *_offset is added on to buf and
 subtracted from size internally; the amount copied into the buffer is
 added to *_offset before returning.

 want_more should be true if further data will be required after this is
 satisfied and false if this is the last item of the receive phase.

 There are three normal returns: 0 if the buffer was filled and want_more
 was true; 1 if the buffer was filled, the last DATA packet has been
 emptied and want_more was false; and -EAGAIN if the function needs to be
 called again.

 If the last DATA packet is processed but the buffer contains less than
 the amount requested, EBADMSG is returned.  If want_more wasn't set, but
 more data was available, EMSGSIZE is returned.

 If a remote ABORT is detected, the abort code received will be stored in
 ``*_abort`` and ECONNABORTED will be returned.

 The service ID that the call ended up with is returned into *_service.
 This can be used to see if a call got a service upgrade.
”h]”(hÊ)”}”(hŒReceive data from a call::”h]”hŒReceive data from a call:”…””}”(hjG  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M}hjC  ubj  )”}”(hX×    int rxrpc_kernel_recv_data(struct socket *sock,
                             struct rxrpc_call *call,
                             void *buf,
                             size_t size,
                             size_t *_offset,
                             bool want_more,
                             u32 *_abort,
                             u16 *_service)

This is used to receive data from either the reply part of a client call
or the request part of a service call.  buf and size specify how much
data is desired and where to store it.  *_offset is added on to buf and
subtracted from size internally; the amount copied into the buffer is
added to *_offset before returning.

want_more should be true if further data will be required after this is
satisfied and false if this is the last item of the receive phase.

There are three normal returns: 0 if the buffer was filled and want_more
was true; 1 if the buffer was filled, the last DATA packet has been
emptied and want_more was false; and -EAGAIN if the function needs to be
called again.

If the last DATA packet is processed but the buffer contains less than
the amount requested, EBADMSG is returned.  If want_more wasn't set, but
more data was available, EMSGSIZE is returned.

If a remote ABORT is detected, the abort code received will be stored in
``*_abort`` and ECONNABORTED will be returned.

The service ID that the call ended up with is returned into *_service.
This can be used to see if a call got a service upgrade.”h]”hX×    int rxrpc_kernel_recv_data(struct socket *sock,
                             struct rxrpc_call *call,
                             void *buf,
                             size_t size,
                             size_t *_offset,
                             bool want_more,
                             u32 *_abort,
                             u16 *_service)

This is used to receive data from either the reply part of a client call
or the request part of a service call.  buf and size specify how much
data is desired and where to store it.  *_offset is added on to buf and
subtracted from size internally; the amount copied into the buffer is
added to *_offset before returning.

want_more should be true if further data will be required after this is
satisfied and false if this is the last item of the receive phase.

There are three normal returns: 0 if the buffer was filled and want_more
was true; 1 if the buffer was filled, the last DATA packet has been
emptied and want_more was false; and -EAGAIN if the function needs to be
called again.

If the last DATA packet is processed but the buffer contains less than
the amount requested, EBADMSG is returned.  If want_more wasn't set, but
more data was available, EMSGSIZE is returned.

If a remote ABORT is detected, the abort code received will be stored in
``*_abort`` and ECONNABORTED will be returned.

The service ID that the call ended up with is returned into *_service.
This can be used to see if a call got a service upgrade.”…””}”hjU  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h MhjC  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hX:  Abort a call??

::

   void rxrpc_kernel_abort_call(struct socket *sock,
                                struct rxrpc_call *call,
                                u32 abort_code);

This is used to abort a call if it's still in an abortable state.  The
abort code specified will be placed in the ABORT message sent.
”h]”(hÊ)”}”(hŒAbort a call??”h]”hŒAbort a call??”…””}”(hjm  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M hji  ubj  )”}”(hŒ•void rxrpc_kernel_abort_call(struct socket *sock,
                             struct rxrpc_call *call,
                             u32 abort_code);”h]”hŒ•void rxrpc_kernel_abort_call(struct socket *sock,
                             struct rxrpc_call *call,
                             u32 abort_code);”…””}”hj{  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h M¤hji  ubhÊ)”}”(hŒ…This is used to abort a call if it's still in an abortable state.  The
abort code specified will be placed in the ABORT message sent.”h]”hŒ‡This is used to abort a call if itâ€™s still in an abortable state.  The
abort code specified will be placed in the ABORT message sent.”…””}”(hj‰  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M¨hji  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hX1	  Intercept received RxRPC messages::

   typedef void (*rxrpc_interceptor_t)(struct sock *sk,
                                       unsigned long user_call_ID,
                                       struct sk_buff *skb);

   void
   rxrpc_kernel_intercept_rx_messages(struct socket *sock,
                                      rxrpc_interceptor_t interceptor);

This installs an interceptor function on the specified AF_RXRPC socket.
All messages that would otherwise wind up in the socket's Rx queue are
then diverted to this function.  Note that care must be taken to process
the messages in the right order to maintain DATA message sequentiality.

The interceptor function itself is provided with the address of the socket
and handling the incoming message, the ID assigned by the kernel utility
to the call and the socket buffer containing the message.

The skb->mark field indicates the type of message:

   =============================== =======================================
   Mark                            Meaning
   =============================== =======================================
   RXRPC_SKB_MARK_DATA             Data message
   RXRPC_SKB_MARK_FINAL_ACK        Final ACK received for an incoming call
   RXRPC_SKB_MARK_BUSY             Client call rejected as server busy
   RXRPC_SKB_MARK_REMOTE_ABORT     Call aborted by peer
   RXRPC_SKB_MARK_NET_ERROR        Network error detected
   RXRPC_SKB_MARK_LOCAL_ERROR      Local error encountered
   RXRPC_SKB_MARK_NEW_CALL         New incoming call awaiting acceptance
   =============================== =======================================

The remote abort message can be probed with rxrpc_kernel_get_abort_code().
The two error messages can be probed with rxrpc_kernel_get_error_number().
A new call can be accepted with rxrpc_kernel_accept_call().

Data messages can have their contents extracted with the usual bunch of
socket buffer manipulation functions.  A data message can be determined to
be the last one in a sequence with rxrpc_kernel_is_data_last().  When a
data message has been used up, rxrpc_kernel_data_consumed() should be
called on it.

Messages should be handled to rxrpc_kernel_free_skb() to dispose of.  It
is possible to get extra refs on all types of message for later freeing,
but this may pin the state of a call until the message is finally freed.
”h]”(hÊ)”}”(hŒ#Intercept received RxRPC messages::”h]”hŒ"Intercept received RxRPC messages:”…””}”(hj¡  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M«hj  ubj  )”}”(hX1  typedef void (*rxrpc_interceptor_t)(struct sock *sk,
                                    unsigned long user_call_ID,
                                    struct sk_buff *skb);

void
rxrpc_kernel_intercept_rx_messages(struct socket *sock,
                                   rxrpc_interceptor_t interceptor);”h]”hX1  typedef void (*rxrpc_interceptor_t)(struct sock *sk,
                                    unsigned long user_call_ID,
                                    struct sk_buff *skb);

void
rxrpc_kernel_intercept_rx_messages(struct socket *sock,
                                   rxrpc_interceptor_t interceptor);”…””}”hj¯  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h M­hj  ubhÊ)”}”(hX  This installs an interceptor function on the specified AF_RXRPC socket.
All messages that would otherwise wind up in the socket's Rx queue are
then diverted to this function.  Note that care must be taken to process
the messages in the right order to maintain DATA message sequentiality.”h]”hX!  This installs an interceptor function on the specified AF_RXRPC socket.
All messages that would otherwise wind up in the socketâ€™s Rx queue are
then diverted to this function.  Note that care must be taken to process
the messages in the right order to maintain DATA message sequentiality.”…””}”(hj½  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mµhj  ubhÊ)”}”(hŒÍThe interceptor function itself is provided with the address of the socket
and handling the incoming message, the ID assigned by the kernel utility
to the call and the socket buffer containing the message.”h]”hŒÍThe interceptor function itself is provided with the address of the socket
and handling the incoming message, the ID assigned by the kernel utility
to the call and the socket buffer containing the message.”…””}”(hjË  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mºhj  ubhÊ)”}”(hŒ2The skb->mark field indicates the type of message:”h]”hŒ2The skb->mark field indicates the type of message:”…””}”(hjÙ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M¾hj  ubhè)”}”(hX£  =============================== =======================================
Mark                            Meaning
=============================== =======================================
RXRPC_SKB_MARK_DATA             Data message
RXRPC_SKB_MARK_FINAL_ACK        Final ACK received for an incoming call
RXRPC_SKB_MARK_BUSY             Client call rejected as server busy
RXRPC_SKB_MARK_REMOTE_ABORT     Call aborted by peer
RXRPC_SKB_MARK_NET_ERROR        Network error detected
RXRPC_SKB_MARK_LOCAL_ERROR      Local error encountered
RXRPC_SKB_MARK_NEW_CALL         New incoming call awaiting acceptance
=============================== =======================================
”h]”j‰	  )”}”(hhh]”jŽ	  )”}”(hhh]”(j“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j’	  hjî  ubj“	  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”K'uh1j’	  hjî  ubj½	  )”}”(hhh]”jÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒMark”h]”hŒMark”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÁhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒMeaning”h]”hŒMeaning”…””}”(hj%  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÁhj"  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj  ubeh}”(h]”h ]”h"]”•˜      h$]”h&]”uh1jÁ	  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¼	  hjî  ubj1
  )”}”(hhh]”(jÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_SKB_MARK_DATA”h]”hŒRXRPC_SKB_MARK_DATA”…””}”(hjN  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÃhjK  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjH  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒData message”h]”hŒData message”…””}”(hje  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÃhjb  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjH  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hjE  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_SKB_MARK_FINAL_ACK”h]”hŒRXRPC_SKB_MARK_FINAL_ACK”…””}”(hj…  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÄhj‚  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ'Final ACK received for an incoming call”h]”hŒ'Final ACK received for an incoming call”…””}”(hjœ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÄhj™  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hjE  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_SKB_MARK_BUSY”h]”hŒRXRPC_SKB_MARK_BUSY”…””}”(hj¼  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÅhj¹  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj¶  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ#Client call rejected as server busy”h]”hŒ#Client call rejected as server busy”…””}”(hjÓ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÅhjÐ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj¶  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hjE  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_SKB_MARK_REMOTE_ABORT”h]”hŒRXRPC_SKB_MARK_REMOTE_ABORT”…””}”(hjó  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÆhjð  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjí  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒCall aborted by peer”h]”hŒCall aborted by peer”…””}”(hj
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÆhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hjí  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hjE  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_SKB_MARK_NET_ERROR”h]”hŒRXRPC_SKB_MARK_NET_ERROR”…””}”(hj*  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÇhj'  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj$  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒNetwork error detected”h]”hŒNetwork error detected”…””}”(hjA  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÇhj>  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj$  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hjE  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_SKB_MARK_LOCAL_ERROR”h]”hŒRXRPC_SKB_MARK_LOCAL_ERROR”…””}”(hja  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÈhj^  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj[  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒLocal error encountered”h]”hŒLocal error encountered”…””}”(hjx  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÈhju  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj[  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hjE  ubjÂ	  )”}”(hhh]”(jÇ	  )”}”(hhh]”hÊ)”}”(hŒRXRPC_SKB_MARK_NEW_CALL”h]”hŒRXRPC_SKB_MARK_NEW_CALL”…””}”(hj˜  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÉhj•  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj’  ubjÇ	  )”}”(hhh]”hÊ)”}”(hŒ%New incoming call awaiting acceptance”h]”hŒ%New incoming call awaiting acceptance”…””}”(hj¯  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÉhj¬  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ	  hj’  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÁ	  hjE  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j0
  hjî  ubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1j	  hjë  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jˆ	  hjç  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h MÀhj  ubhÊ)”}”(hŒÑThe remote abort message can be probed with rxrpc_kernel_get_abort_code().
The two error messages can be probed with rxrpc_kernel_get_error_number().
A new call can be accepted with rxrpc_kernel_accept_call().”h]”hŒÑThe remote abort message can be probed with rxrpc_kernel_get_abort_code().
The two error messages can be probed with rxrpc_kernel_get_error_number().
A new call can be accepted with rxrpc_kernel_accept_call().”…””}”(hjâ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÌhj  ubhÊ)”}”(hX.  Data messages can have their contents extracted with the usual bunch of
socket buffer manipulation functions.  A data message can be determined to
be the last one in a sequence with rxrpc_kernel_is_data_last().  When a
data message has been used up, rxrpc_kernel_data_consumed() should be
called on it.”h]”hX.  Data messages can have their contents extracted with the usual bunch of
socket buffer manipulation functions.  A data message can be determined to
be the last one in a sequence with rxrpc_kernel_is_data_last().  When a
data message has been used up, rxrpc_kernel_data_consumed() should be
called on it.”…””}”(hjð  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÐhj  ubhÊ)”}”(hŒÚMessages should be handled to rxrpc_kernel_free_skb() to dispose of.  It
is possible to get extra refs on all types of message for later freeing,
but this may pin the state of a call until the message is finally freed.”h]”hŒÚMessages should be handled to rxrpc_kernel_free_skb() to dispose of.  It
is possible to get extra refs on all types of message for later freeing,
but this may pin the state of a call until the message is finally freed.”…””}”(hjþ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÖhj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hXç  Accept an incoming call::

   struct rxrpc_call *
   rxrpc_kernel_accept_call(struct socket *sock,
                            unsigned long user_call_ID);

This is used to accept an incoming call and to assign it a call ID.  This
function is similar to rxrpc_kernel_begin_call() and calls accepted must
be ended in the same way.

If this function is successful, an opaque reference to the RxRPC call is
returned.  The caller now holds a reference on this and it must be
properly ended.
”h]”(hÊ)”}”(hŒAccept an incoming call::”h]”hŒAccept an incoming call:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÚhj  ubj  )”}”(hŒwstruct rxrpc_call *
rxrpc_kernel_accept_call(struct socket *sock,
                         unsigned long user_call_ID);”h]”hŒwstruct rxrpc_call *
rxrpc_kernel_accept_call(struct socket *sock,
                         unsigned long user_call_ID);”…””}”hj$  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h MÜhj  ubhÊ)”}”(hŒ¬This is used to accept an incoming call and to assign it a call ID.  This
function is similar to rxrpc_kernel_begin_call() and calls accepted must
be ended in the same way.”h]”hŒ¬This is used to accept an incoming call and to assign it a call ID.  This
function is similar to rxrpc_kernel_begin_call() and calls accepted must
be ended in the same way.”…””}”(hj2  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Màhj  ubhÊ)”}”(hŒ›If this function is successful, an opaque reference to the RxRPC call is
returned.  The caller now holds a reference on this and it must be
properly ended.”h]”hŒ›If this function is successful, an opaque reference to the RxRPC call is
returned.  The caller now holds a reference on this and it must be
properly ended.”…””}”(hj@  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mähj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hXH  Reject an incoming call::

   int rxrpc_kernel_reject_call(struct socket *sock);

This is used to reject the first incoming call on the socket's queue with
a BUSY message.  -ENODATA is returned if there were no incoming calls.
Other errors may be returned if the call had been aborted (-ECONNABORTED)
or had timed out (-ETIME).
”h]”(hÊ)”}”(hŒReject an incoming call::”h]”hŒReject an incoming call:”…””}”(hjX  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MèhjT  ubj  )”}”(hŒ2int rxrpc_kernel_reject_call(struct socket *sock);”h]”hŒ2int rxrpc_kernel_reject_call(struct socket *sock);”…””}”hjf  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h MêhjT  ubhÊ)”}”(hŒõThis is used to reject the first incoming call on the socket's queue with
a BUSY message.  -ENODATA is returned if there were no incoming calls.
Other errors may be returned if the call had been aborted (-ECONNABORTED)
or had timed out (-ETIME).”h]”hŒ÷This is used to reject the first incoming call on the socketâ€™s queue with
a BUSY message.  -ENODATA is returned if there were no incoming calls.
Other errors may be returned if the call had been aborted (-ECONNABORTED)
or had timed out (-ETIME).”…””}”(hjt  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MìhjT  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hŒàAllocate a null key for doing anonymous security::

   struct key *rxrpc_get_null_key(const char *keyname);

This is used to allocate a null RxRPC key that can be used to indicate
anonymous security for a particular domain.
”h]”(hÊ)”}”(hŒ2Allocate a null key for doing anonymous security::”h]”hŒ1Allocate a null key for doing anonymous security:”…””}”(hjŒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mñhjˆ  ubj  )”}”(hŒ4struct key *rxrpc_get_null_key(const char *keyname);”h]”hŒ4struct key *rxrpc_get_null_key(const char *keyname);”…””}”hjš  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h Móhjˆ  ubhÊ)”}”(hŒrThis is used to allocate a null RxRPC key that can be used to indicate
anonymous security for a particular domain.”h]”hŒrThis is used to allocate a null RxRPC key that can be used to indicate
anonymous security for a particular domain.”…””}”(hj¨  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mõhjˆ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hŒãGet the peer address of a call::

   void rxrpc_kernel_get_peer(struct socket *sock, struct rxrpc_call *call,
                              struct sockaddr_rxrpc *_srx);

This is used to find the remote peer address of a call.
”h]”(hÊ)”}”(hŒ Get the peer address of a call::”h]”hŒGet the peer address of a call:”…””}”(hjÀ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Møhj¼  ubj  )”}”(hŒvoid rxrpc_kernel_get_peer(struct socket *sock, struct rxrpc_call *call,
                           struct sockaddr_rxrpc *_srx);”h]”hŒvoid rxrpc_kernel_get_peer(struct socket *sock, struct rxrpc_call *call,
                           struct sockaddr_rxrpc *_srx);”…””}”hjÎ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h Múhj¼  ubhÊ)”}”(hŒ7This is used to find the remote peer address of a call.”h]”hŒ7This is used to find the remote peer address of a call.”…””}”(hjÜ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mýhj¼  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hXÂ  Set the total transmit data size on a call::

   void rxrpc_kernel_set_tx_length(struct socket *sock,
                                   struct rxrpc_call *call,
                                   s64 tx_total_len);

This sets the amount of data that the caller is intending to transmit on a
call.  It's intended to be used for setting the reply size as the request
size should be set when the call is begun.  tx_total_len may not be less
than zero.
”h]”(hÊ)”}”(hŒ,Set the total transmit data size on a call::”h]”hŒ+Set the total transmit data size on a call:”…””}”(hjô  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mÿhjð  ubj  )”}”(hŒ void rxrpc_kernel_set_tx_length(struct socket *sock,
                                struct rxrpc_call *call,
                                s64 tx_total_len);”h]”hŒ void rxrpc_kernel_set_tx_length(struct socket *sock,
                                struct rxrpc_call *call,
                                s64 tx_total_len);”…””}”hj   sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h Mhjð  ubhÊ)”}”(hŒèThis sets the amount of data that the caller is intending to transmit on a
call.  It's intended to be used for setting the reply size as the request
size should be set when the call is begun.  tx_total_len may not be less
than zero.”h]”hŒêThis sets the amount of data that the caller is intending to transmit on a
call.  Itâ€™s intended to be used for setting the reply size as the request
size should be set when the call is begun.  tx_total_len may not be less
than zero.”…””}”(hj   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhjð  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hŒ²Get call RTT::

   u64 rxrpc_kernel_get_rtt(struct socket *sock, struct rxrpc_call *call);

Get the RTT time to the peer in use by a call.  The value returned is in
nanoseconds.
”h]”(hÊ)”}”(hŒGet call RTT::”h]”hŒGet call RTT:”…””}”(hj(   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M
hj$   ubj  )”}”(hŒGu64 rxrpc_kernel_get_rtt(struct socket *sock, struct rxrpc_call *call);”h]”hŒGu64 rxrpc_kernel_get_rtt(struct socket *sock, struct rxrpc_call *call);”…””}”hj6   sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h Mhj$   ubhÊ)”}”(hŒUGet the RTT time to the peer in use by a call.  The value returned is in
nanoseconds.”h]”hŒUGet the RTT time to the peer in use by a call.  The value returned is in
nanoseconds.”…””}”(hjD   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj$   ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hXt  Check call still alive::

   bool rxrpc_kernel_check_life(struct socket *sock,
                                struct rxrpc_call *call,
                                u32 *_life);
   void rxrpc_kernel_probe_life(struct socket *sock,
                                struct rxrpc_call *call);

The first function passes back in ``*_life`` a number that is updated when
ACKs are received from the peer (notably including PING RESPONSE ACKs
which we can elicit by sending PING ACKs to see if the call still exists
on the server).  The caller should compare the numbers of two calls to see
if the call is still alive after waiting for a suitable interval.  It also
returns true as long as the call hasn't yet reached the completed state.

This allows the caller to work out if the server is still contactable and
if the call is still alive on the server while waiting for the server to
process a client operation.

The second function causes a ping ACK to be transmitted to try to provoke
the peer into responding, which would then cause the value returned by the
first function to change.  Note that this must be called in TASK_RUNNING
state.
”h]”(hÊ)”}”(hŒCheck call still alive::”h]”hŒCheck call still alive:”…””}”(hj\   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MhjX   ubj  )”}”(hŒúbool rxrpc_kernel_check_life(struct socket *sock,
                             struct rxrpc_call *call,
                             u32 *_life);
void rxrpc_kernel_probe_life(struct socket *sock,
                             struct rxrpc_call *call);”h]”hŒúbool rxrpc_kernel_check_life(struct socket *sock,
                             struct rxrpc_call *call,
                             u32 *_life);
void rxrpc_kernel_probe_life(struct socket *sock,
                             struct rxrpc_call *call);”…””}”hjj   sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h MhjX   ubhÊ)”}”(hX¸  The first function passes back in ``*_life`` a number that is updated when
ACKs are received from the peer (notably including PING RESPONSE ACKs
which we can elicit by sending PING ACKs to see if the call still exists
on the server).  The caller should compare the numbers of two calls to see
if the call is still alive after waiting for a suitable interval.  It also
returns true as long as the call hasn't yet reached the completed state.”h]”(hŒ"The first function passes back in ”…””}”(hjx   hžhhŸNh NubhŒliteral”“”)”}”(hŒ
``*_life``”h]”hŒ*_life”…””}”(hj‚   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j€   hjx   ubhXŽ   a number that is updated when
ACKs are received from the peer (notably including PING RESPONSE ACKs
which we can elicit by sending PING ACKs to see if the call still exists
on the server).  The caller should compare the numbers of two calls to see
if the call is still alive after waiting for a suitable interval.  It also
returns true as long as the call hasnâ€™t yet reached the completed state.”…””}”(hjx   hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MhjX   ubhÊ)”}”(hŒ®This allows the caller to work out if the server is still contactable and
if the call is still alive on the server while waiting for the server to
process a client operation.”h]”hŒ®This allows the caller to work out if the server is still contactable and
if the call is still alive on the server while waiting for the server to
process a client operation.”…””}”(hjš   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M hjX   ubhÊ)”}”(hŒäThe second function causes a ping ACK to be transmitted to try to provoke
the peer into responding, which would then cause the value returned by the
first function to change.  Note that this must be called in TASK_RUNNING
state.”h]”hŒäThe second function causes a ping ACK to be transmitted to try to provoke
the peer into responding, which would then cause the value returned by the
first function to change.  Note that this must be called in TASK_RUNNING
state.”…””}”(hj¨   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M$hjX   ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hX,  Get remote client epoch::

   u32 rxrpc_kernel_get_epoch(struct socket *sock,
                              struct rxrpc_call *call)

This allows the epoch that's contained in packets of an incoming client
call to be queried.  This value is returned.  The function always
successful if the call is still in progress.  It shouldn't be called once
the call has expired.  Note that calling this on a local client call only
returns the local epoch.

This value can be used to determine if the remote client has been
restarted as it shouldn't change otherwise.
”h]”(hÊ)”}”(hŒGet remote client epoch::”h]”hŒGet remote client epoch:”…””}”(hjÀ   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M)hj¼   ubj  )”}”(hŒcu32 rxrpc_kernel_get_epoch(struct socket *sock,
                           struct rxrpc_call *call)”h]”hŒcu32 rxrpc_kernel_get_epoch(struct socket *sock,
                           struct rxrpc_call *call)”…””}”hjÎ   sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h M+hj¼   ubhÊ)”}”(hX6  This allows the epoch that's contained in packets of an incoming client
call to be queried.  This value is returned.  The function always
successful if the call is still in progress.  It shouldn't be called once
the call has expired.  Note that calling this on a local client call only
returns the local epoch.”h]”hX:  This allows the epoch thatâ€™s contained in packets of an incoming client
call to be queried.  This value is returned.  The function always
successful if the call is still in progress.  It shouldnâ€™t be called once
the call has expired.  Note that calling this on a local client call only
returns the local epoch.”…””}”(hjÜ   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M.hj¼   ubhÊ)”}”(hŒmThis value can be used to determine if the remote client has been
restarted as it shouldn't change otherwise.”h]”hŒoThis value can be used to determine if the remote client has been
restarted as it shouldnâ€™t change otherwise.”…””}”(hjê   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M4hj¼   ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hX“  Set the maximum lifespan on a call::

   void rxrpc_kernel_set_max_life(struct socket *sock,
                                  struct rxrpc_call *call,
                                  unsigned long hard_timeout)

This sets the maximum lifespan on a call to hard_timeout (which is in
jiffies).  In the event of the timeout occurring, the call will be
aborted and -ETIME or -ETIMEDOUT will be returned.
”h]”(hÊ)”}”(hŒ$Set the maximum lifespan on a call::”h]”hŒ#Set the maximum lifespan on a call:”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M7hjþ   ubj  )”}”(hŒ¦void rxrpc_kernel_set_max_life(struct socket *sock,
                               struct rxrpc_call *call,
                               unsigned long hard_timeout)”h]”hŒ¦void rxrpc_kernel_set_max_life(struct socket *sock,
                               struct rxrpc_call *call,
                               unsigned long hard_timeout)”…””}”hj!  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h M9hjþ   ubhÊ)”}”(hŒ»This sets the maximum lifespan on a call to hard_timeout (which is in
jiffies).  In the event of the timeout occurring, the call will be
aborted and -ETIME or -ETIMEDOUT will be returned.”h]”hŒ»This sets the maximum lifespan on a call to hard_timeout (which is in
jiffies).  In the event of the timeout occurring, the call will be
aborted and -ETIME or -ETIMEDOUT will be returned.”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M=hjþ   ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubhó)”}”(hX  Apply the RXRPC_MIN_SECURITY_LEVEL sockopt to a socket from within in the
kernel::

  int rxrpc_sock_set_min_security_level(struct sock *sk,
                                        unsigned int val);

This specifies the minimum security level required for calls on this
socket.

”h]”(hÊ)”}”(hŒRApply the RXRPC_MIN_SECURITY_LEVEL sockopt to a socket from within in the
kernel::”h]”hŒQApply the RXRPC_MIN_SECURITY_LEVEL sockopt to a socket from within in the
kernel:”…””}”(hj6!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MAhj2!  ubj  )”}”(hŒoint rxrpc_sock_set_min_security_level(struct sock *sk,
                                      unsigned int val);”h]”hŒoint rxrpc_sock_set_min_security_level(struct sock *sk,
                                      unsigned int val);”…””}”hjD!  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j  hŸh³h MDhj2!  ubhÊ)”}”(hŒLThis specifies the minimum security level required for calls on this
socket.”h]”hŒLThis specifies the minimum security level required for calls on this
socket.”…””}”(hjR!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MGhj2!  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhjä  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhjà  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h M hj2  hžhubeh}”(h]”Œaf-rxrpc-kernel-interface”ah ]”h"]”Œaf_rxrpc kernel interface”ah$]”h&]”uh1h´hj  hžhhŸh³h Mubhµ)”}”(hhh]”(hº)”}”(hŒConfigurable Parameters”h]”hŒConfigurable Parameters”…””}”(hj}!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjz!  hžhhŸh³h MLubhÊ)”}”(hŒ{The RxRPC protocol driver has a number of configurable parameters that can be
adjusted through sysctls in /proc/net/rxrpc/:”h]”hŒ{The RxRPC protocol driver has a number of configurable parameters that can be
adjusted through sysctls in /proc/net/rxrpc/:”…””}”(hj‹!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MNhjz!  hžhubhè)”}”(hXj
  (#) req_ack_delay

    The amount of time in milliseconds after receiving a packet with the
    request-ack flag set before we honour the flag and actually send the
    requested ack.

    Usually the other side won't stop sending packets until the advertised
    reception window is full (to a maximum of 255 packets), so delaying the
    ACK permits several packets to be ACK'd in one go.

(#) soft_ack_delay

    The amount of time in milliseconds after receiving a new packet before we
    generate a soft-ACK to tell the sender that it doesn't need to resend.

(#) idle_ack_delay

    The amount of time in milliseconds after all the packets currently in the
    received queue have been consumed before we generate a hard-ACK to tell
    the sender it can free its buffers, assuming no other reason occurs that
    we would send an ACK.

(#) resend_timeout

    The amount of time in milliseconds after transmitting a packet before we
    transmit it again, assuming no ACK is received from the receiver telling
    us they got it.

(#) max_call_lifetime

    The maximum amount of time in seconds that a call may be in progress
    before we preemptively kill it.

(#) dead_call_expiry

    The amount of time in seconds before we remove a dead call from the call
    list.  Dead calls are kept around for a little while for the purpose of
    repeating ACK and ABORT packets.

(#) connection_expiry

    The amount of time in seconds after a connection was last used before we
    remove it from the connection list.  While a connection is in existence,
    it serves as a placeholder for negotiated security; when it is deleted,
    the security must be renegotiated.

(#) transport_expiry

    The amount of time in seconds after a transport was last used before we
    remove it from the transport list.  While a transport is in existence, it
    serves to anchor the peer data and keeps the connection ID counter.

(#) rxrpc_rx_window_size

    The size of the receive window in packets.  This is the maximum number of
    unconsumed received packets we're willing to hold in memory for any
    particular call.

(#) rxrpc_rx_mtu

    The maximum packet MTU size that we're willing to receive in bytes.  This
    indicates to the peer whether we're willing to accept jumbo packets.

(#) rxrpc_rx_jumbo_max

    The maximum number of packets that we're willing to accept in a jumbo
    packet.  Non-terminal packets in a jumbo packet must contain a four byte
    header plus exactly 1412 bytes of data.  The terminal packet must contain
    a four byte header plus any amount of data.  In any event, a jumbo packet
    may not exceed rxrpc_rx_mtu in size.”h]”hî)”}”(hhh]”(hó)”}”(hXk  req_ack_delay

The amount of time in milliseconds after receiving a packet with the
request-ack flag set before we honour the flag and actually send the
requested ack.

Usually the other side won't stop sending packets until the advertised
reception window is full (to a maximum of 255 packets), so delaying the
ACK permits several packets to be ACK'd in one go.
”h]”(hÊ)”}”(hŒreq_ack_delay”h]”hŒreq_ack_delay”…””}”(hj¤!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MQhj !  ubhÊ)”}”(hŒ˜The amount of time in milliseconds after receiving a packet with the
request-ack flag set before we honour the flag and actually send the
requested ack.”h]”hŒ˜The amount of time in milliseconds after receiving a packet with the
request-ack flag set before we honour the flag and actually send the
requested ack.”…””}”(hj²!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MShj !  ubhÊ)”}”(hŒÁUsually the other side won't stop sending packets until the advertised
reception window is full (to a maximum of 255 packets), so delaying the
ACK permits several packets to be ACK'd in one go.”h]”hŒÅUsually the other side wonâ€™t stop sending packets until the advertised
reception window is full (to a maximum of 255 packets), so delaying the
ACK permits several packets to be ACKâ€™d in one go.”…””}”(hjÀ!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MWhj !  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj!  ubhó)”}”(hŒ¡soft_ack_delay

The amount of time in milliseconds after receiving a new packet before we
generate a soft-ACK to tell the sender that it doesn't need to resend.
”h]”(hÊ)”}”(hŒsoft_ack_delay”h]”hŒsoft_ack_delay”…””}”(hjØ!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M[hjÔ!  ubhÊ)”}”(hŒThe amount of time in milliseconds after receiving a new packet before we
generate a soft-ACK to tell the sender that it doesn't need to resend.”h]”hŒ’The amount of time in milliseconds after receiving a new packet before we
generate a soft-ACK to tell the sender that it doesnâ€™t need to resend.”…””}”(hjæ!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M]hjÔ!  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj!  ubhó)”}”(hX  idle_ack_delay

The amount of time in milliseconds after all the packets currently in the
received queue have been consumed before we generate a hard-ACK to tell
the sender it can free its buffers, assuming no other reason occurs that
we would send an ACK.
”h]”(hÊ)”}”(hŒidle_ack_delay”h]”hŒidle_ack_delay”…””}”(hjþ!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M`hjú!  ubhÊ)”}”(hŒðThe amount of time in milliseconds after all the packets currently in the
received queue have been consumed before we generate a hard-ACK to tell
the sender it can free its buffers, assuming no other reason occurs that
we would send an ACK.”h]”hŒðThe amount of time in milliseconds after all the packets currently in the
received queue have been consumed before we generate a hard-ACK to tell
the sender it can free its buffers, assuming no other reason occurs that
we would send an ACK.”…””}”(hj"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mbhjú!  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj!  ubhó)”}”(hŒ²resend_timeout

The amount of time in milliseconds after transmitting a packet before we
transmit it again, assuming no ACK is received from the receiver telling
us they got it.
”h]”(hÊ)”}”(hŒresend_timeout”h]”hŒresend_timeout”…””}”(hj$"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mghj "  ubhÊ)”}”(hŒ¡The amount of time in milliseconds after transmitting a packet before we
transmit it again, assuming no ACK is received from the receiver telling
us they got it.”h]”hŒ¡The amount of time in milliseconds after transmitting a packet before we
transmit it again, assuming no ACK is received from the receiver telling
us they got it.”…””}”(hj2"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mihj "  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj!  ubhó)”}”(hŒxmax_call_lifetime

The maximum amount of time in seconds that a call may be in progress
before we preemptively kill it.
”h]”(hÊ)”}”(hŒmax_call_lifetime”h]”hŒmax_call_lifetime”…””}”(hjJ"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MmhjF"  ubhÊ)”}”(hŒdThe maximum amount of time in seconds that a call may be in progress
before we preemptively kill it.”h]”hŒdThe maximum amount of time in seconds that a call may be in progress
before we preemptively kill it.”…””}”(hjX"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MohjF"  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj!  ubhó)”}”(hŒÄdead_call_expiry

The amount of time in seconds before we remove a dead call from the call
list.  Dead calls are kept around for a little while for the purpose of
repeating ACK and ABORT packets.
”h]”(hÊ)”}”(hŒdead_call_expiry”h]”hŒdead_call_expiry”…””}”(hjp"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mrhjl"  ubhÊ)”}”(hŒ±The amount of time in seconds before we remove a dead call from the call
list.  Dead calls are kept around for a little while for the purpose of
repeating ACK and ABORT packets.”h]”hŒ±The amount of time in seconds before we remove a dead call from the call
list.  Dead calls are kept around for a little while for the purpose of
repeating ACK and ABORT packets.”…””}”(hj~"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mthjl"  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj!  ubhó)”}”(hX  connection_expiry

The amount of time in seconds after a connection was last used before we
remove it from the connection list.  While a connection is in existence,
it serves as a placeholder for negotiated security; when it is deleted,
the security must be renegotiated.
”h]”(hÊ)”}”(hŒconnection_expiry”h]”hŒconnection_expiry”…””}”(hj–"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mxhj’"  ubhÊ)”}”(hŒüThe amount of time in seconds after a connection was last used before we
remove it from the connection list.  While a connection is in existence,
it serves as a placeholder for negotiated security; when it is deleted,
the security must be renegotiated.”h]”hŒüThe amount of time in seconds after a connection was last used before we
remove it from the connection list.  While a connection is in existence,
it serves as a placeholder for negotiated security; when it is deleted,
the security must be renegotiated.”…””}”(hj¤"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mzhj’"  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj!  ubhó)”}”(hŒètransport_expiry

The amount of time in seconds after a transport was last used before we
remove it from the transport list.  While a transport is in existence, it
serves to anchor the peer data and keeps the connection ID counter.
”h]”(hÊ)”}”(hŒtransport_expiry”h]”hŒtransport_expiry”…””}”(hj¼"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj¸"  ubhÊ)”}”(hŒÕThe amount of time in seconds after a transport was last used before we
remove it from the transport list.  While a transport is in existence, it
serves to anchor the peer data and keeps the connection ID counter.”h]”hŒÕThe amount of time in seconds after a transport was last used before we
remove it from the transport list.  While a transport is in existence, it
serves to anchor the peer data and keeps the connection ID counter.”…””}”(hjÊ"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj¸"  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj!  ubhó)”}”(hŒµrxrpc_rx_window_size

The size of the receive window in packets.  This is the maximum number of
unconsumed received packets we're willing to hold in memory for any
particular call.
”h]”(hÊ)”}”(hŒrxrpc_rx_window_size”h]”hŒrxrpc_rx_window_size”…””}”(hjâ"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M…hjÞ"  ubhÊ)”}”(hŒžThe size of the receive window in packets.  This is the maximum number of
unconsumed received packets we're willing to hold in memory for any
particular call.”h]”hŒ The size of the receive window in packets.  This is the maximum number of
unconsumed received packets weâ€™re willing to hold in memory for any
particular call.”…””}”(hjð"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M‡hjÞ"  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj!  ubhó)”}”(hŒrxrpc_rx_mtu

The maximum packet MTU size that we're willing to receive in bytes.  This
indicates to the peer whether we're willing to accept jumbo packets.
”h]”(hÊ)”}”(hŒrxrpc_rx_mtu”h]”hŒrxrpc_rx_mtu”…””}”(hj#  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M‹hj#  ubhÊ)”}”(hŒŽThe maximum packet MTU size that we're willing to receive in bytes.  This
indicates to the peer whether we're willing to accept jumbo packets.”h]”hŒ’The maximum packet MTU size that weâ€™re willing to receive in bytes.  This
indicates to the peer whether weâ€™re willing to accept jumbo packets.”…””}”(hj#  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj#  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj!  ubhó)”}”(hX[  rxrpc_rx_jumbo_max

The maximum number of packets that we're willing to accept in a jumbo
packet.  Non-terminal packets in a jumbo packet must contain a four byte
header plus exactly 1412 bytes of data.  The terminal packet must contain
a four byte header plus any amount of data.  In any event, a jumbo packet
may not exceed rxrpc_rx_mtu in size.”h]”(hÊ)”}”(hŒrxrpc_rx_jumbo_max”h]”hŒrxrpc_rx_jumbo_max”…””}”(hj.#  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj*#  ubhÊ)”}”(hXG  The maximum number of packets that we're willing to accept in a jumbo
packet.  Non-terminal packets in a jumbo packet must contain a four byte
header plus exactly 1412 bytes of data.  The terminal packet must contain
a four byte header plus any amount of data.  In any event, a jumbo packet
may not exceed rxrpc_rx_mtu in size.”h]”hXI  The maximum number of packets that weâ€™re willing to accept in a jumbo
packet.  Non-terminal packets in a jumbo packet must contain a four byte
header plus exactly 1412 bytes of data.  The terminal packet must contain
a four byte header plus any amount of data.  In any event, a jumbo packet
may not exceed rxrpc_rx_mtu in size.”…””}”(hj<#  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M’hj*#  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hòhj!  ubeh}”(h]”h ]”h"]”h$]”h&]”jê  jë  jì  jí  jî  jï  uh1híhj™!  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhŸh³h MQhjz!  hžhubeh}”(h]”Œconfigurable-parameters”ah ]”h"]”Œconfigurable parameters”ah$]”h&]”uh1h´hj  hžhhŸh³h MLubeh}”(h]”Œexample-client-usage”ah ]”h"]”Œexample client usage”ah$]”h&]”uh1h´hhhžhhŸh³h M!ubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h³uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¹NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”jÆ	  Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jŽ#  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h³Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(j›  j˜  j  j  jÈ  jÅ  j^	  j[	  j“  j  jB  j?  j  j
  ji#  jf#  j/  j,  jw!  jt!  ja#  j^#  uŒ	nametypes”}”(j›  ‰j  ‰jÈ  ‰j^	  ‰j“  ‰jB  ‰j  ‰ji#  ‰j/  ‰jw!  ‰ja#  ‰uh}”(j˜  h¶j  jö  jÅ  j  j[	  jË  j  ja	  j?  jž  j
  jE  jf#  j  j,  j  jt!  j2  j^#  jz!  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”(hŒsystem_message”“”)”}”(hhh]”hÊ)”}”(hŒ:Enumerated list start value not ordinal-1: "2" (ordinal 2)”h]”hŒ>Enumerated list start value not ordinal-1: â€œ2â€ (ordinal 2)”…””}”(hjõ#  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhjò#  ubah}”(h]”h ]”h"]”h$]”h&]”Œlevel”KŒtype”ŒINFO”Œsource”h³Œline”Kuh1jð#  hjd  ubjñ#  )”}”(hhh]”hÊ)”}”(hŒ<Enumerated list start value not ordinal-1: "10" (ordinal 10)”h]”hŒ@Enumerated list start value not ordinal-1: â€œ10â€ (ordinal 10)”…””}”(hj$  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhj$  ubah}”(h]”h ]”h"]”h$]”h&]”Œlevel”KŒtype”j$  Œsource”h³Œline”M!uh1jð#  hj  hžhhŸh³h MçubeŒtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.