general/occlum

Fork 0

Hui, Chunyang af2643f9e0 Add config guide for EDMM

2023-11-07 09:26:20 +08:00

13 KiB

Raw Blame History

OCCLUM EDMM 配置介绍

EDMM环境要求

硬件平台：需要支持SGX-2
OS: 需要Linux Kernel v6.0及以上版本，目前的开发测试主要使用的是v6.2

EDMM启用方法

EDMM功能默认不启用。如需开启，在Occlum build阶段通过设置ENABLE_EDMM启用：

ENABLE_EDMM=Y occlum build
occlum run /xxx/xxx

如果未启用，则默认按照非EDMM平台进行build以及配置。

Occlum.json配置

配置设计原则

一份Occlum.json文件可以同时运行在EDMM以及非EDMM平台。并且在EDMM平台能够自动地最大限度地使用EDMM的功能。

EDMM原理

在支持EDMM后，Enclave.xml对于包括TCS, heap, stack等内存相关配置都提供类似Init和Max的两个配置项（有的还有第三个配置项 Min）。它的意义就是可以使得Enclave在启动阶段能够加载比较少的内存，来提高Enclave应用的启动速度。而把其他内存的加载时间平摊在运行时。Occlum.json由Occlum内部的配置工具转换成Enclave.xml并作为Enclave的最终配置。为了充分利用EDMM能力，因此也补充了相关的配置项。

总体配置思路大概是：如果希望Occlum启动速度比较快，就配置较少的Init内存。而当内存不足时，应该增加Max内存大小。Init内存作为Occlum启动时加载的内存，不管有没有真正用到都会被加载。Max内存决定了应用需要的最大内存，即使不用也不会浪费，在运行时进行按需加载。

Occlum.json EDMM相关配置示例

总体是在原有Occlum.json基础上增加了3个选填字段，包括kernel_space_heap_max_size, user_space_max_size, 以及init_num_of_threads。打开全部EDMM相关配置后的Occlum.json内存部分配置如下：

{
  "resource_limits": {
    "kernel_space_stack_size": "1MB",       // (已有，必填)
    "kernel_space_heap_size": "4MB",        // (已有，必填)
    "kernel_space_heap_max_size": "40MB",   // !!! (新增，选填)
    "user_space_size": "1MB",               // (已有，必填)
    "user_space_max_size": "600MB",         // !!! (新增，选填)
    "init_num_of_threads": 2,               // !!! (新增，选填)
    "max_num_of_threads": 64                // (已有，必填)
  },
  "process": {
    "default_stack_size": "4MB",            // (已有，必填)
    "default_heap_size": "8MB",             // (已有，必填)
    "default_mmap_size": "100MB"            // (已有，必填，但不生效)
  },
}

如果没有提供必填项，则occlum build会失败。

详细解释

Kernel Stack

对应Occlum kernel space stack内存, 与原有配置方式保持一致

对应Enclave.xml文件的StackMaxSize, StackMinSize (大小相同)
由于该stack只为Occlum kernel thread提供, 因此内存需求并不会很大。一般都在1~4M，并且绝大多数时候都不需要改动。因此不再提供其他配置项
推荐配置方式：与之前配置一致，不做修改

Kernel Heap

对应Occlum kernel space heap内存

如果只配置了
- 在EDMM平台，Occlum配置工具会提供缺省的作为按需分配的heap最大值，而作为LibOS初始化时的kernel heap大小
- 在非EDMM平台，和之前的用法保持一致，对应静态的kernel space heap大小
如果增加了配置
- 在EDMM平台，由对比Occlum配置工具提供缺省的的最大值作为kernel heap的最大值，而作为LibOS初始化时的kernel heap大小
- 在非EDMM平台，使用作为静态的kernel space heap大小， 不再生效
推荐配置方式
- EDMM平台：增加配置，可以相比之前的增加一些。原可以根据期望的启动时间，适当减小。理论上配置的越小，LibOS启动速度越快
- 非EDMM平台：与之前配置一样，不做修改，即保持与之前一致。或者增加配置来提供未来的拓展性

User Space

对应Occlum user space 大小

如果只配置了
- 在EDMM平台，Occlum配置工具会提供缺省的作为按需分配的user space最大值，而作为LibOS初始化时的user space大小
- 在非EDMM平台，和之前的用法保持一致，对应静态的user space大小
如果增加了配置
- 在EDMM平台，由对比Occlum配置工具提供缺省的的最大值作为user space的最大值，而作为LibOS初始化时的user space大小
- 在非EDMM平台，使用作为静态的user space大小， 不再生效
推荐配置方式
- EDMM平台：user space的内存变得廉价，所以可以配置的比较大，比如在之前的上乘以2倍，以杜绝应用OOM。原可以根据期望的启动时间，适当减小。理论上配置的越小，LibOS启动速度越快
- 非EDMM平台：与之前配置一样，不做修改，即保持与之前一致。也可以考虑增加配置来提供未来的拓展性

TCS Number

对应LibOS kernel线程和user线程数量的总和

和kernel heap以及user space大小配置不同的是，对于线程数量的配置是增加了对Init数量的配置，而保留了原有的Max数量的配置
如果只配置了
- 在EDMM平台，Occlum配置工具会提供缺省的作为Init数量的线程，而由对比Occlum配置工具提供缺省的的最大值作为线程数量的最大值
- 在非EDMM平台，和之前的用法保持一致，对应静态的线程数量
如果增加了配置
- 在EDMM平台，由对比Occlum配置工具提供的缺省的最小值作为初始化的线程数量，而对比Occlum配置工具提供缺省的的最大值作为线程数量的最大值
- 在非EDMM平台，不生效，只有生效，与之前用法保持一致，对应静态的线程数量
推荐配置方式
- EDMM平台：增加配置，可以根据期望的启动时间设定一个较小的值。理论上配置的越小，LibOS的启动速度越快。可以保持和之前的配置一样
- 非EDMM平台：与之前配置一样，不做修改，即保持与之前一致

需要注意

运行在EDMM平台会自动地最大限度使用EDMM功能。在目前的实现中，即使用户手动配置了或者 , 也可能会超过这个限制而使用系统提供的。因此无法通过限制max_size来限制应用的最大物理内存用量。由于是按需分配的，这些内存如果没有用到的话，是不会占用物理内存的。
如果需要考虑兼容性，即一份Occlum.json需要同时运行在EDMM和非EDMM平台，则请勿将Max相关值（包括）设置的过大。在EDMM平台，由于内存按需提交，过大的Max值不影响程序正常运行，也不会造成浪费。但是在非EDMM平台，由于内存全量提交，Max值配置的比较大会导致LibOS启动速度慢，如果过大甚至会导致加载Enclave失败。
环境变量SGX_MODE优先级高于ENABLE_EDMM。即在Simulation模式下无法启用EDMM。如果同时配置了ENABLE_EDMM=Y SGX_MODE=SIM则只有SGX_MODE环境变量生效。
用户应尽力避免occlum build时对EDMM的配置与occlum run时实际的EDMM配置冲突。如果occlum build和occlum run在不同环境：
- occlum build时不启用EDMM, occlum run时环境支持EDMM: Occlum不会启用EDMM能力，依然按照非EDMM配置运行
- occlum build时启用EDMM, occlum run时环境不支持EDMM: Enclave可以启动，但是由于配置文件的内存用量是按照EDMM环境进行配置的，在非EDMM环境会出现未定义错误。包括可能由于内存不足报错退出或发生panic等

13 KiB Raw Blame History Unescape Escape