From patchwork Thu Jul 16 10:16:14 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Johannes Thumshirn X-Patchwork-Id: 11667093 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 117EB60D for ; Thu, 16 Jul 2020 10:16:27 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id EAE6F207F9 for ; Thu, 16 Jul 2020 10:16:26 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=wdc.com header.i=@wdc.com header.b="iu/XI8JL" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727118AbgGPKQ0 (ORCPT ); Thu, 16 Jul 2020 06:16:26 -0400 Received: from esa3.hgst.iphmx.com ([216.71.153.141]:17298 "EHLO esa3.hgst.iphmx.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727081AbgGPKQZ (ORCPT ); Thu, 16 Jul 2020 06:16:25 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=wdc.com; i=@wdc.com; q=dns/txt; s=dkim.wdc.com; t=1594894584; x=1626430584; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=KALZF4NqHXC9qoy6I4teMnQITGGpyunub/V7H6Pi3g4=; b=iu/XI8JLxX/PCRBzSpKLwOxxrsE55CxeaYCfE3D+FAmUlaEVorMG7hPq GP7SYQfbjyNvh0IhVvJbis6TR3bzI2mE6tRS9Sg0bgWNdXS3MX2ft32gp e0JGvdf0zVTM5ecppgnfUngfJJez/zj5MXvhJht17S7PgnFwAEwXv04FR t5DQzZj2YgU7p695iSt9Nddelmtj+GS0xkTG6JPj2Uq7pqyQQPq0RLWE7 HzdM/YuVajQ9WvQKrxCAKjmnocmQ/g6NdSY5yo0bWh9nGrBI+i3p3kxlq rtkvSQeqzRZ7AS+jYOWnPAE9kC7G+0+7O1PHYgE+KEAb8GI0w7eBX/zcl w==; IronPort-SDR: CSUuUmHOaniawfOyRWeQA5qVtmPmLFcSyKnzFuasyJ/e4zkS3poWBg5qb+OX1re7Lzf/BC21+n X7IZ2hin7llNB5Er6Q/6y4hbntGXXu0/OTINAeb6Z6nWKH3bkIsUMH6BBH6PuBNhWcNcAiIDD5 6kMinyIIZczvwx1B9r6WNTH2WN0Ad04ojo1yfVx7vb3Mypf/4YdUBBdwNxsF5t1v9FlYVM0WMy IatKG5wiQvtuXCBlEfV9xZIIkHhOGb87LbUMzFPYcZRuiyEtBaNObZ/JP/VmFpJiPEYlIVtNWx 1gI= X-IronPort-AV: E=Sophos;i="5.75,358,1589212800"; d="scan'208";a="146905374" Received: from h199-255-45-14.hgst.com (HELO uls-op-cesaep01.wdc.com) ([199.255.45.14]) by ob1.hgst.iphmx.com with ESMTP; 16 Jul 2020 18:16:24 +0800 IronPort-SDR: w3QNmCx5OVU9N/PhLAsa4CPItiJwBKzKavVZxikx7XbXbjg6Pj0qhf9ot0aXMHvmKJ/VUCS1Hx G+MC6jB1yMjOfo3MV6+nahznEEObQTK68= Received: from uls-op-cesaip02.wdc.com ([10.248.3.37]) by uls-op-cesaep01.wdc.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 16 Jul 2020 03:04:48 -0700 IronPort-SDR: FKM1AkJNtGQsHmh76F1uvDY+9qlRL71ebh+VuId8QzahOgGVwh+FHLW2KE7E6FXUuxn3aVvHhH 5dz2QzTI613w== WDCIronportException: Internal Received: from unknown (HELO redsun60.ssa.fujisawa.hgst.com) ([10.149.66.36]) by uls-op-cesaip02.wdc.com with ESMTP; 16 Jul 2020 03:16:23 -0700 From: Johannes Thumshirn To: Damien Le Moal Cc: linux-fsdevel@vger.kernel.org, Johannes Thumshirn Subject: [PATCH 2/2] zonefs: update documentation to reflect zone size vs capacity Date: Thu, 16 Jul 2020 19:16:14 +0900 Message-Id: <20200716101614.3468-3-johannes.thumshirn@wdc.com> X-Mailer: git-send-email 2.26.2 In-Reply-To: <20200716101614.3468-1-johannes.thumshirn@wdc.com> References: <20200716101614.3468-1-johannes.thumshirn@wdc.com> MIME-Version: 1.0 Sender: linux-fsdevel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-fsdevel@vger.kernel.org Update the zonefs documentation to reflect the difference between a zone's size and it's capacity. The maximum file size in zonefs is the zones capacity, for ZBC and ZAC based devices, which do not have a separate zone capacity, the zone capacity is equal to the zone size. Signed-off-by: Johannes Thumshirn --- Documentation/filesystems/zonefs.rst | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/Documentation/filesystems/zonefs.rst b/Documentation/filesystems/zonefs.rst index 71d845c6a700..6c18bc8ce332 100644 --- a/Documentation/filesystems/zonefs.rst +++ b/Documentation/filesystems/zonefs.rst @@ -110,14 +110,14 @@ contain files named "0", "1", "2", ... The file numbers also represent increasing zone start sector on the device. All read and write operations to zone files are not allowed beyond the file -maximum size, that is, beyond the zone size. Any access exceeding the zone -size is failed with the -EFBIG error. +maximum size, that is, beyond the zone capacity. Any access exceeding the zone +capacity is failed with the -EFBIG error. Creating, deleting, renaming or modifying any attribute of files and sub-directories is not allowed. The number of blocks of a file as reported by stat() and fstat() indicates the -size of the file zone, or in other words, the maximum file size. +capacity of the zone file, or in other words, the maximum file size. Conventional zone files ----------------------- @@ -156,8 +156,8 @@ all accepted. Truncating sequential zone files is allowed only down to 0, in which case, the zone is reset to rewind the file zone write pointer position to the start of -the zone, or up to the zone size, in which case the file's zone is transitioned -to the FULL state (finish zone operation). +the zone, or up to the zone capacity, in which case the file's zone is +transitioned to the FULL state (finish zone operation). Format options -------------- @@ -324,7 +324,7 @@ file size set to 0. This is necessary as the write pointer of read-only zones is defined as invalib by the ZBC and ZAC standards, making it impossible to discover the amount of data that has been written to the zone. In the case of a read-only zone discovered at run-time, as indicated in the previous section. -the size of the zone file is left unchanged from its last updated value. +The size of the zone file is left unchanged from its last updated value. Zonefs User Space Tools ======================= @@ -401,8 +401,9 @@ append-writes to the file:: # ls -l /mnt/seq/0 -rw-r----- 1 root root 0 Nov 25 13:49 /mnt/seq/0 -Since files are statically mapped to zones on the disk, the number of blocks of -a file as reported by stat() and fstat() indicates the size of the file zone:: +Since files are statically mapped to zones on the disk, the number of blocks +of a file as reported by stat() and fstat() indicates the capacity of the file +zone:: # stat /mnt/seq/0 File: /mnt/seq/0 @@ -416,5 +417,6 @@ a file as reported by stat() and fstat() indicates the size of the file zone:: The number of blocks of the file ("Blocks") in units of 512B blocks gives the maximum file size of 524288 * 512 B = 256 MB, corresponding to the device zone -size in this example. Of note is that the "IO block" field always indicates the -minimum I/O size for writes and corresponds to the device physical sector size. +capacity in this example. Of note is that the "IO block" field always +indicates the minimum I/O size for writes and corresponds to the device +physical sector size.