บทเรียน 2.2 — Make และตัวแปรของการ build

เป้าหมาย

เมื่อจบบทเรียนนี้ คุณจะ

1. เปิดแคตตาล็อกตัวอย่างของ SDK ด้วย ENABLE_PAGE_EXAMPLES=1 และเลือกรันตัวอย่างฝั่ง CM33 ด้วย SDK_EXAMPLE_CM33 ได้
2. อธิบายความต่างของการกำหนดค่าตัวแปร Make แบบ ?= กับ = และผลต่อการ build
3. อธิบายว่าทำไมตัวอย่างที่ปิดไว้จึงไม่เพิ่มขนาดเฟิร์มแวร์เลย

ใช้เวลาประมาณ 70 นาที — แนวคิดและแบบฝึกใช้แค่ GNU Make บนคอมพิวเตอร์ ไม่ต้องคอมไพล์อะไร

ก่อนเริ่ม

ทวนจากบทเรียน 2.1 สองข้อ

1. ทำไมต้องรัน make getlibs ในทั้งสามโปรเจกต์ แทนที่จะรันครั้งเดียวที่โฟลเดอร์บนสุด
2. บรรทัดไหนบน serial console ที่เป็นหลักฐานว่าบอร์ด mtb-only บูตสำเร็จ

ดูของจริงก่อน

เปิด examples/flags.mk — ไม่คอมไพล์อะไร แค่พิมพ์ว่า make เข้าใจตัวแปรแต่ละตัวอย่างไร ทายก่อนรัน: บรรทัด SOURCES จะมีกี่ไฟล์ในแต่ละแบบ

make -f examples/flags.mk
make -f examples/flags.mk ENABLE_PAGE_EXAMPLES=1 SDK_EXAMPLE_CM33=cm33/io/04_gpio_led_button
ENABLE_PAGE_EXAMPLES=1 make -f examples/flags.mk

แบบแรกได้ 2 ไฟล์ อีกสองแบบได้ 4 ไฟล์ และ make บอกด้วยว่าค่ามาจากไหน (file, command line, environment) สังเกต FROZEN ได้แค่ hello ทั้งที่ GREETING ได้ hello world และ TRAILING ที่ดูเหมือนเป็น 1 แต่ equals 1: no — สามเรื่องนี้คือเรื่องทั้งหมดของบทเรียน

แนวคิด (1) — โครงของ Makefile ในแม่แบบ ModusToolbox

Makefile สองชั้น: ชั้นบนสุดบอกว่ามีโปรเจกต์อะไรบ้าง (MTB_PROJECTS=proj_cm33_s proj_cm33_ns proj_cm55) ส่วนของแต่ละโปรเจกต์เรียงแบบนี้

ลำดับมีผลจริง: LDLIBS ที่ตั้งหลัง include start.mk จะไม่ถึง linker เลย

แนวคิด (2) — ตัวแปรของ make: = := ?= +=

ค่าจาก command line ชนะการกำหนดค่าในไฟล์ทุกแบบ ส่วนค่าจาก environment แพ้ =/:= ในไฟล์ แต่ชนะ ?= — นี่คือเหตุผลที่ SDK ประกาศ ENABLE_PAGE_EXAMPLES ?= 0 ถ้าเขียนเป็น = การตั้งค่าไว้ใน environment ของเครื่อง build จะถูกกลืนหายเงียบ ๆ

แนวคิด (2) ต่อ — ifeq ตัดสินตอนอ่านบรรทัด และช่องว่างมีความหมาย

ifeq ถูกตัดสิน ตอน make อ่านบรรทัดนั้น — ตัวแปรที่ต้องใช้ต้องถูกกำหนดค่า ก่อน ifeq มาถึง ไม่งั้นค่าจะว่างเปล่าตอน parse

ifeq เทียบข้อความตรงตัว — ค่า 1 ที่มีช่องว่างต่อท้ายไม่เท่ากับ 1 (Appendix X #23 ของเอกสาร SDK) ฟีเจอร์หายไปทั้งก้อนโดยไม่มี error ที่ไหนเลย

common.mk ของ SDK ป้องกันด้วยการ $(strip) ค่าของ BENTO_VARIANT แล้วจงใจให้ build ล้มด้วย $(error ...) ถ้าค่าไม่ใช่ mtb-mpy หรือ mtb-only เพราะ "a typo must not quietly select the wrong firmware"

แนวคิด (3) — ทำไมตัวอย่างที่ปิดไว้ไม่เพิ่มขนาดเฟิร์มแวร์

ModusToolbox ไม่ได้อ่านรายการซอร์สจาก Makefile — มัน เดินทั้งโฟลเดอร์ของโปรเจกต์แล้วคอมไพล์ทุกไฟล์ที่เจอ

# MTB DISCOVERS SOURCES BY WALKING THE APP TREE. `SOURCES +=` adds; it does
# not subtract. Only CY_IGNORE removes one. Gating with `ifeq SOURCES +=
# wildcard` therefore does NOTHING — files compile anyway.
ifeq ($(ENABLE_PAGE_EXAMPLES),1)
INCLUDES += examples
else
CY_IGNORE += examples
endif

เมื่อธงเป็น 0 โฟลเดอร์ examples ถูก CY_IGNORE ทั้งโฟลเดอร์ — ไม่มี object ไม่มีอะไรให้ linker ใส่ลงใน image อีกชั้นในโค้ด C: main.c เรียกฟังก์ชันตัวอย่างเฉพาะใน #if ENABLE_PAGE_EXAMPLES เท่านั้น

ตัวอย่างสมบูรณ์ — สี่ท่าใน flags.mk

# ท่าที่ 1: ?= ให้ค่าเริ่มต้นเฉพาะเมื่อยังไม่มีใครให้ค่ามาก่อน
ENABLE_PAGE_EXAMPLES ?= 0

# ท่าที่ 2: = ขยายทุกครั้งที่ใช้ ส่วน := ขยายครั้งเดียวตอนอ่านบรรทัด
GREETING = hello $(WHO)
FROZEN := hello $(WHO)
WHO = world

# ท่าที่ 4: กับดักช่องว่างต่อท้าย - TRAILING คือ "1 " เพราะคอมเมนต์ต่อท้าย
TRAILING := 1 # this comment leaves a trailing space in the value
ifeq ($(TRAILING),1)
    TRAILING_RAW := yes
else
    TRAILING_RAW := no
endif

ท่าที่ 1 ?= + $(origin ...) · ท่าที่ 2 recursive vs simple · ท่าที่ 3 SOURCES เปลี่ยนตามธง · ท่าที่ 4 ifeq เทียบตรงตัว จนกว่าจะ $(strip)

ฝึกเติม

เปิด practice/feature.mk — โจทย์: ทำให้ feature/feature.c ถูกคอมไพล์เฉพาะเมื่อ ENABLE_FEATURE เป็น 1 ค่าเริ่มต้นปิด เปิดได้ทั้งจาก command line และ environment และทนช่องว่างต่อท้ายได้ มีช่องให้เติม 2 จุด

make -f practice/feature.mk check

ก่อนแก้คุณจะเห็น FAIL สองบรรทัด และ make จบด้วย error ลองแก้ทีละ TODO แล้วรัน check ทุกครั้ง จะเห็นว่าแต่ละ TODO ทำให้บรรทัดไหนเปลี่ยนจาก FAIL เป็น PASS

ลองเองก่อนอย่างน้อย 15 นาที แล้วค่อยเปิด solution/feature.mk

เช็กความเข้าใจ

ตอบคำถาม 5 ข้อใน quiz.yaml ครอบคลุมเป้าหมายทั้งสามข้อ (ตอบถูกตั้งแต่ 4 ข้อขึ้นไปถือว่าจบบทเรียน)

1. ต้องการรันตัวอย่างอ่านปุ่มและ LED ฝั่ง CM33 ตอนบูต คำสั่งใดถูกต้อง
2. build ด้วย ENABLE_PAGE_EXAMPLES=1 แต่ไม่ได้ตั้ง SDK_EXAMPLE_CM33 จะเกิดอะไรบน serial console
3. Makefile มี FLAG = 0 แล้วผู้ใช้รัน FLAG=1 make build (environment) ค่าของ FLAG คืออะไร และถ้าเปลี่ยนเป็น FLAG ?= 0 จะเป็นอะไร
4. A = x$(B), C := x$(B), แล้ว B = y — เมื่อใช้งาน A กับ C มีค่าอะไร
5. ทำไมเมื่อ ENABLE_PAGE_EXAMPLES=0 ตัวอย่างของ SDK ไม่เพิ่มขนาดเฟิร์มแวร์ (เลือกได้หลายข้อ)

แล็บ

งาน: เปิดแคตตาล็อกตัวอย่าง เลือกรันตัวอย่างฝั่ง CM33 หนึ่งตัว และวัดว่าการเปิดตัวอย่างเปลี่ยนขนาดเฟิร์มแวร์เท่าไร

1. build แบบปิดตัวอย่างก่อน (make build -j) หา ELF ของ CM33_NS แล้ว arm-none-eabi-size จดคอลัมน์ text data bss
2. build ใหม่แบบเปิดตัวอย่าง make build -j ENABLE_PAGE_EXAMPLES=1 ไม่เลือกตัวไหน วัดอีกครั้ง flash แล้วอ่าน console ตัวรันจะพิมพ์รายการตัวอย่างและวิธีรันด้วย SDK_EXAMPLE_CM33=<id>
3. build อีกครั้งโดยเลือกตัวอย่างหนึ่งตัว เช่น SDK_EXAMPLE_CM33=cm33/sensors/01_i2c_bus_scan ดูบรรทัด [sdk-example] running ... และผลลัพธ์
4. ลองชื่อที่ไม่มีอยู่จริงหนึ่งครั้ง ตัวรันตอบว่าอะไร เทียบกับรายการที่ตัวรันพิมพ์เอง
5. เทียบขนาดข้อ 1 กับข้อ 2 ส่วนต่างอยู่ใน section ไหน อธิบายด้วยแนวคิดข้อ 3

หลักฐานที่เก็บไว้ใน portfolio: ผลของ arm-none-eabi-size ทั้งสองครั้ง log ของตัวรันตัวอย่าง และคำอธิบายข้อ 5

ไปต่อ

• ./bento.sh menus ของแม่แบบถาม make ทีละธงแทนการอ่าน Makefile ด้วยตา — บางธงถูกกำหนดสองครั้งในเงื่อนไขของบอร์ดกับใน else ลองหาธงแบบนั้นด้วย grep -n "ENABLE_PAGE_" proj_cm55/Makefile
• เอกสาร GNU Make หัวข้อ "The Two Flavors of Variables" และ "Overriding Variables"

บทถัดไป: บทเรียน 2.3 — Git สำหรับงานเฟิร์มแวร์

แหล่งที่มาและเครดิต

"พื้นฐานเฟิร์มแวร์ภาษา C บน PSoC Edge" จาก TESA Open Knowledge โดยสมาคมสมองกลฝังตัวไทย
(Thai Embedded Systems Association: TESA) https://github.com/tesaiot/tesa-qualification-program
สัญญาอนุญาต CC BY-NC 4.0

โค้ดของหลักสูตรนี้ (examples/, practice/, solution/) Apache-2.0 · โค้ดของ SDK ไม่ได้คัดลอกเป็นไฟล์
บทเรียนยกมาเป็นช่วงสั้น ๆ พร้อมลิงก์ไปยังไฟล์ที่ commit ef72c1b (Apache-2.0, tesaiot-pse84-devkit-sdk)