From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id D4C1D5A0C for ; Sun, 26 Jun 2016 22:28:16 +0200 (CEST) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga101.fm.intel.com with ESMTP; 26 Jun 2016 13:28:15 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.26,533,1459839600"; d="scan'208";a="1005548166" Received: from irsmsx154.ger.corp.intel.com ([163.33.192.96]) by orsmga002.jf.intel.com with ESMTP; 26 Jun 2016 13:28:14 -0700 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.240]) by IRSMSX154.ger.corp.intel.com ([169.254.12.28]) with mapi id 14.03.0248.002; Sun, 26 Jun 2016 21:28:13 +0100 From: "Mcnamara, John" To: Yuanhan Liu , "dev@dpdk.org" CC: "Xie, Huawei" , Thomas Monjalon Thread-Topic: [PATCH] doc: update vhost guide Thread-Index: AQHRze0zooyQleksUESBT4+YzEP5t5/8Mhvw Date: Sun, 26 Jun 2016 20:28:12 +0000 Message-ID: References: <1466754768-4809-1-git-send-email-yuanhan.liu@linux.intel.com> In-Reply-To: <1466754768-4809-1-git-send-email-yuanhan.liu@linux.intel.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: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNDFlYjllM2MtZWM4Ny00ZGE1LTlmMmYtNzVhNmQwYTUwN2M5IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6IlRjRzNuZjFmeDQ4eXlOck4yOUR0czh2UGhxMWR5Y1RGMG5PZGRZZHBzaGc9In0= x-originating-ip: [163.33.239.180] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH] doc: update vhost guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 26 Jun 2016 20:28:17 -0000 > -----Original Message----- > From: Yuanhan Liu [mailto:yuanhan.liu@linux.intel.com] > Sent: Friday, June 24, 2016 8:53 AM > To: dev@dpdk.org > Cc: Xie, Huawei ; Mcnamara, John > ; Thomas Monjalon ; > Yuanhan Liu > Subject: [PATCH] doc: update vhost guide >=20 > Mainly on updating vhost-user part: we now support client mode. > Also refine some words, and add a bit more explanation. >=20 > And made an emphatic statement that you are suggested to use vhost-user > instead of vhost-cuse, because we have enhanced vhost-user a lot since > v2.2 (Actually, I doubt there are any people still using vhost-cuse) Hi Yuahan, Nice doc and updates. Some minor comments below. > + > +* access the guest memory > + > + For QEMU, this is done by using **-object > + memory-backend-file,share=3Don,...** > + option. Which means QEMU will create a file to serve as the guest RAM. > + The **share=3Don** option allows another process to map that file, > + which means it can access the guest RAM. Fixed width quotes `` `` would be better here than bold ** **. > +Currently, there are two ways to pass those messages. That results to > +we have two implementations: vhost-cuse (character devices in user > +space) and vhost-user. Vhost-cuse creates a user space char dev and > +hook a function ioctl, so that all ioctl commands (that represent those > +messages) sent from the frontend (QEMU) will be captured and handled. > +While vhost-user creates a Unix domain socket file, through which those > messages are passed. Probably better to separate the vhost-cuse and vhost-user into 2 paragraphs to make the text clearer. Also, it is probably better to standardize on using a hyphen in vhost-cuse and vhost-user throughout the doc; there are cases with and without. > +Note that since DPDK v2.2, we have spent a lot of efforts on enhancing > +vhost-user, such as multiple queue, live migration, reconnect, etc. > +Thus, **you are encouraged to use vhost-user instead of vhost-cuse**. In general I prefer to use a simple "Note" in the text, like this, rather that the RST Note:: directive which creates a more distinctive but usually unnecessary callout box. However in this case it is probably worth having this recommendation displayed prominently. Something like the following: .. Note:: Since DPDK v2.2, the majority of the development effort has gone into enhancing vhost-user, such as multiple queue, live migration, and reconnect. Thus, it is strongly advised to use vhost-user instead of vhost-cuse. > * VHOST_SET_LOG_FD > * VHOST_SET_VRING_ERR Probably best to prefix this list with a sentence that explains what they are. Something like: The supported vhost messages are: * ``VHOST_SET_MEM_TABLE`` * ``VHOST_SET_VRING_KICK`` * ``VHOST_SET_VRING_CALL`` * ``VHOST_SET_LOG_FD`` * ``VHOST_SET_VRING_ERR`` Also, use fixed width quotes here and elsewhere for function or variable names coming from code. I will send you on some other suggestions. John