From patchwork Tue Jul 9 18:31:23 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Josef Bacik X-Patchwork-Id: 13728419 Received: from mail-qt1-f174.google.com (mail-qt1-f174.google.com [209.85.160.174]) (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 6DFFF18003E for ; Tue, 9 Jul 2024 18:31:49 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.160.174 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720549910; cv=none; b=AiHxTcutTLFdnJ4jwfYZwHI4b1MNePvFPgCMljRsMkXC4nMEASf2/R4fBW2rq9g/uw2USzOPXc6k7/c2SVhWGl0Ac+tCeaHGXnSiTjQMtiX38nKxagpDb/QLHOkg0Q5WuKC0YK5a254Y7TK8lOC6VdnArnmpnx/gExGr4ghsBKA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720549910; c=relaxed/simple; bh=+ybtD3rMW9x9U4NvEo/lnHiCh/HjbONJxCdCw6p9SDo=; h=From:To:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=ZJw2VDKdsXisbrdz/t/Dxt/evbNy2qVqlw4Xc19pD18Yf0TsidN0gI8kbEov61eE34o04spP5Q8RXgaTLnBzlaQgcK94GZHle3Qx2DpvqUdijoM2/W/xtw64qs5Uxoi15UjXaLp85d4Z/b4WvdmTQzfsZtcM2w2w7U9CK7iY0Jw= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=toxicpanda.com; spf=none smtp.mailfrom=toxicpanda.com; dkim=pass (2048-bit key) header.d=toxicpanda-com.20230601.gappssmtp.com header.i=@toxicpanda-com.20230601.gappssmtp.com header.b=oAXoGyvn; arc=none smtp.client-ip=209.85.160.174 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=toxicpanda.com Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=toxicpanda.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=toxicpanda-com.20230601.gappssmtp.com header.i=@toxicpanda-com.20230601.gappssmtp.com header.b="oAXoGyvn" Received: by mail-qt1-f174.google.com with SMTP id d75a77b69052e-444fdb6c1cfso36213531cf.3 for ; Tue, 09 Jul 2024 11:31:49 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=toxicpanda-com.20230601.gappssmtp.com; s=20230601; t=1720549908; x=1721154708; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=kmv1mjjvcYUl96SA0qF10FvJXvlumaF/KianBCDo0wM=; b=oAXoGyvn/1HEXF9VMmZGzuRW2Y8K8P/pbbmL93LwNNDFU3PatqkrD/3gMyq2oa5oRC lyrYYDtIbSFnrJHGpGtTRLQLVcSDFCFjDyJHJwJYXNcbYryDq8ZcPWBSQynloYCFPRUG KdSnnJH/tplQIiRXyzyttGCDMbgQ2eAAl5zVIVDKAOJDijRZlPpxoTMLki/Rq2iHT/On qEPgdBtI8xBx2JDYwBQkQfYs2+98AoTIhJD5z3zUesZ5/dYNViaSSvDQt5JMC8M27ugt xdDOKPmRMVOFCmTadC+zrIwiKq2hG3QNDnJAMtXpP0F4IUnBRqMGMgjHnVy6C5sK7E7T HFqA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720549908; x=1721154708; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=kmv1mjjvcYUl96SA0qF10FvJXvlumaF/KianBCDo0wM=; b=mKulet3lRdSqFN4GB+qincXtK8mWsPkJrXod+natnR1jZ+jIVzF0HEPqIYsD4sGvUB ctQYAah0Np3AzywqDJiMwKmJZkK4+EWhXdZTYRgQS6u/zwFY6aA+d/j/dQCZooGK1i6y sYrPhNIPjR+wsY0K3nvy7jdZYbi0846tgTip1h7NDuexKB1shu/394uML2lKUZcRNfhd 22LCamR+Xtj6FneWLV+EWjqNpEdD54cJGIPADjsu9kOWeFGemqp0mNPqFE3mgsrI98ws uwUCVL2jSj+4DLIFFizoPEcR7eheApMwz32gjjLu8DIKnqCKvJqpatb/cDeOKxFzgLai b2aQ== X-Forwarded-Encrypted: i=1; AJvYcCXqq3ojQLMTV9vdn9aDY8JdXSnWLZfm5OOY49L6v3G1I++yd9CNym5K2JdXo99lNzkWOWNUV8U/UYaJzNps581TS+OAS6fUpSvms9IEgg== X-Gm-Message-State: AOJu0YwUZy6CIpNL3sggcmrUKWNUJv6q5dyulYgu0/EjRPy6Da2MatEd Wathn/DxxwyPmtBa8LPfIxnRre4b1XKDzxcP5hb5rihWr6uJaY/NGdQ77SHeVBY= X-Google-Smtp-Source: AGHT+IHwHbMvPEG+jjklGKP7Cp+EsbiS/jg4Nma8VIZ1FJkn9fWGoOKV8ISChPbVE9wOQk+cHIvVrA== X-Received: by 2002:a05:6214:20a7:b0:6b5:83bb:11b5 with SMTP id 6a1803df08f44-6b61bc8472bmr42991446d6.9.1720549908267; Tue, 09 Jul 2024 11:31:48 -0700 (PDT) Received: from localhost (syn-076-182-020-124.res.spectrum.com. [76.182.20.124]) by smtp.gmail.com with ESMTPSA id 6a1803df08f44-6b61ba1587asm10915786d6.70.2024.07.09.11.31.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 Jul 2024 11:31:47 -0700 (PDT) From: Josef Bacik To: alx@kernel.org, linux-man@vger.kernel.org, brauner@kernel.org, linux-fsdevel@vger.kernel.org, mszeredi@redhat.com, kernel-team@fb.com Subject: [PATCH v6 2/2] listmount.2: New page describing the listmount syscall Date: Tue, 9 Jul 2024 14:31:23 -0400 Message-ID: <2d72a44fa49f47bd7258d7efb931926b26de4004.1720549824.git.josef@toxicpanda.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-fsdevel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Add some documentation for the new listmount syscall. Signed-off-by: Josef Bacik --- man/man2/listmount.2 | 112 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 112 insertions(+) create mode 100644 man/man2/listmount.2 diff --git a/man/man2/listmount.2 b/man/man2/listmount.2 new file mode 100644 index 000000000..212929fb6 --- /dev/null +++ b/man/man2/listmount.2 @@ -0,0 +1,112 @@ +.\" Copyright (c) 2024 Josef Bacik +.\" +.\" SPDX-License-Identifier: Linux-man-pages-copyleft +.\" +.TH listmount 2 (date) "Linux man-pages (unreleased)" +.SH NAME +listmount \- get a list of mount ID's +.SH LIBRARY +Standard C library +.RI ( libc ", " \-lc ) +.SH SYNOPSIS +.nf +.BR "#include " " /* Definition of struct mnt_id_req constants */" +.B #include +.P +.BI "int syscall(SYS_listmount, struct mnt_id_req * " req , +.BI " u64 * " mnt_ids ", size_t " nr_mnt_ids , +.BI " unsigned long " flags ); +.P +.B #include +.P +.B struct mnt_id_req { +.BR " __u32 size;" " /* sizeof(struct mnt_id_req) */" +.BR " __u64 mnt_id;" " /* The parent mnt_id being searched */" +.BR " __u64 param;" " /* The next mnt_id we want to find */" +.B }; +.fi +.P +.IR Note : +glibc provides no wrapper for +.BR listmount (), +necessitating the use of +.BR syscall (2). +.SH DESCRIPTION +To access the mounts in your namespace, +you must have CAP_SYS_ADMIN in the user namespace. +.P +This function returns a list of mount IDs under the +.BR req.mnt_id . +This is meant to be used in conjuction with +.BR statmount (2) +in order to provide a way to iterate and discover mounted file systems. +.SS The mnt_id_req structure +.I req.size +is used by the kernel to determine which struct +.I mnt_id_req +is being passed in, +it should always be set to sizeof(struct mnt_id req). +.P +.I req.mnt_id +is the parent mnt_id that we will list from, +which can either be +.B LSMT_ROOT +which means the root mount of the current mount namespace, +or a mount ID obtained from either +.BR statx (2) +using +.B STATX_MNT_ID_UNIQUE +or from +.BR listmount (2) . +.P +.I req.param +is used to tell the kernel what mount ID to start the list from. +This is useful if multiple calls to +.BR listmount (2) +are required. +This can be set to the last mount ID returned + 1 in order to +resume from a previous spot in the list. +.SH RETURN VALUE +On success, the number of entries filled into +.I mnt_ids +is returned, 0 if there are no more mounts left. +On error, \-1 is returned, and +.I errno +is set to indicate the error. +.SH ERRORS +.TP +.B EPERM +Permission is denied for accessing this mount. +.TP +.B EFAULT +.I req +or +.I mnt_ids +points to a location outside the process's accessible +address space. +.TP +.B EINVAL +Invalid flag specified in +.IR flags . +.TP +.B EINVAL +.I req +is of insufficient size to be utilized. +.TP +.B E2BIG +.I req +is too large, +the limit is the architectures page size. +.TP +.B ENOENT +The specified +.I req.mnt_id +doesn't exist. +.TP +.B ENOMEM +Out of memory (i.e., kernel memory). +.SH STANDARDS +Linux. +.SH SEE ALSO +.BR statmount (2), +.BR statx (2)