FIP I/O driver의 UUID lookup과 bounds

QUESTION

FIP I/O driver의 UUID lookup과 bounds 단계에서 실제로 바뀌는 상태는 무엇인가?

STRUCTURE

객체와 주소가 놓이는 구조

CALL PATH

실행 흐름

STATE LEDGER

단계별 입력과 출력

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

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

VISUAL WALKTHROUGH

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

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

UPSTREAM SOURCE

원본 코드

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

50	uintptr_t dev_spec;
51	size_t fip_size;
52	uint16_t plat_toc_flag;
53} fip_dev_state_t;
54
55/*
56 * Only one file can be open across all FIP device
57 * as backends like io_memmap don't support
58 * multiple open files. The file state and
59 * backend handle should be maintained per FIP device
60 * if the same support is available in the backend
61 */
62static fip_file_state_t current_fip_file = {0};
63static uintptr_t backend_dev_handle;
64static uintptr_t backend_image_spec;
65
66static fip_dev_state_t state_pool[MAX_FIP_DEVICES];
67static io_dev_info_t dev_info_pool[MAX_FIP_DEVICES];
68
69/* Track number of allocated fip devices */
70static unsigned int fip_dev_count;
71
72/* Firmware Image Package driver functions */
73static int fip_dev_open(const uintptr_t dev_spec, io_dev_info_t **dev_info);
74static int fip_file_open(io_dev_info_t *dev_info, const uintptr_t spec,
75			  io_entity_t *entity);
76static int fip_file_len(io_entity_t *entity, size_t *length);
77static int fip_file_read(io_entity_t *entity, uintptr_t buffer, size_t length,
78			  size_t *length_read);
79static int fip_file_close(io_entity_t *entity);
80static int fip_dev_init(io_dev_info_t *dev_info, const uintptr_t init_params);
81static int fip_dev_close(io_dev_info_t *dev_info);
82
83
84/* Return 0 for equal uuids. */
85static inline int compare_uuids(const uuid_t *uuid1, const uuid_t *uuid2)
86{
87	return memcmp(uuid1, uuid2, sizeof(uuid_t));
88}
89
90
91static inline int is_valid_header(fip_toc_header_t *header)
92{
93	if ((header->name == TOC_HEADER_NAME) && (header->serial_number != 0)) {
94		return 1;
95	} else {
96		return 0;
97	}
98}
99
100
101/* Identify the device type as a virtual driver */
102static io_type_t device_type_fip(void)
103{
104	return IO_TYPE_FIRMWARE_IMAGE_PACKAGE;
105}
106
107
108static const io_dev_connector_t fip_dev_connector = {
109	.dev_open = fip_dev_open
110};
111
112
113static const io_dev_funcs_t fip_dev_funcs = {
114	.type = device_type_fip,
115	.open = fip_file_open,
116	.seek = NULL,
117	.size = fip_file_len,
118	.read = fip_file_read,
119	.write = NULL,
120	.close = fip_file_close,
121	.dev_init = fip_dev_init,
122	.dev_close = fip_dev_close,
123};
124
125/* Locate a file state in the pool, specified by address */
126static int find_first_fip_state(const uintptr_t dev_spec,
127				  unsigned int *index_out)
128{
129	int result = -ENOENT;
130	unsigned int index;
131
132	for (index = 0; index < (unsigned int)MAX_FIP_DEVICES; ++index) {
133		/* dev_spec is used as identifier since it's unique */
134		if (state_pool[index].dev_spec == dev_spec) {
135			result = 0;
136			*index_out = index;
137			break;
138		}

READING CONTRACT

발췌 범위와 읽기 기준

원문 50-138줄에는 앞뒤 문맥이 포함됩니다. 기준 구문 static int fip_file_open(io_dev_info_t *dev_info은 L74에 있습니다. 발췌 첫 줄을 함수 정의의 시작으로 해석하지 않습니다.

FIP parser가 믿는 값은 storage에서 읽은 비신뢰 metadata다. terminator, serial number, offset, size와 backend length 검사를 먼저 확인한다.

RELATED SOURCE

함께 읽어야 하는 원본 코드

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

67static io_dev_info_t dev_info_pool[MAX_FIP_DEVICES];
68
69/* Track number of allocated fip devices */
70static unsigned int fip_dev_count;
71
72/* Firmware Image Package driver functions */
73static int fip_dev_open(const uintptr_t dev_spec, io_dev_info_t **dev_info);
74static int fip_file_open(io_dev_info_t *dev_info, const uintptr_t spec,
75			  io_entity_t *entity);
76static int fip_file_len(io_entity_t *entity, size_t *length);
77static int fip_file_read(io_entity_t *entity, uintptr_t buffer, size_t length,
78			  size_t *length_read);
79static int fip_file_close(io_entity_t *entity);
80static int fip_dev_init(io_dev_info_t *dev_info, const uintptr_t init_params);
81static int fip_dev_close(io_dev_info_t *dev_info);
82
83
84/* Return 0 for equal uuids. */
85static inline int compare_uuids(const uuid_t *uuid1, const uuid_t *uuid2)
86{
87	return memcmp(uuid1, uuid2, sizeof(uuid_t));
88}
89
90
91static inline int is_valid_header(fip_toc_header_t *header)
92{
93	if ((header->name == TOC_HEADER_NAME) && (header->serial_number != 0)) {
94		return 1;
95	} else {
96		return 0;
97	}
98}
99
100
101/* Identify the device type as a virtual driver */
102static io_type_t device_type_fip(void)
103{
104	return IO_TYPE_FIRMWARE_IMAGE_PACKAGE;
105}
106
107
108static const io_dev_connector_t fip_dev_connector = {
109	.dev_open = fip_dev_open
110};
111
112
113static const io_dev_funcs_t fip_dev_funcs = {
114	.type = device_type_fip,
115	.open = fip_file_open,
116	.seek = NULL,
117	.size = fip_file_len,
118	.read = fip_file_read,
119	.write = NULL,
120	.close = fip_file_close,
121	.dev_init = fip_dev_init,
122	.dev_close = fip_dev_close,
123};
124
125/* Locate a file state in the pool, specified by address */
126static int find_first_fip_state(const uintptr_t dev_spec,
127				  unsigned int *index_out)
128{
129	int result = -ENOENT;
130	unsigned int index;
131
132	for (index = 0; index < (unsigned int)MAX_FIP_DEVICES; ++index) {
133		/* dev_spec is used as identifier since it's unique */
134		if (state_pool[index].dev_spec == dev_spec) {
135			result = 0;
136			*index_out = index;
137			break;
138		}
139	}
140	return result;
141}
142
143
144/* Allocate a device info from the pool and return a pointer to it */
145static int allocate_dev_info(io_dev_info_t **dev_info)
146{
147	int result = -ENOMEM;
148
149	assert(dev_info != NULL);
150
151	if (fip_dev_count < (unsigned int)MAX_FIP_DEVICES) {
152		unsigned int index = 0;
153
154		result = find_first_fip_state(0, &index);
155		assert(result == 0);
156		/* initialize dev_info */
157		dev_info_pool[index].funcs = &fip_dev_funcs;
158		dev_info_pool[index].info =
159				(uintptr_t)&state_pool[index];
160		*dev_info = &dev_info_pool[index];
161		++fip_dev_count;
162	}
163
164	return result;
165}
166
167/* Release a device info to the pool */
168static int free_dev_info(io_dev_info_t *dev_info)
169{

70static unsigned int fip_dev_count;
71
72/* Firmware Image Package driver functions */
73static int fip_dev_open(const uintptr_t dev_spec, io_dev_info_t **dev_info);
74static int fip_file_open(io_dev_info_t *dev_info, const uintptr_t spec,
75			  io_entity_t *entity);
76static int fip_file_len(io_entity_t *entity, size_t *length);
77static int fip_file_read(io_entity_t *entity, uintptr_t buffer, size_t length,
78			  size_t *length_read);
79static int fip_file_close(io_entity_t *entity);
80static int fip_dev_init(io_dev_info_t *dev_info, const uintptr_t init_params);
81static int fip_dev_close(io_dev_info_t *dev_info);
82
83
84/* Return 0 for equal uuids. */
85static inline int compare_uuids(const uuid_t *uuid1, const uuid_t *uuid2)
86{
87	return memcmp(uuid1, uuid2, sizeof(uuid_t));
88}
89
90
91static inline int is_valid_header(fip_toc_header_t *header)
92{
93	if ((header->name == TOC_HEADER_NAME) && (header->serial_number != 0)) {
94		return 1;
95	} else {
96		return 0;
97	}
98}
99
100
101/* Identify the device type as a virtual driver */
102static io_type_t device_type_fip(void)
103{
104	return IO_TYPE_FIRMWARE_IMAGE_PACKAGE;
105}
106
107
108static const io_dev_connector_t fip_dev_connector = {
109	.dev_open = fip_dev_open
110};
111
112
113static const io_dev_funcs_t fip_dev_funcs = {
114	.type = device_type_fip,
115	.open = fip_file_open,
116	.seek = NULL,
117	.size = fip_file_len,
118	.read = fip_file_read,
119	.write = NULL,
120	.close = fip_file_close,
121	.dev_init = fip_dev_init,
122	.dev_close = fip_dev_close,
123};
124
125/* Locate a file state in the pool, specified by address */
126static int find_first_fip_state(const uintptr_t dev_spec,
127				  unsigned int *index_out)
128{
129	int result = -ENOENT;
130	unsigned int index;
131
132	for (index = 0; index < (unsigned int)MAX_FIP_DEVICES; ++index) {
133		/* dev_spec is used as identifier since it's unique */
134		if (state_pool[index].dev_spec == dev_spec) {
135			result = 0;
136			*index_out = index;
137			break;
138		}
139	}
140	return result;
141}
142
143
144/* Allocate a device info from the pool and return a pointer to it */
145static int allocate_dev_info(io_dev_info_t **dev_info)
146{
147	int result = -ENOMEM;
148
149	assert(dev_info != NULL);
150
151	if (fip_dev_count < (unsigned int)MAX_FIP_DEVICES) {
152		unsigned int index = 0;
153
154		result = find_first_fip_state(0, &index);
155		assert(result == 0);
156		/* initialize dev_info */
157		dev_info_pool[index].funcs = &fip_dev_funcs;
158		dev_info_pool[index].info =
159				(uintptr_t)&state_pool[index];
160		*dev_info = &dev_info_pool[index];
161		++fip_dev_count;
162	}
163
164	return result;
165}
166
167/* Release a device info to the pool */
168static int free_dev_info(io_dev_info_t *dev_info)

DETAILS

내부 동작을 더 깊게 읽기

IMPLEMENTATION NOTES

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

OBJECT LIFETIME

객체와 수명

FAILURE PATH

실패 지점과 증상

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

EVIDENCE

소스 밖에서 확인할 증거

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

LAB

직접 확인할 실험

1. 01
   FIP ToC offset을 변조해 open 실패 확인

   FIP header read 진입 전후에 io_dev_info_t의 주소·크기·반환값과 timestamp를 함께 남긴다.

2. 02
   동시에 두 FIP device를 열어 state 분리 확인

   ToC scan 진입 전후에 fip_toc_header의 주소·크기·반환값과 timestamp를 함께 남긴다.

3. 03
   짧은 backend에서 read 반환값 기록

   UUID match 진입 전후에 fip_toc_entry의 주소·크기·반환값과 timestamp를 함께 남긴다.

PRIMARY REFERENCES

원문과 다음 글