RxRPC 네트워크 프로토콜

RxRPC 문서의 범위

RxRPC는 UDP 위에 구현한 2단계 비대칭 원격 프로시저 호출 프로토콜입니다. Linux의 AF_RXRPC 주소 패밀리는 커널과 사용자 공간 모두에 RxRPC 소켓을 제공하며, 일반적인 소켓 호출인 `sendmsg()`와 `recvmsg()`를 사용합니다. 데이터, 중단 코드, 네트워크 오류 및 프로토콜 상태는 제어 메시지로 함께 전달됩니다.

이 문서는 프로토콜 자체의 요약에서 시작해 AF_RXRPC 드라이버 모델, 제어 메시지와 소켓 옵션, 보안 키, 클라이언트와 서버 사용 절차, 커널 내부 API, 조정 가능한 매개변수 및 함수 참조를 차례로 설명합니다. 각 API 이름, 상수, 구조체 및 source path는 구현과 대조할 수 있도록 원문 표기를 유지합니다.

.. SPDX-License-Identifier: GPL-2.0

======================
RxRPC Network Protocol
======================

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.

Contents of this document:

 (#) 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.

계층 구조와 통신 모델

RxRPC는 두 계층으로 나뉩니다. 세션 계층은 IPv4 또는 IPv6 UDP 위에 신뢰할 수 있는 가상 연결을 만들고, 표현 계층은 SunRPC와 비슷하게 XDR 형식의 데이터 블롭을 전달합니다. Linux의 AF_RXRPC는 이 가운데 세션 계층만 구현합니다. 호출자는 XDR 인코딩과 디코딩을 직접 담당하며 커널은 전송되는 바이트열의 의미를 해석하지 않습니다.

한 호출은 클라이언트가 요청을 보내고 서버가 응답을 반환하는 두 단계로 이루어집니다. 실제 UDP 전송 경로는 여러 호출에서 재사용될 수 있고, 키 보존 서비스를 통해 보안 계층을 붙일 수 있습니다. 요청의 첫 4바이트에는 보통 연산 ID가 들어가지만, 이것은 응용 프로그램 규약이며 커널 세션 계층의 관심 대상은 아닙니다.

AF_RXRPC 소켓은 `SOCK_DGRAM` 형식입니다. RxRPC가 사용하는 하위 전송 프로토콜은 현재 `PF_INET`이며, AFS가 대표적인 사용자입니다. AFS 파일 서버, 볼륨 위치 서비스 등은 같은 전송 모델 위에서 서로 다른 서비스 ID와 응용 프로토콜을 사용합니다.

Overview
========

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)::

                +-------------+
                | Application |
                +-------------+
                |     XDR     |                Presentation
                +-------------+
                |    RxRPC    |                Session
                +-------------+
                |     UDP     |                Transport
                +-------------+


AF_RXRPC provides:

 (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.

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.


Sockets of AF_RXRPC family are:

 (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.


The Andrew File System (AFS) is an example of an application that uses this and
that has both kernel (filesystem) and userspace (utility) components.

연결, 호출, ACK와 완료 조건

RxRPC는 UDP만 사용하며, 로컬과 원격의 UDP 포트가 통신 끝점을 이룹니다. 하나의 끝점 쌍 사이에는 여러 가상 연결을 만들 수 있고, 각 연결은 하나의 서비스만 대상으로 합니다. 하나의 UDP 끝점이 여러 서비스를 제공할 수도 있으며, 방향 표시는 같은 끝점이 클라이언트와 서버 역할을 동시에 수행할 수 있게 합니다.

가상 연결은 로컬 주소와 포트, 원격 주소와 포트, 방향, 연결 ID, 서비스 ID라는 일곱 값으로 식별됩니다. 연결 하나에는 최대 약 40억 개의 호출 번호가 있고 최대 네 호출을 동시에 진행할 수 있습니다. 호출은 클라이언트 요청 단계와 서버 응답 단계로 나뉘며, 각 단계의 데이터는 길이가 정해지지 않은 블롭입니다. 마지막 패킷의 플래그가 단계 종료를 표시하고 시퀀스 번호가 순환하므로 한 단계는 40억 패킷 미만이어야 합니다.

보안은 연결 단위로 협상합니다. 첫 DATA 패킷이 보안 연결을 시작하면 서버가 challenge를 보내고 클라이언트가 response로 답합니다. 협상 결과는 연결 수명 동안 유지되지만 서버가 상태를 잊었다면 다시 협상합니다. 요청의 첫 4바이트에 들어가는 연산 ID는 서버가 어떤 작업을 수행할지 선택하는 응용 계층 값입니다.

신뢰성은 ACK로 보장합니다. hard ACK는 패킷을 수신하고 처리까지 마쳤음을 뜻하므로 송신자가 보관 사본을 버릴 수 있습니다. soft ACK는 현재 수신했지만 아직 버리고 다시 요청할 수 있다는 뜻입니다. 따라서 송신자는 hard ACK를 받을 때까지 각 패킷을 보관합니다. 응답의 첫 DATA 패킷은 전체 요청에 대한 암시적 hard ACK로도 작동합니다.

호출이 정상 완료되려면 클라이언트가 요청을 모두 보내고, 응답을 모두 받으며, 응답의 최종 hard ACK가 서버에 도착해야 합니다. 이 완료 지점 전에는 어느 쪽도 호출을 중단할 수 있으며, 중단 코드는 상대에게 전달됩니다.

RxRPC Protocol Summary
======================

An overview of the RxRPC protocol:

 (#) 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.

AF_RXRPC 드라이버 모델과 호출 큐

AF_RXRPC 드라이버는 내부 UDP 소켓을 전송 끝점으로 사용하고, AF_RXRPC 소켓을 연결 묶음에 대응시킵니다. 응용 프로그램은 실제 연결 선택을 보지 않습니다. 클라이언트 소켓 하나로 같은 서비스에 여러 호출을 보낼 수 있고, 서버 소켓 하나로 여러 클라이언트의 호출을 받을 수 있습니다. 드라이버는 필요하면 조정 가능한 상한까지 병렬 연결을 만들고, 호출 종료 뒤에도 연결과 UDP 소켓을 일정 시간 보존해 재사용합니다.

같은 키와 보안 수준을 쓰는 클라이언트 호출은 연결을 공유할 수 있으며 보안을 쓰지 않는 호출도 공유할 수 있습니다. 서버 측 연결은 클라이언트가 공유 가능한 형태로 만들었을 때 공유됩니다. ACK와 ping은 자동으로 처리됩니다. `SO_KEEPALIVE` 지원은 문서상 아직 TODO입니다. ICMP 오류가 들어오면 영향을 받은 호출은 중단되고 `recvmsg()`를 통해 네트워크 오류가 보고됩니다.

0이 아닌 서비스 ID로 `bind()`한 소켓은 서버가 됩니다. 클라이언트는 하나 이상의 `sendmsg()`로 요청을 보내고 하나 이상의 `recvmsg()`로 응답을 받습니다. 첫 `sendmsg()`에는 응용 프로그램이 선택한 user call ID 태그를 붙여야 하며, 이후 모든 제어 정보가 이 태그와 연결됩니다. `connect()`는 기본 목적지를 정하고, 첫 송신의 `msg_name`으로 호출별 목적지를 바꿀 수도 있습니다. 아직 바인드하지 않은 소켓을 연결하면 임의 로컬 포트가 자동 선택됩니다.

서버 소켓도 첫 `sendmsg()`에 대상 주소를 주면 클라이언트 호출을 만들 수 있습니다. 태그는 호출의 terminal 메시지를 받은 뒤 다시 사용할 수 있습니다. 클라이언트는 요청 송신 뒤 응답을 받고, 서버는 요청 수신 뒤 응답을 보내고 마지막 ACK를 받습니다. 송수신 중 `MSG_MORE`는 현재 단계가 계속된다는 뜻이고 `MSG_EOR`은 terminal 이벤트를 표시합니다.

호출을 중단하는 제어 메시지는 해당 태그의 호출을 끝내고 큐에 남은 메시지를 버립니다. 원격 abort, server busy, challenge 및 각종 오류는 `recvmsg()`의 제어 데이터로 전달되며 abort와 busy는 terminal입니다. 서버에는 새 호출을 알리는 `RXRPC_NEW_CALL`이 먼저 도착합니다. 서버는 `RXRPC_ACCEPT`와 새 태그를 `sendmsg()`로 보내 호출을 수락하고, 그 뒤 요청 DATA가 일반 수신 큐에 제공됩니다.

보안 서버는 secret keyring으로 challenge/response를 처리하고, 클라이언트는 소켓 옵션으로 보안 키 이름을 지정합니다. `sendmsg(MSG_WAITALL)`은 상대가 적어도 2 RTT마다 한 패킷씩 진행하는 동안 신호를 무시하고 계속 기다립니다. 진전 없이 중단되면 아무 바이트도 소비하지 않은 경우 `-EINTR` 또는 `-ERESTARTSYS`, 일부를 소비한 경우 소비한 바이트 수를 반환합니다.

`recvmsg()`는 같은 호출의 데이터를 단계 끝, 비데이터 메시지, 다른 호출, 사용자 버퍼 포화 가운데 하나가 나타날 때까지 처리합니다. `MSG_PEEK`는 데이터가 하나라도 있으면 반환합니다. 메시지 일부만 복사했다면 나머지는 큐 앞으로 되돌리며 `MSG_TRUNC`는 사용하지 않습니다. 현재 단계에 데이터가 더 있으면 `MSG_MORE`가 반환됩니다.

AF_RXRPC Driver Model
=====================

About the AF_RXRPC driver:

 (#) 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().


Interaction with the user of the RxRPC socket:

 (#) 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.


Notes on sendmsg:

 (#) 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.


Notes on recvmsg:

 (#) 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.

제어 메시지

RxRPC 제어 메시지는 `SOL_RXRPC` 레벨에서 사용합니다. 문서 표의 S, R, T는 각각 `sendmsg()`에서 사용 가능, `recvmsg()`로 전달, terminal 이벤트를 뜻합니다. `RXRPC_USER_CALL_ID`는 첫 클라이언트 DATA 또는 서버의 `RXRPC_ACCEPT`에 넣는 `unsigned long` 응용 태그입니다. `RXRPC_NEW_CALL`을 제외한 수신 메시지에는 이 태그가 함께 제공됩니다.

`RXRPC_ABORT`는 로컬에서 abort 코드를 보내거나 원격 abort 코드를 받을 때 사용합니다. 송신에는 call ID가 필요하며 일치하는 호출이 없으면 `EBADSLT`입니다. `RXRPC_ACK`는 서버가 최종 ACK를 받았음을 알리는 terminal 메시지입니다. `RXRPC_NET_ERROR`, `RXRPC_BUSY`, `RXRPC_LOCAL_ERROR`는 각각 ICMP에서 유도한 errno, 서버의 busy 거절, 로컬 오류를 call ID와 함께 전달하며 모두 terminal입니다.

`RXRPC_NEW_CALL`은 서버 큐에 수락할 새 호출이 있음을 알리지만 call ID를 포함하지 않습니다. 서버는 데이터 없는 `sendmsg()`에 `RXRPC_ACCEPT`와 새 `RXRPC_USER_CALL_ID`를 넣어 가장 오래된 미수락 호출을 수락합니다. 호출이 없으면 `ENODATA`, 이미 사용 중인 ID면 `EBADSLT`입니다.

`RXRPC_EXCLUSIVE_CALL`은 호출 전용 일회성 연결을 요구하며 완료 뒤 연결을 폐기합니다. `RXRPC_UPGRADE_SERVICE`는 더 높은 서비스 ID를 탐색합니다. 응답의 `msg_name`에 있는 `srx_service`를 검사해 실제 선택을 확인해야 하며, 연산 ID와 인수는 두 서비스에서 같아야 합니다. 결과는 캐시되므로 성공한 목적지에 이후 호출을 보낼 때 upgrade 플래그를 중단할 수 있습니다.

`RXRPC_TX_LENGTH`는 첫 DATA 송신에서 전체 Tx 길이를 `__s64` 0 이상 값으로 알립니다. 커널은 이 정보를 이용해 사용자 공간에서 패킷으로 직접 암호화하여 복사를 피할 수 있습니다. 실제 길이가 선언과 다르면 `EMSGSIZE`가 발생합니다. `RXRPC__SUPPORTED`는 가장 큰 제어 메시지 번호보다 하나 큰 값이며 `RXRPC_SUPPORTED_CMSG` 소켓 옵션으로 구현 범위를 조회할 때 사용합니다.

Control Messages
================

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:

        =======================        === ===========        ===============================
        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.

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).

SOL_RXRPC 소켓 옵션

`RXRPC_SECURITY_KEY`는 클라이언트 보안 키의 설명 문자열을 지정합니다. 커널은 프로세스 keyring들에서 `rxrpc` 형식 키를 `request_key()`로 찾으며 `optlen`에는 문자열 끝 NUL을 포함하지 않습니다. `RXRPC_SECURITY_KEYRING`은 서버가 보안 키를 찾을 keyring의 설명을 지정합니다.

`RXRPC_EXCLUSIVE_CONNECTION`을 NULL, 길이 0으로 설정하면 이후 호출마다 새 연결을 사용합니다. `RXRPC_MIN_SECURITY_LEVEL`은 정수로 최소 보안 수준을 정합니다. `RXRPC_SECURITY_PLAIN`은 암호화된 checksum만 사용합니다. `RXRPC_SECURITY_AUTH`는 checksum에 더해 패킷을 패딩하고 실제 길이를 포함한 첫 8바이트를 암호화합니다. `RXRPC_SECURITY_ENCRYPT`는 실제 길이를 포함한 패킷 전체를 패딩하고 암호화합니다.

`RXRPC_UPGRADEABLE_SERVICE`는 원래 서비스와 업그레이드할 서비스 ID 두 개를 `unsigned short` 배열로 전달합니다. `RXRPC_SUPPORTED_CMSG`는 읽기 전용이며 구현이 지원하는 가장 높은 제어 메시지 형식을 반환합니다.

Socket Options
==============

AF_RXRPC sockets support a few socket options at the SOL_RXRPC level:

 (#) 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.

rxkad 보안 키

현재 구현된 보안 형식은 Kerberos 4와 동등한 rxkad이며 보안 인덱스 2를 사용합니다. 구현은 `rxkad` 커널 모듈에 있습니다. 클라이언트 티켓은 AFS kaserver 또는 Kerberos 서버에서 얻고 `klog` 같은 도구가 이를 `rxrpc` 키로 설치합니다. 문서가 가리키는 OpenAFS `klog.c`는 사용자 공간 키 구성 예를 제공합니다.

클라이언트 키 payload는 `rxrpc_key_sec2_v1` 구조입니다. `security_index`는 2, `ticket_length`는 뒤따르는 티켓 길이, `expiry`는 만료 시각, `kvno`는 키 버전입니다. `session_key[8]`에는 DES 세션 키가 들어가고 실제 티켓 바이트는 가변 배열 `ticket[0]` 뒤에 연속해 붙습니다.

서버 키 형식은 `rxrpc_s`이며 설명은 `<serviceID>:<securityIndex>`입니다. 예를 들어 VL 서비스에서 rxkad를 쓰면 `52:2`입니다. 키 payload는 8바이트 secret이고 `add_key()`로 keyring에 추가합니다. 이 keyring을 `RXRPC_SECURITY_KEYRING`으로 서버 소켓에 연결하면 보안 호출이 들어올 때 적절한 키를 조회합니다. OpenAFS `listen.c`가 서버 설정 예를 보여 줍니다.

Security
========

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:

        http://people.redhat.com/~dhowells/rxrpc/klog.c

The payload provided to add_key() on the client should be of the following
form::

        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 */
        };

Where the ticket blob is just appended to the above structure.


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).

        add_key("rxrpc_s", "52:2", secret_key, 8, keyring);

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:

        http://people.redhat.com/~dhowells/rxrpc/listen.c

사용자 공간 클라이언트 절차

클라이언트는 `socket(AF_RXRPC, SOCK_DGRAM, PF_INET)`으로 소켓을 만듭니다. IPv6 사용 예는 문서상 TODO입니다. 필요하면 service ID 0인 `sockaddr_rxrpc`으로 `bind()`해 로컬 포트를 정합니다. AFS callback처럼 7000번 포트를 쓸 수 있고, 그렇지 않으면 임의의 비특권 포트가 선택됩니다. 여러 가상 연결이 같은 UDP 포트를 공유할 수 있으며 보안은 각 가상 연결에 적용됩니다.

보안이 필요하면 `request_key()`로 클라이언트 키를 얻고 `RXRPC_SECURITY_KEY` 소켓 옵션으로 선택합니다. 최소 수준은 `RXRPC_MIN_SECURITY_LEVEL`로 정하며 예에서는 `RXRPC_SECURITY_ENCRYPT`를 요구합니다. 이어서 `connect()`로 기본 목적지 주소, UDP 포트와 VL 같은 service ID를 설정합니다.

호출 요청은 여러 `sendmsg()`로 나눌 수 있습니다. 첫 메시지에는 `RXRPC_USER_CALL_ID`가 반드시 들어가며 마지막을 제외한 송신에는 `MSG_MORE`를 붙입니다. 전체 길이를 아는 경우 첫 메시지에 `RXRPC_TX_LENGTH`를 넣습니다. 연결된 기본 목적지와 다른 곳으로 보낼 때는 호출의 첫 `sendmsg()`에서 `msg_name`을 지정합니다.

응답은 `recvmsg()`로 받습니다. 같은 단계에 데이터가 더 있으면 `MSG_MORE`, 호출을 끝내는 메시지면 `MSG_EOR`이 반환됩니다. 제어 데이터의 `RXRPC_USER_CALL_ID`로 호출을 식별하고, `RXRPC_ABORT`, `RXRPC_NET_ERROR`, `RXRPC_LOCAL_ERROR`, `RXRPC_BUSY` 같은 terminal 결과도 함께 처리해야 합니다.

서비스 업그레이드를 요청하려면 첫 송신에 `RXRPC_UPGRADE_SERVICE`를 넣습니다. 응답 `msg_name`의 `srx_service`가 서버가 선택한 실제 서비스입니다. 같은 목적지에 다음 호출을 보내기 전에 첫 탐색 결과를 기다리면 캐시된 업그레이드 결과를 안전하게 사용할 수 있습니다.

Example Client Usage
====================

A client would issue an operation by:

 (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.

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).

사용자 공간 서버 절차

서버도 `socket(AF_RXRPC, SOCK_DGRAM, PF_INET)`으로 시작합니다. 보안을 쓰면 `keyctl()`로 `AFSkeys` 같은 keyring을 만들고, `rxrpc_s` 형식의 `52:2` 같은 서버 키를 `add_key()`로 넣은 뒤 `RXRPC_SECURITY_KEYRING` 옵션으로 소켓에 연결합니다. 서비스 중에도 keyring 내용을 바꿀 수 있어 키 교체가 가능합니다.

0이 아닌 service ID와 UDP 포트로 `bind()`하면 서버가 됩니다. 같은 전송 소켓에서 최대 두 service ID를 제공하려면 `bind()`를 두 번 호출합니다. 두 서비스 사이 업그레이드를 허용하려면 두 바인드 뒤에 `RXRPC_UPGRADEABLE_SERVICE`를 설정합니다. `listen(100)`은 대기 호출 backlog를 설정합니다.

새 호출은 데이터 없는 `recvmsg()`의 `RXRPC_NEW_CALL`로 알립니다. 이 알림의 주소는 실제 수락 시점까지 호출이 사라질 수 있으므로 의존하지 않습니다. 서버는 데이터 없는 `sendmsg()`에 `RXRPC_ACCEPT`와 새 `RXRPC_USER_CALL_ID`를 넣어 가장 오래된 호출을 수락합니다.

수락 뒤 요청 데이터는 `recvmsg()`로 읽으며 주소는 `msg_name`, 호출 태그는 제어 데이터, 이어지는 데이터 여부는 `MSG_MORE`로 확인합니다. 응답은 같은 call ID를 붙인 하나 이상의 `sendmsg()`로 보내고 마지막 전까지 `MSG_MORE`를 사용합니다. 최종 응답을 보낸 뒤 데이터 없는 `recvmsg()`에서 `RXRPC_ACK`, 해당 ID와 `MSG_EOR`을 받으면 호출이 완전히 끝납니다.

최종 응답 패킷을 보내기 전에는 데이터 없는 `sendmsg()`에 call ID와 4바이트 `RXRPC_ABORT` 코드를 넣어 호출을 중단할 수 있습니다. 중단 시 큐에 남아 있던 해당 호출 메시지는 폐기됩니다. 서버 소켓 하나에는 여러 호출의 DATA와 제어 메시지가 섞여 들어오므로 모든 메시지를 `RXRPC_USER_CALL_ID`로 다중화해야 합니다.

Example Server Usage
====================

A server would be set up to accept operations in the following manner:

 (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.

(10) 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.

(11) 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.

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.

커널 호출 생성과 송신

커널 인터페이스는 한 소켓에서 호출마다 다른 키를 쓰고, 커널 호출자가 직접 키를 요청하며, 메모리 할당용 `gfp_t`를 지정하고, `recvmsg()` 대신 skb를 가로채 처리할 수 있게 합니다. 기본 준비는 사용자 공간과 같이 AF_RXRPC 소켓을 열고 `bind()` 또는 `listen()`하는 것입니다.

`rxrpc_kernel_begin_call()`은 호출에 필요한 상태를 할당하고 실제 연결과 채널을 선택합니다. `srx`가 없으면 연결된 소켓의 목적지를 쓰고, 명시적 `key`는 소켓의 기본 키를 덮어쓰지만 같은 조건의 연결 공유는 계속 가능합니다. `user_call_ID`는 호출자가 선택한 포인터 태그입니다. `tx_total_len`이 -1이면 길이를 모르며 0 이상이면 전체 송신 길이를 선언해 직접 암호화 경로를 허용합니다.

`notify_rx` 콜백은 수신 이벤트를 알리고 `upgrade`는 서비스 업그레이드 탐색을 요청합니다. `intr`가 참이면 채널을 기다리는 동안 신호에 의해 `-ERESTARTSYS`로 중단될 수 있습니다. `debug_id`에는 `rxrpc_debug_id`에서 원자적으로 얻은 추적 번호를 넣습니다. 성공하면 불투명한 `struct rxrpc_call *` 참조를 반환하며 반드시 종료 또는 해제해야 합니다.

`rxrpc_kernel_shutdown_call()`은 call ID를 소켓에서 제거하고 호출을 종료합니다. `rxrpc_kernel_put_call()`은 보유한 참조를 놓습니다. 두 함수의 책임이 다르므로 호출 수명과 참조 수명을 각각 맞춰야 합니다.

`rxrpc_kernel_send_data()`는 커널 가상 주소 iov를 담은 `msghdr`에서 데이터를 보냅니다. 허용되는 플래그는 단계가 계속됨을 뜻하는 `MSG_MORE`뿐이며 목적지 주소나 제어 메시지는 받지 않습니다. 마지막 DATA를 보내기 전에 Tx 단계가 끝났음을 알리는 콜백이 spinlock을 잡은 상태에서 호출될 수 있으므로 콜백은 잠금 문맥에 맞아야 합니다.

AF_RXRPC Kernel Interface
=========================

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:

 (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.

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.

The kernel interface functions are as follows:

 (#) 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.

커널 수신, skb 가로채기와 생존 확인

`rxrpc_kernel_recv_data()`는 호출 응답을 `buf`로 복사하고 `offset`을 갱신합니다. 버퍼가 찼지만 더 받을 수 있으면 0과 `want_more=true`, 마지막 DATA까지 정확히 소비하면 1과 `want_more=false`, 지금 처리할 데이터가 없으면 `-EAGAIN`입니다. 마지막 패킷인데 요청한 크기를 채우지 못하면 `-EBADMSG`, `want_more=false`인데 여분 데이터가 있으면 `-EMSGSIZE`입니다. 원격 abort면 코드를 `abort`에 저장하고 `-ECONNABORTED`를 반환하며, `service`에는 업그레이드 결과가 기록됩니다.

`rxrpc_kernel_abort_call()`은 지정한 abort code로 호출을 중단합니다. 일반 수신 큐 대신 직접 메시지를 처리하려면 `rxrpc_kernel_intercept_rx_messages()`에 콜백을 등록합니다. 콜백에는 소켓, user call ID와 skb가 전달되며 DATA 순서는 보존됩니다. `skb->mark`는 `RXRPC_SKB_MARK_DATA`, `FINAL_ACK`, `BUSY`, `REMOTE_ABORT`, `NET_ERROR`, `LOCAL_ERROR`, `NEW_CALL` 가운데 하나로 메시지 종류를 나타냅니다.

abort와 errno는 전용 접근자로 꺼냅니다. 새 호출은 `rxrpc_kernel_accept_call()`로 수락하고 반환된 불투명 호출 참조는 다른 호출과 같은 방식으로 끝내야 합니다. DATA skb에서는 `rxrpc_kernel_extract_data()`로 바이트를 추출하고 `rxrpc_kernel_is_data_last()`로 마지막 패킷인지 검사하며, 소비가 끝나면 `rxrpc_kernel_data_consumed()`를 호출합니다. `rxrpc_kernel_free_skb()`가 skb를 해제합니다. skb가 보유한 추가 참조는 관련 호출 상태를 계속 고정합니다.

`rxrpc_kernel_reject_call()`은 가장 오래된 새 호출을 BUSY로 거절합니다. 대기 호출이 없으면 `-ENODATA`, 이미 중단됐으면 `-ECONNABORTED`, 만료됐으면 `-ETIME`입니다. `rxrpc_kernel_get_null_key()`는 익명 보안 호출용 null key를, `rxrpc_kernel_get_peer()`는 peer 객체를 반환합니다. `rxrpc_kernel_set_tx_length()`는 0 이상인 응답 길이를 설정하고 `rxrpc_kernel_get_rtt()`는 RTT를 ns 단위로 반환합니다.

`rxrpc_kernel_check_life()`는 ACK를 받을 때 증가하는 life counter를 표본과 비교합니다. PING ACK가 유도한 PING RESPONSE도 counter를 바꿉니다. 호출이 완료되지 않은 동안 최근 활동이 있었는지 확인할 수 있습니다. `rxrpc_kernel_probe_life()`는 PING ACK를 보내 생존을 확인하며 호출자는 `TASK_RUNNING` 상태여야 합니다. `rxrpc_sock_set_min_security_level()`은 커널 소켓의 최소 보안 수준을 설정합니다.

 (#) 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.

 (#) 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.

조정 가능한 /proc/net/rxrpc 매개변수

RxRPC 조정값은 `/proc/net/rxrpc/` 아래에 있습니다. `req_ack_delay`는 요청 ACK 플래그를 붙이기 전 지연으로, 255패킷 수신 창 안에서 송신자가 ACK 요청을 함께 묶도록 합니다. `soft_ack_delay`는 새 패킷에 대한 soft ACK 지연, `idle_ack_delay`는 응용 프로그램이 데이터를 소비한 뒤 수신 버퍼를 해제하는 hard ACK 지연입니다. 모두 밀리초 단위입니다.

`resend_timeout`은 재전송을 시작할 시간이며 밀리초 단위입니다. `max_call_lifetime`은 호출 최대 수명, `dead_call_expiry`는 종료 호출을 보관해 반복 패킷에 ACK 또는 ABORT를 다시 보낼 시간, `connection_expiry`는 보안 상태를 포함한 연결을 보관할 시간, `transport_expiry`는 peer와 connection ID 카운터를 붙잡는 전송 객체 보관 시간입니다. 이 네 값은 초 단위입니다.

`rxrpc_rx_window_size`는 호출별로 응용 프로그램이 아직 소비하지 않은 수신 패킷 수의 상한입니다. `rxrpc_rx_mtu`는 jumbo packet 수용에 사용하는 바이트 MTU이고 `rxrpc_rx_jumbo_max`는 한 jumbo packet에 묶을 수 있는 패킷 수입니다. 비종단 하위 패킷은 4바이트 헤더와 정확히 1412바이트 데이터, 종단 하위 패킷은 4바이트 헤더와 임의 길이 데이터를 가지며 전체는 Rx MTU를 넘을 수 없습니다.

Configurable Parameters
=======================

The RxRPC protocol driver has a number of configurable parameters that can be
adjusted through sysctls in /proc/net/rxrpc/:

 (#) 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.

커널 API 함수 참조 source path

마지막 절은 kernel-doc이 읽는 RxRPC 구현 파일을 나열합니다. 공개 함수의 실제 선언과 주석은 `net/rxrpc/af_rxrpc.c`, `call_object.c`, `key.c`, `oob.c`, `peer_object.c`, `recvmsg.c`, `rxgk.c`, `rxkad.c`, `sendmsg.c`, `server_key.c`에 있습니다. 이 경로는 API 설명과 현재 구현을 교차 확인할 기준입니다.

API Function Reference
======================

.. kernel-doc:: net/rxrpc/af_rxrpc.c
.. kernel-doc:: net/rxrpc/call_object.c
.. kernel-doc:: net/rxrpc/key.c
.. kernel-doc:: net/rxrpc/oob.c
.. kernel-doc:: net/rxrpc/peer_object.c
.. kernel-doc:: net/rxrpc/recvmsg.c
.. kernel-doc:: net/rxrpc/rxgk.c
.. kernel-doc:: net/rxrpc/rxkad.c
.. kernel-doc:: net/rxrpc/sendmsg.c
.. kernel-doc:: net/rxrpc/server_key.c