Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37;
From:   John Garry <john.g.garry@oracle.com>
To:     axboe@kernel.dk, kbusch@kernel.org, hch@lst.de, sagi@grimberg.me,
        jejb@linux.ibm.com, martin.petersen@oracle.com, djwong@kernel.org,
        viro@zeniv.linux.org.uk, brauner@kernel.org, dchinner@redhat.com,
        jack@suse.cz
Cc:     linux-block@vger.kernel.org, linux-kernel@vger.kernel.org,
        linux-nvme@lists.infradead.org, linux-xfs@vger.kernel.org,
        linux-fsdevel@vger.kernel.org, tytso@mit.edu, jbongio@google.com,
        linux-scsi@vger.kernel.org, ming.lei@redhat.com,
        jaswin@linux.ibm.com, bvanassche@acm.org,
        Prasad Singamsetty <prasad.singamsetty@oracle.com>,
        John Garry <john.g.garry@oracle.com>
Subject: [PATCH v2 05/16] fs: Add RWF_ATOMIC and IOCB_ATOMIC flags for atomic write support
Date:   Tue, 12 Dec 2023 11:08:33 +0000
Message-Id: <20231212110844.19698-6-john.g.garry@oracle.com>
In-Reply-To: <20231212110844.19698-1-john.g.garry@oracle.com>
References: <20231212110844.19698-1-john.g.garry@oracle.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?wHl69egH9xBqAN9hIGoaQZiG9wgkLRPFnHBN0Kfoi96tEvTWQxcXLpGDWxIU?=
 =?us-ascii?Q?89uxlkoK4xz/g1DVlj3ZLtZWAxqJlXp67+dl4iNvv6l5KfFHR3w3LJQpGJoo?=
 =?us-ascii?Q?eHcJkDKnjMxeqJ3/gsxDUJS39m+9VGYH3wJPO4WFKoQwaisoU1h5Up0oMG/E?=
 =?us-ascii?Q?8VAsfiliwllZzFtnohgY6fy4VP8pEIcuy84Ic/4oZTW+a5cskruTxZLE8up1?=
 =?us-ascii?Q?cmWXgGt3CvAoB6qCXyJwDmO6ajpd5Y10cyxIAT9TaSn+8uJyXcXkJ999alKN?=
 =?us-ascii?Q?FIn2GxM/CPqDgVNyEPfjOxHX/ZJoI8AboH+FKEpO3vA8LS5rM37gpA1SRZkz?=
 =?us-ascii?Q?HstD1npWppKP4bvynSZN9GkMVYxG/YTLhcU2hbtWdV/mLda0EWlu3gupnSQc?=
 =?us-ascii?Q?DoDfMPkKY5DKM6xqL+QLxPTThbQ6JfeKSA+WrHShJfV0PUj+t1zRwTby8AJF?=
 =?us-ascii?Q?q+QCKNeOdYeN0Od/9vPjWCvbppmam0/MZriX0ADq73PIXL5nO+sz9Hnc4mog?=
 =?us-ascii?Q?RUyi3Q5C/byOkG8j4Fp/1kjJvqi9j34QexQLIkMzkom85UbX3sbrWKhDI9bS?=
 =?us-ascii?Q?PQiWlpl/FWJKROSCrROxJbt6MzRnTOLJt1kIiCDYkZ4rbra+04pYj6YtIJRc?=
 =?us-ascii?Q?nWH+GX5wnLuZOzVIAPVUpytzNAyIqSGNS0pY1oDuZnCKkSbftcSny8i5S9Fc?=
 =?us-ascii?Q?Jm2lLHZ7N3Da9SPZJDyaTbUTLMFbQri0tIqROi/Mg5meIRliEQc5jKTyHRc0?=
 =?us-ascii?Q?fvvPlpdnJvjrDzoKTO/q3rDxHw3f5V8sHqC3iMwxUlTSrfVIVjbnyg6FmuvQ?=
 =?us-ascii?Q?EVSkwKcw6to4rt81/tWj/38moASpMnlGR2kX+ZD76U6YFA1Tz4PLUG2RVLq+?=
 =?us-ascii?Q?07tYwCtddg5CPHWclmCHPoiEYEepVgjWVT9DFwhq6IPL0vOwI+bOplyYAoF2?=
 =?us-ascii?Q?yDMWoig+Cnl3jwAIG0TvCjft6O9LaOXbue3YJUP4CVWvaGce6cgMQD4i64mo?=
 =?us-ascii?Q?sK2MtyKQzLsPGrmdqYazPSL16L0cjWk+RaFtdGVIhLM7ZeHqSdz9iSfup05l?=
 =?us-ascii?Q?5ovP5OKZeZiQ0kdUU6uyUBfJDZ777AEPBcIC73cbKJDZJobtpWsxpRCttOvF?=
 =?us-ascii?Q?fPV2APCQ5vHxx49FpMQikS/grYhKuINmjNnqRqnQ9trvoAKzDtjReEtj8zuM?=
 =?us-ascii?Q?T9kbyo2S3BcQg0lAPQ5/uXrvxu06ZasJgDKQGRszvhCjxuhCdw0mx57GyTL5?=
 =?us-ascii?Q?N3LYueNMyg89W/1VWGWBXnBwjTbkeeRs4Z/otPNy19IH5/TL2w7blNyVFTxm?=
 =?us-ascii?Q?mwP5/cWRsUIwu7ORO4zMt3avP3UsJ86YKNTl+AvpgdqnHUMcwlhsigneFJiM?=
 =?us-ascii?Q?ZLZxa8X7mdHzGJKUzToLOrCeM0CIRWWDE9sMJE7FySpc/lN+eKBf1b0tIUIm?=
 =?us-ascii?Q?Qu4Hp5iMA55tO9t8XVJ6nnPk0ueC+/FvSDLReebozKOBSfybSpfBWneJcVoa?=
 =?us-ascii?Q?jWFXWX/4kxo9h44jgDqDjoPWTZGJO5okCSBEO8F4Ay6nWEgciJw5T71e1tCI?=
 =?us-ascii?Q?XlahsMIFHzISRrTpFKKgOUPkvNDfN1lV6LuhKHpVP1CnQtZDIU5iPJRSaCPH?=
 =?us-ascii?Q?WQ=3D=3D?=
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: V9XoFZgPyAs9kGeVU/UHm1JayXTBHzkVN/ZWCbQx6Ph1DlVBV56E5FacPCSWsxgB4CrLLQMS2uxCR2G0SBoFiDtOlLSytE6lg2Cp9mpE2QduzOpAIYpUYrJYOvhWlIheEbc63pf37CFy9MRjUCKgY6f/B3ZliGSLx6s0nBZMkt+6lX6NrZh9xQh4FhcO3aKyEkXeT1fx1GK9MLPHw06+2hqBL8ggDX4lyX1ZwNpoCCeKXsbts9TLRm5C6BHIAoBRzNr8WfM11oOzVkgTMFnFN7oFm6qaXKIzAzS9P98eM0bfjtL4RD8KmT9jRPGMt8hTaPs84cnCUV8HWtiYquHfxLKjncvnJo6L1tIuPHJHQgoXl0TnlyfRcCt86tOujQTCcOZJBlYeHjN/kPjX4qw2AO4Icr55jJQEPBmXF+d0YlL+gQRmHB0d+pstzQ01zApomUhGdxvRz7dprXN4GLVa26dvh9Fmrx1mfg3zLxFlPopx9OmM7T5zSUO9nJUITMX2pT76UVwlLHS0cJeFcjZSUbqIKDtbNz1JN557JGKlwrN+sMO1ULuQaMRVkxoXR8mpn8pInFmNFAaI6R6q1DaL5hG0jz9ERGzrepkBftSEXHY=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 551c8a71-72ba-4e49-ac47-08dbfb02c9c8
X-MS-Exchange-CrossTenant-AuthSource: DM6PR10MB4313.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Dec 2023 11:09:19.8312
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 29Lc2AFRS23sOfpHEB9W9E3mDcSqPMa03AJq3hpQ3jwIhdKwU2GwBLkoS+p78eAP7B6aDY2XsgqHchUzLD7pMQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA1PR10MB6663
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.272,Aquarius:18.0.997,Hydra:6.0.619,FMLib:17.11.176.26
 definitions=2023-12-12_04,2023-12-12_01,2023-05-22_02
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 phishscore=0 malwarescore=0 spamscore=0
 suspectscore=0 mlxscore=0 mlxlogscore=999 adultscore=0 bulkscore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2311290000
 definitions=main-2312120089
X-Proofpoint-ORIG-GUID: _hof55kIx_G12pWsjH5qXTiXeXjdeOe-
X-Proofpoint-GUID: _hof55kIx_G12pWsjH5qXTiXeXjdeOe-
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED,
        RCVD_IN_MSPIKE_H5,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,SPF_NONE,
        T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Tue, 12 Dec 2023 03:10:22 -0800 (PST)

From: Prasad Singamsetty <prasad.singamsetty@oracle.com>

Userspace may add flag RWF_ATOMIC to pwritev2() to indicate that the
write is to be issued with torn write prevention, according to special
alignment and length rules.

Torn write prevention means that for a power or any other HW failure, all
or none of the data will be committed to storage, but never a mix of old
and new.

For any syscall interface utilizing struct iocb, add IOCB_ATOMIC for
iocb->ki_flags field to indicate the same.

A call to statx will give the relevant atomic write info:
- atomic_write_unit_min
- atomic_write_unit_max

Both values are a power-of-2.

Applications can avail of atomic write feature by ensuring that the total
length of a write is a power-of-2 in size and also sized between
atomic_write_unit_min and atomic_write_unit_max, inclusive. Applications
must ensure that the write is at a naturally-aligned offset in the file
wrt the total write length.

Add file mode flag FMODE_CAN_ATOMIC_WRITE, so files which do not have the
flag set will have RWF_ATOMIC rejected and not just ignored.

Signed-off-by: Prasad Singamsetty <prasad.singamsetty@oracle.com>
Signed-off-by: John Garry <john.g.garry@oracle.com>
---
 include/linux/fs.h      | 8 ++++++++
 include/uapi/linux/fs.h | 5 ++++-
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/include/linux/fs.h b/include/linux/fs.h
index 70329c81be31..d725c194243c 100644
--- a/include/linux/fs.h
+++ b/include/linux/fs.h
@@ -185,6 +185,9 @@ typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
 /* File supports async nowait buffered writes */
 #define FMODE_BUF_WASYNC	((__force fmode_t)0x80000000)
 
+/* File supports atomic writes */
+#define FMODE_CAN_ATOMIC_WRITE	((__force fmode_t)0x100000000)
+
 /*
  * Attribute flags.  These should be or-ed together to figure out what
  * has been changed!
@@ -328,6 +331,7 @@ enum rw_hint {
 #define IOCB_SYNC		(__force int) RWF_SYNC
 #define IOCB_NOWAIT		(__force int) RWF_NOWAIT
 #define IOCB_APPEND		(__force int) RWF_APPEND
+#define IOCB_ATOMIC		(__force int) RWF_ATOMIC
 
 /* non-RWF related bits - start at 16 */
 #define IOCB_EVENTFD		(1 << 16)
@@ -3265,6 +3269,10 @@ static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
 			return -EOPNOTSUPP;
 		kiocb_flags |= IOCB_NOIO;
 	}
+	if (flags & RWF_ATOMIC) {
+		if (!(ki->ki_filp->f_mode & FMODE_CAN_ATOMIC_WRITE))
+			return -EOPNOTSUPP;
+	}
 	kiocb_flags |= (__force int) (flags & RWF_SUPPORTED);
 	if (flags & RWF_SYNC)
 		kiocb_flags |= IOCB_DSYNC;
diff --git a/include/uapi/linux/fs.h b/include/uapi/linux/fs.h
index da43810b7485..1a5c68d31ef5 100644
--- a/include/uapi/linux/fs.h
+++ b/include/uapi/linux/fs.h
@@ -301,9 +301,12 @@ typedef int __bitwise __kernel_rwf_t;
 /* per-IO O_APPEND */
 #define RWF_APPEND	((__force __kernel_rwf_t)0x00000010)
 
+/* Atomic Write */
+#define RWF_ATOMIC	((__force __kernel_rwf_t)0x00000020)
+
 /* mask of flags supported by the kernel */
 #define RWF_SUPPORTED	(RWF_HIPRI | RWF_DSYNC | RWF_SYNC | RWF_NOWAIT |\
-			 RWF_APPEND)
+			 RWF_APPEND | RWF_ATOMIC)
 
 /* Pagemap ioctl */
 #define PAGEMAP_SCAN	_IOWR('f', 16, struct pm_scan_arg)
-- 
2.35.3