timer queue와 tick 처리

QUESTION

timer queue와 tick 처리 단계에서 실제로 바뀌는 상태는 무엇인가?

STRUCTURE

객체와 주소가 놓이는 구조

CALL PATH

실행 흐름

STATE LEDGER

단계별 입력과 출력

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

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

VISUAL WALKTHROUGH

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

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

UPSTREAM SOURCE

원본 코드

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

20 * @{
21 */
22#include <kernel/timer.h>
23
24#include <assert.h>
25#include <kernel/debug.h>
26#include <kernel/spinlock.h>
27#include <kernel/thread.h>
28#include <lk/debug.h>
29#include <lk/list.h>
30#include <lk/trace.h>
31#include <platform.h>
32#include <platform/timer.h>
33
34#define LOCAL_TRACE 0
35
36spin_lock_t timer_lock;
37
38struct timer_state {
39    struct list_node timer_queue;
40} __CPU_ALIGN;
41
42static struct timer_state timers[SMP_MAX_CPUS];
43
44static enum handler_return timer_tick(void *arg, lk_time_t now);
45
46/**
47 * @brief  Initialize a timer object
48 */
49void timer_initialize(timer_t *timer) {
50    *timer = (timer_t)TIMER_INITIAL_VALUE(*timer);
51}
52
53static void insert_timer_in_queue(uint cpu, timer_t *timer) {
54    timer_t *entry;
55
56    DEBUG_ASSERT(arch_ints_disabled());
57
58    LTRACEF("timer %p, cpu %u, scheduled %u, periodic %u\n", timer, cpu, timer->scheduled_time, timer->periodic_time);
59
60    list_for_every_entry(&timers[cpu].timer_queue, entry, timer_t, node) {
61        if (TIME_GT(entry->scheduled_time, timer->scheduled_time)) {
62            list_add_before(&entry->node, &timer->node);
63            return;
64        }
65    }
66
67    /* walked off the end of the list */
68    list_add_tail(&timers[cpu].timer_queue, &timer->node);
69}
70
71static void timer_set(timer_t *timer, lk_time_t delay, lk_time_t period, timer_callback callback, void *arg) {
72    lk_time_t now;
73
74    LTRACEF("timer %p, delay %u, period %u, callback %p, arg %p\n", timer, delay, period, callback, arg);
75
76    DEBUG_ASSERT(timer->magic == TIMER_MAGIC);
77
78    if (list_in_list(&timer->node)) {
79        panic("timer %p already in list\n", timer);
80    }
81
82    now = current_time();
83    timer->scheduled_time = now + delay;
84    timer->periodic_time = period;
85    timer->callback = callback;
86    timer->arg = arg;
87
88    LTRACEF("scheduled time %u\n", timer->scheduled_time);
89
90    spin_lock_saved_state_t state;
91    spin_lock_irqsave(&timer_lock, state);
92
93    uint cpu = arch_curr_cpu_num();
94    insert_timer_in_queue(cpu, timer);
95
96#if PLATFORM_HAS_DYNAMIC_TIMER
97    if (list_peek_head_type(&timers[cpu].timer_queue, timer_t, node) == timer) {
98        /* we just modified the head of the timer queue */
99        LTRACEF("setting new timer for %u msecs\n", delay);
100        platform_set_oneshot_timer(timer_tick, NULL, delay);
101    }
102#endif
103
104    spin_unlock_irqrestore(&timer_lock, state);
105}
106
107/**
108 * @brief  Set up a timer that executes once

READING CONTRACT

발췌 범위와 읽기 기준

원문 20-108줄에는 앞뒤 문맥이 포함됩니다. 기준 구문 static enum handler_return timer_tick(void *arg은 L44에 있습니다. 발췌 첫 줄을 함수 정의의 시작으로 해석하지 않습니다.

callback이 IRQ 문맥에서 실행되는지와 lock이 풀린 구간을 구분한다. callback이 timer를 재등록할 때 iterator와 deadline 계산이 안전한지 확인한다.

RELATED SOURCE

함께 읽어야 하는 원본 코드

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

61        if (TIME_GT(entry->scheduled_time, timer->scheduled_time)) {
62            list_add_before(&entry->node, &timer->node);
63            return;
64        }
65    }
66
67    /* walked off the end of the list */
68    list_add_tail(&timers[cpu].timer_queue, &timer->node);
69}
70
71static void timer_set(timer_t *timer, lk_time_t delay, lk_time_t period, timer_callback callback, void *arg) {
72    lk_time_t now;
73
74    LTRACEF("timer %p, delay %u, period %u, callback %p, arg %p\n", timer, delay, period, callback, arg);
75
76    DEBUG_ASSERT(timer->magic == TIMER_MAGIC);
77
78    if (list_in_list(&timer->node)) {
79        panic("timer %p already in list\n", timer);
80    }
81
82    now = current_time();
83    timer->scheduled_time = now + delay;
84    timer->periodic_time = period;
85    timer->callback = callback;
86    timer->arg = arg;
87
88    LTRACEF("scheduled time %u\n", timer->scheduled_time);
89
90    spin_lock_saved_state_t state;
91    spin_lock_irqsave(&timer_lock, state);
92
93    uint cpu = arch_curr_cpu_num();
94    insert_timer_in_queue(cpu, timer);
95
96#if PLATFORM_HAS_DYNAMIC_TIMER
97    if (list_peek_head_type(&timers[cpu].timer_queue, timer_t, node) == timer) {
98        /* we just modified the head of the timer queue */
99        LTRACEF("setting new timer for %u msecs\n", delay);
100        platform_set_oneshot_timer(timer_tick, NULL, delay);
101    }
102#endif
103
104    spin_unlock_irqrestore(&timer_lock, state);
105}
106
107/**
108 * @brief  Set up a timer that executes once
109 *
110 * This function specifies a callback function to be called after a specified
111 * delay.  The function will be called one time.
112 *
113 * @param  timer The timer to use
114 * @param  delay The delay, in ms, before the timer is executed
115 * @param  callback  The function to call when the timer expires
116 * @param  arg  The argument to pass to the callback
117 *
118 * The timer function is declared as:
119 *   enum handler_return callback(struct timer *, lk_time_t now, void *arg) { ... }
120 */
121void timer_set_oneshot(timer_t *timer, lk_time_t delay, timer_callback callback, void *arg) {
122    if (delay == 0)
123        delay = 1;
124    timer_set(timer, delay, 0, callback, arg);
125}
126
127/**
128 * @brief  Set up a timer that executes repeatedly
129 *
130 * This function specifies a callback function to be called after a specified
131 * delay.  The function will be called repeatedly.
132 *
133 * @param  timer The timer to use

DETAILS

내부 동작을 더 깊게 읽기

IMPLEMENTATION NOTES

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

OBJECT LIFETIME

객체와 수명

FAILURE PATH

실패 지점과 증상

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

EVIDENCE

소스 밖에서 확인할 증거

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

LAB

직접 확인할 실험

1. 01
   timer insert/cancel/expire timestamp 기록

   timer_tick 진입 전후에 platform clockevent의 주소·크기·반환값과 timestamp를 함께 남긴다.

2. 02
   같은 deadline timer 여러 개 순서 확인

   expired timer list 진입 전후에 timer queue의 주소·크기·반환값과 timestamp를 함께 남긴다.

3. 03
   callback에서 timer 재등록 실험

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

PRIMARY REFERENCES

원문과 다음 글