console parser와 정적 command table | LK

QUESTION

console parser와 정적 command table 단계에서 실제로 바뀌는 상태는 무엇인가?

고정 길이 line buffer, quoting, command 재진입과 lock을 본다. 디버그 shell이라도 입력 길이와 handler의 blocking 특성을 무시하면 부트 경로를 멈출 수 있다.

parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다. 이 문장을 기준으로 코드를 위에서 아래로 읽으면, 함수 이름을 외우는 대신 어느 시점에 어떤 상태를 신뢰할 수 있는지 판단할 수 있다.

STRUCTURE

객체와 주소가 놓이는 구조

그림 1. console parser와 정적 command table에서 입력, 내부 상태, 출력의 경계

입력과 전제내부 상태외부로 공개되는 결과

01console buffer

02argv tokens

03cmd table

04command context

INVARIANT

parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다.

console_t / console_cmd / argv buffer를 중심에 놓고 왼쪽의 입력이 어떤 검사를 거쳐 오른쪽 결과로 공개되는지 표시했다. 실제 디버깅에서는 각 블록의 주소와 크기를 로그에 대입한다.

CALL PATH

실행 흐름

그림 2. 정상 경로의 주요 호출과 상태 전달

UART input

line reader

tokenize

command lookup

handler return

화살표는 단순 호출 순서만 뜻하지 않는다. 각 단계가 성공을 반환할 때 다음 단계가 읽을 수 있는 상태가 무엇인지 함께 확인한다. 오류 반환이 발생하면 바로 다음 화살표로 진행하지 않고 해당 단계의 정리 경로를 따라간다.

STATE LEDGER

단계별 입력과 출력

호출 순서를 함수 이름으로만 외우지 않고, 각 단계가 무엇을 받아 무엇을 공개하는지 적은 표다. 실제 소스에서 생산 필드가 다르면 표를 고치는 방식으로 사용한다.

#	단계	진입 시 신뢰할 상태	성공 뒤 남아야 할 상태	다음 소비자
01	`UART input`	부트 CPU의 동기 실행 문맥	console buffer	line reader
02	`line reader`	UART input 완료 상태	argv tokens	tokenize
03	`tokenize`	line reader 완료 상태	cmd table	command lookup
04	`command lookup`	tokenize 완료 상태	command context	handler return
05	`handler return`	command lookup 완료 상태	command context	최종 최종 부트로더 이미지 또는 다음 stage

공통 불변 조건: parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다. 한 단계의 출력이 다음 단계의 입력 조건을 만족하지 않으면 오류가 실제로 드러난 위치보다 앞의 생산 단계부터 조사한다.

UPSTREAM SOURCE

원본 코드

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

commit1eb99171efae98867d4be4a5bd6479ea03f43ac9symbolstatic int console_run_script_etc

726
727    // we're done
728    if (lineread->string[lineread->pos] == 0)
729        return -1;
730
731    size_t bufpos = 0;
732    while (lineread->string[lineread->pos] != 0) {
733        if (lineread->string[lineread->pos] == '\n') {
734            lineread->pos++;
735            break;
736        }
737        if (bufpos == (lineread->buflen - 1))
738            break;
739        lineread->buffer[bufpos] = lineread->string[lineread->pos];
740        lineread->pos++;
741        bufpos++;
742    }
743    lineread->buffer[bufpos] = 0;
744
745    *buffer = lineread->buffer;
746
747    return bufpos;
748}
749
750static int console_run_script_etc(console_t *con, const char *string, bool locked) {
751    struct line_read_struct lineread;
752
753    lineread.string = string;
754    lineread.pos = 0;
755    lineread.buffer = malloc(LINE_LEN);
756    lineread.buflen = LINE_LEN;
757
758    command_loop(con, &fetch_next_line, (void *)&lineread, false, locked);
759
760    free(lineread.buffer);
761
762    return con->lastresult;
763}
764
765int console_run_script(console_t *con, const char *string) {
766    if (!con) {
767        con = console_get_current();
768    }
769    return console_run_script_etc(con, string, false);
770}
771
772int console_run_script_locked(console_t *con, const char *string) {
773    if (!con) {
774        con = console_get_current();
775    }
776    return console_run_script_etc(con, string, true);
777}
778
779console_cmd_func console_get_command_handler(const char *commandstr) {
780    const console_cmd *command = match_command(commandstr, CMD_AVAIL_NORMAL);
781
782    if (command)
783        return command->cmd_callback;
784    else
785        return NULL;
786}
787
788static int cmd_help_impl(uint8_t availability_mask) {
789    printf("command list by block:\n");
790
791    for (const console_cmd_block *block = &__start_commands; block != &__stop_commands; block++) {
792        const console_cmd *curr_cmd = block->list;
793        printf("  [%s]\n", block->name);
794        for (size_t i = 0; i < block->count; i++) {
795            if ((availability_mask & curr_cmd[i].availability_mask) == 0) {
796                // Skip commands that aren't available in the current shell.
797                continue;
798            }
799            if (curr_cmd[i].help_str)
800                printf("\t%-16s: %s\n", curr_cmd[i].cmd_str, curr_cmd[i].help_str);
801        }
802    }
803
804    return 0;
805}
806
807static int cmd_help(int argc, const console_cmd_args *argv) {
808    return cmd_help_impl(CMD_AVAIL_NORMAL);
809}
810
811static int cmd_help_panic(int argc, const console_cmd_args *argv) {
812    return cmd_help_impl(CMD_AVAIL_PANIC);
813}
814

LINE BY LINE

726-814줄 해설

원본에 보이는 모든 줄을 순서대로 설명한다. 빈 줄도 block 경계로 남겨, 코드와 설명의 위치가 어긋나지 않게 했다.

726(빈 줄)

이전 block 경계까지의 동작과 // we're done에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 console buffer 상태가 아래 블록의 입력으로 사용되는 경계다.

727// we're done

원본 주석이 'we're done'라고 기록한 줄이다. 바로 아래 구현이 이 전제와 같은 순서·단위를 사용하는지 대조한다.

728if (lineread->string[lineread->pos] == 0)

lineread->string[lineread->pos] == 0를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 'parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.

729return -1;

-1를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 console_t / console_cmd / argv buffer를 정리하거나 다음 단계로 진행하는지 확인한다.

730(빈 줄)

return -1;까지의 동작과 size_t bufpos = 0;에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

731size_t bufpos = 0;

size_t bufpos = 0를 선언한다. 함수 안 선언이면 현재 stack frame, file scope와 static이면 image의 data/BSS에 놓인다. 이 값이 console_t / console_cmd / argv buffer를 직접 소유하는지 pointer만 빌리는지, 부트 CPU의 동기 실행 문맥를 벗어난 뒤에도 참조되는지 다음 대입과 callback 등록까지 따라간다.

732while (lineread->string[lineread->pos] != 0) {

'while (lineread->string[lineread->pos] != 0) {'가 목록이나 후보를 순회한다. 반복 중 console_t / console_cmd / argv buffer를 제거·추가하는 호출이 있는지와 loop 종료 뒤 iterator가 유효한지 확인한다.

733if (lineread->string[lineread->pos] == '\n') {

lineread->string[lineread->pos] == '\n'를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 'parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.

734lineread->pos++;

원본 734번 줄의 lineread->pos++;는 앞의 if (lineread->string[lineread->pos] == '\n') { 결과를 받아 다음 break;로 넘기는 중간 연산이다. 이 줄이 바꾸는 register·field·list link를 찾고, 변경 뒤에도 'parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다' 조건이 유지되는지 확인한다.

735break;

'break;'로 직선 경로를 벗어난다. 이동 대상에서 console_t / console_cmd / argv buffer에 걸린 lock, allocation, list 등록을 어디까지 되돌리는지 이어서 확인한다.

736}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

737if (bufpos == (lineread->buflen - 1))

bufpos == (lineread->buflen - 1)를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 'parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.

738break;

'break;'로 직선 경로를 벗어난다. 이동 대상에서 console_t / console_cmd / argv buffer에 걸린 lock, allocation, list 등록을 어디까지 되돌리는지 이어서 확인한다.

739lineread->buffer[bufpos] = lineread->string[lineread->pos];

lineread->buffer[bufpos]에 lineread->string[lineread->pos]를 = 연산으로 반영해 console_t / console_cmd / argv buffer와 연결된 field를 갱신한다. 이후 handler return 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.

740lineread->pos++;

원본 740번 줄의 lineread->pos++;는 앞의 lineread->buffer[bufpos] = lineread->string[lineread->pos]; 결과를 받아 다음 bufpos++;로 넘기는 중간 연산이다. 이 줄이 바꾸는 register·field·list link를 찾고, 변경 뒤에도 'parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다' 조건이 유지되는지 확인한다.

741bufpos++;

원본 741번 줄의 bufpos++;는 앞의 lineread->pos++; 결과를 받아 다음 }로 넘기는 중간 연산이다. 이 줄이 바꾸는 register·field·list link를 찾고, 변경 뒤에도 'parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다' 조건이 유지되는지 확인한다.

742}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

743lineread->buffer[bufpos] = 0;

lineread->buffer[bufpos]에 0를 = 연산으로 반영해 console_t / console_cmd / argv buffer와 연결된 field를 갱신한다. 이후 handler return 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.

744(빈 줄)

lineread->buffer[bufpos] = 0;까지의 동작과 *buffer = lineread->buffer;에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

745*buffer = lineread->buffer;

원본 주석이 'buffer = lineread->buffer;'라고 기록한 줄이다. 바로 아래 구현이 이 전제와 같은 순서·단위를 사용하는지 대조한다.

746(빈 줄)

*buffer = lineread->buffer;까지의 동작과 return bufpos;에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

747return bufpos;

bufpos를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 console_t / console_cmd / argv buffer를 정리하거나 다음 단계로 진행하는지 확인한다.

748}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

749(빈 줄)

}까지의 동작과 static int console_run_script_etc(console_t *con, const char *string, bool locked) {에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

750static int console_run_script_etc(console_t *con, const char *string, bool locked) {

console_run_script_etc 함수 정의가 시작된다. 입력은 console_t *con, const char *string, bool locked이며, 부트 CPU의 동기 실행 문맥에서 호출된다는 전제로 반환 전까지의 상태 변화를 읽는다.

751struct line_read_struct lineread;

struct line_read_struct lineread를 선언한다. 함수 안 선언이면 현재 stack frame, file scope와 static이면 image의 data/BSS에 놓인다. 이 값이 console_t / console_cmd / argv buffer를 직접 소유하는지 pointer만 빌리는지, 부트 CPU의 동기 실행 문맥를 벗어난 뒤에도 참조되는지 다음 대입과 callback 등록까지 따라간다.

752(빈 줄)

struct line_read_struct lineread;까지의 동작과 lineread.string = string;에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

753lineread.string = string;

lineread.string에 string를 = 연산으로 반영해 console_t / console_cmd / argv buffer와 연결된 field를 갱신한다. 이후 handler return 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.

754lineread.pos = 0;

lineread.pos에 0를 = 연산으로 반영해 console_t / console_cmd / argv buffer와 연결된 field를 갱신한다. 이후 handler return 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.

755lineread.buffer = malloc(LINE_LEN);

lineread.buffer에 malloc(LINE_LEN)를 = 연산으로 반영해 console_t / console_cmd / argv buffer와 연결된 field를 갱신한다. 이후 handler return 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.

756lineread.buflen = LINE_LEN;

lineread.buflen에 LINE_LEN를 = 연산으로 반영해 console_t / console_cmd / argv buffer와 연결된 field를 갱신한다. 이후 handler return 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.

757(빈 줄)

lineread.buflen = LINE_LEN;까지의 동작과 command_loop(con, &fetch_next_line, (void *)&lineread, false, locked);에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

758command_loop(con, &fetch_next_line, (void *)&lineread, false, locked);

command_loop(con, &fetch_next_line, (void *)&lineread, false, locked)를 호출한다. 반환값을 직접 사용하지 않으므로 이 함수가 실패를 내부 처리하는지 확인해야 한다. pointer 인자는 console_t / console_cmd / argv buffer의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 command context 항목과 대조한다.

759(빈 줄)

command_loop(con, &fetch_next_line, (void *)&lineread, false, locked);까지의 동작과 free(lineread.buffer);에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

760free(lineread.buffer);

free(lineread.buffer)를 호출한다. 반환값을 직접 사용하지 않으므로 이 함수가 실패를 내부 처리하는지 확인해야 한다. pointer 인자는 console_t / console_cmd / argv buffer의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 command context 항목과 대조한다.

761(빈 줄)

free(lineread.buffer);까지의 동작과 return con->lastresult;에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

762return con->lastresult;

con->lastresult를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 console_t / console_cmd / argv buffer를 정리하거나 다음 단계로 진행하는지 확인한다.

763}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

764(빈 줄)

}까지의 동작과 int console_run_script(console_t *con, const char *string) {에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

765int console_run_script(console_t *con, const char *string) {

console_run_script 함수 정의가 시작된다. 입력은 console_t *con, const char *string이며, 부트 CPU의 동기 실행 문맥에서 호출된다는 전제로 반환 전까지의 상태 변화를 읽는다.

766if (!con) {

!con를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 'parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.

767con = console_get_current();

con에 console_get_current()를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 이후 handler return 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.

768}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

769return console_run_script_etc(con, string, false);

console_run_script_etc(con, string, false)를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 console_t / console_cmd / argv buffer를 정리하거나 다음 단계로 진행하는지 확인한다.

770}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

771(빈 줄)

}까지의 동작과 int console_run_script_locked(console_t *con, const char *string) {에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

772int console_run_script_locked(console_t *con, const char *string) {

console_run_script_locked 함수 정의가 시작된다. 입력은 console_t *con, const char *string이며, 부트 CPU의 동기 실행 문맥에서 호출된다는 전제로 반환 전까지의 상태 변화를 읽는다.

773if (!con) {

774con = console_get_current();

775}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

776return console_run_script_etc(con, string, true);

console_run_script_etc(con, string, true)를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 console_t / console_cmd / argv buffer를 정리하거나 다음 단계로 진행하는지 확인한다.

777}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

778(빈 줄)

}까지의 동작과 console_cmd_func console_get_command_handler(const char *commandstr) {에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

779console_cmd_func console_get_command_handler(const char *commandstr) {

console_get_command_handler 함수 정의가 시작된다. 입력은 const char *commandstr이며, 부트 CPU의 동기 실행 문맥에서 호출된다는 전제로 반환 전까지의 상태 변화를 읽는다.

780const console_cmd *command = match_command(commandstr, CMD_AVAIL_NORMAL);

const console_cmd *command에 match_command(commandstr, CMD_AVAIL_NORMAL)를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 이후 handler return 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.

781(빈 줄)

const console_cmd *command = match_command(commandstr, CMD_AVAIL_NORMAL);까지의 동작과 if (command)에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

782if (command)

command를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 'parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.

783return command->cmd_callback;

command->cmd_callback를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 console_t / console_cmd / argv buffer를 정리하거나 다음 단계로 진행하는지 확인한다.

784else

원본 784번 줄의 else는 앞의 return command->cmd_callback; 결과를 받아 다음 return NULL;로 넘기는 중간 연산이다. 이 줄이 바꾸는 register·field·list link를 찾고, 변경 뒤에도 'parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다' 조건이 유지되는지 확인한다.

785return NULL;

NULL를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 console_t / console_cmd / argv buffer를 정리하거나 다음 단계로 진행하는지 확인한다.

786}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

787(빈 줄)

}까지의 동작과 static int cmd_help_impl(uint8_t availability_mask) {에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

788static int cmd_help_impl(uint8_t availability_mask) {

cmd_help_impl 함수 정의가 시작된다. 입력은 uint8_t availability_mask이며, 부트 CPU의 동기 실행 문맥에서 호출된다는 전제로 반환 전까지의 상태 변화를 읽는다.

789printf("command list by block:\n");

printf("command list by block:\n")를 호출한다. 반환값을 직접 사용하지 않으므로 이 함수가 실패를 내부 처리하는지 확인해야 한다. pointer 인자는 console_t / console_cmd / argv buffer의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 command context 항목과 대조한다.

790(빈 줄)

printf("command list by block:\n");까지의 동작과 for (const console_cmd_block *block = &__start_commands; block != &__stop_commands; block++) {에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

791for (const console_cmd_block *block = &__start_commands; block != &__stop_commands; block++) {

'for (const console_cmd_block *block = &__start_commands; block != &__stop_commands; block++) {'가 목록이나 후보를 순회한다. 반복 중 console_t / console_cmd / argv buffer를 제거·추가하는 호출이 있는지와 loop 종료 뒤 iterator가 유효한지 확인한다.

792const console_cmd *curr_cmd = block->list;

const console_cmd *curr_cmd에 block->list를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 이후 handler return 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.

793printf(" [%s]\n", block->name);

printf(" [%s]\n", block->name)를 호출한다. 반환값을 직접 사용하지 않으므로 이 함수가 실패를 내부 처리하는지 확인해야 한다. pointer 인자는 console_t / console_cmd / argv buffer의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 command context 항목과 대조한다.

794for (size_t i = 0; i < block->count; i++) {

'for (size_t i = 0; i < block->count; i++) {'가 목록이나 후보를 순회한다. 반복 중 console_t / console_cmd / argv buffer를 제거·추가하는 호출이 있는지와 loop 종료 뒤 iterator가 유효한지 확인한다.

795if ((availability_mask & curr_cmd[i].availability_mask) == 0) {

(availability_mask & curr_cmd[i].availability_mask) == 0를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 'parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.

796// Skip commands that aren't available in the current shell.

원본 주석이 'Skip commands that aren't available in the current shell.'라고 기록한 줄이다. 바로 아래 구현이 이 전제와 같은 순서·단위를 사용하는지 대조한다.

797continue;

'continue;'로 직선 경로를 벗어난다. 이동 대상에서 console_t / console_cmd / argv buffer에 걸린 lock, allocation, list 등록을 어디까지 되돌리는지 이어서 확인한다.

798}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

799if (curr_cmd[i].help_str)

curr_cmd[i].help_str를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 'parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.

800printf("\t%-16s: %s\n", curr_cmd[i].cmd_str, curr_cmd[i].help_str);

printf("\t%-16s: %s\n", curr_cmd[i].cmd_str, curr_cmd[i].help_str)를 호출한다. 반환값을 직접 사용하지 않으므로 이 함수가 실패를 내부 처리하는지 확인해야 한다. pointer 인자는 console_t / console_cmd / argv buffer의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 command context 항목과 대조한다.

801}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

802}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

803(빈 줄)

}까지의 동작과 return 0;에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

804return 0;

0를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 console_t / console_cmd / argv buffer를 정리하거나 다음 단계로 진행하는지 확인한다.

805}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

806(빈 줄)

}까지의 동작과 static int cmd_help(int argc, const console_cmd_args *argv) {에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

807static int cmd_help(int argc, const console_cmd_args *argv) {

cmd_help 함수 정의가 시작된다. 입력은 int argc, const console_cmd_args *argv이며, 부트 CPU의 동기 실행 문맥에서 호출된다는 전제로 반환 전까지의 상태 변화를 읽는다.

808return cmd_help_impl(CMD_AVAIL_NORMAL);

cmd_help_impl(CMD_AVAIL_NORMAL)를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 console_t / console_cmd / argv buffer를 정리하거나 다음 단계로 진행하는지 확인한다.

809}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

810(빈 줄)

}까지의 동작과 static int cmd_help_panic(int argc, const console_cmd_args *argv) {에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

811static int cmd_help_panic(int argc, const console_cmd_args *argv) {

cmd_help_panic 함수 정의가 시작된다. 입력은 int argc, const console_cmd_args *argv이며, 부트 CPU의 동기 실행 문맥에서 호출된다는 전제로 반환 전까지의 상태 변화를 읽는다.

812return cmd_help_impl(CMD_AVAIL_PANIC);

cmd_help_impl(CMD_AVAIL_PANIC)를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 console_t / console_cmd / argv buffer를 정리하거나 다음 단계로 진행하는지 확인한다.

813}

현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.

814(빈 줄)

}까지의 동작과 다음 block 경계에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 command context 상태가 아래 블록의 입력으로 사용되는 경계다.

DETAILS

내부 동작을 더 깊게 읽기

진입 조건을 먼저 고정한다

UART input에서 들어온 실행은 부트 CPU의 동기 실행 문맥에 놓여 있다. 이때 interrupt, MMU/cache, stack, heap 중 무엇이 이미 준비되었는지 소스의 호출자까지 올라가 확인한다. 같은 함수라도 SPL, relocation 전후, app thread처럼 호출 문맥이 달라지면 허용되는 API와 지연 시간이 달라진다.

고정 길이 line buffer, quoting, command 재진입과 lock을 본다. 디버그 shell이라도 입력 길이와 handler의 blocking 특성을 무시하면 부트 경로를 멈출 수 있다.

중심 객체의 생성과 공개를 나눈다

이 글의 중심 객체는 console_t / console_cmd / argv buffer다. 메모리를 확보한 시점, 필드를 채운 시점, 전역 list나 다른 subsystem에 공개한 시점을 구분한다. 공개 뒤 오류가 발생한다면 목록에서 제거하고 child, buffer, reference를 역순으로 정리하는지 확인한다.

빌드 산출물 관점에서는 최종 부트로더 이미지 안에 해당 symbol과 section이 실제로 포함되었는지도 map과 objdump로 검증한다.

주소, 크기와 정렬을 계산한다

부트 코드의 오류는 논리보다 주소 계산에서 먼저 드러나는 경우가 많다. source range, destination range, header가 말하는 payload size, block 또는 page 단위를 표로 적고 각 구간의 끝 주소를 직접 계산한다. 끝 주소는 start + size - 1인지 exclusive end인지 API 계약을 확인한다.

parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다.

성공 flag와 실제 완료 시점을 맞춘다

line reader → tokenize → command lookup 구간에서는 부분 초기화 상태가 생길 수 있다. flag, list insertion, callback 등록, storage write 완료 중 무엇이 성공의 기준인지 찾는다. hardware write나 DMA가 포함되면 함수 반환과 장치 완료가 같은 시점인지도 확인한다.

다른 CPU, interrupt handler, USB completion 또는 shell command가 상태를 관찰할 수 있다면 memory ordering과 lock 범위도 함께 읽는다.

마지막 handoff의 계약을 적는다

정상 경로는 handler return에서 끝난다. 이 단계가 함수 반환인지, scheduler 전환인지, 다른 image로의 비복귀 분기인지 구분한다. 비복귀 handoff라면 cache clean/invalidate, interrupt disable, 장치 quiesce, argument register와 FDT 또는 image address가 최종 점검 항목이다.

반환하는 경로라면 caller가 오류와 부분 성공을 구분하고 다음 후보 또는 복구 경로를 선택하는지 확인한다.

IMPLEMENTATION NOTES

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

command table도 linker가 수집하는 정적 registry다

command macro가 name, help와 callback을 section에 놓고 parser가 이름으로 검색한다. 같은 이름 중복, section garbage collection과 module 미포함을 map과 help 출력으로 구분한다.

callback pointer와 descriptor 수명은 image 전체이지만 argv buffer는 한 command 실행 동안만 유효하다.

tokenizer의 quote와 길이 규칙이 입력 경계다

공백 분리, quote, escape와 최대 argument 수를 확인한다. 긴 line이 truncate된 뒤 유효한 다른 command로 해석되지 않도록 오류 처리를 본다.

숫자 변환은 base, signedness와 overflow를 검사하고 address command는 접근 가능한 range를 제한한다.

command callback의 실행 문맥을 고정한다

console thread에서 실행되는 blocking command는 다른 shell 입력을 막고 lock을 잡은 채 device completion을 기다릴 수 있다. interrupt나 timer callback에서 command를 직접 호출하지 않는다.

ctrl-c 취소, timeout과 부분 hardware 변경의 rollback을 command별로 시험한다.

OBJECT LIFETIME

객체와 수명

대상	만들어지는 시점	유효 범위	확인할 조건
`console_t / console_cmd / argv buffer`	line reader	handler return 또는 오류 정리 완료까지	parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다.
입력 buffer / metadata	UART input	parse와 검증이 끝날 때까지	길이, 정렬, 소유권, 변조 가능성
등록된 list / descriptor	tokenize	subsystem 종료 또는 image handoff까지	이중 등록, dangling pointer, 오류 unwind
hardware 또는 persistent state	실제 write/probe가 완료된 뒤	reset 또는 명시적 해제·갱신까지	flush, timeout, 전원 차단, rollback
`최종 부트로더 이미지`	link/image 생성 시점	다음 stage가 새 image로 교체할 때까지	load address, entry, section과 header 일치

FAILURE PATH

실패 지점과 증상

#	조건	관찰되는 증상	먼저 볼 단계
01	긴 입력	buffer truncation/overflow	line reader
02	console lock 재진입	deadlock	tokenize
03	알 수 없는 command 처리 오류	stale argv 사용	command lookup

로그가 끊긴 마지막 함수만 고치지 않는다. 그 함수가 받은 주소, size, flag가 만들어진 앞 단계까지 올라가고, 오류 뒤 등록 객체와 hardware 상태가 남았는지도 확인한다.

EVIDENCE

소스 밖에서 확인할 증거

소스 해석은 실제 빌드 산출물과 target 로그로 닫아야 한다. 아래 명령의 보드 이름과 toolchain prefix는 사용 중인 빌드 환경에 맞게 바꾼다.

#	목적	명령 또는 계측	판정 기준
01	빌드 구성	`make <project> -j1`	platform, target, app 선택과 linker 입력을 로그로 남긴다.
02	symbol과 주소	`nm -n build-*/lk.elf \| grep 'static int console_run_script_etc'`	init hook, app descriptor와 함수가 어느 주소에 놓였는지 확인한다.
03	어셈블리 대조	`objdump -drS build-*/lk.elf`	thread 전환과 interrupt disable 구간의 실제 명령을 확인한다.
04	초기화 순서	`init level 전후에 current_time_hires()와 함수 이름 기록`	level 내부 순서와 지연을 serial log로 남긴다.
05	문맥 확인	`current_thread, interrupt state, stack pointer 기록`	함수가 bootstrap thread인지 scheduler 이후 thread인지 구분한다.

LAB

직접 확인할 실험

01
최대 길이 직전/초과 입력 비교
line reader 진입 전후에 console buffer의 주소·크기·반환값과 timestamp를 함께 남긴다. 결과는 정상 부팅 여부로 끝내지 말고 parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다. 조건이 처음 깨지는 줄을 기록한다.
02
따옴표와 공백 token case 작성
tokenize 진입 전후에 argv tokens의 주소·크기·반환값과 timestamp를 함께 남긴다. 결과는 정상 부팅 여부로 끝내지 말고 parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다. 조건이 처음 깨지는 줄을 기록한다.
03
command 안에서 script 실행 시 locked API 확인
command lookup 진입 전후에 cmd table의 주소·크기·반환값과 timestamp를 함께 남긴다. 결과는 정상 부팅 여부로 끝내지 말고 parser가 handler에 넘기는 argc/argv는 command 실행이 끝날 때까지 유효하고 buffer 경계를 넘지 않아야 한다. 조건이 처음 깨지는 줄을 기록한다.

PRIMARY REFERENCES

원문과 다음 글

lib/console/console.cupstream 1eb9917 원본 파일 LK source tree기준 commit 1eb99171efae