console parser와 정적 command table

QUESTION

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

STRUCTURE

객체와 주소가 놓이는 구조

CALL PATH

실행 흐름

STATE LEDGER

단계별 입력과 출력

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

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

VISUAL WALKTHROUGH

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

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

UPSTREAM SOURCE

원본 코드

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

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

READING CONTRACT

발췌 범위와 읽기 기준

원문 726-814줄에는 앞뒤 문맥이 포함됩니다. 기준 구문 static int console_run_script_etc은 L750에 있습니다. 발췌 첫 줄을 함수 정의의 시작으로 해석하지 않습니다.

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

RELATED SOURCE

함께 읽어야 하는 원본 코드

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

367    // add to history
368    add_history(con, buffer);
369#endif
370
371    // return a pointer to our buffer
372    *outbuffer = buffer;
373
374    return pos;
375}
376
377static int tokenize_command(const char *inbuffer, const char **continuebuffer, char *buffer, size_t buflen, console_cmd_args *args, int arg_count) {
378    int inpos;
379    int outpos;
380    int arg;
381    enum {
382        INITIAL = 0,
383        NEXT_FIELD,
384        SPACE,
385        IN_SPACE,
386        TOKEN,
387        IN_TOKEN,
388        QUOTED_TOKEN,
389        IN_QUOTED_TOKEN,
390        VAR,
391        IN_VAR,
392        COMMAND_SEP,
393    } state;
394    char varname[128];
395    int varnamepos;
396
397    inpos = 0;
398    outpos = 0;
399    arg = 0;
400    varnamepos = 0;
401    state = INITIAL;
402    *continuebuffer = NULL;
403
404    for (;;) {
405        char c = inbuffer[inpos];
406
407//      dprintf(SPEW, "c 0x%hhx state %d arg %d inpos %d pos %d\n", c, state, arg, inpos, outpos);
408
409        switch (state) {
410            case INITIAL:
411            case NEXT_FIELD:
412                if (c == '\0')
413                    goto done;
414                if (isspace(c))
415                    state = SPACE;
416                else if (c == ';')
417                    state = COMMAND_SEP;
418                else
419                    state = TOKEN;
420                break;
421            case SPACE:
422                state = IN_SPACE;
423                break;
424            case IN_SPACE:
425                if (c == '\0')
426                    goto done;
427                if (c == ';') {
428                    state = COMMAND_SEP;
429                } else if (!isspace(c)) {
430                    state = TOKEN;
431                } else {
432                    inpos++; // consume the space
433                }
434                break;
435            case TOKEN:
436                // start of a token
437                DEBUG_ASSERT(c != '\0');
438                if (c == '"') {
439                    // start of a quoted token
440                    state = QUOTED_TOKEN;
441                } else if (c == '$') {
442                    // start of a variable
443                    state = VAR;
444                } else {
445                    // regular, unquoted token
446                    state = IN_TOKEN;
447                    args[arg].str = &buffer[outpos];
448                }
449                break;
450            case IN_TOKEN:
451                if (c == '\0') {
452                    arg++;
453                    goto done;
454                }
455                if (isspace(c) || c == ';') {

DETAILS

내부 동작을 더 깊게 읽기

IMPLEMENTATION NOTES

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

OBJECT LIFETIME

객체와 수명

FAILURE PATH

실패 지점과 증상

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

EVIDENCE

소스 밖에서 확인할 증거

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

LAB

직접 확인할 실험

1. 01
   최대 길이 직전/초과 입력 비교

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

2. 02
   따옴표와 공백 token case 작성

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

3. 03
   command 안에서 script 실행 시 locked API 확인

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

PRIMARY REFERENCES

원문과 다음 글