1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>XED2: XED2 User Guide - Thu May 15 03:15:09 2008 </title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
7 <!-- Generated by Doxygen 1.4.6 -->
10 <li><a href="main.html"><span>Main Page</span></a></li>
11 <li><a href="modules.html"><span>Modules</span></a></li>
12 <li><a href="classes.html"><span>Data Structures</span></a></li>
13 <li><a href="files.html"><span>Files</span></a></li>
15 <form action="search.php" method="get">
16 <table cellspacing="0" cellpadding="0" border="0">
18 <td><label> <u>S</u>earch for </label></td>
19 <td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
25 <h1>Printing (disassembling) Instructions</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
26 There are two kinds of printers. The legacy printers to not take a void* context parameter. The other printers take a void* context parameter that is only passed to a callback function registered by calling <a class="el" href="group__PRINT.html#gd6a3477c164874ca5ac8654b6563082d">xed_register_disassembly_callback()</a>. The callback is used for symbolic disassembly.
28 <table border="0" cellpadding="0" cellspacing="0">
30 <tr><td colspan="2"><br><h2>Legacy printers without context parameter</h2></td></tr>
31 <tr><td class="memItemLeft" nowrap align="right" valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PRINT.html#g5a8149ea49b19f4967d20435f470b0f2">xed_format</a> (<a class="el" href="xed-syntax-enum_8h.html#226c37dc9f1af9e61dad79dc5f65bc9f">xed_syntax_enum_t</a> syntax, <a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> *xedd, char *out_buffer, int buffer_len, xed_uint64_t runtime_instruction_address)</td></tr>
33 <tr><td class="mdescLeft"> </td><td class="mdescRight">Disassemble the decoded instruction using the specified syntax. <a href="#g5a8149ea49b19f4967d20435f470b0f2"></a><br></td></tr>
34 <tr><td class="memItemLeft" nowrap align="right" valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PRINT.html#gd8d360fbecb021a4fc0c9d865e0b326d">xed_format_att</a> (<a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> *xedd, char *out_buffer, xed_uint32_t buffer_len, xed_uint64_t runtime_instruction_address)</td></tr>
36 <tr><td class="mdescLeft"> </td><td class="mdescRight">Disassemble the decoded instruction using the ATT SYSV syntax. <a href="#gd8d360fbecb021a4fc0c9d865e0b326d"></a><br></td></tr>
37 <tr><td class="memItemLeft" nowrap align="right" valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PRINT.html#gf8b71dad59c2cf235d339c612f66c4a4">xed_format_intel</a> (<a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> *xedd, char *out_buffer, xed_uint32_t buffer_len, xed_uint64_t runtime_instruction_address)</td></tr>
39 <tr><td class="mdescLeft"> </td><td class="mdescRight">Disassemble the decoded instruction using the Intel syntax. <a href="#gf8b71dad59c2cf235d339c612f66c4a4"></a><br></td></tr>
40 <tr><td class="memItemLeft" nowrap align="right" valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PRINT.html#g6d44153ee05618381828ff69e0c84b08">xed_format_xed</a> (<a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> *xedd, char *out_buffer, xed_uint32_t buffer_len, xed_uint64_t runtime_instruction_address)</td></tr>
42 <tr><td class="mdescLeft"> </td><td class="mdescRight">Disassemble the decoded instruction using the XED syntax providing all operand resources (implicit, explicit, suppressed). <a href="#g6d44153ee05618381828ff69e0c84b08"></a><br></td></tr>
43 <tr><td colspan="2"><br><h2>Printers with context parameter</h2></td></tr>
44 <tr><td class="memItemLeft" nowrap align="right" valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PRINT.html#gba00a6705b2c7c636d5f693eee83817f">xed_format_att_context</a> (<a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> *xedd, char *out_buffer, xed_uint32_t buffer_len, xed_uint64_t runtime_instruction_address, void *context)</td></tr>
46 <tr><td class="mdescLeft"> </td><td class="mdescRight">Disassemble the decoded instruction using the ATT SYSV syntax. <a href="#gba00a6705b2c7c636d5f693eee83817f"></a><br></td></tr>
47 <tr><td class="memItemLeft" nowrap align="right" valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PRINT.html#g55c8f699f25fdd6ee842593bd4c3ea7f">xed_format_context</a> (<a class="el" href="xed-syntax-enum_8h.html#226c37dc9f1af9e61dad79dc5f65bc9f">xed_syntax_enum_t</a> syntax, <a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> *xedd, char *out_buffer, int buffer_len, xed_uint64_t runtime_instruction_address, void *context)</td></tr>
49 <tr><td class="mdescLeft"> </td><td class="mdescRight">Disassemble the decoded instruction using the specified syntax. <a href="#g55c8f699f25fdd6ee842593bd4c3ea7f"></a><br></td></tr>
50 <tr><td class="memItemLeft" nowrap align="right" valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PRINT.html#gbc13aaaa26429bcb390fd2c776102206">xed_format_intel_context</a> (<a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> *xedd, char *out_buffer, xed_uint32_t buffer_len, xed_uint64_t runtime_instruction_address, void *context)</td></tr>
52 <tr><td class="mdescLeft"> </td><td class="mdescRight">Disassemble the decoded instruction using the Intel syntax. <a href="#gbc13aaaa26429bcb390fd2c776102206"></a><br></td></tr>
53 <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
54 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int XED_DLL_EXPORT(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PRINT.html#g58ce98693231e7865ff3525b816fe7f3">xed_disassembly_callback_fn_t</a> )(xed_uint64_t address, char *symbol_buffer, xed_uint32_t buffer_length, xed_uint64_t *offset, void *context)</td></tr>
56 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
57 <tr><td class="memItemLeft" nowrap align="right" valign="top">XED_DLL_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PRINT.html#gd6a3477c164874ca5ac8654b6563082d">xed_register_disassembly_callback</a> (<a class="el" href="group__PRINT.html#g58ce98693231e7865ff3525b816fe7f3">xed_disassembly_callback_fn_t</a> f)</td></tr>
59 <tr><td class="mdescLeft"> </td><td class="mdescRight">Register a disassembly call back function of type <a class="el" href="group__PRINT.html#g58ce98693231e7865ff3525b816fe7f3">xed_disassembly_callback_fn_t</a> to get called when the disassembler needs to get a symbol and offset for an address. <a href="#gd6a3477c164874ca5ac8654b6563082d"></a><br></td></tr>
61 <hr><h2>Typedef Documentation</h2>
62 <a class="anchor" name="g58ce98693231e7865ff3525b816fe7f3"></a><!-- doxytag: member="xed-disas.h::xed_disassembly_callback_fn_t" ref="g58ce98693231e7865ff3525b816fe7f3" args=")(xed_uint64_t address, char *symbol_buffer, xed_uint32_t buffer_length, xed_uint64_t *offset, void *context)" --><p>
63 <table class="mdTable" cellpadding="2" cellspacing="0">
66 <table cellpadding="0" cellspacing="0" border="0">
68 <td class="md" nowrap valign="top">typedef int XED_DLL_EXPORT(* <a class="el" href="group__PRINT.html#g58ce98693231e7865ff3525b816fe7f3">xed_disassembly_callback_fn_t</a>)(xed_uint64_t address, char *symbol_buffer, xed_uint32_t buffer_length, xed_uint64_t *offset, void *context) </td>
74 <table cellspacing="5" cellpadding="0" border="0">
82 <dl compact><dt><b>Parameters:</b></dt><dd>
83 <table border="0" cellspacing="2" cellpadding="0">
84 <tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>The input address for which we want symbolic name and offset </td></tr>
85 <tr><td valign="top"></td><td valign="top"><em>symbol_buffer</em> </td><td>A buffer to hold the symbol name. The callback function should fill this in and terminate with a null byte. </td></tr>
86 <tr><td valign="top"></td><td valign="top"><em>buffer_length</em> </td><td>The maximum length of the symbol_buffer including then null </td></tr>
87 <tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>A pointer to a xed_uint64_t to old the offset from the provided symbol. </td></tr>
88 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>This void* pointer passed to the disassembler's new interface so that the caller can identify the proper context against which to resolve the symbols. The disassembler passes this value to the callback. The legacy formatters that do not have context will pass zero for this parameter. </td></tr>
91 <dl compact><dt><b>Returns:</b></dt><dd>0 on failure, 1 on success. </dd></dl>
94 Definition at line <a class="el" href="xed-disas_8h-source.html#l00060">60</a> of file <a class="el" href="xed-disas_8h-source.html">xed-disas.h</a>. </td>
97 <hr><h2>Function Documentation</h2>
98 <a class="anchor" name="g5a8149ea49b19f4967d20435f470b0f2"></a><!-- doxytag: member="xed-inst-printer.h::xed_format" ref="g5a8149ea49b19f4967d20435f470b0f2" args="(xed_syntax_enum_t syntax, xed_decoded_inst_t *xedd, char *out_buffer, int buffer_len, xed_uint64_t runtime_instruction_address)" --><p>
99 <table class="mdTable" cellpadding="2" cellspacing="0">
102 <table cellpadding="0" cellspacing="0" border="0">
104 <td class="md" nowrap valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> xed_format </td>
105 <td class="md" valign="top">( </td>
106 <td class="md" nowrap valign="top"><a class="el" href="xed-syntax-enum_8h.html#226c37dc9f1af9e61dad79dc5f65bc9f">xed_syntax_enum_t</a> </td>
107 <td class="mdname" nowrap> <em>syntax</em>, </td>
110 <td class="md" nowrap align="right"></td>
112 <td class="md" nowrap><a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> * </td>
113 <td class="mdname" nowrap> <em>xedd</em>, </td>
116 <td class="md" nowrap align="right"></td>
118 <td class="md" nowrap>char * </td>
119 <td class="mdname" nowrap> <em>out_buffer</em>, </td>
122 <td class="md" nowrap align="right"></td>
124 <td class="md" nowrap>int </td>
125 <td class="mdname" nowrap> <em>buffer_len</em>, </td>
128 <td class="md" nowrap align="right"></td>
130 <td class="md" nowrap>xed_uint64_t </td>
131 <td class="mdname" nowrap> <em>runtime_instruction_address</em></td>
135 <td class="md">) </td>
136 <td class="md" colspan="2"></td>
142 <table cellspacing="5" cellpadding="0" border="0">
150 Disassemble the decoded instruction using the specified syntax.
152 The output buffer must be at least 25 bytes long. Returns true if disassembly proceeded without errors. <dl compact><dt><b>Parameters:</b></dt><dd>
153 <table border="0" cellspacing="2" cellpadding="0">
154 <tr><td valign="top"></td><td valign="top"><em>syntax</em> </td><td>a <a class="el" href="xed-syntax-enum_8h.html#226c37dc9f1af9e61dad79dc5f65bc9f">xed_syntax_enum_t</a> the specifies the disassembly format </td></tr>
155 <tr><td valign="top"></td><td valign="top"><em>xedd</em> </td><td>a <a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> for a decoded instruction </td></tr>
156 <tr><td valign="top"></td><td valign="top"><em>out_buffer</em> </td><td>a buffer to write the disassembly in to. </td></tr>
157 <tr><td valign="top"></td><td valign="top"><em>buffer_len</em> </td><td>maximum length of the disassembly buffer </td></tr>
158 <tr><td valign="top"></td><td valign="top"><em>runtime_instruction_address</em> </td><td>the address of the instruction being disassembled </td></tr>
161 <dl compact><dt><b>Returns:</b></dt><dd>Returns 0 if the disassembly fails, 1 otherwise. </dd></dl>
165 <a class="anchor" name="gd8d360fbecb021a4fc0c9d865e0b326d"></a><!-- doxytag: member="xed-inst-printer.h::xed_format_att" ref="gd8d360fbecb021a4fc0c9d865e0b326d" args="(xed_decoded_inst_t *xedd, char *out_buffer, xed_uint32_t buffer_len, xed_uint64_t runtime_instruction_address)" --><p>
166 <table class="mdTable" cellpadding="2" cellspacing="0">
169 <table cellpadding="0" cellspacing="0" border="0">
171 <td class="md" nowrap valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> xed_format_att </td>
172 <td class="md" valign="top">( </td>
173 <td class="md" nowrap valign="top"><a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> * </td>
174 <td class="mdname" nowrap> <em>xedd</em>, </td>
177 <td class="md" nowrap align="right"></td>
179 <td class="md" nowrap>char * </td>
180 <td class="mdname" nowrap> <em>out_buffer</em>, </td>
183 <td class="md" nowrap align="right"></td>
185 <td class="md" nowrap>xed_uint32_t </td>
186 <td class="mdname" nowrap> <em>buffer_len</em>, </td>
189 <td class="md" nowrap align="right"></td>
191 <td class="md" nowrap>xed_uint64_t </td>
192 <td class="mdname" nowrap> <em>runtime_instruction_address</em></td>
196 <td class="md">) </td>
197 <td class="md" colspan="2"></td>
203 <table cellspacing="5" cellpadding="0" border="0">
211 Disassemble the decoded instruction using the ATT SYSV syntax.
213 The output buffer must be at least 16 bytes long. Returns true if disassembly proceeded without errors. <dl compact><dt><b>Parameters:</b></dt><dd>
214 <table border="0" cellspacing="2" cellpadding="0">
215 <tr><td valign="top"></td><td valign="top"><em>xedd</em> </td><td>a <a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> for a decoded instruction </td></tr>
216 <tr><td valign="top"></td><td valign="top"><em>out_buffer</em> </td><td>a buffer to write the disassembly in to. </td></tr>
217 <tr><td valign="top"></td><td valign="top"><em>buffer_len</em> </td><td>maximum length of the disassembly buffer </td></tr>
218 <tr><td valign="top"></td><td valign="top"><em>runtime_instruction_address</em> </td><td>the address of the instruction being disassembled </td></tr>
221 <dl compact><dt><b>Returns:</b></dt><dd>Returns 0 if the disassembly fails, 1 otherwise. </dd></dl>
225 <a class="anchor" name="gba00a6705b2c7c636d5f693eee83817f"></a><!-- doxytag: member="xed-inst-printer.h::xed_format_att_context" ref="gba00a6705b2c7c636d5f693eee83817f" args="(xed_decoded_inst_t *xedd, char *out_buffer, xed_uint32_t buffer_len, xed_uint64_t runtime_instruction_address, void *context)" --><p>
226 <table class="mdTable" cellpadding="2" cellspacing="0">
229 <table cellpadding="0" cellspacing="0" border="0">
231 <td class="md" nowrap valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> xed_format_att_context </td>
232 <td class="md" valign="top">( </td>
233 <td class="md" nowrap valign="top"><a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> * </td>
234 <td class="mdname" nowrap> <em>xedd</em>, </td>
237 <td class="md" nowrap align="right"></td>
239 <td class="md" nowrap>char * </td>
240 <td class="mdname" nowrap> <em>out_buffer</em>, </td>
243 <td class="md" nowrap align="right"></td>
245 <td class="md" nowrap>xed_uint32_t </td>
246 <td class="mdname" nowrap> <em>buffer_len</em>, </td>
249 <td class="md" nowrap align="right"></td>
251 <td class="md" nowrap>xed_uint64_t </td>
252 <td class="mdname" nowrap> <em>runtime_instruction_address</em>, </td>
255 <td class="md" nowrap align="right"></td>
257 <td class="md" nowrap>void * </td>
258 <td class="mdname" nowrap> <em>context</em></td>
262 <td class="md">) </td>
263 <td class="md" colspan="2"></td>
269 <table cellspacing="5" cellpadding="0" border="0">
277 Disassemble the decoded instruction using the ATT SYSV syntax.
279 The output buffer must be at least 16 bytes long. Returns true if disassembly proceeded without errors. <dl compact><dt><b>Parameters:</b></dt><dd>
280 <table border="0" cellspacing="2" cellpadding="0">
281 <tr><td valign="top"></td><td valign="top"><em>xedd</em> </td><td>a <a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> for a decoded instruction </td></tr>
282 <tr><td valign="top"></td><td valign="top"><em>out_buffer</em> </td><td>a buffer to write the disassembly in to. </td></tr>
283 <tr><td valign="top"></td><td valign="top"><em>buffer_len</em> </td><td>maximum length of the disassembly buffer </td></tr>
284 <tr><td valign="top"></td><td valign="top"><em>runtime_instruction_address</em> </td><td>the address of the instruction being disassembled </td></tr>
285 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>A void* used only for the call back routine for symbolic disassembly if one is registered. </td></tr>
288 <dl compact><dt><b>Returns:</b></dt><dd>Returns 0 if the disassembly fails, 1 otherwise. </dd></dl>
292 <a class="anchor" name="g55c8f699f25fdd6ee842593bd4c3ea7f"></a><!-- doxytag: member="xed-inst-printer.h::xed_format_context" ref="g55c8f699f25fdd6ee842593bd4c3ea7f" args="(xed_syntax_enum_t syntax, xed_decoded_inst_t *xedd, char *out_buffer, int buffer_len, xed_uint64_t runtime_instruction_address, void *context)" --><p>
293 <table class="mdTable" cellpadding="2" cellspacing="0">
296 <table cellpadding="0" cellspacing="0" border="0">
298 <td class="md" nowrap valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> xed_format_context </td>
299 <td class="md" valign="top">( </td>
300 <td class="md" nowrap valign="top"><a class="el" href="xed-syntax-enum_8h.html#226c37dc9f1af9e61dad79dc5f65bc9f">xed_syntax_enum_t</a> </td>
301 <td class="mdname" nowrap> <em>syntax</em>, </td>
304 <td class="md" nowrap align="right"></td>
306 <td class="md" nowrap><a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> * </td>
307 <td class="mdname" nowrap> <em>xedd</em>, </td>
310 <td class="md" nowrap align="right"></td>
312 <td class="md" nowrap>char * </td>
313 <td class="mdname" nowrap> <em>out_buffer</em>, </td>
316 <td class="md" nowrap align="right"></td>
318 <td class="md" nowrap>int </td>
319 <td class="mdname" nowrap> <em>buffer_len</em>, </td>
322 <td class="md" nowrap align="right"></td>
324 <td class="md" nowrap>xed_uint64_t </td>
325 <td class="mdname" nowrap> <em>runtime_instruction_address</em>, </td>
328 <td class="md" nowrap align="right"></td>
330 <td class="md" nowrap>void * </td>
331 <td class="mdname" nowrap> <em>context</em></td>
335 <td class="md">) </td>
336 <td class="md" colspan="2"></td>
342 <table cellspacing="5" cellpadding="0" border="0">
350 Disassemble the decoded instruction using the specified syntax.
352 The output buffer must be at least 25 bytes long. Returns true if disassembly proceeded without errors. <dl compact><dt><b>Parameters:</b></dt><dd>
353 <table border="0" cellspacing="2" cellpadding="0">
354 <tr><td valign="top"></td><td valign="top"><em>syntax</em> </td><td>a <a class="el" href="xed-syntax-enum_8h.html#226c37dc9f1af9e61dad79dc5f65bc9f">xed_syntax_enum_t</a> the specifies the disassembly format </td></tr>
355 <tr><td valign="top"></td><td valign="top"><em>xedd</em> </td><td>a <a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> for a decoded instruction </td></tr>
356 <tr><td valign="top"></td><td valign="top"><em>out_buffer</em> </td><td>a buffer to write the disassembly in to. </td></tr>
357 <tr><td valign="top"></td><td valign="top"><em>buffer_len</em> </td><td>maximum length of the disassembly buffer </td></tr>
358 <tr><td valign="top"></td><td valign="top"><em>runtime_instruction_address</em> </td><td>the address of the instruction being disassembled </td></tr>
359 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>A void* used only for the call back routine for symbolic disassembly if one is registered. </td></tr>
362 <dl compact><dt><b>Returns:</b></dt><dd>Returns 0 if the disassembly fails, 1 otherwise. </dd></dl>
366 <a class="anchor" name="gf8b71dad59c2cf235d339c612f66c4a4"></a><!-- doxytag: member="xed-inst-printer.h::xed_format_intel" ref="gf8b71dad59c2cf235d339c612f66c4a4" args="(xed_decoded_inst_t *xedd, char *out_buffer, xed_uint32_t buffer_len, xed_uint64_t runtime_instruction_address)" --><p>
367 <table class="mdTable" cellpadding="2" cellspacing="0">
370 <table cellpadding="0" cellspacing="0" border="0">
372 <td class="md" nowrap valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> xed_format_intel </td>
373 <td class="md" valign="top">( </td>
374 <td class="md" nowrap valign="top"><a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> * </td>
375 <td class="mdname" nowrap> <em>xedd</em>, </td>
378 <td class="md" nowrap align="right"></td>
380 <td class="md" nowrap>char * </td>
381 <td class="mdname" nowrap> <em>out_buffer</em>, </td>
384 <td class="md" nowrap align="right"></td>
386 <td class="md" nowrap>xed_uint32_t </td>
387 <td class="mdname" nowrap> <em>buffer_len</em>, </td>
390 <td class="md" nowrap align="right"></td>
392 <td class="md" nowrap>xed_uint64_t </td>
393 <td class="mdname" nowrap> <em>runtime_instruction_address</em></td>
397 <td class="md">) </td>
398 <td class="md" colspan="2"></td>
404 <table cellspacing="5" cellpadding="0" border="0">
412 Disassemble the decoded instruction using the Intel syntax.
414 The output buffer must be at least 16 bytes long. Returns true if disassembly proceeded without errors. <dl compact><dt><b>Parameters:</b></dt><dd>
415 <table border="0" cellspacing="2" cellpadding="0">
416 <tr><td valign="top"></td><td valign="top"><em>xedd</em> </td><td>a <a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> for a decoded instruction </td></tr>
417 <tr><td valign="top"></td><td valign="top"><em>out_buffer</em> </td><td>a buffer to write the disassembly in to. </td></tr>
418 <tr><td valign="top"></td><td valign="top"><em>buffer_len</em> </td><td>maximum length of the disassembly buffer </td></tr>
419 <tr><td valign="top"></td><td valign="top"><em>runtime_instruction_address</em> </td><td>the address of the instruction being disassembled </td></tr>
422 <dl compact><dt><b>Returns:</b></dt><dd>Returns 0 if the disassembly fails, 1 otherwise. </dd></dl>
426 <a class="anchor" name="gbc13aaaa26429bcb390fd2c776102206"></a><!-- doxytag: member="xed-inst-printer.h::xed_format_intel_context" ref="gbc13aaaa26429bcb390fd2c776102206" args="(xed_decoded_inst_t *xedd, char *out_buffer, xed_uint32_t buffer_len, xed_uint64_t runtime_instruction_address, void *context)" --><p>
427 <table class="mdTable" cellpadding="2" cellspacing="0">
430 <table cellpadding="0" cellspacing="0" border="0">
432 <td class="md" nowrap valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> xed_format_intel_context </td>
433 <td class="md" valign="top">( </td>
434 <td class="md" nowrap valign="top"><a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> * </td>
435 <td class="mdname" nowrap> <em>xedd</em>, </td>
438 <td class="md" nowrap align="right"></td>
440 <td class="md" nowrap>char * </td>
441 <td class="mdname" nowrap> <em>out_buffer</em>, </td>
444 <td class="md" nowrap align="right"></td>
446 <td class="md" nowrap>xed_uint32_t </td>
447 <td class="mdname" nowrap> <em>buffer_len</em>, </td>
450 <td class="md" nowrap align="right"></td>
452 <td class="md" nowrap>xed_uint64_t </td>
453 <td class="mdname" nowrap> <em>runtime_instruction_address</em>, </td>
456 <td class="md" nowrap align="right"></td>
458 <td class="md" nowrap>void * </td>
459 <td class="mdname" nowrap> <em>context</em></td>
463 <td class="md">) </td>
464 <td class="md" colspan="2"></td>
470 <table cellspacing="5" cellpadding="0" border="0">
478 Disassemble the decoded instruction using the Intel syntax.
480 The output buffer must be at least 16 bytes long. Returns true if disassembly proceeded without errors. <dl compact><dt><b>Parameters:</b></dt><dd>
481 <table border="0" cellspacing="2" cellpadding="0">
482 <tr><td valign="top"></td><td valign="top"><em>xedd</em> </td><td>a <a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> for a decoded instruction </td></tr>
483 <tr><td valign="top"></td><td valign="top"><em>out_buffer</em> </td><td>a buffer to write the disassembly in to. </td></tr>
484 <tr><td valign="top"></td><td valign="top"><em>buffer_len</em> </td><td>maximum length of the disassembly buffer </td></tr>
485 <tr><td valign="top"></td><td valign="top"><em>runtime_instruction_address</em> </td><td>the address of the instruction being disassembled </td></tr>
486 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>A void* used only for the call back routine for symbolic disassembly if one is registered. </td></tr>
489 <dl compact><dt><b>Returns:</b></dt><dd>Returns 0 if the disassembly fails, 1 otherwise. </dd></dl>
493 <a class="anchor" name="g6d44153ee05618381828ff69e0c84b08"></a><!-- doxytag: member="xed-inst-printer.h::xed_format_xed" ref="g6d44153ee05618381828ff69e0c84b08" args="(xed_decoded_inst_t *xedd, char *out_buffer, xed_uint32_t buffer_len, xed_uint64_t runtime_instruction_address)" --><p>
494 <table class="mdTable" cellpadding="2" cellspacing="0">
497 <table cellpadding="0" cellspacing="0" border="0">
499 <td class="md" nowrap valign="top">XED_DLL_EXPORT <a class="el" href="xed-types_8h.html#d355c921b747945a82d62233a599c7b5">xed_bool_t</a> xed_format_xed </td>
500 <td class="md" valign="top">( </td>
501 <td class="md" nowrap valign="top"><a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> * </td>
502 <td class="mdname" nowrap> <em>xedd</em>, </td>
505 <td class="md" nowrap align="right"></td>
507 <td class="md" nowrap>char * </td>
508 <td class="mdname" nowrap> <em>out_buffer</em>, </td>
511 <td class="md" nowrap align="right"></td>
513 <td class="md" nowrap>xed_uint32_t </td>
514 <td class="mdname" nowrap> <em>buffer_len</em>, </td>
517 <td class="md" nowrap align="right"></td>
519 <td class="md" nowrap>xed_uint64_t </td>
520 <td class="mdname" nowrap> <em>runtime_instruction_address</em></td>
524 <td class="md">) </td>
525 <td class="md" colspan="2"></td>
531 <table cellspacing="5" cellpadding="0" border="0">
539 Disassemble the decoded instruction using the XED syntax providing all operand resources (implicit, explicit, suppressed).
541 The output buffer must be at least 25 bytes long. Returns true if disassembly proceeded without errors. <dl compact><dt><b>Parameters:</b></dt><dd>
542 <table border="0" cellspacing="2" cellpadding="0">
543 <tr><td valign="top"></td><td valign="top"><em>xedd</em> </td><td>a <a class="el" href="group__DEC.html#ga704925b5f80885a0ac56640a7c70937">xed_decoded_inst_t</a> for a decoded instruction </td></tr>
544 <tr><td valign="top"></td><td valign="top"><em>out_buffer</em> </td><td>a buffer to write the disassembly in to. </td></tr>
545 <tr><td valign="top"></td><td valign="top"><em>buffer_len</em> </td><td>maximum length of the disassembly buffer </td></tr>
546 <tr><td valign="top"></td><td valign="top"><em>runtime_instruction_address</em> </td><td>the address of the instruction being disassembled </td></tr>
549 <dl compact><dt><b>Returns:</b></dt><dd>Returns 0 if the disassembly fails, 1 otherwise. </dd></dl>
553 <a class="anchor" name="gd6a3477c164874ca5ac8654b6563082d"></a><!-- doxytag: member="xed-disas.h::xed_register_disassembly_callback" ref="gd6a3477c164874ca5ac8654b6563082d" args="(xed_disassembly_callback_fn_t f)" --><p>
554 <table class="mdTable" cellpadding="2" cellspacing="0">
557 <table cellpadding="0" cellspacing="0" border="0">
559 <td class="md" nowrap valign="top">XED_DLL_EXPORT void xed_register_disassembly_callback </td>
560 <td class="md" valign="top">( </td>
561 <td class="md" nowrap valign="top"><a class="el" href="group__PRINT.html#g58ce98693231e7865ff3525b816fe7f3">xed_disassembly_callback_fn_t</a> </td>
562 <td class="mdname1" valign="top" nowrap> <em>f</em> </td>
563 <td class="md" valign="top"> ) </td>
564 <td class="md" nowrap></td>
570 <table cellspacing="5" cellpadding="0" border="0">
578 Register a disassembly call back function of type <a class="el" href="group__PRINT.html#g58ce98693231e7865ff3525b816fe7f3">xed_disassembly_callback_fn_t</a> to get called when the disassembler needs to get a symbol and offset for an address.
583 <hr size="1"><address style="align: right;"><small>Generated on Thu May 15 03:15:09 2008 for XED2 by
584 <a href="http://www.doxygen.org/index.html">
585 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>