From nobody Wed Oct 8 02:04:52 2025 Received: from mail-oa1-f51.google.com (mail-oa1-f51.google.com [209.85.160.51]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 2F54E2F94A7; Thu, 3 Jul 2025 18:51:41 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.160.51 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751568704; cv=none; b=t5uW9afaBlzauWU7FE2jMW6p9muG37lZEyf3sAm3V5vxnYkfLoyOnW+rst6O9VKIbA96mEBZkvSvOFJDXV8lhVXYSiskeHcwaUtvjlEqw++76DGKKPRT3IR3Pyj8uBYSIumBDAqbbOKIToYS3tdoe7z8V8YK/T0+ii77TcdvD7w= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751568704; c=relaxed/simple; bh=2GAozt3GI52rhisyuFm59adRbnyMvu8uPfkVdb4WXbo=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=XP5ft2FZdU3E7I85FK9Bp6tGn2GdD/xLpLvOpr3e/Yrk1g5BVf0F248qftY30tThvspXBff79cmaMhZ1z2y4YRyNRQ6+TLAy3ryvWQoGCfqJIHrjpnSEybUG7H80kyici6gqSOcf3BvHiLlhSJynsfx4zEoGWJSHKNOY89CRZUo= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=Groves.net; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=Xou/obCu; arc=none smtp.client-ip=209.85.160.51 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=Groves.net Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="Xou/obCu" Received: by mail-oa1-f51.google.com with SMTP id 586e51a60fabf-2ea080f900cso82302fac.2; Thu, 03 Jul 2025 11:51:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1751568701; x=1752173501; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:sender:from:to:cc:subject:date :message-id:reply-to; bh=kk7l0GfRD3h+I6lOGqS5B01ZAdefY7DdGtDZDmtpdlE=; b=Xou/obCuVVLFMEBeXWLXeJOZVN49NFOmZmnM4ZdpOZ35swNumJw0LLJ4on/MuZi6S+ gICUhcKhnvvEgZn3vsgqwMryICPLhZHWr8qR9Hm7Wt2paQebJmc/i+MlNbsdgVhISJPS UoHIGlAgcqZ9E4P2nGwFFWp8V4CNRL9tB5Q116X+9S5Gt+hrcbA3i7GZa+/0eDrBnZvF OA4Wx6EDOzrTfA67cKhjUCqh60iA4hbh6rjwFX4bSjw10HznrO4d0J7kjvMQ3lrNCvCl HWpu5sgIvlIXCM7RxolTSinETLJEF/IfaDbkhUdsnm0ahLzZxkvUFnZ22V4O8G4XS1hQ 31mg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1751568701; x=1752173501; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:sender:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=kk7l0GfRD3h+I6lOGqS5B01ZAdefY7DdGtDZDmtpdlE=; b=s9OFtsyfqHPVOcZFIktdQSu2QVbPsO2z6wigjUPLDE5pQqzZdlyQffv7FOR2CTBZ03 n4CIek3IcZlfkfrLPOlx9ZB/qe394EbtYLeFneiV0Upi/o9I5cUDSg19CLJJ8hZvM9va PiE+KCniprAJ+byEsfkMSW2sXorJ00isSg9IiqJXCrAASlN2mPufazU48rmguNhNLYRJ aw4EjR/9RqkBT8U0ba6igenCk/p3Y4yeCeA9umWt/GOVzgl3vecNZNzFMx7pV5I8sch4 CD2eievXz/+7Vf200oeNpIqqkWiKXP6F6bOU+LB1j16shSwatlthUfftcRlyhqwqaiEI 3TRQ== X-Forwarded-Encrypted: i=1; AJvYcCVS4rgzQpMIKUzDgMN4AMDzaWod6BrvzAoKdyT4s0vx64E/JQYzdjZQGmGxABRrSw5O6zwmhXR9m/yQWUj1CQ==@vger.kernel.org, AJvYcCW9EMjY4OWjLiti0bmvfx7RqSQhdVsVWFMq6+R514EEHewjyv3ruggkQQR4QoX2lIgJV2N5QolnadKg@vger.kernel.org, AJvYcCWM/n/SJ2X8WXT8CgCQXFLu5LM6RNiYpT4LluHVEJ1Y1hRyUIDgG3OjAePqQdy8UYvzsqsJse3I0X4=@vger.kernel.org, AJvYcCWqWwbLKRnsNAWCrkxxeHn2mcuggsSXKuAhrdXsk/qMlv/LrumuFA5EeyItS3KWFjzTCVVfg4t0uWNM/ieb@vger.kernel.org X-Gm-Message-State: AOJu0YxDZbbprWlpKFNcwzgxOtu4A+DS+1RxrrKI1Q4hzhO3tFYcXfz0 dBzug5sLPUC74agd3e+m0pkxpQwwvm4qJOMENiGFkeNdUlCB+YeO8Ch7 X-Gm-Gg: ASbGncuE3QcISYzFAz5JF6oE3wNkTFnakPMTPBcn9NKMkG47sxe0xdtnPaV2Are/NrA xIiyiQLqWySk89pcDodVHtpmbhkDMr4H1xbD+V5GqU9NdhiW60vMp2JXzCTo4qsUuOnPJgU05Pl 9aiBnE4Gal5AnT/JcjVDZtvi4zB/pqZRdZDrsVOBYqZXhJGSfz9R/gRu544Akv54uZXCoYybztJ jL4TcDHVAK3QBdznOKHoKrbPfyUoqECtP44pJAJj2G9F4DUkJPIQL5Az6u6C2SBRhwstwGpScF2 Lzu9xhmPa4ShE0PZyy5Q8WAKZEKRI2UEfXt9w1iXbDHKdi2angNOx8ZAWetaZhQcuyCJnezx9sK AkO1hdXXA9IHlPNJ7qCgrFFYq X-Google-Smtp-Source: AGHT+IGyynocoCnJ7HhmXu2ub5GrunKuCD0K0j7iMXpe886ZyEto3OHXwpTDbVj7W1yPxb0He4yvEQ== X-Received: by 2002:a05:6871:454:b0:2e8:eccb:fe1c with SMTP id 586e51a60fabf-2f76ca3651cmr3726270fac.31.1751568700979; Thu, 03 Jul 2025 11:51:40 -0700 (PDT) Received: from localhost.localdomain ([2603:8080:1500:3d89:cd4:2776:8c4a:3597]) by smtp.gmail.com with ESMTPSA id 46e09a7af769-73c9f90d1ccsm68195a34.44.2025.07.03.11.51.38 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Thu, 03 Jul 2025 11:51:40 -0700 (PDT) Sender: John Groves From: John Groves X-Google-Original-From: John Groves To: John Groves , Dan Williams , Miklos Szeredi , Bernd Schubert Cc: John Groves , Jonathan Corbet , Vishal Verma , Dave Jiang , Matthew Wilcox , Jan Kara , Alexander Viro , Christian Brauner , "Darrick J . Wong" , Randy Dunlap , Jeff Layton , Kent Overstreet , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, nvdimm@lists.linux.dev, linux-cxl@vger.kernel.org, linux-fsdevel@vger.kernel.org, Amir Goldstein , Jonathan Cameron , Stefan Hajnoczi , Joanne Koong , Josef Bacik , Aravind Ramesh , Ajay Joshi , John Groves Subject: [RFC V2 18/18] famfs_fuse: Add documentation Date: Thu, 3 Jul 2025 13:50:32 -0500 Message-Id: <20250703185032.46568-19-john@groves.net> X-Mailer: git-send-email 2.39.5 (Apple Git-154) In-Reply-To: <20250703185032.46568-1-john@groves.net> References: <20250703185032.46568-1-john@groves.net> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add Documentation/filesystems/famfs.rst and update MAINTAINERS Signed-off-by: John Groves Reviewed-by: Randy Dunlap Tested-by: Randy Dunlap --- Documentation/filesystems/famfs.rst | 142 ++++++++++++++++++++++++++++ Documentation/filesystems/index.rst | 1 + MAINTAINERS | 1 + 3 files changed, 144 insertions(+) create mode 100644 Documentation/filesystems/famfs.rst diff --git a/Documentation/filesystems/famfs.rst b/Documentation/filesystem= s/famfs.rst new file mode 100644 index 000000000000..0d3c9ba9b7a8 --- /dev/null +++ b/Documentation/filesystems/famfs.rst @@ -0,0 +1,142 @@ +.. SPDX-License-Identifier: GPL-2.0 + +.. _famfs_index: + +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +famfs: The fabric-attached memory file system +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +- Copyright (C) 2024-2025 Micron Technology, Inc. + +Introduction +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Compute Express Link (CXL) provides a mechanism for disaggregated or +fabric-attached memory (FAM). This creates opportunities for data sharing; +clustered apps that would otherwise have to shard or replicate data can +share one copy in disaggregated memory. + +Famfs, which is not CXL-specific in any way, provides a mechanism for +multiple hosts to concurrently access data in shared memory, by giving it +a file system interface. With famfs, any app that understands files can +access data sets in shared memory. Although famfs supports read and write, +the real point is to support mmap, which provides direct (dax) access to +the memory - either writable or read-only. + +Shared memory can pose complex coherency and synchronization issues, but +there are also simple cases. Two simple and eminently useful patterns that +occur frequently in data analytics and AI are: + +* Serial Sharing - Only one host or process at a time has access to a file +* Read-only Sharing - Multiple hosts or processes share read-only access + to a file + +The famfs fuse file system is part of the famfs framework; user space +components [1] handle metadata allocation and distribution, and provide a +low-level fuse server to expose files that map directly to [presumably +shared] memory. + +The famfs framework manages coherency of its own metadata and structures, +but does not attempt to manage coherency for applications. + +Famfs also provides data isolation between files. That is, even though +the host has access to an entire memory "device" (as a devdax device), apps +cannot write to memory for which the file is read-only, and mapping one +file provides isolation from the memory of all other files. This is pretty +basic, but some experimental shared memory usage patterns provide no such +isolation. + +Principles of Operation +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Famfs is a file system with one or more devdax devices as a first-class +backing device(s). Metadata maintenance and query operations happen +entirely in user space. + +The famfs low-level fuse server daemon provides file maps (fmaps) and +devdax device info to the fuse/famfs kernel component so that +read/write/mapping faults can be handled without up-calls for all active +files. + +The famfs user space is responsible for maintaining and distributing +consistent metadata. This is currently handled via an append-only +metadata log within the memory, but this is orthogonal to the fuse/famfs +kernel code. + +Once instantiated, "the same file" on each host points to the same shared +memory, but in-memory metadata (inodes, etc.) is ephemeral on each host +that has a famfs instance mounted. Use cases are free to allow or not +allow mutations to data on a file-by-file basis. + +When an app accesses a data object in a famfs file, there is no page cache +involvement. The CPU cache is loaded directly from the shared memory. In +some use cases, this is an enormous reduction read amplification compared +to loading an entire page into the page cache. + + +Famfs is Not a Conventional File System +--------------------------------------- + +Famfs files can be accessed by conventional means, but there are +limitations. The kernel component of fuse/famfs is not involved in the +allocation of backing memory for files at all; the famfs user space +creates files and responds as a low-level fuse server with fmaps and +devdax device info upon request. + +Famfs differs in some important ways from conventional file systems: + +* Files must be pre-allocated by the famfs framework; allocation is never + performed on (or after) write. +* Any operation that changes a file's size is considered to put the file + in an invalid state, disabling access to the data. It may be possible to + revisit this in the future. (Typically the famfs user space can restore + files to a valid state by replaying the famfs metadata log.) + +Famfs exists to apply the existing file system abstractions to shared +memory so applications and workflows can more easily adapt to an +environment with disaggregated shared memory. + +Memory Error Handling +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Possible memory errors include timeouts, poison and unexpected +reconfiguration of an underlying dax device. In all of these cases, famfs +receives a call from the devdax layer via its iomap_ops->notify_failure() +function. If any memory errors have been detected, access to the affected +daxdev is disabled to avoid further errors or corruption. + +In all known cases, famfs can be unmounted cleanly. In most cases errors +can be cleared by re-initializing the memory - at which point a new famfs +file system can be created. + +Key Requirements +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The primary requirements for famfs are: + +1. Must support a file system abstraction backed by sharable devdax memory +2. Files must efficiently handle VMA faults +3. Must support metadata distribution in a sharable way +4. Must handle clients with a stale copy of metadata + +The famfs kernel component takes care of 1-2 above by caching each file's +mapping metadata in the kernel. + +Requirements 3 and 4 are handled by the user space components, and are +largely orthogonal to the functionality of the famfs kernel module. + +Requirements 3 and 4 cannot be met by conventional fs-dax file systems +(e.g. xfs) because they use write-back metadata; it is not valid to mount +such a file system on two hosts from the same in-memory image. + + +Famfs Usage +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Famfs usage is documented at [1]. + + +References +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +- [1] Famfs user space repository and documentation + https://github.com/cxl-micron-reskit/famfs diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystem= s/index.rst index 2636f2a41bd3..5aad315206ee 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -90,6 +90,7 @@ Documentation for filesystem implementations. ext3 ext4/index f2fs + famfs gfs2 gfs2-uevents gfs2-glocks diff --git a/MAINTAINERS b/MAINTAINERS index 02688f27a4d0..faa7de4a43de 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -8814,6 +8814,7 @@ M: John Groves L: linux-cxl@vger.kernel.org L: linux-fsdevel@vger.kernel.org S: Supported +F: Documentation/filesystems/famfs.rst F: fs/fuse/famfs.c F: fs/fuse/famfs_kfmap.h =20 --=20 2.49.0