如何保证只有一个进程实例

作者：[e-mail]
博客：blog.focus-linux.net   linuxfocus.blog.chinaunix.net 

微博：weibo.com/glinuxer

QQ技术群：4367710

 

本文的copyleft归[e-mail]所有，使用GPL发布，可以自由拷贝，转载。但转载请保持文档的完整性，注明原作者及原链接，严禁用于任何商业用途。

============================================================================================================================

在编写服务进程的时候，经常有这样一个需求：保证服务进程只有一个实例在运行。

为实现这个简单的功能，有下面各种常见的实现方式：
1. 通过已知的进程名，来查询是否有同名的进程正在运行。
   可以利用proc，也可以读取ps的输出等；
2. 利用pid文件，这也是linux各种服务常见的实现方式：    
    服务进程启动的时候，首先在指定目录下，一般为/var/run/，查找是否已经存在对应该进程的pid文件。
   如果已经存在，表明有同样的进程在运行。但是也许该进程意外崩溃，所以需要进一步检查。读取该pid文件，获得pid。
   然后再利用确定该pid的进程是否存在。如存在，是否为同名进程。

上面两种方式，是我以前常用的方法。后来，我更倾向于下面这种利用flock文件锁的方式。
闲话不说，见代码：

#include <stdio.h>
#include <string.h>
#include <stdlib.h>

#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <errno.h>
#include <sys/file.h>
#include <unistd.h>

#include <my_basetype.h>

static int g_single_proc_inst_lock_fd = -1;

static void single_proc_inst_lockfile_cleanup(void)
{
    if (g_single_proc_inst_lock_fd != -1) {
        close(g_single_proc_inst_lock_fd);
        g_single_proc_inst_lock_fd = -1;
    }
}

B_BOOL is_single_proc_inst_running(const char *process_name)
{
    char lock_file[128];
    snprintf(lock_file, sizeof(lock_file), "/var/tmp/%s.lock", process_name);

    g_single_proc_inst_lock_fd = open(lock_file, O_CREAT|O_RDWR, 0644);
    if (-1 == g_single_proc_inst_lock_fd) {
        fprintf(stderr, "Fail to open lock file(%s). Error: %s\n",
            lock_file, strerror(errno));
        return B_FALSE;
    }

    if (0 == flock(g_single_proc_inst_lock_fd, LOCK_EX | LOCK_NB)) {
        atexit(single_proc_inst_lockfile_cleanup);
        return B_TRUE;
    }

    close(g_single_proc_inst_lock_fd);
    g_single_proc_inst_lock_fd = -1;
    return B_FALSE;

}

注：这个代码由我自定义的类型，如B_BOOL。感兴趣的同学，可以自行更改。

is_single_proc_inst_running为关键函数，返回true，则表明只有一个进程实例在运行（本进程）。返回false则表明已有同名进程在运行了。

利用非阻塞的文件锁，对相应的文件进行上锁。成功获得文件锁的时候，就排斥了其它实例再次拿锁。在进程退出时，无论是正常退出还是意外崩溃的时候，Linux内核本身都会关闭该文件描述符。
当文件关闭时，文件锁都会被释放。这样新的服务进程可以再次启动。


但是我在写这个代码时，还是利用atexit，实现了对该文件描述符的关闭。即使加了这个不必要的实现，这份代码仍然比最早提出的两种方式要简单的多。
这份代码没有考虑多线程竞争，因为没有必要。一般来说，检测进程唯一实例应该是在进程刚刚启动的时候。那时，应该只有一个线程。

希望大家对这个实现提意见，或者分享你的方法。