From: John Groves <John@groves.net>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: John Groves <jgroves@micron.com>,
Jonathan Corbet <corbet@lwn.net>,
Dan Williams <dan.j.williams@intel.com>,
Vishal Verma <vishal.l.verma@intel.com>,
Dave Jiang <dave.jiang@intel.com>,
Alexander Viro <viro@zeniv.linux.org.uk>,
Christian Brauner <brauner@kernel.org>, Jan Kara <jack@suse.cz>,
Matthew Wilcox <willy@infradead.org>,
linux-cxl@vger.kernel.org, linux-fsdevel@vger.kernel.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
nvdimm@lists.linux.dev, john@jagalactic.com,
Dave Chinner <david@fromorbit.com>,
Christoph Hellwig <hch@infradead.org>,
dave.hansen@linux.intel.com, gregory.price@memverge.com
Subject: Re: [RFC PATCH 07/20] famfs: Add include/linux/famfs_ioctl.h
Date: Fri, 23 Feb 2024 20:23:21 -0600 [thread overview]
Message-ID: <7onhdq4spd7mnkr5c443sbvnr7l4n34amtterg4soiey2qubyl@r2ppa6fsohnk> (raw)
In-Reply-To: <8f62b688-6c14-4eab-b039-7d9a112893f8@infradead.org>
On 24/02/23 05:39PM, Randy Dunlap wrote:
> Hi--
>
> On 2/23/24 09:41, John Groves wrote:
> > Add uapi include file for famfs. The famfs user space uses ioctl on
> > individual files to pass in mapping information and file size. This
> > would be hard to do via sysfs or other means, since it's
> > file-specific.
> >
> > Signed-off-by: John Groves <john@groves.net>
> > ---
> > include/uapi/linux/famfs_ioctl.h | 56 ++++++++++++++++++++++++++++++++
> > 1 file changed, 56 insertions(+)
> > create mode 100644 include/uapi/linux/famfs_ioctl.h
> >
> > diff --git a/include/uapi/linux/famfs_ioctl.h b/include/uapi/linux/famfs_ioctl.h
> > new file mode 100644
> > index 000000000000..6b3e6452d02f
> > --- /dev/null
> > +++ b/include/uapi/linux/famfs_ioctl.h
> > @@ -0,0 +1,56 @@
> > +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
> > +/*
> > + * famfs - dax file system for shared fabric-attached memory
> > + *
> > + * Copyright 2023-2024 Micron Technology, Inc.
> > + *
> > + * This file system, originally based on ramfs the dax support from xfs,
>
> This is confusing to me. Is it just me? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Thanks Randy. I think I was trying to say "based on ramfs *plus* the dax
support from xfs. But I'll try to come up with something more clear than
that...
>
> > + * is intended to allow multiple host systems to mount a common file system
> > + * view of dax files that map to shared memory.
> > + */
> > +#ifndef FAMFS_IOCTL_H
> > +#define FAMFS_IOCTL_H
> > +
> > +#include <linux/ioctl.h>
> > +#include <linux/uuid.h>
> > +
> > +#define FAMFS_MAX_EXTENTS 2
> > +
> > +enum extent_type {
> > + SIMPLE_DAX_EXTENT = 13,
> > + INVALID_EXTENT_TYPE,
> > +};
> > +
> > +struct famfs_extent {
> > + __u64 offset;
> > + __u64 len;
> > +};
> > +
> > +enum famfs_file_type {
> > + FAMFS_REG,
> > + FAMFS_SUPERBLOCK,
> > + FAMFS_LOG,
> > +};
> > +
> > +/**
>
> "/**" is used to begin kernel-doc comments, but this comment block is missing
> a few entries to make it be kernel-doc compatible. Please either add them
> or just use "/*" to begin the comment.
Will do, thanks. And I'll check the whole code base for other instances;
I won't be surprise if I was sloop about that in more than one place.
>
> > + * struct famfs_ioc_map
> > + *
> > + * This is the metadata that indicates where the memory is for a famfs file
> > + */
> > +struct famfs_ioc_map {
> > + enum extent_type extent_type;
> > + enum famfs_file_type file_type;
> > + __u64 file_size;
> > + __u64 ext_list_count;
> > + struct famfs_extent ext_list[FAMFS_MAX_EXTENTS];
> > +};
> > +
> > +#define FAMFSIOC_MAGIC 'u'
>
> This 'u' value should be documented in
> Documentation/userspace-api/ioctl/ioctl-number.rst.
>
> and if possible, you might want to use values like 0x5x or 0x8x
> that don't conflict with the ioctl numbers that are already used
> in the 'u' space.
Will do. I was trying to be too clever there, invoking "mu" for
micron.
>
> > +
> > +/* famfs file ioctl opcodes */
> > +#define FAMFSIOC_MAP_CREATE _IOW(FAMFSIOC_MAGIC, 1, struct famfs_ioc_map)
> > +#define FAMFSIOC_MAP_GET _IOR(FAMFSIOC_MAGIC, 2, struct famfs_ioc_map)
> > +#define FAMFSIOC_MAP_GETEXT _IOR(FAMFSIOC_MAGIC, 3, struct famfs_extent)
> > +#define FAMFSIOC_NOP _IO(FAMFSIOC_MAGIC, 4)
> > +
> > +#endif /* FAMFS_IOCTL_H */
>
> --
> #Randy
Thank you for taking the time to look it over, Randy.
John
next prev parent reply other threads:[~2024-02-24 2:23 UTC|newest]
Thread overview: 105+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-23 17:41 [RFC PATCH 00/20] Introduce the famfs shared-memory file system John Groves
2024-02-23 17:41 ` [RFC PATCH 01/20] famfs: Documentation John Groves
2024-02-23 17:41 ` [RFC PATCH 02/20] dev_dax_iomap: Add fs_dax_get() func to prepare dax for fs-dax usage John Groves
2024-02-26 12:05 ` Jonathan Cameron
2024-02-26 15:00 ` John Groves
2024-02-23 17:41 ` [RFC PATCH 03/20] dev_dax_iomap: Move dax_pgoff_to_phys from device.c to bus.c since both need it now John Groves
2024-02-26 12:10 ` Jonathan Cameron
2024-02-26 15:13 ` John Groves
2024-02-23 17:41 ` [RFC PATCH 04/20] dev_dax_iomap: Save the kva from memremap John Groves
2024-02-26 12:21 ` Jonathan Cameron
2024-02-26 15:48 ` John Groves
2024-02-23 17:41 ` [RFC PATCH 05/20] dev_dax_iomap: Add dax_operations for use by fs-dax on devdax John Groves
2024-02-26 12:32 ` Jonathan Cameron
2024-02-26 16:09 ` John Groves
2024-02-23 17:41 ` [RFC PATCH 06/20] dev_dax_iomap: Add CONFIG_DEV_DAX_IOMAP kernel build parameter John Groves
2024-02-26 12:34 ` Jonathan Cameron
2024-02-26 16:12 ` John Groves
2024-02-23 17:41 ` [RFC PATCH 07/20] famfs: Add include/linux/famfs_ioctl.h John Groves
2024-02-24 1:39 ` Randy Dunlap
2024-02-24 2:23 ` John Groves [this message]
2024-02-24 3:27 ` Randy Dunlap
2024-02-24 23:32 ` John Groves
2024-02-24 23:40 ` Randy Dunlap
2024-02-26 12:39 ` Jonathan Cameron
2024-02-26 16:44 ` John Groves
2024-02-26 16:56 ` Jonathan Cameron
2024-02-26 18:04 ` John Groves
2024-02-23 17:41 ` [RFC PATCH 08/20] famfs: Add famfs_internal.h John Groves
2024-02-26 12:48 ` Jonathan Cameron
2024-02-26 17:35 ` John Groves
2024-02-27 10:28 ` Jonathan Cameron
2024-02-28 1:06 ` John Groves
2024-02-27 13:38 ` Christian Brauner
2024-02-27 14:12 ` John Groves
2024-02-23 17:41 ` [RFC PATCH 09/20] famfs: Add super_operations John Groves
2024-02-26 12:51 ` Jonathan Cameron
2024-02-26 21:47 ` John Groves
2024-02-27 10:34 ` Jonathan Cameron
2024-02-27 17:48 ` John Groves
2024-02-23 17:41 ` [RFC PATCH 10/20] famfs: famfs_open_device() & dax_holder_operations John Groves
2024-02-26 12:56 ` Jonathan Cameron
2024-02-26 22:22 ` John Groves
2024-02-27 13:39 ` Christian Brauner
2024-02-27 18:38 ` John Groves
2024-02-23 17:41 ` [RFC PATCH 11/20] famfs: Add fs_context_operations John Groves
2024-02-26 13:20 ` Jonathan Cameron
2024-02-26 22:43 ` John Groves
2024-02-27 13:41 ` Christian Brauner
2024-02-28 0:59 ` John Groves
2024-02-28 1:49 ` Randy Dunlap
2024-02-28 8:17 ` Christian Brauner
2024-02-28 10:07 ` Christian Brauner
2024-02-28 12:01 ` Christian Brauner
2024-02-23 17:41 ` [RFC PATCH 12/20] famfs: Add inode_operations and file_system_type John Groves
2024-02-26 13:25 ` Jonathan Cameron
2024-02-26 22:53 ` John Groves
2024-02-23 17:41 ` [RFC PATCH 13/20] famfs: Add iomap_ops John Groves
2024-02-26 13:30 ` Jonathan Cameron
2024-02-26 23:00 ` John Groves
2024-02-23 17:41 ` [RFC PATCH 14/20] famfs: Add struct file_operations John Groves
2024-02-26 13:32 ` Jonathan Cameron
2024-02-26 23:09 ` John Groves
2024-02-23 17:41 ` [RFC PATCH 15/20] famfs: Add ioctl to file_operations John Groves
2024-02-26 13:44 ` Jonathan Cameron
2024-02-23 17:42 ` [RFC PATCH 16/20] famfs: Add fault counters John Groves
2024-02-23 18:23 ` Dave Hansen
2024-02-23 19:56 ` John Groves
2024-02-23 20:04 ` Dan Williams
2024-02-23 20:39 ` John Groves
2024-02-23 21:19 ` Dave Hansen
2024-02-23 23:50 ` Dan Williams
2024-02-24 3:59 ` Matthew Wilcox
2024-02-24 4:30 ` Dan Williams
2024-02-23 17:42 ` [RFC PATCH 17/20] famfs: Add module stuff John Groves
2024-02-26 13:47 ` Jonathan Cameron
2024-02-27 22:15 ` John Groves
2024-02-23 17:42 ` [RFC PATCH 18/20] famfs: Support character dax via the dev_dax_iomap patch John Groves
2024-02-26 13:52 ` Jonathan Cameron
2024-02-27 22:27 ` John Groves
2024-02-23 17:42 ` [RFC PATCH 19/20] famfs: Update MAINTAINERS file John Groves
2024-02-23 17:42 ` [RFC PATCH 20/20] famfs: Add Kconfig and Makefile plumbing John Groves
2024-02-24 1:50 ` Randy Dunlap
2024-02-24 2:24 ` John Groves
2024-02-24 0:07 ` [RFC PATCH 00/20] Introduce the famfs shared-memory file system Luis Chamberlain
2024-02-26 13:27 ` John Groves
2024-02-26 15:53 ` Luis Chamberlain
2024-02-26 21:16 ` John Groves
2024-02-27 0:58 ` Luis Chamberlain
2024-02-27 2:05 ` John Groves
2024-02-29 2:15 ` Dave Chinner
2024-02-29 14:52 ` John Groves
2024-03-11 1:29 ` Dave Chinner
2024-02-29 6:52 ` Amir Goldstein
2024-02-29 22:16 ` John Groves
2024-05-17 9:55 ` Miklos Szeredi
2024-05-19 5:59 ` Amir Goldstein
2024-05-22 2:05 ` John Groves
2024-05-22 8:58 ` Miklos Szeredi
2024-05-22 10:16 ` Amir Goldstein
2024-05-22 11:28 ` Miklos Szeredi
2024-05-22 13:41 ` Amir Goldstein
2024-05-23 2:49 ` John Groves
2024-05-23 13:57 ` Miklos Szeredi
2024-05-24 0:47 ` John Groves
2024-05-24 7:55 ` Miklos Szeredi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7onhdq4spd7mnkr5c443sbvnr7l4n34amtterg4soiey2qubyl@r2ppa6fsohnk \
--to=john@groves.net \
--cc=brauner@kernel.org \
--cc=corbet@lwn.net \
--cc=dan.j.williams@intel.com \
--cc=dave.hansen@linux.intel.com \
--cc=dave.jiang@intel.com \
--cc=david@fromorbit.com \
--cc=gregory.price@memverge.com \
--cc=hch@infradead.org \
--cc=jack@suse.cz \
--cc=jgroves@micron.com \
--cc=john@jagalactic.com \
--cc=linux-cxl@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=nvdimm@lists.linux.dev \
--cc=rdunlap@infradead.org \
--cc=viro@zeniv.linux.org.uk \
--cc=vishal.l.verma@intel.com \
--cc=willy@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).