Linux 驅動學習筆記 - 自旋鎖 (十一)

Linux 驅動學習筆記 - 自旋鎖 (十一)

本系列均爲正點原子 Linux 驅動的學習筆記, 以便加深筆者記憶。如讀者想進一步學習，可以到正點原子官網中下載資料進行學習。

自旋鎖適用於短時期的輕量級加鎖

自旋鎖定義

Linux 內核使用結構體 spinlock_t 表示自旋鎖，在使用自旋鎖以前，需要先定義一個自旋鎖，定義方法如下：

spinlock_t lock;    /* 定義自旋鎖 */

自旋鎖 API

基本的自旋鎖 API 如下表：

函數	描述
DEFINE_SPINLOCK(spinlock_t lock)	定義並初始化一個自旋鎖
int spin_lock_init(spinlock_t *lock)	初始化自旋鎖
void spin_lock(spinlock_t *lock)	獲取指定的自旋鎖，也叫做加鎖
void spin_unlock(spinlock_t *lock)	釋放指定的自旋鎖
int spin_trylock(spinlock_t *lock)	嘗試獲取指定的自旋鎖，如果沒有獲取到就返回 0
int spin_is_locked(spinlock_t *lock)	檢查指定的自旋鎖是否被獲取，如果沒有被獲取就返回非 0，否則返回 0

死鎖

上表中的自旋鎖 API 函數適用於 SMP 或支持搶佔的單 CPU 下線程之間的併發訪問，也就是用於線程與線程之間，被自旋鎖保護的臨界區一定不能調用任何能夠引起睡眠和阻塞的 API 函數，否則的話會可能會導致死鎖現象的發生。

自旋鎖會自動禁止搶佔，也就說當線程 A 得到鎖以後會暫時禁止內核搶佔。如果線程 A 在持有鎖期間進入了休眠狀態，那麼線程 A 會自動放棄 CPU 使用權。線程 B 開始運行，線程 B 也想要獲取鎖，但是此時鎖被 A 線程持有，而且內核搶佔還被禁止了！線程 B 無法被調度出去，那麼線程 A 就無法運行，鎖也就無法釋放，好了，死鎖發生了！

中斷

上表中的 API 函數用於線程之間的併發訪問，如果此時中斷也要插一腳，中斷也想訪問共享資源，那該怎麼辦呢？首先可以肯定的是，中斷裏面可以使用自旋鎖，但是在中斷裏面使用自旋鎖的時候，在獲取鎖之前一定要先禁止本地中斷(也就是本 CPU 中斷，對於多核 SOC來說會有多個 CPU 核)，否則可能導致鎖死現象的發生。

最好的解決方法就是獲取鎖之前關閉本地中斷，Linux 內核提供了相應的 API 函數，如下表所示：

函數	描述
void spin_lock_irq(spinlock_t *lock)	禁止本地中斷，並獲取自旋鎖
void spin_unlock_irq(spinlock_t *lock)	激活本地中斷，並釋放自旋鎖
void spin_lock_irqsave(spinlock_t *lock, unsigned long flags)	保存中斷狀態，禁止本地中斷，並獲取自旋鎖
void spin_unlock_irqrestore(spinlock_t *lock, unsigned long flags)	將中斷狀態恢復到以前的狀態，並且激活本地中斷，釋放自旋鎖

使用 spin_lock_irq/spin_unlock_irq 的時候需要用戶能夠確定加鎖之前的中斷狀態，但實際上內核很龐大，運行也是千變萬化，我們是很難確定某個時刻的中斷狀態，因此不推薦使用spin_lock_irq/spin_unlock_irq。建議使用 spin_lock_irqsave/spin_unlock_irqrestore，因爲這一組函數會保存中斷狀態，在釋放鎖的時候會恢復中斷狀態。一般在線程中使用 spin_lock_irqsave/spin_unlock_irqrestore，在中斷中使用 spin_lock/spin_unlock，示例代碼如下所示：

DEFINE_SPINLOCK(lock) /* 定義並初始化一個鎖 */
/* 線程 A */
void functionA ()
{
    unsigned long flags; /* 中斷狀態 */
    spin_lock_irqsave(&lock, flags) /* 獲取鎖 */
    /* 臨界區 */
    spin_unlock_irqrestore(&lock, flags) /* 釋放鎖 */
}

/* 中斷服務函數 */
void irq() 
{
    spin_lock(&lock) /* 獲取鎖 */
    /* 臨界區 */
    spin_unlock(&lock) /* 釋放鎖 */
}

下半部

函數	描述
void spin_lock_bh(spinlock_t *lock)	關閉下半部，並獲取自旋鎖
void spin_unlock_bh(spinlock_t *lock)	打開下半部，並釋放自旋鎖

注意事項

• 因爲在等待自旋鎖的時候處於 自旋 狀態，因此鎖的持有時間不能太長，一定要短，否則的話會降低系統性能。如果臨界區較大，運行時間較長的話可以使用其它的併發處理方式，比如信號量和互斥體

• 自旋鎖保護的臨界區不能調用任何可能導致線程休眠的 API 函數，否則的話可能導致死鎖

• 不能遞歸申請自旋鎖，因爲一旦通過遞歸的方式申請一個你正在持有的鎖，那麼你就
  必須自旋，等待鎖被釋放，然而你正處於自旋狀態，根本沒法釋放鎖。結果就是自己
  把自己鎖死了！

• 在編寫驅動程序的時候我們必須考慮到驅動的可移植性，因此不管你用的是單核的還
  是多核的 SOC，都將其當做多核 SOC 來編寫驅動程序。

測試程序

#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/ide.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/errno.h>
#include <linux/gpio.h>
#include <linux/cdev.h>
#include <linux/device.h>
#include <linux/of.h>
#include <linux/of_address.h>
#include <linux/of_gpio.h>
#include <asm/mach/map.h>
#include <asm/uaccess.h>
#include <asm/io.h>

#define GPIOLED_CNT 1          /* 設備號個數 */
#define GPIOLED_NAME "gpioled" /* 名字 */
#define LEDOFF 0               /* 關燈 */
#define LEDON 1                /* 開燈 */

/* gpioled設備結構體 */
struct gpioled_dev
{
    dev_t devid;            /* 設備號 	 */
    struct cdev cdev;       /* cdev 	*/
    struct class *class;    /* 類 		*/
    struct device *device;  /* 設備 	 */
    int major;              /* 主設備號	  */
    int minor;              /* 次設備號   */
    struct device_node *nd; /* 設備節點 */
    int led_gpio;           /* led所使用的GPIO編號		*/
    int dev_stats;          /* 設備使用狀態，0，設備未使用;>0,設備已經被使用 */
    spinlock_t lock;        /* 自旋鎖 */
};

struct gpioled_dev gpioled; /* led設備 */

/*
 * @description		: 打開設備
 * @param - inode 	: 傳遞給驅動的inode
 * @param - filp 	: 設備文件，file結構體有個叫做private_data的成員變量
 * 					  一般在open的時候將private_data指向設備結構體。
 * @return 			: 0 成功;其他 失敗
 */
static int led_open(struct inode *inode, struct file *filp)
{
    unsigned long flags;
    filp->private_data = &gpioled; /* 設置私有數據 */

    spin_lock_irqsave(&gpioled.lock, flags); /* 上鎖 */
    if (gpioled.dev_stats)
    {                                                 /* 如果設備被使用了 */
        spin_unlock_irqrestore(&gpioled.lock, flags); /* 解鎖 */
        return -EBUSY;
    }
    gpioled.dev_stats++;                          /* 如果設備沒有打開，那麼就標記已經打開了 */
    spin_unlock_irqrestore(&gpioled.lock, flags); /* 解鎖 */

    return 0;
}

/*
 * @description		: 從設備讀取數據 
 * @param - filp 	: 要打開的設備文件(文件描述符)
 * @param - buf 	: 返回給用戶空間的數據緩衝區
 * @param - cnt 	: 要讀取的數據長度
 * @param - offt 	: 相對於文件首地址的偏移
 * @return 			: 讀取的字節數，如果爲負值，表示讀取失敗
 */
static ssize_t led_read(struct file *filp, char __user *buf, size_t cnt, loff_t *offt)
{
    return 0;
}

/*
 * @description		: 向設備寫數據 
 * @param - filp 	: 設備文件，表示打開的文件描述符
 * @param - buf 	: 要寫給設備寫入的數據
 * @param - cnt 	: 要寫入的數據長度
 * @param - offt 	: 相對於文件首地址的偏移
 * @return 			: 寫入的字節數，如果爲負值，表示寫入失敗
 */
static ssize_t led_write(struct file *filp, const char __user *buf, size_t cnt, loff_t *offt)
{
    int retvalue;
    unsigned char databuf[1];
    unsigned char ledstat;
    struct gpioled_dev *dev = filp->private_data;

    retvalue = copy_from_user(databuf, buf, cnt);
    if (retvalue < 0)
    {
        printk("kernel write failed!\r\n");
        return -EFAULT;
    }

    ledstat = databuf[0]; /* 獲取狀態值 */

    if (ledstat == LEDON)
    {
        gpio_set_value(dev->led_gpio, 0); /* 打開LED燈 */
    }
    else if (ledstat == LEDOFF)
    {
        gpio_set_value(dev->led_gpio, 1); /* 關閉LED燈 */
    }
    return 0;
}

/*
 * @description		: 關閉/釋放設備
 * @param - filp 	: 要關閉的設備文件(文件描述符)
 * @return 			: 0 成功;其他 失敗
 */
static int led_release(struct inode *inode, struct file *filp)
{
    unsigned long flags;
    struct gpioled_dev *dev = filp->private_data;

    /* 關閉驅動文件的時候將dev_stats減1 */
    spin_lock_irqsave(&dev->lock, flags); /* 上鎖 */
    if (dev->dev_stats)
    {
        dev->dev_stats--;
    }
    spin_unlock_irqrestore(&dev->lock, flags); /* 解鎖 */

    return 0;
}

/* 設備操作函數 */
static struct file_operations gpioled_fops = {
    .owner = THIS_MODULE,
    .open = led_open,
    .read = led_read,
    .write = led_write,
    .release = led_release,
};

/*
 * @description	: 驅動入口函數
 * @param 		: 無
 * @return 		: 無
 */
static int __init led_init(void)
{
    int ret = 0;

    /*  初始化自旋鎖 */
    spin_lock_init(&gpioled.lock);

    /* 設置LED所使用的GPIO */
    /* 1、獲取設備節點：gpioled */
    gpioled.nd = of_find_node_by_path("/gpioled");
    if (gpioled.nd == NULL)
    {
        printk("gpioled node not find!\r\n");
        return -EINVAL;
    }
    else
    {
        printk("gpioled node find!\r\n");
    }

    /* 2、 獲取設備樹中的gpio屬性，得到LED所使用的LED編號 */
    gpioled.led_gpio = of_get_named_gpio(gpioled.nd, "led-gpio", 0);
    if (gpioled.led_gpio < 0)
    {
        printk("can't get led-gpio");
        return -EINVAL;
    }
    printk("led-gpio num = %d\r\n", gpioled.led_gpio);

    /* 3、設置GPIO1_IO03爲輸出，並且輸出高電平，默認關閉LED燈 */
    ret = gpio_direction_output(gpioled.led_gpio, 1);
    if (ret < 0)
    {
        printk("can't set gpio!\r\n");
    }

    /* 註冊字符設備驅動 */
    /* 1、創建設備號 */
    if (gpioled.major)
    { /*  定義了設備號 */
        gpioled.devid = MKDEV(gpioled.major, 0);
        register_chrdev_region(gpioled.devid, GPIOLED_CNT, GPIOLED_NAME);
    }
    else
    {                                                                      /* 沒有定義設備號 */
        alloc_chrdev_region(&gpioled.devid, 0, GPIOLED_CNT, GPIOLED_NAME); /* 申請設備號 */
        gpioled.major = MAJOR(gpioled.devid);                              /* 獲取分配號的主設備號 */
        gpioled.minor = MINOR(gpioled.devid);                              /* 獲取分配號的次設備號 */
    }
    printk("gpioled major=%d,minor=%d\r\n", gpioled.major, gpioled.minor);

    /* 2、初始化cdev */
    gpioled.cdev.owner = THIS_MODULE;
    cdev_init(&gpioled.cdev, &gpioled_fops);

    /* 3、添加一個cdev */
    cdev_add(&gpioled.cdev, gpioled.devid, GPIOLED_CNT);

    /* 4、創建類 */
    gpioled.class = class_create(THIS_MODULE, GPIOLED_NAME);
    if (IS_ERR(gpioled.class))
    {
        return PTR_ERR(gpioled.class);
    }

    /* 5、創建設備 */
    gpioled.device = device_create(gpioled.class, NULL, gpioled.devid, NULL, GPIOLED_NAME);
    if (IS_ERR(gpioled.device))
    {
        return PTR_ERR(gpioled.device);
    }

    return 0;
}

/*
 * @description	: 驅動出口函數
 * @param 		: 無
 * @return 		: 無
 */
static void __exit led_exit(void)
{
    /* 註銷字符設備驅動 */
    cdev_del(&gpioled.cdev);                              /*  刪除cdev */
    unregister_chrdev_region(gpioled.devid, GPIOLED_CNT); /* 註銷設備號 */

    device_destroy(gpioled.class, gpioled.devid);
    class_destroy(gpioled.class);
}

module_init(led_init);
module_exit(led_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("tyustli");