From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 29606F94 for ; Fri, 29 Sep 2017 17:44:19 +0200 (CEST) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 29 Sep 2017 08:44:18 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.42,453,1500966000"; d="scan'208";a="1019876877" Received: from irsmsx107.ger.corp.intel.com ([163.33.3.99]) by orsmga003.jf.intel.com with ESMTP; 29 Sep 2017 08:44:17 -0700 Received: from irsmsx111.ger.corp.intel.com (10.108.20.4) by IRSMSX107.ger.corp.intel.com (163.33.3.99) with Microsoft SMTP Server (TLS) id 14.3.319.2; Fri, 29 Sep 2017 16:44:16 +0100 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.49]) by irsmsx111.ger.corp.intel.com ([169.254.2.30]) with mapi id 14.03.0319.002; Fri, 29 Sep 2017 16:44:16 +0100 From: "Mcnamara, John" To: Eelco Chaudron CC: "dev@dpdk.org" Thread-Topic: [PATCH] doc: Adds reference to use mlockall() in the Programmer's guide Thread-Index: AQHTOSGT5Iefw52iFEilvhoCRBrgIaLL/fRA Date: Fri, 29 Sep 2017 15:44:16 +0000 Message-ID: References: <138d85856e7b5c6c09abfccdb885927458120be8.1506689397.git.echaudro@redhat.com> In-Reply-To: <138d85856e7b5c6c09abfccdb885927458120be8.1506689397.git.echaudro@redhat.com> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_IC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNmY0OGFlYTQtNjJlYS00YzBmLTlkYzMtMWQ1OTllOWQ0OGI1IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE2LjUuOS4zIiwiVHJ1c3RlZExhYmVsSGFzaCI6IkhkUjVmSzJ2cUdhQXZNSVJCbzlLMlc2UVR4K3pjWUVZNmVweVg3R1ptYW89In0= dlp-product: dlpe-windows dlp-version: 11.0.0.116 dlp-reaction: no-action x-originating-ip: [163.33.239.182] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH] doc: Adds reference to use mlockall() in the Programmer's guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 29 Sep 2017 15:44:20 -0000 Hi Eelco, Thanks for that. It is always good to get doc improvements. Some minor comments below. > -----Original Message----- > From: Eelco Chaudron [mailto:echaudro@redhat.com] > Sent: Friday, September 29, 2017 1:51 PM > To: Mcnamara, John > Cc: dev@dpdk.org > Subject: [PATCH] doc: Adds reference to use mlockall() in the Programmer'= s > guide The title should be lowercase (except for known acronyms), <=3D 50 characte= rs and the verb should be in the imperative. This is explained in the Contrib= utor's Guide: http://dpdk.org/doc/guides/contributing/patches.html#commit-messages-subjec= t-line Also you can check with the DPDK check-git-log.sh tool: $ devtools/check-git-log.sh=20 Wrong headline uppercase: doc: Adds reference to use mlockall() in the Programmer's guide Headline too long: doc: Adds reference to use mlockall() in the Programmer's guide I'd suggest a title like: doc: add use of mlockall to programmers guide >=20 > diff --git a/doc/guides/prog_guide/writing_efficient_code.rst > b/doc/guides/prog_guide/writing_efficient_code.rst > index 8223aceea..3975026ce 100644 > --- a/doc/guides/prog_guide/writing_efficient_code.rst > +++ b/doc/guides/prog_guide/writing_efficient_code.rst > @@ -105,6 +105,20 @@ meaning that if all memory access operations are don= e > on the first channel only, >=20 > By default, the :ref:`Mempool Library ` spreads the > addresses of objects among memory channels. >=20 > +Locking memory pages > +~~~~~~~~~~~~~~~~~~~~ Add a blank line after a header+underline. > +The underlying operating system is allowed to load/unload memory pages a= t > its own discretion. > +These page loads could impact the performance, as the process is on hold > when the kernel fetches them. > + > +To avoid these you could pre-load, and lock them into memory with the > mlockall() call. Include the function call in backquotes: ``mlockall()``. Thanks, John Reviewed-by: John McNamara