QUESTION
envfs load와 default environment 단계에서 실제로 바뀌는 상태는 무엇인가?
U-Boot의 key-value blob과 달리 Barebox 환경은 파일과 script 중심이다. 저장 image의 integrity, extraction path와 default overlay 순서를 확인한다.
검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다. 이 문장을 기준으로 코드를 위에서 아래로 읽으면, 함수 이름을 외우는 대신 어느 시점에 어떤 상태를 신뢰할 수 있는지 판단할 수 있다.
STRUCTURE
객체와 주소가 놓이는 구조
검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다.
envfs_super / environment directory를 중심에 놓고 왼쪽의 입력이 어떤 검사를 거쳐 오른쪽 결과로 공개되는지 표시했다. 실제 디버깅에서는 각 블록의 주소와 크기를 로그에 대입한다.
CALL PATH
실행 흐름
화살표는 단순 호출 순서만 뜻하지 않는다. 각 단계가 성공을 반환할 때 다음 단계가 읽을 수 있는 상태가 무엇인지 함께 확인한다. 오류 반환이 발생하면 바로 다음 화살표로 진행하지 않고 해당 단계의 정리 경로를 따라간다.
STATE LEDGER
단계별 입력과 출력
호출 순서를 함수 이름으로만 외우지 않고, 각 단계가 무엇을 받아 무엇을 공개하는지 적은 표다. 실제 소스에서 생산 필드가 다르면 표를 고치는 방식으로 사용한다.
| # | 단계 | 진입 시 신뢰할 상태 | 성공 뒤 남아야 할 상태 | 다음 소비자 |
|---|---|---|---|---|
| 01 | environment cdev/file | 부트 CPU의 동기 실행 문맥 | envfs image | envfs superblock |
| 02 | envfs superblock | environment cdev/file 완료 상태 | superblock/inodes | CRC/decompress |
| 03 | CRC/decompress | envfs superblock 완료 상태 | runtime directory | extract files |
| 04 | extract files | CRC/decompress 완료 상태 | global variables | shell variables/scripts |
| 05 | shell variables/scripts | extract files 완료 상태 | global variables | 최종 최종 부트로더 이미지 또는 다음 stage |
공통 불변 조건: 검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다. 한 단계의 출력이 다음 단계의 입력 조건을 만족하지 않으면 오류가 실제로 드러난 위치보다 앞의 생산 단계부터 조사한다.
UPSTREAM SOURCE
원본 코드
아래 코드는 Barebox v2026.06.1의 common/environment.c에서 422-510줄을 그대로 가져온 것이다. 설명을 위해 실제 코드를 가짜 의사 코드로 바꾸지 않았다.
422 defenv_path = default_environment_path_get();
423 if (defenv_path && !strcmp(filename, defenv_path))
424 nv_var_set_clean();
425#endif
426out:
427 close(envfd);
428out1:
429 free(buf);
430#ifdef __BAREBOX__
431 unlink_recursive(TMPDIR, NULL);
432#endif
433 return ret;
434}
435EXPORT_SYMBOL(envfs_save);
436
437/**
438 * Restore the last environment into the current one
439 * @param[in] filename from where to restore
440 * @param[in] dir where to store the last content
441 * @return 0 on success, anything else in case of failure
442 *
443 * Note: This function will also be used on the host! See note in the header
444 * of this file.
445 */
446int envfs_load(const char *filename, const char *dir, unsigned flags)
447{
448 struct envfs_super super;
449 void *buf = NULL, *rbuf;
450 int envfd;
451 int ret = 0;
452 size_t size, rsize;
453 __maybe_unused const char *defenv_path;
454
455#ifdef __BAREBOX__
456 if (!IS_ALLOWED(SCONFIG_ENVIRONMENT_LOAD))
457 return -EPERM;
458#endif
459
460 if (!filename)
461 filename = default_environment_path_get();
462 if (!filename)
463 return -ENOENT;
464
465 if (!dir)
466 dir = "/env";
467
468 envfd = open(filename, O_RDONLY);
469 if (envfd < 0) {
470 printf("environment load %s: %m\n", filename);
471 if (errno == ENOENT)
472 printf("Maybe you have to create the partition.\n");
473 return -1;
474 }
475
476 /* read superblock */
477 ret = read(envfd, &super, sizeof(struct envfs_super));
478 if ( ret < sizeof(struct envfs_super)) {
479 perror("read");
480 ret = -errno;
481 goto out;
482 }
483
484 ret = envfs_check_super(&super, &size);
485 if (ret)
486 goto out;
487
488 if (super.flags & ENVFS_FLAGS_FORCE_BUILT_IN) {
489 printf("found force-builtin environment, using defaultenv\n");
490 ret = defaultenv_load(dir, 0);
491 if (ret)
492 printf("failed to load default environment: %s\n",
493 strerror(-ret));
494 goto out;
495 }
496
497 buf = xmalloc(size);
498
499 rbuf = buf;
500 rsize = size;
501
502 while (rsize) {
503 ssize_t now;
504
505 now = read(envfd, rbuf, rsize);
506 if (now < 0) {
507 perror("read");
508 ret = -errno;
509 goto out;
510 }
LINE BY LINE
422-510줄 해설
원본에 보이는 모든 줄을 순서대로 설명한다. 빈 줄도 block 경계로 남겨, 코드와 설명의 위치가 어긋나지 않게 했다.
defenv_path = default_environment_path_get();defenv_path에 default_environment_path_get()를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 바로 다음 if (defenv_path && !strcmp(filename, defenv_path))가 이 값을 다시 읽으므로 그 전까지 완성된 값이어야 한다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.
if (defenv_path && !strcmp(filename, defenv_path))defenv_path && !strcmp(filename, defenv_path)를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.
nv_var_set_clean();nv_var_set_clean(인자 없음)를 호출한다. 반환값을 직접 사용하지 않으므로 이 함수가 실패를 내부 처리하는지 확인해야 한다. pointer 인자는 envfs_super / environment directory의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 runtime directory 항목과 대조한다.
#endif#endif 전처리 지시문으로 이 줄 아래의 code가 binary에 존재할지를 결정한다. architecture 또는 build stage 조건을 여닫는다. 현재 .config와 compiler의 -dD -E 출력에서 실제로 남은 branch를 확인한 뒤 line-by-line 흐름에 포함한다.
out:'out' label이다. 이곳을 참조하는 branch를 역검색하고 각 진입 경로의 register, stack, lock 조건이 같은지 확인한다.
close(envfd);close(envfd)를 호출한다. 반환값을 직접 사용하지 않으므로 이 함수가 실패를 내부 처리하는지 확인해야 한다. pointer 인자는 envfs_super / environment directory의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 global variables 항목과 대조한다.
out1:'out1' label이다. 이곳을 참조하는 branch를 역검색하고 각 진입 경로의 register, stack, lock 조건이 같은지 확인한다.
free(buf);free(buf)를 호출한다. 반환값을 직접 사용하지 않으므로 이 함수가 실패를 내부 처리하는지 확인해야 한다. pointer 인자는 envfs_super / environment directory의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 global variables 항목과 대조한다.
#ifdef __BAREBOX__#ifdef 전처리 지시문으로 이 줄 아래의 code가 binary에 존재할지를 결정한다. architecture 또는 build stage 조건을 여닫는다. 현재 .config와 compiler의 -dD -E 출력에서 실제로 남은 branch를 확인한 뒤 line-by-line 흐름에 포함한다.
unlink_recursive(TMPDIR, NULL);unlink_recursive(TMPDIR, NULL)를 호출한다. 반환값을 직접 사용하지 않으므로 이 함수가 실패를 내부 처리하는지 확인해야 한다. pointer 인자는 envfs_super / environment directory의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 global variables 항목과 대조한다.
#endif#endif 전처리 지시문으로 이 줄 아래의 code가 binary에 존재할지를 결정한다. architecture 또는 build stage 조건을 여닫는다. 현재 .config와 compiler의 -dD -E 출력에서 실제로 남은 branch를 확인한 뒤 line-by-line 흐름에 포함한다.
return ret;ret를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 envfs_super / environment directory를 정리하거나 다음 단계로 진행하는지 확인한다.
}현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.
EXPORT_SYMBOL(envfs_save);EXPORT_SYMBOL(envfs_save)를 호출한다. 반환값을 직접 사용하지 않으므로 이 함수가 실패를 내부 처리하는지 확인해야 한다. pointer 인자는 envfs_super / environment directory의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 global variables 항목과 대조한다.
(빈 줄)EXPORT_SYMBOL(envfs_save);까지의 동작과 /**에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 global variables 상태가 아래 블록의 입력으로 사용되는 경계다.
/**원본 주석이 'block boundary'라고 기록한 줄이다. 바로 아래 구현이 이 전제와 같은 순서·단위를 사용하는지 대조한다.
* Restore the last environment into the current one원본 주석이 'Restore the last environment into the current one'라고 기록한 줄이다. 바로 아래 구현이 이 전제와 같은 순서·단위를 사용하는지 대조한다.
* @param[in] filename from where to restore원본 주석이 '@param[in] filename from where to restore'라고 기록한 줄이다. 바로 아래 구현이 이 전제와 같은 순서·단위를 사용하는지 대조한다.
* @param[in] dir where to store the last content원본 주석이 '@param[in] dir where to store the last content'라고 기록한 줄이다. 바로 아래 구현이 이 전제와 같은 순서·단위를 사용하는지 대조한다.
* @return 0 on success, anything else in case of failure원본 주석이 '@return 0 on success, anything else in case of failure'라고 기록한 줄이다. 바로 아래 구현이 이 전제와 같은 순서·단위를 사용하는지 대조한다.
*원본 주석이 'block boundary'라고 기록한 줄이다. 바로 아래 구현이 이 전제와 같은 순서·단위를 사용하는지 대조한다.
* Note: This function will also be used on the host! See note in the header원본 주석이 'Note: This function will also be used on the host! See note in the header'라고 기록한 줄이다. 바로 아래 구현이 이 전제와 같은 순서·단위를 사용하는지 대조한다.
* of this file.원본 주석이 'of this file.'라고 기록한 줄이다. 바로 아래 구현이 이 전제와 같은 순서·단위를 사용하는지 대조한다.
*/원본 주석이 'block boundary'라고 기록한 줄이다. 바로 아래 구현이 이 전제와 같은 순서·단위를 사용하는지 대조한다.
int envfs_load(const char *filename, const char *dir, unsigned flags)envfs_load 함수 정의가 시작된다. 입력은 const char *filename, const char *dir, unsigned flags이며, 부트 CPU의 동기 실행 문맥에서 호출된다는 전제로 반환 전까지의 상태 변화를 읽는다.
{바로 위 함수·조건·초기화의 block이 열린다. 이 scope 안에서 만들어지는 지역 객체와 오류 이동 지점을 envfs_super / environment directory의 수명에 맞춰 묶어 읽는다.
struct envfs_super super;struct envfs_super super를 선언한다. 함수 안 선언이면 현재 stack frame, file scope와 static이면 image의 data/BSS에 놓인다. 이 값이 envfs_super / environment directory를 직접 소유하는지 pointer만 빌리는지, 부트 CPU의 동기 실행 문맥를 벗어난 뒤에도 참조되는지 다음 대입과 callback 등록까지 따라간다.
void *buf = NULL, *rbuf;void *buf = NULL, *rbuf를 선언한다. 함수 안 선언이면 현재 stack frame, file scope와 static이면 image의 data/BSS에 놓인다. 이 값이 envfs_super / environment directory를 직접 소유하는지 pointer만 빌리는지, 부트 CPU의 동기 실행 문맥를 벗어난 뒤에도 참조되는지 다음 대입과 callback 등록까지 따라간다.
int envfd;int envfd를 선언한다. 함수 안 선언이면 현재 stack frame, file scope와 static이면 image의 data/BSS에 놓인다. 이 값이 envfs_super / environment directory를 직접 소유하는지 pointer만 빌리는지, 부트 CPU의 동기 실행 문맥를 벗어난 뒤에도 참조되는지 다음 대입과 callback 등록까지 따라간다.
int ret = 0;int ret = 0를 선언한다. 함수 안 선언이면 현재 stack frame, file scope와 static이면 image의 data/BSS에 놓인다. 이 값이 envfs_super / environment directory를 직접 소유하는지 pointer만 빌리는지, 부트 CPU의 동기 실행 문맥를 벗어난 뒤에도 참조되는지 다음 대입과 callback 등록까지 따라간다.
size_t size, rsize;size_t size, rsize를 선언한다. 함수 안 선언이면 현재 stack frame, file scope와 static이면 image의 data/BSS에 놓인다. 이 값이 envfs_super / environment directory를 직접 소유하는지 pointer만 빌리는지, 부트 CPU의 동기 실행 문맥를 벗어난 뒤에도 참조되는지 다음 대입과 callback 등록까지 따라간다.
__maybe_unused const char *defenv_path;원본 453번 줄의 __maybe_unused const char *defenv_path;는 앞의 size_t size, rsize; 결과를 받아 다음 다음 block 경계로 넘기는 중간 연산이다. 이 줄이 바꾸는 register·field·list link를 찾고, 변경 뒤에도 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건이 유지되는지 확인한다.
(빈 줄)__maybe_unused const char *defenv_path;까지의 동작과 #ifdef __BAREBOX__에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 global variables 상태가 아래 블록의 입력으로 사용되는 경계다.
#ifdef __BAREBOX__#ifdef 전처리 지시문으로 이 줄 아래의 code가 binary에 존재할지를 결정한다. architecture 또는 build stage 조건을 여닫는다. 현재 .config와 compiler의 -dD -E 출력에서 실제로 남은 branch를 확인한 뒤 line-by-line 흐름에 포함한다.
if (!IS_ALLOWED(SCONFIG_ENVIRONMENT_LOAD))!IS_ALLOWED(SCONFIG_ENVIRONMENT_LOAD)를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.
return -EPERM;-EPERM를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 envfs_super / environment directory를 정리하거나 다음 단계로 진행하는지 확인한다.
#endif#endif 전처리 지시문으로 이 줄 아래의 code가 binary에 존재할지를 결정한다. architecture 또는 build stage 조건을 여닫는다. 현재 .config와 compiler의 -dD -E 출력에서 실제로 남은 branch를 확인한 뒤 line-by-line 흐름에 포함한다.
(빈 줄)#endif까지의 동작과 if (!filename)에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 global variables 상태가 아래 블록의 입력으로 사용되는 경계다.
if (!filename)!filename를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.
filename = default_environment_path_get();filename에 default_environment_path_get()를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 바로 다음 if (!filename)가 이 값을 다시 읽으므로 그 전까지 완성된 값이어야 한다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.
if (!filename)!filename를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.
return -ENOENT;-ENOENT를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 envfs_super / environment directory를 정리하거나 다음 단계로 진행하는지 확인한다.
(빈 줄)return -ENOENT;까지의 동작과 if (!dir)에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 global variables 상태가 아래 블록의 입력으로 사용되는 경계다.
if (!dir)!dir를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.
dir = "/env";dir에 "/env"를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 이후 shell variables/scripts 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.
(빈 줄)dir = "/env";까지의 동작과 envfd = open(filename, O_RDONLY);에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 global variables 상태가 아래 블록의 입력으로 사용되는 경계다.
envfd = open(filename, O_RDONLY);envfd에 open(filename, O_RDONLY)를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 바로 다음 if (envfd < 0) {가 이 값을 다시 읽으므로 그 전까지 완성된 값이어야 한다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.
if (envfd < 0) {envfd < 0를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.
printf("environment load %s: %m\n", filename);printf("environment load %s: %m\n", filename)를 호출한다. 반환 결과는 현재 줄 또는 다음 if (errno == ENOENT)에서 검사되는 흐름이다. pointer 인자는 envfs_super / environment directory의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 global variables 항목과 대조한다.
if (errno == ENOENT)errno == ENOENT를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.
printf("Maybe you have to create the partition.\n");printf("Maybe you have to create the partition.\n")를 호출한다. 반환 결과는 현재 줄 또는 다음 return -1;에서 검사되는 흐름이다. pointer 인자는 envfs_super / environment directory의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 global variables 항목과 대조한다.
return -1;-1를 호출자에게 반환한다. caller가 이 값을 검사한 뒤 부분 초기화된 envfs_super / environment directory를 정리하거나 다음 단계로 진행하는지 확인한다.
}현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.
(빈 줄)}까지의 동작과 /* read superblock */에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 global variables 상태가 아래 블록의 입력으로 사용되는 경계다.
/* read superblock */원본 주석이 'read superblock'라고 기록한 줄이다. 바로 아래 구현이 이 전제와 같은 순서·단위를 사용하는지 대조한다.
ret = read(envfd, &super, sizeof(struct envfs_super));ret = read(envfd, &super, sizeof(struct envfs_super))를 선언한다. 함수 안 선언이면 현재 stack frame, file scope와 static이면 image의 data/BSS에 놓인다. 이 값이 envfs_super / environment directory를 직접 소유하는지 pointer만 빌리는지, 부트 CPU의 동기 실행 문맥를 벗어난 뒤에도 참조되는지 다음 대입과 callback 등록까지 따라간다.
if ( ret < sizeof(struct envfs_super)) { ret < sizeof(struct envfs_super)를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.
perror("read");perror("read")를 호출한다. 반환 결과는 현재 줄 또는 다음 ret = -errno;에서 검사되는 흐름이다. pointer 인자는 envfs_super / environment directory의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 global variables 항목과 대조한다.
ret = -errno;ret에 -errno를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 이후 shell variables/scripts 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.
goto out;'goto out;'로 직선 경로를 벗어난다. 이동 대상에서 envfs_super / environment directory에 걸린 lock, allocation, list 등록을 어디까지 되돌리는지 이어서 확인한다.
}현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.
(빈 줄)}까지의 동작과 ret = envfs_check_super(&super, &size);에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 global variables 상태가 아래 블록의 입력으로 사용되는 경계다.
ret = envfs_check_super(&super, &size);ret에 envfs_check_super(&super, &size)를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 주소·크기 값이면 단위와 정렬, 덧셈 overflow를 함께 검산한다. 바로 다음 if (ret)가 이 값을 다시 읽으므로 그 전까지 완성된 값이어야 한다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.
if (ret)ret를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.
goto out;'goto out;'로 직선 경로를 벗어난다. 이동 대상에서 envfs_super / environment directory에 걸린 lock, allocation, list 등록을 어디까지 되돌리는지 이어서 확인한다.
(빈 줄)goto out;까지의 동작과 if (super.flags & ENVFS_FLAGS_FORCE_BUILT_IN) {에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 global variables 상태가 아래 블록의 입력으로 사용되는 경계다.
if (super.flags & ENVFS_FLAGS_FORCE_BUILT_IN) {super.flags & ENVFS_FLAGS_FORCE_BUILT_IN를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.
printf("found force-builtin environment, using defaultenv\n");printf("found force-builtin environment, using defaultenv\n")를 호출한다. 반환 결과는 현재 줄 또는 다음 ret = defaultenv_load(dir, 0);에서 검사되는 흐름이다. pointer 인자는 envfs_super / environment directory의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 global variables 항목과 대조한다.
ret = defaultenv_load(dir, 0);ret에 defaultenv_load(dir, 0)를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 바로 다음 if (ret)가 이 값을 다시 읽으므로 그 전까지 완성된 값이어야 한다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.
if (ret)ret를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.
printf("failed to load default environment: %s\n",printf(인자 없음)를 호출한다. 반환 결과는 현재 줄 또는 다음 strerror(-ret));에서 검사되는 흐름이다. pointer 인자는 envfs_super / environment directory의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 global variables 항목과 대조한다.
strerror(-ret));strerror(-ret))를 호출한다. 반환값을 직접 사용하지 않으므로 이 함수가 실패를 내부 처리하는지 확인해야 한다. pointer 인자는 envfs_super / environment directory의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 global variables 항목과 대조한다.
goto out;'goto out;'로 직선 경로를 벗어난다. 이동 대상에서 envfs_super / environment directory에 걸린 lock, allocation, list 등록을 어디까지 되돌리는지 이어서 확인한다.
}현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.
(빈 줄)}까지의 동작과 buf = xmalloc(size);에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 global variables 상태가 아래 블록의 입력으로 사용되는 경계다.
buf = xmalloc(size);buf에 xmalloc(size)를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 주소·크기 값이면 단위와 정렬, 덧셈 overflow를 함께 검산한다. 이후 shell variables/scripts 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.
(빈 줄)buf = xmalloc(size);까지의 동작과 rbuf = buf;에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 global variables 상태가 아래 블록의 입력으로 사용되는 경계다.
rbuf = buf;rbuf에 buf를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 이후 shell variables/scripts 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.
rsize = size;rsize에 size를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 주소·크기 값이면 단위와 정렬, 덧셈 overflow를 함께 검산한다. 이후 shell variables/scripts 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.
(빈 줄)rsize = size;까지의 동작과 while (rsize) {에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 global variables 상태가 아래 블록의 입력으로 사용되는 경계다.
while (rsize) {'while (rsize) {'가 목록이나 후보를 순회한다. 반복 중 envfs_super / environment directory를 제거·추가하는 호출이 있는지와 loop 종료 뒤 iterator가 유효한지 확인한다.
ssize_t now;원본 503번 줄의 ssize_t now;는 앞의 while (rsize) { 결과를 받아 다음 다음 block 경계로 넘기는 중간 연산이다. 이 줄이 바꾸는 register·field·list link를 찾고, 변경 뒤에도 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건이 유지되는지 확인한다.
(빈 줄)ssize_t now;까지의 동작과 now = read(envfd, rbuf, rsize);에서 시작하는 동작을 나누는 빈 줄이다. 앞 블록이 만든 global variables 상태가 아래 블록의 입력으로 사용되는 경계다.
now = read(envfd, rbuf, rsize);now에 read(envfd, rbuf, rsize)를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 바로 다음 if (now < 0) {가 이 값을 다시 읽으므로 그 전까지 완성된 값이어야 한다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.
if (now < 0) {now < 0를 검사해 진행 여부를 가른다. 거짓 경로와 참 경로 중 어느 쪽이 '검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다' 조건을 보존하는지 다음 return 또는 goto까지 따라간다.
perror("read");perror("read")를 호출한다. 반환 결과는 현재 줄 또는 다음 ret = -errno;에서 검사되는 흐름이다. pointer 인자는 envfs_super / environment directory의 소유권을 넘기는지 호출 동안만 빌리는지 구분하고, 호출 뒤 공개되는 상태를 global variables 항목과 대조한다.
ret = -errno;ret에 -errno를 = 연산으로 반영해 현재 scope의 계산 결과를 저장한다. 이후 shell variables/scripts 단계가 이 값을 처음 소비하는 지점을 찾는다. 실패 경로가 이 field를 이전 값으로 되돌리거나 객체 전체를 폐기하는지도 확인한다.
goto out;'goto out;'로 직선 경로를 벗어난다. 이동 대상에서 envfs_super / environment directory에 걸린 lock, allocation, list 등록을 어디까지 되돌리는지 이어서 확인한다.
}현재 block, initializer 또는 호출의 경계를 닫는다. 이 지점까지 획득한 resource가 성공 경로와 실패 경로에서 대칭인지 점검한다.
DETAILS
내부 동작을 더 깊게 읽기
진입 조건을 먼저 고정한다
environment cdev/file에서 들어온 실행은 부트 CPU의 동기 실행 문맥에 놓여 있다. 이때 interrupt, MMU/cache, stack, heap 중 무엇이 이미 준비되었는지 소스의 호출자까지 올라가 확인한다. 같은 함수라도 SPL, relocation 전후, app thread처럼 호출 문맥이 달라지면 허용되는 API와 지연 시간이 달라진다.
U-Boot의 key-value blob과 달리 Barebox 환경은 파일과 script 중심이다. 저장 image의 integrity, extraction path와 default overlay 순서를 확인한다.
중심 객체의 생성과 공개를 나눈다
이 글의 중심 객체는 envfs_super / environment directory다. 메모리를 확보한 시점, 필드를 채운 시점, 전역 list나 다른 subsystem에 공개한 시점을 구분한다. 공개 뒤 오류가 발생한다면 목록에서 제거하고 child, buffer, reference를 역순으로 정리하는지 확인한다.
빌드 산출물 관점에서는 최종 부트로더 이미지 안에 해당 symbol과 section이 실제로 포함되었는지도 map과 objdump로 검증한다.
주소, 크기와 정렬을 계산한다
부트 코드의 오류는 논리보다 주소 계산에서 먼저 드러나는 경우가 많다. source range, destination range, header가 말하는 payload size, block 또는 page 단위를 표로 적고 각 구간의 끝 주소를 직접 계산한다. 끝 주소는 start + size - 1인지 exclusive end인지 API 계약을 확인한다.
검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다.
성공 flag와 실제 완료 시점을 맞춘다
envfs superblock → CRC/decompress → extract files 구간에서는 부분 초기화 상태가 생길 수 있다. flag, list insertion, callback 등록, storage write 완료 중 무엇이 성공의 기준인지 찾는다. hardware write나 DMA가 포함되면 함수 반환과 장치 완료가 같은 시점인지도 확인한다.
다른 CPU, interrupt handler, USB completion 또는 shell command가 상태를 관찰할 수 있다면 memory ordering과 lock 범위도 함께 읽는다.
마지막 handoff의 계약을 적는다
정상 경로는 shell variables/scripts에서 끝난다. 이 단계가 함수 반환인지, scheduler 전환인지, 다른 image로의 비복귀 분기인지 구분한다. 비복귀 handoff라면 cache clean/invalidate, interrupt disable, 장치 quiesce, argument register와 FDT 또는 image address가 최종 점검 항목이다.
반환하는 경로라면 caller가 오류와 부분 성공을 구분하고 다음 후보 또는 복구 경로를 선택하는지 확인한다.
IMPLEMENTATION NOTES
구현을 읽을 때 놓치기 쉬운 부분
envfs는 key-value blob이 아니라 파일 tree image다
superblock과 inode entry를 검증하고 압축 또는 CRC를 확인한 뒤 runtime environment directory로 파일과 script를 펼친다. path, mode와 file length를 신뢰하기 전에 image 전체 범위 안인지 계산한다.
..와 절대 path가 environment root 밖으로 나가지 못하게 canonicalization을 확인한다.
default environment와 persistent overlay 순서를 본다
built-in default 파일을 먼저 구성하고 valid envfs를 덮는지, persistent load 실패 시 default로 완전히 되돌리는지 확인한다. 부분 extraction 뒤 CRC나 entry 오류가 나면 이미 쓴 파일을 정리해야 한다.
같은 파일의 source와 최종 내용을 표시해 우선순위를 검증한다.
saveenv의 atomicity는 backend에 달려 있다
새 image를 memory에서 완성·검증한 뒤 storage에 기록해야 하며 단일 erase block을 덮는 backend는 전원 차단에 취약하다. redundant copy, rename 가능한 filesystem 또는 state backend와 보장 수준을 구분한다.
write 중 reset 뒤 어느 copy가 선택되는지 반복 시험한다.
OBJECT LIFETIME
객체와 수명
| 대상 | 만들어지는 시점 | 유효 범위 | 확인할 조건 |
|---|---|---|---|
envfs_super / environment directory | envfs superblock | shell variables/scripts 또는 오류 정리 완료까지 | 검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다. |
| 입력 buffer / metadata | environment cdev/file | parse와 검증이 끝날 때까지 | 길이, 정렬, 소유권, 변조 가능성 |
| 등록된 list / descriptor | CRC/decompress | 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 | CRC 오류 | persistent env 무시 | envfs superblock |
| 02 | path traversal 처리 오류 | 임의 파일 overwrite | CRC/decompress |
| 03 | 전원 차단 | 새 envfs image 손상 | extract files |
로그가 끊긴 마지막 함수만 고치지 않는다. 그 함수가 받은 주소, size, flag가 만들어진 앞 단계까지 올라가고, 오류 뒤 등록 객체와 hardware 상태가 남았는지도 확인한다.
EVIDENCE
소스 밖에서 확인할 증거
소스 해석은 실제 빌드 산출물과 target 로그로 닫아야 한다. 아래 명령의 보드 이름과 toolchain prefix는 사용 중인 빌드 환경에 맞게 바꾼다.
| # | 목적 | 명령 또는 계측 | 판정 기준 |
|---|---|---|---|
| 01 | 빌드 구성 | make <board>_defconfig && make V=1 | Kconfig, linker section과 최종 barebox image 생성 명령을 보관한다. |
| 02 | symbol과 section | ${CROSS_COMPILE}nm -n barebox | grep 'int envfs_load' | initcall, command, driver descriptor가 image에 남았는지 확인한다. |
| 03 | 주소와 resource | iomem | image, malloc, stack, device resource와 reserved 영역의 겹침을 확인한다. |
| 04 | device 상태 | devinfo; drvinfo; of_dump | DT node 생성, device 등록, driver probe를 서로 구분한다. |
| 05 | boot 정책 | boot -d -v; state -d | entry 탐색 결과와 persistent state가 실제 선택에 미친 영향을 확인한다. |
LAB
직접 확인할 실험
- 01saveenv/loadenv 전후 envfs header 비교
envfs superblock진입 전후에 envfs image의 주소·크기·반환값과 timestamp를 함께 남긴다. 결과는 정상 부팅 여부로 끝내지 말고 검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다. 조건이 처음 깨지는 줄을 기록한다. - 02CRC byte 변조 후 default fallback 확인
CRC/decompress진입 전후에 superblock/inodes의 주소·크기·반환값과 timestamp를 함께 남긴다. 결과는 정상 부팅 여부로 끝내지 말고 검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다. 조건이 처음 깨지는 줄을 기록한다. - 03환경 파일 하나의 mode와 내용 보존 확인
extract files진입 전후에 runtime directory의 주소·크기·반환값과 timestamp를 함께 남긴다. 결과는 정상 부팅 여부로 끝내지 말고 검증되지 않은 entry가 environment root 밖으로 추출되거나 기존 runtime state를 부분적으로 덮어쓰지 않아야 한다. 조건이 처음 깨지는 줄을 기록한다.
PRIMARY REFERENCES