ducky.machine module

ducky.machine.Machine is the virtual machine. Each instance represents self-contained virtual machine, with all its devices, memory, CPUs and other necessary properties.

class ducky.machine.CommChannel(machine)

Bases: object

create_queue(name)

get_queue(name)

unregister_queue(name)

class ducky.machine.CommQueue(channel)

Bases: object

is_empty_in()

is_empty_out()

read_in()

read_out()

write_in(o)

write_out(o)

class ducky.machine.EventBus(machine)

Bases: object

add_listener(event, callback, *args, **kwargs)

remove_listener(event, callback)

trigger(event, *args, **kwargs)

class ducky.machine.HaltMachineTask(machine)

Bases: ducky.interfaces.IReactorTask

run()

class ducky.machine.IRQRouterTask(machine)

Bases: ducky.interfaces.IReactorTask

This task is responsible for distributing triggered IRQs between CPU cores. When IRQ is triggered, IRQ source (i.e. device that requires attention) is appended to this tasks queue (ducky.machine.IRQRouterTask.qeueu). As long as this queue is not empty, this task pops IRQ sources, selects free CPU core, and by calling its ducky.cpu.CPUCore.irq() method core takes reponsibility for executing interrupt routine.

Parameters:machine (ducky.machine.Machine) – machine this task belongs to.

run()

class ducky.machine.Machine(logger=None, stdin=None, stdout=None, stderr=None)

Bases: ducky.interfaces.ISnapshotable, ducky.interfaces.IMachineWorker

Virtual machine itself.

boot()

capture_state(suspend=False)

Capture current state of the VM, and store it in it’s last_state attribute.

Parameters:suspend (bool) – if True, suspend VM before taking snapshot.

core(cid)

Find CPU core by its string id.

Parameters:cid (string) – id of searched CPU core, in the form #<cpuid>:#<coreid>. Return type:ducky.cpu.CPUCore Returns:found core Raises:ducky.errors.InvalidResourceError – when no such core exists.

cores

Get list of all cores in the machine.

Return type:list Returns:list of ducky.cpu.CPUCore instances

die(exc)

exit_code

get_device_by_name(name, klass=None)

Get device by its name and class.

Parameters:

• name (string) – name of the device.
• klass (string) – if set, search only devices with this class.

Return type:

ducky.devices.Device

Returns:

found device

Raises:

ducky.errors.InvalidResourceError – when no such device exists

get_storage_by_id(sid)

Get storage by its id.

Parameters:sid (int) – id of storage caller is looking for. Return type:ducky.devices.Device Returns:found device. Raises:ducky.errors.InvalidResourceError – when no such storage exists.

halt()

hw_setup(machine_config)

load_state(state)

on_core_alive(core)

Signal machine that one of CPU cores is now alive.

on_core_halted(core)

Signal machine that one of CPU cores is no longer alive.

register_port(port, handler)

run()

save_state(parent)

setup_devices()

suspend()

tenh(s, *args)

trigger_irq(handler)

unregister_port(port)

wake_up()

class ducky.machine.MachineState

Bases: ducky.snapshot.SnapshotNode

get_cpu_state_by_id(cpuid)

get_cpu_states()

ducky.machine.cmd_boot(console, cmd)

Setup HW, load binaries, init everything

ducky.machine.cmd_halt(console, cmd)

Halt execution

ducky.machine.cmd_run(console, cmd)

Start execution of loaded binaries

ducky.machine.cmd_snapshot(console, cmd)

Create snapshot