-
Notifications
You must be signed in to change notification settings - Fork 1
/
runModel.go
469 lines (406 loc) · 12.9 KB
/
runModel.go
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
// Copyright (c) 2016 OpenM++
// This code is licensed under the MIT license (see LICENSE.txt for details)
package main
import (
"bufio"
"errors"
"io"
"os"
"os/exec"
"path/filepath"
"runtime"
"strings"
"text/template"
"time"
"github.com/openmpp/go/ompp/helper"
"github.com/openmpp/go/ompp/omppLog"
)
// runModel starts new model run and return run stamp.
// if run stamp not specified as input parameter then use unique timestamp.
// Model run console output redirected to log file: models/log/modelName.runStamp.console.log
func (rsc *RunCatalog) runModel(req *RunRequest) (*RunState, error) {
// make model process run stamp, if not specified then use timestamp by default
ts, dtNow := theCatalog.getNewTimeStamp()
rStamp := helper.CleanPath(req.RunStamp)
if rStamp == "" {
rStamp = ts
}
// new run state
rs := &RunState{
ModelName: req.ModelName,
ModelDigest: req.ModelDigest,
RunStamp: rStamp,
UpdateDateTime: helper.MakeDateTime(dtNow),
}
// set directories: work directory and bin model.exe directory
// if bin directory is relative then it must be relative to oms root directory
// re-base it to model work directory
binRoot, _ := theCatalog.getModelDir()
mb, ok := theCatalog.modelBasicByDigest(req.ModelDigest)
if !ok {
err := errors.New("Model not found: " + req.ModelName + ": " + req.ModelDigest)
omppLog.Log("Model run error: ", err)
rs.IsFinal = true
return rs, err // exit with error: model failed to start
}
binDir := mb.binDir
wDir := binDir
if req.Dir != "" {
wDir = filepath.Join(binRoot, req.Dir)
}
binDir, err := filepath.Rel(wDir, binDir)
if err != nil {
binDir = binRoot
}
// make file path for model console log output
if mb.isLogDir {
if mb.logDir == "" {
mb.logDir, mb.isLogDir = theCatalog.getModelLogDir()
}
}
if mb.isLogDir {
if mb.logDir == "" {
mb.logDir = binDir
}
rs.IsLog = mb.isLogDir
rs.LogFileName = rs.ModelName + "." + rStamp + ".console.log"
rs.logPath = filepath.Join(mb.logDir, rs.LogFileName)
}
// make model run command line arguments, starting from process run stamp and log options
mArgs := []string{}
mArgs = append(mArgs, "-OpenM.RunStamp", rStamp)
mArgs = append(mArgs, "-OpenM.LogToConsole", "true")
mArgs = append(mArgs, "-OpenM.LogToFile", "false")
importDbLc := strings.ToLower("-ImportDb.")
// append model run options from run request
for krq, val := range req.Opts {
if len(krq) < 1 { // skip empty run options
continue
}
// command line argument key starts with "-" ex: "-OpenM.Threads"
key := krq
if krq[0] != '-' {
key = "-" + krq
}
// save run name and task run name to return as part of run state
if strings.EqualFold(key, "-OpenM.RunName") {
rs.RunName = val
}
if strings.EqualFold(key, "-OpenM.TaskRunName") {
rs.TaskRunName = val
}
if strings.EqualFold(key, "-OpenM.LogToConsole") {
continue // skip log to console input run option: it is already on
}
if strings.EqualFold(key, "-OpenM.LogToFile") {
continue // skip log to file input run option: replaced by console output
}
if strings.EqualFold(key, "-OpenM.LogFilePath") {
continue // skip log file path input run option: replaced by console output
}
if strings.EqualFold(key, "-OpenM.Database") {
continue // database connection string not allowed as run option
}
if strings.HasPrefix(strings.ToLower(key), importDbLc) {
continue // import database connection string not allowed as run option
}
mArgs = append(mArgs, key, val) // append command line argument key and value
}
// if list of tables to retain is not empty then put the list into ini-file:
//
// [Tables]
// Retain = ageSexIncome,AdditionalTables
//
if len(req.Tables) > 0 {
p, e := filepath.Abs(filepath.Join(mb.logDir, rs.RunStamp+"."+mb.name+".ini"))
if e == nil {
e = os.WriteFile(p, []byte("[Tables]"+"\n"+"Retain = "+strings.Join(req.Tables, ", ")+"\n"), 0644)
}
if e != nil {
omppLog.Log("Model run error: ", e)
rs.IsFinal = true
return rs, e
}
mArgs = append(mArgs, "-ini", p) // append ini file path to command line arguments
}
// save run notes into the file(s) and append file path(s) to the model run options
for _, rn := range req.RunNotes {
if rn.Note == "" {
continue
}
if !rs.IsLog {
e := errors.New("Unable to save run notes: " + req.ModelName + ": " + req.ModelDigest)
omppLog.Log("Model run error: ", e)
rs.IsFinal = true
return rs, e
}
p, e := filepath.Abs(filepath.Join(mb.logDir, rs.RunStamp+".run_notes."+rn.LangCode+".md"))
if e == nil {
e = os.WriteFile(p, []byte(rn.Note), 0644)
}
if e != nil {
omppLog.Log("Model run error: ", e)
rs.IsFinal = true
return rs, e
}
mArgs = append(mArgs, "-"+rn.LangCode+".RunNotesPath", p) // append run notes file path to command line arguments
}
// assume model exe name is the same as model name
mExe := helper.CleanPath(req.ModelName)
cmd, err := rsc.makeCommand(mExe, binDir, wDir, mb.dbPath, mArgs, req)
if err != nil {
omppLog.Log("Error at starting model: ", err)
rs.IsFinal = true
return rs, errors.New("Error at starting model " + req.ModelName + ": " + err.Error())
}
// connect console output to log line array
outPipe, err := cmd.StdoutPipe()
if err != nil {
omppLog.Log("Error at starting model: ", err)
rs.IsFinal = true
return rs, errors.New("Error at starting model " + req.ModelName + ": " + err.Error())
}
errPipe, err := cmd.StderrPipe()
if err != nil {
omppLog.Log("Error at starting model: ", err)
rs.IsFinal = true
return rs, errors.New("Error at starting model " + req.ModelName + ": " + err.Error())
}
outDoneC := make(chan bool, 1)
errDoneC := make(chan bool, 1)
logTck := time.NewTicker(logTickTimeout * time.Millisecond)
// append console output to log lines array
doLog := func(digest, runStamp string, r io.Reader, done chan<- bool) {
sc := bufio.NewScanner(r)
for sc.Scan() {
rsc.updateRunState(digest, runStamp, false, sc.Text())
}
done <- true
close(done)
}
// run state initialized: save in run state list
rsc.createProcRunState(rs)
// start console output listners
go doLog(req.ModelDigest, rs.RunStamp, outPipe, outDoneC)
go doLog(req.ModelDigest, rs.RunStamp, errPipe, errDoneC)
// start the model
omppLog.Log("Run model: ", mExe, " in directory: ", wDir)
omppLog.Log(strings.Join(cmd.Args, " "))
err = cmd.Start()
if err != nil {
omppLog.Log("Model run error: ", err)
rsc.updateRunState(req.ModelDigest, rs.RunStamp, true, err.Error())
rs.IsFinal = true
return rs, err // exit with error: model failed to start
}
// else model started: wait until run completed
go func(digest, runStamp string, cmd *exec.Cmd) {
// wait until stdout and stderr closed
for outDoneC != nil || errDoneC != nil {
select {
case _, ok := <-outDoneC:
if !ok {
outDoneC = nil
}
case _, ok := <-errDoneC:
if !ok {
errDoneC = nil
}
case <-logTck.C:
}
}
// wait for model run to be completed
e := cmd.Wait()
if e != nil {
omppLog.Log(e)
rsc.updateRunState(digest, runStamp, true, e.Error())
return
}
// else: completed OK
rsc.updateRunState(digest, runStamp, true, "")
}(req.ModelDigest, rs.RunStamp, cmd)
return rs, nil
}
// makeCommand return command to run the model.
// If template file name specified then template processing results used to create command line.
// If this is MPI model run then tempalate is requred
// MPI run template can be model specific: "mpi.ModelName.template.txt" or default: "mpi.ModelRun.template.txt".
func (rsc *RunCatalog) makeCommand(mExe, binDir, workDir, dbPath string, mArgs []string, req *RunRequest) (*exec.Cmd, error) {
// check is it MPI model run, to run MPI model template is required
isMpi := req.Mpi.Np != 0
if isMpi && req.Template == "" {
// search for model-specific MPI template
mtn := "mpi." + req.ModelName + ".template.txt"
for _, tn := range theRunCatalog.mpiTemplates {
if tn == mtn {
req.Template = mtn
}
}
// if model-specific MPI template not found then use default MPI template to run the model
if req.Template == "" {
req.Template = defaultMpiTemplate
}
}
isTmpl := req.Template != ""
// if this is regular non-MPI model.exe run and no template:
// ./modelExe -OpenM.LogToFile true ...etc...
var cmd *exec.Cmd
if !isTmpl && !isMpi {
if binDir == "" || binDir == "." || binDir == "./" {
mExe = "./" + mExe
} else {
mExe = filepath.Join(binDir, mExe)
}
cmd = exec.Command(mExe, mArgs...)
}
// if template specified then process template to get exe name and arguments
if isTmpl {
// parse template
tmpl, err := template.ParseFiles(filepath.Join(rsc.etcDir, req.Template))
if err != nil {
return nil, err
}
// set template parameters
d := struct {
ModelName string // model name
ExeStem string // base part of model exe name, usually modelName
Dir string // work directory to run the model
BinDir string // bin directory where model.exe is located
DbPath string // absolute path to sqlite database file: models/bin/model.sqlite
MpiNp int // number of MPI processes
Args []string // model command line arguments
Env map[string]string // environment variables to run the model
}{
ModelName: req.ModelName,
ExeStem: mExe,
Dir: workDir,
BinDir: binDir,
DbPath: dbPath,
MpiNp: req.Mpi.Np,
Args: mArgs,
Env: req.Env,
}
// execute template and convert results in array of text lines
var b strings.Builder
err = tmpl.Execute(&b, d)
if err != nil {
return nil, err
}
tLines := strings.Split(strings.Replace(b.String(), "\r", "\n", -1), "\n")
// from template processing results get:
// exe name as first non-empty line
// use all other non-empty lines as command line arguments
cExe := ""
cArgs := []string{}
for k := range tLines {
cl := strings.TrimSpace(tLines[k])
if cl == "" {
continue
}
if cExe == "" {
cExe = cl
} else {
cArgs = append(cArgs, cl)
}
}
if cExe == "" {
return nil, errors.New("Error: empty template processing results, cannot run the model: " + req.ModelName)
}
// make command
cmd = exec.Command(cExe, cArgs...)
}
// if this is not MPI run then:
// set work directory
// append request environment variables to model environment
if !isMpi {
cmd.Dir = workDir
if len(req.Env) > 0 {
env := os.Environ()
for key, val := range req.Env {
if key != "" && val != "" {
env = append(env, key+"="+val)
}
}
cmd.Env = env
}
}
return cmd, nil
}
// add new model run state into run history
func (rsc *RunCatalog) createProcRunState(rs *RunState) {
if rs == nil {
return
}
rsc.rscLock.Lock()
defer rsc.rscLock.Unlock()
rsc.runLst.PushFront(
&runStateLog{
RunState: *rs,
logLineLst: make([]string, 0, 128),
})
for rsc.runLst.Len() > theCfg.runHistoryMaxSize { // remove old run state from history
rsc.runLst.Remove(rsc.runLst.Back())
}
// create log file or truncate existing
if rs.IsLog {
f, err := os.Create(rs.logPath)
if err != nil {
rs.IsLog = false
return
}
defer f.Close()
}
}
// updateRunState does model run state update and append to model log lines array
func (rsc *RunCatalog) updateRunState(digest, runStamp string, isFinal bool, msg string) {
if digest == "" || runStamp == "" {
return // model run undefined
}
dtNow := time.Now()
rsc.rscLock.Lock()
defer rsc.rscLock.Unlock()
// find model run state by digest and run stamp
// update model run state and append log message
var rs *runStateLog
var ok bool
for re := rsc.runLst.Front(); re != nil; re = re.Next() {
rs, ok = re.Value.(*runStateLog)
if !ok || rs == nil {
continue
}
ok = rs.ModelDigest == digest && rs.RunStamp == runStamp
if ok {
break
}
}
if !ok || rs == nil {
return // model run state not found
}
// run state found
// update run state and append new log line if not empty
rs.IsFinal = isFinal
rs.UpdateDateTime = helper.MakeDateTime(dtNow)
if msg != "" {
rs.logLineLst = append(rs.logLineLst, msg)
}
// write into model console log file
if rs.IsLog {
f, err := os.OpenFile(rs.logPath, os.O_APPEND|os.O_WRONLY, 0644)
if err != nil {
rs.IsLog = false
return
}
defer f.Close()
_, err = f.WriteString(msg)
if err == nil {
if runtime.GOOS == "windows" { // adjust newline for windows
_, err = f.WriteString("\r\n")
} else {
_, err = f.WriteString("\n")
}
}
if err != nil {
rs.IsLog = false
}
}
}