diff options
Diffstat (limited to 'docs/TCF Service - Memory.html')
| -rw-r--r-- | docs/TCF Service - Memory.html | 370 |
1 files changed, 185 insertions, 185 deletions
diff --git a/docs/TCF Service - Memory.html b/docs/TCF Service - Memory.html index afca975ea..199a474eb 100644 --- a/docs/TCF Service - Memory.html +++ b/docs/TCF Service - Memory.html @@ -35,15 +35,15 @@ in addition to error report, describes data validity on per byte basis:</p> <pre><b><font face="Courier New" size=2 color=#333399> <i><array of error addresses></i> - <font face=Wingdings>Ψ</font> null - <font face=Wingdings>Ψ</font> [ <i><error address list></i> ] + ⇒ null + ⇒ [ <i><error address list></i> ] <i><error address list></i> - <font face=Wingdings>Ψ</font> <i><error address></i> - <font face=Wingdings>Ψ</font> <i><error address list></i> , <i><error address></i> + ⇒ <i><error address></i> + ⇒ <i><error address list></i> , <i><error address></i> <i><error address></i> - <font face=Wingdings>Ψ</font> { "addr" : <i><int: range starting address></i> , "size" : <i><int: range length in bytes></i> , "stat" : <i><int: status code></i> , "msg" : <i><error description></i> } + ⇒ { "addr" : <i><int: range starting address></i> , "size" : <i><int: range length in bytes></i> , "stat" : <i><int: status code></i> , "msg" : <i><error description></i> } </font></b></pre> <p>If there is no entry in error addresses array for a data byte, then status of such @@ -51,10 +51,10 @@ byte is defined by main error report.</p> <p>Status code is bitwise or of status flags:</p> <dl> - <dt><code><b>BYTE_VALID = 0x00</b></code> <dd>no error for this byte - <dt><code><b>BYTE_UNKNOWN = 0x01</b></code> <dd>status is unknown - <dt><code><b>BYTE_INVALID = 0x02</b></code> <dd>byte value in invalid, error message describes the problem - <dt><code><b>BYTE_CANNOT_READ = 0x04</b></code> <dd>cannot read the byte + <dt><code><b>BYTE_VALID = 0x00</b></code> <dd>no error for this byte + <dt><code><b>BYTE_UNKNOWN = 0x01</b></code> <dd>status is unknown + <dt><code><b>BYTE_INVALID = 0x02</b></code> <dd>byte value in invalid, error message describes the problem + <dt><code><b>BYTE_CANNOT_READ = 0x04</b></code> <dd>cannot read the byte <dt><code><b>BYTE_CANNOT_WRITE = 0x08</b></code> <dd>cannot write the byte </dl> @@ -63,7 +63,7 @@ byte is defined by main error report.</p> <h3><a name='CmdGetContext'>Get Context</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C <i><token></i> Memory getContext <i><string: context ID></i> +C • <i><token></i> • Memory • getContext • <i><string: context ID></i> • </font></b></pre> <p>The command retrieves context info for given context ID. A context corresponds to an @@ -90,11 +90,11 @@ that is:</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R <i><token></i> <i><error report></i> <i><context data></i> +R • <i><token></i> • <i><error report></i> • <i><context data></i> • <i><context data></i> - <font face=Wingdings>Ψ</font> null - <font face=Wingdings>Ψ</font> <i><object></i> + ⇒ null + ⇒ <i><object></i> </font></b></pre> <p>Context data object should, at least, contain member @@ -120,12 +120,12 @@ Service sends contextChanged event to notify changes in context data.</p> <h3><a name='CmdGetChildren'>Get Children</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C <i><token></i> Memory getChildren <i><string: parent context ID></i> +C • <i><token></i> • Memory • getChildren • <i><string: parent context ID></i> • </font></b></pre> <p>The command requests a list of contexts available for memory access commands.</p> -<p>Parent context ID can be null to retrieve top level of the hierarchy, can be one +<p>Parent context ID can be null – to retrieve top level of the hierarchy, can be one of context IDs retrieved by previous getChildren commands, or it can be obtained from another service. 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.</p> @@ -133,25 +133,25 @@ choose layout that is most descriptive for a given target.</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R <i><token></i> <i><error report></i> <i><array of context IDs></i> <i></i> +R • <i><token></i> • <i><error report></i> • <i><array of context IDs></i> •<i></i> <i><array of context IDs></i> - <font face=Wingdings>Ψ</font> null - <font face=Wingdings>Ψ</font> [ ] - <font face=Wingdings>Ψ</font> [ <i><context ID list></i> ] + ⇒ null + ⇒ [ ] + ⇒ [ <i><context ID list></i> ] <i><context ID list></i> - <font face=Wingdings>Ψ</font> <i><string: context ID></i> - <font face=Wingdings>Ψ</font> <i><context ID list></i> , <i><string: context ID></i> + ⇒ <i><string: context ID></i> + ⇒ <i><context ID list></i> , <i><string: context ID></i> </font></b></pre> <h3><a name='CmdSetMemory'>Set Memory</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C <token> Memory set - <i><string: context ID></i> <i><int: address></i> <i><int: word size></i> - <i><int: byte count></i> <i><int: mode></i> <i><string: BASE64 encoded byte array></i> +C • <token> • Memory • set • + <i><string: context ID></i> • <i><int: address></i> • <i><int: word size></i> • + <i><int: byte count></i> • <i><int: mode></i> • <i><string: BASE64 encoded byte array></i> • </font></b></pre> <p>Writes data bytes at given address in memory, "word size" bytes at a time. Address @@ -159,15 +159,15 @@ should be aligned by "word size". Context ID must be one returned by getContexts Mode is logical OR of any combination of:</p> <ul type='disc'> - <li>0x1 continue on error (like bus error or page fault) + <li>0x1 – continue on error (like bus error or page fault) - <li>0x2 verify data after writing by reading back and compare + <li>0x2 – verify data after writing by reading back and compare </ul> <p>Result message:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R <i><token></i> <i><error report></i> <i><array of error addresses></i> +R • <i><token></i> • <i><error report></i> • <i><array of error addresses></i> • </font></b></pre> <p>Error report provides integer error code and a short, human readable explanation @@ -177,9 +177,9 @@ to be written into memory.</p> <h3><a name='CmdGetMemory'>Get Memory</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C <token> Memory get - <i><string: context ID></i> <i><int: address></i> <i><int: word size></i> - <i><int: byte count></i> <i><int: mode></i> +C • <token> • Memory • get • + <i><string: context ID></i> • <i><int: address></i> • <i><int: word size></i> • + <i><int: byte count></i> • <i><int: mode></i> • </font></b></pre> <p>Reads data bytes at given address in memory, "word size" bytes at a time. Address @@ -187,15 +187,15 @@ should be aligned by "word size". Context ID must be one returned by getContexts Mode is logical OR of any combination of:</p> <ul type='disc'> - <li>0x1 continue on error (like bus error or page fault) + <li>0x1 – continue on error (like bus error or page fault) - <li>0x2 verify data after reading by re-reading and compare + <li>0x2 – verify data after reading by re-reading and compare </ul> <p>Result message:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R <i><token></i> <i><string: BASE64 encoded byte array></i> <i><error report></i> <i><array of error addresses></i> +R • <i><token></i> • <i><string: BASE64 encoded byte array></i> • <i><error report></i> • <i><array of error addresses></i> • </font></b></pre> <p>Error report provides integer error code and a short, human readable explanation @@ -205,9 +205,9 @@ to be retrieved from memory.</p> <h3><a name='CmdFillMemory'>Fill Memory</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C <token> Memory fill - <i><string: context ID></i> <i><int: address></i> <i><int: word size></i> - <int: byte count> <i><int: mode></i> <i><array: array of pattern bytes></i> +C • <token> • Memory • fill • + <i><string: context ID></i> • <i><int: address></i> • <i><int: word size></i> • + <int: byte count> • <i><int: mode></i> • <i><array: array of pattern bytes></i> • </font></b></pre> <p>Writes pattern bytes at given address in memory, "word size" bytes at a time. Address @@ -216,15 +216,15 @@ pattern is repeated necessary number of times. Context ID must be one returned b getContexts. Mode is logical OR of any combination of:</p> <ul type='disc'> - <li>0x1 continue on error (like bus error or page fault) + <li>0x1 – continue on error (like bus error or page fault) - <li>0x2 verify data after writing by reading back and compare + <li>0x2 – verify data after writing by reading back and compare </ul> <p>Result message:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R <i><token></i> <i><error report></i> <i><array of error addresses></i> +R • <i><token></i> • <i><error report></i> • <i><array of error addresses></i> • </font></b></pre> <p>Error report provides integer error code and a short, human readable explanation @@ -237,30 +237,30 @@ to be written into memory.</p> or changed, and when memory content is altered by "set" or "fill" commands.</p> <pre><b><font face="Courier New" size=2 color=#333399> -E Memory contextAdded <i><array of context data></i> -E Memory contextChanged <i><array of context data></i> -E Memory contextRemoved <i><array of context IDs></i> -E Memory memoryChanged <i><string: context ID></i> <i><array of address ranges></i> +E • Memory • contextAdded • <i><array of context data></i> • +E • Memory • contextChanged • <i><array of context data></i> • +E • Memory • contextRemoved • <i><array of context IDs></i> • +E • Memory • memoryChanged • <i><string: context ID></i> • <i><array of address ranges></i> • <i><array of context data></i> <font face="Times New Roman" size=3>- see Get Contexts command.</font> <i><array of context IDs></i> - <font face=Wingdings>Ψ</font> [ <i><context ID list></i> ] + ⇒ [ <i><context ID list></i> ] <i><context ID list></i> - <font face=Wingdings>Ψ</font> <i><string: context ID></i> - <font face=Wingdings>Ψ</font> <i><context ID list></i> , <i><string: context ID></i> + ⇒ <i><string: context ID></i> + ⇒ <i><context ID list></i> , <i><string: context ID></i> <i><array of address ranges></i> - <font face=Wingdings>Ψ</font> null - <font face=Wingdings>Ψ</font> [ <i><address ranges list></i> ] + ⇒ null + ⇒ [ <i><address ranges list></i> ] <i><address ranges list></i> - <font face=Wingdings>Ψ</font> <i><address range></i> - <font face=Wingdings>Ψ</font> <i><address ranges list></i> , <i><address range></i> + ⇒ <i><address range></i> + ⇒ <i><address ranges list></i> , <i><address range></i> <i><address range></i> - <font face=Wingdings>Ψ</font> { "addr" : <i><int: range starting address></i> , "size" : <i><int: range length in bytes></i> } + ⇒ { "addr" : <i><int: range starting address></i> , "size" : <i><int: range length in bytes></i> } </font></b></pre> <h2><a name='API'>API</a></h2> @@ -276,19 +276,19 @@ E Memory memoryChanged <i><string: context ID></i> <i><array of <font color=#3F5FBF>/** * Retrieve context info for given context ID. * - * <font color=#7F9FBF>@param</font> id context ID. + * <font color=#7F9FBF>@param</font> id – context ID. * <font color=#7F9FBF>@param</font> done - callback interface called when operation is completed. - */</font> + */</font> IToken getContext(String id, DoneGetContext done); <font color=#3F5FBF>/** * Client callback interface for getContext(). - */</font> + */</font> <font color=#7F0055>interface</font> DoneGetContext { <font color=#3F5FBF>/** * Called when contexts data retrieval is done. - * <font color=#7F9FBF>@param</font> error error description if operation failed, null if succeeded. - * <font color=#7F9FBF>@param</font> context context data. + * <font color=#7F9FBF>@param</font> error – error description if operation failed, null if succeeded. + * <font color=#7F9FBF>@param</font> context – context data. */</font> <font color=#7F0055>void</font> doneGetContext(IToken token, Exception error, MemoryContext context); } @@ -303,7 +303,7 @@ E Memory memoryChanged <i><string: context ID></i> <i><array of * with same IDs, however, each service accesses its own subset of context's * attributes and functionality, which is relevant to that service. * - * <font color=#7F9FBF>@param</font> parent_context_id parent context ID. Can be null + * <font color=#7F9FBF>@param</font> parent_context_id – parent context ID. Can be null – * to retrieve top level of the hierarchy, or one of context IDs retrieved * by previous getContexts commands. * <font color=#7F9FBF>@param</font> done - callback interface called when operation is completed. @@ -316,139 +316,139 @@ E Memory memoryChanged <i><string: context ID></i> <i><array of <font color=#7F0055>interface</font> DoneGetChildren { <font color=#3F5FBF>/** * Called when contexts data retrieval is done. - * <font color=#7F9FBF>@param</font> error error description if operation failed, null if succeeded. - * <font color=#7F9FBF>@param</font> contexts array of available context IDs. + * <font color=#7F9FBF>@param</font> error – error description if operation failed, null if succeeded. + * <font color=#7F9FBF>@param</font> contexts – array of available context IDs. */</font> <font color=#7F0055>void</font> doneGetChildren(IToken token, Exception error, String[] context_ids); } - <font color=#3F5FBF>/** - * Memory access mode: - * Carry on when some of the memory cannot be accessed and - * return MemoryError at the end if any of the bytes - * were not processed correctly. - */</font> - <font color=#7F0055>final static int</font> MODE_CONTINUEONERROR = 0x1; - - <font color=#3F5FBF>/** - * Memory access mode: - * Verify result of memory operations (by reading and comparing). - */</font> - <font color=#7F0055>final static int</font> MODE_VERIFY = 0x2; - - <font color=#7F0055>interface</font> MemoryContext { - - <font color=#3F5FBF>/** - * Retrieve context ID. - * Same as getProperties().get("id") - */</font> - String getID(); - - <font color=#3F5FBF>/** - * Return true if the context has children. - * Same as getProperties().get("has_children") - * Children can be retrieved by getContexts call. - */</font> - <font color=#7F0055>boolean</font> hasChildren(); - - <font color=#3F5FBF>/** - * Retrieve context properties. - */</font> - Map<String,Object> getProperties(); - - <font color=#3F5FBF>/** - * Set target memory. - * If 'word_size' is 0 it means client does not care about word size. - */</font> - <font color=#7F0055>void</font> set(long addr, <font color=#7F0055>int</font> word_size, byte[] buf, - <font color=#7F0055>int</font> offs, <font color=#7F0055>int</font> size, <font color=#7F0055>int</font> mode, DoneMemory done); - - <font color=#3F5FBF>/** - * Read target memory. - */</font> - <font color=#7F0055>void</font> get(long addr, <font color=#7F0055>int</font> word_size, byte[] buf, - <font color=#7F0055>int</font> offs, <font color=#7F0055>int</font> size, <font color=#7F0055>int</font> mode, DoneMemory done); - - <font color=#3F5FBF>/** - * Fill target memory with given pattern. - * 'size' is number of bytes to fill. - */</font> - <font color=#7F0055>void</font> fill(long addr, <font color=#7F0055>int</font> word_size, byte[] value, - <font color=#7F0055>int</font> size, <font color=#7F0055>int</font> mode, DoneMemory done); - - <font color=#3F5FBF>/** - * Client callback interface for set(), get() and fill(). - */</font> - <font color=#7F0055>interface</font> DoneMemory { - <font color=#7F0055>void</font> doneMemory(MemoryError error); - } - } - - <font color=#7F0055>class</font> MemoryError <font color=#7F0055>extends</font> Exception { - } + <font color=#3F5FBF>/** + * Memory access mode: + * Carry on when some of the memory cannot be accessed and + * return MemoryError at the end if any of the bytes + * were not processed correctly. + */</font> + <font color=#7F0055>final static int</font> MODE_CONTINUEONERROR = 0x1; + + <font color=#3F5FBF>/** + * Memory access mode: + * Verify result of memory operations (by reading and comparing). + */</font> + <font color=#7F0055>final static int</font> MODE_VERIFY = 0x2; + + <font color=#7F0055>interface</font> MemoryContext { + + <font color=#3F5FBF>/** + * Retrieve context ID. + * Same as getProperties().get("id") + */</font> + String getID(); + + <font color=#3F5FBF>/** + * Return true if the context has children. + * Same as getProperties().get("has_children") + * Children can be retrieved by getContexts call. + */</font> + <font color=#7F0055>boolean</font> hasChildren(); + + <font color=#3F5FBF>/** + * Retrieve context properties. + */</font> + Map<String,Object> getProperties(); + + <font color=#3F5FBF>/** + * Set target memory. + * If 'word_size' is 0 it means client does not care about word size. + */</font> + <font color=#7F0055>void</font> set(long addr, <font color=#7F0055>int</font> word_size, byte[] buf, + <font color=#7F0055>int</font> offs, <font color=#7F0055>int</font> size, <font color=#7F0055>int</font> mode, DoneMemory done); + + <font color=#3F5FBF>/** + * Read target memory. + */</font> + <font color=#7F0055>void</font> get(long addr, <font color=#7F0055>int</font> word_size, byte[] buf, + <font color=#7F0055>int</font> offs, <font color=#7F0055>int</font> size, <font color=#7F0055>int</font> mode, DoneMemory done); + + <font color=#3F5FBF>/** + * Fill target memory with given pattern. + * 'size' is number of bytes to fill. + */</font> + <font color=#7F0055>void</font> fill(long addr, <font color=#7F0055>int</font> word_size, byte[] value, + <font color=#7F0055>int</font> size, <font color=#7F0055>int</font> mode, DoneMemory done); + + <font color=#3F5FBF>/** + * Client callback interface for set(), get() and fill(). + */</font> + <font color=#7F0055>interface</font> DoneMemory { + <font color=#7F0055>void</font> doneMemory(MemoryError error); + } + } + + <font color=#7F0055>class</font> MemoryError <font color=#7F0055>extends</font> Exception { + } - <font color=#3F5FBF>/** - * ErrorOffset interface can be implemented by MemoryError object, - * which is returned by get, set and fill commands. - * - * get/set/fill () returns this exception when reading failed - * for some but not all bytes, and MODE_CONTINUEONERROR - * has been set in mode. (For example, when only part of the request - * translates to valid memory addresses.) - * Exception.getMessage can be used for generalized message of the - * possible reasons of partial memory operation. - */</font> - <font color=#7F0055>interface</font> ErrorOffset { - - // Error may have per byte information - <font color=#7F0055>final static int</font> - BYTE_VALID = 0x00, - BYTE_UNKNOWN = 0x01, // e.g. out of range - BYTE_INVALID = 0x02, - BYTE_CANNOT_READ = 0x04, - BYTE_CANNOT_WRITE = 0x08; - - <font color=#7F0055>int</font> getStatus(<font color=#7F0055>int</font> offset); - - <font color=#3F5FBF>/** - * Returns the detail message string about the - * byte associated with specified location. - * <font color=#7F9FBF>@return</font> the detail error message string. - */</font> - String getMessage(<font color=#7F0055>int</font> offset); - - } - - <font color=#7F0055>void</font> addListener(MemoryListener listener); - - <font color=#7F0055>interface</font> MemoryListener { - - <font color=#3F5FBF>/** - * Called when a new memory access context(s) is created. - */</font> - <font color=#7F0055>void</font> contextAdded(Context[] contexts); - - <font color=#3F5FBF>/** - * Called when a new memory access context(s) properties changed. - */</font> - <font color=#7F0055>void</font> contextChanged(Context[] contexts); - - <font color=#3F5FBF>/** - * Called when memory access context(s) is removed. - */</font> - <font color=#7F0055>void</font> contextRemoved(String[] context_ids); - - <font color=#3F5FBF>/** - * Called when target memory content was changed and clients - * need to update themselves. Clients, at least, should invalidate - * corresponding cached memory data. - * Not every change is notified - it is not possible, - * only those, which are not caused by normal execution of the debuggee. - * addr and size can be null if unknown. - */</font> - <font color=#7F0055>void</font> memoryChanged(String context_id, - long[] addr, long[] size); - } + <font color=#3F5FBF>/** + * ErrorOffset interface can be implemented by MemoryError object, + * which is returned by get, set and fill commands. + * + * get/set/fill () returns this exception when reading failed + * for some but not all bytes, and MODE_CONTINUEONERROR + * has been set in mode. (For example, when only part of the request + * translates to valid memory addresses.) + * Exception.getMessage can be used for generalized message of the + * possible reasons of partial memory operation. + */</font> + <font color=#7F0055>interface</font> ErrorOffset { + + // Error may have per byte information + <font color=#7F0055>final static int</font> + BYTE_VALID = 0x00, + BYTE_UNKNOWN = 0x01, // e.g. out of range + BYTE_INVALID = 0x02, + BYTE_CANNOT_READ = 0x04, + BYTE_CANNOT_WRITE = 0x08; + + <font color=#7F0055>int</font> getStatus(<font color=#7F0055>int</font> offset); + + <font color=#3F5FBF>/** + * Returns the detail message string about the + * byte associated with specified location. + * <font color=#7F9FBF>@return</font> the detail error message string. + */</font> + String getMessage(<font color=#7F0055>int</font> offset); + + } + + <font color=#7F0055>void</font> addListener(MemoryListener listener); + + <font color=#7F0055>interface</font> MemoryListener { + + <font color=#3F5FBF>/** + * Called when a new memory access context(s) is created. + */</font> + <font color=#7F0055>void</font> contextAdded(Context[] contexts); + + <font color=#3F5FBF>/** + * Called when a new memory access context(s) properties changed. + */</font> + <font color=#7F0055>void</font> contextChanged(Context[] contexts); + + <font color=#3F5FBF>/** + * Called when memory access context(s) is removed. + */</font> + <font color=#7F0055>void</font> contextRemoved(String[] context_ids); + + <font color=#3F5FBF>/** + * Called when target memory content was changed and clients + * need to update themselves. Clients, at least, should invalidate + * corresponding cached memory data. + * Not every change is notified - it is not possible, + * only those, which are not caused by normal execution of the debuggee. + * ‘addr’ and ‘size’ can be null if unknown. + */</font> + <font color=#7F0055>void</font> memoryChanged(String context_id, + long[] addr, long[] size); + } } </pre> |