Device Driver Design Patterns

Device driver design pattern 소개

이 문서는 device driver에서 흔히 볼 수 있는 몇 가지 design pattern을 설명합니다. subsystem maintainer는 driver developer에게 이 pattern을 따르도록 요구할 가능성이 큽니다.

• State Container
• container_of()

State Container와 reentrant probe

kernel에는 특정 system에서 `probe()`가 한 번만 호출된다고 가정하는 singleton driver도 조금 있지만, 일반적인 관례는 driver가 bind하는 device instance가 여러 개 나타날 수 있다고 가정하는 것입니다. 따라서 `probe()`와 모든 callback은 reentrant해야 합니다.

이를 구현하는 가장 흔한 방법이 state container design pattern이며 보통 다음 형태입니다.

struct foo {
    spinlock_t lock; /* Example member */
    (...)
};

static int foo_probe(...)
{
    struct foo *foo;

    foo = devm_kzalloc(dev, sizeof(*foo), GFP_KERNEL);
    if (!foo)
        return -ENOMEM;
    spin_lock_init(&foo->lock);
    (...)
}

`probe()`가 호출될 때마다 memory에 `struct foo` instance를 하나 생성합니다. 이것이 해당 device-driver instance의 state container입니다. state와 member에 접근해야 하는 모든 function에 이 instance를 계속 전달해야 합니다.

Interrupt handler에 state 전달

예를 들어 driver가 interrupt handler를 등록한다면 다음처럼 `struct foo` pointer를 context로 전달합니다.

static irqreturn_t foo_handler(int irq, void *arg)
{
    struct foo *foo = arg;
    (...)
}

static int foo_probe(...)
{
    struct foo *foo;

    (...)
    ret = request_irq(irq, foo_handler, 0, "foo", foo);
}

이렇게 하면 interrupt handler에서 항상 올바른 `foo` instance pointer를 돌려받습니다.

container_of()와 offloaded work

앞의 예제에 offloaded work를 추가하면 다음과 같습니다.

struct foo {
    spinlock_t lock;
    struct workqueue_struct *wq;
    struct work_struct offload;
    (...)
};

static void foo_work(struct work_struct *work)
{
    struct foo *foo = container_of(work, struct foo, offload);

    (...)
}

static irqreturn_t foo_handler(int irq, void *arg)
{
    struct foo *foo = arg;

    queue_work(foo->wq, &foo->offload);
    (...)
}

static int foo_probe(...)
{
    struct foo *foo;

    foo->wq = create_singlethread_workqueue("foo-wq");
    INIT_WORK(&foo->offload, foo_work);
    (...)
}

interrupt handler는 `foo->offload` work를 queue하고, work callback은 전달받은 `struct work_struct *`에서 `container_of(work, struct foo, offload)`로 자신을 포함하는 `struct foo` instance를 복원합니다.

container_of()의 조건과 효과

callback에서 struct member 하나를 가리키는 pointer만 돌려주는 `hrtimer` 같은 mechanism에도 같은 design pattern을 적용합니다. `container_of()`는 `<linux/kernel.h>`에 정의된 macro입니다.

`container_of()`는 standard C의 `offsetof()` macro를 이용한 단순 subtraction으로 member pointer에서 그 member를 포함하는 struct pointer를 구합니다. 이를 통해 object-oriented behavior와 비슷한 동작을 구현할 수 있습니다. 이 방식이 동작하려면 contained member가 pointer가 아니라 실제 embedded member여야 합니다.

따라서 `struct foo *` instance를 가리키는 global pointer를 피하면서도 work function에는 pointer 하나만 전달하면 됩니다.