Linux system函数返回值

1、语法

#include <stdlib.h>

int system(const char *command);

2、函数说明

system()会调用fork()产生子进程，由子进程来调用/bin/sh -c command来执行参数command字符串所代表的命令，此命令执行完后随即返回原调用的进程。

command命令执行完成后，system函数才会返回。--意味着system是阻塞的

在调用system()期间SIGCHLD 信号会被暂时搁置，SIGINT和SIGQUIT 信号则会被忽略。

3、源码浅析

libc各个版本源码连接如下：system.c - sysdeps/posix/system.c - Glibc source code (glibc-2.38) - Bootlin

这里为了分析方便，进行了简化，参考前辈的文章：
从Linux system()函数谈起 – 又见杜梨树

linux system 函数源代码分析-ShadowSrX-ChinaUnix博客

精简版本（不带对信号的处理）如下：

int system_without_sig(const char *cmdstring)    //version without signal handling
{
        pid_t pid;
        int status;
 
        if(cmdstring == NULL)
                return(1);
 
        if((pid = fork()) < 0){
                status = -1;        //probably out of process
        }
        else if(pid == 0){          //child
                execl("/bin/sh", "sh", "-c", cmdstring, (char*)0);
                _exit(127);         //execl error
        }
        else{
                while(waitpid(pid, &status, 0) < 0)
                        if(errno != EINTR){
                                status = -1;    //error other than EINTR from waitpid()
                                break;
                        }
        }
 
        return(status);
}

带信号处理的如下：

int system_with_sig(const char *cmdstring)      //with appropriate signal handling
{
        pid_t           pid;
        int             status;
        struct sigaction ignore, saveintr, savequit;
        sigset_t        chldmask, savemask;
 
        if(cmdstring == NULL)
                return(1);                      //always a command processor with UNIX
 
        ignore.sa_handler = SIG_IGN;            //ignore SIGINT and SIGQUIT
        sigemptyset(&ignore.sa_mask);
        ignore.sa_flags = 0;
        if(sigaction(SIGINT, &ignore, &saveintr) < 0)
                return(-1);
        if(sigaction(SIGQUIT, &ignore, &savequit) < 0)
                return(-1);
 
        sigemptyset(&chldmask);                 //now block SIGCHLD
        sigaddset(&chldmask, SIGCHLD);
        if(sigprocmask(SIG_BLOCK, &chldmask, &savemask) < 0)
                return (-1);
 
        if((pid = fork()) < 0){
                status = -1;                    //probably out of process
        }
        else if(pid == 0){                      //child
                //restore previous signal actions & reset signal mask
                sigaction(SIGINT, &saveintr, NULL);
                sigaction(SIGQUIT, &savequit, NULL);
                sigprocmask(SIG_SETMASK, &savemask, NULL);
 
                execl("/bin/sh", "sh", "-c", cmdstring, (char*)0);
                _exit(127);                     //exec error
        }
        else{                                   //parent
                while(waitpid(pid, &status, 0) < 0)
                        if(errno != EINTR){
                                status = -1;    //error other than EINTR from waitpid()
                                break;
                        }
        }
 
        //restore previous signal actions & reset signal mask
        if(sigaction(SIGINT, &saveintr, NULL) < 0)
                return(-1);
        if(sigaction(SIGQUIT, &savequit, NULL) < 0)
                return(-1);
        if(sigprocmask(SIG_SETMASK, &savemask, NULL) < 0)
                return(-1);
 
        return(status);
}

如上所示，system函数的实现主要调用了三个函数——fork()、execl()、waitpid()：

1. 首先，调用fork()函数去生成一个子进程；
2. 如果pid==0，说明子进程创建成功，子进程调用execl()函数去执行shell命令；
3. 如果pid>0（父进程），则父进程调用waitpid()函数阻塞等待子进程退出，并获取子进程退出的状态，存入status中。

note：

• 因为fork在两个进程：父进程和子进程中都返回，这里要检查返回的 pid，fork在子进程中返回0，在父进程中返回子进程的pid，父进程使用waitpid等待子进程结束，子进程则是调用execl来启动一个程序代替自己，execl("/bin/sh", "sh", "-c", cmdstring,(char*)0)是调用shell，这个shell的路径是/bin/sh，后面的字符串都是参数，然后子进程就变成了一个 shell进程，这个shell的参数是cmdstring，就是system接受的参数。
• waitpid方法是用于等待子进程结束的函数。当正常返回的时候，waitpid返回收集到的子进程的进程ID；如果设置了选项WNOHANG,而调用中waitpid发现没有已退出的子进程可收集，则返回0；如果调用中出错，则返回-1，这时errno会被设置成相应的值以指示错误所在，如果没有子进程或其它错误原因，则返回-1

4、返回值

1、先统一两个说法：

（1）system 返回值：指调用 system 函数后的返回值，比如上例中 status 为 system 返回值

（2）shell 返回值：指 system 所调用的命令的返回值

exec函数族-CSDN博客

linux进程（三）——如何终止进程？_linux 进程杀不掉 父进程为1-CSDN博客

通过system源码可以看出，返回值其实也就是status，来源于waitpid。那么只要搞懂了waitpid返回值的规则，就搞懂了system返回值的规则。

https://linux.die.net/man/2/waitpid

If status is not NULL, wait() and waitpid() store status information in the int to which it points. This integer can be inspected with the following macros (which take the integer itself as an argument, not a pointer to it, as is done in wait() and waitpid()!):

WIFEXITED(status)

returns true if the child terminated normally, that is, by calling exit(3) or _exit(2), or by returning from main().

WEXITSTATUS(status)

this macro evaluates to the low-order 8 bits of the status argument that the child process passed to _exit() or exit(), or the value the child process returned from main().

This macro should only be employed if WIFEXITED returned true.

system 函数对返回值的处理，涉及 3 个阶段：

阶段 1：创建子进程等准备工作。如果失败，返回 - 1。

阶段 2：调用 / bin/sh 拉起 shell 脚本，如果拉起失败或者 shell 未正常执行结束（参见备注 1），原因值被写入到 status 的低 8~15 比特位中。system 的 man 中只说明了会写了 127 这个值，但实测发现还会写 126 等值。

阶段 3：如果 shell 脚本正常执行结束，将 shell 返回值填到 status 的低 8~15 比特位中。

备注 1：

只要能够调用到 / bin/sh，并且执行 shell 过程中没有被其他信号异常中断，都算正常结束。
比如：不管 shell 脚本中返回什么原因值，是 0 还是非 0，都算正常执行结束。即使 shell 脚本不存在或没有执行权限，也都算正常执行结束；如果 shell 脚本执行过程中被强制 kill 掉等情况则算异常结束。

如何判断阶段 2 中，shell 脚本是否正常执行结束呢？系统提供了宏：WIFEXITED(status)。如果 WIFEXITED(status) 为真，则说明正常结束。

如何取得阶段 3 中的 shell 返回值？你可以直接通过右移 8bit 来实现，但安全的做法是使用系统提供的宏：WEXITSTATUS(status)。

5、对system函数的封装

由于我们一般在 shell 脚本中会通过返回值判断本脚本是否正常执行，如果成功返回 0，失败返回正数。所以综上，判断一个 system 函数调用 shell 脚本是否正常结束的方法应该是如下 3 个条件同时成立：

1. -1 != status
2. WIFEXITED(status) 为真
3. 0 == WEXITSTATUS(status)

注意：

根据以上分析，当 shell 脚本不存在、没有执行权限等场景下时，以上前 2 个条件仍会成立，此时 WEXITSTATUS(status) 为 127，126 等数值。

所以，我们在 shell 脚本中不能将 127，126 等数值定义为返回值，否则无法区分中是 shell 的返回值，还是调用 shell 脚本异常的原因值。shell 脚本中的返回值最好多 1 开始递增。

判断 shell 脚本正常执行结束的健全代码如下：

#include <stdio.h>
#include <stdlib.h>
#include <sys/wait.h>
#include <sys/types.h>
 
int main()
{
    pid_t status;
 
 
    status = system("./test.sh");
 
    if (-1 == status)
    {
        printf("system error!");
    }
    else
    {
        printf("exit status value = [0x%x]\n", status);
 
        if (WIFEXITED(status))
        {
            if (0 == WEXITSTATUS(status))
            {
                printf("run shell script successfully.\n");
            }
            else
            {
                printf("run shell script fail, script exit code: %d\n", WEXITSTATUS(status));
            }
        }
        else
        {
            printf("exit status = [%d]\n", WEXITSTATUS(status));
        }
    }
 
    return 0;
}

ref：

https://www.cnblogs.com/Rainingday/p/15070262.html

system(3) - Linux manual page

https://linux.die.net/man/3/system

宏伟精讲·linux system()函数完全解密 - 知乎

system函数的原理和调用方法_c++system函数原理-CSDN博客

linux system 函数源代码分析-ShadowSrX-ChinaUnix博客

system.c - sysdeps/posix/system.c - Glibc source code (glibc-2.38) - Bootlin

linux进程---exec族函数(execl, execlp, execle, execv, execvp, execvpe)-CSDN博客