| 1 |
/* |
| 2 |
* FCML - Free Code Manipulation Library. |
| 3 |
* Copyright (C) 2010-2020 Slawomir Wojtasiak |
| 4 |
* |
| 5 |
* This library is free software; you can redistribute it and/or |
| 6 |
* modify it under the terms of the GNU Lesser General Public |
| 7 |
* License as published by the Free Software Foundation; either |
| 8 |
* version 2.1 of the License, or (at your option) any later version. |
| 9 |
* |
| 10 |
* This library is distributed in the hope that it will be useful, |
| 11 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 13 |
* Lesser General Public License for more details. |
| 14 |
* |
| 15 |
* You should have received a copy of the GNU Lesser General Public |
| 16 |
* License along with this library; if not, write to the Free Software |
| 17 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 18 |
*/ |
| 19 |
|
| 20 |
/** @file fcml_common_utils.h |
| 21 |
* |
| 22 |
* Common general purpose utility functions. |
| 23 |
* |
| 24 |
* @copyright Copyright (C) 2010-2020 Slawomir Wojtasiak. All rights reserved. |
| 25 |
* This project is released under the GNU Lesser General Public License. |
| 26 |
*/ |
| 27 |
|
| 28 |
#ifndef FCML_COMMON_UTILS_H_ |
| 29 |
#define FCML_COMMON_UTILS_H_ |
| 30 |
|
| 31 |
#include "fcml_lib_export.h" |
| 32 |
|
| 33 |
#include "fcml_common.h" |
| 34 |
#include "fcml_assembler.h" |
| 35 |
#include "fcml_disassembler.h" |
| 36 |
#include "fcml_instructions.h" |
| 37 |
|
| 38 |
#ifdef __cplusplus |
| 39 |
extern "C" { |
| 40 |
#endif |
| 41 |
|
| 42 |
/** |
| 43 |
* @defgroup REG_STRUCTURES_GROUP Registers |
| 44 |
* Declarations of structures describing all available registers. |
| 45 |
* @{ |
| 46 |
*/ |
| 47 |
|
| 48 |
extern LIB_EXPORT fcml_st_register fcml_reg_AL; |
| 49 |
extern LIB_EXPORT fcml_st_register fcml_reg_AX; |
| 50 |
extern LIB_EXPORT fcml_st_register fcml_reg_EAX; |
| 51 |
extern LIB_EXPORT fcml_st_register fcml_reg_RAX; |
| 52 |
extern LIB_EXPORT fcml_st_register fcml_reg_MM0; |
| 53 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM0; |
| 54 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM0; |
| 55 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM0; |
| 56 |
|
| 57 |
extern LIB_EXPORT fcml_st_register fcml_reg_CL; |
| 58 |
extern LIB_EXPORT fcml_st_register fcml_reg_CX; |
| 59 |
extern LIB_EXPORT fcml_st_register fcml_reg_ECX; |
| 60 |
extern LIB_EXPORT fcml_st_register fcml_reg_RCX; |
| 61 |
extern LIB_EXPORT fcml_st_register fcml_reg_MM1; |
| 62 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM1; |
| 63 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM1; |
| 64 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM1; |
| 65 |
|
| 66 |
extern LIB_EXPORT fcml_st_register fcml_reg_DL; |
| 67 |
extern LIB_EXPORT fcml_st_register fcml_reg_DX; |
| 68 |
extern LIB_EXPORT fcml_st_register fcml_reg_EDX; |
| 69 |
extern LIB_EXPORT fcml_st_register fcml_reg_RDX; |
| 70 |
extern LIB_EXPORT fcml_st_register fcml_reg_MM2; |
| 71 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM2; |
| 72 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM2; |
| 73 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM2; |
| 74 |
|
| 75 |
extern LIB_EXPORT fcml_st_register fcml_reg_BL; |
| 76 |
extern LIB_EXPORT fcml_st_register fcml_reg_BX; |
| 77 |
extern LIB_EXPORT fcml_st_register fcml_reg_EBX; |
| 78 |
extern LIB_EXPORT fcml_st_register fcml_reg_RBX; |
| 79 |
extern LIB_EXPORT fcml_st_register fcml_reg_MM3; |
| 80 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM3; |
| 81 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM3; |
| 82 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM3; |
| 83 |
|
| 84 |
extern LIB_EXPORT fcml_st_register fcml_reg_AH; |
| 85 |
extern LIB_EXPORT fcml_st_register fcml_reg_SPL; |
| 86 |
extern LIB_EXPORT fcml_st_register fcml_reg_SP; |
| 87 |
extern LIB_EXPORT fcml_st_register fcml_reg_ESP; |
| 88 |
extern LIB_EXPORT fcml_st_register fcml_reg_RSP; |
| 89 |
extern LIB_EXPORT fcml_st_register fcml_reg_MM4; |
| 90 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM4; |
| 91 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM4; |
| 92 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM4; |
| 93 |
|
| 94 |
extern LIB_EXPORT fcml_st_register fcml_reg_CH; |
| 95 |
extern LIB_EXPORT fcml_st_register fcml_reg_BPL; |
| 96 |
extern LIB_EXPORT fcml_st_register fcml_reg_BP; |
| 97 |
extern LIB_EXPORT fcml_st_register fcml_reg_EBP; |
| 98 |
extern LIB_EXPORT fcml_st_register fcml_reg_RBP; |
| 99 |
extern LIB_EXPORT fcml_st_register fcml_reg_MM5; |
| 100 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM5; |
| 101 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM5; |
| 102 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM5; |
| 103 |
|
| 104 |
extern LIB_EXPORT fcml_st_register fcml_reg_DH; |
| 105 |
extern LIB_EXPORT fcml_st_register fcml_reg_SIL; |
| 106 |
extern LIB_EXPORT fcml_st_register fcml_reg_SI; |
| 107 |
extern LIB_EXPORT fcml_st_register fcml_reg_ESI; |
| 108 |
extern LIB_EXPORT fcml_st_register fcml_reg_RSI; |
| 109 |
extern LIB_EXPORT fcml_st_register fcml_reg_MM6; |
| 110 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM6; |
| 111 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM6; |
| 112 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM6; |
| 113 |
|
| 114 |
extern LIB_EXPORT fcml_st_register fcml_reg_BH; |
| 115 |
extern LIB_EXPORT fcml_st_register fcml_reg_DIL; |
| 116 |
extern LIB_EXPORT fcml_st_register fcml_reg_DI; |
| 117 |
extern LIB_EXPORT fcml_st_register fcml_reg_EDI; |
| 118 |
extern LIB_EXPORT fcml_st_register fcml_reg_RDI; |
| 119 |
extern LIB_EXPORT fcml_st_register fcml_reg_MM7; |
| 120 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM7; |
| 121 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM7; |
| 122 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM7; |
| 123 |
|
| 124 |
extern LIB_EXPORT fcml_st_register fcml_reg_R8L; |
| 125 |
extern LIB_EXPORT fcml_st_register fcml_reg_R8W; |
| 126 |
extern LIB_EXPORT fcml_st_register fcml_reg_R8D; |
| 127 |
extern LIB_EXPORT fcml_st_register fcml_reg_R8; |
| 128 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM8; |
| 129 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM8; |
| 130 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM8; |
| 131 |
|
| 132 |
extern LIB_EXPORT fcml_st_register fcml_reg_R9L; |
| 133 |
extern LIB_EXPORT fcml_st_register fcml_reg_R9W; |
| 134 |
extern LIB_EXPORT fcml_st_register fcml_reg_R9D; |
| 135 |
extern LIB_EXPORT fcml_st_register fcml_reg_R9; |
| 136 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM9; |
| 137 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM9; |
| 138 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM9; |
| 139 |
|
| 140 |
extern LIB_EXPORT fcml_st_register fcml_reg_R10L; |
| 141 |
extern LIB_EXPORT fcml_st_register fcml_reg_R10W; |
| 142 |
extern LIB_EXPORT fcml_st_register fcml_reg_R10D; |
| 143 |
extern LIB_EXPORT fcml_st_register fcml_reg_R10; |
| 144 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM10; |
| 145 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM10; |
| 146 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM10; |
| 147 |
|
| 148 |
extern LIB_EXPORT fcml_st_register fcml_reg_R11L; |
| 149 |
extern LIB_EXPORT fcml_st_register fcml_reg_R11W; |
| 150 |
extern LIB_EXPORT fcml_st_register fcml_reg_R11D; |
| 151 |
extern LIB_EXPORT fcml_st_register fcml_reg_R11; |
| 152 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM11; |
| 153 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM11; |
| 154 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM11; |
| 155 |
|
| 156 |
extern LIB_EXPORT fcml_st_register fcml_reg_R12L; |
| 157 |
extern LIB_EXPORT fcml_st_register fcml_reg_R12W; |
| 158 |
extern LIB_EXPORT fcml_st_register fcml_reg_R12D; |
| 159 |
extern LIB_EXPORT fcml_st_register fcml_reg_R12; |
| 160 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM12; |
| 161 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM12; |
| 162 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM12; |
| 163 |
|
| 164 |
extern LIB_EXPORT fcml_st_register fcml_reg_R13L; |
| 165 |
extern LIB_EXPORT fcml_st_register fcml_reg_R13W; |
| 166 |
extern LIB_EXPORT fcml_st_register fcml_reg_R13D; |
| 167 |
extern LIB_EXPORT fcml_st_register fcml_reg_R13; |
| 168 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM13; |
| 169 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM13; |
| 170 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM13; |
| 171 |
|
| 172 |
extern LIB_EXPORT fcml_st_register fcml_reg_R14L; |
| 173 |
extern LIB_EXPORT fcml_st_register fcml_reg_R14W; |
| 174 |
extern LIB_EXPORT fcml_st_register fcml_reg_R14D; |
| 175 |
extern LIB_EXPORT fcml_st_register fcml_reg_R14; |
| 176 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM14; |
| 177 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM14; |
| 178 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM14; |
| 179 |
|
| 180 |
extern LIB_EXPORT fcml_st_register fcml_reg_R15L; |
| 181 |
extern LIB_EXPORT fcml_st_register fcml_reg_R15W; |
| 182 |
extern LIB_EXPORT fcml_st_register fcml_reg_R15D; |
| 183 |
extern LIB_EXPORT fcml_st_register fcml_reg_R15; |
| 184 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM15; |
| 185 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM15; |
| 186 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM15; |
| 187 |
|
| 188 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM16; |
| 189 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM16; |
| 190 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM16; |
| 191 |
|
| 192 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM17; |
| 193 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM17; |
| 194 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM17; |
| 195 |
|
| 196 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM18; |
| 197 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM18; |
| 198 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM18; |
| 199 |
|
| 200 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM19; |
| 201 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM19; |
| 202 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM19; |
| 203 |
|
| 204 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM20; |
| 205 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM20; |
| 206 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM20; |
| 207 |
|
| 208 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM21; |
| 209 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM21; |
| 210 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM21; |
| 211 |
|
| 212 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM22; |
| 213 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM22; |
| 214 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM22; |
| 215 |
|
| 216 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM23; |
| 217 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM23; |
| 218 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM23; |
| 219 |
|
| 220 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM24; |
| 221 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM24; |
| 222 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM24; |
| 223 |
|
| 224 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM25; |
| 225 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM25; |
| 226 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM25; |
| 227 |
|
| 228 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM26; |
| 229 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM26; |
| 230 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM26; |
| 231 |
|
| 232 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM27; |
| 233 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM27; |
| 234 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM27; |
| 235 |
|
| 236 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM28; |
| 237 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM28; |
| 238 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM28; |
| 239 |
|
| 240 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM29; |
| 241 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM29; |
| 242 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM29; |
| 243 |
|
| 244 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM30; |
| 245 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM30; |
| 246 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM30; |
| 247 |
|
| 248 |
extern LIB_EXPORT fcml_st_register fcml_reg_XMM31; |
| 249 |
extern LIB_EXPORT fcml_st_register fcml_reg_YMM31; |
| 250 |
extern LIB_EXPORT fcml_st_register fcml_reg_ZMM31; |
| 251 |
|
| 252 |
extern LIB_EXPORT fcml_st_register fcml_reg_ES; |
| 253 |
extern LIB_EXPORT fcml_st_register fcml_reg_CS; |
| 254 |
extern LIB_EXPORT fcml_st_register fcml_reg_SS; |
| 255 |
extern LIB_EXPORT fcml_st_register fcml_reg_DS; |
| 256 |
extern LIB_EXPORT fcml_st_register fcml_reg_FS; |
| 257 |
extern LIB_EXPORT fcml_st_register fcml_reg_GS; |
| 258 |
|
| 259 |
extern LIB_EXPORT fcml_st_register fcml_reg_ST0; |
| 260 |
extern LIB_EXPORT fcml_st_register fcml_reg_ST1; |
| 261 |
extern LIB_EXPORT fcml_st_register fcml_reg_ST2; |
| 262 |
extern LIB_EXPORT fcml_st_register fcml_reg_ST3; |
| 263 |
extern LIB_EXPORT fcml_st_register fcml_reg_ST4; |
| 264 |
extern LIB_EXPORT fcml_st_register fcml_reg_ST5; |
| 265 |
extern LIB_EXPORT fcml_st_register fcml_reg_ST6; |
| 266 |
extern LIB_EXPORT fcml_st_register fcml_reg_ST7; |
| 267 |
|
| 268 |
extern LIB_EXPORT fcml_st_register fcml_reg_CR0; |
| 269 |
extern LIB_EXPORT fcml_st_register fcml_reg_CR2; |
| 270 |
extern LIB_EXPORT fcml_st_register fcml_reg_CR3; |
| 271 |
extern LIB_EXPORT fcml_st_register fcml_reg_CR4; |
| 272 |
extern LIB_EXPORT fcml_st_register fcml_reg_CR8; |
| 273 |
|
| 274 |
extern LIB_EXPORT fcml_st_register fcml_reg_DR0; |
| 275 |
extern LIB_EXPORT fcml_st_register fcml_reg_DR1; |
| 276 |
extern LIB_EXPORT fcml_st_register fcml_reg_DR2; |
| 277 |
extern LIB_EXPORT fcml_st_register fcml_reg_DR3; |
| 278 |
extern LIB_EXPORT fcml_st_register fcml_reg_DR4; |
| 279 |
extern LIB_EXPORT fcml_st_register fcml_reg_DR5; |
| 280 |
extern LIB_EXPORT fcml_st_register fcml_reg_DR6; |
| 281 |
extern LIB_EXPORT fcml_st_register fcml_reg_DR7; |
| 282 |
|
| 283 |
extern LIB_EXPORT fcml_st_register fcml_reg_K0; |
| 284 |
extern LIB_EXPORT fcml_st_register fcml_reg_K1; |
| 285 |
extern LIB_EXPORT fcml_st_register fcml_reg_K2; |
| 286 |
extern LIB_EXPORT fcml_st_register fcml_reg_K3; |
| 287 |
extern LIB_EXPORT fcml_st_register fcml_reg_K4; |
| 288 |
extern LIB_EXPORT fcml_st_register fcml_reg_K5; |
| 289 |
extern LIB_EXPORT fcml_st_register fcml_reg_K6; |
| 290 |
extern LIB_EXPORT fcml_st_register fcml_reg_K7; |
| 291 |
|
| 292 |
extern LIB_EXPORT fcml_st_register fcml_reg_IP; |
| 293 |
extern LIB_EXPORT fcml_st_register fcml_reg_EIP; |
| 294 |
extern LIB_EXPORT fcml_st_register fcml_reg_RIP; |
| 295 |
|
| 296 |
/** @} */ |
| 297 |
|
| 298 |
/** Prepares register operand for given register. |
| 299 |
* @param reg Register for instruction operator. |
| 300 |
* @return Prepared operand. |
| 301 |
*/ |
| 302 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_reg( |
| 303 |
fcml_st_register *reg); |
| 304 |
|
| 305 |
/* IMM.*/ |
| 306 |
|
| 307 |
/** Prepares immediate operand for unsigned int8. |
| 308 |
* @param value Value for immediate operand. |
| 309 |
* @return Prepared operand. |
| 310 |
*/ |
| 311 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_unsigned_imm_8( |
| 312 |
fcml_uint8_t value); |
| 313 |
/** Prepares immediate operand for signed int8. |
| 314 |
* @param value Value for immediate operand. |
| 315 |
* @return Prepared operand. |
| 316 |
*/ |
| 317 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_signed_imm_8( |
| 318 |
fcml_int8_t value); |
| 319 |
/** Prepares immediate operand for unsigned int16. |
| 320 |
* @param value Value for immediate operand. |
| 321 |
* @return Prepared operand. |
| 322 |
*/ |
| 323 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_unsigned_imm_16( |
| 324 |
fcml_uint16_t value); |
| 325 |
/** Prepares immediate operand for signed int16. |
| 326 |
* @param value Value for immediate operand. |
| 327 |
* @return Prepared operand. |
| 328 |
*/ |
| 329 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_signed_imm_16( |
| 330 |
fcml_int16_t value); |
| 331 |
/** Prepares immediate operand for unsigned int32. |
| 332 |
* @param value Value for immediate operand. |
| 333 |
* @return Prepared operand. |
| 334 |
*/ |
| 335 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_unsigned_imm_32( |
| 336 |
fcml_uint32_t value); |
| 337 |
/** Prepares immediate operand for signed int32. |
| 338 |
* @param value Value for immediate operand. |
| 339 |
* @return Prepared operand. |
| 340 |
*/ |
| 341 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_signed_imm_32( |
| 342 |
fcml_int32_t value); |
| 343 |
/** Prepares immediate operand for unsigned int64. |
| 344 |
* @param value Value for immediate operand. |
| 345 |
* @return Prepared operand. |
| 346 |
*/ |
| 347 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_unsigned_imm_64( |
| 348 |
fcml_uint64_t value); |
| 349 |
/** Prepares immediate operand for signed int64. |
| 350 |
* @param value Value for immediate operand. |
| 351 |
* @return Prepared operand. |
| 352 |
*/ |
| 353 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_signed_imm_64( |
| 354 |
fcml_int64_t value); |
| 355 |
|
| 356 |
/* Memory addressing.*/ |
| 357 |
|
| 358 |
/** Prepares far pointer operand for given segment and offset. |
| 359 |
* @param seg 16-bit code segment. |
| 360 |
* @param offset 16-bit code offset. |
| 361 |
* @return Prepared operand. |
| 362 |
*/ |
| 363 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_far_pointer_offset16( |
| 364 |
fcml_int16_t seg, fcml_int16_t offset); |
| 365 |
/** Prepares far pointer operand for given segment and offset. |
| 366 |
* @param seg 16-bit code segment. |
| 367 |
* @param offset 32-bit code offset. |
| 368 |
* @return Prepared operand. |
| 369 |
*/ |
| 370 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_far_pointer_offset32( |
| 371 |
fcml_int16_t seg, fcml_int32_t offset); |
| 372 |
/** Prepares memory addressing operand for 16-bit absolute offset. |
| 373 |
* @param offset 16-bit absolute offset. |
| 374 |
* @param size_operator Size operator. |
| 375 |
* @return Prepared operand. |
| 376 |
*/ |
| 377 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_offset_16( |
| 378 |
fcml_int16_t offset, fcml_usize size_operator); |
| 379 |
/** Prepares memory addressing operand for 32-bit absolute offset. |
| 380 |
* @param offset 32-bit absolute offset. |
| 381 |
* @param size_operator Size operator. |
| 382 |
* @return Prepared operand. |
| 383 |
*/ |
| 384 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_offset_32( |
| 385 |
fcml_int32_t offset, fcml_usize size_operator); |
| 386 |
/** Prepares memory addressing operand for 64-bit absolute offset. Function |
| 387 |
* sets operand level hint: FCML_OP_HINT_ABSOLUTE_ADDRESSING. |
| 388 |
* @param offset 64-bit absolute offset. |
| 389 |
* @param size_operator Size operator. |
| 390 |
* @return Prepared operand. |
| 391 |
* @see RIP addressing. |
| 392 |
*/ |
| 393 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_offset_abs_64( |
| 394 |
fcml_int64_t offset, fcml_usize size_operator); |
| 395 |
/** Prepares memory addressing operand for 64-bit absolute offset. Function |
| 396 |
* sets operand level hint: FCML_OP_HINT_RELATIVE_ADDRESSING. |
| 397 |
* @param offset 64-bit absolute offset. |
| 398 |
* @param size_operator Size operator. |
| 399 |
* @return Prepared operand. |
| 400 |
* @see RIP addressing. |
| 401 |
*/ |
| 402 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_offset_rel_64( |
| 403 |
fcml_int64_t offset, fcml_usize size_operator); |
| 404 |
/** Prepares effective memory addressing operand for 16-bit displacement. |
| 405 |
* @param disp 16-bit displacement. |
| 406 |
* @param size_operator Size operator. |
| 407 |
* @return Prepared operand. |
| 408 |
*/ |
| 409 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_disp_16( |
| 410 |
fcml_int16_t disp, fcml_usize size_operator); |
| 411 |
/** Prepares effective memory addressing operand for 32-bit displacement. |
| 412 |
* @param disp 32-bit displacement. |
| 413 |
* @param size_operator Size operator. |
| 414 |
* @return Prepared operand. |
| 415 |
*/ |
| 416 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_disp_32( |
| 417 |
fcml_int32_t disp, fcml_usize size_operator); |
| 418 |
/** Prepares effective memory addressing operand for 64-bit displacement. |
| 419 |
* @param disp 64-bit displacement. |
| 420 |
* @param size_operator Size operator. |
| 421 |
* @return Prepared operand. |
| 422 |
*/ |
| 423 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_disp_64( |
| 424 |
fcml_int64_t disp, fcml_usize size_operator); |
| 425 |
/** Prepares effective memory addressing operand for 8-bit displacement |
| 426 |
* and base register. |
| 427 |
* @param base Base register. |
| 428 |
* @param disp 8-bit displacement. |
| 429 |
* @param size_operator Size operator. |
| 430 |
* @return Prepared operand. |
| 431 |
*/ |
| 432 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_b_disp_8( |
| 433 |
fcml_st_register *base, fcml_int8_t disp, fcml_usize size_operator); |
| 434 |
/** Prepares effective memory addressing operand for 16-bit displacement |
| 435 |
* and base register. |
| 436 |
* @param base Base register. |
| 437 |
* @param disp 16-bit displacement. |
| 438 |
* @param size_operator Size operator. |
| 439 |
* @return Prepared operand. |
| 440 |
*/ |
| 441 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_b_disp_16( |
| 442 |
fcml_st_register *base, fcml_int16_t disp, fcml_usize size_operator); |
| 443 |
/** Prepares effective memory addressing operand for 32-bit displacement |
| 444 |
* and base register. |
| 445 |
* @param base Base register. |
| 446 |
* @param disp 32-bit displacement. |
| 447 |
* @param size_operator Size operator. |
| 448 |
* @return Prepared operand. |
| 449 |
*/ |
| 450 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_b_disp_32( |
| 451 |
fcml_st_register *base, fcml_int32_t disp, fcml_usize size_operator); |
| 452 |
/** Prepares effective memory addressing operand for 64-bit displacement |
| 453 |
* and base register. |
| 454 |
* @param base Base register. |
| 455 |
* @param disp 64-bit displacement. |
| 456 |
* @param size_operator Size operator. |
| 457 |
* @return Prepared operand. |
| 458 |
*/ |
| 459 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_b_disp_64( |
| 460 |
fcml_st_register *base, fcml_int64_t disp, fcml_usize size_operator); |
| 461 |
/** Prepares effective memory addressing operand for 8-bit displacement, |
| 462 |
* scale factor and index register. |
| 463 |
* @param index Index register. |
| 464 |
* @param scale_factor Scale factor. |
| 465 |
* @param disp 8-bit displacement. |
| 466 |
* @param size_operator Size operator. |
| 467 |
* @return Prepared operand. |
| 468 |
*/ |
| 469 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_is_disp_8( |
| 470 |
fcml_st_register *index, fcml_uint8_t scale_factor, fcml_int8_t disp, |
| 471 |
fcml_usize size_operator); |
| 472 |
/** Prepares effective memory addressing operand for 16-bit displacement, |
| 473 |
* scale factor and index register. |
| 474 |
* @param index Index register. |
| 475 |
* @param scale_factor Scale factor. |
| 476 |
* @param disp 16-bit displacement. |
| 477 |
* @param size_operator Size operator. |
| 478 |
* @return Prepared operand. |
| 479 |
*/ |
| 480 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_is_disp_32( |
| 481 |
fcml_st_register *index, fcml_uint8_t scale_factor, fcml_int32_t disp, |
| 482 |
fcml_usize size_operator); |
| 483 |
/** Prepares effective memory addressing operand for 32-bit displacement, |
| 484 |
* scale factor and index register. |
| 485 |
* @param index Index register. |
| 486 |
* @param scale_factor Scale factor. |
| 487 |
* @param disp 32-bit displacement. |
| 488 |
* @param size_operator Size operator. |
| 489 |
* @return Prepared operand. |
| 490 |
*/ |
| 491 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_is_disp_64( |
| 492 |
fcml_st_register *index, fcml_uint8_t scale_factor, fcml_int64_t disp, |
| 493 |
fcml_usize size_operator); |
| 494 |
/** Prepares effective memory addressing operand for 8-bit displacement, |
| 495 |
* base register, scale factor and index register. |
| 496 |
* @param base Base register. |
| 497 |
* @param index Index register. |
| 498 |
* @param scale_factor Scale factor. |
| 499 |
* @param disp 8-bit displacement. |
| 500 |
* @param size_operator Size operator. |
| 501 |
* @return Prepared operand. |
| 502 |
*/ |
| 503 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_bis_disp_8( |
| 504 |
fcml_st_register *base, fcml_st_register *index, |
| 505 |
fcml_uint8_t scale_factor, fcml_int8_t disp, fcml_usize size_operator); |
| 506 |
/** Prepares effective memory addressing operand for 16-bit displacement, |
| 507 |
* base register, scale factor and index register. |
| 508 |
* @param base Base register. |
| 509 |
* @param index Index register. |
| 510 |
* @param scale_factor Scale factor. |
| 511 |
* @param disp 16-bit displacement. |
| 512 |
* @param size_operator Size operator. |
| 513 |
* @return Prepared operand. |
| 514 |
*/ |
| 515 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_bis_disp_32( |
| 516 |
fcml_st_register *base, fcml_st_register *index, |
| 517 |
fcml_uint8_t scale_factor, fcml_int32_t disp, fcml_usize size_operator); |
| 518 |
/** Prepares effective memory addressing operand for 32-bit displacement, |
| 519 |
* base register, scale factor and index register. |
| 520 |
* @param base Base register. |
| 521 |
* @param index Index register. |
| 522 |
* @param scale_factor Scale factor. |
| 523 |
* @param disp 32-bit displacement. |
| 524 |
* @param size_operator Size operator. |
| 525 |
* @return Prepared operand. |
| 526 |
*/ |
| 527 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_operand_addr_bis_disp_64( |
| 528 |
fcml_st_register *base, fcml_st_register *index, |
| 529 |
fcml_uint8_t scale_factor, fcml_int64_t disp, fcml_usize size_operator); |
| 530 |
|
| 531 |
/** Adds hints to the operand. |
| 532 |
* @param operand Operand for hints. |
| 533 |
* @param hints Hints mask. |
| 534 |
* @return Prepared operand. |
| 535 |
*/ |
| 536 |
LIB_EXPORT fcml_st_operand LIB_CALL fcml_fn_cu_add_operand_hints( |
| 537 |
fcml_st_operand operand, fcml_hints hints); |
| 538 |
|
| 539 |
/** Clones given instruction. |
| 540 |
* Allocates new instance of instruction and makes a deep copy of |
| 541 |
* all fields. Remember that cloned instructions have to be freed |
| 542 |
* using fcml_fn_cu_free_instruction() function. Do not try to free |
| 543 |
* it on your own because it might be allocated on different |
| 544 |
* dedicated memory heap. |
| 545 |
* @param instruction Instruction to be cloned. |
| 546 |
* @return Cloned instruction. |
| 547 |
*/ |
| 548 |
LIB_EXPORT fcml_st_instruction* LIB_CALL fcml_fn_cu_clone_instruction( |
| 549 |
fcml_st_instruction *instruction); |
| 550 |
|
| 551 |
/** Frees given instruction. |
| 552 |
* Frees instruction allocated by fcml_fn_cu_clone_instruction() function. |
| 553 |
* @param instruction Instruction to be freed. |
| 554 |
*/ |
| 555 |
LIB_EXPORT void LIB_CALL fcml_fn_cu_free_instruction( |
| 556 |
fcml_st_instruction *instruction); |
| 557 |
|
| 558 |
/** Gets operand of given type or NULL if there is no such operand. |
| 559 |
* If more than one operand of given type exist, the first one is returned. |
| 560 |
* @param instruction Finds an operand of the given type for for |
| 561 |
* given instruction. |
| 562 |
* @param operand_type Operand type. |
| 563 |
* @return Pointer to the operand of given type. |
| 564 |
*/ |
| 565 |
LIB_EXPORT fcml_st_operand* fcml_fn_cu_find_operand( |
| 566 |
fcml_st_instruction *instruction, fcml_en_operand_type operand_type); |
| 567 |
|
| 568 |
/* Some shortcuts for those who prefer to use macros instead of functions.*/ |
| 569 |
|
| 570 |
#define FCML_IMM8_S( x ) fcml_fn_cu_operand_signed_imm_8( x ) |
| 571 |
#define FCML_IMM8( x ) fcml_fn_cu_operand_unsigned_imm_8( x ) |
| 572 |
#define FCML_IMM16_S( x ) fcml_fn_cu_operand_signed_imm_16( x ) |
| 573 |
#define FCML_IMM16( x ) fcml_fn_cu_operand_unsigned_imm_16( x ) |
| 574 |
#define FCML_IMM32_S( x ) fcml_fn_cu_operand_signed_imm_32( x ) |
| 575 |
#define FCML_IMM32( x ) fcml_fn_cu_operand_unsigned_imm_32( x ) |
| 576 |
#define FCML_IMM64_S( x ) fcml_fn_cu_operand_signed_imm_64( x ) |
| 577 |
#define FCML_IMM64( x ) fcml_fn_cu_operand_unsigned_imm_64( x ) |
| 578 |
|
| 579 |
#ifdef FCML_USE_SHORT_REG |
| 580 |
#define FCML_REG( x ) fcml_fn_cu_operand_reg( &fcml_reg_##x ) |
| 581 |
#else |
| 582 |
#define FCML_REG( x ) fcml_fn_cu_operand_reg( &x ) |
| 583 |
#endif |
| 584 |
|
| 585 |
#define FCML_FAR_POINTER_16( seg, offset ) \ |
| 586 |
fcml_fn_cu_operand_addr_far_pointer_offset16( seg, offset ) |
| 587 |
#define FCML_FAR_POINTER_32( seg, offset ) \ |
| 588 |
fcml_fn_cu_operand_addr_far_pointer_offset32( seg, offset ) |
| 589 |
#define FCML_OFFSET_16( offset ) \ |
| 590 |
fcml_fn_cu_operand_addr_offset_16( offset ) |
| 591 |
#define FCML_OFFSET_32( offset ) \ |
| 592 |
fcml_fn_cu_operand_addr_offset_32( offset ) |
| 593 |
#define FCML_OFFSET_ABS_64( offset ) \ |
| 594 |
fcml_fn_cu_operand_addr_offset_abs_64( offset ) |
| 595 |
#define FCML_OFFSET_REL_64( offset ) \ |
| 596 |
fcml_fn_cu_operand_addr_offset_rel_64( offset ) |
| 597 |
#define FCML_DISP_16( offset ) \ |
| 598 |
fcml_fn_cu_operand_addr_disp_16( offset ) |
| 599 |
#define FCML_DISP_32( offset ) \ |
| 600 |
fcml_fn_cu_operand_addr_disp_32( offset ) |
| 601 |
#define FCML_DISP_64( offset ) \ |
| 602 |
fcml_fn_cu_operand_addr_disp_64( offset ) |
| 603 |
|
| 604 |
#ifdef FCML_USE_SHORT_REG |
| 605 |
#define FCML_B_DISP_8(base, offset) \ |
| 606 |
fcml_fn_cu_operand_addr_b_disp_8( &fcml_reg_##base, offset ) |
| 607 |
#define FCML_B_DISP_16(base, offset) \ |
| 608 |
fcml_fn_cu_operand_addr_b_disp_16( &fcml_reg_##base, offset ) |
| 609 |
#define FCML_B_DISP_32(base, offset) \ |
| 610 |
fcml_fn_cu_operand_addr_b_disp_32( &fcml_reg_##base, offset ) |
| 611 |
#define FCML_B_DISP_64(base, offset) \ |
| 612 |
fcml_fn_cu_operand_addr_b_disp_64( &fcml_reg_##base, offset ) |
| 613 |
#define FCML_IS_DISP_8(index, scale, offset) \ |
| 614 |
fcml_fn_cu_operand_addr_is_disp_8( &fcml_reg_##index, scale, offset ) |
| 615 |
#define FCML_IS_DISP_16(index, scale, offset) \ |
| 616 |
fcml_fn_cu_operand_addr_is_disp_32( &fcml_reg_##index, scale, offset ) |
| 617 |
#define FCML_IS_DISP_32(index, scale, offset) \ |
| 618 |
fcml_fn_cu_operand_addr_is_disp_64( &fcml_reg_##index, scale, offset ) |
| 619 |
#define FCML_BIS_DISP_8(base, index, scale, offset) \ |
| 620 |
fcml_fn_cu_operand_addr_bis_disp_8( &fcml_reg_##base, &fcml_reg_##index, \ |
| 621 |
scale, offset ) |
| 622 |
#define FCML_BIS_DISP_16(base, index, scale, offset) \ |
| 623 |
fcml_fn_cu_operand_addr_bis_disp_32( &fcml_reg_##base, &fcml_reg_##index, \ |
| 624 |
scale, offset ) |
| 625 |
#define FCML_BIS_DISP_32(base, index, scale, offset) \ |
| 626 |
fcml_fn_cu_operand_addr_bis_disp_64( &fcml_reg_##base, &fcml_reg_##index, \ |
| 627 |
scale, offset ) |
| 628 |
#else |
| 629 |
#define FCML_B_DISP_8(base, offset) \ |
| 630 |
fcml_fn_cu_operand_addr_b_disp_8( &base, offset ) |
| 631 |
#define FCML_B_DISP_16(base, offset) \ |
| 632 |
fcml_fn_cu_operand_addr_b_disp_16( &base, offset ) |
| 633 |
#define FCML_B_DISP_32(base, offset) \ |
| 634 |
fcml_fn_cu_operand_addr_b_disp_32( &base, offset ) |
| 635 |
#define FCML_B_DISP_64(base, offset) \ |
| 636 |
fcml_fn_cu_operand_addr_b_disp_64( &base, offset ) |
| 637 |
#define FCML_IS_DISP_8(index, scale, offset) \ |
| 638 |
fcml_fn_cu_operand_addr_is_disp_8( &index, scale, offset ) |
| 639 |
#define FCML_IS_DISP_16(index, scale, offset) \ |
| 640 |
fcml_fn_cu_operand_addr_is_disp_32( &index, scale, offset ) |
| 641 |
#define FCML_IS_DISP_32(index, scale, offset) \ |
| 642 |
fcml_fn_cu_operand_addr_is_disp_64( &index, scale, offset ) |
| 643 |
#define FCML_BIS_DISP_8(base, index, scale, offset) \ |
| 644 |
fcml_fn_cu_operand_addr_bis_disp_8( &base, &index, scale, offset ) |
| 645 |
#define FCML_BIS_DISP_16(base, index, scale, offset) \ |
| 646 |
fcml_fn_cu_operand_addr_bis_disp_32( &base, &index, scale, offset ) |
| 647 |
#define FCML_BIS_DISP_32(base, index, scale, offset) \ |
| 648 |
fcml_fn_cu_operand_addr_bis_disp_64( &base, &index, scale, offset ) |
| 649 |
#endif |
| 650 |
|
| 651 |
#define FCML_IS_INSTRUCTION_GROUP(result, group) \ |
| 652 |
( result.instruction_details.instruction_group & ( group ) ) |
| 653 |
#define FCML_IS_INSTRUCTION_CODE(result, _ins) \ |
| 654 |
( result.instruction_details.instruction == _ins ) |
| 655 |
|
| 656 |
#ifdef __cplusplus |
| 657 |
} |
| 658 |
#endif |
| 659 |
|
| 660 |
#endif /* FCML_COMMON_UTILS_H_ */ |