lkboot의 network image 수신과 chain loading

QUESTION

lkboot의 network image 수신과 chain loading 단계에서 실제로 바뀌는 상태는 무엇인가?

STRUCTURE

객체와 주소가 놓이는 구조

CALL PATH

실행 흐름

STATE LEDGER

단계별 입력과 출력

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

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

VISUAL WALKTHROUGH

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

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

UPSTREAM SOURCE

원본 코드

아래 코드는 LK upstream 1eb9917의 app/lkboot/lkboot.c에서 263-337줄을 그대로 가져온 것이다. 설명을 위해 실제 코드를 가짜 의사 코드로 바꾸지 않았다.

263            printf("lkboot: handled command, staying in server loop\n");
264        }
265
266        /* see if we need to drop out and try to direct boot */
267        if (timeout != INFINITE_TIME && (current_time() - t >= timeout)) {
268            break;
269        }
270    }
271
272#if WITH_LIB_MINIP
273    tcp_close(listen_socket);
274#endif
275
276    printf("lkboot: server timed out\n");
277
278    return ERR_TIMED_OUT;
279}
280
281/* platform code can override this to conditionally abort autobooting from flash */
282bool platform_abort_autoboot(void);
283__WEAK bool platform_abort_autoboot(void) {
284    return false;
285}
286
287static void lkboot_task(const struct app_descriptor *app, void *args) {
288    /* read a few sysparams to decide if we're going to autoboot */
289    uint8_t autoboot = 1;
290    sysparam_read("lkboot.autoboot", &autoboot, sizeof(autoboot));
291
292    /* let platform code have a shot at disabling the autoboot behavior */
293    if (platform_abort_autoboot())
294        autoboot = 0;
295
296#if !LKBOOT_AUTOBOOT
297    autoboot = 0;
298#endif
299
300    /* if we're going to autoobot, read the timeout value */
301    lk_time_t autoboot_timeout;
302    if (!autoboot) {
303        autoboot_timeout = INFINITE_TIME;
304    } else {
305        autoboot_timeout = LKBOOT_AUTOBOOT_TIMEOUT;
306        sysparam_read("lkboot.autoboot_timeout", &autoboot_timeout, sizeof(autoboot_timeout));
307    }
308
309    TRACEF("autoboot %u autoboot_timeout %u\n", autoboot, (uint)autoboot_timeout);
310
311#if LKBOOT_WITH_SERVER
312    lkboot_server(autoboot_timeout);
313#else
314    if (autoboot_timeout != INFINITE_TIME) {
315        TRACEF("waiting for %u milliseconds before autobooting\n", (uint)autoboot_timeout);
316        thread_sleep(autoboot_timeout);
317    }
318#endif
319
320    if (autoboot_timeout != INFINITE_TIME) {
321        TRACEF("trying to boot from flash...\n");
322        status_t err = do_flash_boot();
323        TRACEF("do_flash_boot returns %d\n", err);
324    }
325
326#if LKBOOT_WITH_SERVER
327    TRACEF("restarting server\n");
328    lkboot_server(INFINITE_TIME);
329#endif
330
331    TRACEF("nothing to do, exiting\n");
332}
333
334APP_START(lkboot)
335.entry = lkboot_task,
336.flags = 0,
337APP_END

READING CONTRACT

발췌 범위와 읽기 기준

원문 263-337줄에는 앞뒤 문맥이 포함됩니다. 기준 구문 static void lkboot_task(const struct app_descriptor *app은 L287에 있습니다. 발췌 첫 줄을 함수 정의의 시작으로 해석하지 않습니다.

여기서 다루는 LK의 lkboot는 과거 Android aboot와 다르다. 프로토콜 명령, 이미지 메모리를 관리하는 주체, 이미지를 실행하기 전 하드웨어 동작을 정지시키는 절차를 구분해 살펴본다.

RELATED SOURCE

함께 읽어야 하는 원본 코드

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

169        len -= lkb->avail;
170        lkb->avail = 0;
171    }
172    return 0;
173
174fail:
175    lkb->state = STATE_ERROR;
176    return -1;
177}
178
179status_t lkboot_process_command(lkb_t *lkb) {
180    msg_hdr_t hdr;
181    char cmd[128];
182    char *arg;
183    int err;
184    const char *result;
185    unsigned len;
186
187    if (lkb->read(lkb->cookie, &hdr, sizeof(hdr))) goto fail;
188    if (hdr.opcode != MSG_CMD) goto fail;
189    if (hdr.length > 127) goto fail;
190    if (lkb->read(lkb->cookie, cmd, hdr.length)) goto fail;
191    cmd[hdr.length] = 0;
192
193    TRACEF("recv '%s'\n", cmd);
194
195    if (!(arg = strchr(cmd, ':'))) goto fail;
196    *arg++ = 0;
197    len = atoul(arg);
198    if (!(arg = strchr(arg, ':'))) goto fail;
199    arg++;
200
201    err = lkb_handle_command(lkb, cmd, arg, len, &result);
202    if (err >= 0) {
203        lkb_okay(lkb);
204    } else {
205        lkb_fail(lkb, result);
206    }
207
208    TRACEF("command handled with success\n");
209    return NO_ERROR;
210
211fail:
212    TRACEF("command failed\n");
213    return ERR_IO;
214}
215
216static status_t lkboot_server(lk_time_t timeout) {
217    lkboot_dcc_init();
218
219#if WITH_LIB_MINIP
220    /* open the server's socket */
221    tcp_socket_t *listen_socket = NULL;
222    if (tcp_open_listen(&listen_socket, 1023) < 0) {
223        printf("lkboot: error opening listen socket\n");
224        return ERR_NO_MEMORY;
225    }
226#endif
227
228    /* run the main lkserver loop */
229    printf("lkboot: starting server\n");
230    lk_time_t t = current_time(); /* remember when we started */
231    for (;;) {
232        bool handled_command = false;
233
234        lkb_t *lkb;
235
236#if WITH_LIB_MINIP
237        /* wait for a new connection */
238        lk_time_t sock_timeout = 100;
239        tcp_socket_t *s;
240        if (tcp_accept_timeout(listen_socket, &s, sock_timeout) >= 0) {
241            DEBUG_ASSERT(s);
242
243            /* handle the command and close it */
244            lkb = lkboot_tcp_opened(s);
245            lkboot_process_command(lkb);
246            free(lkb);
247            tcp_close(s);
248            handled_command = true;
249        }
250#endif
251

DETAILS

내부 동작을 더 깊게 읽기

IMPLEMENTATION NOTES

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

OBJECT LIFETIME

객체와 수명

FAILURE PATH

실패 지점과 증상

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

EVIDENCE

소스 밖에서 확인할 증거

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

LAB

직접 확인할 실험

1. 01
   protocol packet 길이 경계 시험

   lkboot protocol 진입 전후에 protocol session의 주소·크기·반환값과 timestamp를 함께 남긴다.

2. 02
   download buffer와 LK image range 비교

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

3. 03
   jump 직전 interrupt/cache 상태 기록

   validate command 진입 전후에 image metadata의 주소·크기·반환값과 timestamp를 함께 남긴다.

PRIMARY REFERENCES

원문과 다음 글