From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: ARC-Seal: i=1; a=rsa-sha256; t=1519117745; cv=none; d=google.com; s=arc-20160816; b=B3lBnw4ttYst4jMSGmtOf04GPKExXMsQ8ZT0GlTdmTvLUQgusvXUEXUnN/WGT89fhN Ny5idHw7YH7c1T3tra3RNWNRXJWuGI/Ox0cvnsp8RiFbVEwWJJBf1lDAHh5us4nG6AjQ SfQogauuTkxCCNo36C7b2rDHTgexxVfjZMMGvmluaz96rnCqXKwocUCR7dlQeTPK3+Gn Qp4lXmmNh19+bvbui3iWbOnBxMrZmA9TXS5MzuYgGIDnhBvm7aTZfKvbwtW+uRDcaOP2 qTG7Yheq2RpVfzyiqOPajtraWfmUAWwf0P4M/Vy0Pk04Pwx7IxP+5e3iVGJrxF4w2t5W zTBw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=user-agent:content-disposition:mime-version:message-id:subject:cc :to:from:date:dkim-signature:arc-authentication-results; bh=4nGm3A0SeOhpCuVhrtuwrK3ZHWyRFGfAYE1zgY7DM9o=; b=o/Jgif89Y0Ow2YZ9CzLgTnCQJGgSOvVfREtQX1kbrlXM5qXaS05iR6S3D2KWZ02vgr Y84+jme5pE5gofSXj2cH9UPjNVe3DfZJQLjjo8mkjIrfXZyl8R5LduplfcBRg/hyrcrO MaBOSrC+AkncoSvPQrk6S/UJjVIt9H0Igc7LtyBNy/LaL/1tmjWgtlv1YJyHIIpOLRs7 QelU8LsKcJAludH9WHzSMHCAKs0AncsZxHpIVmz58D7dEc1Gqo34sk6pPHv5206lBjTq HDmITF2X7vZ1F5jINc9FO79Q7aHRpJYe8hV9jDZBQfSTc/pgHWIcocoCl75KCXQvuezA AlHw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=eyvDa1u6; spf=pass (google.com: domain of aishpant@gmail.com designates 209.85.220.41 as permitted sender) smtp.mailfrom=aishpant@gmail.com; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=eyvDa1u6; spf=pass (google.com: domain of aishpant@gmail.com designates 209.85.220.41 as permitted sender) smtp.mailfrom=aishpant@gmail.com; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com X-Google-Smtp-Source: AH8x227/G3ac6/jeb564qcAi60AoPtRKg+SsLPr/WaS6YSsYrTpIZJ104z/rV8rpvtfuKg6O3qcLkA== Date: Tue, 20 Feb 2018 14:38:59 +0530 From: Aishwarya Pant To: Ilya Dryomov , Sage Weil , Alex Elder , ceph-devel@vger.kernel.org, linux-kernel@vger.kernel.org, Jonathan Corbet , Greg KH Cc: Julia Lawall Subject: [PATCH] block: rbd: update sysfs interface Message-ID: <20180220090859.GA22737@mordor.localdomain> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.9.3 (2018-01-21) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: =?utf-8?q?1592910409201593402?= X-GMAIL-MSGID: =?utf-8?q?1592910409201593402?= X-Mailing-List: linux-kernel@vger.kernel.org List-ID: The existing sysfs interface has been updated to be in the same format as described in Documentation/ABI/README. This will be useful for scripting and tracking changes in the ABI. Attributes have been grouped by functionality and/or the date on which they were added. There are a couple of more changes: - The attributes have been annotated with file permissions RO/RW/WO. - Added description of the bus attribute supported_features Signed-off-by: Aishwarya Pant --- Documentation/ABI/testing/sysfs-bus-rbd | 202 +++++++++++++++++++------------- 1 file changed, 122 insertions(+), 80 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-bus-rbd b/Documentation/ABI/testing/sysfs-bus-rbd index f208ac58d613..9549e9b0fcf8 100644 --- a/Documentation/ABI/testing/sysfs-bus-rbd +++ b/Documentation/ABI/testing/sysfs-bus-rbd @@ -1,121 +1,163 @@ -What: /sys/bus/rbd/ -Date: November 2010 +What: /sys/bus/rbd/add +What: /sys/bus/rbd/remove +Date: Jan, 2012 +KernelVersion: v3.10 Contact: Yehuda Sadeh , Sage Weil Description: + add : (WO) Add rbd block device. -Being used for adding and removing rbd block devices. + Usage: [] -Usage: [] + $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add - $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add + The snapshot name can be "-" or omitted to map the image + read/write. A will be assigned for any registered block + device. If snapshot is used, it will be mapped read-only. -The snapshot name can be "-" or omitted to map the image read/write. A -will be assigned for any registered block device. If snapshot is used, it will -be mapped read-only. + remove: (WO) Remove rbd block device. -Usage: [force] + Usage: [force] - $ echo 2 > /sys/bus/rbd/remove + $ echo 2 > /sys/bus/rbd/remove + + Optional "force" argument which when passed will wait for + running requests and then unmap the image. Requests sent to the + driver after initiating the removal will be failed. (August + 2016, since 4.9.) -Optional "force" argument which when passed will wait for running requests and -then unmap the image. Requests sent to the driver after initiating the removal -will be failed. (August 2016, since 4.9.) What: /sys/bus/rbd/add_single_major -Date: December 2013 -KernelVersion: 3.14 -Contact: Sage Weil -Description: Available only if rbd module is inserted with single_major +Date: Dec, 2013 +KernelVersion: v3.14 +Contact: Yehuda Sadeh , + Sage Weil +Description: + (WO) Available only if rbd module is inserted with single_major parameter set to true. - Usage is the same as for /sys/bus/rbd/add. If present, + + Usage is the same as for /sys/bus/rbd/add. If present, this should be used instead of the latter: any attempts to use - /sys/bus/rbd/add if /sys/bus/rbd/add_single_major is - available will fail for backwards compatibility reasons. + /sys/bus/rbd/add if /sys/bus/rbd/add_single_major is available + will fail for backwards compatibility reasons. + What: /sys/bus/rbd/remove_single_major -Date: December 2013 -KernelVersion: 3.14 -Contact: Sage Weil -Description: Available only if rbd module is inserted with single_major +Date: Dec, 2013 +KernelVersion: v3.14 +Contact: Yehuda Sadeh , + Sage Weil +Description: + (WO) Available only if rbd module is inserted with single_major parameter set to true. - Usage is the same as for /sys/bus/rbd/remove. If present, + + Usage is the same as for /sys/bus/rbd/remove. If present, this should be used instead of the latter: any attempts to use /sys/bus/rbd/remove if /sys/bus/rbd/remove_single_major is available will fail for backwards compatibility reasons. -Entries under /sys/bus/rbd/devices// --------------------------------------------- - -client_addr - - The ceph unique client entity_addr_t (address + nonce). - The format is

:/: '1.2.3.4:1234/5678' or - '[1:2:3:4:5:6:7:8]:1234/5678'. (August 2016, since 4.9.) - -client_id - - The ceph unique client id that was assigned for this specific session. - -cluster_fsid - - The ceph cluster UUID. (August 2016, since 4.9.) - -config_info - - The string written into /sys/bus/rbd/add{,_single_major}. (August - 2016, since 4.9.) - -features - - A hexadecimal encoding of the feature bits for this image. -major - - The block device major number. - -minor +What: /sys/bus/rbd/supported_features +Date: Mar, 2017 +KernelVersion: v4.11 +Contact: Yehuda Sadeh , + Sage Weil +Description: + (RO) Displays the features supported by the client software + implementation so that userspace can generate meaningful error + messages and spell out unsupported features that need to be + disabled. + + +What: /sys/bus/rbd/devices//size +What: /sys/bus/rbd/devices//refresh +What: /sys/bus/rbd/devices//current_snap +What: /sys/bus/rbd/devices//name +What: /sys/bus/rbd/devices//major +What: /sys/bus/rbd/devices//client_id +Date: Aug, 2010 +KernelVersion: v2.6.37 +Contact: Yehuda Sadeh , + Sage Weil +Description: + size: (RO) The size (in bytes) of the mapped block + device. - The block device minor number. (December 2013, since 3.14.) + refresh: (WO) Writing to this file will reread the image + header data and set all relevant data structures + accordingly. -name + current_snap: (RO) The current snapshot for which the device + is mapped. - The name of the rbd image. + name: (RO) The name of the rbd image. -image_id + major: (RO) The block device major number. - The unique id for the rbd image. (For rbd image format 1 - this is empty.) + client_id: (RO) The ceph unique client id that was assigned + for this specific session. -pool - The name of the storage pool where this rbd image resides. - An rbd image name is unique within its pool. +What: /sys/bus/rbd/devices//pool +What: /sys/bus/rbd/devices//image_id +What: /sys/bus/rbd/devices//features +What: /sys/bus/rbd/devices//pool_id +Date: Jul, 2012 +KernelVersion: v3.10 +Contact: Yehuda Sadeh , + Sage Weil +Description: + pool: (RO) The name of the storage pool where this rbd + image resides. An rbd image name is unique + within its pool. -pool_id + image_id: (WO) The unique id for the rbd image. (For rbd + image format 1 this is empty.) - The unique identifier for the rbd image's pool. This is - a permanent attribute of the pool. A pool's id will never - change. + features: (RO) A hexadecimal encoding of the feature bits + for this image. -size + pool_idr: (RO) The unique identifier for the rbd image's + pool. This is a permanent attribute of the pool. + A pool's id will never change. - The size (in bytes) of the mapped block device. -refresh +What: /sys/bus/rbd/devices//parent +Date: Oct, 2012 +KernelVersion: v3.10 +Contact: Yehuda Sadeh , + Sage Weil +Description: + (RO) Information identifying the chain of parent images in a + layered rbd image. Entries are separated by empty lines. - Writing to this file will reread the image header data and set - all relevant datastructures accordingly. -current_snap +What: /sys/bus/rbd/devices//minor +Date: Dec, 2013 +KernelVersion: v3.14 +Contact: Yehuda Sadeh , + Sage Weil +Description: + (RO) The block device minor number. - The current snapshot for which the device is mapped. -snap_id +What: /sys/bus/rbd/devices//snap_id +What: /sys/bus/rbd/devices//config_info +What: /sys/bus/rbd/devices//cluster_fsid +What: /sys/bus/rbd/devices//client_addr +Date: Aug, 2016 +KernelVersion: v4.9 +Contact: Yehuda Sadeh , + Sage Weil +Description: + snap_id: (RO) The current snapshot's id. - The current snapshot's id. (August 2016, since 4.9.) + config_info: (RO) The string written into + /sys/bus/rbd/add{,_single_major}. -parent + cluster_fsid: (RO) The ceph cluster UUID. - Information identifying the chain of parent images in a layered rbd - image. Entries are separated by empty lines. + client_addr: (RO) The ceph unique client + entity_addr_t (address + nonce). The format is +

:/: '1.2.3.4:1234/5678' or + '[1:2:3:4:5:6:7:8]:1234/5678'. -- 2.16.1