BiopetCommandLineFunctionTrait.scala 8.79 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/**
 * Biopet is built on top of GATK Queue for building bioinformatic
 * pipelines. It is mainly intended to support LUMC SHARK cluster which is running
 * SGE. But other types of HPC that are supported by GATK Queue (such as PBS)
 * should also be able to execute Biopet tools and pipelines.
 *
 * Copyright 2014 Sequencing Analysis Support Core - Leiden University Medical Center
 *
 * Contact us at: sasc@lumc.nl
 *
 * A dual licensing mode is applied. The source code within this project that are
 * not part of GATK Queue is freely available for non-commercial use under an AGPL
 * license; For commercial users or users who do not want to follow the AGPL
 * license, please contact us to obtain a separate license.
 */
16
17
18
package nl.lumc.sasc.biopet.core

import java.io.File
Peter van 't Hof's avatar
Peter van 't Hof committed
19
import nl.lumc.sasc.biopet.core.config.Configurable
Peter van 't Hof's avatar
Peter van 't Hof committed
20
21
import org.broadinstitute.gatk.queue.QException
import org.broadinstitute.gatk.queue.function.CommandLineFunction
22
23
import org.broadinstitute.gatk.utils.commandline.{ Input, Argument }
import scala.sys.process.{ Process, ProcessLogger }
24
import scala.util.matching.Regex
25
26
import java.io.FileInputStream
import java.security.MessageDigest
27

Peter van 't Hof's avatar
Peter van 't Hof committed
28
/** Biopet command line trait to auto check executable and cluster values */
29
trait BiopetCommandLineFunctionTrait extends CommandLineFunction with Configurable {
Peter van 't Hof's avatar
Peter van 't Hof committed
30
  analysisName = configName
bow's avatar
bow committed
31
32

  @Input(doc = "deps", required = false)
33
  var deps: List[File] = Nil
bow's avatar
bow committed
34

35
36
  var threads = 0
  val defaultThreads = 1
bow's avatar
bow committed
37

38
  var vmem: Option[String] = config("vmem")
Peter van 't Hof's avatar
Peter van 't Hof committed
39
  protected val defaultCoreMemory: Double = 1.0
40
  var vmemFactor: Double = config("vmem_factor", default = 1.5)
Peter van 't Hof's avatar
Peter van 't Hof committed
41

Peter van 't Hof's avatar
Peter van 't Hof committed
42
  var residentFactor: Double = config("resident_factor", default = 1.2)
43
44

  private var coreMemory: Double = _
Peter van 't Hof's avatar
Peter van 't Hof committed
45

Peter van 't Hof's avatar
Peter van 't Hof committed
46
  var executable: String = _
bow's avatar
bow committed
47

Peter van 't Hof's avatar
Peter van 't Hof committed
48
49
50
51
  /**
   * Can override this method. This is executed just before the job is ready to run.
   * Can check on run time files from pipeline here
   */
Peter van 't Hof's avatar
Peter van 't Hof committed
52
  protected[core] def beforeCmd {}
Peter van 't Hof's avatar
Peter van 't Hof committed
53

Peter van 't Hof's avatar
Peter van 't Hof committed
54
  /** Can override this method. This is executed after the script is done en queue starts to generate the graph */
55
  protected[core] def beforeGraph {}
Peter van 't Hof's avatar
Peter van 't Hof committed
56

Peter van 't Hof's avatar
Peter van 't Hof committed
57
  /** Set default output file, threads and vmem for current job */
58
  override def freezeFieldValues() {
59
    preProcesExecutable
60
    beforeGraph
61
    if (jobOutputFile == null) jobOutputFile = new File(firstOutput.getAbsoluteFile.getParent, "." + firstOutput.getName + "." + configName + ".out")
bow's avatar
bow committed
62

63
64
    if (threads == 0) threads = getThreads(defaultThreads)
    if (threads > 1) nCoresRequest = Option(threads)
bow's avatar
bow committed
65

66
67
68
69
70
    coreMemory = config("core_memory", default = defaultCoreMemory).asDouble + (0.5 * retry)

    if (config.contains("memory_limit")) memoryLimit = config("memory_limit")
    else memoryLimit = Some(coreMemory * threads)

Peter van 't Hof's avatar
Peter van 't Hof committed
71
    if (config.contains("resident_limit")) residentLimit = config("resident_limit")
Peter van 't Hof's avatar
Peter van 't Hof committed
72
    else residentLimit = Some((coreMemory + (0.5 * retry)) * residentFactor)
73

74
    if (!config.contains("vmem")) vmem = Some((coreMemory * (vmemFactor + (0.5 * retry))) + "G")
Peter van 't Hof's avatar
Peter van 't Hof committed
75
    if (vmem.isDefined) jobResourceRequests :+= "h_vmem=" + vmem.get
76
    jobName = configName + ":" + (if (firstOutput != null) firstOutput.getName else jobOutputFile)
bow's avatar
bow committed
77

78
79
    super.freezeFieldValues()
  }
bow's avatar
bow committed
80

81
82
  var retry = 0

Peter van 't Hof's avatar
Peter van 't Hof committed
83
84
  override def setupRetry(): Unit = {
    super.setupRetry()
85
    if (vmem.isDefined) jobResourceRequests = jobResourceRequests.filterNot(_.contains("h_vmem="))
86
    logger.info("Auto raise memory on retry")
87
88
    retry += 1
    this.freeze()
Peter van 't Hof's avatar
Peter van 't Hof committed
89
90
  }

91
92
93
  /** can override this value is executable may not be converted to CanonicalPath */
  val executableToCanonicalPath = true

Peter van 't Hof's avatar
Peter van 't Hof committed
94
95
96
  /**
   * Checks executable. Follow full CanonicalPath, checks if it is existing and do a md5sum on it to store in job report
   */
97
  protected[core] def preProcesExecutable {
98
99
100
101
102
103
104
105
106
107
    if (!BiopetCommandLineFunctionTrait.executableMd5Cache.contains(executable)) {
      try if (executable != null) {
        if (!BiopetCommandLineFunctionTrait.executableCache.contains(executable)) {
          val oldExecutable = executable
          val buffer = new StringBuffer()
          val cmd = Seq("which", executable)
          val process = Process(cmd).run(ProcessLogger(buffer.append(_)))
          if (process.exitValue == 0) {
            executable = buffer.toString
            val file = new File(executable)
108
109
            if (executableToCanonicalPath) executable = file.getCanonicalPath
            else executable = file.getAbsolutePath
110
          } else {
111
            BiopetQScript.addError("executable: '" + executable + "' not found, please check config")
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
          }
          BiopetCommandLineFunctionTrait.executableCache += oldExecutable -> executable
          BiopetCommandLineFunctionTrait.executableCache += executable -> executable
        } else {
          executable = BiopetCommandLineFunctionTrait.executableCache(executable)
        }

        if (!BiopetCommandLineFunctionTrait.executableMd5Cache.contains(executable)) {
          val is = new FileInputStream(executable)
          val cnt = is.available
          val bytes = Array.ofDim[Byte](cnt)
          is.read(bytes)
          is.close()
          val temp = MessageDigest.getInstance("MD5").digest(bytes).map("%02X".format(_)).mkString.toLowerCase
          BiopetCommandLineFunctionTrait.executableMd5Cache += executable -> temp
        }
      } catch {
        case ioe: java.io.IOException => logger.warn("Could not use 'which', check on executable skipped: " + ioe)
130
131
      }
    }
132
133
    val md5 = BiopetCommandLineFunctionTrait.executableMd5Cache.get(executable)
    addJobReportBinding("md5sum_exe", md5.getOrElse("None"))
134
  }
bow's avatar
bow committed
135

Peter van 't Hof's avatar
Peter van 't Hof committed
136
  /** executes checkExecutable method and fill job report */
137
  final protected def preCmdInternal {
138
    preProcesExecutable
bow's avatar
bow committed
139

140
    beforeCmd
bow's avatar
bow committed
141

Peter van 't Hof's avatar
Peter van 't Hof committed
142
143
    addJobReportBinding("cores", nCoresRequest match {
      case Some(n) if n > 0 => n
144
      case _                => 1
Peter van 't Hof's avatar
Peter van 't Hof committed
145
    })
146
    addJobReportBinding("version", getVersion)
147
  }
bow's avatar
bow committed
148

Peter van 't Hof's avatar
Peter van 't Hof committed
149
  /** Command to get version of executable */
150
  protected def versionCommand: String = null
Peter van 't Hof's avatar
Peter van 't Hof committed
151
152

  /** Regex to get version from version command output */
153
  protected val versionRegex: Regex = null
Peter van 't Hof's avatar
Peter van 't Hof committed
154
155
156
157
158

  /** Allowed exit codes for the version command */
  protected val versionExitcode = List(0)

  /** Executes the version command */
159
160
  private def getVersionInternal: Option[String] = {
    if (versionCommand == null || versionRegex == null) return None
161
    val exe = new File(versionCommand.trim.split(" ")(0))
162
    if (!exe.exists()) return None
163
164
    val stdout = new StringBuffer()
    val stderr = new StringBuffer()
165
166
167
168
    def outputLog = "Version command: \n" + versionCommand +
      "\n output log: \n stdout: \n" + stdout.toString +
      "\n stderr: \n" + stderr.toString
    val process = Process(versionCommand).run(ProcessLogger(stdout append _ + "\n", stderr append _ + "\n"))
169
    if (!versionExitcode.contains(process.exitValue)) {
170
      logger.warn("getVersion give exit code " + process.exitValue + ", version not found \n" + outputLog)
171
      return None
172
    }
173
    for (line <- stdout.toString.split("\n") ++ stderr.toString.split("\n")) {
bow's avatar
bow committed
174
      line match {
175
        case versionRegex(m) => return Some(m)
Peter van 't Hof's avatar
Peter van 't Hof committed
176
        case _               =>
177
178
      }
    }
179
    logger.warn("getVersion give a exit code " + process.exitValue + " but no version was found, executable correct? \n" + outputLog)
180
    return None
181
  }
bow's avatar
bow committed
182

Peter van 't Hof's avatar
Peter van 't Hof committed
183
  /** Get version from cache otherwise execute the version command  */
184
  def getVersion: Option[String] = {
Peter van 't Hof's avatar
Peter van 't Hof committed
185
    if (!BiopetCommandLineFunctionTrait.executableCache.contains(executable))
186
      preProcesExecutable
187
188
189
190
191
192
    if (!BiopetCommandLineFunctionTrait.versionCache.contains(versionCommand))
      getVersionInternal match {
        case Some(version) => BiopetCommandLineFunctionTrait.versionCache += versionCommand -> version
        case _             =>
      }
    BiopetCommandLineFunctionTrait.versionCache.get(versionCommand)
Peter van 't Hof's avatar
Peter van 't Hof committed
193
194
  }

Peter van 't Hof's avatar
Peter van 't Hof committed
195
196
197
198
199
  /**
   * Get threads from config
   * @param default default when not found in config
   * @return number of threads
   */
bow's avatar
bow committed
200
201
202
  def getThreads(default: Int): Int = {
    val maxThreads: Int = config("maxthreads", default = 8)
    val threads: Int = config("threads", default = default)
203
204
205
    if (maxThreads > threads) return threads
    else return maxThreads
  }
bow's avatar
bow committed
206

Peter van 't Hof's avatar
Peter van 't Hof committed
207
208
209
210
211
212
  /**
   * Get threads from config
   * @param default default when not found in config
   * @param module Module when this is difrent from default
   * @return number of threads
   */
bow's avatar
bow committed
213
214
215
  def getThreads(default: Int, module: String): Int = {
    val maxThreads: Int = config("maxthreads", default = 8, submodule = module)
    val threads: Int = config("threads", default = default, submodule = module)
216
217
218
219
    if (maxThreads > threads) return threads
    else return maxThreads
  }
}
Peter van 't Hof's avatar
Peter van 't Hof committed
220

Peter van 't Hof's avatar
Peter van 't Hof committed
221
/** stores global caches */
Peter van 't Hof's avatar
Peter van 't Hof committed
222
223
224
object BiopetCommandLineFunctionTrait {
  import scala.collection.mutable.Map
  private val versionCache: Map[String, String] = Map()
225
  private[core] val executableMd5Cache: Map[String, String] = Map()
226
  private val executableCache: Map[String, String] = Map()
227
}