/* OpenIDA - Outil d'analyse de fichiers binaires
 * java.c - support du format Java
 *
 * Copyright (C) 2008 Cyrille Bagard
 *
 *  This file is part of OpenIDA.
 *
 *  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/>.
 */


#include "java.h"


#include <string.h>


#include "java-int.h"











/* Initialise la classe des formats d'exécutables Java. */
static void g_java_format_class_init(GJavaFormatClass *);

/* Initialise une instance de format d'exécutable Java. */
static void g_java_format_init(GJavaFormat *);

/* Indique le type d'architecture visée par le format. */
static FormatTargetMachine g_java_format_get_target_machine(const GJavaFormat *);

/* Fournit l'adresse mémoire du point d'entrée du programme. */
static vmpa_t g_java_format_get_entry_point(const GJavaFormat *);

/* Fournit les références aux zones binaires à analyser. */
static GBinPart **g_java_format_get_parts(const GJavaFormat *, size_t *);

/* Fournit la position correspondant à une adresse virtuelle. */
static bool g_java_format_translate_address_into_offset(const GJavaFormat *, vmpa_t, off_t *);

/* Fournit l'adresse virtuelle correspondant à une position. */
static bool g_java_format_translate_offset_into_address(const GJavaFormat *, off_t, vmpa_t *);



/******************************************************************************
*                                                                             *
*  Paramètres  : type    = type de format recherché.                          *
*                content = contenu binaire à parcourir.                       *
*                length  = taille du contenu en question.                     *
*                                                                             *
*  Description : Indique si le format peut être pris en charge ici.           *
*                                                                             *
*  Retour      : true si la réponse est positive, false sinon.                *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool java_is_matching(FormatType type, const uint8_t *content, off_t length)
{
    bool result;                            /* Bilan à faire connaître     */

    result = false;

    if (length >= 4)
        result = (strncmp((const char *)content, "\xca\xfe\xba\xbe", 4) == 0);

    return result;

}


/* Indique le type défini pour un format d'exécutable Java. */
G_DEFINE_TYPE(GJavaFormat, g_java_format, G_TYPE_EXE_FORMAT);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des formats d'exécutables Java.         *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_java_format_class_init(GJavaFormatClass *klass)
{

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = instance à initialiser.                             *
*                                                                             *
*  Description : Initialise une instance de format d'exécutable Java.         *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_java_format_init(GJavaFormat *format)
{
    GExeFormat *exe_format;                 /* Format parent à constituer  */

    exe_format = G_EXE_FORMAT(format);

    exe_format->get_machine = (get_target_machine_fc)g_java_format_get_target_machine;
    exe_format->get_entry_point = (get_entry_point_fc)g_java_format_get_entry_point;
    exe_format->get_parts = (get_parts_fc)g_java_format_get_parts;

    exe_format->translate_addr = (translate_addr_fc)g_java_format_translate_address_into_offset;
    exe_format->translate_off = (translate_off_fc)g_java_format_translate_offset_into_address;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : content = contenu binaire à parcourir.                       *
*                length  = taille du contenu en question.                     *
*                                                                             *
*  Description : Prend en charge un nouveau format Java.                      *
*                                                                             *
*  Retour      : Adresse de la structure mise en place ou NULL en cas d'échec.*
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GBinFormat *g_java_format_new(const bin_t *content, off_t length)
{
    GJavaFormat *result;                      /* Structure à retourner       */
    off_t offset;                           /* Tête de lecture             */

    result = g_object_new(G_TYPE_JAVA_FORMAT, NULL);

    g_binary_format_set_content(G_BIN_FORMAT(result), content, length);


    offset = 0;

    if (!read_java_header(result, &offset, &result->header))
    {
        /* TODO */
        return NULL;
    }


    return G_BIN_FORMAT(result);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = informations chargées à consulter.                  *
*                                                                             *
*  Description : Indique le type d'architecture visée par le format.          *
*                                                                             *
*  Retour      : Identifiant de l'architecture ciblée par le format.          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static FormatTargetMachine g_java_format_get_target_machine(const GJavaFormat *format)
{
    FormatTargetMachine result;             /* Identifiant à retourner     */

    result = FTM_386;

    /*
    switch (format->header.e_machine)
    {
        case EM_MIPS:
            result = FTM_MIPS;
            break;

        case EM_386:
            result = FTM_386;
            break;

        case EM_NONE:
        default:
            result = FTM_NONE;
            break;

    }
    */

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = informations chargées à consulter.                  *
*                                                                             *
*  Description : Fournit l'adresse mémoire du point d'entrée du programme.    *
*                                                                             *
*  Retour      : Adresse de mémoire.                                          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static vmpa_t g_java_format_get_entry_point(const GJavaFormat *format)
{
    return 0;//(format->is_32b ? format->header.e_entry.addr32 : format->header.e_entry.addr64);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = informations chargées à consulter.                  *
*                count  = quantité de zones listées. [OUT]                    *
*                                                                             *
*  Description : Fournit les références aux zones binaires à analyser.        *
*                                                                             *
*  Retour      : Zones binaires à analyser.                                   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static GBinPart **g_java_format_get_parts(const GJavaFormat *format, size_t *count)
{
    GBinPart **result;                      /* Tableau à retourner         */
    uint16_t i;                             /* Boucle de parcours          */
    off_t offset;                           /* Position physique           */
    off_t size;                             /* Taille de la partie         */
    GBinPart *part;                         /* Partie à intégrer à la liste*/

    result = NULL;
    *count = 0;
    /*
    for (i = 0; i < format->header.methods_count; i++)
        if (find_java_method_code_part(&format->header.methods[i], &offset, &size))
        {
            part = g_binary_part_new();

            g_binary_part_set_name(part, "name");

            g_binary_part_set_values(part, offset, size, offset);

            result = (GBinPart **)realloc(result, ++(*count) * sizeof(GBinPart *));
            result[*count - 1] = part;

        }

    }
    */

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = description de l'exécutable à consulter.            *
*                addr   = adresse virtuelle à retrouver.                      *
*                pos    = position correspondante. [OUT]                      *
*                                                                             *
*  Description : Fournit la position correspondant à une adresse virtuelle.   *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool g_java_format_translate_address_into_offset(const GJavaFormat *format, vmpa_t addr, off_t *pos)
{
    bool result;                            /* Bilan à retourner           */

    result = false;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = description de l'exécutable à consulter.            *
*                pos    = position dans le flux binaire à retrouver.          *
*                addr   = adresse virtuelle correspondante. [OUT]             *
*                                                                             *
*  Description : Fournit l'adresse virtuelle correspondant à une position.    *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool g_java_format_translate_offset_into_address(const GJavaFormat *format, off_t pos, vmpa_t *addr)
{
    bool result;                            /* Bilan à retourner           */

    result = false;

    return result;

}



















#if 0

#include <malloc.h>
#include <string.h>


#include "attribute.h"
#include "field.h"
#include "java-int.h"
#include "method.h"
#include "pool.h"
#include "../../common/endianness.h"




/* Indique le type d'architecture visée par le format. */
FormatTargetMachine get_java_target_machine(const java_format *);



/* Fournit les références aux zones de code à analyser. */
bin_part **get_java_default_code_parts(const java_format *, size_t *);


/* Fournit le prototype de toutes les routines détectées. */
GBinRoutine **get_all_java_routines(const java_format *, size_t *);





/******************************************************************************
*                                                                             *
*  Paramètres  : content = contenu binaire à parcourir.                       *
*                length  = taille du contenu en question.                     *
*                                                                             *
*  Description : Indique si le format peut être pris en charge ici.           *
*                                                                             *
*  Retour      : true si la réponse est positive, false sinon.                *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool java_is_matching(const uint8_t *content, off_t length)
{
    bool result;                            /* Bilan à faire connaître     */

    result = false;

    if (length >= 4)
        result = (strncmp((const char *)content, "\xca\xfe\xba\xbe", 4) == 0);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : content = contenu binaire à parcourir.                       *
*                length  = taille du contenu en question.                     *
*                                                                             *
*  Description : Prend en charge une nouvelle classe Java.                    *
*                                                                             *
*  Retour      : Adresse de la structure mise en place ou NULL en cas d'échec.*
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

exe_format *load_java(const uint8_t *content, off_t length)
{
    java_format *result;                    /* Adresse à retourner         */
    off_t pos;                              /* Point d'analyse             */
    uint32_t magic;                         /* Identifiant Java            */
    uint16_t i;                             /* Boucle de parcours          */

    result = (java_format *)calloc(1, sizeof(java_format));

    EXE_FORMAT(result)->content = content;
    EXE_FORMAT(result)->length = length;

    EXE_FORMAT(result)->get_target_machine = (get_target_machine_fc)get_java_target_machine;
    EXE_FORMAT(result)->get_def_parts = (get_def_parts_fc)get_java_default_code_parts;
    EXE_FORMAT(result)->get_all_routines = (get_all_routines_fc)get_all_java_routines;

    pos = 0;

    if (!read_u32(&magic, content, &pos, length, SRE_BIG))
        goto ldj_error;

    if (!read_u16(&result->minor_version, content, &pos, length, SRE_BIG))
        goto ldj_error;

    if (!read_u16(&result->major_version, content, &pos, length, SRE_BIG))
        goto ldj_error;

    if (!load_java_pool(result, &pos))
        goto ldj_error;

    if (!read_u16((uint16_t *)&result->access, content, &pos, length, SRE_BIG))
        goto ldj_error;

    if (!read_u16(&result->this_class, content, &pos, length, SRE_BIG))
        goto ldj_error;

    if (!read_u16(&result->super_class, content, &pos, length, SRE_BIG))
        goto ldj_error;

    if (!read_u16(&result->interfaces_count, content, &pos, length, SRE_BIG))
       goto ldj_error;

    for (i = 0; i < result->interfaces_count; i++)
        if (!read_u16(&result->interfaces[i], content, &pos, length, SRE_BIG))
            goto ldj_error;

    if (!load_java_fields(result, &pos))
        goto ldj_error;

    if (!load_java_methods(result, &pos))
        goto ldj_error;

    if (!load_java_attributes(result, &pos, &result->attributes, &result->attributes_count))
        goto ldj_error;

    return EXE_FORMAT(result);

 ldj_error:

    unload_java(result);

    return NULL;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : format = description de l'exécutable à supprimer.            *
*                                                                             *
*  Description : Efface la prise en charge une nouvelle classe Java.          *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void unload_java(java_format *format)
{
    if (format->pool_len > 0)
        unload_java_pool(format);

    if (format->interfaces_count > 0)
        free(format->interfaces);

    if (format->fields_count > 0)
        unload_java_fields(format);

    if (format->methods_count > 0)
        unload_java_methods(format);

    if (format->attributes_count > 0)
        unload_java_attributes(format, format->attributes, format->attributes_count);

    free(format);

}





/******************************************************************************
*                                                                             *
*  Paramètres  : format = informations chargées à consulter.                  *
*                                                                             *
*  Description : Indique le type d'architecture visée par le format.          *
*                                                                             *
*  Retour      : Identifiant de l'architecture ciblée par le format.          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

FormatTargetMachine get_java_target_machine(const java_format *format)
{
    return FTM_JVM;

}





/******************************************************************************
*                                                                             *
*  Paramètres  : format = informations chargées à consulter.                  *
*                count  = quantité de zones listées. [OUT]                    *
*                                                                             *
*  Description : Fournit les références aux zones de code à analyser.         *
*                                                                             *
*  Retour      : Zones de code à analyser.                                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bin_part **get_java_default_code_parts(const java_format *format, size_t *count)
{
    bin_part **result;                      /* Tableau à retourner         */
    uint16_t i;                             /* Boucle de parcours          */
    off_t offset;                           /* Position physique           */
    off_t size;                             /* Taille de la partie         */
    bin_part *part;                         /* Partie à intégrer à la liste*/

    result = NULL;
    *count = 0;

    for (i = 0; i < format->methods_count; i++)
        if (find_java_method_code_part(&format->methods[i], &offset, &size))
        {
            part = create_bin_part();

            set_bin_part_values(part, offset, size, offset);

            result = (bin_part **)realloc(result, ++(*count) * sizeof(bin_part *));
            result[*count - 1] = part;

        }

    return result;

}




/******************************************************************************
*                                                                             *
*  Paramètres  : format = informations chargées à consulter.                  *
*                count  = taille du tableau créé. [OUT]                       *
*                                                                             *
*  Description : Fournit le prototype de toutes les routines détectées.       *
*                                                                             *
*  Retour      : Tableau créé ou NULL si aucun symbole de routine trouvé.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GBinRoutine **get_all_java_routines(const java_format *format, size_t *count)
{
    *count = 0;

    return NULL;

}

#endif