Merge pull request #1586 from ltratt/ykd_log

Rename `YK_LOG` to `YKD_LOG`.

docs/src/dev/runtime_config.md

@@ -10,22 +10,6 @@ Variables prefixed with `YK_` allow the user to control aspects of yk's executio
 
 The following environment variables are available:
 
-* `YK_LOG=[<path>:]<level>` specifies where, and how much, general information
-  yk will log during execution.
-
-  If `<path>:` (i.e. a path followed by ":") is specified then output is sent
-  to that path. The special value `-` (i.e. a single dash) can be used for
-  `<path>` to indicate stderr. If not specified, logs to stderr.
-
-  `<level>` specifies the level of logging, each adding to the previous: level
-  0 turns off all yk logging; level 1 shows major errors only; and level 2
-  warnings. Levels above 3 are used for internal yk debugging, and their
-  precise output, and indeed the maximum level may change without warning.
-  Currently: level 3 logs transitions of a `Location` transition; and level 4
-  JIT events such as starting/stopping tracing. Note that some information, at
-  all levels, may or may not be displayed based on compile-time options.
-  Defaults to 1.
-
 * `YK_HOT_THRESHOLD`: an integer from 0..4294967295 (both inclusive) that
   determines how many executions of a hot loop are needed before it is traced.
   Defaults to 50.
@@ -40,5 +24,20 @@ performance down.
 
 The following environment variables are available (some only in certain configurations of yk):
 
+* `YKD_LOG=[<path>:]<level>` specifies where, and how much, general information
+  yk will log during execution.
+
+  If `<path>:` (i.e. a path followed by ":") is specified then output is sent
+  to that path. The special value `-` (i.e. a single dash) can be used for
+  `<path>` to indicate stderr. If not specified, logs to stderr.
+
+  `<level>` specifies the level of logging, each adding to the previous: level
+  0 turns off all yk logging; level 1 shows major errors only; and level 2
+  warnings. Levels above 3 are used for internal yk debugging, and their
+  precise output, and indeed the maximum level may change without warning.
+  Currently: level 3 logs transitions of a `Location` transition; and level 4
+  JIT events such as starting/stopping tracing. Note that some information, at
+  all levels, may or may not be displayed based on compile-time options.
+  Defaults to 1.
 * [`YKD_LOG_IR`](understanding_traces.html#ykd_log_ir) [with the `ykd` feature]
 * [`YKD_LOG_STATS`](profiling.html#jit-statistics)

tests/c/arg_mapping_callee.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     3:5

tests/c/arithmetic.c

@@ -3,7 +3,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=jit-pre-opt,jit-post-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     add 5

tests/c/ashr_exact.c

@@ -3,7 +3,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     ashr 4

tests/c/bf.O0.c

@@ -2,7 +2,7 @@
 //   env-var: YKB_EXTRA_CC_FLAGS=-O0
 // Run-time:
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     ...
 //     yk-jit-event: enter-jit-code

tests/c/bf.O1.c

@@ -2,7 +2,7 @@
 //   env-var: YKB_EXTRA_CC_FLAGS=-O1
 // Run-time:
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     ...
 //     yk-jit-event: enter-jit-code

tests/c/bf.O2.c

@@ -2,7 +2,7 @@
 //   env-var: YKB_EXTRA_CC_FLAGS=-O2
 // Run-time:
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     ...
 //     yk-jit-event: enter-jit-code

tests/c/bf.O3.c

@@ -2,7 +2,7 @@
 //   env-var: YKB_EXTRA_CC_FLAGS=-O3
 // Run-time:
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     ...
 //     yk-jit-event: enter-jit-code

tests/c/call_args.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     3: 5

tests/c/call_ext_in_obj.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     4

tests/c/calls_double.c

@@ -1,6 +1,6 @@
 // Run-time:
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     ...
 //     yk-jit-event: enter-jit-code

tests/c/choice.c

@@ -1,6 +1,6 @@
 // Compiler:
 // Run-time:
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   env-var: YKD_LOG_IR=jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
 //   stderr:

tests/c/conditionals.c

@@ -1,5 +1,5 @@
 // Run-time:
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   env-var: YKD_SERIALISE_COMPILATION=1
 //   stderr:
 //     ...

tests/c/const_global.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     i=4

tests/c/constexpr.c

@@ -2,7 +2,7 @@
 // ignore-if: true
 // Run-time:
 //   env-var: YKD_LOG_IR=jit-pre-opt
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   env-var: YKD_SERIALISE_COMPILATION=1
 //   stderr:
 //     ...

tests/c/double.c

@@ -3,7 +3,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     4 -> 4.000000

tests/c/doubleinline.c

@@ -3,7 +3,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     4

tests/c/dyn_ptradd_mixed.c

@@ -3,7 +3,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     i=4, y=7

tests/c/dyn_ptradd_multidim.c

@@ -3,7 +3,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     i=0, elem=000

tests/c/dyn_ptradd_simple.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     i=4, elem=14

tests/c/early_return1.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_SERIALISE_COMPILATION=1
 //   env-var: YKD_LOG_IR=jit-pre-opt
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     early return

tests/c/early_return2.c

@@ -2,7 +2,7 @@
 // Run-time:
 //   env-var: YKD_SERIALISE_COMPILATION=1
 //   env-var: YKD_LOG_IR=jit-pre-opt
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     b3

tests/c/exit_and_reenter_interploop.c

@@ -1,6 +1,6 @@
 // Run-time:
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     enter
 //     yk-jit-event: start-tracing

tests/c/fcmp_double.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt,jit-asm
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     1.100000 == 2.200000: 0

tests/c/fcmp_float.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt,jit-asm
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     1.100000 == 2.200000: 0

tests/c/fib.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     4:21

tests/c/float.c

@@ -3,7 +3,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     4 -> 4.000000

tests/c/float_binop.c

@@ -3,7 +3,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     4 -> 4.333300 4.840000

tests/c/float_consts.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     4 -> 3.350000, 4.500000

tests/c/float_div.c

@@ -3,7 +3,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     4 -> 8.000000 20.000000

tests/c/float_mul.c

@@ -3,7 +3,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     4 -> 1.333200 3.360000

tests/c/float_store.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-post-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     4 -> 3.252033

tests/c/fp_in_out.c

@@ -1,6 +1,6 @@
 // Run-time:
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     5.100000

tests/c/fp_to_si.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     i=4

tests/c/funcptrarg_hasir.c

@@ -2,7 +2,7 @@
 // ignore-if: true
 // Run-time:
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     ...
 //     FIXME: match the indirect call

tests/c/funcptrarg_noir.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_SERIALISE_COMPILATION=1
 //   env-var: YKD_LOG_IR=jit-pre-opt
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     z=3

tests/c/funcptrarg_pretrace.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_SERIALISE_COMPILATION=1
 //   env-var: YKD_LOG_IR=jit-pre-opt
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     ...
 //     --- Begin jit-pre-opt ---

tests/c/icmp_ptr.c

@@ -1,6 +1,6 @@
 // Run-time:
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     ...
 //     yk-jit-event: enter-jit-code

tests/c/indirect_branch.c

@@ -2,7 +2,7 @@
 // ignore-if: true
 // Run-time:
 //   env-var: YKD_LOG_IR=jit-pre-opt
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     FIXME: match some IR/output
 //     ...

tests/c/indirect_call.c

@@ -1,7 +1,7 @@
 // Run-time:
 //   env-var: YKD_LOG_IR=jit-pre-opt
 //   env-var: YKD_SERIALISE_COMPILATION=1
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   stderr:
 //     yk-jit-event: start-tracing
 //     foo 7

tests/c/indirect_external_function_call.c

@@ -2,7 +2,7 @@
 // ignore-if: true
 // Run-time:
 //   env-var: YKD_LOG_IR=aot,jit-pre-opt
-//   env-var: YK_LOG=4
+//   env-var: YKD_LOG=4
 //   env-var: YKD_SERIALISE_COMPILATION=1
 //   stdout:
 //     205