SMC runtime service 등록과 dispatch

QUESTION

SMC runtime service 등록과 dispatch 단계에서 실제로 바뀌는 상태는 무엇인가?

STRUCTURE

객체와 주소가 놓이는 구조

CALL PATH

실행 흐름

STATE LEDGER

단계별 입력과 출력

각 단계의 입력과 처리 후 바뀌는 상태를 정리한 표다. 사용 중인 소스 버전에서 다른 필드를 변경한다면 그에 맞춰 표도 수정한다.

분석 범위의 전제와 비교해, 다음 단계에 잘못된 입력을 넘긴 부분부터 조사한다.

VISUAL WALKTHROUGH

주소와 객체의 이동을 그림으로 읽기

아래 그림은 주소, 객체를 사용하는 기간, 제어권을 넘기는 시점을 중심으로 정리했다. 실제 주소와 크기는 사용 중인 보드의 bdinfo, 맵 파일과 링커 심벌로 확인한다.

UPSTREAM SOURCE

원본 코드

아래 코드는 Trusted Firmware-A LTS 2.14.3의 common/runtime_svc.c에서 8-96줄을 그대로 가져온 것이다. 설명을 위해 실제 코드를 가짜 의사 코드로 바꾸지 않았다.

8#include <errno.h>
9#include <string.h>
10
11#include <common/debug.h>
12#include <common/runtime_svc.h>
13
14/*******************************************************************************
15 * The 'rt_svc_descs' array holds the runtime service descriptors exported by
16 * services by placing them in the 'rt_svc_descs' linker section.
17 * The 'rt_svc_descs_indices' array holds the index of a descriptor in the
18 * 'rt_svc_descs' array. When an SMC arrives, the OEN[29:24] bits and the call
19 * type[31] bit in the function id are combined to get an index into the
20 * 'rt_svc_descs_indices' array. This gives the index of the descriptor in the
21 * 'rt_svc_descs' array which contains the SMC handler.
22 ******************************************************************************/
23uint8_t rt_svc_descs_indices[MAX_RT_SVCS];
24
25#define RT_SVC_DECS_NUM		((RT_SVC_DESCS_END - RT_SVC_DESCS_START)\
26					/ sizeof(rt_svc_desc_t))
27
28/*******************************************************************************
29 * Function to invoke the registered `handle` corresponding to the smc_fid in
30 * AArch32 mode.
31 ******************************************************************************/
32uintptr_t handle_runtime_svc(uint32_t smc_fid,
33			     void *cookie,
34			     void *handle,
35			     unsigned int flags)
36{
37	u_register_t x1, x2, x3, x4;
38	unsigned int index;
39	unsigned int idx;
40	const rt_svc_desc_t *rt_svc_descs;
41
42	assert(handle != NULL);
43	idx = get_unique_oen_from_smc_fid(smc_fid);
44	assert(idx < MAX_RT_SVCS);
45
46	index = rt_svc_descs_indices[idx];
47	if (index >= RT_SVC_DECS_NUM)
48		SMC_RET1(handle, SMC_UNK);
49
50	rt_svc_descs = (rt_svc_desc_t *) RT_SVC_DESCS_START;
51
52	get_smc_params_from_ctx(handle, x1, x2, x3, x4);
53
54	return rt_svc_descs[index].handle(smc_fid, x1, x2, x3, x4, cookie,
55						handle, flags);
56}
57
58/*******************************************************************************
59 * Simple routine to sanity check a runtime service descriptor before using it
60 ******************************************************************************/
61static int32_t validate_rt_svc_desc(const rt_svc_desc_t *desc)
62{
63	if (desc == NULL) {
64		return -EINVAL;
65	}
66	if (desc->start_oen > desc->end_oen) {
67		return -EINVAL;
68	}
69	if (desc->end_oen >= OEN_LIMIT) {
70		return -EINVAL;
71	}
72	if ((desc->call_type != SMC_TYPE_FAST) &&
73	    (desc->call_type != SMC_TYPE_YIELD)) {
74		return -EINVAL;
75	}
76	/* A runtime service having no init or handle function doesn't make sense */
77	if ((desc->init == NULL) && (desc->handle == NULL)) {
78		return -EINVAL;
79	}
80	return 0;
81}
82
83/*******************************************************************************
84 * This function calls the initialisation routine in the descriptor exported by
85 * a runtime service. Once a descriptor has been validated, its start & end
86 * owning entity numbers and the call type are combined to form a unique oen.
87 * The unique oen is used as an index into the 'rt_svc_descs_indices' array.
88 * The index of the runtime service descriptor is stored at this index.
89 ******************************************************************************/
90void __init runtime_svc_init(void)
91{
92	int rc = 0;
93	uint8_t index, start_idx, end_idx;
94	rt_svc_desc_t *rt_svc_descs;
95
96	/* Assert the number of descriptors detected are less than maximum indices */

READING CONTRACT

발췌 범위와 읽기 기준

원문 8-96줄에는 앞뒤 문맥이 포함됩니다. 기준 구문 uintptr_t handle_runtime_svc(uint32_t smc_fid은 L32에 있습니다. 발췌 첫 줄을 함수 정의의 시작으로 해석하지 않습니다.

SMC function ID의 owner number, call type, 32/64-bit convention을 분리해서 본다. descriptor 초기화 실패가 runtime table에 어떤 빈칸을 남기는지도 확인한다.

RELATED SOURCE

함께 읽어야 하는 원본 코드

첫 코드 조각만으로 동작이 완성되지 않는 경우 호출 매크로, 객체 정의와 실제 실행 목록을 같은 페이지에 묶었다. 각 조각은 같은 기준 commit에서 가져왔다.

80	return 0;
81}
82
83/*******************************************************************************
84 * This function calls the initialisation routine in the descriptor exported by
85 * a runtime service. Once a descriptor has been validated, its start & end
86 * owning entity numbers and the call type are combined to form a unique oen.
87 * The unique oen is used as an index into the 'rt_svc_descs_indices' array.
88 * The index of the runtime service descriptor is stored at this index.
89 ******************************************************************************/
90void __init runtime_svc_init(void)
91{
92	int rc = 0;
93	uint8_t index, start_idx, end_idx;
94	rt_svc_desc_t *rt_svc_descs;
95
96	/* Assert the number of descriptors detected are less than maximum indices */
97	assert((RT_SVC_DESCS_END >= RT_SVC_DESCS_START) &&
98			(RT_SVC_DECS_NUM < MAX_RT_SVCS));
99
100	/* If no runtime services are implemented then simply bail out */
101	if (RT_SVC_DECS_NUM == 0U) {
102		return;
103	}
104	/* Initialise internal variables to invalid state */
105	(void)memset(rt_svc_descs_indices, -1, sizeof(rt_svc_descs_indices));
106
107	rt_svc_descs = (rt_svc_desc_t *) RT_SVC_DESCS_START;
108	for (index = 0U; index < RT_SVC_DECS_NUM; index++) {
109		rt_svc_desc_t *service = &rt_svc_descs[index];
110
111		/*
112		 * An invalid descriptor is an error condition since it is
113		 * difficult to predict the system behaviour in the absence
114		 * of this service.
115		 */
116		rc = validate_rt_svc_desc(service);
117		if (rc != 0) {
118			ERROR("Invalid runtime service descriptor %p\n",
119				(void *) service);
120			panic();
121		}
122
123		/*
124		 * The runtime service may have separate rt_svc_desc_t
125		 * for its fast smc and yielding smc. Since the service itself
126		 * need to be initialized only once, only one of them will have
127		 * an initialisation routine defined. Call the initialisation
128		 * routine for this runtime service, if it is defined.
129		 */
130		if (service->init != NULL) {
131			rc = service->init();
132			if (rc != 0) {
133				ERROR("Error initializing runtime service %s\n",
134						service->name);
135				continue;
136			}
137		}
138
139		/*
140		 * Fill the indices corresponding to the start and end
141		 * owning entity numbers with the index of the
142		 * descriptor which will handle the SMCs for this owning
143		 * entity range.
144		 */
145		start_idx = (uint8_t)get_unique_oen(service->start_oen,
146						    service->call_type);
147		end_idx = (uint8_t)get_unique_oen(service->end_oen,
148						  service->call_type);
149		assert(start_idx <= end_idx);
150		assert(end_idx < MAX_RT_SVCS);
151		for (; start_idx <= end_idx; start_idx++) {
152			rt_svc_descs_indices[start_idx] = index;
153		}
154	}
155}

51 * for future use
52 */
53typedef uintptr_t (*rt_svc_handle_t)(uint32_t smc_fid,
54				  u_register_t x1,
55				  u_register_t x2,
56				  u_register_t x3,
57				  u_register_t x4,
58				  void *cookie,
59				  void *handle,
60				  u_register_t flags);
61typedef struct rt_svc_desc {
62	uint8_t start_oen;
63	uint8_t end_oen;
64	uint8_t call_type;
65	const char *name;
66	rt_svc_init_t init;
67	rt_svc_handle_t handle;
68} rt_svc_desc_t;
69
70/*
71 * Convenience macros to declare a service descriptor
72 */
73#define DECLARE_RT_SVC(_name, _start, _end, _type, _setup, _smch)	\
74	static const rt_svc_desc_t __svc_desc_ ## _name			\
75		__section(".rt_svc_descs") __used = {			\
76			.start_oen = (_start),				\
77			.end_oen = (_end),				\
78			.call_type = (_type),				\
79			.name = #_name,					\
80			.init = (_setup),				\
81			.handle = (_smch)				\
82		}
83
84/*
85 * Compile time assertions related to the 'rt_svc_desc' structure to:
86 * 1. ensure that the assembler and the compiler view of the size
87 *    of the structure are the same.
88 * 2. ensure that the assembler and the compiler see the initialisation
89 *    routine at the same offset.
90 * 3. ensure that the assembler and the compiler see the handler
91 *    routine at the same offset.
92 */
93CASSERT((sizeof(rt_svc_desc_t) == SIZEOF_RT_SVC_DESC),
94	assert_sizeof_rt_svc_desc_mismatch);
95CASSERT(RT_SVC_DESC_INIT == __builtin_offsetof(rt_svc_desc_t, init),
96	assert_rt_svc_desc_init_offset_mismatch);
97CASSERT(RT_SVC_DESC_HANDLE == __builtin_offsetof(rt_svc_desc_t, handle),
98	assert_rt_svc_desc_handle_offset_mismatch);
99
100
101/*
102 * This function combines the call type and the owning entity number
103 * corresponding to a runtime service to generate a unique owning entity number.
104 * This unique oen is used to access an entry in the 'rt_svc_descs_indices'
105 * array. The entry contains the index of the service descriptor in the
106 * 'rt_svc_descs' array.
107 */
108static inline uint32_t get_unique_oen(uint32_t oen, uint32_t call_type)
109{
110	return ((call_type & FUNCID_TYPE_MASK) << FUNCID_OEN_WIDTH) |
111		(oen & FUNCID_OEN_MASK);
112}
113

DETAILS

내부 동작을 더 깊게 읽기

IMPLEMENTATION NOTES

구현을 읽을 때 놓치기 쉬운 부분

OBJECT LIFETIME

객체와 수명

FAILURE PATH

실패 지점과 증상

로그가 끊긴 함수뿐 아니라 그 함수에 주소, 크기, 플래그를 전달한 앞 단계도 조사한다. 오류 처리 후 등록된 객체나 하드웨어 설정이 그대로 남아 있는지도 확인한다.

EVIDENCE

소스 밖에서 확인할 증거

소스에서 파악한 동작을 실제 빌드 결과와 대상 보드의 로그로 확인한다. 아래 명령의 보드 이름과 툴체인 접두사는 사용 중인 빌드 환경에 맞게 바꾼다.

LAB

직접 확인할 실험

1. 01
   등록 descriptor와 index table 출력

   decode owner/type 진입 전후에 rt_svc_desc_t의 주소·크기·반환값과 timestamp를 함께 남긴다.

2. 02
   unknown SMC ID 반환값 확인

   descriptor index 진입 전후에 runtime_svc_descs_indices의 주소·크기·반환값과 timestamp를 함께 남긴다.

3. 03
   32-bit caller에서 64-bit pointer 전달 거부 확인

   service handler 진입 전후에 SMCCC registers의 주소·크기·반환값과 timestamp를 함께 남긴다.

PRIMARY REFERENCES

원문과 다음 글