OILS / core / shell.py View on Github | oils.pub

1225 lines, 785 significant
1"""
2core/shell.py -- Entry point for the shell interpreter.
3"""
4from __future__ import print_function
5
6from errno import ENOENT
7import time as time_
8
9from _devbuild.gen import arg_types
10from _devbuild.gen.option_asdl import option_i, builtin_i
11from _devbuild.gen.syntax_asdl import (loc, source, source_t, IntParamBox,
12 debug_frame, debug_frame_t)
13from _devbuild.gen.value_asdl import (value, value_e, value_t, value_str, Obj)
14from core import alloc
15from core import comp_ui
16from core import dev
17from core import error
18from core import executor
19from core import completion
20from core import main_loop
21from core import optview
22from core import process
23from core import pyutil
24from core import sh_init
25from core import state
26from display import ui
27from core import util
28from core import vm
29
30from frontend import args
31from frontend import flag_def # side effect: flags are defined!
32
33unused1 = flag_def
34from frontend import flag_util
35from frontend import reader
36from frontend import parse_lib
37
38from builtin import assign_osh
39from builtin import bracket_osh
40from builtin import completion_osh
41from builtin import completion_ysh
42from builtin import dirs_osh
43from builtin import error_ysh
44from builtin import hay_ysh
45from builtin import io_osh
46from builtin import io_ysh
47from builtin import json_ysh
48from builtin import meta_oils
49from builtin import misc_osh
50from builtin import module_ysh
51from builtin import printf_osh
52from builtin import process_osh
53from builtin import pure_osh
54from builtin import pure_ysh
55from builtin import readline_osh
56from builtin import read_osh
57from builtin import trap_osh
58
59from builtin import func_eggex
60from builtin import func_hay
61from builtin import func_misc
62from builtin import func_reflect
63
64from builtin import method_dict
65from builtin import method_io
66from builtin import method_list
67from builtin import method_other
68from builtin import method_str
69from builtin import method_type
70
71from osh import cmd_eval
72from osh import glob_
73from osh import history
74from osh import prompt
75from osh import sh_expr_eval
76from osh import split
77from osh import word_eval
78
79from mycpp import iolib
80from mycpp import mops
81from mycpp import mylib
82from mycpp.mylib import NewDict, print_stderr, log
83from pylib import os_path
84from tools import deps
85from tools import fmt
86from tools import ysh_ify
87from ysh import expr_eval
88
89unused2 = log
90
91import libc
92import posix_ as posix
93
94from typing import List, Dict, Optional, TYPE_CHECKING
95if TYPE_CHECKING:
96 from frontend.py_readline import Readline
97
98if mylib.PYTHON:
99 try:
100 from _devbuild.gen import help_meta # type: ignore
101 except ImportError:
102 help_meta = None
103
104
105def _InitDefaultCompletions(cmd_ev, complete_builtin, comp_lookup):
106 # type: (cmd_eval.CommandEvaluator, completion_osh.Complete, completion.Lookup) -> None
107
108 # register builtins and words
109 complete_builtin.Run(cmd_eval.MakeBuiltinArgv(['-E', '-A', 'command']))
110 # register path completion
111 # Add -o filenames? Or should that be automatic?
112 complete_builtin.Run(cmd_eval.MakeBuiltinArgv(['-D', '-A', 'file']))
113
114
115def _CompletionDemo(comp_lookup):
116 # type: (completion.Lookup) -> None
117
118 # Something for fun, to show off. Also: test that you don't repeatedly hit
119 # the file system / network / coprocess.
120 A1 = completion.TestAction(['foo.py', 'foo', 'bar.py'], 0.0)
121 l = [] # type: List[str]
122 for i in xrange(0, 5):
123 l.append('m%d' % i)
124
125 A2 = completion.TestAction(l, 0.1)
126 C1 = completion.UserSpec([A1, A2], [], [], completion.DefaultPredicate(),
127 '', '')
128 comp_lookup.RegisterName('slowc', {}, C1)
129
130
131def SourceStartupFile(
132 fd_state, # type: process.FdState
133 rc_path, # type: str
134 lang, # type: str
135 parse_ctx, # type: parse_lib.ParseContext
136 cmd_ev, # type: cmd_eval.CommandEvaluator
137 errfmt, # type: ui.ErrorFormatter
138):
139 # type: (...) -> None
140
141 # Right now this is called when the shell is interactive. (Maybe it should
142 # be called on login_shel too.)
143 #
144 # Terms:
145 # - interactive shell: Roughly speaking, no args or -c, and isatty() is true
146 # for stdin and stdout.
147 # - login shell: Started from the top level, e.g. from init or ssh.
148 #
149 # We're not going to copy everything bash does because it's too complex, but
150 # for reference:
151 # https://www.gnu.org/software/bash/manual/bash.html#Bash-Startup-Files
152 # Bash also has --login.
153
154 try:
155 f = fd_state.Open(rc_path)
156 except (IOError, OSError) as e:
157 # TODO: Could warn about nonexistent explicit --rcfile?
158 if e.errno != ENOENT:
159 raise # Goes to top level. Handle this better?
160 return
161
162 arena = parse_ctx.arena
163 rc_line_reader = reader.FileLineReader(f, arena)
164 rc_c_parser = parse_ctx.MakeOshParser(rc_line_reader)
165
166 with alloc.ctx_SourceCode(arena, source.MainFile(rc_path)):
167 # TODO: handle status, e.g. 2 for ParseError
168 unused = main_loop.Batch(cmd_ev, rc_c_parser, errfmt)
169
170 f.close()
171
172
173class ShellOptHook(state.OptHook):
174
175 def __init__(self, readline):
176 # type: (Optional[Readline]) -> None
177 self.readline = readline
178
179 def OnChange(self, opt0_array, opt_name, b):
180 # type: (List[bool], str, bool) -> bool
181 """This method is called whenever an option is changed.
182
183 Returns success or failure.
184 """
185 if opt_name == 'vi' or opt_name == 'emacs':
186 # TODO: Replace with a hook? Just like setting LANG= can have a hook.
187 if self.readline:
188 self.readline.parse_and_bind("set editing-mode " + opt_name)
189 else:
190 print_stderr(
191 "Warning: Can't set option %r because shell wasn't compiled with GNU readline"
192 % opt_name)
193 return False
194
195 # Invert: they are mutually exclusive!
196 if opt_name == 'vi':
197 opt0_array[option_i.emacs] = not b
198 elif opt_name == 'emacs':
199 opt0_array[option_i.vi] = not b
200
201 return True
202
203
204def _AddBuiltinFunc(mem, name, func):
205 # type: (state.Mem, str, vm._Callable) -> None
206 assert isinstance(func, vm._Callable), func
207 mem.AddBuiltin(name, value.BuiltinFunc(func))
208
209
210def InitAssignmentBuiltins(
211 mem, # type: state.Mem
212 procs, # type: state.Procs
213 exec_opts, # type: optview.Exec
214 errfmt, # type: ui.ErrorFormatter
215):
216 # type: (...) -> Dict[int, vm._AssignBuiltin]
217
218 assign_b = {} # type: Dict[int, vm._AssignBuiltin]
219
220 new_var = assign_osh.NewVar(mem, procs, exec_opts, errfmt)
221 assign_b[builtin_i.declare] = new_var
222 assign_b[builtin_i.typeset] = new_var
223 assign_b[builtin_i.local] = new_var
224
225 assign_b[builtin_i.export_] = assign_osh.Export(mem, errfmt)
226 assign_b[builtin_i.readonly] = assign_osh.Readonly(mem, errfmt)
227
228 return assign_b
229
230
231def Main(
232 lang, # type: str
233 arg_r, # type: args.Reader
234 environ, # type: Dict[str, str]
235 login_shell, # type: bool
236 loader, # type: pyutil._ResourceLoader
237 readline, # type: Optional[Readline]
238):
239 # type: (...) -> int
240 """The full shell lifecycle. Used by bin/osh and bin/ysh.
241
242 Args:
243 lang: 'osh' or 'ysh'
244 login_shell: Was - on argv[0]?
245 loader: to get help, version, grammar, etc.
246 readline: optional GNU readline
247 """
248 # Differences between osh and ysh:
249 # - oshrc vs yshrc
250 # - shopt -s ysh:all
251 # - Prompt
252 # - --help
253
254 argv0 = arg_r.Peek()
255 assert argv0 is not None
256 arg_r.Next()
257
258 assert lang in ('osh', 'ysh'), lang
259
260 try:
261 attrs = flag_util.ParseMore('main', arg_r)
262 except error.Usage as e:
263 print_stderr('%s usage error: %s' % (lang, e.msg))
264 return 2
265 flag = arg_types.main(attrs.attrs)
266
267 arena = alloc.Arena()
268 errfmt = ui.ErrorFormatter()
269
270 if flag.help:
271 util.HelpFlag(loader, '%s-usage' % lang, mylib.Stdout())
272 return 0
273 if flag.version:
274 util.VersionFlag(loader, mylib.Stdout())
275 return 0
276
277 if flag.tool == 'cat-em':
278 paths = arg_r.Rest()
279
280 status = 0
281 for p in paths:
282 try:
283 contents = loader.Get(p)
284 print(contents)
285 except (OSError, IOError):
286 print_stderr("cat-em: %r not found" % p)
287 status = 1
288 return status
289
290 debug_stack = [] # type: List[debug_frame_t]
291 if arg_r.AtEnd(): # -c input, or stdin
292 dollar0 = argv0
293 else:
294 dollar0 = arg_r.Peek() # the script name
295
296 frame0 = debug_frame.Main(dollar0)
297 debug_stack.append(frame0)
298
299 #log('STACK %s', debug_stack)
300
301 script_name = arg_r.Peek() # type: Optional[str]
302 arg_r.Next()
303
304 env_dict = NewDict() # type: Dict[str, value_t]
305 defaults = NewDict() # type: Dict[str, value_t]
306 mem = state.Mem(dollar0,
307 arg_r.Rest(),
308 arena,
309 debug_stack,
310 env_dict,
311 defaults=defaults)
312
313 opt_hook = ShellOptHook(readline)
314 # Note: only MutableOpts needs mem, so it's not a true circular dep.
315 parse_opts, exec_opts, mutable_opts = state.MakeOpts(
316 mem, environ, opt_hook)
317 mem.exec_opts = exec_opts # circular dep
318 mutable_opts.Init()
319
320 # Set these BEFORE processing flags, so they can be overridden.
321 if lang == 'ysh':
322 mutable_opts.SetAnyOption('ysh:all', True)
323
324 pure_osh.SetOptionsFromFlags(mutable_opts, attrs.opt_changes,
325 attrs.shopt_changes)
326
327 version_str = pyutil.GetVersion(loader)
328 sh_init.InitBuiltins(mem, version_str, defaults)
329 sh_init.InitDefaultVars(mem)
330
331 sh_init.CopyVarsFromEnv(exec_opts, environ, mem)
332
333 # PATH PWD SHELLOPTS, etc. must be set after CopyVarsFromEnv()
334 sh_init.InitVarsAfterEnv(mem)
335
336 if attrs.show_options: # special case: sh -o
337 pure_osh.ShowOptions(mutable_opts, [])
338 return 0
339
340 # feedback between runtime and parser
341 aliases = NewDict() # type: Dict[str, str]
342
343 ysh_grammar = pyutil.LoadYshGrammar(loader)
344
345 if flag.do_lossless and not exec_opts.noexec():
346 raise error.Usage('--one-pass-parse requires noexec (-n)', loc.Missing)
347
348 # Tools always use one pass parse
349 # Note: osh --tool syntax-tree is like osh -n --one-pass-parse
350 do_lossless = True if len(flag.tool) else flag.do_lossless
351
352 parse_ctx = parse_lib.ParseContext(arena,
353 parse_opts,
354 aliases,
355 ysh_grammar,
356 do_lossless=do_lossless)
357
358 # Three ParseContext instances SHARE aliases.
359 comp_arena = alloc.Arena()
360 comp_arena.PushSource(source.Unused('completion'))
361 trail1 = parse_lib.Trail()
362 # do_lossless needs to be turned on to complete inside backticks. TODO:
363 # fix the issue where ` gets erased because it's not part of
364 # set_completer_delims().
365 comp_ctx = parse_lib.ParseContext(comp_arena,
366 parse_opts,
367 aliases,
368 ysh_grammar,
369 do_lossless=True)
370 comp_ctx.Init_Trail(trail1)
371
372 hist_arena = alloc.Arena()
373 hist_arena.PushSource(source.Unused('history'))
374 trail2 = parse_lib.Trail()
375 hist_ctx = parse_lib.ParseContext(hist_arena, parse_opts, aliases,
376 ysh_grammar)
377 hist_ctx.Init_Trail(trail2)
378
379 # Deps helps manages dependencies. These dependencies are circular:
380 # - cmd_ev and word_ev, arith_ev -- for command sub, arith sub
381 # - arith_ev and word_ev -- for $(( ${a} )) and $x$(( 1 ))
382 # - cmd_ev and builtins (which execute code, like eval)
383 # - prompt_ev needs word_ev for $PS1, which needs prompt_ev for @P
384 cmd_deps = cmd_eval.Deps()
385 cmd_deps.mutable_opts = mutable_opts
386
387 job_control = process.JobControl()
388 job_list = process.JobList()
389 fd_state = process.FdState(errfmt, job_control, job_list, mem, None, None,
390 exec_opts)
391
392 my_pid = posix.getpid()
393
394 debug_path = ''
395 debug_dir = environ.get('OILS_DEBUG_DIR')
396 if flag.debug_file is not None:
397 # --debug-file takes precedence over OSH_DEBUG_DIR
398 debug_path = flag.debug_file
399 elif debug_dir is not None:
400 debug_path = os_path.join(debug_dir, '%d-osh.log' % my_pid)
401
402 if len(debug_path):
403 # This will be created as an empty file if it doesn't exist, or it could be
404 # a pipe.
405 try:
406 debug_f = util.DebugFile(
407 fd_state.OpenForWrite(debug_path)) # type: util._DebugFile
408 except (IOError, OSError) as e:
409 print_stderr("%s: Couldn't open %r: %s" %
410 (lang, debug_path, posix.strerror(e.errno)))
411 return 2
412 else:
413 debug_f = util.NullDebugFile()
414
415 if flag.xtrace_to_debug_file:
416 trace_f = debug_f
417 else:
418 trace_f = util.DebugFile(mylib.Stderr())
419
420 trace_dir = environ.get('OILS_TRACE_DIR', '')
421 dumps = environ.get('OILS_TRACE_DUMPS', '')
422 streams = environ.get('OILS_TRACE_STREAMS', '')
423 multi_trace = dev.MultiTracer(my_pid, trace_dir, dumps, streams, fd_state)
424
425 tracer = dev.Tracer(parse_ctx, exec_opts, mutable_opts, mem, trace_f,
426 multi_trace)
427 fd_state.tracer = tracer # circular dep
428
429 signal_safe = iolib.InitSignalSafe()
430 trap_state = trap_osh.TrapState(signal_safe)
431
432 waiter = process.Waiter(job_list, exec_opts, signal_safe, tracer)
433 fd_state.waiter = waiter
434
435 cmd_deps.debug_f = debug_f
436
437 now = time_.time()
438 iso_stamp = time_.strftime("%Y-%m-%d %H:%M:%S", time_.localtime(now))
439
440 argv_buf = mylib.BufWriter()
441 dev.PrintShellArgv(arg_r.argv, argv_buf)
442
443 debug_f.writeln('%s [%d] Oils started with argv %s' %
444 (iso_stamp, my_pid, argv_buf.getvalue()))
445 if len(debug_path):
446 debug_f.writeln('Writing logs to %r' % debug_path)
447
448 interp = environ.get('OILS_HIJACK_SHEBANG', '')
449 search_path = executor.SearchPath(mem, exec_opts)
450 ext_prog = process.ExternalProgram(interp, fd_state, errfmt, debug_f)
451
452 splitter = split.SplitContext(mem)
453 # TODO: This is instantiation is duplicated in osh/word_eval.py
454 globber = glob_.Globber(exec_opts)
455
456 # This could just be OILS_TRACE_DUMPS='crash:argv0'
457 crash_dump_dir = environ.get('OILS_CRASH_DUMP_DIR', '')
458 cmd_deps.dumper = dev.CrashDumper(crash_dump_dir, fd_state)
459
460 comp_lookup = completion.Lookup()
461
462 # Various Global State objects to work around readline interfaces
463 compopt_state = completion.OptionState()
464
465 comp_ui_state = comp_ui.State()
466 prompt_state = comp_ui.PromptState()
467
468 # The login program is supposed to set $HOME
469 # https://superuser.com/questions/271925/where-is-the-home-environment-variable-set
470 # state.InitMem(mem) must happen first
471 tilde_ev = word_eval.TildeEvaluator(mem, exec_opts)
472 home_dir = tilde_ev.GetMyHomeDir()
473 if home_dir is None:
474 # TODO: print errno from getpwuid()
475 print_stderr("%s: Failed to get home dir from $HOME or getpwuid()" %
476 lang)
477 return 1
478
479 sh_files = sh_init.ShellFiles(lang, home_dir, mem, flag)
480
481 #
482 # Executor and Evaluators (are circularly dependent)
483 #
484
485 # Global proc namespace. Funcs are defined in the common variable
486 # namespace.
487 procs = state.Procs(mem) # type: state.Procs
488
489 builtins = {} # type: Dict[int, vm._Builtin]
490
491 # e.g. s.startswith()
492 methods = {} # type: Dict[int, Dict[str, vm._Callable]]
493
494 hay_state = hay_ysh.HayState()
495
496 shell_ex = executor.ShellExecutor(mem, exec_opts, mutable_opts, procs,
497 hay_state, builtins, search_path,
498 ext_prog, waiter, tracer, job_control,
499 job_list, fd_state, trap_state, errfmt)
500
501 arith_ev = sh_expr_eval.ArithEvaluator(mem, exec_opts, mutable_opts,
502 parse_ctx, errfmt)
503 bool_ev = sh_expr_eval.BoolEvaluator(mem, exec_opts, mutable_opts,
504 parse_ctx, errfmt)
505 expr_ev = expr_eval.ExprEvaluator(mem, mutable_opts, methods, splitter,
506 errfmt)
507 word_ev = word_eval.NormalWordEvaluator(mem, exec_opts, mutable_opts,
508 tilde_ev, splitter, errfmt)
509
510 assign_b = InitAssignmentBuiltins(mem, procs, exec_opts, errfmt)
511 cmd_ev = cmd_eval.CommandEvaluator(mem, exec_opts, errfmt, procs, assign_b,
512 arena, cmd_deps, trap_state,
513 signal_safe)
514
515 # PromptEvaluator rendering is needed in non-interactive shells for @P.
516 prompt_ev = prompt.Evaluator(lang, version_str, parse_ctx, mem)
517
518 io_methods = NewDict() # type: Dict[str, value_t]
519 io_methods['promptVal'] = value.BuiltinFunc(method_io.PromptVal(prompt_ev))
520
521 # The M/ prefix means it's io->eval()
522 io_methods['M/eval'] = value.BuiltinFunc(
523 method_io.Eval(mem, cmd_ev, method_io.EVAL_NULL))
524 io_methods['M/evalToDict'] = value.BuiltinFunc(
525 method_io.Eval(mem, cmd_ev, method_io.EVAL_DICT))
526 io_methods['M/evalInFrame'] = value.BuiltinFunc(
527 method_io.EvalInFrame(mem, cmd_ev))
528 io_methods['M/evalExpr'] = value.BuiltinFunc(method_io.EvalExpr(expr_ev))
529
530 # Identical to command sub
531 io_methods['captureStdout'] = value.BuiltinFunc(
532 method_io.CaptureStdout(mem, shell_ex))
533
534 # TODO:
535 io_methods['time'] = value.BuiltinFunc(method_io.Time())
536 io_methods['strftime'] = value.BuiltinFunc(method_io.Strftime())
537 io_methods['glob'] = value.BuiltinFunc(method_io.Glob())
538
539 io_props = {'stdin': value.Stdin} # type: Dict[str, value_t]
540 io_obj = Obj(Obj(None, io_methods), io_props)
541
542 vm_methods = NewDict() # type: Dict[str, value_t]
543 # These are methods, not free functions, because they reflect VM state
544 vm_methods['getFrame'] = value.BuiltinFunc(func_reflect.GetFrame(mem))
545 vm_methods['getDebugStack'] = value.BuiltinFunc(
546 func_reflect.GetDebugStack(mem))
547 vm_methods['id'] = value.BuiltinFunc(func_reflect.Id())
548
549 vm_props = NewDict() # type: Dict[str, value_t]
550 vm_obj = Obj(Obj(None, vm_methods), vm_props)
551
552 # Add basic type objects for flag parser
553 # flag -v --verbose (Bool, help='foo')
554 #
555 # TODO:
556 # - Add other types like Dict, CommandFlag
557 # - Obj(first, rest)
558 # - List() Dict() Obj() can do shallow copy with __call__
559
560 # - type(x) should return these Obj, or perhaps typeObj(x)
561 # - __str__ method for echo $[type(x)] ?
562
563 # TODO: List and Dict could be the only ones with __index__?
564 i_func = method_type.Index__()
565 type_m = NewDict() # type: Dict[str, value_t]
566 type_m['__index__'] = value.BuiltinFunc(i_func)
567 type_obj_methods = Obj(None, type_m)
568
569 # Note: Func[Int -> Int] is something we should do?
570 for tag in [
571 value_e.Bool,
572 value_e.Int,
573 value_e.Float,
574 value_e.Str,
575 value_e.List,
576 value_e.Dict,
577 ]:
578 type_name = value_str(tag, dot=False)
579 #log('%s %s' , type_name, tag)
580 type_obj = Obj(type_obj_methods, {'name': value.Str(type_name)})
581 mem.AddBuiltin(type_name, type_obj)
582
583 # Initialize Obj
584 tag = value_e.Obj
585 type_name = value_str(tag, dot=False)
586
587 # TODO: change Obj.new to __call__
588 type_props = NewDict() # type: Dict[str, value_t]
589 type_props['name'] = value.Str(type_name)
590 type_props['new'] = value.BuiltinFunc(func_misc.Obj_call())
591 type_obj = Obj(type_obj_methods, type_props)
592
593 mem.AddBuiltin(type_name, type_obj)
594
595 # Wire up circular dependencies.
596 vm.InitCircularDeps(arith_ev, bool_ev, expr_ev, word_ev, cmd_ev, shell_ex,
597 prompt_ev, io_obj, tracer)
598
599 unsafe_arith = sh_expr_eval.UnsafeArith(mem, exec_opts, mutable_opts,
600 parse_ctx, arith_ev, errfmt)
601 vm.InitUnsafeArith(mem, word_ev, unsafe_arith)
602
603 #
604 # Initialize Built-in Procs
605 #
606
607 b = builtins # short alias for initialization
608
609 if mylib.PYTHON:
610 if help_meta:
611 help_data = help_meta.TopicMetadata()
612 else:
613 help_data = NewDict() # minimal build
614 else:
615 help_data = help_meta.TopicMetadata()
616 b[builtin_i.help] = misc_osh.Help(lang, loader, help_data, errfmt)
617
618 # Interpreter state
619 b[builtin_i.set] = pure_osh.Set(mutable_opts, mem)
620 b[builtin_i.shopt] = pure_osh.Shopt(exec_opts, mutable_opts, cmd_ev, mem,
621 environ)
622
623 b[builtin_i.hash] = pure_osh.Hash(search_path) # not really pure
624 b[builtin_i.trap] = trap_osh.Trap(trap_state, parse_ctx, tracer, errfmt)
625
626 b[builtin_i.shvar] = pure_ysh.Shvar(mem, search_path, cmd_ev)
627 b[builtin_i.ctx] = pure_ysh.Ctx(mem, cmd_ev)
628 b[builtin_i.push_registers] = pure_ysh.PushRegisters(mem, cmd_ev)
629
630 # Hay
631 b[builtin_i.hay] = hay_ysh.Hay(hay_state, mutable_opts, mem, cmd_ev)
632 b[builtin_i.haynode] = hay_ysh.HayNode_(hay_state, mem, cmd_ev)
633
634 # Interpreter introspection
635 b[builtin_i.type] = meta_oils.Type(procs, aliases, search_path, errfmt)
636 b[builtin_i.builtin] = meta_oils.Builtin(shell_ex, errfmt)
637 b[builtin_i.command] = meta_oils.Command(shell_ex, procs, aliases,
638 search_path)
639 # Part of YSH, but similar to builtin/command
640 b[builtin_i.runproc] = meta_oils.RunProc(shell_ex, procs, errfmt)
641 b[builtin_i.invoke] = meta_oils.Invoke(shell_ex, procs, errfmt)
642 b[builtin_i.extern_] = meta_oils.Extern(shell_ex, procs, errfmt)
643
644 # Meta builtins
645 module_invoke = module_ysh.ModuleInvoke(cmd_ev, tracer, errfmt)
646 b[builtin_i.use] = meta_oils.ShellFile(parse_ctx,
647 search_path,
648 cmd_ev,
649 fd_state,
650 tracer,
651 errfmt,
652 loader,
653 module_invoke=module_invoke)
654 source_builtin = meta_oils.ShellFile(parse_ctx, search_path, cmd_ev,
655 fd_state, tracer, errfmt, loader)
656 b[builtin_i.source] = source_builtin
657 b[builtin_i.dot] = source_builtin
658 b[builtin_i.eval] = meta_oils.Eval(parse_ctx, exec_opts, cmd_ev, tracer,
659 errfmt, mem)
660
661 # Module builtins
662 guards = NewDict() # type: Dict[str, bool]
663 b[builtin_i.source_guard] = module_ysh.SourceGuard(guards, exec_opts,
664 errfmt)
665 b[builtin_i.is_main] = module_ysh.IsMain(mem)
666
667 # Errors
668 b[builtin_i.error] = error_ysh.Error()
669 b[builtin_i.failed] = error_ysh.Failed(mem)
670 b[builtin_i.boolstatus] = error_ysh.BoolStatus(shell_ex, errfmt)
671 b[builtin_i.try_] = error_ysh.Try(mutable_opts, mem, cmd_ev, shell_ex,
672 errfmt)
673 b[builtin_i.assert_] = error_ysh.Assert(expr_ev, errfmt)
674
675 # Pure builtins
676 true_ = pure_osh.Boolean(0)
677 b[builtin_i.colon] = true_ # a "special" builtin
678 b[builtin_i.true_] = true_
679 b[builtin_i.false_] = pure_osh.Boolean(1)
680
681 b[builtin_i.alias] = pure_osh.Alias(aliases, errfmt)
682 b[builtin_i.unalias] = pure_osh.UnAlias(aliases, errfmt)
683
684 b[builtin_i.getopts] = pure_osh.GetOpts(mem, errfmt)
685
686 b[builtin_i.shift] = assign_osh.Shift(mem)
687 b[builtin_i.unset] = assign_osh.Unset(mem, procs, unsafe_arith, errfmt)
688
689 b[builtin_i.append] = pure_ysh.Append(mem, errfmt)
690
691 # test / [ differ by need_right_bracket
692 b[builtin_i.test] = bracket_osh.Test(False, exec_opts, mem, errfmt)
693 b[builtin_i.bracket] = bracket_osh.Test(True, exec_opts, mem, errfmt)
694
695 # Output
696 b[builtin_i.echo] = io_osh.Echo(exec_opts)
697 b[builtin_i.printf] = printf_osh.Printf(mem, parse_ctx, unsafe_arith,
698 errfmt)
699 b[builtin_i.write] = io_ysh.Write(mem, errfmt)
700 redir_builtin = io_ysh.RunBlock(mem, cmd_ev) # used only for redirects
701 b[builtin_i.redir] = redir_builtin
702 b[builtin_i.fopen] = redir_builtin # alias for backward compatibility
703
704 # (pp output format isn't stable)
705 b[builtin_i.pp] = io_ysh.Pp(expr_ev, mem, errfmt, procs, arena)
706
707 # Input
708 b[builtin_i.cat] = io_osh.Cat() # for $(<file)
709 b[builtin_i.read] = read_osh.Read(splitter, mem, parse_ctx, cmd_ev, errfmt)
710
711 mapfile = io_osh.MapFile(mem, errfmt, cmd_ev)
712 b[builtin_i.mapfile] = mapfile
713 b[builtin_i.readarray] = mapfile
714
715 # Dirs
716 dir_stack = dirs_osh.DirStack()
717 b[builtin_i.cd] = dirs_osh.Cd(mem, dir_stack, cmd_ev, errfmt)
718 b[builtin_i.pushd] = dirs_osh.Pushd(mem, dir_stack, errfmt)
719 b[builtin_i.popd] = dirs_osh.Popd(mem, dir_stack, errfmt)
720 b[builtin_i.dirs] = dirs_osh.Dirs(mem, dir_stack, errfmt)
721 b[builtin_i.pwd] = dirs_osh.Pwd(mem, errfmt)
722
723 b[builtin_i.times] = misc_osh.Times()
724
725 b[builtin_i.json] = json_ysh.Json(mem, errfmt, False)
726 b[builtin_i.json8] = json_ysh.Json(mem, errfmt, True)
727
728 ### Process builtins
729 b[builtin_i.exec_] = process_osh.Exec(mem, ext_prog, fd_state, search_path,
730 errfmt)
731 b[builtin_i.umask] = process_osh.Umask()
732 b[builtin_i.ulimit] = process_osh.Ulimit()
733 b[builtin_i.wait] = process_osh.Wait(waiter, job_list, mem, tracer, errfmt)
734
735 b[builtin_i.jobs] = process_osh.Jobs(job_list)
736 b[builtin_i.fg] = process_osh.Fg(job_control, job_list, waiter)
737 b[builtin_i.bg] = process_osh.Bg(job_list)
738
739 # Could be in process_ysh
740 b[builtin_i.fork] = process_osh.Fork(shell_ex)
741 b[builtin_i.forkwait] = process_osh.ForkWait(shell_ex)
742
743 # Interactive builtins depend on readline
744 b[builtin_i.bind] = readline_osh.Bind(readline, errfmt)
745 b[builtin_i.history] = readline_osh.History(readline, sh_files, errfmt,
746 mylib.Stdout())
747
748 # Completion
749 spec_builder = completion_osh.SpecBuilder(cmd_ev, parse_ctx, word_ev,
750 splitter, comp_lookup, help_data,
751 errfmt)
752 complete_builtin = completion_osh.Complete(spec_builder, comp_lookup)
753 b[builtin_i.complete] = complete_builtin
754 b[builtin_i.compgen] = completion_osh.CompGen(spec_builder)
755 b[builtin_i.compopt] = completion_osh.CompOpt(compopt_state, errfmt)
756 b[builtin_i.compadjust] = completion_osh.CompAdjust(mem)
757
758 comp_ev = word_eval.CompletionWordEvaluator(mem, exec_opts, mutable_opts,
759 tilde_ev, splitter, errfmt)
760
761 comp_ev.arith_ev = arith_ev
762 comp_ev.expr_ev = expr_ev
763 comp_ev.prompt_ev = prompt_ev
764 comp_ev.CheckCircularDeps()
765
766 root_comp = completion.RootCompleter(comp_ev, mem, comp_lookup,
767 compopt_state, comp_ui_state,
768 comp_ctx, debug_f)
769 b[builtin_i.compexport] = completion_ysh.CompExport(root_comp)
770
771 #
772 # Initialize Builtin-in Methods
773 #
774
775 methods[value_e.Str] = {
776 'startsWith': method_str.HasAffix(method_str.START),
777 'endsWith': method_str.HasAffix(method_str.END),
778 'trim': method_str.Trim(method_str.START | method_str.END),
779 'trimStart': method_str.Trim(method_str.START),
780 'trimEnd': method_str.Trim(method_str.END),
781 'upper': method_str.Upper(),
782 'lower': method_str.Lower(),
783 'split': method_str.Split(),
784
785 # finds a substring, optional position to start at
786 'find': None,
787
788 # replace substring, OR an eggex
789 # takes count=3, the max number of replacements to do.
790 'replace': method_str.Replace(mem, expr_ev),
791
792 # Like Python's re.search, except we put it on the string object
793 # It's more consistent with Str->find(substring, pos=0)
794 # It returns value.Match() rather than an integer
795 'search': method_str.SearchMatch(method_str.SEARCH),
796
797 # like Python's re.match()
798 'leftMatch': method_str.SearchMatch(method_str.LEFT_MATCH),
799
800 # like Python's re.fullmatch(), not sure if we really need it
801 'fullMatch': None,
802 }
803 methods[value_e.Dict] = {
804 # keys() values() get() are FREE functions, not methods
805 # I think items() isn't as necessary because dicts are ordered? YSH
806 # code shouldn't use the List of Lists representation.
807 'M/erase': method_dict.Erase(),
808 # could be d->tally() or d->increment(), but inc() is short
809 #
810 # call d->inc('mycounter')
811 # call d->inc('mycounter', 3)
812 'M/inc': None,
813
814 # call d->accum('mygroup', 'value')
815 'M/accum': None,
816
817 # DEPRECATED - use free functions
818 'get': method_dict.Get(),
819 'keys': method_dict.Keys(),
820 'values': method_dict.Values(),
821 }
822 methods[value_e.List] = {
823 'M/reverse': method_list.Reverse(),
824 'M/append': method_list.Append(),
825 'M/clear': method_list.Clear(),
826 'M/extend': method_list.Extend(),
827 'M/pop': method_list.Pop(),
828 'M/insert': None, # insert object before index
829 'M/remove': None, # insert object before index
830 'indexOf': method_list.IndexOf(), # return first index of value, or -1
831 # Python list() has index(), which raises ValueError
832 # But this is consistent with Str->find(), and doesn't
833 # use exceptions
834 'lastIndexOf': method_list.LastIndexOf(),
835 'join': func_misc.Join(), # both a method and a func
836 }
837
838 methods[value_e.Match] = {
839 'group': func_eggex.MatchMethod(func_eggex.G, expr_ev),
840 'start': func_eggex.MatchMethod(func_eggex.S, None),
841 'end': func_eggex.MatchMethod(func_eggex.E, None),
842 }
843
844 methods[value_e.Place] = {
845 # __mut_setValue()
846
847 # instead of setplace keyword
848 'M/setValue': method_other.SetValue(mem),
849 }
850
851 methods[value_e.CommandFrag] = {
852 # var x = ^(echo hi)
853 # Export source code and line number
854 # Useful for test frameworks and so forth
855 'export': None,
856 }
857
858 #
859 # Initialize Built-in Funcs
860 #
861
862 parse_hay = func_hay.ParseHay(fd_state, parse_ctx, mem, errfmt)
863 eval_hay = func_hay.EvalHay(hay_state, mutable_opts, mem, cmd_ev)
864 hay_func = func_hay.HayFunc(hay_state)
865
866 _AddBuiltinFunc(mem, 'parseHay', parse_hay)
867 _AddBuiltinFunc(mem, 'evalHay', eval_hay)
868 _AddBuiltinFunc(mem, '_hay', hay_func)
869
870 _AddBuiltinFunc(mem, 'len', func_misc.Len())
871 _AddBuiltinFunc(mem, 'type', func_misc.Type())
872
873 g = func_eggex.MatchFunc(func_eggex.G, expr_ev, mem)
874 _AddBuiltinFunc(mem, '_group', g)
875 _AddBuiltinFunc(mem, '_match',
876 g) # TODO: remove this backward compat alias
877 _AddBuiltinFunc(mem, '_start',
878 func_eggex.MatchFunc(func_eggex.S, None, mem))
879 _AddBuiltinFunc(mem, '_end', func_eggex.MatchFunc(func_eggex.E, None, mem))
880
881 # TODO: should this be parseCommandStr() vs. parseFile() for Hay?
882 _AddBuiltinFunc(mem, 'parseCommand',
883 func_reflect.ParseCommand(parse_ctx, mem, errfmt))
884 _AddBuiltinFunc(mem, 'parseExpr',
885 func_reflect.ParseExpr(parse_ctx, errfmt))
886
887 _AddBuiltinFunc(mem, 'shvarGet', func_reflect.Shvar_get(mem))
888 _AddBuiltinFunc(mem, 'getVar', func_reflect.GetVar(mem))
889 _AddBuiltinFunc(mem, 'setVar', func_reflect.SetVar(mem))
890
891 # TODO: implement bindFrame() to turn CommandFrag -> Command
892 # Then parseCommand() and parseHay() will not depend on mem; they will not
893 # bind a frame yet
894 #
895 # what about newFrame() and globalFrame()?
896 _AddBuiltinFunc(mem, 'bindFrame', func_reflect.BindFrame())
897
898 _AddBuiltinFunc(mem, 'Object', func_misc.Object())
899
900 _AddBuiltinFunc(mem, 'rest', func_misc.Prototype())
901 _AddBuiltinFunc(mem, 'first', func_misc.PropView())
902
903 # TODO: remove these aliases
904 _AddBuiltinFunc(mem, 'prototype', func_misc.Prototype())
905 _AddBuiltinFunc(mem, 'propView', func_misc.PropView())
906
907 # type conversions
908 _AddBuiltinFunc(mem, 'bool', func_misc.Bool())
909 _AddBuiltinFunc(mem, 'int', func_misc.Int())
910 _AddBuiltinFunc(mem, 'float', func_misc.Float())
911 _AddBuiltinFunc(mem, 'str', func_misc.Str_())
912 _AddBuiltinFunc(mem, 'list', func_misc.List_())
913 _AddBuiltinFunc(mem, 'dict', func_misc.DictFunc())
914
915 # Dict functions
916 _AddBuiltinFunc(mem, 'get', method_dict.Get())
917 _AddBuiltinFunc(mem, 'keys', method_dict.Keys())
918 _AddBuiltinFunc(mem, 'values', method_dict.Values())
919
920 _AddBuiltinFunc(mem, 'runes', func_misc.Runes())
921 _AddBuiltinFunc(mem, 'encodeRunes', func_misc.EncodeRunes())
922 _AddBuiltinFunc(mem, 'bytes', func_misc.Bytes())
923 _AddBuiltinFunc(mem, 'encodeBytes', func_misc.EncodeBytes())
924
925 # Str
926 #_AddBuiltinFunc(mem, 'strcmp', None)
927 # TODO: This should be Python style splitting
928 _AddBuiltinFunc(mem, 'split', func_misc.Split(splitter))
929 _AddBuiltinFunc(mem, 'shSplit', func_misc.Split(splitter))
930
931 # Float
932 _AddBuiltinFunc(mem, 'floatsEqual', func_misc.FloatsEqual())
933
934 # List
935 _AddBuiltinFunc(mem, 'join', func_misc.Join())
936 _AddBuiltinFunc(mem, 'maybe', func_misc.Maybe())
937 _AddBuiltinFunc(mem, 'glob', func_misc.Glob(globber))
938
939 # Serialize
940 _AddBuiltinFunc(mem, 'toJson8', func_misc.ToJson8(True))
941 _AddBuiltinFunc(mem, 'toJson', func_misc.ToJson8(False))
942
943 _AddBuiltinFunc(mem, 'fromJson8', func_misc.FromJson8(True))
944 _AddBuiltinFunc(mem, 'fromJson', func_misc.FromJson8(False))
945
946 # Demos
947 _AddBuiltinFunc(mem, '_a2sp', func_misc.BashArrayToSparse())
948 _AddBuiltinFunc(mem, '_opsp', func_misc.SparseOp())
949
950 mem.AddBuiltin('io', io_obj)
951 mem.AddBuiltin('vm', vm_obj)
952
953 # Special case for testing
954 mem.AddBuiltin('module-invoke', value.BuiltinProc(module_invoke))
955
956 #
957 # Is the shell interactive?
958 #
959
960 # History evaluation is a no-op if readline is None.
961 hist_ev = history.Evaluator(readline, hist_ctx, debug_f)
962
963 if flag.c is not None:
964 src = source.CFlag # type: source_t
965 line_reader = reader.StringLineReader(flag.c,
966 arena) # type: reader._Reader
967 if flag.i: # -c and -i can be combined
968 mutable_opts.set_interactive()
969
970 elif flag.i: # force interactive
971 src = source.Stdin(' -i')
972 line_reader = reader.InteractiveLineReader(arena, prompt_ev, hist_ev,
973 readline, prompt_state)
974 mutable_opts.set_interactive()
975
976 else:
977 if script_name is None:
978 if flag.headless:
979 src = source.Headless
980 line_reader = None # unused!
981 # Not setting '-i' flag for now. Some people's bashrc may want it?
982 else:
983 stdin_ = mylib.Stdin()
984 # --tool never starts a prompt
985 if len(flag.tool) == 0 and stdin_.isatty():
986 src = source.Interactive
987 line_reader = reader.InteractiveLineReader(
988 arena, prompt_ev, hist_ev, readline, prompt_state)
989 mutable_opts.set_interactive()
990 else:
991 src = source.Stdin('')
992 line_reader = reader.FileLineReader(stdin_, arena)
993 else:
994 src = source.MainFile(script_name)
995 try:
996 f = fd_state.Open(script_name)
997 except (IOError, OSError) as e:
998 print_stderr("%s: Couldn't open %r: %s" %
999 (lang, script_name, posix.strerror(e.errno)))
1000 return 1
1001 line_reader = reader.FileLineReader(f, arena)
1002
1003 # Pretend it came from somewhere else
1004 if flag.location_str is not None:
1005 src = source.Synthetic(flag.location_str)
1006 assert line_reader is not None
1007 location_start_line = mops.BigTruncate(flag.location_start_line)
1008 if location_start_line != -1:
1009 line_reader.SetLineOffset(location_start_line)
1010
1011 arena.PushSource(src)
1012
1013 # Calculate ~/.config/oils/oshrc or yshrc. Used for both -i and --headless
1014 # We avoid cluttering the user's home directory. Some users may want to ln
1015 # -s ~/.config/oils/oshrc ~/oshrc or ~/.oshrc.
1016
1017 # https://unix.stackexchange.com/questions/24347/why-do-some-applications-use-config-appname-for-their-config-data-while-other
1018
1019 config_dir = '.config/oils'
1020 rc_paths = [] # type: List[str]
1021 if flag.headless or exec_opts.interactive():
1022 if flag.norc:
1023 # bash doesn't have this warning, but it's useful
1024 if flag.rcfile is not None:
1025 print_stderr('%s warning: --rcfile ignored with --norc' % lang)
1026 if flag.rcdir is not None:
1027 print_stderr('%s warning: --rcdir ignored with --norc' % lang)
1028 else:
1029 # User's rcfile comes FIRST. Later we can add an 'after-rcdir' hook
1030 rc_path = flag.rcfile
1031 if rc_path is None:
1032 rc_paths.append(
1033 os_path.join(home_dir, '%s/%src' % (config_dir, lang)))
1034 else:
1035 rc_paths.append(rc_path)
1036
1037 # Load all files in ~/.config/oils/oshrc.d or oilrc.d
1038 # This way "installers" can avoid mutating oshrc directly
1039
1040 rc_dir = flag.rcdir
1041 if rc_dir is None:
1042 rc_dir = os_path.join(home_dir,
1043 '%s/%src.d' % (config_dir, lang))
1044
1045 rc_paths.extend(libc.glob(os_path.join(rc_dir, '*'), 0))
1046
1047 # Initialize even in non-interactive shell, for 'compexport'
1048 _InitDefaultCompletions(cmd_ev, complete_builtin, comp_lookup)
1049
1050 if flag.headless:
1051 sh_init.InitInteractive(mem, sh_files, lang)
1052 mutable_opts.set_redefine_const()
1053 mutable_opts.set_redefine_source()
1054
1055 # NOTE: rc files loaded AFTER _InitDefaultCompletions.
1056 for rc_path in rc_paths:
1057 with state.ctx_ThisDir(mem, rc_path):
1058 try:
1059 SourceStartupFile(fd_state, rc_path, lang, parse_ctx,
1060 cmd_ev, errfmt)
1061 except util.UserExit as e:
1062 return e.status
1063
1064 loop = main_loop.Headless(cmd_ev, parse_ctx, errfmt)
1065 try:
1066 # TODO: What other exceptions happen here?
1067 status = loop.Loop()
1068 except util.UserExit as e:
1069 status = e.status
1070
1071 # Same logic as interactive shell
1072 mut_status = IntParamBox(status)
1073 cmd_ev.RunTrapsOnExit(mut_status)
1074 status = mut_status.i
1075
1076 return status
1077
1078 # Note: headless mode above doesn't use c_parser
1079 assert line_reader is not None
1080 c_parser = parse_ctx.MakeOshParser(line_reader)
1081
1082 if exec_opts.interactive():
1083 sh_init.InitInteractive(mem, sh_files, lang)
1084 # bash: 'set -o emacs' is the default only in the interactive shell
1085 mutable_opts.set_emacs()
1086 mutable_opts.set_redefine_const()
1087 mutable_opts.set_redefine_source()
1088
1089 # NOTE: rc files loaded AFTER _InitDefaultCompletions.
1090 for rc_path in rc_paths:
1091 with state.ctx_ThisDir(mem, rc_path):
1092 try:
1093 SourceStartupFile(fd_state, rc_path, lang, parse_ctx,
1094 cmd_ev, errfmt)
1095 except util.UserExit as e:
1096 return e.status
1097
1098 completion_display = state.MaybeString(mem, 'OILS_COMP_UI')
1099 if completion_display is None:
1100 completion_display = flag.completion_display
1101
1102 if readline:
1103 if completion_display == 'nice':
1104 display = comp_ui.NiceDisplay(
1105 comp_ui_state, prompt_state, debug_f, readline,
1106 signal_safe) # type: comp_ui._IDisplay
1107 else:
1108 display = comp_ui.MinimalDisplay(comp_ui_state, prompt_state,
1109 debug_f, signal_safe)
1110
1111 comp_ui.InitReadline(readline, sh_files.HistoryFile(), root_comp,
1112 display, debug_f)
1113
1114 if flag.completion_demo:
1115 _CompletionDemo(comp_lookup)
1116
1117 else: # Without readline module
1118 display = comp_ui.MinimalDisplay(comp_ui_state, prompt_state,
1119 debug_f, signal_safe)
1120
1121 process.InitInteractiveShell(signal_safe) # Set signal handlers
1122 # The interactive shell leads a process group which controls the terminal.
1123 # It MUST give up the terminal afterward, otherwise we get SIGTTIN /
1124 # SIGTTOU bugs.
1125 with process.ctx_TerminalControl(job_control, errfmt):
1126
1127 assert line_reader is not None
1128 line_reader.Reset() # After sourcing startup file, render $PS1
1129
1130 prompt_plugin = prompt.UserPlugin(mem, parse_ctx, cmd_ev, errfmt)
1131 try:
1132 status = main_loop.Interactive(flag, cmd_ev, c_parser, display,
1133 prompt_plugin, waiter, errfmt)
1134 except util.UserExit as e:
1135 status = e.status
1136
1137 mut_status = IntParamBox(status)
1138 cmd_ev.RunTrapsOnExit(mut_status)
1139 status = mut_status.i
1140
1141 if readline:
1142 hist_file = sh_files.HistoryFile()
1143 if hist_file is not None:
1144 try:
1145 readline.write_history_file(hist_file)
1146 except (IOError, OSError):
1147 pass
1148
1149 return status
1150
1151 if flag.rcfile is not None: # bash doesn't have this warning, but it's useful
1152 print_stderr('%s warning: --rcfile ignored in non-interactive shell' %
1153 lang)
1154 if flag.rcdir is not None:
1155 print_stderr('%s warning: --rcdir ignored in non-interactive shell' %
1156 lang)
1157
1158 #
1159 # Tools that use the OSH/YSH parsing mode, etc.
1160 #
1161
1162 # flag.tool is '' if nothing is passed
1163 # osh --tool syntax-tree is equivalent to osh -n --one-pass-parse
1164 tool_name = 'syntax-tree' if exec_opts.noexec() else flag.tool
1165
1166 if len(tool_name):
1167 # Don't save tokens becaues it's slow
1168 if tool_name != 'syntax-tree':
1169 arena.SaveTokens()
1170
1171 try:
1172 node = main_loop.ParseWholeFile(c_parser)
1173 except error.Parse as e:
1174 errfmt.PrettyPrintError(e)
1175 return 2
1176
1177 if tool_name == 'syntax-tree':
1178 ui.PrintAst(node, flag)
1179
1180 elif tool_name == 'tokens':
1181 ysh_ify.PrintTokens(arena)
1182
1183 elif tool_name == 'lossless-cat': # for test/lossless.sh
1184 ysh_ify.LosslessCat(arena)
1185
1186 elif tool_name == 'fmt':
1187 fmt.Format(arena, node)
1188
1189 elif tool_name == 'test':
1190 raise AssertionError('TODO')
1191
1192 elif tool_name == 'ysh-ify':
1193 ysh_ify.Ysh_ify(arena, node)
1194
1195 elif tool_name == 'deps':
1196 if mylib.PYTHON:
1197 deps.Deps(node)
1198
1199 else:
1200 raise AssertionError(tool_name) # flag parser validated it
1201
1202 return 0
1203
1204 #
1205 # Run a shell script
1206 #
1207
1208 with state.ctx_ThisDir(mem, script_name):
1209 try:
1210 status = main_loop.Batch(cmd_ev,
1211 c_parser,
1212 errfmt,
1213 cmd_flags=cmd_eval.IsMainProgram)
1214 except util.UserExit as e:
1215 status = e.status
1216 except KeyboardInterrupt:
1217 # The interactive shell handles this in main_loop.Interactive
1218 status = 130 # 128 + 2
1219 mut_status = IntParamBox(status)
1220 cmd_ev.RunTrapsOnExit(mut_status)
1221
1222 multi_trace.WriteDumps()
1223
1224 # NOTE: We haven't closed the file opened with fd_state.Open
1225 return mut_status.i