Container request priority flag.
[lightning.git] / vcf2fasta.go
1 package main
2
3 import (
4         "bytes"
5         "compress/gzip"
6         "errors"
7         "flag"
8         "fmt"
9         "io"
10         "io/ioutil"
11         "net/http"
12         _ "net/http/pprof"
13         "os"
14         "os/exec"
15         "path/filepath"
16         "runtime"
17         "sync"
18
19         "git.arvados.org/arvados.git/sdk/go/arvados"
20         log "github.com/sirupsen/logrus"
21 )
22
23 type vcf2fasta struct {
24         refFile           string
25         mask              bool
26         gvcfRegionsPy     string
27         gvcfRegionsPyData []byte
28         projectUUID       string
29         outputDir         string
30         runLocal          bool
31         vcpus             int
32 }
33
34 func (cmd *vcf2fasta) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
35         var err error
36         defer func() {
37                 if err != nil {
38                         fmt.Fprintf(stderr, "%s\n", err)
39                 }
40         }()
41         flags := flag.NewFlagSet("", flag.ContinueOnError)
42         flags.SetOutput(stderr)
43         flags.StringVar(&cmd.refFile, "ref", "", "reference fasta `file`")
44         flags.BoolVar(&cmd.mask, "mask", false, "mask uncalled regions (default: output hom ref)")
45         flags.StringVar(&cmd.gvcfRegionsPy, "gvcf-regions.py", "https://raw.githubusercontent.com/lijiayong/gvcf_regions/master/gvcf_regions.py", "source of gvcf_regions.py")
46         flags.StringVar(&cmd.projectUUID, "project", "", "project `UUID` for containers and output data")
47         flags.StringVar(&cmd.outputDir, "output-dir", "", "output directory")
48         flags.IntVar(&cmd.vcpus, "vcpus", 0, "number of VCPUs to request for arvados container (default: 2*number of input files, max 32)")
49         flags.BoolVar(&cmd.runLocal, "local", false, "run on local host (default: run in an arvados container)")
50         priority := flags.Int("priority", 500, "container request priority")
51         pprof := flags.String("pprof", "", "serve Go profile data at http://`[addr]:port`")
52         err = flags.Parse(args)
53         if err == flag.ErrHelp {
54                 err = nil
55                 return 0
56         } else if err != nil {
57                 return 2
58         } else if cmd.refFile == "" {
59                 err = errors.New("reference data (-ref) not specified")
60                 return 2
61         } else if flags.NArg() == 0 {
62                 flags.Usage()
63                 return 2
64         }
65
66         if *pprof != "" {
67                 go func() {
68                         log.Println(http.ListenAndServe(*pprof, nil))
69                 }()
70         }
71
72         if !cmd.runLocal {
73                 if cmd.outputDir != "" {
74                         err = errors.New("cannot specify output dir in non-local mode")
75                         return 2
76                 }
77                 if cmd.vcpus < 1 {
78                         var infiles []string
79                         infiles, err = listInputFiles(flags.Args())
80                         if err != nil {
81                                 return 1
82                         }
83                         if cmd.vcpus = len(infiles) * 2; cmd.vcpus > 32 {
84                                 cmd.vcpus = 32
85                         }
86                 }
87                 runner := arvadosContainerRunner{
88                         Name:        "lightning vcf2fasta",
89                         Client:      arvados.NewClientFromEnv(),
90                         ProjectUUID: cmd.projectUUID,
91                         RAM:         2<<30 + int64(cmd.vcpus)<<28,
92                         VCPUs:       cmd.vcpus,
93                         Priority:    *priority,
94                 }
95                 err = runner.TranslatePaths(&cmd.refFile)
96                 if err != nil {
97                         return 1
98                 }
99                 inputs := flags.Args()
100                 for i := range inputs {
101                         err = runner.TranslatePaths(&inputs[i])
102                         if err != nil {
103                                 return 1
104                         }
105                 }
106                 runner.Args = append([]string{"vcf2fasta", "-local=true", "-ref", cmd.refFile, fmt.Sprintf("-mask=%v", cmd.mask), "-gvcf-regions.py", cmd.gvcfRegionsPy, "-output-dir", "/mnt/output"}, inputs...)
107                 var output string
108                 output, err = runner.Run()
109                 if err != nil {
110                         return 1
111                 }
112                 fmt.Fprintln(stdout, output)
113                 return 0
114         }
115
116         if cmd.mask {
117                 var resp *http.Response
118                 resp, err = http.Get(cmd.gvcfRegionsPy)
119                 if err != nil {
120                         return 1
121                 }
122                 if resp.StatusCode != http.StatusOK {
123                         err = fmt.Errorf("get %q: http status %d", cmd.gvcfRegionsPy, resp.StatusCode)
124                         return 1
125                 }
126                 cmd.gvcfRegionsPyData, err = ioutil.ReadAll(resp.Body)
127                 if err != nil {
128                         err = fmt.Errorf("get %q: read body: %s", cmd.gvcfRegionsPy, err)
129                         return 1
130                 }
131         }
132
133         infiles, err := listInputFiles(flags.Args())
134         if err != nil {
135                 return 1
136         }
137
138         type job struct {
139                 vcffile string
140                 phase   int
141         }
142         todo := make(chan job)
143         go func() {
144                 for _, infile := range infiles {
145                         for phase := 1; phase <= 2; phase++ {
146                                 todo <- job{vcffile: infile, phase: phase}
147                         }
148                 }
149                 close(todo)
150         }()
151
152         done := make(chan error, runtime.NumCPU()*2)
153         var wg sync.WaitGroup
154         for i := 0; i < runtime.NumCPU(); i++ {
155                 wg.Add(1)
156                 go func() {
157                         defer wg.Done()
158                         for job := range todo {
159                                 if len(done) > 0 {
160                                         // a different worker encountered an error
161                                         return
162                                 }
163                                 err := cmd.vcf2fasta(job.vcffile, job.phase)
164                                 if err != nil {
165                                         done <- fmt.Errorf("%s phase %d: %s", job.vcffile, job.phase, err)
166                                         return
167                                 }
168                         }
169                 }()
170         }
171         go func() {
172                 wg.Wait()
173                 close(done)
174         }()
175
176         err = <-done
177         if err != nil {
178                 return 1
179         }
180         return 0
181 }
182
183 func maybeInDocker(args, mountfiles []string) []string {
184         if out, err := exec.Command("docker", "image", "ls", "-q", "lightning-runtime").Output(); err != nil || len(out) == 0 {
185                 return args
186         }
187         dockerrun := []string{
188                 "docker", "run", "--rm",
189                 "--log-driver=none",
190         }
191         for _, f := range mountfiles {
192                 dockerrun = append(dockerrun, "--volume="+f+":"+f+":ro")
193         }
194         dockerrun = append(dockerrun, "lightning-runtime")
195         dockerrun = append(dockerrun, args...)
196         return dockerrun
197 }
198
199 func (cmd *vcf2fasta) vcf2fasta(infile string, phase int) error {
200         _, basename := filepath.Split(infile)
201         outfile := filepath.Join(cmd.outputDir, fmt.Sprintf("%s.%d.fasta.gz", basename, phase))
202         outf, err := os.OpenFile(outfile, os.O_CREATE|os.O_WRONLY|os.O_EXCL, 0777)
203         if err != nil {
204                 return fmt.Errorf("error opening output file: %s", err)
205         }
206         defer outf.Close()
207         gzipw := gzip.NewWriter(outf)
208         defer gzipw.Close()
209
210         var maskfile *os.File // reading side of a pipe if we're running bedtools, otherwise nil
211
212         var wg sync.WaitGroup
213         errs := make(chan error, 3)
214         if cmd.mask {
215                 bedr, bedw, err := os.Pipe()
216                 if err != nil {
217                         return err
218                 }
219                 bedargs := []string{"python", "-", "--gvcf_type", "gatk", infile}
220                 bed := exec.Command(bedargs[0], bedargs[1:]...)
221                 bed.Stdin = bytes.NewBuffer(cmd.gvcfRegionsPyData)
222                 bed.Stdout = bedw
223                 wg.Add(1)
224                 go func() {
225                         defer wg.Done()
226                         errs <- bed.Run()
227                 }()
228
229                 bedcompr, bedcompw, err := os.Pipe()
230                 if err != nil {
231                         return err
232                 }
233                 bedcompargs := []string{"bedtools", "complement", "-i", "/dev/stdin", "-g", cmd.refFile}
234                 bedcompargs = maybeInDocker(bedcompargs, []string{cmd.refFile, infile})
235                 bedcomp := exec.Command(bedcompargs[0], bedcompargs[1:]...)
236                 bedcomp.Stdin = bedr
237                 bedcomp.Stdout = bedcompw
238                 wg.Add(1)
239                 go func() {
240                         defer wg.Done()
241                         errs <- bedcomp.Run()
242                 }()
243                 maskfile = bedcompr
244         }
245
246         consargs := []string{"bcftools", "consensus", "--fasta-ref", cmd.refFile, "-H", fmt.Sprint(phase)}
247         if maskfile != nil {
248                 consargs = append(consargs, "--mask", "/dev/fd/3")
249         }
250         consargs = append(consargs, infile)
251         indexsuffix := ".tbi"
252         if _, err := os.Stat(infile + ".csi"); err == nil {
253                 indexsuffix = ".csi"
254         }
255         consargs = maybeInDocker(consargs, []string{infile, infile + indexsuffix, cmd.refFile})
256
257         consensus := exec.Command(consargs[0], consargs[1:]...)
258         consensus.Stderr = os.Stderr
259         consensus.Stdout = gzipw
260         if maskfile != nil {
261                 consensus.ExtraFiles = []*os.File{maskfile}
262         }
263         err = consensus.Start()
264         if err != nil {
265                 return err
266         }
267         err = consensus.Wait()
268         if err != nil {
269                 return err
270         }
271         err = gzipw.Close()
272         if err != nil {
273                 return err
274         }
275         err = outf.Close()
276         if err != nil {
277                 return err
278         }
279         return nil
280 }