/* Chrysalide - Outil d'analyse de fichiers binaires
 * instruction.h - prototypes pour la gestion générique des instructions
 *
 * Copyright (C) 2008-2013 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  OpenIDA is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  OpenIDA is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */


#ifndef _ARCH_INSTRUCTION_H
#define _ARCH_INSTRUCTION_H


#include <sys/types.h>


#include "context.h"
#include "immediate.h"
#include "register.h"
#include "vmpa.h"
#include "../analysis/content.h"
#include "../analysis/type.h"
#include "../decomp/context.h"
#include "../decomp/instruction.h"
//#include "../format/executable.h"
//#include "../format/format.h"



#define G_TYPE_ARCH_INSTRUCTION               g_arch_instruction_get_type()
#define G_ARCH_INSTRUCTION(obj)               (G_TYPE_CHECK_INSTANCE_CAST((obj), g_arch_instruction_get_type(), GArchInstruction))
#define G_IS_ARCH_INSTRUCTION(obj)            (G_TYPE_CHECK_INSTANCE_TYPE((obj), g_arch_instruction_get_type()))
#define G_ARCH_INSTRUCTION_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass), G_TYPE_ARCH_INSTRUCTION, GArchInstructionClass))
#define G_IS_ARCH_INSTRUCTION_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass), G_TYPE_ARCH_INSTRUCTION))
#define G_ARCH_INSTRUCTION_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), G_TYPE_ARCH_INSTRUCTION, GArchInstructionClass))


/* Définition générique d'une instruction d'architecture (instance) */
typedef struct _GArchInstruction GArchInstruction;

/* Définition générique d'une instruction d'architecture (classe) */
typedef struct _GArchInstructionClass GArchInstructionClass;


/* Indique le type défini pour une instruction d'architecture. */
GType g_arch_instruction_get_type(void);

/* Indique l'encodage d'une instruction de façon détaillée. */
const char *g_arch_instruction_get_encoding(const GArchInstruction *);

/* Précise l'encodage d'une instruction de façon détaillée. */
void g_arch_instruction_set_encoding(GArchInstruction *, const char *);

/* Etend la désignation d'un nom d'instruction. */
void g_arch_instruction_append_suffix(GArchInstruction *, const char *);

/* Drapeaux pour informations complémentaires */
typedef enum _ArchInstrFlag
{
    AIF_NONE            = (0 << 0),         /* Aucune information          */
    AIF_ROUTINE_START   = (1 << 0),         /* Début de routine            */
    AIF_RETURN_POINT    = (1 << 1)          /* Retour de fonction appelée  */

} ArchInstrFlag;

/* Ajoute une information complémentaire à une instruction. */
bool g_arch_instruction_set_flag(GArchInstruction *, ArchInstrFlag);

/* Fournit les informations complémentaires d'une instruction. */
ArchInstrFlag g_arch_instruction_get_flags(const GArchInstruction *);


/**
 * La définition de "GBinFormat", utile aux traitements complémentaires, ne peut
 * se faire en incluant le fichier d'en-tête "../format/format.h", pour cause
 * de références circulaires.
 *
 * On procède donc à une seconde déclaration, en attendant éventuellement mieux.
 *
 * Pareil pour "GArchProcessor", définie dans le fichier "processor.h", lequel
 * inclut directement ce fichier.
 */

/* Format binaire générique (instance) */
typedef struct _GBinFormat GBinFormat;

/* Ligne de représentation générique (instance) */
typedef struct _GArchProcessor GArchProcessor;


/* Types de crochet de traitement */
typedef enum _InstrProcessHook
{
    IPH_FETCH,                              /* Itinéraire de désassemblage */
    IPH_LINK,                               /* Edition des liens           */
    IPH_POST,                               /* Résolution des symboles     */

    IPH_COUNT

} InstrProcessHook;

/* Complète un désassemblage accompli pour une instruction. */
typedef void (* instr_hook_fc) (GArchInstruction *, GArchProcessor *, GProcContext *, GBinFormat *);

/* Définit un traitement complémentare au désassemblage. */
void g_arch_instruction_set_hook(GArchInstruction *, InstrProcessHook, instr_hook_fc);

/* Complète un désassemblage accompli pour une instruction. */
void g_arch_instruction_call_hook(GArchInstruction *, InstrProcessHook, GArchProcessor *, GProcContext *, GBinFormat *);

/* Définit la localisation d'une instruction. */
void g_arch_instruction_set_range(GArchInstruction *, const mrange_t *);

/* Fournit la place mémoire d'une instruction. */
const mrange_t *g_arch_instruction_get_range(const GArchInstruction *);



/* Fournit la localisation d'une instruction. */
void g_arch_instruction_get_location(const GArchInstruction *, off_t *, off_t *, vmpa_t *);



/* Attache un opérande supplémentaire à une instruction. */
void g_arch_instruction_attach_extra_operand(GArchInstruction *, GArchOperand *);

/* Indique la quantité d'opérandes présents dans l'instruction. */
size_t g_arch_instruction_count_operands(const GArchInstruction *);

/* Fournit un opérande donné d'une instruction. */
GArchOperand *g_arch_instruction_get_operand(const GArchInstruction *, size_t);

/* Remplace un opérande d'une instruction par un autre. */
void g_arch_instruction_replace_operand(GArchInstruction *, GArchOperand *, const GArchOperand *);

/* Détache un opérande liée d'une instruction. */
void g_arch_instruction_detach_operand(GArchInstruction *, GArchOperand *);

/* Liste les registres lus et écrits par l'instruction. */
void g_arch_instruction_get_rw_registers(const GArchInstruction *, GArchRegister ***, size_t *, GArchRegister ***, size_t *);



/* ------------------- DEFINITION DES LIAISONS ENTRE INSTRUCTIONS ------------------- */


/* Typage des instructions rencontrées */
typedef enum _InstructionLinkType
{
    ILT_NONE,                               /* Aucune instruction visée    */
    ILT_EXEC_FLOW,                          /* Raccord attendu entre blocs */
    ILT_JUMP,                               /* Saut inconditionnel         */
    ILT_CASE_JUMP,                          /* Saut suite à aiguillage     */
    ILT_JUMP_IF_TRUE,                       /* Saut conditionnel (si vrai) */
    ILT_JUMP_IF_FALSE,                      /* Saut conditionnel (si faux) */
    ILT_LOOP,                               /* Retour en arrière (boucle)  */
    ILT_CALL,                               /* Appel d'une fonction        */
    ILT_CATCH_EXCEPTION,                    /* Gestion d'une exception     */
    ILT_REF                                 /* Simple référence croisée    */

} InstructionLinkType;

/* Informations complémentaires pour un lien */
typedef union _link_extra_info
{
    GImmOperand *imm;                       /* Valeur d'un cas de switch() */
    GDataType *type;                        /* Type d'une exception        */

} link_extra_info;


/* Etablit un lien entre deux instructions. */
void g_arch_instruction_link_with(GArchInstruction *, GArchInstruction *, InstructionLinkType, ...);

/* Change la nature d'un lien entre deux instructions. */
bool g_arch_instruction_change_link(GArchInstruction *, GArchInstruction *, InstructionLinkType, InstructionLinkType);

/* Met à disposition un encadrement des accès aux sources. */
void g_arch_instruction_lock_unlock_sources(GArchInstruction *, bool, bool);

#define g_arch_instruction_wlock_src(ins) g_arch_instruction_lock_unlock_sources(ins, true, true)
#define g_arch_instruction_wunlock_src(ins) g_arch_instruction_lock_unlock_sources(ins, true, false)

#define g_arch_instruction_rlock_src(ins) g_arch_instruction_lock_unlock_sources(ins, false, true)
#define g_arch_instruction_runlock_src(ins) g_arch_instruction_lock_unlock_sources(ins, false, false)

/* Indique si l'instruction a une ou plusieurs origines. */
bool g_arch_instruction_has_sources(const GArchInstruction *);

/* Fournit les origines d'une instruction donnée. */
size_t g_arch_instruction_get_sources(const GArchInstruction *, GArchInstruction ***, InstructionLinkType **);

/* Met à disposition un encadrement des accès aux destinations. */
void g_arch_instruction_lock_unlock_destinations(GArchInstruction *, bool, bool);

#define g_arch_instruction_wlock_dest(ins) g_arch_instruction_lock_unlock_destinations(ins, true, true)
#define g_arch_instruction_wunlock_dest(ins) g_arch_instruction_lock_unlock_destinations(ins, true, false)

#define g_arch_instruction_rlock_dest(ins) g_arch_instruction_lock_unlock_destinations(ins, false, true)
#define g_arch_instruction_runlock_dest(ins) g_arch_instruction_lock_unlock_destinations(ins, false, false)

/* Indique si l'instruction a une suite autre que la suivante. */
bool g_arch_instruction_has_destinations(const GArchInstruction *);

/* Fournit les destinations d'une instruction donnée. */
size_t g_arch_instruction_get_destinations(const GArchInstruction *, GArchInstruction ***, InstructionLinkType **, link_extra_info **);

/* Fournit la destination d'une instruction et d'un type donné. */
GArchInstruction *g_arch_instruction_get_given_destination(const GArchInstruction *, InstructionLinkType);

/* Indique la position dans les instructions identiques. */
size_t g_arch_instruction_compute_group_index(GArchInstruction **, GArchInstruction **, size_t);



/* --------------------- CONVERSIONS DU FORMAT DES INSTRUCTIONS --------------------- */


/* Fournit le nom humain de l'instruction manipulée. */
const char *g_arch_instruction_get_keyword(const GArchInstruction *, AsmSyntax);

/* Indique si elle existe la quantité maximale de code affiché. */
phys_t g_arch_instruction_get_displayed_max_length(const GArchInstruction *);

/* Définit la quantité maximale de code affiché. */
void g_arch_instruction_set_displayed_max_length(GArchInstruction *, phys_t);

/* Ajoute à un tampon GLib le contenu de l'instance spécifiée. */
GBufferLine *g_arch_instruction_print(const GArchInstruction *, GCodeBuffer *, MemoryDataSize, const GBinContent *, AsmSyntax);

/* Décompile une instruction de façon générique. */
GDecInstruction *g_arch_instruction_decompile(const GArchInstruction *, GDecContext *);



/* -------------------- TRAITEMENT DES INSTRUCTIONS PAR ENSEMBLE -------------------- */


/* Renvoie vers la dernière instruction d'une série. */
GArchInstruction *g_arch_instruction_find_last(const GArchInstruction *);

/* Ajoute une instruction à un ensemble existant. */
void g_arch_instruction_add_to_list(GArchInstruction **, GArchInstruction *);

/* Fusionne deux listes d'instructions. */
void g_arch_instruction_merge_lists(GArchInstruction **, GArchInstruction **);

/* Fournit l'élement suivant un autre pour un parcours. */
GArchInstruction *g_arch_instruction_get_prev_iter(const GArchInstruction *, const GArchInstruction *);

/* Fournit l'élement suivant un autre pour un parcours. */
GArchInstruction *g_arch_instruction_get_next_iter(const GArchInstruction *, const GArchInstruction *, vmpa_t);

/* Recherche une instruction d'après son emplacement mémoire. */
GArchInstruction *g_arch_instruction_find_by_range(GArchInstruction *, const mrange_t *);

/* Recherche une instruction d'après son adresse. */
GArchInstruction *g_arch_instruction_find_by_address(GArchInstruction *, const vmpa2t *, bool) __attribute__ ((deprecated));
/* -> g_arch_processor_find_instr_by_address */



#endif  /* _ARCH_INSTRUCTION_H */