State framework와 영속 변수

QUESTION

State framework와 영속 변수 단계에서 실제로 바뀌는 상태는 무엇인가?

STRUCTURE

객체와 주소가 놓이는 구조

CALL PATH

실행 흐름

STATE LEDGER

단계별 입력과 출력

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

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

VISUAL WALKTHROUGH

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

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

UPSTREAM SOURCE

원본 코드

아래 코드는 Barebox v2026.06.1의 common/state/state.c에서 20-108줄을 그대로 가져온 것이다. 설명을 위해 실제 코드를 가짜 의사 코드로 바꾸지 않았다.

20#include <errno.h>
21#include <fs.h>
22#include <crc.h>
23#include <init.h>
24#include <block.h>
25#include <linux/err.h>
26#include <linux/list.h>
27#include <linux/uuid.h>
28
29#include <linux/mtd/mtd-abi.h>
30#include <malloc.h>
31#include <state.h>
32#include <libbb.h>
33
34#include "state.h"
35
36/* list of all registered state instances */
37static LIST_HEAD(state_list);
38
39/**
40 * Save the state
41 * @param state
42 * @return
43 */
44int state_save(struct state *state)
45{
46	void *buf;
47	ssize_t len;
48	int ret;
49	struct state_backend_storage_bucket *bucket;
50	struct state_backend_storage *storage;
51
52	if (!state->dirty)
53		return 0;
54
55	ret = state->format->pack(state->format, state, &buf, &len);
56	if (ret) {
57		dev_err(&state->dev, "Failed to pack state with backend format %s, %d\n",
58			state->format->name, ret);
59		return ret;
60	}
61
62	storage = &state->storage;
63	if (state->keep_prev_content) {
64		bool has_content = 0;
65		list_for_each_entry(bucket, &storage->buckets, bucket_list)
66			has_content |= bucket->wrong_magic;
67		if (has_content) {
68			dev_err(&state->dev, "Found foreign content on backend, won't overwrite.\n");
69			ret = -EPERM;
70			goto out;
71		}
72	}
73
74	ret = state_storage_write(storage, buf, len);
75	if (ret) {
76		dev_err(&state->dev, "Failed to write packed state, %d\n", ret);
77		goto out;
78	}
79
80	state->dirty = 0;
81
82out:
83	free(buf);
84	return ret;
85}
86
87/**
88 * state_do_load - Loads a state from the backend
89 * @param state The state that should be updated to contain the loaded data
90 * @return 0 on success, -errno on failure. If no state is loaded the previous
91 * values remain in the state.
92 *
93 * This function uses the registered storage backend to read data. All data that
94 * we read is checked for integrity by the formatter. After that we unpack the
95 * data into our state.
96 */
97static int state_do_load(struct state *state, enum state_flags flags)
98{
99	void *buf = NULL;
100	ssize_t len;
101	int ret;
102
103	ret = state_storage_read(&state->storage, state->format,
104				 state->magic, &buf, &len, flags);
105	if (ret) {
106		dev_err_state_init(&state->dev, ret, "format %s read failed\n",
107				   state->format->name);
108		goto out;

READING CONTRACT

발췌 범위와 읽기 기준

원문 20-108줄에는 앞뒤 문맥이 포함됩니다. 기준 구문 int state_save(struct state *state)은 L44에 있습니다. 발췌 첫 줄을 함수 정의의 시작으로 해석하지 않습니다.

environment와 제품 상태를 구분한다. attempts, priority 같은 값의 type/width와 redundant/circular backend가 전원 차단을 견디는 방식을 본다.

RELATED SOURCE

함께 읽어야 하는 원본 코드

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

87/**
88 * state_do_load - Loads a state from the backend
89 * @param state The state that should be updated to contain the loaded data
90 * @return 0 on success, -errno on failure. If no state is loaded the previous
91 * values remain in the state.
92 *
93 * This function uses the registered storage backend to read data. All data that
94 * we read is checked for integrity by the formatter. After that we unpack the
95 * data into our state.
96 */
97static int state_do_load(struct state *state, enum state_flags flags)
98{
99	void *buf = NULL;
100	ssize_t len;
101	int ret;
102
103	ret = state_storage_read(&state->storage, state->format,
104				 state->magic, &buf, &len, flags);
105	if (ret) {
106		dev_err_state_init(&state->dev, ret, "format %s read failed\n",
107				   state->format->name);
108		goto out;
109	}
110
111	ret = state->format->unpack(state->format, state, buf, len);
112	if (ret) {
113		dev_err(&state->dev, "Failed to unpack read data with format %s although verified, %d\n",
114			state->format->name, ret);
115		goto out;
116	}
117
118	state->init_from_defaults = 0;
119out:
120	state->dirty = !!ret; /* mark dirty on error */
121	free(buf);
122	return ret;
123}
124
125int state_load(struct state *state)
126{
127	return state_do_load(state, 0);
128}
129
130int state_load_no_auth(struct state *state)
131{
132	return state_do_load(state, STATE_FLAG_NO_AUTHENTICATION);
133}
134
135static int state_format_init(struct state *state, const char *backend_format,
136			     struct device_node *node, const char *state_name)
137{
138	int ret;
139
140	if (!backend_format || !strcmp(backend_format, "raw")) {
141		ret = backend_format_raw_create(&state->format, node,
142						state_name, &state->dev);
143	} else if (!strcmp(backend_format, "dtb")) {
144		ret = backend_format_dtb_create(&state->format, &state->dev);
145	} else {
146		dev_err(&state->dev, "Invalid backend format %s\n",
147			backend_format);
148		return -EINVAL;
149	}
150
151	if (ret && ret != -EPROBE_DEFER)
152		dev_err(&state->dev, "Failed to initialize format %s, %d\n",
153			backend_format, ret);
154
155	return ret;
156}
157
158static void state_format_free(struct state_backend_format *format)
159{
160	if (!format)
161		return;
162
163	if (format->free)
164		format->free(format);
165}
166
167void state_backend_set_readonly(struct state *state)
168{
169	state_storage_set_readonly(&state->storage);

DETAILS

내부 동작을 더 깊게 읽기

IMPLEMENTATION NOTES

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

OBJECT LIFETIME

객체와 수명

FAILURE PATH

실패 지점과 증상

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

EVIDENCE

소스 밖에서 확인할 증거

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

LAB

직접 확인할 실험

1. 01
   state -d로 variable과 backend 확인

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

2. 02
   저장 중 reset 주입 후 이전/새 copy 선택 확인

   pack format 진입 전후에 typed variables의 주소·크기·반환값과 timestamp를 함께 남긴다.

3. 03
   DT default와 저장값 우선순위 비교

   storage buckets 진입 전후에 backend format의 주소·크기·반환값과 timestamp를 함께 남긴다.

PRIMARY REFERENCES

원문과 다음 글