linux下程序如何实现单实例运行

1、技术原理

无论是windows还是linux下，程序设计者都会遇到一个问题，那就是如何实现程序的单实例运行。比如，Windows自带的播放软件Windows Medea Player只能启动一个实例。原因很简单，如果同时启动几个实例，却播放不同的文件，那么声音和图像就会引起混乱。所以，我们要做的就是，程序启动时检测一下系统中是否已经存在一个完全一样的实例，如果已经存在，则本次启动的程序自动退出。那么，从编码的角度来分析，该如何实现这个效果呢？在linux系统中，我们一般有以下几种方法：

1. shell使用ps命令来判断。最常见也是最简单的方案，直接写一个特定的shell脚本来实现。不过存在可移植性差的问题，进程名字一旦改变之后，脚本就失去作用无法监控。同时，还要额外附加这个脚本文件在系统中运行，实在有点多余；
2. 信号量/共享内存。使用共享内存，通过shmget操作共享内存，然后写入pid，这样就不用生成可见的文件。这个方案只存在一个很小的缺陷，需要配置共享内存的key，并保证不与系统其他应用冲突，一般来说，冲突概率非常小；
3. 端口抢占。应用于大多数的Linux网络应用。思路是系统保证每个端口的TCP只能有一个进程监听，那么如果程序启动时，监听一个核心的端口，第二个运行的实例就会监听失败，无法启动。这个方案同样很有效，省去了一个额外的配置文件，不足之处是一般只用于带网络的程序；
4. 创建文件，加锁（建议性锁）。这种做法最常见了，应用于大多数的Linux程序，如apache httpd, mysql。思路是配置一个pid文件，当程序启动时，对pid文件加锁，然后写入本进程的pid，如果锁失败，说明有实例已经启动了。这个方案非常可靠，唯一的不足是需要配置一个pid文件，并且保证文件目录和文件可写；
5. 进程列表检测。对于运维常用的方法。由于运维不一定能控制程序的修改，所以考虑从外部解决。crontab脚本，查询运行的进程数，一旦发现进程数与预期不符，那么killall，重启进程。这个方案是旁路方案，比上面的方式更通用，还可以监视进程数，避免某些子进程core。这个方案没有什么缺陷，如果硬要找一个的话，不同的系统ps命令输出可能不一样，脚本需要考虑移植。

2、源码实现

经过一番对比，优选其中的方案4，也是最大众化的一个方案。下面就是详细的代码实现：

• single_instance.c源代码

/**************************************************************************************************
**                                                                                               **
**  文件名称:  single_instance.c                                                                 **
**  版权所有:  CopyRight @ LEON WorkStudio CO.LTD. 2017                                          **
**  文件描述:  判断系统中是否已经存在该进程的实例                                                **
**  ===========================================================================================  **
**  创建信息:  | 2017-9-14 | LEON | 创建本模块                                                   **
**  ===========================================================================================  **
**  修改信息:  单击此处添加....                                                                  **
**************************************************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <fcntl.h>
#include <printf.h>
#include <string.h>
#include <errno.h>
#include <sys/stat.h>

/**************************************************************************************************
**  函数名称:  lockfile
**  功能描述:  对文件加锁
**  输入参数:  无
**  输出参数:  无
**  返回参数:  无
**************************************************************************************************/
static int lockfile(int fd)
{
    struct flock fl;

    fl.l_type   = F_WRLCK;
    fl.l_start  = 0;
    fl.l_whence = SEEK_SET;
    fl.l_len    = 0;

    return(fcntl(fd, F_SETLK, &fl));
}

/**************************************************************************************************
**  函数名称:  proc_is_exist
**  功能描述:  判断系统中是否存在该进程
**  输入参数:  procname: 进程名
**  输出参数:  无
**  返回参数:  返回1表示系统中已经存在该进程了；返回0表示系统中不存在该进程
**  注意事项:  此处加锁完后无需对文件进行close，而是进程退出后由系统来释放；否则无法起到保护的作用
**************************************************************************************************/
int proc_is_exist(const char *procname)
{
    int  fd;
    char buf[16];
    char filename[100];

    sprintf(filename, "/var/run/%s.pid", procname);

    fd = open(filename, O_RDWR | O_CREAT, (S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
    if (fd < 0) {
        printf("open file \"%s\" failed!!!\n", filename);
        return 1;
    }

    if (lockfile(fd) == -1) {                                                  /* 尝试对文件进行加锁 */
        printf("file \"%s\" locked. proc already exit!!!\n", filename);
        close(fd);
        return 1;
    } else {
        ftruncate(fd, 0);                                                      /* 写入运行实例的pid */
        sprintf(buf, "%ld", (long)getpid());
        write(fd, buf, strlen(buf) + 1);
        return 0;
    }
}

• single_instance.h源代码

/**************************************************************************************************
**                                                                                               **
**  文件名称:  single_instance.h                                                                 **
**  版权所有:  CopyRight @ LEON WorkStudio CO.LTD. 2017                                          **
**  文件描述:  判断系统中是否已经存在该进程的实例                                                **
**  ===========================================================================================  **
**  创建信息:  | 2017-9-14 | LEON | 创建本模块                                                   **
**  ===========================================================================================  **
**  修改信息:  单击此处添加....                                                                  **
**************************************************************************************************/
#ifndef SINGLE_INSTANCE_H
#define SINGLE_INSTANCE_H

#ifdef __cplusplus
extern "C"
{
#endif

int proc_is_exist(const char *procname);

#ifdef __cplusplus
}
#endif

#endif

3、使用说明

调用者只需在程序启动时调用本函数，根据返回值进行判断即可：

if (proc_is_exist(g_fk_process_name) == TRUE) {                             /* 单实例运行 */
    print_sys("an \"%s\" already running in system. exit now...\n", g_fk_process_name);
    return 0;
} else {
    print_sys("\"%s\" starting...\n", g_fk_process_name);
}