Received: by 2002:ac0:a5a7:0:0:0:0:0 with SMTP id m36-v6csp756305imm; Thu, 26 Jul 2018 11:25:48 -0700 (PDT) X-Google-Smtp-Source: AAOMgpcxju7G/PTG4hdVHv1wh9Qgju712id2Swl98YlaD09iYMEQTiRyKPw2RtHX0egnW3POgFuH X-Received: by 2002:a63:b95c:: with SMTP id v28-v6mr2965811pgo.162.1532629548868; Thu, 26 Jul 2018 11:25:48 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1532629548; cv=none; d=google.com; s=arc-20160816; b=lpqChpP9N3U/fG8JNniLAGUwX2zKtx+261AtA/xlmzLCYr9TyWi34P25nmA5p0ikE6 8Lb+U1aTp6hmKcAeR04p7UH194cbEbR77H4hMvq7urn2wLIW+8eLACAEtsKpjysrqtIm Sg2vGch2r/LWuIAdzTlI67UcfFGrEn37LacGZdFkm+fIB4mD9ft8goV/s4bCW9u1nyCI eDKflWsXAAyPaHSr6vJ/4ea6+yQwtzWp+2aYcAMccJtTaFZZQkJgdYsXHeZyQy3yq0Ka HfZTBxp8JJdsbJuNiPeix5zfFklI09CsFjcBg/pa47d82gx2tsnyqJ3Z2/NvV+mmY3el pBlA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:message-id:references:in-reply-to:date :subject:cc:to:from:arc-authentication-results; bh=nDJkqw+NiWI9NTy5rzHL1+ViXwcq7DcYO8Z2zLaa5BQ=; b=CZbal1XW4O7hA7JM51TAdUGW9NB33gZq7dm6rPBB0jvuIGwv8K3NcglevzfCAYDmTr vfXRH0gfppsvTcNqJ233dczEobkgcoH4XByJLAGbRw4Uif2hWo6xRzTrYtL+XFyuceNc rR8d0wNMLqUu6L1PAc48bmkvi2BdvoqzK/OOqe3YDj4vudX01+pRs3a1F7NDgVjfJQRm Hrc2IMZn4xWUtKeR9o1b3fncYP0S71AZeDufCd+gcL3DN08VTUVR/9V6oUkgyXFgpbeV 8S0k40blmIX/vKzLv3TvTge6PyaGGV4TLHEoDycxOfSja/crwSTX+166r07bVq+X3mAh 2uVQ== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=ibm.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id p84-v6si2022744pfl.17.2018.07.26.11.25.33; Thu, 26 Jul 2018 11:25:48 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=ibm.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2389058AbeGZSvB (ORCPT + 99 others); Thu, 26 Jul 2018 14:51:01 -0400 Received: from mx0b-001b2d01.pphosted.com ([148.163.158.5]:37318 "EHLO mx0a-001b2d01.pphosted.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1731646AbeGZSu6 (ORCPT ); Thu, 26 Jul 2018 14:50:58 -0400 Received: from pps.filterd (m0098419.ppops.net [127.0.0.1]) by mx0b-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w6QHSqXT043157 for ; Thu, 26 Jul 2018 13:33:09 -0400 Received: from e06smtp01.uk.ibm.com (e06smtp01.uk.ibm.com [195.75.94.97]) by mx0b-001b2d01.pphosted.com with ESMTP id 2kfj32stsd-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Thu, 26 Jul 2018 13:33:09 -0400 Received: from localhost by e06smtp01.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Thu, 26 Jul 2018 18:33:07 +0100 Received: from b06cxnps3074.portsmouth.uk.ibm.com (9.149.109.194) by e06smtp01.uk.ibm.com (192.168.101.131) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Thu, 26 Jul 2018 18:33:04 +0100 Received: from d06av23.portsmouth.uk.ibm.com (d06av23.portsmouth.uk.ibm.com [9.149.105.59]) by b06cxnps3074.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id w6QHX3hT39125130 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Thu, 26 Jul 2018 17:33:03 GMT Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id A5576A4051; Thu, 26 Jul 2018 20:33:16 +0100 (BST) Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id C75C3A404D; Thu, 26 Jul 2018 20:33:14 +0100 (BST) Received: from rapoport-lnx (unknown [9.148.204.214]) by d06av23.portsmouth.uk.ibm.com (Postfix) with ESMTPS; Thu, 26 Jul 2018 20:33:14 +0100 (BST) Received: by rapoport-lnx (sSMTP sendmail emulation); Thu, 26 Jul 2018 20:33:00 +0300 From: Mike Rapoport To: Jonathan Corbet , Andrew Morton Cc: Matthew Wilcox , Michal Hocko , linux-doc@vger.kernel.org, linux-mm@kvack.org, linux-kernel@vger.kernel.org, Mike Rapoport Subject: [PATCH v3 7/7] docs/core-api: mm-api: add section about GFP flags Date: Thu, 26 Jul 2018 20:32:40 +0300 X-Mailer: git-send-email 2.7.4 In-Reply-To: <1532626360-16650-1-git-send-email-rppt@linux.vnet.ibm.com> References: <1532626360-16650-1-git-send-email-rppt@linux.vnet.ibm.com> X-TM-AS-GCONF: 00 x-cbid: 18072617-4275-0000-0000-0000029E6E4F X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18072617-4276-0000-0000-000037A672E0 Message-Id: <1532626360-16650-8-git-send-email-rppt@linux.vnet.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:,, definitions=2018-07-26_04:,, signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=2 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=871 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1806210000 definitions=main-1807260180 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Signed-off-by: Mike Rapoport --- Documentation/core-api/mm-api.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst index b5913aa..46ae353 100644 --- a/Documentation/core-api/mm-api.rst +++ b/Documentation/core-api/mm-api.rst @@ -14,6 +14,27 @@ User Space Memory Access .. kernel-doc:: mm/util.c :functions: get_user_pages_fast +Memory Allocation Controls +========================== + +Functions which need to allocate memory often use GFP flags to express +how that memory should be allocated. The GFP acronym stands for "get +free pages", the underlying memory allocation function. Not every GFP +flag is allowed to every function which may allocate memory. Most +users will want to use a plain ``GFP_KERNEL``. + +.. kernel-doc:: include/linux/gfp.h + :doc: Page mobility and placement hints + +.. kernel-doc:: include/linux/gfp.h + :doc: Watermark modifiers + +.. kernel-doc:: include/linux/gfp.h + :doc: Reclaim modifiers + +.. kernel-doc:: include/linux/gfp.h + :doc: Common combinations + The Slab Cache ============== -- 2.7.4