1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
#' Gets the number of batchtools workers
#'
#' Tries to infer the total number of batchtools workers. This is
#' done using various ad hoc procedures based on code inspection
#' of batchtools itself.
#'
#' @param evaluator A future evaluator function.
#' If NULL (default), the current evaluator as returned
#' by [plan()] is used.
#'
#' @return A number in \eqn{[1, Inf]}.
#'
#' @importFrom future nbrOfWorkers
#' @export
#' @keywords internal
nbrOfWorkers.batchtools <- function(evaluator) {
## 1. Infer from 'workers' argument
expr <- formals(evaluator)$workers
workers <- eval(expr, enclos = baseenv())
if (!is.null(workers)) {
stop_if_not(length(workers) >= 1)
if (is.numeric(workers)) return(prod(workers))
if (is.character(workers)) return(length(workers))
stop("Invalid data type of 'workers': ", mode(workers))
}
## 2. Infer from 'cluster.functions' argument
expr <- formals(evaluator)$cluster.functions
cf <- eval(expr, enclos = baseenv())
if (!is.null(cf)) {
stop_if_not(inherits(cf, "ClusterFunctions"))
name <- cf$name
if (is.null(name)) name <- cf$Name
## Uni-process backends
if (name %in% c("Local", "Interactive")) return(1L)
## Cluster backends (with a scheduler queue)
if (name %in% c("TORQUE", "Slurm", "SGE", "OpenLava", "LSF")) {
return(availableHpcWorkers())
}
}
## If still not known, assume a generic HPC scheduler
availableHpcWorkers()
}
## Number of available workers in an HPC environment
##
## @return (numeric) A positive integer or `+Inf`.
availableHpcWorkers <- function() {
name <- "future.batchtools.workers"
value <- getOption(name, default = NULL)
if (!is.null(value)) {
if (!is.numeric(value) || length(value) != 1L ||
is.na(value) || value < 1.0) {
stop(sprintf(
"Option %s does not specify a value >= 1: %s",
sQuote(name), sQuote(value)
))
}
value <- floor(value)
return(value)
}
name <- "R_FUTURE_BATCHTOOLS_WORKERS"
value0 <- Sys.getenv(name, "")
if (nzchar(value0)) {
value <- as.numeric(value0)
if (is.na(value) || value < 1.0) {
stop(sprintf(
"Environment variable %s does not specify a value >= 1: %s",
sQuote(name), sQuote(value0)
))
}
value <- floor(value)
return(value)
}
## Assume an infinite number HPC queue slots
100
}
|
