From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-ot1-f68.google.com (mail-ot1-f68.google.com [209.85.210.68]) (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 4F6AE38E128 for ; Wed, 14 Jan 2026 21:42:42 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.68 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1768426983; cv=none; b=RvSbrp8UFYJnfsfIVFNHWnH4vm/wokp6rPUDvPec9ziENkKlI9Q3+n0JrsOVBGgre8borHPzeG9UXVsHz+3QE4ViZunywal4UxLetKLlkUGDKMWgfLYS5wWMOLmYfTqk6nftwcoJcm7nHf9qzS18ooeqW+A0Ts2+JyShvofROHs= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1768426983; c=relaxed/simple; bh=P4J7niyHS51xHp1Q12pZ0X0vf1nlssirOmBCP6cbZ64=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=daRM4/7h7foLcIUa1KW4l+2rhY8qDXAQTxFZTy/jztmCj57msTondjOACam4aTXzr3Ba+WU+d+8ol3/VvORWXqB+ZgNWbE/KhdPMlwiVz5ubaWgU9j//aBcC7NLnYkz4fCspToQxnX1Sy7EmIadzUAoHKECY40gjn0nXBj3oAF4= 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=B07gobi4; arc=none smtp.client-ip=209.85.210.68 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="B07gobi4" Received: by mail-ot1-f68.google.com with SMTP id 46e09a7af769-7cdf7529bb2so173084a34.2 for ; Wed, 14 Jan 2026 13:42:42 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1768426958; x=1769031758; 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=laJJpvpihQ20m2JOTCcWi2X4Dot3SA9OG2LQvA/I7VM=; b=B07gobi4Py45kfcflPcaBfBuXUqerKnQ1T+2ax11FlxbDl3sTTT0iGO+/xEuwJgUm8 FgNWk1SK2tJS1pW7SN6e3XREubW1fdK/BUuR7xRJ/81ETDeLP8C7D6o8ajeUz0OXo7cX 8hGIFoXcEeyrzbIM7uYSfqN/wSMDsZ4mjM66SKgIaYJEPjRrLqpuNSH2L8EcnV8cfHUE BodLKPc3bMCJLqEclNfExQxA2NA+sYKKc5f5mto004/ew04Z1OFdUJ+lrNcQogQGIRpf bw3E3eFpPfP88LqsJs5kn4OpoPxRD2fzt2KunUJjRCdFtbW359WDtjc7Mbstqg0eUTV2 20dA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1768426958; x=1769031758; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:sender:x-gm-gg :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=laJJpvpihQ20m2JOTCcWi2X4Dot3SA9OG2LQvA/I7VM=; b=RYvq7U5eaWfBX4UhiHll12ELJ4Z6jZN3aq741tEWFNWKXXh4tCtiFV5bsu1p/9bFK6 v/2wjucxBFeD7YBf1W5YizyAhpEp0kEHH6PjnQ32cYNSLGWhL/Sm/Y8PYcb+5qDZmRIT CAlInsAd2qNycP+9+uQKY1a04oeQL7jTAXhWrzc0WqDdT+zlfUN+/ssvmCHSXDpEOiR1 XyCY1jh2k9GTqjibX2BsCAIXU9YqlSOnLQ29wxNgH9hKgjH3zSYagEvbD4E+rCtkrp6l ik1VTMMCY/+qPTzjKodvuU1yUhXGmSuRL+0eTUXTxunLgic0VRzHEboa34+Vp5Ezzkw5 c40g== X-Forwarded-Encrypted: i=1; AJvYcCVPMOrj0LgxZkqCe/l8CN7/1ol+Jc8t9Z//uUknwg69bKR+d6WfhNn9/WhajMizgiIJ5DNMMncZHXRqCxs=@vger.kernel.org X-Gm-Message-State: AOJu0Yy1xDQxNnZq/I8OahPcEpEKRYzWifX6nC2XKNgM5YBcP6FHP0v+ ZZcBlRv5t1VpgO/dPjsvSS55wtFf1UZoTczHO2x56O+ranJ9GF5yMiaD X-Gm-Gg: AY/fxX4gEC6Xevb1H4K4OItqXjRbO5rDpQJr1DLXFLr/dhifIxXRUyUJj5KeGpd6gse 7Q25tH8sV3e4eCqV3CdJZ4NbQahzEjvLs2P/QYgiZ6BMv56jVfe2ndbRPy9VWWL6yYwJjheUb4P pQsAcl9bHnTc1bw1ae7c1ShRRg9QM2ANQJDw/hYew34C0ovMr9I6SGBunM8+UqrfViH4nVmHGmw JOJE7SX+7jOxfD2s9C5LttsrgHuNoxO7hNR8zQH8PgnkaNr+C5Oi6DpdE27qh94R0YbPFFQUCG2 EmS/UTWZTZsRFS3gChtjIoIZ1dO8N+lldIM3FlBA+URIg7ypxE/bkzBghMl2iwDz+dIoFC7sBge zved5gFGSAsvAg23hudc7T8Wfh4qUrjO6CVmhnanUaaYNxEVnhf0i+Yf/L2w2pA37SRiDXW/1rO wz70/DXAUHjKNhUXjKXZH+FsmE6z4xhkSiRdZkj+eTwoBv X-Received: by 2002:a05:6830:4124:b0:7cf:d191:3a76 with SMTP id 46e09a7af769-7cfd1913d41mr1096939a34.2.1768426957561; Wed, 14 Jan 2026 13:42:37 -0800 (PST) Received: from localhost.localdomain ([2603:8080:1500:3d89:4c85:2962:e438:72c4]) by smtp.gmail.com with ESMTPSA id 46e09a7af769-7cfcc8428fesm2063248a34.0.2026.01.14.13.42.35 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 14 Jan 2026 13:42:37 -0800 (PST) Sender: John Groves From: John Groves X-Google-Original-From: John Groves To: John Groves , Miklos Szeredi , Dan Williams , Bernd Schubert , Alison Schofield Cc: John Groves , Jonathan Corbet , Vishal Verma , Dave Jiang , Matthew Wilcox , Jan Kara , Alexander Viro , David Hildenbrand , Christian Brauner , "Darrick J . Wong" , Randy Dunlap , Jeff Layton , Amir Goldstein , Jonathan Cameron , Stefan Hajnoczi , Joanne Koong , Josef Bacik , Bagas Sanjaya , James Morse , Fuad Tabba , Sean Christopherson , Shivank Garg , Ackerley Tng , Gregory Price , Aravind Ramesh , Ajay Joshi , venkataravis@micron.com, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, nvdimm@lists.linux.dev, linux-cxl@vger.kernel.org, linux-fsdevel@vger.kernel.org Subject: [PATCH V4 19/19] famfs_fuse: Add documentation Date: Wed, 14 Jan 2026 15:32:06 -0600 Message-ID: <20260114213209.29453-20-john@groves.net> X-Mailer: git-send-email 2.52.0 In-Reply-To: <20260114213209.29453-1-john@groves.net> References: <20260114153133.29420.compound@groves.net> <20260114213209.29453-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: 8bit Add Documentation/filesystems/famfs.rst and update MAINTAINERS Reviewed-by: Randy Dunlap Tested-by: Randy Dunlap Reviewed-by: Jonathan Cameron Signed-off-by: John Groves --- 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/filesystems/famfs.rst new file mode 100644 index 000000000000..bf0c0e6574bb --- /dev/null +++ b/Documentation/filesystems/famfs.rst @@ -0,0 +1,142 @@ +.. SPDX-License-Identifier: GPL-2.0 + +.. _famfs_index: + +================================================================== +famfs: The fabric-attached memory file system +================================================================== + +- Copyright (C) 2024-2026 Micron Technology, Inc. + +Introduction +============ +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 +======================= + +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 +===================== + +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 +================ + +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 +=========== + +Famfs usage is documented at [1]. + + +References +========== + +- [1] Famfs user space repository and documentation + https://github.com/cxl-micron-reskit/famfs diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index f4873197587d..e6fb467c1680 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -89,6 +89,7 @@ Documentation for filesystem implementations. ext3 ext4/index f2fs + famfs gfs2/index hfs hfsplus diff --git a/MAINTAINERS b/MAINTAINERS index 6f8a7c813c2f..43141ee4fd4e 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -10385,6 +10385,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 -- 2.52.0