Go执行命令行操作

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Go执行命令行操作相关的知识,希望对你有一定的参考价值。

参考技术A go中提供了 os/exec 包使用 Command 函数可以完成一些调用命令行的操作。因为系统的不同,调用的参数会有点些不一样。

其他的创建执行都是一样的。

我们可以封装一个函数,输入需要执行的命令,输入返回结果

调用测试

如何避免 Go 命令行执行产生“孤儿”进程?

简介: 在 Go 程序当中,如果我们要执行命令时,通常会使用 exec.Command ,也比较好用,通常状况下,可以达到我们的目的,如果我们逻辑当中,需要终止这个进程,则可以快速使用 cmd.Process.Kill() 方法来结束进程。但当我们要执行的命令会启动其他子进程来操作的时候,会发生什么情况?

作者 | 昕希
来源 | 阿里技术公众号

在 Go 程序当中,如果我们要执行命令时,通常会使用 exec.Command ,也比较好用,通常状况下,可以达到我们的目的,如果我们逻辑当中,需要终止这个进程,则可以快速使用 cmd.Process.Kill() 方法来结束进程。但当我们要执行的命令会启动其他子进程来操作的时候,会发生什么情况?

一 孤儿进程的产生

测试小程序:

func kill(cmd *exec.Cmd) func() {
    return func() {
    if cmd != nil {
    cmd.Process.Kill()
    }
    }
}

func main() {
    cmd := exec.Command("/bin/bash", "-c", "watch top >top.log")
    time.AfterFunc(1*time.Second, kill(cmd))
    err := cmd.Run()
    fmt.Printf("pid=%d err=%s\\n", cmd.Process.Pid, err)
}

执行小程序:

go run main.go

pid=27326 err=signal: killed

查看进程信息:

ps -j

USER    PID  PPID  PGID   SESS JOBC STAT   TT       TIME COMMAND
king  24324     1 24303      0    0 S    s012    0:00.01 watch top

可以看到这个 "watch top" 的 PPID 为 1,说明这个进程已经变成了 “孤儿” 进程。

那为什么会这样,这并不符合我们预期,那么可以从 Go 的文档中找到答案:

二 通过进程组来解决掉所有子进程

在 linux 当中,是有会话、进程组和进程组的概念,并且 Go 也是使用 linux 的 kill(2) 方法来发送信号的,那么是否可以通过 kill 来将要结束进程的子进程都结束掉?

linux 的 kill(2) 的定义如下:

并在方法的描述中,可以看到如下内容:

如果 pid 为正数的时候,会给指定的 pid 发送 sig 信号,如果 pid 为负数的时候,会给这个进程组发送 sig 信号,那么我们可以通过进程组来将所有子进程退出掉?改一下 Go 程序中 kill 方法:

func kill(cmd *exec.Cmd) func() {
    return func() {
    if cmd != nil {
    // cmd.Process.Kill()
    syscall.Kill(-cmd.Process.Pid, syscall.SIGKILL)
    }
    }
}

func main() {
    cmd := exec.Command("/bin/bash", "-c", "watch top >top.log")
    time.AfterFunc(1*time.Second, kill(cmd))
    err := cmd.Run()
    fmt.Printf("pid=%d err=%s\\n", cmd.Process.Pid, err)
}

再次执行:

go run main.go

会发现程序卡住了,我们来看一下当前执行的进程:

ps -j

USER    PID  PPID  PGID   SESS JOBC STAT   TT       TIME COMMAND
king 27655 91597 27655      0    1 S+   s012    0:01.10 go run main.go
king 27672 27655 27655      0    1 S+   s012    0:00.03 ..../exe/main
king 27673 27672 27655      0    1 S+   s012    0:00.00 /bin/bash -c watch top >top.log
king 27674 27673 27655      0    1 S+   s012    0:00.01 watch top

可以看到我们 go run 产生了一个子进程 27672(command 那里是 go 执行的临时目录,比较长,因此添加了省略号),27672 产生了 27673(watch top >top.log)进程,27673 产生了 27674(watch top)进程。那为什么没有将这些子进程都关闭掉呢?

其实之类犯了一个低级错误,从上图中,我们可以看到他们的进程组 ID 为 27655,但是我们传递的是 cmd 的 id 即 27673,这个并不是进程组的 ID,因此程序并没有 kill,导致 cmd.Run() 一直在执行。

在 Linux 中,进程组中的第一个进程,被称为进程组 Leader,同时这个进程组的 ID 就是这个进程的 ID,从这个进程中创建的其他进程,都会继承这个进程的进程组和会话信息;从上面可以看出 go run main.go 程序 PID 和 PGID 同为 27655,那么这个进程就是进程组 Leader,我们不能 kill 这个进程组,除非想“自杀”,哈哈哈。

那么我们给要执行的进程,新建一个进程组,在 Kill 不就可以了嘛。在 linux 当中,通过 setpgid 方法来设置进程组 ID,定义如下:

如果将 pid 和 pgid 同时设置成 0,也就是 setpgid(0,0),则会使用当前进程为进程组 leader 并创建新的进程组。

那么在 Go 程序中,可以通过 cmd.SysProcAttr 来设置创建新的进程组,修改后的代码如下:

func kill(cmd *exec.Cmd) func() {
    return func() {
    if cmd != nil {
    // cmd.Process.Kill()
    syscall.Kill(-cmd.Process.Pid, syscall.SIGKILL)
    }
    }
}

func main() {
    cmd := exec.Command("/bin/bash", "-c", "watch top >top.log")
  cmd.SysProcAttr = &syscall.SysProcAttr{
    Setpgid: true,
    }
    
    time.AfterFunc(1*time.Second, kill(cmd))
    err := cmd.Run()
    fmt.Printf("pid=%d err=%s\\n", cmd.Process.Pid, err)
}

再次执行:

go run main.go

pid=29397 err=signal: killed

再次查看进程:

ps -j

USER    PID  PPID  PGID   SESS JOBC STAT   TT       TIME COMMAND

发现 watch 的进程都不存在了,那我们在看看是否还会有孤儿进程:

# 由于我测试的环境是mac,因此这个脚本只能在mac执行
ps -j | head -1;ps -j | awk '{if ($3 ==1 && $1 !="root"){print $0}}' | head

USER    PID  PPID  PGID   SESS JOBC STAT   TT       TIME COMMAND

已经没有孤儿进程了,问题至此已经完全解决。

三 子进程监听父进程是否退出(只能在 linux 下执行)

假设要调用的程序也是我们自己写的其他应用程序,那么可以使用 Linux 的 prctl 方法来处理, prctl 方法的定义如下:

这个方法有一个重要的 option:PR_SET_PDEATHSIG,通过这个来接收父进程的退出。

让我们来再次构造一个有问题的程序。

有两个文件,分别为 main.go 和 child.go 文件,main.go 会调用 child.go 文件。

main.go 文件:

package main

import (
        "os/exec"
)

func main() {
        cmd := exec.Command("./child")
        cmd.Run()
}

child.go 文件:

package main

import (
    "fmt"
    "time"
)

func main() {
    for {
    time.Sleep(200 * time.Millisecond)
    fmt.Println(time.Now())
    }
}

在 Linux 环境中分别编译这两个文件:

// 编译 main.go 生成 main 二进制文件
go build -o main main.go

// 编译 child.go 生成 child 二进制文件
go build -o child child.go

执行 main 二进制文件:

./main &

查看他们的进程:

ps -ef

UID        PID  PPID  C STIME TTY          TIME CMD
root         1     0  0 06:05 pts/0    00:00:00 /bin/bash
root     11514     1  0 12:12 pts/0    00:00:00 ./main
root     11520 11514  0 12:12 pts/0    00:00:00 ./child

可以看到 main 和 child 的进程,child 是 main 的子进程,我们将 main 进程 kill 掉,在查看进程状态:

kill -9 11514

ps -ef

UID        PID  PPID  C STIME TTY          TIME CMD
root         1     0  0 06:05 pts/0    00:00:00 /bin/bash
root     11520     1  0 12:12 pts/0    00:00:00 ./child

我们可以看到 child 的进程,他的 PPID 已经变成了 1,说明这个进程已经变成了孤儿进程。

那接下来我们可以使用 PR_SET_PDEATHSIG 来保证父进程退出,子进程也退出,大致方式有两种:使用 CGO 调用和使用 syscall.RawSyscall 来调用。

1 使用 CGO

将 child 修改成如下内容:

程序中,使用 CGO,为了简单的展示,在 Go 文件中编写了 C 的 killTest 方法,并调用了 prctl 方法,然后在 Go 程序中调用 killTest 方法,让我们重新编译执行一下,再看看进程:

go build -o child child.go
./main & 
ps -ef 

UID        PID  PPID  C STIME TTY          TIME CMD
root         1     0  0 06:05 pts/0    00:00:00 /bin/bash
root     11663     1  0 12:28 pts/0    00:00:00 ./main
root     11669 11663  0 12:28 pts/0    00:00:00 ./child

再次 kill 掉 main,并查看进程:

kill -9 11663
ps -ef

UID        PID  PPID  C STIME TTY          TIME CMD
root         1     0  0 06:05 pts/0    00:00:00 /bin/bash

可以看到 child 的进程也已经退出了,说明 CGO 调用的 prctl 生效了。

2 syscall.RawSyscall 方法

也可以采用 Go 中提供的 syscall.RawSyscall 方法来替代调用 CGO,在 Go 的文档中,可以查看到 syscall 包中定义的常量(查看 linux,如果是本地 godoc,需要指定 GOOS=linux),可以看到我们要用的几个常量以及他们对应的数值:

// 其他内容省略掉了
const(
    ....
    PR_SET_PDEATHSIG                 = 0x1
    ....
)

const(     
    .....
    SYS_PRCTL                  = 157
    .....
)

其中 PR_SET_PDEATHSIG 操作的值为 1,SYS_PRCTL 的值为 157,那么将 child.go 修改成如下内容:

package main

import (
    "fmt"
    "os"
    "syscall"
    "time"
)

func main() {
    _, _, errno := syscall.RawSyscall(uintptr(syscall.SYS_PRCTL), uintptr(syscall.PR_SET_PDEATHSIG), uintptr(syscall.SIGKILL), 0)
    if errno != 0 {
    os.Exit(int(errno))
    }

    for {
    time.Sleep(200 * time.Millisecond)
    fmt.Println(time.Now())
    }
}

再次编译并执行:

go build -o child child.go
./main & 
ps -ef

UID        PID  PPID  C STIME TTY          TIME CMD
root         1     0  0 06:05 pts/0    00:00:00 /bin/bash
root     12208     1  0 12:46 pts/0    00:00:00 ./main
root     12214 12208  0 12:46 pts/0    00:00:00 ./child

将 main 进程结束掉:

kill -9 12208
ps -ef

UID        PID  PPID  C STIME TTY          TIME CMD
root         1     0  0 06:05 pts/0    00:00:00 /bin/bash

child 进程已经退出了,也达成了最终效果。

四 总结

当我们使用 Go 程序执行其他程序的时候,如果其他程序也开启了其他进程,那么在 kill 的时候可能会把这些进程变成孤儿进程,一直执行并滞留在内存中。当然,如果我们程序非法退出,或者被 kill 调用,也会导致我们执行的进程变成孤儿进程,那么为了解决这个问题,从两个思路来解决:

  • 给要执行的程序创建新的进程组,并调用 syscall.Kill,传递负值 pid 来关闭这个进程组中所有的进程(比较完美的解决方法)。
  • 如果要调用的程序也是我们自己编写的,那么可以使用 PR_SET_PDEATHSIG 来感知父进程退出,那么这种方式需要调用 Linxu 的 prctrl,可以使用 CGO 的方式,也可以使用 syscall.RawSyscall 的方式。

但不管使用哪种方式,都只是提供了一种思路,在我们编写服务端服务程序的时候,需要特殊关注,防止孤儿进程消耗服务器资源。

原文链接
本文为阿里云原创内容,未经允许不得转载。

以上是关于Go执行命令行操作的主要内容,如果未能解决你的问题,请参考以下文章

译Go语言命令行执行路径的安全性

Go 执行命令行并实时打印输出

Go语言命令行参数

Go语言命令行参数

Go常用命令

Go常用命令