Linux驱动开发必备：dev_set_drvdata和dev_get_drvdata的5个实战技巧

Linux驱动开发进阶：解锁设备私有数据管理的五个实战心法

在Linux内核驱动的世界里，每个设备实例都像是一个独立的生命体，它们有自己的状态、配置和运行时信息。如何优雅地为这些“生命体”管理其独有的“记忆”，是区分驱动新手与老手的一道分水岭。很多开发者初学时，可能会下意识地使用全局变量或静态变量来存储设备信息，直到遇到需要支持多个相同设备时，才发现代码变得一团糟，实例间的数据相互污染，调试起来苦不堪言。

这正是 dev_set_drvdata 和 dev_get_drvdata 这对内核API存在的核心价值。它们并非什么高深莫测的黑科技，而是内核设备模型为驱动开发者提供的一个标准化、优雅的“挂钩”。通过这个挂钩，你可以将任意一块自定义的内存数据（通常是一个结构体指针）与一个具体的 struct device 对象牢牢绑定。从此，在驱动的任何地方，只要你能拿到这个设备对象，就能随时取回属于它的那份私有数据，实现了完美的数据隔离与实例化管理。

本文将抛开基础定义的赘述，直接切入实战腹地。我们假设你已经知道这两个函数的基本签名，我们将聚焦于五个在真实项目开发中，能显著提升代码质量、避免常见陷阱的进阶技巧。这些技巧关乎内存安全、并发处理、设计模式，以及如何让代码在未来更具适应力。

1. 从内存管理开始：选择正确的分配策略

在 probe 函数中为私有数据分配内存，是使用 dev_set_drvdata 的第一步。这一步的选择，直接决定了后续资源管理的复杂度和安全性。内核提供了多种内存分配函数，我们需要根据场景做出明智决策。

1.1 资源管理分配器：devm_kzalloc 是你的首选

对于绝大多数设备驱动，devm_kzalloc 及其家族函数应是你的默认选择。它的“devm”前缀代表“设备管理资源”（Device Managed Resource）。其核心优势在于，内核会将此次分配的内存与你的设备对象（struct device *dev）的生命周期自动绑定。

static int my_driver_probe(struct platform_device *pdev)
{
    struct my_private_data *priv;

    // 使用 devm_kzalloc 分配并自动清零内存
    priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
    if (!priv)
        return -ENOMEM;

    // 初始化私有数据结构
    priv->irq = platform_get_irq(pdev, 0);
    priv->reg_base = devm_platform_ioremap_resource(pdev, 0);

    // 将私有数据指针关联到设备
    platform_set_drvdata(pdev, priv); // 内部调用 dev_set_drvdata

    // ... 其他初始化操作
    return 0;
}

注意：使用 devm_kzalloc 后，在驱动的 remove 函数中，你无需也不能再调用 kfree 来释放 priv。当设备被卸载或探测失败时，内核的设备核心代码会自动释放所有通过 devm_ 系列函数为该设备分配的资源。这从根本上杜绝了因忘记释放而导致的内存泄漏。

1.2 何时使用传统的 kzalloc？

虽然 devm_kzalloc 非常方便，但在某些特定场景下，你可能仍需使用传统的 kzalloc。

• 数据生命周期与设备不完全一致：如果你分配的数据需要在设备被移除（remove）之后继续存在一段时间，或者在设备成功探测（probe）之前就需要使用。
• 复杂的多阶段初始化：内存分配和资源获取可能失败，你需要更精细的清理控制，而不是依赖自动回滚。

使用 kzalloc 时，你必须肩负起手动管理的责任：

static int my_driver_probe(struct platform_device *pdev)
{
    struct my_private_data *priv;

    priv = kzalloc(sizeof(*priv), GFP_KERNEL);
    if (!priv)
        return -ENOMEM;

    if (some_init_step_failed(priv)) {
        kfree(priv); // 手动释放
        return -EIO;
    }

    platform_set_drvdata(pdev, priv);
    return 0;
}

static int my_driver_remove(struct platform_device *pdev)
{
    struct my_private_data *priv = platform_get_drvdata(pdev);

    // 执行必要的硬件反初始化...

    kfree(priv); // 必须手动释放！
    return 0;
}

为了清晰地对比这两种策略，我们将其核心差异总结如下：

特性	devm_kzalloc	kzalloc
内存释放	自动，由设备生命周期管理	手动，需在 remove 或错误路径调用 kfree
优点	防止内存泄漏，代码简洁	提供完全的控制权，生命周期可自定义
缺点	生命周期严格绑定设备	易因遗忘释放导致泄漏，增加代码复杂度
推荐场景	绝大多数设备私有数据分配	数据生命周期特殊、需要复杂错误处理的场景

我的个人经验是，在驱动开发的早期就养成使用 devm_kzalloc 的习惯。它能让你的 remove 函数保持清爽，专注于硬件反初始化，而将内存管理的负担交给成熟的内核框架。只有在框架无法满足你的特定需求时，才退回到手动管理。

2. 应对多设备实例：私有数据是隔离的基石

驱动支持多个同类型设备实例是再常见不过的需求。dev_set_drvdata 机制天生就是为这种场景设计的，因为它将数据存储在每个设备对象内部，实现了完美的隔离。

2.1 一个典型的并发探测场景

假设我们有一个控制多个独立LED灯板的平台驱动。每个灯板在设备树中都是一个独立的节点，内核会为每个节点创建一个 platform_device，并依次调用驱动的 probe 函数。

// 私有数据结构，代表一个灯板的状态
struct led_board_data {
    void __iomem *reg_base;
    int led_count;
    struct mutex lock; // 每个实例有自己的锁
    u32 brightness[MAX_LEDS];
};

static int led_board_probe(struct platform_device *pdev)
{
    struct device *dev = &pdev->dev;
    struct led_board_data *board;
    struct resource *res;
    int ret;

    board = devm_kzalloc(dev, sizeof(*board), GFP_KERNEL);
    if (!board)
        return -ENOMEM;

    // 获取该实例独有的硬件资源（如寄存器地址）
    res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
    board->reg_base = devm_ioremap_resource(dev, res);
    if (IS_ERR(board->reg_base))
        return PTR_ERR(board->reg_base);

    // 从设备树读取该实例特有的属性，比如这个板子有多少个LED
    ret = device_property_read_u32(dev, "num-leds", &board->led_count);
    if (ret) {
        board->led_count = DEFAULT_LED_COUNT; // 默认值
    }

    mutex_init(&board->lock); // 初始化该实例的互斥锁

    // 关键一步：将私有数据绑定到这个特定的pdev上
    platform_set_drvdata(pdev, board);

    // 创建设备文件，sysfs节点等，这些操作会用到board数据
    // 它们现在都只影响当前这个设备实例
    dev_info(dev, "Probed LED board with %d LEDs at %pR\n",
             board->led_count, res);
    return 0;
}

当系统中有两个LED灯板时，内核会调用两次 led_board_probe，每次都会：

1. 为新的 struct led_board_data 分配内存。
2. 映射该灯板独有的物理地址空间。
3. 初始化该灯板独有的互斥锁。
4. 将这块内存的指针通过 platform_set_drvdata 存入当前正在探测的 pdev->dev 中。

这样，驱动中所有通过 platform_get_drvdata(pdev) 获取到的 board 指针，都严格指向与当前操作上下文（即 pdev）对应的那个灯板的数据。两个灯板的状态、寄存器、锁完全独立，互不干扰。

2.2 在文件操作中正确获取实例数据

当用户空间通过 /dev/ledboardX 设备文件进行操作时，驱动需要知道操作的是哪个实例。这通常通过 file->private_data 或容器宏来实现，而其源头正是设备的私有数据。

static int led_board_open(struct inode *inode, struct file *file)
{
    struct platform_device *pdev;
    struct led_board_data *board;

    // 从inode获取对应的平台设备指针（具体方法取决于你的驱动类型）
    pdev = container_of(inode->i_cdev, struct platform_device, dev);
    // 安全地获取该设备实例的私有数据
    board = platform_get_drvdata(pdev);
    if (!board) {
        return -ENODEV; // 设备可能已被移除
    }

    // 可以将board指针存到file->private_data，方便后续read/write调用使用
    file->private_data = board;
    return 0;
}

static ssize_t led_board_write(struct file *file, const char __user *buf,
                               size_t count, loff_t *ppos)
{
    struct led_board_data *board = file->private_data;
    // 现在board指向的就是打开的那个特定灯板实例的数据
    // 操作board->reg_base只会影响那个具体的硬件
    // ...
    return count;
}

这种模式清晰地将设备实例、其私有数据以及用户空间的操作句柄关联起来，是多实例驱动设计的标准范式。

3. 确保线程安全：私有数据访问的锁策略

dev_get_drvdata 仅仅返回一个指针。如果这个指针指向的数据结构会被多个内核线程（例如，中断处理程序、工作队列、并发的系统调用）访问和修改，那么你必须引入锁机制来保护它。

3.1 将锁嵌入私有数据结构

最直接的方式是将锁作为私有数据结构的一个成员。这样，每个设备实例都拥有自己独立的锁，锁的粒度最细，并发性能最好。

struct my_concurrent_data {
    spinlock_t data_lock; // 用于保护以下数据
    int current_value;
    u32 event_count;
    wait_queue_head_t wait_queue;
    // ... 其他成员
};

static irqreturn_t my_interrupt_handler(int irq, void *dev_id)
{
    struct platform_device *pdev = dev_id;
    struct my_concurrent_data *priv = platform_get_drvdata(pdev);
    unsigned long flags;

    // 使用自旋锁保护中断上下文中的数据访问
    spin_lock_irqsave(&priv->data_lock, flags);
    priv->event_count++;
    // 可能更新 current_value
    spin_unlock_irqrestore(&priv->data_lock, flags);

    // 唤醒可能正在等待事件的进程
    wake_up_interruptible(&priv->wait_queue);
    return IRQ_HANDLED;
}

static ssize_t my_device_read(struct file *file, char __user *buf,
                              size_t count, loff_t *ppos)
{
    struct my_concurrent_data *priv = file->private_data;
    DEFINE_WAIT(wait);
    int ret;

    // 在进程上下文中，我们可以睡眠，使用互斥锁或信号量更合适
    // 但这里为了与中断共享数据，我们仍用自旋锁
    // 或者，可以设计为用原子变量来存储event_count，避免锁。
    // 这里仅为示例。
    spin_lock(&priv->data_lock);
    while (priv->event_count == 0) {
        spin_unlock(&priv->data_lock);
        prepare_to_wait(&priv->wait_queue, &wait, TASK_INTERRUPTIBLE);
        if (signal_pending(current)) {
            finish_wait(&priv->wait_queue, &wait);
            return -ERESTARTSYS;
        }
        schedule();
        finish_wait(&priv->wait_queue, &wait);
        spin_lock(&priv->data_lock);
    }
    // ... 读取数据
    spin_unlock(&priv->data_lock);
    return ret;
}

3.2 锁的选择与注意事项

• 自旋锁 (spinlock_t)：适用于保护在中断上下文或不允许睡眠的原子上下文中访问的数据。等待锁的线程会“自旋”忙等。切忌在持有自旋锁时调用任何可能引发睡眠的函数（如 kmalloc(GFP_KERNEL), copy_from_user）。
• 互斥锁 (mutex)：适用于只在进程上下文中访问的数据。如果获取不到锁，任务会睡眠。它比自旋锁开销大，但更适用于临界区执行时间较长的场景。
• 读写信号量 (rw_semaphore)：如果你的数据结构读多写少，可以考虑使用读写锁来提高并发读的性能。

关键点在于，锁的保护对象是 dev_get_drvdata 返回的指针所指向的内容，而不是获取指针这个动作本身。dev_get_drvdata 本身是原子的、安全的。

4. 超越基础封装：处理复杂设备类型与层次结构

内核为常见总线（如 platform、I2C、PCI、SPI）提供了 xxx_set_drvdata 的封装函数，这主要是为了代码的简洁性和可读性。但在面对复杂驱动，尤其是那些涉及设备树、子设备、或类设备（class）的驱动时，我们需要更深入地理解其本质。

4.1 本质：一切皆归于 struct device

无论 platform_set_drvdata 还是 i2c_set_clientdata，其底层最终调用的都是 dev_set_drvdata(struct device *dev, ...)。理解这一点，能让你在遇到非常规情况时游刃有余。

// 内核源码中的典型实现（简化）
static inline void platform_set_drvdata(struct platform_device *pdev, void *data)
{
    dev_set_drvdata(&pdev->dev, data);
}

static inline void i2c_set_clientdata(const struct i2c_client *client, void *data)
{
    dev_set_drvdata(&client->dev, data);
}

因此，如果你有一个 struct device 指针，即使你不知道它具体来自哪种总线，也可以直接使用 dev_set/get_drvdata。这在编写通用性较强的设备模型辅助函数时很有用。

4.2 场景：管理子设备的私有数据

假设你编写一个“父”驱动，它管理一个核心硬件，并动态创建多个“子”设备（例如，一个多功能芯片驱动为每个功能创建一个独立的子设备）。父驱动需要为每个子设备管理一些状态。

struct child_device_data {
    struct device *child_dev;
    int function_id;
    void *parent_priv; // 指向父设备私有数据的某部分
    // ... 子设备特有数据
};

// 在父驱动的某个函数中，创建子设备并关联数据
static int create_child_device(struct parent_data *parent, int id)
{
    struct child_device_data *child_data;
    struct device *child;

    child = device_create(parent->class, parent->dev, MKDEV(0,0),
                          NULL, "child%d", id);
    if (IS_ERR(child))
        return PTR_ERR(child);

    child_data = devm_kzalloc(parent->dev, sizeof(*child_data), GFP_KERNEL);
    if (!child_data) {
        device_destroy(parent->class, child->devt);
        return -ENOMEM;
    }

    child_data->child_dev = child;
    child_data->function_id = id;
    child_data->parent_priv = &parent->submodule[id];

    // 关键：将子设备数据直接关联到子设备的struct device
    dev_set_drvdata(child, child_data);

    return 0;
}

// 后来，在子设备触发的中断或操作中，可以通过传入的struct device*找到其数据
static void handle_child_event(struct device *child_dev)
{
    struct child_device_data *data = dev_get_drvdata(child_dev);
    // 现在你可以操作这个特定子设备的数据了
    process_function(data->function_id, data->parent_priv);
}

这种模式允许你将复杂的设备树层次关系，清晰地映射到内存中的数据结构层次上。

5. 防御性编程与调试技巧：让代码更健壮

即使理解了原理，在实际编码中，围绕 dev_set_drvdata 和 dev_get_drvdata 仍有一些细微之处需要注意，以避免空指针、生命周期错乱等顽疾。

5.1 在 remove 或 shutdown 中清空指针

这是一个好习惯，可以防止在设备被部分拆除后，某些延迟执行的代码（如定时器回调）通过陈旧的指针访问已释放的内存。

static int my_driver_remove(struct platform_device *pdev)
{
    struct my_private_data *priv = platform_get_drvdata(pdev);

    // 1. 停止所有可能访问priv的异步活动（定时器、工作队列、中断）
    del_timer_sync(&priv->watchdog_timer);
    free_irq(priv->irq, pdev);

    // 2. 执行硬件反初始化...

    // 3. 如果是devm分配，无需kfree。但建议将drvdata置NULL。
    // 如果是kzalloc分配，先kfree，再置NULL。
    // 这里以devm为例：
    platform_set_drvdata(pdev, NULL); // 清空！

    // 注意：对于devm_kzalloc，priv指针本身会在后续被内核自动释放，
    // 但将其从dev中解绑是一个清晰的标志。
    return 0;
}

5.2 在访问前检查指针有效性

任何从 dev_get_drvdata 获取的指针，在解引用前，尤其是在可能并发执行的环境中，都应进行有效性检查。

void some_deferred_work(struct work_struct *work)
{
    struct my_private_data *priv = container_of(work, struct my_private_data, work);
    // 假设这个work是priv结构体的一部分，通过container_of获得priv。

    // 但更安全的模式是，work函数通过设备指针获取priv：
    // struct platform_device *pdev = to_platform_device(some_device_ptr);
    // struct my_private_data *priv = platform_get_drvdata(pdev);

    if (!priv) {
        pr_err("Work queued for a device with no private data!\n");
        return;
    }

    // 进一步检查设备是否仍然“存活”
    if (!priv->device_active) {
        return; // 设备已下线，忽略此次工作
    }

    // ... 安全地操作 priv->...
}

5.3 利用调试工具：CONFIG_DEBUG_DRIVER_DATA

对于深度的调试，可以启用内核配置选项 CONFIG_DEBUG_DRIVER_DATA（如果内核版本支持）。它会为 driver_data 字段增加额外的调试检查，例如在设备生命周期结束后检测是否还有代码试图访问其私有数据，有助于发现生命周期管理相关的Bug。

最后，我想分享一个自己踩过的坑：曾经在一个驱动中，我将一个在模块初始化阶段分配的静态数据结构的地址设置为了 drvdata。这在该驱动只支持一个设备时工作正常。但当后来需要支持多实例时，所有设备实例的 drvdata 都指向了同一块全局内存，导致数据混乱。这个教训让我深刻理解到，dev_set_drvdata 存储的必须是每个设备实例独有的数据指针，通常是在 probe 中动态分配的结果。静态或全局变量的地址，除非经过精心设计（如作为每个实例数据的索引），否则绝不应该直接存入。