From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-9.7 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 71B4BC32770 for ; Mon, 30 Dec 2019 10:30:16 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 3F798206DB for ; Mon, 30 Dec 2019 10:30:16 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="Q6ALVEVq" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727471AbfL3KaP (ORCPT ); Mon, 30 Dec 2019 05:30:15 -0500 Received: from mail-ed1-f66.google.com ([209.85.208.66]:35329 "EHLO mail-ed1-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727425AbfL3KaO (ORCPT ); Mon, 30 Dec 2019 05:30:14 -0500 Received: by mail-ed1-f66.google.com with SMTP id f8so32224277edv.2; Mon, 30 Dec 2019 02:30:12 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=S66d/s1DzmMwIj52SGUfwiRx17h7a16XUgBfRYfwxsk=; b=Q6ALVEVqJqWNtq4Q1hnw2o+2JKmvC5sfpLjFgnyWwlimYF9/0uhBTWv+5+Trh//HFX 1QEy6NhEYj5C3TqG6qP/3qPhblFw+21SdWa1hwLLacGxbutHvPvIumhG3x4e52/6DbSn FZ3pjeUrULkyG4XNyLFpKLwtvqD+2dP+vi6bQG8HWzAyR51LcL6U2/NSJmnLTEcdCAki bZbkBT41DuotfvCDYez8ClCa3Eu5w/LOcNU83VDCjrPRQ+j4+7p6NAl45S8OV0RpmlkP Fy0rFTYhkOk+mjlZRxL9Acs6rUdIfhK/mfN6tmIfp8Bo/YRLyUcXlwqjy+rH1QL8pKBe UF9Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=S66d/s1DzmMwIj52SGUfwiRx17h7a16XUgBfRYfwxsk=; b=G0IazVLvaXYf6GUfbQ5lcn1+LrUeBHPG/D9okEx0fIg0Fnt1VAsM40SkZggCu2MqAr 9PZb/7gXvA8eNFvOd8ozwMoETN0ITofmAwCrtKka86XPDqh5bFyqpj8IknuZDxAwz1PF cHhZs+MmZ7cfpcGjHW5IQKQHYBPjkS9hDYUyqjZysc+LbgxghzUkr8hK5VCBj134ZERK O9T+A8jz4xiAeOSo4bt2FlfAts1HhQKe1ifwGxlfldLFIB9sy/Eip+e5QMD6O2KVGVw1 Ksq9iplrHRKRY1TPNv2NeLSABU+FCzXIExp7MbaMsnjo5Yeojp0fvXYnS8UK4ckG4qpZ gmKg== X-Gm-Message-State: APjAAAVDl84OxeoHGdt+QhvLDsqxQezr7aH+mcFms35NGbuORP1tVffy ETRjxNrzb6ROM+PN1vP7EWZIZn7j X-Google-Smtp-Source: APXvYqwEq4doU3yoQRewE9ze588D1nNlm59sQs7kwK1UBf5Xia4i8cc6/3rM91Qn8pQAHM+tZ2aT0A== X-Received: by 2002:a50:cd1c:: with SMTP id z28mr69964062edi.20.1577701811159; Mon, 30 Dec 2019 02:30:11 -0800 (PST) Received: from jwang-Latitude-5491.fritz.box ([2001:16b8:4955:5100:b9e0:6ef7:286d:4897]) by smtp.gmail.com with ESMTPSA id v8sm5246630edw.21.2019.12.30.02.30.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 30 Dec 2019 02:30:10 -0800 (PST) From: Jack Wang To: linux-block@vger.kernel.org, linux-rdma@vger.kernel.org Cc: axboe@kernel.dk, hch@infradead.org, sagi@grimberg.me, bvanassche@acm.org, leon@kernel.org, dledford@redhat.com, danil.kipnis@cloud.ionos.com, jinpu.wang@cloud.ionos.com, rpenyaev@suse.de, linux-kernel@vger.kernel.org Subject: [PATCH v6 24/25] rnbd: a bit of documentation Date: Mon, 30 Dec 2019 11:29:41 +0100 Message-Id: <20191230102942.18395-25-jinpuwang@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20191230102942.18395-1-jinpuwang@gmail.com> References: <20191230102942.18395-1-jinpuwang@gmail.com> Sender: linux-block-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-block@vger.kernel.org From: Jack Wang README with description of major sysfs entries, sysfs documentation are moved to ABI dir as Bart suggested. Signed-off-by: Danil Kipnis Signed-off-by: Jack Wang Cc: linux-kernel@vger.kernel.org --- Documentation/ABI/testing/sysfs-block-rnbd | 51 ++++++++ .../ABI/testing/sysfs-class-rnbd-client | 117 ++++++++++++++++++ .../ABI/testing/sysfs-class-rnbd-server | 57 +++++++++ drivers/block/rnbd/README | 92 ++++++++++++++ 4 files changed, 317 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-block-rnbd create mode 100644 Documentation/ABI/testing/sysfs-class-rnbd-client create mode 100644 Documentation/ABI/testing/sysfs-class-rnbd-server create mode 100644 drivers/block/rnbd/README diff --git a/Documentation/ABI/testing/sysfs-block-rnbd b/Documentation/ABI/testing/sysfs-block-rnbd new file mode 100644 index 000000000000..dea84280291a --- /dev/null +++ b/Documentation/ABI/testing/sysfs-block-rnbd @@ -0,0 +1,51 @@ +What: /sys/block/rnbd/rnbd/unmap_device +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +To unmap a volume, "normal" or "force" has to be written to: + /sys/block/rnbd/rnbd/unmap_device + +When "normal" is used, the operation will fail with EBUSY if any process +is using the device. When "force" is used, the device is also unmapped +when device is in use. All I/Os that are in progress will fail. + +Example: + + # echo "normal" > /sys/block/rnbd0/rnbd/unmap_device + +What: /sys/block/rnbd/rnbd/state +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +The file contains the current state of the block device. The state file +returns "open" when the device is successfully mapped from the server +and accepting I/O requests. When the connection to the server gets +disconnected in case of an error (e.g. link failure), the state file +returns "closed" and all I/O requests submitted to it will fail with -EIO. + +What: /sys/block/rnbd/rnbd/session +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +RNBD uses RTRS session to transport the data between client and +server. The entry "session" contains the name of the session, that +was used to establish the RTRS session. It's the same name that +was passed as server parameter to the map_device entry. + +What: /sys/block/rnbd/rnbd/mapping_path +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +Contains the path that was passed as "device_path" to the map_device +operation. + +What: /sys/block/rnbd/rnbd/access_mode +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +Contains the device access mode: ro, rw or migration. diff --git a/Documentation/ABI/testing/sysfs-class-rnbd-client b/Documentation/ABI/testing/sysfs-class-rnbd-client new file mode 100644 index 000000000000..7466a6aa2641 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-class-rnbd-client @@ -0,0 +1,117 @@ +What: /sys/class/rnbd-client +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +Provide information about RNBD-client. +All sysfs files that are not read-only provide the usage information on read: + +Example: + # cat /sys/class/rnbd-client/ctl/map_device + + > Usage: echo "sessname= path=<[srcaddr,]dstaddr> + > [path=<[srcaddr,]dstaddr>] device_path= + > [access_mode=] > map_device + > + > addr ::= [ ip: | ip: | gid: ] + +What: /sys/class/rnbd-client/ctl/map_device +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +Expected format is the following: + + sessname= + path=<[srcaddr,]dstaddr> [path=<[srcaddr,]dstaddr> ...] + device_path= + [access_mode=] + +Where: + +sessname: accepts a string not bigger than 256 chars, which identifies + a given session on the client and on the server. + I.e. "clt_hostname-srv_hostname" could be a natural choice. + +path: describes a connection between the client and the server by + specifying destination and, when required, the source address. + The addresses are to be provided in the following format: + + ip: + ip: + gid: + + for example: + + path=ip:10.0.0.66 + The single addr is treated as the destination. + The connection will be established to this + server from any client IP address. + + path=ip:10.0.0.66,ip:10.0.1.66 + First addr is the source address and the second + is the destination. + + If multiple "path=" options are specified multiple connection + will be established and data will be sent according to + the selected multipath policy (see RTRS mp_policy sysfs entry + description). + +device_path: Path to the block device on the server side. Path is specified + relative to the directory on server side configured in the + 'dev_search_path' module parameter of the rnbd_server. + The rnbd_server prepends the received from client + with and tries to open the + / block device. On success, + a /dev/rnbd device file, a /sys/block/rnbd_client/rnbd/ + directory and an entry in /sys/class/rnbd-client/ctl/devices + will be created. + + If 'dev_search_path' contains '%SESSNAME%', then each session can + have different devices namespace, e.g. server was configured with + the following parameter "dev_search_path=/run/rnbd-devs/%SESSNAME%", + client has this string "sessname=blya device_path=sda", then server + will try to open: /run/rnbd-devs/blya/sda. + +access_mode: the access_mode parameter specifies if the device is to be + mapped as "ro" read-only or "rw" read-write. The server allows + a device to be exported in rw mode only once. The "migration" + access mode has to be specified if a second mapping in read-write + mode is desired. + + By default "rw" is used. + +Exit Codes: + +If the device is already mapped it will fail with EEXIST. If the input +has an invalid format it will return EINVAL. If the device path cannot +be found on the server, it will fail with ENOENT. + +Finding device file after mapping +--------------------------------- + +After mapping, the device file can be found by: + o The symlink /sys/class/rnbd-client/ctl/devices/ + points to /sys/block/. The last part of the symlink destination + is the same as the device name. By extracting the last part of the + path the path to the device /dev/ can be build. + + o /dev/block/$(cat /sys/class/rnbd-client/ctl/devices//dev) + +How to find the of the device is described on the next +section. + +What: /sys/class/rnbd-client/ctl/devices/ +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +For each device mapped on the client a new symbolic link is created as +/sys/class/rnbd-client/ctl/devices/, which points +to the block device created by rnbd (/sys/block/rnbd/). +The of each device is created as follows: + +- If the 'device_path' provided during mapping contains slashes ("/"), + they are replaced by exclamation mark ("!") and used as as the + . Otherwise, the will be the same as the + "device_path" provided. diff --git a/Documentation/ABI/testing/sysfs-class-rnbd-server b/Documentation/ABI/testing/sysfs-class-rnbd-server new file mode 100644 index 000000000000..1faa9faa8ca3 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-class-rnbd-server @@ -0,0 +1,57 @@ +What: /sys/class/rnbd-server +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: provide information about RNBD-server. + +What: /sys/class/rnbd-server/ctl/ +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +When a client maps a device, a directory entry with the name of the +block device is created under /sys/class/rnbd-server/ctl/devices/. + +What: /sys/class/rnbd-server/ctl/devices//block_dev +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +Is a symlink to the sysfs entry of the exported device. + +Example: + + block_dev -> ../../../../class/block/ram0 + +What: /sys/class/rnbd-server/ctl/devices//sessions/ +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +For each client a particular device is exported to, following directory will be +created: + +/sys/class/rnbd-server/ctl/devices//sessions// + +When the device is unmapped by that client, the directory will be removed. + +What: /sys/class/rnbd-server/ctl/devices//sessions//read_only +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +Contains '1' if device is mapped read-only, otherwise '0'. + +What: /sys/class/rnbd-server/ctl/devices//sessions//mapping_path +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +Contains the relative device path provided by the user during mapping. + +What: /sys/class/rnbd-server/ctl/devices//sessions//access_mode +Date: Jan 2020 +KernelVersion: 5.6 +Contact: Jack Wang Danil Kipnis +Description: +Contains the device access mode: ro, rw or migration. diff --git a/drivers/block/rnbd/README b/drivers/block/rnbd/README new file mode 100644 index 000000000000..3ee009d72fbb --- /dev/null +++ b/drivers/block/rnbd/README @@ -0,0 +1,92 @@ +*************************************** +Infiniband Network Block Device (RNBD) +*************************************** + +Introduction +------------ + +RNBD (InfiniBand Network Block Device) is a pair of kernel modules +(client and server) that allow for remote access of a block device on +the server over RTRS protocol using the RDMA (InfiniBand, RoCE, iWarp) +transport. After being mapped, the remote block devices can be accessed +on the client side as local block devices. + +I/O is transferred between client and server by the RTRS transport +modules. The administration of RNBD and RTRS modules is done via +sysfs entries. + +Requirements +------------ + + RTRS kernel modules + +Quick Start +----------- + +Server side: + # modprobe rnbd_server + +Client side: + # modprobe rnbd_client + # echo "sessname=blya path=ip:10.50.100.66 device_path=/dev/ram0" > \ + /sys/devices/virtual/rnbd-client/ctl/map_device + + Where "sessname=" is a session name, a string to identify the session + on client and on server sides; "path=" is a destination IP address or + a pair of a source and a destination IPs, separated by comma. Multiple + "path=" options can be specified in order to use multipath (see RTRS + description for details); "device_path=" is the block device to be + mapped from the server side. After the session to the server machine is + established, the mapped device will appear on the client side under + /dev/rnbd. + + +RNBD-Server Module Parameters +============================== + +dev_search_path +--------------- + +When a device is mapped from the client, the server generates the path +to the block device on the server side by concatenating dev_search_path +and the "device_path" that was specified in the map_device operation. + +The default dev_search_path is: "/". + +dev_search_path option can also contain %SESSNAME% in order to provide +different deviec namespaces for different sessions. See "device_path" +option for details. + +============================== +Protocol (rnbd/rnbd-proto.h) +============================== + +1. Before mapping first device from a given server, client sends an +RNBD_MSG_SESS_INFO to the server. Server responds with +RNBD_MSG_SESS_INFO_RSP. Currently the messages only contain the protocol +version for backward compatibility. + +2. Client requests to open a device by sending RNBD_MSG_OPEN message. This +contains the path to the device and access mode (read-only or writable). +Server responds to the message with RNBD_MSG_OPEN_RSP. This contains +a 32 bit device id to be used for IOs and device "geometry" related +information: side, max_hw_sectors, etc. + +3. Client attaches RNBD_MSG_IO to each IO message send to a device. This +message contains device id, provided by server in his rnbd_msg_open_rsp, +sector to be accessed, read-write flags and bi_size. + +4. Client closes a device by sending RNBD_MSG_CLOSE which contains only the +device id provided by the server. + +========================================= +Contributors List(in alphabetical order) +========================================= +Danil Kipnis +Fabian Holler +Guoqing Jiang +Jack Wang +Kleber Souza +Lutz Pogrell +Milind Dumbare +Roman Penyaev -- 2.17.1