classic fastboot command loop

QUESTION

classic fastboot command loop 단계에서 실제로 바뀌는 상태는 무엇인가?

STRUCTURE

객체와 주소가 놓이는 구조

CALL PATH

실행 흐름

STATE LEDGER

단계별 입력과 출력

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

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

VISUAL WALKTHROUGH

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

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

UPSTREAM SOURCE

원본 코드

아래 코드는 LK / classic AOSP aboot AOSP 9d6e28f의 app/aboot/fastboot.c에서 270-358줄을 그대로 가져온 것이다. 설명을 위해 실제 코드를 가짜 의사 코드로 바꾸지 않았다.

270{
271	STACKBUF_DMA_ALIGN(response, MAX_RSP_SIZE);
272	unsigned len = hex2unsigned(arg);
273	int r;
274
275	download_size = 0;
276	if (len > download_max) {
277		fastboot_fail("data too large");
278		return;
279	}
280
281	snprintf(response, MAX_RSP_SIZE, "DATA%08x", len);
282	if (usb_write(response, strlen(response)) < 0)
283		return;
284
285	r = usb_read(download_base, len);
286	if ((r < 0) || ((unsigned) r != len)) {
287		fastboot_state = STATE_ERROR;
288		return;
289	}
290	download_size = len;
291	fastboot_okay("");
292}
293
294static void fastboot_command_loop(void)
295{
296	struct fastboot_cmd *cmd;
297	int r;
298	dprintf(INFO,"fastboot: processing commands\n");
299
300	uint8_t *buffer = (uint8_t *)memalign(CACHE_LINE, ROUNDUP(4096, CACHE_LINE));
301	if (!buffer)
302	{
303		dprintf(CRITICAL, "Could not allocate memory for fastboot buffer\n.");
304		ASSERT(0);
305	}
306again:
307	while (fastboot_state != STATE_ERROR) {
308		r = usb_read(buffer, MAX_RSP_SIZE);
309		if (r < 0) break;
310		buffer[r] = 0;
311		dprintf(INFO,"fastboot: %s\n", buffer);
312
313		for (cmd = cmdlist; cmd; cmd = cmd->next) {
314			if (memcmp(buffer, cmd->prefix, cmd->prefix_len))
315				continue;
316			fastboot_state = STATE_COMMAND;
317			cmd->handle((const char*) buffer + cmd->prefix_len,
318				    (void*) download_base, download_size);
319			if (fastboot_state == STATE_COMMAND)
320				fastboot_fail("unknown reason");
321			goto again;
322		}
323
324		fastboot_fail("unknown command");
325			
326	}
327	fastboot_state = STATE_OFFLINE;
328	dprintf(INFO,"fastboot: oops!\n");
329	free(buffer);
330}
331
332static int fastboot_handler(void *arg)
333{
334	for (;;) {
335		event_wait(&usb_online);
336		fastboot_command_loop();
337	}
338	return 0;
339}
340
341static void fastboot_notify(struct udc_gadget *gadget, unsigned event)
342{
343	if (event == UDC_EVENT_ONLINE) {
344		event_signal(&usb_online, 0);
345	}
346}
347
348static struct udc_endpoint *fastboot_endpoints[2];
349
350static struct udc_gadget fastboot_gadget = {
351	.notify		= fastboot_notify,
352	.ifc_class	= 0xff,
353	.ifc_subclass	= 0x42,
354	.ifc_protocol	= 0x03,
355	.ifc_endpoints	= 2,
356	.ifc_string	= "fastboot",
357	.ept		= fastboot_endpoints,
358};

READING CONTRACT

발췌 범위와 읽기 기준

원문 270-358줄에는 앞뒤 문맥이 포함됩니다. 기준 구문 static void fastboot_command_loop(void)은 L294에 있습니다. 발췌 첫 줄을 함수 정의의 시작으로 해석하지 않습니다.

prefix matching 순서, buffer termination과 command handler가 공유하는 global download state를 본다. transport completion과 storage completion을 분리한다.

RELATED SOURCE

함께 읽어야 하는 원본 코드

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

77};
78
79struct fastboot_var {
80	struct fastboot_var *next;
81	const char *name;
82	const char *value;
83};
84	
85static struct fastboot_cmd *cmdlist;
86
87void fastboot_register(const char *prefix,
88		       void (*handle)(const char *arg, void *data, unsigned sz))
89{
90	struct fastboot_cmd *cmd;
91	cmd = malloc(sizeof(*cmd));
92	if (cmd) {
93		cmd->prefix = prefix;
94		cmd->prefix_len = strlen(prefix);
95		cmd->handle = handle;
96		cmd->next = cmdlist;
97		cmdlist = cmd;
98	}
99}
100
101static struct fastboot_var *varlist;
102
103void fastboot_publish(const char *name, const char *value)
104{
105	struct fastboot_var *var;
106	var = malloc(sizeof(*var));
107	if (var) {
108		var->name = name;
109		var->value = value;
110		var->next = varlist;
111		varlist = var;
112	}
113}
114
115
116static event_t usb_online;
117static event_t txn_done;
118static struct udc_endpoint *in, *out;
119static struct udc_request *req;
120int txn_status;
121
122static void *download_base;
123static unsigned download_max;
124static unsigned download_size;
125
126#define STATE_OFFLINE	0
127#define STATE_COMMAND	1
128#define STATE_COMPLETE	2
129#define STATE_ERROR	3
130
131static unsigned fastboot_state = STATE_OFFLINE;
132
133static void req_complete(struct udc_request *req, unsigned actual, int status)
134{
135	txn_status = status;
136	req->length = actual;
137
138	event_signal(&txn_done, 0);
139}
140
141static int usb_read(void *_buf, unsigned len)
142{
143	int r;
144	unsigned xfer;
145	unsigned char *buf = _buf;

DETAILS

내부 동작을 더 깊게 읽기

IMPLEMENTATION NOTES

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

OBJECT LIFETIME

객체와 수명

FAILURE PATH

실패 지점과 증상

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

EVIDENCE

소스 밖에서 확인할 증거

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

LAB

직접 확인할 실험

1. 01
   등록 command 순서와 prefix 목록 출력

   command prefix match 진입 전후에 USB request buffer의 주소·크기·반환값과 timestamp를 함께 남긴다.

2. 02
   최대 command length 입력

   download/handler 진입 전후에 command registry의 주소·크기·반환값과 timestamp를 함께 남긴다.

3. 03
   unknown command 뒤 다음 정상 command 처리 확인

   response queue 진입 전후에 download state의 주소·크기·반환값과 timestamp를 함께 남긴다.

PRIMARY REFERENCES

원문과 다음 글