TF-A 빌드 산출물과 FIP 구성

QUESTION

TF-A 빌드 산출물과 FIP 구성 단계에서 실제로 바뀌는 상태는 무엇인가?

STRUCTURE

객체와 주소가 놓이는 구조

CALL PATH

실행 흐름

STATE LEDGER

단계별 입력과 출력

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

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

VISUAL WALKTHROUGH

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

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

UPSTREAM SOURCE

원본 코드

아래 코드는 Trusted Firmware-A LTS 2.14.3의 Makefile에서 1189-1277줄을 그대로 가져온 것이다. 설명을 위해 실제 코드를 가짜 의사 코드로 바꾸지 않았다.

1189endif #(GENERATE_COT)
1190
1191ifneq (${GENERATE_COT},0)
1192bl2_certificates: ${BUILD_PLAT}/${FIP_NAME} ${BL2_CRT_DEPS} ${CRTTOOL} | ${BUILD_PLAT}/
1193	$(q)${CRTTOOL} ${BL2_CRT_ARGS}
1194	$(s)echo
1195	$(s)echo "Built $@ successfully"
1196	$(s)echo "BL2 certificates can be found in ${BUILD_PLAT}"
1197	$(s)echo
1198endif #(GENERATE_COT)
1199
1200${BUILD_PLAT}/${FWU_FIP_NAME}: ${FWU_FIP_DEPS} ${FIPTOOL} | $$(@D)/
1201	$(eval ${CHECK_FWU_FIP_CMD})
1202	$(q)${FIPTOOL} create ${FWU_FIP_ARGS} $@
1203	$(q)${FIPTOOL} info $@
1204	$(s)echo
1205	$(s)echo "Built $@ successfully"
1206	$(s)echo
1207
1208fiptool: ${FIPTOOL}
1209ifeq (${SEPARATE_BL2_FIP},1)
1210bl2_fip: ${BUILD_PLAT}/${BL2_FIP_NAME}
1211fip: bl2_fip
1212else
1213fip: ${BUILD_PLAT}/${FIP_NAME}
1214endif #(SEPARATE_BL2_FIP)
1215fwu_fip: ${BUILD_PLAT}/${FWU_FIP_NAME}
1216
1217# symlink for compatibility before tools were in the build directory
1218${FIPTOOL}: FORCE | $$(@D)/
1219	$(q)${MAKE} PLAT=${PLAT} BUILD_PLAT=$(abspath ${BUILD_PLAT}) CPPFLAGS="-DVERSION='\"${VERSION_STRING}\"'" OPENSSL_DIR=${OPENSSL_DIR} DEBUG=${DEBUG} --no-print-directory -C ${FIPTOOLPATH} all
1220	$(q)ln -sf ${FIPTOOL} ${FIPTOOLPATH}/fiptool
1221
1222$(BUILD_PLAT)/romlib/romlib.bin $(BUILD_PLAT)/lib/libwrappers.a $&: $(BUILD_PLAT)/lib/libfdt.a $(BUILD_PLAT)/lib/libc.a $(CRYPTO_LIB) | $$(@D)/
1223	$(q)${MAKE} PLAT_DIR=${PLAT_DIR} BUILD_PLAT=${BUILD_PLAT} ENABLE_BTI=${ENABLE_BTI} CRYPTO_LIB=$(CRYPTO_LIB) ARM_ARCH_MINOR=${ARM_ARCH_MINOR} INCLUDES=$(call escape-shell,$(INCLUDES)) DEFINES=$(call escape-shell,$(DEFINES)) --no-print-directory -C ${ROMLIBPATH} all
1224
1225memmap: all
1226	$(if $(host-poetry),$(q)poetry -q install --no-root)
1227	$(q)$(if $(host-poetry),poetry run )memory --root ${BUILD_PLAT} symbols
1228
1229tl: ${BUILD_PLAT}/tl.bin
1230${BUILD_PLAT}/tl.bin: ${HW_CONFIG} | $$(@D)/
1231	$(if $(host-poetry),$(q)poetry -q install --no-root)
1232	$(q)$(if $(host-poetry),poetry run )tlc create --fdt $< -s ${FW_HANDOFF_SIZE} $@
1233
1234doc:
1235	$(s)echo "  BUILD DOCUMENTATION"
1236	$(if $(host-poetry),$(q)poetry -q install --with docs --no-root)
1237	$(q)$(if $(host-poetry),poetry run )${MAKE} --no-print-directory -C ${DOCS_PATH} BUILDDIR=$(abspath ${BUILD_BASE}/docs) html
1238
1239enctool: ${ENCTOOL}
1240
1241${ENCTOOL}: FORCE | $$(@D)/
1242	$(q)${MAKE} PLAT=${PLAT} BUILD_PLAT=$(abspath ${BUILD_PLAT}) BUILD_INFO=0 OPENSSL_DIR=${OPENSSL_DIR} DEBUG=${DEBUG} --no-print-directory -C ${ENCTOOLPATH} all
1243	$(s)echo
1244	$(s)echo "Built $@ successfully"
1245	$(s)echo
1246
1247cscope:
1248	$(s)echo "  CSCOPE"
1249	$(q)find ${CURDIR} -name "*.[chsS]" > cscope.files
1250	$(q)cscope -b -q -k
1251
1252help:
1253	$(s)echo "usage: ${MAKE} [PLAT=<platform>] [OPTIONS] [TARGET]"
1254	$(s)echo ""
1255	$(s)echo "PLAT is used to specify which platform you wish to build."
1256	$(s)echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}"
1257	$(s)echo ""
1258	$(s)echo "platform = ${PLATFORM_LIST}"
1259	$(s)echo ""
1260	$(s)echo "Please refer to the User Guide for a list of all supported options."
1261	$(s)echo "Note that the build system doesn't track dependencies for build "
1262	$(s)echo "options. Therefore, if any of the build options are changed "
1263	$(s)echo "from a previous build, a clean build must be performed."
1264	$(s)echo ""
1265	$(s)echo "Supported Targets:"
1266	$(s)echo "  all            Build all individual bootloader binaries"
1267	$(s)echo "  bl1            Build the BL1 binary"
1268	$(s)echo "  bl2            Build the BL2 binary"
1269	$(s)echo "  bl2u           Build the BL2U binary"
1270	$(s)echo "  bl31           Build the BL31 binary"
1271	$(s)echo "  bl32           Build the BL32 binary. If ARCH=aarch32, then "
1272	$(s)echo "                 this builds secure payload specified by AARCH32_SP"
1273	$(s)echo "  certificates   Build the certificates (requires 'GENERATE_COT=1')"
1274	$(s)echo "  fip            Build the Firmware Image Package (FIP)"
1275	$(s)echo "  fwu_fip        Build the FWU Firmware Image Package (FIP)"
1276	$(s)echo "  checkcodebase  Check the coding style of the entire source tree"
1277	$(s)echo "  checkpatch     Check the coding style on changes in the current"

READING CONTRACT

발췌 범위와 읽기 기준

원문 1189-1277줄에는 앞뒤 문맥이 포함됩니다. 기준 구문 fip: ${BUILD_PLAT}/${FIP_NAME}은 L1213에 있습니다. 발췌 첫 줄을 함수 정의의 시작으로 해석하지 않습니다.

파일 이름보다 FIP ToC의 UUID, offset, size와 각 image의 load address를 함께 본다. BL32와 BL33은 FIP 안의 순서가 아니라 image descriptor와 security state로 구분된다.

RELATED SOURCE

함께 읽어야 하는 원본 코드

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

1231	printf("\n");
1232	printf("Commands supported:\n");
1233	printf("  info\t\tList images contained in FIP.\n");
1234	printf("  create\tCreate a new FIP with the given images.\n");
1235	printf("  update\tUpdate an existing FIP with the given images.\n");
1236	printf("  unpack\tUnpack images from FIP.\n");
1237	printf("  remove\tRemove images from FIP.\n");
1238	printf("  version\tShow fiptool version.\n");
1239	printf("  help\t\tShow help for given command.\n");
1240	exit(EXIT_SUCCESS);
1241}
1242
1243int main(int argc, char *argv[])
1244{
1245	int i, ret = 0;
1246
1247	while (1) {
1248		int c, opt_index = 0;
1249		static struct option opts[] = {
1250			{ "verbose", no_argument, NULL, 'v' },
1251			{ NULL, no_argument, NULL, 0 }
1252		};
1253
1254		/*
1255		 * Set POSIX mode so getopt stops at the first non-option
1256		 * which is the subcommand.
1257		 */
1258		c = getopt_long(argc, argv, "+v", opts, &opt_index);
1259		if (c == -1)
1260			break;
1261
1262		switch (c) {
1263		case 'v':
1264			verbose = 1;
1265			break;
1266		default:
1267			usage();
1268		}
1269	}
1270	argc -= optind;
1271	argv += optind;
1272	/* Reset optind for subsequent getopt processing. */
1273	optind = 0;
1274
1275	if (argc == 0)
1276		usage();
1277
1278	fill_image_descs();
1279	for (i = 0; i < NELEM(cmds); i++) {
1280		if (strcmp(cmds[i].name, argv[0]) == 0) {
1281			ret = cmds[i].handler(argc, argv);
1282			break;
1283		}
1284	}
1285	if (i == NELEM(cmds))
1286		usage();
1287	free_image_descs();
1288	return ret;
1289}

521
522	return 0;
523}
524
525static void info_usage(int exit_status)
526{
527	printf("fiptool info FIP_FILENAME\n");
528	exit(exit_status);
529}
530
531static int pack_images(const char *filename, uint64_t toc_flags, unsigned long align)
532{
533	FILE *fp;
534	image_desc_t *desc;
535	fip_toc_header_t *toc_header;
536	fip_toc_entry_t *toc_entry;
537	char *buf;
538	uint64_t entry_offset, buf_size, payload_size = 0, pad_size;
539	size_t nr_images = 0;
540
541	for (desc = image_desc_head; desc != NULL; desc = desc->next)
542		if (desc->image != NULL)
543			nr_images++;
544
545	buf_size = sizeof(fip_toc_header_t) +
546	    sizeof(fip_toc_entry_t) * (nr_images + 1);
547	buf = calloc(1, buf_size);
548	if (buf == NULL)
549		log_err("calloc");
550
551	/* Build up header and ToC entries from the image table. */
552	toc_header = (fip_toc_header_t *)buf;
553	toc_header->name = TOC_HEADER_NAME;
554	toc_header->serial_number = TOC_HEADER_SERIAL_NUMBER;
555	toc_header->flags = toc_flags;
556
557	toc_entry = (fip_toc_entry_t *)(toc_header + 1);
558
559	entry_offset = buf_size;
560	for (desc = image_desc_head; desc != NULL; desc = desc->next) {
561		image_t *image = desc->image;
562
563		if (image == NULL || (image->toc_e.size == 0ULL))
564			continue;
565		payload_size += image->toc_e.size;
566		entry_offset = (entry_offset + align - 1) & ~(align - 1);
567		image->toc_e.offset_address = entry_offset;
568		*toc_entry++ = image->toc_e;
569		entry_offset += image->toc_e.size;
570	}
571
572	/*
573	 * Append a null uuid entry to mark the end of ToC entries.
574	 * NOTE the offset address for the last toc_entry must match the fip
575	 * size.
576	 */
577	memset(toc_entry, 0, sizeof(*toc_entry));
578	toc_entry->offset_address = (entry_offset + align - 1) & ~(align - 1);
579
580	/* Generate the FIP file. */
581	fp = fopen(filename, "wb");
582	if (fp == NULL)
583		log_err("fopen %s", filename);
584
585	if (verbose)
586		log_dbgx("Metadata size: %zu bytes", buf_size);
587
588	xfwrite(buf, buf_size, fp, filename);
589
590	if (verbose)
591		log_dbgx("Payload size: %zu bytes", payload_size);
592
593	for (desc = image_desc_head; desc != NULL; desc = desc->next) {
594		image_t *image = desc->image;
595
596		if (image == NULL)
597			continue;
598		if (fseek(fp, image->toc_e.offset_address, SEEK_SET))
599			log_errx("Failed to set file position");
600
601		xfwrite(image->buffer, image->toc_e.size, fp, filename);
602	}
603
604	if (fseek(fp, entry_offset, SEEK_SET))
605		log_errx("Failed to set file position");
606
607	pad_size = toc_entry->offset_address - entry_offset;
608	while (pad_size--)
609		fputc(0x0, fp);
610
611	free(buf);
612	fclose(fp);
613	return 0;
614}
615
616/*
617 * This function is shared between the create and update subcommands.
618 * The difference between the two subcommands is that when the FIP file
619 * is created, the parsing of an existing FIP is skipped.  This results
620 * in update_fip() creating the new FIP file from scratch because the
621 * internal image table is not populated.
622 */
623static void update_fip(void)
624{
625	image_desc_t *desc;
626
627	/* Add or replace images in the FIP file. */
628	for (desc = image_desc_head; desc != NULL; desc = desc->next) {
629		image_t *image;
630
631		if (desc->action != DO_PACK)
632			continue;
633

DETAILS

내부 동작을 더 깊게 읽기

IMPLEMENTATION NOTES

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

OBJECT LIFETIME

객체와 수명

FAILURE PATH

실패 지점과 증상

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

EVIDENCE

소스 밖에서 확인할 증거

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

LAB

직접 확인할 실험

1. 01
   fiptool info로 UUID와 크기 확인

   BL image ELF/bin 진입 전후에 BL1/BL2/BL31 binaries의 주소·크기·반환값과 timestamp를 함께 남긴다.

2. 02
   readelf로 BL31 entry와 load address 확인

   certificate generation 진입 전후에 BL32 secure payload의 주소·크기·반환값과 timestamp를 함께 남긴다.

3. 03
   BL32/BL33를 교체해 package diff 비교

   fiptool package 진입 전후에 BL33 normal-world firmware의 주소·크기·반환값과 timestamp를 함께 남긴다.

PRIMARY REFERENCES

원문과 다음 글