README.md

Infiltrator.jl

This packages provides the @infiltrate macro, which acts as a breakpoint with negligible runtime performance overhead.

Note that you cannot access other function scopes or step into further calls. Use an actual debugger if you need that level of flexibility.

Running code that ends up triggering the @infiltrate REPL mode via inline evaluation in VS Code or Juno can cause issues, so it's recommended to always use the REPL directly.

@infiltrate

@infiltrate
@infiltrate condition::Bool

@infiltrate sets an infiltration point.

When the infiltration point is hit, it will drop you into an interactive REPL session that lets you inspect local variables and the call stack as well as execute arbitrary statements in the context of the current local and global scope.

The optional argument cond only enables this infiltration point if it evaluates to true, e.g.

@infiltrate false # does not infiltrate

You can also use

if isdefined(Main, :Infiltrator)
  Main.infiltrate(@__MODULE__, Base.@locals, @__FILE__, @__LINE__)
end

to infiltrate package code without any post-hoc evaluation into the module (because the functional form does not require Infiltrator to be loaded at compiletime).

The safehouse

Exfiltrating variables (with @exfiltrate or by assignment in an @infiltrate session) happens by assigning the variable to a global storage space (backed by a module); any exfiltrated objects can be directly accessed, via Infiltrator.store or its exported aliases safehouse or exfiltrated:

julia> foo(x) = @exfiltrate
foo (generic function with 1 method)

julia> foo(3)

julia> safehouse.x # or exfiltrated.x
3

You can reset the safehouse with Infiltrator.clear_store!().

You can also assign a specific module with Infiltrator.set_store!(mod). This allows you to e.g. set the backing module to Main and therefore export the contents of the safehouse to the global namespace (although doing so is not recommended).

Usage

Scripts and package development

Using Infiltrator for debugging packages or scripts requires a little bit of setup.

1. Either your current environment or an environment futher down the environment stack must contain Infiltrator.jl. I would recommend putting Infiltrator.jl into your global @v1.xx environment so that it is always available.
2. Load Revise.jl or use VS Code's inline evaluation to seamlessly update your package code.
3. Load your package.
4. Add Main.@infiltrate statements as breakpoints wherever desired.
5. Run a function that ends up executing the method containing the breakpoint.

The ordering of steps 3 and 4 is important: loading your package after adding Main.@infiltrate statements will prevent if from loading, because that macro does not exist during precompilation.

If you absolutely cannot modfiy your code after loading it initially, then the infiltrate function can be used instead. An advantage of the macro form is that it will fail tests, so you don't end up committing or merging code containing infiltration points.

REPL session

julia> function f(x)
         out = []
         for i in x
           push!(out, 2i)
           @infiltrate
         end
         out
       end
f (generic function with 1 method)

julia> f([1,2,3,4,5,6,7,8,9,10])
Infiltrating f(x::Vector{Int64})
  at REPL[10]:5

infil> ?
  Code entered here is evaluated in the current scope. Changes to local variables are not possible; global variables can only be changed with eval/@eval.

  All assignments will end up in the safehouse.

  The following commands are special cased:

    •  ?: Print this help text.

    •  @trace: Print the current stack trace.

    •  @locals: Print local variables. @locals x y only prints x and y.

    •  @exception: Print the exception that triggered the current @infiltry session, if any.

    •  @exfiltrate: Save all local variables into the store. @exfiltrate x y saves x and y; this variant can also exfiltrate variables defined in the infil> REPL.

    •  @toggle: Toggle infiltrating at this @infiltrate spot (clear all with Infiltrator.clear_disabled!()).

    •  @cond expr: Infiltrate at this @infiltrate spot only if <expr> evaluates to true (clear all with
       Infiltrator.clear_conditions!()).

    •  @continue: Continue to the next infiltration point or exit (shortcut: Ctrl-D).

    •  @doc symbol: Get help for symbol (same as in the normal Julia REPL).

    •  @exit: Stop infiltrating for the remainder of this session and exit (on Julia versions prior to 1.5 this needs to be manually cleared with Infiltrator.end_session!()).

infil> @locals
- out::Vector{Any} = Any[2]
- i::Int64 = 1
- x::Vector{Int64} = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

infil> 0//0
ERROR: ArgumentError: invalid rational: zero(Int64)//zero(Int64)
Stacktrace:
 [1] __throw_rational_argerror_zero(T::Type)
   @ Base ./rational.jl:32
 [2] Rational{Int64}(num::Int64, den::Int64)
   @ Base ./rational.jl:34
 [3] Rational
   @ ./rational.jl:39 [inlined]
 [4] //(n::Int64, d::Int64)
   @ Base ./rational.jl:62
 [5] top-level scope
   @ none:1

infil> @toggle
Disabled infiltration at this infiltration point.

infil> @toggle
Enabled infiltration at this infiltration point.

infil> @cond i > 5
Conditionally enabled infiltration at this infiltration point.

infil> @continue

Infiltrating f(x::Vector{Int64})
  at REPL[10]:5

infil> i
6

infil> intermediate = copy(out)
6-element Vector{Any}:
  2
  4
  6
  8
 10
 12

infil> @exfiltrate intermediate x
Exfiltrating 2 local variables into the safehouse.

infil> @exit

10-element Vector{Any}:
  2
  4
  6
  8
 10
 12
 14
 16
 18
 20


julia> safehouse.intermediate
6-element Vector{Any}:
  2
  4
  6
  8
 10
 12

julia> @withstore begin
         x = 23
         x .* intermediate
       end
6-element Vector{Int64}:
  46
  92
 138
 184
 230
 276

Advanced

Auto-loading Infiltrator.jl

Infiltrator loads very fast (~3ms on my machine) and is generally safe to load in startup.jl.

If, for whatever reason, you do not want to unconditionally load Infiltrator in your startup.jl, you can use the following convenience macro instead. It will automatically load Infiltrator.jl (if it is in your environment stack) and subsequently call @infiltrate:

macro autoinfiltrate(cond=true)
    pkgid = Base.PkgId(Base.UUID("5903a43b-9cc3-4c30-8d17-598619ec4e9b"), "Infiltrator")
    if !haskey(Base.loaded_modules, pkgid)
        try
            Base.eval(Main, :(using Infiltrator))
        catch err
            @error "Cannot load Infiltrator.jl. Make sure it is included in your environment stack."
        end
    end
    i = get(Base.loaded_modules, pkgid, nothing)
    lnn = LineNumberNode(__source__.line, __source__.file)

    if i === nothing
        return Expr(
            :macrocall,
            Symbol("@warn"),
            lnn,
            "Could not load Infiltrator.")
    end

    return Expr(
        :macrocall,
        Expr(:., i, QuoteNode(Symbol("@infiltrate"))),
        lnn,
        esc(cond)
    )
end

Related projects

• @exfiltrate for Python