From patchwork Mon Jan 14 11:47:34 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Rapoport X-Patchwork-Id: 10762271 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 16CBB1390 for ; Mon, 14 Jan 2019 11:47:47 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 03F1C28B04 for ; Mon, 14 Jan 2019 11:47:47 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id EB3B928B14; Mon, 14 Jan 2019 11:47:46 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_NONE autolearn=ham version=3.3.1 Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id B054A28B04 for ; Mon, 14 Jan 2019 11:47:45 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 0E4C18E0003; Mon, 14 Jan 2019 06:47:44 -0500 (EST) Delivered-To: linux-mm-outgoing@kvack.org Received: by kanga.kvack.org (Postfix, from userid 40) id 0958E8E0002; Mon, 14 Jan 2019 06:47:44 -0500 (EST) X-Original-To: int-list-linux-mm@kvack.org X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id EEC1E8E0003; Mon, 14 Jan 2019 06:47:43 -0500 (EST) X-Original-To: linux-mm@kvack.org X-Delivered-To: linux-mm@kvack.org Received: from mail-qk1-f200.google.com (mail-qk1-f200.google.com [209.85.222.200]) by kanga.kvack.org (Postfix) with ESMTP id C27598E0002 for ; Mon, 14 Jan 2019 06:47:43 -0500 (EST) Received: by mail-qk1-f200.google.com with SMTP id w28so16136425qkj.22 for ; Mon, 14 Jan 2019 03:47:43 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-original-authentication-results:x-gm-message-state:from:to:cc :subject:date:message-id; bh=sEg1K+ukxt+R8lxPxPwzJEf5nKOeiY8MzA4/ehrrvXc=; b=iwUNbTS3W3PmCSc1YBoN3XtfVA/Ody7pqstp9/Jtm6t0P+Xwt2ganAbOgGmznGL22Q MGX58eaXAi50nfHjb74MDNoLLYbCbWQlTkX6kHWv/V6xRgS84ENNGlD+FxIzVRqc5pXl WdXWL7zCLx0np7Ax5CKIB6wMyQesSIKiTlYYynJGGle1A11pvhMUH0LjPRSAttZbi8Od m8NKP4QNJXHklYcoahUAHKyNtH2mNYXU3jiRTu52gI+lmYDwY6MLMHCJsygeduUbRmT6 tAEvrI+bSLrKlZcvzMOBboKlNJiheyOjZmLdhj0gbGn/Y0r797Q+qpj229+qj8rohbaX GhmA== X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of rppt@linux.ibm.com designates 148.163.158.5 as permitted sender) smtp.mailfrom=rppt@linux.ibm.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=ibm.com X-Gm-Message-State: AJcUukc2OA8S8V/iaqunbT8eHGUofMRapUCp/dvWkbgdSebry2Wt3ECJ zfcM01rGT9hsM90Un88vHvffn6x15SDANOFo4OZzDLRTZSJLGJOHJV3yGah0W+7tgwxtuh7zqVO 44ZOYEAhiaRNzJ/q30XGFiKdl+iE+comhMnLxccmFx08hK52+cnafHjPzfiZFY8QusQ== X-Received: by 2002:aed:2dc5:: with SMTP id i63mr24174699qtd.173.1547466463489; Mon, 14 Jan 2019 03:47:43 -0800 (PST) X-Google-Smtp-Source: ALg8bN4qMKzjaOA5h2aRQzVBdzyfNPDrMoxlGWh4pB+c+Mp1VVu+9yZ02lgZAI8dOl4ZosfRmM1p X-Received: by 2002:aed:2dc5:: with SMTP id i63mr24174675qtd.173.1547466462888; Mon, 14 Jan 2019 03:47:42 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1547466462; cv=none; d=google.com; s=arc-20160816; b=I92Vfr2vT4Cjy9CMpr0OEly0RdENxG7zKNX3Aur50T6lBhSVB6BSjdcABJ7FAjhxBe 2iPoBo45Egsv/F35l/rmaZsOyiTAd6HmwygRJPRl1Siqe6CYyfnwYAyxxpqL/o2sSr3H /zRqwfoX/lxyaS4H+dFZoXTasPqtrkSPUNFupmIHXkJKEA5/7qzfD1YBEzH55B53src3 bDIwRRj7DU6z6Wa57QY/YPqJsubgGpIPVySWLMo3oN1+Wz+TNmgMJ84ouC1fREJ85Dw6 z3iC83d8hNBVZYhL3/9pIHHRqsR5yuyoAQhZBafOosHijEslCJUOCU+DAvAgLXC3ucMu Zi1w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=message-id:date:subject:cc:to:from; bh=sEg1K+ukxt+R8lxPxPwzJEf5nKOeiY8MzA4/ehrrvXc=; b=l63gvv/Ps/CRL8hDRpgZ476K65sRjZZzpXtguVoRvnzcAXIDE4pmfrDLIMspkjwkro ybjjcdvaRgG5rNFLWnbX+FgZZCGTl9MXRUU1XVjtXf4PK0Z990KH3QihLmrmuMPJ8xWr n/OT/WmETiaFbFhFLj4xW+EAn59XxohM58P5sh35MMGsyaEa4ndsEIOb4F8iRcpBqLO5 Mcxi/QUTB57UvKU6OFpdMyhiYOz9ReNmPDi/KfNMfCJo9+ro23Dv5g9/wn5DbsPe8y4A TrOi8mqDxvJB8zrMyjhu5To19Ps29qKIWbPFotWab4lTpnOyGVxDaBDCOfF4j5AkLqdK iiSA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of rppt@linux.ibm.com designates 148.163.158.5 as permitted sender) smtp.mailfrom=rppt@linux.ibm.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=ibm.com Received: from mx0a-001b2d01.pphosted.com (mx0b-001b2d01.pphosted.com. [148.163.158.5]) by mx.google.com with ESMTPS id x46si1488442qth.369.2019.01.14.03.47.42 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 14 Jan 2019 03:47:42 -0800 (PST) Received-SPF: pass (google.com: domain of rppt@linux.ibm.com designates 148.163.158.5 as permitted sender) client-ip=148.163.158.5; Authentication-Results: mx.google.com; spf=pass (google.com: domain of rppt@linux.ibm.com designates 148.163.158.5 as permitted sender) smtp.mailfrom=rppt@linux.ibm.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=ibm.com 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 x0EBixN5142774 for ; Mon, 14 Jan 2019 06:47:42 -0500 Received: from e06smtp01.uk.ibm.com (e06smtp01.uk.ibm.com [195.75.94.97]) by mx0b-001b2d01.pphosted.com with ESMTP id 2q0pskr34f-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Mon, 14 Jan 2019 06:47:41 -0500 Received: from localhost by e06smtp01.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Mon, 14 Jan 2019 11:47:40 -0000 Received: from b06cxnps3075.portsmouth.uk.ibm.com (9.149.109.195) 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) Mon, 14 Jan 2019 11:47:38 -0000 Received: from d06av21.portsmouth.uk.ibm.com (d06av21.portsmouth.uk.ibm.com [9.149.105.232]) by b06cxnps3075.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id x0EBlbGT51445822 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Mon, 14 Jan 2019 11:47:37 GMT Received: from d06av21.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 80C2652054; Mon, 14 Jan 2019 11:47:37 +0000 (GMT) Received: from rapoport-lnx (unknown [9.148.207.170]) by d06av21.portsmouth.uk.ibm.com (Postfix) with ESMTPS id 007BF52051; Mon, 14 Jan 2019 11:47:35 +0000 (GMT) Received: by rapoport-lnx (sSMTP sendmail emulation); Mon, 14 Jan 2019 13:47:35 +0200 From: Mike Rapoport To: Jonathan Corbet Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-mm@kvack.org, Mike Rapoport Subject: [PATCH] docs/core-api: memory-allocation: add mention of kmem_cache_create_userspace Date: Mon, 14 Jan 2019 13:47:34 +0200 X-Mailer: git-send-email 2.7.4 X-TM-AS-GCONF: 00 x-cbid: 19011411-4275-0000-0000-000002FEF2A6 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 19011411-4276-0000-0000-0000380D0B8B Message-Id: <1547466454-29457-1-git-send-email-rppt@linux.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:,, definitions=2019-01-14_06:,, signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1901140098 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: X-Virus-Scanned: ClamAV using ClamSMTP Mention that when a part of a slab cache might be exported to the userspace, the cache should be created using kmem_cache_create_usercopy() Signed-off-by: Mike Rapoport --- Documentation/core-api/memory-allocation.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/Documentation/core-api/memory-allocation.rst b/Documentation/core-api/memory-allocation.rst index 8954a88..51a200d 100644 --- a/Documentation/core-api/memory-allocation.rst +++ b/Documentation/core-api/memory-allocation.rst @@ -113,9 +113,11 @@ see :c:func:`kvmalloc_node` reference documentation. Note that If you need to allocate many identical objects you can use the slab cache allocator. The cache should be set up with -:c:func:`kmem_cache_create` before it can be used. Afterwards -:c:func:`kmem_cache_alloc` and its convenience wrappers can allocate -memory from that cache. +:c:func:`kmem_cache_create` or :c:func:`kmem_cache_create_usercopy` +before it can be used. The second function should be used if a part of +the cache might be copied to the userspace. After the cache is +created :c:func:`kmem_cache_alloc` and its convenience wrappers can +allocate memory from that cache. When the allocated memory is no longer needed it must be freed. You can use :c:func:`kvfree` for the memory allocated with `kmalloc`,