APP_START descriptor와 app thread

QUESTION

APP_START descriptor와 app thread 단계에서 실제로 바뀌는 상태는 무엇인가?

STRUCTURE

객체와 주소가 놓이는 구조

CALL PATH

실행 흐름

STATE LEDGER

단계별 입력과 출력

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

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

VISUAL WALKTHROUGH

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

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

UPSTREAM SOURCE

원본 코드

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

1/*
2 * Copyright (c) 2009 Travis Geiselbrecht
3 *
4 * Use of this source code is governed by a MIT-style
5 * license that can be found in the LICENSE file or at
6 * https://opensource.org/licenses/MIT
7 */
8#include "app.h"
9
10#include <stdio.h>
11#include <string.h>
12#include <lk/err.h>
13#include <lk/console_cmd.h>
14#include <kernel/thread.h>
15
16extern const struct app_descriptor __start_apps __WEAK;
17extern const struct app_descriptor __stop_apps __WEAK;
18
19static void start_app(const struct app_descriptor *app, bool detach);
20
21/* one time setup */
22void apps_init(void) {
23    const struct app_descriptor *app;
24
25    /* call all the init routines */
26    for (app = &__start_apps; app != &__stop_apps; app++) {
27        if (app->init)
28            app->init(app);
29    }
30
31    /* start any that want to start on boot */
32    for (app = &__start_apps; app != &__stop_apps; app++) {
33        if (app->entry && (app->flags & APP_FLAG_NO_AUTOSTART) == 0) {
34            start_app(app, true);
35        }
36    }
37}
38
39static int app_thread_entry(void *arg) {
40    const struct app_descriptor *app = (const struct app_descriptor *)arg;
41
42    app->entry(app, NULL);
43
44    return 0;
45}
46
47static void start_app(const struct app_descriptor *app, bool detach) {
48    /* dont start an app that has no entry point */
49    if (app->entry == NULL) {
50        return;
51    }
52
53    uint32_t stack_size = (app->flags & APP_FLAG_CUSTOM_STACK_SIZE) ? app->stack_size : DEFAULT_STACK_SIZE;
54
55    printf("starting app %s\n", app->name);
56    thread_t *t = thread_create(app->name, &app_thread_entry, (void *)app, DEFAULT_PRIORITY, stack_size);
57    if (detach) {
58        thread_detach(t);
59        thread_resume(t);
60    } else {
61        thread_resume(t);
62        thread_join(t, NULL, INFINITE_TIME);
63    }
64}
65
66status_t app_start_by_name(const char *name, bool detached) {
67    const struct app_descriptor *app;
68
69    /* find the app and call it */
70    for (app = &__start_apps; app != &__stop_apps; app++) {
71        if (!strcmp(app->name, name)) {
72            start_app(app, detached);
73            return NO_ERROR;
74        }
75    }
76
77    return ERR_NOT_FOUND;
78}
79
80static void list_apps(void) {
81    const struct app_descriptor *app;
82
83    for (app = &__start_apps; app != &__stop_apps; app++) {
84        printf("%s\n", app->name);
85    }
86}

READING CONTRACT

발췌 범위와 읽기 기준

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

이 매크로는 함수를 호출하지 않고 특정 섹션에 정적 설명자를 배치한다. 링커가 정한 섹션 범위와 실행 플래그를 확인한다.

RELATED SOURCE

함께 읽어야 하는 원본 코드

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

39static int app_thread_entry(void *arg) {
40    const struct app_descriptor *app = (const struct app_descriptor *)arg;
41
42    app->entry(app, NULL);
43
44    return 0;
45}
46
47static void start_app(const struct app_descriptor *app, bool detach) {
48    /* dont start an app that has no entry point */
49    if (app->entry == NULL) {
50        return;
51    }
52
53    uint32_t stack_size = (app->flags & APP_FLAG_CUSTOM_STACK_SIZE) ? app->stack_size : DEFAULT_STACK_SIZE;
54
55    printf("starting app %s\n", app->name);
56    thread_t *t = thread_create(app->name, &app_thread_entry, (void *)app, DEFAULT_PRIORITY, stack_size);
57    if (detach) {
58        thread_detach(t);
59        thread_resume(t);
60    } else {
61        thread_resume(t);
62        thread_join(t, NULL, INFINITE_TIME);
63    }
64}
65
66status_t app_start_by_name(const char *name, bool detached) {
67    const struct app_descriptor *app;
68
69    /* find the app and call it */
70    for (app = &__start_apps; app != &__stop_apps; app++) {
71        if (!strcmp(app->name, name)) {
72            start_app(app, detached);
73            return NO_ERROR;
74        }
75    }
76
77    return ERR_NOT_FOUND;
78}
79
80static void list_apps(void) {
81    const struct app_descriptor *app;
82
83    for (app = &__start_apps; app != &__stop_apps; app++) {
84        printf("%s\n", app->name);
85    }
86}
87
88static int cmd_app(int argc, const console_cmd_args *argv) {
89    if (argc == 1) {
90usage:
91        printf("%s subcommands:\n", argv[0].str);
92        printf("%s list         : list apps compiled into the system\n", argv[0].str);
93        printf("%s start <name> : run app\n", argv[0].str);
94        return ERR_INVALID_ARGS;
95    } else if (!strcmp(argv[1].str, "list")) {

DETAILS

내부 동작을 더 깊게 읽기

IMPLEMENTATION NOTES

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

OBJECT LIFETIME

객체와 수명

FAILURE PATH

실패 지점과 증상

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

EVIDENCE

소스 밖에서 확인할 증거

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

LAB

직접 확인할 실험

1. 01
   map에서 apps section 시작/끝 확인

   linker app section 진입 전후에 app_descriptor array의 주소·크기·반환값과 timestamp를 함께 남긴다.

2. 02
   APP_START 하나 추가 후 descriptor 수 비교

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

3. 03
   APP_FLAG_DONT_START_ON_BOOT 변경 효과 확인

   app init 진입 전후에 entry function의 주소·크기·반환값과 timestamp를 함께 남긴다.

PRIMARY REFERENCES

원문과 다음 글