package dse.osidbg

Get desktop application:
View/edit binary Protocol Buffers messages

• oneof msg

  • BkVersionInfoResponse versionInfo = 1

  • BkBreakpointTriggered breakpointTriggered = 2

  • BkResult results = 4

  • BkStoryLoaded storyLoaded = 5

  • BkDebugSessionEnded debugSessionEnded = 6

  • BkGlobalBreakpointTriggered globalBreakpointTriggered = 7

  • BkSyncStoryData syncStoryData = 10

  • BkSyncStoryFinished syncStoryFinished = 11

  • BkDebugOutput debugOutput = 12

  • BkBeginDatabaseContents beginDatabaseContents = 13

  • BkDatabaseRow databaseRow = 14

  • BkEndDatabaseContents endDatabaseContents = 15

  • BkEvaluateRow evaluateRow = 16

  • BkEvaluateFinished evaluateFinished = 17

• uint32 seq_no = 8

• uint32 reply_seq_no = 9

Indicates the start of a database dump

Used in: BackendToDebugger

• uint32 database_id = 1

Used in: BackendToDebugger

• repeated MsgFrame call_stack = 1

• BkBreakpointTriggered.QueryStatus query_succeeded = 2

• optional MsgTuple query_results = 3

• uint32 query_node_id = 4

Used in: BkBreakpointTriggered

• NOT_A_QUERY = 0

• SUCCEEDED = 1

• FAILED = 2

Adds row(s) to a database that is currently being dumped

Used in: BackendToDebugger

• uint32 database_id = 1

• repeated MsgTuple row = 2

Debug output text (DebugBreak) from the story script

Used in: BackendToDebugger

• string message = 1

Notifies the frontend that the story was unloaded

Used in: BackendToDebugger

(message has no fields)

Indicates the end of a database dump

Used in: BackendToDebugger

• uint32 database_id = 1

Indicates the end of an evaluation

Used in: BackendToDebugger

• StatusCode result_code = 1

• bool query_succeeded = 2

Adds row(s) to the result set of an evaluation

Used in: BackendToDebugger

• repeated MsgTuple row = 1

Used in: BackendToDebugger

• BkGlobalBreakpointTriggered.Reason reason = 1

Used in: BkGlobalBreakpointTriggered

• STORY_LOADED = 0

• GAME_INIT = 1

• GAME_EXIT = 2

Used in: BackendToDebugger

• StatusCode status_code = 1

Used in: BackendToDebugger

(message has no fields)

Story synchronization data Each message may contain an arbitrary amount of goals/dbs/nodes. Elements in subsequent messages must be appended to the nodes sent previously.

Used in: BackendToDebugger

• repeated MsgGoalInfo goal = 1

• repeated MsgDatabaseInfo database = 2

• repeated MsgNodeInfo node = 3

• repeated MsgRuleInfo rule = 4

Indicates that all story nodes were sent to the frontend.

Used in: BackendToDebugger

(message has no fields)

Used in: BackendToDebugger

• uint32 protocol_version = 1

• bool story_loaded = 2

• bool story_initialized = 4

Used in: DebuggerToBackend

• DbgContinue.Action action = 1

• uint32 breakpoint_mask = 2

  Same as MsgBreakpoint::BreakpointType

• uint32 flags = 3

Used in: DbgContinue

• CONTINUE = 0

• STEP_OVER = 1

• STEP_INTO = 2

• STEP_OUT = 3

• PAUSE = 4

• NONE = 0

• SKIP_RULE_PUSHDOWN = 1

  Don't break on Pushdown events if the node is a rule node

• SKIP_DB_PROPAGATION = 2

  Don't break inside database propagation chains

Requests the debugger to evaluate an expression

Used in: DebuggerToBackend

• DbgEvaluate.EvalType type = 1

• uint32 node_id = 2

• optional MsgTuple params = 3

Used in: DbgEvaluate

• IS_VALID = 0

  calls IsValid; returns a result row and a true/false match flag

• PUSHDOWN = 1

  calls Pushdown; returns an arbitrary number of result rows

• INSERT = 2

  calls Insert; no result

• DELETE_ = 3

  calls Delete; no result

Used in: DebuggerToBackend

• uint32 database_id = 1

Used in: DebuggerToBackend

• uint32 protocol_version = 1

Used in: DebuggerToBackend

• repeated MsgBreakpoint breakpoint = 1

Used in: DebuggerToBackend

• uint32 breakpoint_mask = 1

• NONE = 0

• STORY_LOADED = 1

• VALID = 2

• PUSHDOWN = 4

• INSERT = 8

• RULE_ACTION = 16

• INIT_CALL = 32

• EXIT_CALL = 64

• GAME_INIT = 128

• GAME_EXIT = 256

• DELETE_ = 512

• FAILED_QUERY = 1024

Requests the debugger to send all story goals/dbs/nodes to the frontend. This is used to validate that the debug info loaded on the frontend matches the story being executed on the backend.

Used in: DebuggerToBackend

(message has no fields)

• oneof msg

  • DbgIdentifyRequest identify = 1

  • DbgSetGlobalBreakpoints setGlobalBreakpoints = 2

  • DbgSetBreakpoints setBreakpoints = 3

  • DbgContinue continue = 4

  • DbgGetDatabaseContents getDatabaseContents = 5

  • DbgSyncStory syncStory = 8

  • DbgEvaluate evaluate = 9

• uint32 seq_no = 6

• uint32 reply_seq_no = 7

Used in: MsgGoalInfo, MsgRuleInfo

• string function = 1

• uint32 arity = 2

• int32 goal_id = 3

Used in: DbgSetBreakpoints

• uint32 node_id = 1

• uint32 breakpoint_mask = 2

• uint32 goal_id = 3

• bool is_init_action = 4

• int32 action_index = 5

• NONE = 0

• VALID = 1

• PUSHDOWN = 2

• INSERT = 4

• RULE_ACTION = 8

• INIT_CALL = 16

• EXIT_CALL = 32

• DELETE_ = 64

• FAILED_QUERY = 128

Used in: BkSyncStoryData

• uint32 id = 1

• repeated uint32 argumentType = 2

Used in: BkBreakpointTriggered

• uint32 node_id = 1

• MsgFrame.FrameType type = 2

• optional MsgTuple tuple = 3

• uint32 goal_id = 4

• uint32 action_index = 5

Used in: MsgFrame

• IS_VALID = 0

• PUSHDOWN = 1

• INSERT = 2

• DELETE_ = 3

• PUSHDOWN_DELETE = 4

• RULE_ACTION = 5

• GOAL_INIT_ACTION = 6

• GOAL_EXIT_ACTION = 7

Used in: BkSyncStoryData

• uint32 id = 1

• string name = 2

• repeated MsgActionInfo initActions = 3

• repeated MsgActionInfo exitActions = 4

Used in: BkSyncStoryData

• uint32 id = 1

• uint32 type = 2

• string name = 3

Used in: BkSyncStoryData

• uint32 node_id = 1

• repeated MsgActionInfo actions = 2

Used in: BkBreakpointTriggered, BkDatabaseRow, BkEvaluateRow, DbgEvaluate, MsgFrame

• repeated MsgTypedValue column = 1

Used in: MsgTuple

• uint32 type_id = 1

• oneof value

  • int64 intval = 2

  • float floatval = 3

  • string stringval = 4

Used in: BkEvaluateFinished, BkResult

• SUCCESS = 0

• UNSUPPORTED_BREAKPOINT_TYPE = 1

• INVALID_NODE_ID = 2

• NOT_IN_PAUSE = 3

• NO_DEBUGGEE = 4

• INVALID_CONTINUE_ACTION = 5

• IN_PAUSE = 6

• INVALID_GOAL_ID = 7

• UNSUPPORTED_CONTINUE_FLAGS = 8

• INVALID_DATABASE_ID = 9

• NOT_CALLABLE = 10

• INVALID_PARAMETERS = 11

• NO_ADAPTER = 12

• INVALID_EVAL_TYPE = 13

• EVAL_ENGINE_NOT_READY = 14

• INVALID_PARAM_TUPLE_ARITY = 15

• INVALID_PARAM_TYPE = 16

• MISSING_REQUIRED_PARAM = 17