Message-ID: <d89841cf-6e31-9846-ab6a-79b60baf8095@intel.com>
Date:   Mon, 6 Dec 2021 13:15:11 -0800
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101
 Firefox/91.0 Thunderbird/91.3.2
Subject: Re: [PATCH 02/25] x86/sgx: Add wrappers for SGX2 functions
Content-Language: en-US
To:     Jarkko Sakkinen <jarkko@kernel.org>
CC:     <dave.hansen@linux.intel.com>, <tglx@linutronix.de>,
        <bp@alien8.de>, <luto@kernel.org>, <mingo@redhat.com>,
        <linux-sgx@vger.kernel.org>, <x86@kernel.org>, <seanjc@google.com>,
        <kai.huang@intel.com>, <cathy.zhang@intel.com>,
        <cedric.xing@intel.com>, <haitao.huang@intel.com>,
        <mark.shanahan@intel.com>, <hpa@zytor.com>,
        <linux-kernel@vger.kernel.org>
References: <cover.1638381245.git.reinette.chatre@intel.com>
 <50ad5005c451f41951327853fb450ba302eadb40.1638381245.git.reinette.chatre@intel.com>
 <Yavl1csrk03Zj4ZW@iki.fi>
From:   Reinette Chatre <reinette.chatre@intel.com>
In-Reply-To: <Yavl1csrk03Zj4ZW@iki.fi>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?WkhBa1BUWFMrcUEvQy90WkN6TFYxdjlJa3FmZHN2RVV0akFpYVVSWGx5UklX?=
 =?utf-8?B?Um5VVTBXWk5YOUQ1eWhBYmQwWHM4S3J5VjBiVS9nRDFON3FxSExyZXBURGow?=
 =?utf-8?B?bmJyQW10R2tkcXhvSS9zMWFMNGVFZWRvR2RyRUl4V25pNXBSeUR1eSs3cjky?=
 =?utf-8?B?Zm4vcExVNnh1MHlVT2l1VU02S3pDWDhDbjBKc2Z0ZmpSUlR6VCtzdkhUTkEy?=
 =?utf-8?B?THk4T0c3N3FSL0tNLzJwbzJES3k0azFSaEtnQ3VCZGV3UjFISTEyNVZMMFFO?=
 =?utf-8?B?UWFhZUhpRDhVQ1cvRkpIL090R1J2TDhYOGUxQnFpenpUY2l5TVM0Z1ljMjFV?=
 =?utf-8?B?YzM0d3ViLzlXWjhJRjdFUER5c2FHemFsakNpc0hicitaaExYbXhEbUJ2cmdZ?=
 =?utf-8?B?Wlhzbmgva2xZd2RBeDZacEgydlFLYjc0eXYzOHVIb0dYNTZCNU9BY1FWNkMz?=
 =?utf-8?B?WjJYZzhYOGdWT1RnWW1yUUZxVklRWXRqSkJCSTl2YWFMS3VycDh5bEVaNkVr?=
 =?utf-8?B?Y3JzYjRpWVNvVXNELzlQa0QwdE9pVTF0SEZDMU85RXlDRzlzNG12R2dUL0U4?=
 =?utf-8?B?TjdZcVBHYVJaY0RuTFhzb05vWDFsOTh3d0RlNUpFUnY0d1FOcVhjNFVScDhK?=
 =?utf-8?B?WmNEbkw0VDNRZWZDTGhZK0VEaXpLUUtnU0tUOXR0LzZ1bE9OVHdJVmlpSStR?=
 =?utf-8?B?L0ViQmttdC9KQlRaWVcyVXhjYTVtdk4yN29GVGRtcUk3RmNoYkNpL0NQbG9Y?=
 =?utf-8?B?UzZNODA1cGdUSCtwcjA3TVRXSDVnNUlVeU9YcTFzN2hCQUQ4UHVtbjd0WVBW?=
 =?utf-8?B?T1ZZLy9IcG1FNFc2eDY1MmJEbzdTUkhTb2Y0cHZwckthNVJsNWlQSXJ3Vkd6?=
 =?utf-8?B?aU8yU0xMTEhCVHdnOFVaS1FNTGNaVFNudHlPenhNN1RqcU8wNHU3b1g1V1NU?=
 =?utf-8?B?NDArQ29VUHVYaTdiNzhlWjRVdXVDREl2bXJNRWpMUm9CNHVzVHg0SGxOMHNj?=
 =?utf-8?B?emwyYkJ0dzVIOFg4RUQwQVdGYk5PNXVGU29HTC9LcDZ2Qlo3QmVBQjZnQWFS?=
 =?utf-8?B?YmRUS2hISC9BNW5VZkdGOU1NZmJocllKTllLQnk0c1FOSGR2T3B3MXdoVzlQ?=
 =?utf-8?B?cG5Ta2VLdXZQNjB3eW1zZHVjRjh5MDZNckpFcm9HZW9BY1Y0cWozRVRrM0gr?=
 =?utf-8?B?cktEWVZRcExxU0k0c0xxbVhpNmRhcWQya1V6WFArMmlEQ1FHbDE5TUZRTVBp?=
 =?utf-8?B?b0t3bnRtWVhWbFRkSzVOa3g1Q0NKVnRxcnpESjVYT3krQnFtTDJDRzkrdjJ2?=
 =?utf-8?B?Y2E2TVA2ZDlIWVd6K0p5R1dJQkpnTEZLR0todGI0L0ZOZzV5TzVyYTU0Z2NE?=
 =?utf-8?B?K1JpVWYwRGVJQnRKSSs2WDBSSDgwU2NJUHBLNUNiTHdaYkJhZXlwRnpjSnMr?=
 =?utf-8?B?NnMzbW5LYlFzbVBmQXFuRTZMeG9mR1RVZ1RjSGFaM0oyNjZHZ250RTNBZkRo?=
 =?utf-8?B?RGtHcmhiVktFNVlVTGU0Rm5rbU5kUjlKKzJPRmF3bmtIcXZmU0tJMjRpZ0Qv?=
 =?utf-8?B?aURDY1dnVFBsLy94NDBITktXZFlnejJYdUtXaHVzQi9IUjVEOWlkR0J2Yytn?=
 =?utf-8?B?QnkvRFZJZjRoSWY4bTkvWUQ2Vmd5UkRTWURPNlhZNDFDR3F3WXg1WExxczE3?=
 =?utf-8?B?a25CNXhGZUdyRGdvWGZoY3B3QXVaNjAzejdoSmxWeW9Yd0wyVUhadFdqdzY3?=
 =?utf-8?B?eFpKbDQ3TWIybGFmeDQycHhuZWNkTFJvbnpEdEgwUHE3TnNCWG9MeVRYRC9W?=
 =?utf-8?B?Nkd0VC9tSkZ5UkQwTUV2cjRrTng4cFBTaDMwSjM5MjlDMW9nVzdNSEhDeG54?=
 =?utf-8?B?RkZud2dPbVpnelY2M0NxdWF4UE1WVGNtUk1wd1hDVFh3YTM2cFNGUlMxV0FQ?=
 =?utf-8?B?MmVQL2ZZSExFeVdTeERzUGE3SkJYYVNUL25vaFQvbTBKaENGNkJOVFJqNlVN?=
 =?utf-8?B?Y3dNeUtVVXdQWkxNZ1lqOUtGZzVZUTl1a3pIckhqVHU2QUpXUE9pNFJ2VklF?=
 =?utf-8?B?b0p5OFZydHlJMTNSRldDV251U1VKekF0dzE3cmgydm5zWFdUMG1rSnpnSlB4?=
 =?utf-8?B?UkphbUx1bWYyV1dsV2FJNXhGZS96Q2UySXNpdGNuY3JvWlZnSTRMS3dOMmZQ?=
 =?utf-8?B?SmNyQ1lEVGxUYWlsTk5MWDY3TURkTjVkczJyZmFTVGc4c3lYYUIvTFBaTEtw?=
 =?utf-8?Q?mClwaqitjpYurqW3JYlh/HUGBIURypKSjdMlni61co=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: c3b7d7f0-1bc2-401e-6448-08d9b8fd7fb9
X-MS-Exchange-CrossTenant-AuthSource: BN0PR11MB5744.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Dec 2021 21:15:16.8007
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: Du3G0qQ2lXdspNzezTTJbPKrTKqen5IiaS9UYHt1ltor2FSAfilf9yaZcA50XITPdOnDDrbB5Y0sE17EvMpqKsDwGhh4s8LE7md1UD/4kJo=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN7PR11MB2674
X-OriginatorOrg: intel.com
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Hi Jarkko,

On 12/4/2021 2:04 PM, Jarkko Sakkinen wrote:
> On Wed, Dec 01, 2021 at 11:23:00AM -0800, Reinette Chatre wrote:
>> The SGX ENCLS instruction uses EAX to specify an SGX function and
>> may require additional registers, depending on the SGX function.
>> ENCLS invokes the specified privileged SGX function for managing
>> and debugging enclaves. Several macros are used to wrap the ENCLS
>> functionality.
>>
>> Add ENCLS wrappers for the SGX2 EMODPR, EMODT, and EAUG functions
>> that can make changes to pages of an initialized SGX enclave. The
>> EMODPR function is used to restrict enclave page permissions
>> as maintained within the enclave (Enclave Page Cache Map (EPCM)
>> permissions). The EMODT function is used to change the type of an
>> enclave page. The EAUG function is used to dynamically add enclave
>> pages to an initialized enclave.
>>
>> EMODPR and EMODT accepts two parameters and can fault as well as return
>> an SGX error code. EAUG also accepts two parameters but does not return
>> an SGX error code. Use existing macros for all new functions.
>>
>> Expand enum sgx_return_code with the possible EMODPR and EMODT
>> return codes.
> 
> These implementation details only obfuscate this commit message, and
> it is way too high-level to be useful e.g. for kernel maintenance.

2c273671d0df ("x86/sgx: Add wrappers for ENCLS functions") seemed to be 
good enough for kernel maintenance, but ok.

> 
> I'd replace it with something like:
> 
> "
> Add wrappers for ENCLS leaf functions EAUG, EMODT and EMODPR,
> which roughly take two steps:
> 
> 1. EAUG creates a new EPCM entry.
>     EMODT and EMODPR modify an existing EPCM entry.
> 2. Set either .PR = 1 (EMODPR), .MODIFY = 1 (EMODT) or .PENDING = 1 (AUG).
> 
> The bit is reset by the enclave by invoking ENCLU leaf function EACCEPT
> or EACCEPTCOPY, which will result the EPCM change becoming effective.
> "

I can use this if the SGX2 functions continues to be introduced in a 
single patch but ...

> 
> The current commit message is also not addressing these:
> 
> 1. What happens if enclaves accesses a memory address with either .PR,
>     .MODIFY or .PENDING set in EPCM, other than by the means of EACCEPT
>     or EACCEPTCOPY?
> 2. The calling conditions (e.g. concerning TLB's and ETRACK/IPI/etc
>     dance related to it).

... adding this information for all three SGX functions would be too 
much for one patch so I think that I should rather split this into three 
patches, each introducing a single SGX2 function with all the details 
you require. But ...


... the intent of this patch was just to introduce the wrappers of the 
SGX2 functions. These details surrounding the flows when using these 
functions are addressed in the patches that use them. It sounds to me 
that you want to duplicate that information here where the wrappers are 
added. Looking ahead you do require the same information in the 
changelogs of the patches that use these wrappers so I would like to 
confirm if you would like to see three separate patches with the details 
duplicating the information provided later or if you would like to see a 
single patch with the three wrappers and the changelog that you recommend?

> If this information was properly contained here, discussing about the
> following commits would be much easier.

The commits using these functions should have clear content on the flows 
surrounding them. I see there is work to do and I will review them to 
ensure that.

Reinette