Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:2 as permitted sender) client-ip=2620:137:e000::3:2;
From:   John Garry <john.g.garry@oracle.com>
To:     linux-kernel@vger.kernel.org, linux-api@vger.kernel.org
Cc:     martin.petersen@oracle.com, djwong@kernel.org, david@fromorbit.com,
        himanshu.madhani@oracle.com, John Garry <john.g.garry@oracle.com>
Subject: [PATCH 1/4] statx.2: Document STATX_WRITE_ATOMIC
Date:   Fri, 29 Sep 2023 09:37:14 +0000
Message-Id: <20230929093717.2972367-2-john.g.garry@oracle.com>
In-Reply-To: <20230929093717.2972367-1-john.g.garry@oracle.com>
References: <20230929093717.2972367-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?PZbnYSksUu0FJ9IF1aWl3u4+U2I3+/T8S3tsvC1ut3xs0e5A8CSnnK2JkHTD?=
 =?us-ascii?Q?BqNo2wPGpMdeEnn5BihJboJKYl+70cn0sfxJe2SDv1pKe8VrAhPiEF+MmTdG?=
 =?us-ascii?Q?65lWVReRb19PHat++o6/tkXiXfB9F/TUFChANgzrF3VGwM3ypiFZ1Ct6aIZx?=
 =?us-ascii?Q?oKJ9/SkJgSeTstF7lhpQhn5l6ndvUQSqKTl6QfOjUm096OSCW3yWPaNUwi+t?=
 =?us-ascii?Q?pvey0LTGujnSGEKpKwXZ+vA8of5C857t1WhtfPU3Pz1mp4TqIsVUk9XhAVBd?=
 =?us-ascii?Q?DR8iMqeQfUtWftbjH406ZkF41dBkc0yYkhRi6Ksc+z9wX1TLTS9diDYQXE/T?=
 =?us-ascii?Q?Q2YWJLp/B8IZwcv4JB1RRNWZXQs89l2c5NF+hYunbGE5VGTotMlXjnWdbvv7?=
 =?us-ascii?Q?91g/8gF3pcU4EGzgoq8+GgfbS20BWcu2/K/RuaBTf11lqUYYJrOx76wfCjh/?=
 =?us-ascii?Q?IS+pM6gM5feSgyIRjsudjibET30ePb2jA8j5ALDYeCNK5ITKStJbDrTb/COo?=
 =?us-ascii?Q?7rIqQbzjqr4ldLP4ebfLb71jQS649QabMv4r4r5/P4yNcfOZ0ZxLaWffJ2gc?=
 =?us-ascii?Q?l2HZrLiECxuctCvMkmlPFtS8tnLG9EbHiz9jtIO8D9PKXGZ5DKySQ2kMT+Qk?=
 =?us-ascii?Q?HDl6MM6D8XDPIeqeG5ZPNr/tGm1l3usg/GRKTKi9zSzfv9nZzm99pgT1fXoc?=
 =?us-ascii?Q?1N29YCSiPfZBWSVj9hGYc39o5BO37FEFiCOI3VNkKNdXLUGd0AgqolgWx6/H?=
 =?us-ascii?Q?P7xL7XuuEDFQrnUZMUFeVp+MlKkCX1U7J6eyMI4LvQUnSYAGPEe/UXxnnwJL?=
 =?us-ascii?Q?SKwMSiiJFWNTmzYcwxfQtMGFy2W2nU1Q22DF7FxReJnTGyn8m2lBgjorNudF?=
 =?us-ascii?Q?Ov+oMX+2dqSHAXD4uu8WsOltnAuREdpG3tTQogCyi5EfzXQR1yq24z6JEenw?=
 =?us-ascii?Q?lTEDC2Re8sSqDP6q5M1S1gZvLhUnt5/JbO1M7k9cUBL8ItTTX5irM+PTxFme?=
 =?us-ascii?Q?Ap10kuTdn1ZHCrSUVN8rGMsVNRfyMEF1iwYJcKJ/KnO1qT7f3plEUroKT5wi?=
 =?us-ascii?Q?NlbHkaRrjcxfofU7gmNWBBU4eowNlptUicf/8h9mdPdBxoiTw0K9Rz0FyBT7?=
 =?us-ascii?Q?1hc31pFDq1+oS+jbim7qMfaNSoZsKC+lcy6uzp1Gzda0kBILPkOtXSycXzbN?=
 =?us-ascii?Q?zgEbttrBKel4HE2nXpeuvtEkfbZs+DqBWyfpL+bBUappUUqZA8a/eOSNjoR2?=
 =?us-ascii?Q?otq2qkyD+rXdd1hvju8LclACKZOjjk6+2f2sKv8M1MwXLtK4s5DaTN7Ijq4I?=
 =?us-ascii?Q?TqWOEtlmKHnM1CxClAeLJSVfgkTfigkoSg1FpD9uwPQN+FmvMpP8pnmkkUpH?=
 =?us-ascii?Q?+FWW5WFsYNMu/71DQsE7U5jaVKG9yFRqh96U23Xe88ce1mpC5HB4M6wgfPEd?=
 =?us-ascii?Q?Uj1xufXJ4WewmYc2lJFJOGwTKNxNfc4OZQ7JJ45VA3fEt+WcQFFeBtRHs9IG?=
 =?us-ascii?Q?S4WTDeQvdzpokmZC24t5He1egUVL++OB+LFvLedAFHJhFsJr9ecclKfrGu3P?=
 =?us-ascii?Q?0d+AeG739kdkNO72iXRfUs9MkH2rd+BfBwdOGlTzYEi9ShdTXK8vckW95NM+?=
 =?us-ascii?Q?nw=3D=3D?=
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: jAnO+Arwn076xuHIKqBaAbEDuJfe9gYMu4NDO8WCWfCgryTRGgD4SluO61+4pd+HjCeIUYXJj1FkUkMimELKzQKMskbJNPzR6rGV5L452XDaUUeVWB+gTjH9eLZUyP0wG97/cPvGpjmJP6o1PXclNmtigewKgRHkCuIjgJoEryvX1wMSLuu0Rl2L4V0Ahv25MeQ3d53QnzvWEwqPI/JwD5F6igrQO0vNr7LZvD/p/dBHGx8st0Am4pxhxdUfMVwPhNFCQ1+E7xngoBhlQOM45tTetynzW2e+A7nIROTHUsqPk1EDhq6kAxFb0WSAVrhCPOkyHmSjGzbi9YC8D5kCf7CiesYmoKptEoRRFVuiDkMML8O0gzITnVC2gBc2PzLJ5TqwQXsjCR4XXiPkqj4wx4LOxxQ/cv4OhXAeWl40LI4/JKeqPTN9dVIpUEefPZC2yVdvpp3BQp5i5nObRNDgNQQYnu3ATDb9bIjOBFyFMCN54msdbCOGHyRQX0ASnlMKn3eqfxGY4NNJiwFyT6tVO1I7r6OlMW0ypgZGfLGAFLfR2mlsJ6HLvH0Tm7ojGjKWk0SU6euS9lrRh38I0zkOqE7WXUoykyFqYQAZYroSMg8eRvD3FCil0+b/d8ezmwjnkh/y36KcKes5VGN/z2CIhhgxEFoCjgVnanzKiJ85TmoacO4Pd/XXCrbhQr9z4e2Gjt8lH+neWGyXg7umMQS+00kePuQgofdQBGvQbl5xDlBN/Z1H6tBRvK4PS2Trg5q3cNrTM3CEBnLyJB8wF/pHo3pVH7GtOJTDQHg0vpou9Afni4lIQ34KWp5hz/q2IGfTlE1svTZ6VEEjqCfFacxYtA==
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 364669fd-2ab8-406b-7a35-08dbc0cfbde3
X-MS-Exchange-CrossTenant-AuthSource: DM6PR10MB4313.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 Sep 2023 09:37:48.0977
 (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: nPRRmzwNsNUo/s9zLIEJtqfXECbzApe8buO+L13ndSLrUEs5T3Q35bDr+FHSHbVUyfp0ehFYy/MP1+Rh/v7VhQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: IA1PR10MB7197
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.267,Aquarius:18.0.980,Hydra:6.0.619,FMLib:17.11.176.26
 definitions=2023-09-29_07,2023-09-28_03,2023-05-22_02
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 spamscore=0 bulkscore=0 mlxscore=0
 mlxlogscore=999 suspectscore=0 phishscore=0 adultscore=0 malwarescore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2309180000
 definitions=main-2309290083
X-Proofpoint-GUID: jZDlhSAZ5q83izRNtivGjaf8YAYYmVJk
X-Proofpoint-ORIG-GUID: jZDlhSAZ5q83izRNtivGjaf8YAYYmVJk
X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
	DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,
	SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no
	version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on agentk.vger.email
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 (agentk.vger.email [0.0.0.0]); Fri, 29 Sep 2023 02:39:10 -0700 (PDT)

From: Himanshu Madhani <himanshu.madhani@oracle.com>

Add the text to the statx man page.

Signed-off-by: Himanshu Madhani <himanshu.madhani@oracle.com>
Signed-off-by: John Garry <john.g.garry@oracle.com>
---
 man2/statx.2 | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/man2/statx.2 b/man2/statx.2
index bcc67c8e3bd3..23b9c6953ec5 100644
--- a/man2/statx.2
+++ b/man2/statx.2
@@ -68,6 +68,9 @@ struct statx {
     /* Direct I/O alignment restrictions */
     __u32 stx_dio_mem_align;
     __u32 stx_dio_offset_align;
+\&
+    __u32 stx_atomic_write_unit_max;
+    __u32 stx_atomic_write_unit_min;
 };
 .EE
 .in
@@ -255,6 +258,8 @@ STATX_ALL	The same as STATX_BASIC_STATS | STATX_BTIME.
 STATX_MNT_ID	Want stx_mnt_id (since Linux 5.8)
 STATX_DIOALIGN	Want stx_dio_mem_align and stx_dio_offset_align
 	(since Linux 6.1; support varies by filesystem)
+STATX_WRITE_ATOMIC	Want stx_atomic_write_unit_min and stx_atomic_write_unit_max
+	(since Linux 6.7; support varies by filesystem)
 .TE
 .in
 .PP
@@ -439,6 +444,16 @@ or 0 if direct I/O is not supported on this file.
 This will only be nonzero if
 .I stx_dio_mem_align
 is nonzero, and vice versa.
+.TP
+.I stx_atomic_write_unit_min
+The minimum size (in bytes) supported for direct I/O
+.RB ( O_DIRECT )
+on the file to be written with torn-write protection. This value is guaranteed to be power-of-2.
+.TP
+.I stx_atomic_write_unit_max
+The maximum size (in bytes) supported for direct I/O
+.RB ( O_DIRECT )
+on the file to be written with torn-write protection. This value is guaranteed to be power-of-2.
 .PP
 For further information on the above fields, see
 .BR inode (7).
@@ -492,6 +507,9 @@ It cannot be written to, and all reads from it will be verified
 against a cryptographic hash that covers the
 entire file (e.g., via a Merkle tree).
 .TP
+.BR STATX_ATTR_WRITE_ATOMIC " (since Linux 6.7)"
+The file supports torn-write protection.
+.TP
 .BR STATX_ATTR_DAX " (since Linux 5.8)"
 The file is in the DAX (cpu direct access) state.
 DAX state attempts to
-- 
2.31.1