From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.5 required=3.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED,DKIM_INVALID,DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id B7A90C433E0 for ; Fri, 29 Jan 2021 07:03:50 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 0B61B60234 for ; Fri, 29 Jan 2021 07:03:49 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 0B61B60234 Authentication-Results: mail.kernel.org; dmarc=fail (p=reject dis=none) header.from=google.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id 4A7A56B0005; Fri, 29 Jan 2021 02:03:49 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 42ECC6B006C; Fri, 29 Jan 2021 02:03:49 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 282926B0071; Fri, 29 Jan 2021 02:03:49 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0034.hostedemail.com [216.40.44.34]) by kanga.kvack.org (Postfix) with ESMTP id 0D2F66B0005 for ; Fri, 29 Jan 2021 02:03:49 -0500 (EST) Received: from smtpin10.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay04.hostedemail.com (Postfix) with ESMTP id C76341EF2 for ; Fri, 29 Jan 2021 07:03:48 +0000 (UTC) X-FDA: 77757922536.10.yard64_5a0f260275a6 Received: from filter.hostedemail.com (10.5.16.251.rfc1918.com [10.5.16.251]) by smtpin10.hostedemail.com (Postfix) with ESMTP id 99AEE16A4BA for ; Fri, 29 Jan 2021 07:03:48 +0000 (UTC) X-HE-Tag: yard64_5a0f260275a6 X-Filterd-Recvd-Size: 15012 Received: from mail-qt1-f202.google.com (mail-qt1-f202.google.com [209.85.160.202]) by imf21.hostedemail.com (Postfix) with ESMTP for ; Fri, 29 Jan 2021 07:03:47 +0000 (UTC) Received: by mail-qt1-f202.google.com with SMTP id h16so5316852qta.12 for ; Thu, 28 Jan 2021 23:03:47 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=sender:date:message-id:mime-version:subject:from:to:cc; bh=iDHOWBvxD85xcfsIQa87SDysF0fbnlcXVyXf/myKFx4=; b=aL+/zidHh89uPro37fJcYhwBVmGfaV0pHX/6NrvHBTPqzCpkgf01wnGDuMNmXsaMuT 9gnFIJ2hOcwzO4fq9hhA7qqUlPFCnysDG5pAESxvvvRGAuCc+YvDcNScByjrVS9DOK/O h9ubXIiWGDVMuk7hegQ5T5+WaQpsoPy+zL/rl5mb+8WmRdTHru2NVTWqGi1bkruJ2Yno e3EISYhGfOvHo3b2Ic6gzbIbXev/A0/5hhOOSQSom7YpXstPWiuOfjIuROQODWPH2Brg gw4KRwxxol21GD9DMoy8lCrkFoRMMdv9GSDUT4tW4A02IdH42WiDQIXhz5mrrgAbIYIj Qo6Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:date:message-id:mime-version:subject:from :to:cc; bh=iDHOWBvxD85xcfsIQa87SDysF0fbnlcXVyXf/myKFx4=; b=GJmEIC5f3o+sveFr+FCD/HUH8TeN3zuM9raE0PU8RuqKaB6g7dYSfANolMtQPvne4S XbKY1NIqYOgVfjBajb+VNGgfUniJAOabzwn8xui7r8bgJRdoenX+z4zdUOuRn5PNl2bY Snd0mCxAtgFjGAX6qmPtZr+VhI6UU1xPWQEfzW+1xxu3xGHHt+Z/kJloTXbcGPgKw6dV vra6yE+pZeC11dOJhN1inlbSkPwoopIWRibJku9+S64iIfPcKyYeXX7WieJcT7xPdIio P/o1k5DKYr6I5YmhklzZAPwu9LdtoQkiqUfvPSQx34LOD26i/7DX9X14ICpCd5yARkWH wpJg== X-Gm-Message-State: AOAM5318joDeZ0HL33XvWFTaOYLZuSnSc1eylYOwzTvphgJ9zKi9xLG/ Xh0r74/S4tF5L4e1SNOeO7oI7WtghvY= X-Google-Smtp-Source: ABdhPJwyuZqZWCr8UObxJ+zZoblcKnDYWVP1T9TuZVod004+jJBLJFM5ifZw1HIBK+vUgtRruuARAzYz6TY= X-Received: from surenb1.mtv.corp.google.com ([2620:15c:211:200:f693:9fff:fef4:2055]) (user=surenb job=sendgmr) by 2002:a0c:ef87:: with SMTP id w7mr2885958qvr.44.1611903827034; Thu, 28 Jan 2021 23:03:47 -0800 (PST) Date: Thu, 28 Jan 2021 23:03:40 -0800 Message-Id: <20210129070340.566340-1-surenb@google.com> Mime-Version: 1.0 X-Mailer: git-send-email 2.30.0.365.g02bc693789-goog Subject: [PATCH v2 1/1] process_madvise.2: Add process_madvise man page From: Suren Baghdasaryan To: linux-man@vger.kernel.org Cc: mtk.manpages@gmail.com, akpm@linux-foundation.org, jannh@google.com, keescook@chromium.org, jeffv@google.com, minchan@kernel.org, mhocko@suse.com, shakeelb@google.com, rientjes@google.com, edgararriaga@google.com, timmurray@google.com, linux-mm@kvack.org, selinux@vger.kernel.org, linux-security-module@vger.kernel.org, linux-api@vger.kernel.org, linux-kernel@vger.kernel.org, kernel-team@android.com, surenb@google.com Content-Type: text/plain; charset="UTF-8" X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Initial version of process_madvise(2) manual page. Initial text was extracted from [1], amended after fix [2] and more details added using man pages of madvise(2) and process_vm_read(2) as examples. It also includes the changes to required permission proposed in [3]. [1] https://lore.kernel.org/patchwork/patch/1297933/ [2] https://lkml.org/lkml/2020/12/8/1282 [3] https://patchwork.kernel.org/project/selinux/patch/20210111170622.2613577-1-surenb@google.com/#23888311 Signed-off-by: Suren Baghdasaryan --- changes in v2: - Changed description of MADV_COLD per Michal Hocko's suggestion - Appled fixes suggested by Michael Kerrisk NAME process_madvise - give advice about use of memory to a process SYNOPSIS #include ssize_t process_madvise(int pidfd, const struct iovec *iovec, unsigned long vlen, int advice, unsigned int flags); DESCRIPTION The process_madvise() system call is used to give advice or directions to the kernel about the address ranges of other process as well as of the calling process. It provides the advice to address ranges of process described by iovec and vlen. The goal of such advice is to improve system or application performance. The pidfd argument is a PID file descriptor (see pidofd_open(2)) that specifies the process to which the advice is to be applied. The pointer iovec points to an array of iovec structures, defined in as: struct iovec { void *iov_base; /* Starting address */ size_t iov_len; /* Number of bytes to transfer */ }; The iovec structure describes address ranges beginning at iov_base address and with the size of iov_len bytes. The vlen represents the number of elements in the iovec structure. The advice argument is one of the values listed below. Linux-specific advice values The following Linux-specific advice values have no counterparts in the POSIX-specified posix_madvise(3), and may or may not have counterparts in the madvise(2) interface available on other implementations. MADV_COLD (since Linux 5.4.1) Deactive a given range of pages which will make them a more probable reclaim target should there be a memory pressure. This is a non- destructive operation. The advice might be ignored for some pages in the range when it is not applicable. MADV_PAGEOUT (since Linux 5.4.1) Reclaim a given range of pages. This is done to free up memory occupied by these pages. If a page is anonymous it will be swapped out. If a page is file-backed and dirty it will be written back to the backing storage. The advice might be ignored for some pages in the range when it is not applicable. The flags argument is reserved for future use; currently, this argument must be specified as 0. The value specified in the vlen argument must be less than or equal to IOV_MAX (defined in or accessible via the call sysconf(_SC_IOV_MAX)). The vlen and iovec arguments are checked before applying any hints. If the vlen is too big, or iovec is invalid, an error will be returned immediately. The hint might be applied to a part of iovec if one of its elements points to an invalid memory region in the remote process. No further elements will be processed beyond that point. Permission to provide a hint to another process is governed by a ptrace access mode PTRACE_MODE_READ_REALCREDS check (see ptrace(2)); in addition, the caller must have the CAP_SYS_ADMIN capability due to performance implications of applying the hint. RETURN VALUE On success, process_madvise() returns the number of bytes advised. This return value may be less than the total number of requested bytes, if an error occurred after some iovec elements were already processed. The caller should check the return value to determine whether a partial advice occurred. On error, -1 is returned and errno is set to indicate the error. ERRORS EFAULT The memory described by iovec is outside the accessible address space of the process referred to by pidfd. EINVAL flags is not 0. EINVAL The sum of the iov_len values of iovec overflows a ssize_t value. EINVAL vlen is too large. ENOMEM Could not allocate memory for internal copies of the iovec structures. EPERM The caller does not have permission to access the address space of the process pidfd. ESRCH The target process does not exist (i.e., it has terminated and been waited on). EBADF pidfd is not a valid PID file descriptor. VERSIONS This system call first appeared in Linux 5.10, Support for this system call is optional, depending on the setting of the CONFIG_ADVISE_SYSCALLS configuration option. SEE ALSO madvise(2), pidofd_open(2), process_vm_readv(2), process_vm_write(2) man2/process_madvise.2 | 222 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 222 insertions(+) create mode 100644 man2/process_madvise.2 diff --git a/man2/process_madvise.2 b/man2/process_madvise.2 new file mode 100644 index 000000000..07553289f --- /dev/null +++ b/man2/process_madvise.2 @@ -0,0 +1,222 @@ +.\" Copyright (C) 2021 Suren Baghdasaryan +.\" and Copyright (C) 2021 Minchan Kim +.\" +.\" %%%LICENSE_START(VERBATIM) +.\" Permission is granted to make and distribute verbatim copies of this +.\" manual provided the copyright notice and this permission notice are +.\" preserved on all copies. +.\" +.\" Permission is granted to copy and distribute modified versions of this +.\" manual under the conditions for verbatim copying, provided that the +.\" entire resulting derived work is distributed under the terms of a +.\" permission notice identical to this one. +.\" +.\" Since the Linux kernel and libraries are constantly changing, this +.\" manual page may be incorrect or out-of-date. The author(s) assume no +.\" responsibility for errors or omissions, or for damages resulting from +.\" the use of the information contained herein. The author(s) may not +.\" have taken the same level of care in the production of this manual, +.\" which is licensed free of charge, as they might when working +.\" professionally. +.\" +.\" Formatted or processed versions of this manual, if unaccompanied by +.\" the source, must acknowledge the copyright and authors of this work. +.\" %%%LICENSE_END +.\" +.\" Commit ecb8ac8b1f146915aa6b96449b66dd48984caacc +.\" +.TH PROCESS_MADVISE 2 2021-01-12 "Linux" "Linux Programmer's Manual" +.SH NAME +process_madvise \- give advice about use of memory to a process +.SH SYNOPSIS +.nf +.B #include +.PP +.BI "ssize_t process_madvise(int " pidfd , +.BI " const struct iovec *" iovec , +.BI " unsigned long " vlen , +.BI " int " advice , +.BI " unsigned int " flags ");" +.fi +.SH DESCRIPTION +The +.BR process_madvise() +system call is used to give advice or directions to the kernel about the +address ranges of other process as well as of the calling process. +It provides the advice to address ranges of process described by +.I iovec +and +.IR vlen . +The goal of such advice is to improve system or application performance. +.PP +The +.I pidfd +argument is a PID file descriptor (see +.BR pidofd_open (2)) +that specifies the process to which the advice is to be applied. +.PP +The pointer +.I iovec +points to an array of +.I iovec +structures, defined in +.IR +as: +.PP +.in +4n +.EX +struct iovec { + void *iov_base; /* Starting address */ + size_t iov_len; /* Number of bytes to transfer */ +}; +.EE +.in +.PP +The +.I iovec +structure describes address ranges beginning at +.I iov_base +address and with the size of +.I iov_len +bytes. +.PP +The +.I vlen +represents the number of elements in the +.I iovec +structure. +.PP +The +.I advice +argument is one of the values listed below. +.\" +.\" ====================================================================== +.\" +.SS Linux-specific advice values +The following Linux-specific +.I advice +values have no counterparts in the POSIX-specified +.BR posix_madvise (3), +and may or may not have counterparts in the +.BR madvise (2) +interface available on other implementations. +.TP +.BR MADV_COLD " (since Linux 5.4.1)" +.\" commit 9c276cc65a58faf98be8e56962745ec99ab87636 +Deactive a given range of pages which will make them a more probable +reclaim target should there be a memory pressure. +This is a non-destructive operation. +The advice might be ignored for some pages in the range when it is not +applicable. +.TP +.BR MADV_PAGEOUT " (since Linux 5.4.1)" +.\" commit 1a4e58cce84ee88129d5d49c064bd2852b481357 +Reclaim a given range of pages. +This is done to free up memory occupied by these pages. +If a page is anonymous it will be swapped out. +If a page is file-backed and dirty it will be written back to the backing +storage. +The advice might be ignored for some pages in the range when it is not +applicable. +.PP +The +.I flags +argument is reserved for future use; currently, this argument must be +specified as 0. +.PP +The value specified in the +.I vlen +argument must be less than or equal to +.BR IOV_MAX +(defined in +.I +or accessible via the call +.IR sysconf(_SC_IOV_MAX) ). +.PP +The +.I vlen +and +.I iovec +arguments are checked before applying any hints. +If the +.I vlen +is too big, or +.I iovec +is invalid, an error will be returned immediately. +.PP +The hint might be applied to a part of +.I iovec +if one of its elements points to an invalid memory region in the +remote process. +No further elements will be processed beyond that point. +.PP +Permission to provide a hint to another process is governed by a +ptrace access mode +.B PTRACE_MODE_READ_REALCREDS +check (see +.BR ptrace (2)); +in addition, the caller must have the +.B CAP_SYS_ADMIN +capability due to performance implications of applying the hint. +.SH RETURN VALUE +On success, process_madvise() returns the number of bytes advised. +This return value may be less than the total number of requested bytes, +if an error occurred after some iovec elements were already processed. +The caller should check the return value to determine whether a partial +advice occurred. +.PP +On error, \-1 is returned and +.I errno +is set to indicate the error. +.SH ERRORS +.TP +.B EFAULT +The memory described by +.I iovec +is outside the accessible address space of the process referred to by +.IR pidfd . +.TP +.B EINVAL +.I flags +is not 0. +.TP +.B EINVAL +The sum of the +.I iov_len +values of +.I iovec +overflows a +.I ssize_t +value. +.TP +.B EINVAL +.I vlen +is too large. +.TP +.B ENOMEM +Could not allocate memory for internal copies of the +.I iovec +structures. +.TP +.B EPERM +The caller does not have permission to access the address space of the process +.IR pidfd . +.TP +.B ESRCH +The target process does not exist (i.e., it has terminated and been waited on). +.TP +.B EBADF +.I pidfd +is not a valid PID file descriptor. +.SH VERSIONS +This system call first appeared in Linux 5.10, +.\" commit ecb8ac8b1f146915aa6b96449b66dd48984caacc +Support for this system call is optional, +depending on the setting of the +.B CONFIG_ADVISE_SYSCALLS +configuration option. +.SH SEE ALSO +.BR madvise (2), +.BR pidofd_open(2), +.BR process_vm_readv (2), +.BR process_vm_write (2) -- 2.30.0.365.g02bc693789-goog