Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 46de260025ea334d648b6562be32d50f177fe7fc (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
# *******************************************************************************
# * Copyright (c) 2011 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
# *******************************************************************************

"""
Expressions service allows TCF client to perform expression evaluation on remote target.
The service can be used to retrieve or modify values of variables or any data structures in remote target memory.
"""

import exceptions
from tcf import services

# Service name.
NAME = "Expressions"

class Expression(object):
    """
    Expression object represent an expression that can be evaluated by remote target.
    It has a unique ID and contains all information necessary to compute a value.
    The object data usually includes:
      1. process, thread or stack frame ID that should be used to resolve symbol names
      2. a script that can compute a value, like "x.y + z"
    """
    def __init__(self, props):
        self._props = props or {}

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

    def getID(self):
        """
        Get context ID.
        @return context ID.
        """
        return self._props.get(PROP_ID)

    def getParentID(self):
        """
        Get parent context ID.
        @return parent context ID.
        """
        return self._props.get(PROP_PARENT_ID)

    def getLanguage(self):
        """
        Get expression script language ID.
        @return language ID.
        """
        return self._props.get(PROP_LANGUAGE)

    def getExpression(self):
        """
        Return expression string - the script part of the context.
        @return expression script string
        """
        return self._props.get(PROP_EXPRESSION)

    def getSymbolID(self):
        """
        Return symbol ID if the expression represents a symbol (e.g. local variable).
        @return symbol ID
        """
        return self._props.get(PROP_SYMBOL_ID)

    def getBits(self):
        """
        Get size of expression value in bits.
        Can be 0 if value size is even number of bytes, use getSize() in such case.
        @return size in bits.
        """
        return self._props.get(PROP_BITS, 0)

    def getSize(self):
        """
        Get size in bytes. The size can include extra (unused) bits.
        This is "static" or "declared" size - as determined by expression type.
        @return size in bytes.
        """
        return self._props.get(PROP_SIZE, 0)

    def getTypeID(self):
        """
        Get expression type ID. Symbols service can be used to get type properties.
        This is "static" or "declared" type ID, actual type of a value can be different -
        if expression language supports dynamic typing.
        @return type ID.
        """
        return self._props.get(PROP_TYPE)

    def canAssign(self):
        """
        Check if the expression can be assigned a new value.
        @return true if can assign.
        """
        return self._props.get(PROP_CAN_ASSIGN)

    def getProperties(self):
        """
        Get complete map of context properties.
        @return map of context properties.
        """
        return self._props

# Expression context property names.
PROP_ID = "ID"
PROP_PARENT_ID = "ParentID"
PROP_SYMBOL_ID = "SymbolID"
PROP_LANGUAGE = "Language"
PROP_EXPRESSION = "Expression"
PROP_BITS = "Bits"
PROP_SIZE = "Size"
PROP_TYPE = "Type"
PROP_CAN_ASSIGN = "CanAssign"

class Value(object):
    """
    Value represents result of expression evaluation.
    Note that same expression can be evaluated multiple times with different results.
    """
    def __init__(self, value, props):
        self._value = value
        self._props = props or {}

    def __str__(self):
        return "[Expression Value %s %s]" % (self._value, self._props)

    def getTypeClass(self):
        """
        Get value type class.
        @see symbols.TypeClass
        @return type class
        """
        return self._props.get(VAL_CLASS, 0)

    def getTypeID(self):
        """
        Get value type ID. Symbols service can be used to get type properties.
        @return type ID.
        """
        return self._props.get(VAL_TYPE)

    def isBigEndian(self):
        """
        Check endianness of the values.
        Big-endian means decreasing numeric significance with increasing byte number.
        @return true if big-endian.
        """
        return self._props.get(VAL_BIG_ENDIAN)

    def getValue(self):
        """
        Get value as array of bytes.
        @return value as array of bytes.
        """
        return self._value

    def getProperties(self):
        """
        Get complete map of value properties.
        @return map of value properties.
        """
        return self._props

# Expression value property names.
VAL_CLASS = "Class"
VAL_TYPE = "Type"
VAL_BIG_ENDIAN = "BigEndian"

class ExpressionsService(services.Service):
    def getName(self):
        return NAME
    
    def getContext(self, id, done):
        """
        Retrieve expression context info for given context ID.
        @see Expression
        
        @param id - context ID.
        @param done - call back interface called when operation is completed.
        @return - pending command handle.
        """
        raise exceptions.NotImplementedError("Abstract method")

    def getChildren(self, parent_context_id, done):
        """
        Retrieve children IDs for given parent ID.
        Meaning of the operation depends on parent kind:
        1. expression with type of a struct, union, or class - fields
        2. expression with type of an enumeration - enumerators
        3. expression with type of an array - array elements
        4. stack frame - function arguments and local variables
        5. thread - top stack frame function arguments and local variables
        6. process - global variables
        
        Children list *does not* include IDs of expressions that were created by clients
        using "create" command.
        
        @param parent_context_id - parent context ID.
        @param done - call back interface called when operation is completed.
        @return - pending command handle.
        """
        raise exceptions.NotImplementedError("Abstract method")

    def create(self, parent_id, language, expression, done):
        """
        Create an expression context.
        The context should be disposed after use.
        @param parent_id - a context ID that can be used to resolve symbol names.
        @param language - language of expression script, None means default language
        @param expression - expression script
        @param done - call back interface called when operation is completed.
        @return - pending command handle.
        """
        raise exceptions.NotImplementedError("Abstract method")

    def dispose(self, id, done):
        """
        Dispose an expression context that was created by create()
        @param id - the expression context ID
        @param done - call back interface called when operation is completed.
        @return - pending command handle.
        """
        raise exceptions.NotImplementedError("Abstract method")

    def evaluate(self, id, done):
        """
        Evaluate value of an expression context.
        @param id - the expression context ID
        @param done - call back interface called when operation is completed.
        @return - pending command handle.
        """
        raise exceptions.NotImplementedError("Abstract method")

    def assign(self, id, value, done):
        """
        Assign a value to memory location determined by an expression.
        @param id - expression ID.
        @param value - value as an array of bytes.
        @param done - call back interface called when operation is completed.
        @return - pending command handle.
        """
        raise exceptions.NotImplementedError("Abstract method")

    def addListener(self, listener):
        """
        Add expressions service event listener.
        @param listener - event listener implementation.
        """
        raise exceptions.NotImplementedError("Abstract method")

    def removeListener(self, listener):
        """
        Remove expressions service event listener.
        @param listener - event listener implementation.
        """
        raise exceptions.NotImplementedError("Abstract method")

class DoneGetContext(object):
    """
    Client call back interface for getContext().
    """
    def doneGetContext(self, token, error, context):
        """
        Called when context data retrieval is done.
        @param token - command handle
        @param error - error description if operation failed, None if succeeded.
        @param context - context properties.
        """
        pass

class DoneGetChildren(object):
    """
    Client call back interface for getChildren().
    """
    def doneGetChildren(self, token, error, context_ids):
        """
        Called when context list retrieval is done.
        @param token - command handle
        @param error - error description if operation failed, None if succeeded.
        @param context_ids - array of available context IDs.
        """
        pass


class DoneCreate(object):
    """
    Client call back interface for create().
    """
    def doneCreate(self, token, error, context):
        """
        Called when context create context command is done.
        @param token - command handle
        @param error - error description if operation failed, None if succeeded.
        @param context - context properties.
        """
        pass

class DoneDispose(object):
    """
    Client call back interface for dispose().
    """
    def doneDispose(self, token, error):
        """
        Called when context dispose command is done.
        @param token - command handle
        @param error - error description if operation failed, None if succeeded.
        """
        pass

class DoneEvaluate(object):
    """
    Client call back interface for evaluate().
    """
    def doneEvaluate(self, token, error, value):
        """
        Called when context dispose command is done.
        @param token - command handle
        @param error - error description if operation failed, None if succeeded.
        @param value - expression evaluation result
        """
        pass

class DoneAssign(object):
    """
    Client call back interface for assign().
    """
    def doneAssign(self, token, error):
        """
        Called when assign command is done.
        @param token - command handle
        @param error - error description if operation failed, None if succeeded.
        """
        pass

class ExpressionsListener(object):
    """
    Registers event listener is notified when registers context hierarchy
    changes, and when a register is modified by the service commands.
    """
    def valueChanged(self, id):
        """
        Called when expression value was changed and clients
        need to update themselves. Clients, at least, should invalidate
        corresponding cached expression data.
        Not every change is notified - it is not possible,
        only those, which are not caused by normal execution of the debuggee.
        At least, changes caused by "assign" command should be notified.
        @param id - expression context ID.
        """
        pass

Back to the top