Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 729a9401742e6709b5721fffc9f06649ca8aabe7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
# *****************************************************************************
# * Copyright (c) 2011, 2013-2014, 2016 Wind River Systems, Inc. and others.
# * All rights reserved. This program and the accompanying materials
# * are made available under the terms of the Eclipse Public License v1.0
# * which accompanies this distribution, and is available at
# * http://www.eclipse.org/legal/epl-v10.html
# *
# * Contributors:
# *     Wind River Systems - initial API and implementation
# *****************************************************************************

"""TCF Runcontrol service interface.

.. |detach| replace:: :meth:`~RunControlContext.detach`
.. |doneGetState| replace:: :meth:`~DoneGetState.doneGetState`
.. |getAddress| replace:: :meth:`~RunControlISA.getAddress`
.. |getChildren| replace:: :meth:`~RunControlService.getChildren`
.. |getContext| replace:: :meth:`~RunControlService.getContext`
.. |getISA| replace:: :meth:`~RunControlContext.getISA`
.. |getSize| replace:: :meth:`~RunControlISA.getSize`
.. |getState| replace:: :meth:`~RunControlContext.getState`
.. |resume| replace:: :meth:`~RunControlContext.resume`
.. |suspend| replace:: :meth:`~RunControlContext.suspend`
.. |terminate| replace:: :meth:`~RunControlContext.terminate`
.. |DoneGetChildren| replace:: :class:`DoneGetChildren`
.. |DoneCommand| replace:: :class:`DoneCommand`
.. |DoneGetContext| replace:: :class:`DoneGetContext`
.. |DoneGetISA| replace:: :class:`DoneGetISA`
.. |MemoryContext| replace:: :class:`~tcf.services.memory.MemoryContext`
.. |RunControlContext| replace:: :class:`RunControlContext`
.. |RunControlISA| replace:: :class:`RunControlISA`
.. |RunControlListener| replace:: :class:`RunControlListener`

Properties
----------
RunControl Context Properties
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+--------------------+--------------+-----------------------------------------+
| Name               | Type         | Description                             |
+====================+==============+=========================================+
| PROP_BP_GROUP      | |basestring| | Context ID of a breakpoints group that  |
|                    |              | contains the context. Members of same   |
|                    |              | group share same breakpoint instances:  |
|                    |              | a breakpoint is planted once for the    |
|                    |              | group, no need to plant the breakpoint  |
|                    |              | for each member of the group.           |
+--------------------+--------------+-----------------------------------------+
| PROP_CAN_COUNT     | |int|        | Bit-set of `Resume Modes`_ values that  |
|                    |              | can be used with count > 1.             |
+--------------------+--------------+-----------------------------------------+
| PROP_CAN_DETACH    | |bool|       | **True** if detach command is supported |
|                    |              | by the context.                         |
+--------------------+--------------+-----------------------------------------+
| PROP_CAN_RESUME    | |bool|       | Bit-set of `Resume Modes`_ values that  |
|                    |              | are supported by the context.           |
+--------------------+--------------+-----------------------------------------+
| PROP_CAN_SUSPEND   | |bool|       | **True** if suspend command is supported|
|                    |              | by the context.                         |
+--------------------+--------------+-----------------------------------------+
| PROP_CAN_TERMINATE | |bool|       | **True** if terminate command is        |
|                    |              | supported by the context.               |
+--------------------+--------------+-----------------------------------------+
| PROP_CREATOR_ID    | |basestring| | ID of a context that created this       |
|                    |              | context.                                |
+--------------------+--------------+-----------------------------------------+
| PROP_HAS_STATE     | |bool|       | **True** if context has execution       |
|                    |              | state - can be suspended/resumed.       |
+--------------------+--------------+-----------------------------------------+
| PROP_ID            | |basestring| | Run control context ID.                 |
+--------------------+--------------+-----------------------------------------+
| PROP_IS_CONTAINER  | |bool|       | **True** if the context is a container. |
|                    |              | Container can propagate run control     |
|                    |              | commands to his children.               |
+--------------------+--------------+-----------------------------------------+
| PROP_NAME          | |basestring| | Human readable context name.            |
+--------------------+--------------+-----------------------------------------+
| PROP_PARENT_ID     | |basestring| | Context parent (owner) ID, for a thread |
|                    |              | it is same as process ID.               |
+--------------------+--------------+-----------------------------------------+
| PROP_PROCESS_ID    | |basestring| | Context process (memory space) ID.      |
+--------------------+--------------+-----------------------------------------+
| PROP_RC_GROUP      | |basestring| | Context ID of a run control group that  |
|                    |              | contains the context. Members of same   |
|                    |              | group are always suspended and resumed  |
|                    |              | together: resuming/suspending a context |
|                    |              | resumes/suspends all members of the     |
|                    |              | group.                                  |
+--------------------+--------------+-----------------------------------------+
| PROP_SYMBOLS_GROUP | |basestring| | Context ID of a symbols group that      |
|                    |              | contains the context. Members of a      |
|                    |              | symbols group share same symbol reader  |
|                    |              | configuration settings, like user       |
|                    |              | defined memory map entries and source   |
|                    |              | lookup info.                            |
+--------------------+--------------+-----------------------------------------+

.. _RunControl-Resume-Modes:

Resume Modes
^^^^^^^^^^^^
All resume modes are of type |int|.

+----------------------------+------------------------------------------------+
| RM_RESUME                  | Resume context.                                |
+----------------------------+------------------------------------------------+
| RM_REVERSE_RESUME          | Start running backwards. Execution will        |
|                            | continue until suspended by command or         |
|                            | breakpoint.                                    |
+----------------------------+------------------------------------------------+
| RM_REVERSE_STEP_INTO       | Reverse of ``RM_STEP_INTO``. This effectively  |
|                            | "un-executes" the previous instruction.        |
+----------------------------+------------------------------------------------+
| RM_REVERSE_STEP_INTO_LINE  | Reverse of ``RM_STEP_INTO_LINE``, Resume       |
|                            | backward execution of given context until      |
|                            | control reaches an instruction that belongs to |
|                            | a different line of source code. If a function |
|                            | is called, stop at the beginning of the last   |
|                            | line of the function code. Error is returned if|
|                            | line number information not available.         |
+----------------------------+------------------------------------------------+
| RM_REVERSE_STEP_INTO_RANGE | Reverse of ``RM_STEP_INTO_RANGE``.             |
+----------------------------+------------------------------------------------+
| RM_REVERSE_STEP_OUT        | Reverse of ``RM_STEP_OUT``. Resume backward    |
|                            | execution of the given context until control   |
|                            | reaches the point where the current function   |
|                            | was called.                                    |
+----------------------------+------------------------------------------------+
| RM_REVERSE_STEP_OVER       | Reverse of ``RM_STEP_OVER`` - run backwards    |
|                            | over a single instruction. If the instruction  |
|                            | is a function call then don't stop until get   |
|                            | out of the function.                           |
+----------------------------+------------------------------------------------+
| RM_REVERSE_STEP_OVER_LINE  | Reverse of ``RM_STEP_OVER_LINE``. Resume       |
|                            | backward execution of given context until      |
|                            | control reaches an instruction that belongs to |
|                            | a different source line. If the line contains  |
|                            | a function call then don't stop until get out  |
|                            | of the function. Error is returned if line     |
|                            | number information not available.              |
+----------------------------+------------------------------------------------+
| RM_REVERSE_STEP_OVER_RANGE | Reverse of ``RM_STEP_OVER_RANGE``.             |
+----------------------------+------------------------------------------------+
| RM_REVERSE_UNTIL_ACTIVE    | Run reverse until the context becomes active.  |
+----------------------------+------------------------------------------------+
| RM_STEP_INTO               | Step a single instruction. If the instruction  |
|                            | is a function call then stop at first          |
|                            | instruction of the function.                   |
+----------------------------+------------------------------------------------+
| RM_STEP_INTO_LINE          | Step a single source code line.  If the line   |
|                            | contains a function call then stop at first    |
|                            | line of the function.                          |
+----------------------------+------------------------------------------------+
| RM_STEP_INTO_RANGE         | Step instruction until PC is outside the       |
|                            | specified range for any reason.                |
+----------------------------+------------------------------------------------+
| RM_STEP_OUT                | Run until control returns from current         |
|                            | function.                                      |
+----------------------------+------------------------------------------------+
| RM_STEP_OVER               | Step over a single instruction. If the         |
|                            | instruction is a function call then don't stop |
|                            | until the function returns.                    |
+----------------------------+------------------------------------------------+
| RM_STEP_OVER_LINE          | Step over a single source code line. If the    |
|                            | line contains a function call then don't stop  |
|                            | until the function returns.                    |
+----------------------------+------------------------------------------------+
| RM_STEP_OVER_RANGE         | Step over instructions until PC is outside the |
|                            | specified range. Any function call within the  |
|                            | range is considered to be in range.            |
+----------------------------+------------------------------------------------+
| RM_UNTIL_ACTIVE            | Run until the context becomes active -         |
|                            | scheduled to run on a target CPU.              |
+----------------------------+------------------------------------------------+

State Reasons
^^^^^^^^^^^^^
State change reason of a context. Reason can be any text, but if it is one of
predefined strings, a generic client might be able to handle it better.

+---------------------+-------------------------------------------------------+
| Name                | Description                                           |
+=====================+=======================================================+
| REASON_BREAKPOINT   | Context has been suspended by a breakpoint hit.       |
+---------------------+-------------------------------------------------------+
| REASON_CONTAINER    | Context is supspended because it container is         |
|                     | suspended.                                            |
+---------------------+-------------------------------------------------------+
| REASON_ERROR        | Context has been suspended by an error.               |
+---------------------+-------------------------------------------------------+
| REASON_EXCEPTION    | Context has been suspended by an exception.           |
+---------------------+-------------------------------------------------------+
| REASON_SHAREDLIB    | Context has been suspended by a sharedlib.            |
+---------------------+-------------------------------------------------------+
| REASON_SIGNAL       | Context has been suspended by a signal.               |
+---------------------+-------------------------------------------------------+
| REASON_STEP         | Context has been suspended by a step request.         |
+---------------------+-------------------------------------------------------+
| REASON_USER_REQUEST | Context has been suspended by user request.           |
+---------------------+-------------------------------------------------------+
| REASON_WATCHPOINT   | Context has been suspended by a watchpoint hit.       |
+---------------------+-------------------------------------------------------+

State Optional Parameters
^^^^^^^^^^^^^^^^^^^^^^^^^
Those information may appear in the context state. See the *param* parameter
of |doneGetState|.

+--------------------------+--------------+-----------------------------------+
| Name                     | Type         | Description                       |
+==========================+==============+===================================+
| STATE_BREAKPOINT_IDS     | |list|       | Breakpoint IDs the context is     |
|                          |              | suspended on.                     |
+--------------------------+--------------+-----------------------------------+
| STATE_PC_ERROR           | |int|        | Program counter the error occurred|
|                          |              | at.                               |
+--------------------------+--------------+-----------------------------------+
| STATE_REVERSING          | |bool|       | true if the context is running in |
|                          |              | reverse.                          |
+--------------------------+--------------+-----------------------------------+
| STATE_SIGNAL             | | int|       | Signal number.                    |
+--------------------------+--------------+-----------------------------------+
| STATE_SIGNAL_DESCRIPTION | |basestring| | Signal description.               |
+--------------------------+--------------+-----------------------------------+
| STATE_SIGNAL_NAME        | |basestring| | Signal name.                      |
+--------------------------+--------------+-----------------------------------+

Resume Optional Parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^
Some resume modes may need optional parameters. See *params* parameter of the
|resume| command.

All resume optional paramters are of type |int|.

+----------------+------------------------------------------------------------+
| Name           | Description                                                |
+================+============================================================+
| RP_RANGE_END   | Ending address of step range, exclusive.                   |
+----------------+------------------------------------------------------------+
| RP_RANGE_START | Starting address of step range, inclusive.                 |
+----------------+------------------------------------------------------------+

Instruction Set Architecture Properties
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

+--------------------------+--------------+-----------------------------------+
| Name                     | Type         | Description                       |
+==========================+==============+===================================+
| ISA_ADDRESS              | |int|        | The address the Instruction Set   |
|                          |              | Architecture is valid at.         |
+--------------------------+--------------+-----------------------------------+
| ISA_ALIGNMENT            | |int|        | Instruction alignmement for the   |
|                          |              | Instruction Set Architecture.     |
+--------------------------+--------------+-----------------------------------+
| ISA_DEFAULT              | |basestring| | Name of the default ISA.          |
+--------------------------+--------------+-----------------------------------+
| ISA_MAX_INSTRUCTION_SIZE | |int|        | Maximum instruction size for ISA. |
+--------------------------+--------------+-----------------------------------+
| ISA_NAME                 | |basestring| | Name of the ISA.                  |
+--------------------------+--------------+-----------------------------------+
| ISA_SIZE                 | |int|        | Size of the ISA. Another ISA may  |
|                          |              | be defined after                  |
|                          |              | ``ISA_ADDRESS`` + ``ISA_SIZE``    |
+--------------------------+--------------+-----------------------------------+


Service Methods
---------------
.. autodata:: NAME
.. autoclass:: RunControlService

addListener
^^^^^^^^^^^
.. automethod:: RunControlService.addListener

getChildren
^^^^^^^^^^^
.. automethod:: RunControlService.getChildren

getContext
^^^^^^^^^^
.. automethod:: RunControlService.getContext

getName
^^^^^^^
.. automethod:: RunControlService.getName

removeListener
^^^^^^^^^^^^^^
.. automethod:: RunControlService.removeListener

detach
^^^^^^
.. automethod:: RunControlContext.detach

getISA
^^^^^^
.. automethod:: RunControlContext.getISA

getState
^^^^^^^^
.. automethod:: RunControlContext.getState

resume
^^^^^^
.. automethod:: RunControlContext.resume

suspend
^^^^^^^
.. automethod:: RunControlContext.suspend

terminate
^^^^^^^^^
.. automethod:: RunControlContext.terminate

Callback Classes
----------------
DoneCommand
^^^^^^^^^^^
.. autoclass:: DoneCommand
    :members:

DoneGetChildren
^^^^^^^^^^^^^^^
.. autoclass:: DoneGetChildren
    :members:

DoneGetContext
^^^^^^^^^^^^^^
.. autoclass:: DoneGetContext
    :members:

DoneGetISA
^^^^^^^^^^
.. autoclass:: DoneGetISA
    :members:

DoneGetState
^^^^^^^^^^^^
.. autoclass:: DoneGetState
    :members:

Listeners
---------
RunControlListener
^^^^^^^^^^^^^^^^^^
.. autoclass:: RunControlListener
    :members:

Helper Classes
--------------
RunControlContext
^^^^^^^^^^^^^^^^^
.. autoclass:: RunControlContext
    :members:

RunControlError
^^^^^^^^^^^^^^^
.. autoclass:: RunControlError
    :members:
    :show-inheritance:

RunControlISA
^^^^^^^^^^^^^
.. autoclass:: RunControlISA
    :members:
"""

from .. import services

NAME = "RunControl"
"""RunControl service name."""

# Context property names.

PROP_ID = "ID"
PROP_PARENT_ID = "ParentID"
PROP_PROCESS_ID = "ProcessID"
PROP_CREATOR_ID = "CreatorID"
PROP_NAME = "Name"
PROP_IS_CONTAINER = "IsContainer"
PROP_HAS_STATE = "HasState"
PROP_CAN_RESUME = "CanResume"
PROP_CAN_COUNT = "CanCount"
PROP_CAN_SUSPEND = "CanSuspend"
PROP_CAN_TERMINATE = "CanTerminate"
PROP_RC_GROUP = "RCGroup"
PROP_BP_GROUP = "BPGroup"
PROP_CAN_DETACH = "CanDetach"
PROP_SYMBOLS_GROUP = "SymbolsGroup"

# Context resume modes.

RM_RESUME = 0
RM_STEP_OVER = 1
RM_STEP_INTO = 2
RM_STEP_OVER_LINE = 3
RM_STEP_INTO_LINE = 4
RM_STEP_OUT = 5
RM_REVERSE_RESUME = 6
RM_REVERSE_STEP_OVER = 7
RM_REVERSE_STEP_INTO = 8
RM_REVERSE_STEP_OVER_LINE = 9
RM_REVERSE_STEP_INTO_LINE = 10
RM_REVERSE_STEP_OUT = 11
RM_STEP_OVER_RANGE = 12
RM_STEP_INTO_RANGE = 13
RM_REVERSE_STEP_OVER_RANGE = 14
RM_REVERSE_STEP_INTO_RANGE = 15
RM_UNTIL_ACTIVE = 16
RM_REVERSE_UNTIL_ACTIVE = 17

# Suspended reasons

REASON_USER_REQUEST = "Suspended"
REASON_STEP = "Step"
REASON_BREAKPOINT = "Breakpoint"
REASON_EXCEPTION = "Exception"
REASON_CONTAINER = "Container"
REASON_WATCHPOINT = "Watchpoint"
REASON_SIGNAL = "Signal"
REASON_SHAREDLIB = "Shared Library"
REASON_ERROR = "Error"
REASON_ACTIVE = "Active"

# Optional parameters of context state.

STATE_SIGNAL = "Signal"
STATE_SIGNAL_NAME = "SignalName"
STATE_SIGNAL_DESCRIPTION = "SignalDescription"
STATE_BREAKPOINT_IDS = "BPs"
STATE_PC_ERROR = "PCError"
STATE_REVERSING = "Reversing"

# Optional parameters of resume command.

RP_RANGE_START = "RangeStart"
RP_RANGE_END = "RangeEnd"

# Instruction Set Architecture properties

ISA_ADDRESS = "Addr"
ISA_ALIGNMENT = "Alignment"
ISA_DEFAULT = "DefISA"
ISA_MAX_INSTRUCTION_SIZE = "MaxInstrSize"
ISA_NAME = "ISA"
ISA_SIZE = "Size"


class RunControlService(services.Service):
    """RunControl service interface."""

    def getName(self):
        """Get this service name.

        :returns: The value of string :const:`NAME`
        """
        return NAME

    def getContext(self, contextID, done):
        """Retrieve context properties for given context ID.

        :param contextID: ID of the context to retrieve.
        :type contextID: |basestring|
        :param done: Callback interface called when operation is completed.
        :type done: |DoneGetContext|

        :returns: Pending command handle.
        """
        raise NotImplementedError("Abstract method")

    def getChildren(self, parent_context_id, done):
        """Retrieve children of given context.

        :param parent_context_id: parent context ID. Can be **None** - to
                                  retrieve top level of the hierarchy, or one
                                  of context IDs retrieved by previous
                                  |getChildren| commands.
        :type parent_context_id: |basestring| or **None**
        :param done: Callback interface called when operation is completed.
        :type done: |DoneGetChildren|

        :returns: Pending command handle.
        """
        raise NotImplementedError("Abstract method")

    def addListener(self, listener):
        """Add run control event listener.

        :param listener: RunControl event listener to add.
        :type listener: |RunControlListener|

        :returns: **None**, always.
        """
        raise NotImplementedError("Abstract method")

    def removeListener(self, listener):
        """Remove run control event listener.

        :param listener: run control event listener to remove.
        :type listener: |RunControlListener|
        """
        raise NotImplementedError("Abstract method")


class RunControlError(Exception):
    """RunControl error class interface."""
    pass


class RunControlISA(object):
    """Instruction Set Architecture.

    :param props: The properties to initialise object with. See
                  `Instruction Set Architecture Properties`_.
    :type props: |dict|
    """
    def __init__(self, props):
        self._properties = props or {}

    def __repr__(self):
        return self.__class__.__name__ + '(' + str(self.getProperties()) + ')'

    def __str__(self):
        res = self.__class__.__name__ + ' ['
        res += 'Name=' + str(self.getName()) + ', '
        res += 'Address=' + str(self.getAddress()) + ', '
        res += ISA_SIZE + '=' + str(self.getSize()) + ', '
        res += ISA_ALIGNMENT + '=' + str(self.getAlignment()) + ', '
        res += ISA_MAX_INSTRUCTION_SIZE + '='
        res += str(self.getMaxInstructionSize()) + ', '
        res += 'Default=' + str(self.getDefault())
        res += ']'
        return res

    def getAddress(self):
        """Get the address this ISA is defined at.

        :returns: An |int| representing the address at which this ISA is
                  defined, or **0** if it is not known.
        """
        return self._properties.get(ISA_ADDRESS, 0)

    def getAlignment(self):
        """Get the address alignment for this ISA.

        :returns: An |int| representing the address alignment for this ISA, or
                  **0** if it is not known.
        """
        return self._properties.get(ISA_ALIGNMENT, 0)

    def getDefault(self):
        """Get the default name of this ISA.

        :returns: A |basestring| representing the default name of this ISA,
                  or **None** if it is not known.
        """
        return self._properties.get(ISA_DEFAULT, None)

    def getMaxInstructionSize(self):
        """Get the maximum size of an instruction for this ISA.

        :returns: An |int| representing the maximum instruction size for this
                  ISA, or **0** if it is not known.
        """
        return self._properties.get(ISA_MAX_INSTRUCTION_SIZE, 0)

    def getName(self):
        """Get the name of this ISA.

        :returns: A |basestring| representing the name of this ISA, or **None**
                  if it is not known.
        """
        return self._properties.get(ISA_NAME, None)

    def getProperties(self):
        """Get the properties defining this ISA.

        :returns: A |dict| representing all the defined properties for this
                  ISA.
        """
        return self._properties

    def getSize(self):
        """Get the size of this ISA.

        Starting from |getAddress|, this ISA is valid only for |getSize| bytes.
        Another |getISA| request should be performed for further addresses.

        :returns: An |int| representing the size for this ISA, or **0** if it
                  is not known.
        """
        return self._properties.get(ISA_MAX_INSTRUCTION_SIZE, 0)


class DoneGetISA(object):
    """Client call back interface for |getISA|."""
    def doneGetISA(self, token, error, isa):
        """Called when |getISA| command execution is complete.

        :param token: Pending command handle.
        :param error: Command execution error or **None**.
        :param isa: A |RunControlISA| object result of the request.
        :type isa: |RunControlISA|
        """
        pass


class DoneGetState(object):
    """Client call back interface for |getState|."""
    def doneGetState(self, token, error, suspended, pc, reason, params):
        """Called when |getState| command execution is complete.

        :param token: Pending command handle.
        :param error: Pommand execution error or **None**.
        :param suspended: **True** if the context is suspended.
        :type suspended: |bool|
        :param pc: Program counter of the context (if suspended).
        :type pc: |int|
        :param reason: Suspend reason (if suspended), see `State Reasons`_.
        :type reason: |basestring|
        :param params: Additional target specific data about context state,
                       see `State Optional Parameters`_.
        :type params: |dict|
        """
        pass


class DoneCommand():
    """Client call back interface for |detach|, |resume|, |suspend| and
    |terminate|."""

    def doneCommand(self, token, error):
        """Called when run control command execution is complete.

        :param token: Pending command handle.
        :param error: Command execution error or **None**.
        """
        pass


class DoneGetContext():
    "Client callback interface for |getContext|."

    def doneGetContext(self, token, error, context):
        """Called when context data retrieval is done.

        :param token: Pending command handle.
        :param error: Error description if operation failed, **None** if
                      succeeded.
        :param context: Context data.
        :type context: |RunControlContext|
        """
        pass


class DoneGetChildren(object):
    """Client callback interface for |getChildren|."""

    def doneGetChildren(self, token, error, context_ids):
        """Called when context list retrieval is done.

        :param token: Pending command handle.
        :param error: Error description if operation failed, **None** if
                      succeeded.
        :param context_ids: array of available context IDs.
        :type context_ids: |list|
        """
        pass


class RunControlContext(object):
    """A context corresponds to an execution thread, process, address space,
    etc.

    A context can belong to a parent context. Contexts hierarchy can be simple
    plain list or it can form a tree. It is up to target agent developers to
    choose layout that is most descriptive for a given target. Context IDs are
    valid across all services. In other words, all services access same
    hierarchy of contexts, with same IDs, however, each service accesses its
    own subset of context's attributes and functionality, which is relevant to
    that service.

    :param props: a `dict` of properties to initialise this RunControl context
                  with. See all the `RunControl Context Properties`_ constants.
    """
    def __init__(self, props):
        self._props = props or {}

    def __str__(self):
        return "[Run Control Context %s]" % self._props

    def getProperties(self):
        """Get context properties.

        See `RunControl Context Properties`_ definitions for property names.

        Context properties are read only, clients should not try to modify
        them.

        :returns: A |dict| of context properties.
        """
        return self._props

    def getID(self):
        """Retrieve context ID.

        :returns: A |basestring| representing this RunControl context ID.
        """
        return self._props.get(PROP_ID)

    def getParentID(self):
        """Retrieve parent context ID.

        :returns: A |basestring| representing this RunControl parent context
                  ID or **None**.
        """
        return self._props.get(PROP_PARENT_ID)

    def getProcessID(self):
        """Retrieve context process ID.

        :returns: A |basestring| representing this RunControl process ID. This
                  value is also meant to be the ID of the |MemoryContext|
                  this RunControl context belongs to.
        """
        return self._props.get(PROP_PROCESS_ID)

    def getCreatorID(self):
        """Retrieve context creator ID.

        :returns: A |basestring| representing this RunControl creator context
                  ID or **None**.
        """
        return self._props.get(PROP_CREATOR_ID)

    def getName(self):
        """Retrieve human readable context name.

        :returns: A |basestring| representing this RunControl context name or
                  **None**
        """
        return self._props.get(PROP_NAME)

    def isContainer(self):
        """Check if this context is a RunControl Context container.

        Executing resume or suspend command on a container causes all its
        children to resume or suspend.

        :returns: A |bool| stating if this context is a container or not.
        """
        return self._props.get(PROP_IS_CONTAINER)

    def hasState(self):
        """Check if this context has a state.

        Only context that has a state can be resumed or suspended.

        :returns: A |bool| stating if this context has a state or not.
        """
        return self._props.get(PROP_HAS_STATE)

    def canSuspend(self):
        """Check if this context can be suspended.

        Value **True** means suspend command is supported by the context,
        however the method does not check that the command can be executed
        successfully in the current state of the context. For example, the
        command still can fail if context is already suspended.

        :return: A |bool| stating if this context can be suspended or not.
        """
        return self._props.get(PROP_CAN_SUSPEND)

    def canResume(self, mode):
        """Check if this context can resume with given *mode*.

        Value **True** means resume command is supported by the context,
        however the method does not check that the command can be executed
        successfully in the current state of the context. For example, the
        command still can fail if context is already resumed.

        :param mode: Resume mode. See `Resume Modes`_.
        :type mode: |int|

        :returns: A |bool| stating if this context can resume with given
                  *mode*.
        """
        b = self._props.get(PROP_CAN_RESUME) or 0
        return (b & (1 << mode)) != 0

    def canCount(self, mode):
        """Check if context can count resumes of given *mode*.

        Value **True** means resume command with count other than 1 is
        supported by the context, however the method does not check that the
        command can be executed successfully in the current state of the
        context. For example, the command still can fail if context is already
        resumed.

        :param mode: Resume mode. See `Resume Modes`_.
        :type mode: |int|

        :returns: A |bool| stating if this context can count resumes on given
                  *mode*.
        """
        b = self._props.get(PROP_CAN_COUNT) or 0
        return (b & (1 << mode)) != 0

    def canTerminate(self):
        """Check if context can be terminated.

        Value **True** means terminate command is supported by the context,
        however the method does not check that the command can be executed
        successfully in the current state of the context. For example, the
        command still can fail if context is already exited.

        :returns: A |bool| stating if this context can be terminated.
        """
        return self._props.get(PROP_CAN_TERMINATE)

    def getRCGroup(self):
        """Get the context RunControl Group ID.

        The RunContol Group ID is the context ID of a run control group that
        contains the context.

        Members of same group are always suspended and resumed together:
        resuming/suspending a context resumes/suspends all members of the
        group.

        :returns: A |basestring| representing this context RC group or
                  **None**.
        """
        return self._props.get(PROP_RC_GROUP)

    def getBPGroup(self):
        """Get this context Breakpoints group ID.

        The Breakpoints group ID is the context ID of a breakpoints group that
        contains the context.

        Members of same group share same breakpoint instances: a breakpoint is
        planted once for the group, no need to plant the breakpoint for each
        member of the group

        :returns: A |basestring| representing this context Breakpoints group
                  ID, or **None** if the context does not support breakpoints.
        """
        return self._props.get(PROP_BP_GROUP)

    def getSymbolsGroup(self):
        """Get this context Symbols group ID.

        The Symbols group ID is the context ID of a symbols group that contains
        the context.

        Members of a symbols group share same symbol reader configuration
        settings, like user defined memory map entries and source lookup info.

        :returns: A |basestring| representing this context Symbols group ID, or
                  **None** if the context is not a member of a symbols group.
        """
        return self._props.get(PROP_SYMBOLS_GROUP)

    def canDetach(self):
        """Check if this context can be detached.

        Value **True** means detach command is supported by the context,
        however the method does not check that the command can be executed
        successfully in the current state of the context. For example, the
        command still can fail if the context already has exited.

        :returns: A |bool| stating if this context can be detached or not.
        """
        return self._props.get(PROP_CAN_DETACH)

    def detach(self, done):
        """Send a command to detach a context.

        :param done: Command result call back object
        :type done: |DoneCommand|

        :returns: Pending command handle, can be used to cancel the command.
        """
        raise NotImplementedError("Abstract method")

    def getISA(self, address, done):
        """Send a command to retrieve current Instruction Set Architecture of a
        context.

        :param address: The memory address to get ISA for.
        :type address: |int|
        :param done: Command result call back object.
        :type done: |DoneGetISA|

        :returns: Pending command handle, can be used to cancel the command.
        """
        raise NotImplementedError("Abstract method")

    def getState(self, done):
        """Send a command to retrieve current state of a context.

        :param done: Command result call back object.
        :type done: |DoneGetState|

        :returns: Pending command handle, can be used to cancel the command.
        """
        raise NotImplementedError("Abstract method")

    def suspend(self, done):
        """Send a command to suspend a context.

        Also suspends children if context is a container.

        :param done: Command result call back object.
        :type done: |DoneCommand|

        :returns: Pending command handle, can be used to cancel the command.
        """
        raise NotImplementedError("Abstract method")

    def resume(self, mode, count, params, done):
        """Send a command to resume a context.

        Also resumes children if context is a container.

        :param mode: Defines how to resume the context. See `Resume Modes`.
        :type mode: |int|
        :param count: If mode implies stepping, defines how many steps to
                      perform.
        :type count: |int|
        :param params: Resume parameters, for example, step range definition,
                       see `Resume Optional Parameters`_.
        :type params: |dict|
        :param done: command result call back object
        :type done: |DoneCommand|

        :returns: Pending command handle, can be used to cancel the command.
        """
        raise NotImplementedError("Abstract method")

    def terminate(self, done):
        """Send a command to terminate a context.

        :param done: Command result call back object.
        :type done: |DoneCommand|

        :returns: Pending command handle, can be used to cancel the command.
        """
        raise NotImplementedError("Abstract method")


class RunControlListener(object):
    """RunControl service events listener interface."""

    def contextAdded(self, contexts):
        """Called when new contexts are created.

        :param contexts: List of new context properties. A |RunControlContext|
                         can be initialised with those |dict| properties.
        :type contexts: |list| of |dict|
        """
        pass

    def contextChanged(self, contexts):
        """Called when a context properties changed.

        :param contexts: List of new context properties. A `RunControlContext`
                         can be initialised with those |dict| properties.
        :type contexts: |list| of |dict|
        """
        pass

    def contextRemoved(self, context_ids):
        """Called when contexts are removed.

        :param context_ids: List of removed context IDs.
        :type context_ids: |list|
        """
        pass

    def contextStateChanged(self, context):
        """Called when context state changes and the context is not and was not
        in suspended state.

        Changes to and from suspended state should be reported by other events:
        contextSuspended, contextResumed, containerSuspended, containerResumed.

        :param context: ID of a context that changed state.
        :type context: |basestring|
        """
        pass

    def contextSuspended(self, context, pc, reason, params):
        """Called when a thread is suspended.

        :param context: ID of a context that was suspended.
        :type context: |basestring|
        :param pc: Program counter of the context.
        :type pc: |int| or **None**
        :param reason: Human readable description of suspend reason. See
                       `State Reasons`_.
        :type reason: |basestring|
        :param params: Additional, target specific data about suspended
                       context. See `State Optional Parameters`_.
        :type params: |dict|
        """
        pass

    def contextResumed(self, context):
        """Called when a thread is resumed.

        :param context: ID of a context that was resumed.
        :type context: |basestring|
        """
        pass

    def containerSuspended(self, context, pc, reason, params, suspended_ids):
        """Called when target simultaneously suspends multiple threads in a
        container (process, core, etc.).

        :param context: ID of a context responsible for the event. It can be
                        container ID or any one of container children, for
                        example, it can be thread that hit "suspend all"
                        breakpoint. Client expected to move focus (selection)
                        to this context.
        :type context: |basestring|
        :param pc: program counter of the context.
        :type pc: |int|
        :param reason: Suspend reason, see `State Reasons`_.
        :type reason: |basestring|
        :param params: Additional target specific data about context state,
                       see `State Reasons`_.
        :type params: |dict|
        :param suspended_ids: full list of all contexts that were suspended.
        :type suspended_ids: |list|
        """
        pass

    def containerResumed(self, context_ids):
        """Called when target simultaneously resumes multiple threads in a
        container (process, core, etc.).

        :param context_ids: Full list of all contexts that were resumed.
        :type context_ids: |list|
        """
        pass

    def contextException(self, context, msg):
        """Called when an exception is detected in a target thread.

        :param context: ID of a context that caused an exception.
        :type context: |basestring|
        :param msg: Human readable description of the exception.
        :type msg: |basestring|
        """
        pass

Back to the top