/* OpenIDA - Outil d'analyse de fichiers binaires
* layout.c - mise en place de graphique
*
* Copyright (C) 2009-2013 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 .
*/
#include "layout.h"
#include
#include
#include
#include "dot.h"
#include "node.h"
#include "nodes/flow.h"
#include "../gtkbufferview.h"
#include "../../analysis/binary.h"
#include "../../analysis/blocks/flow.h"
#include "../../common/extstr.h"
/* Taille maximale des noms de classement */
#define RANK_DESC_LEN 128
/* Taille maximale des introductions aux clusters */
#define CLUSTER_DESC_LEN 128
/* Taille maximale des descriptions de liens */
#define LINKS_DESC_LEN 128
/* Paramètres de construction des commandes */
typedef struct _visitor_dot_params
{
GGraphNode **nodes; /* Intermédiaires en place */
size_t count; /* Quantité de noeuds en place */
char **ranks; /* Profondeurs des blocs */
unsigned int level; /* Profondeur de la visite */
char *cmds; /* Description à envoyer à dot */
} visitor_dot_params;
/* Construit les rangs pour dot en parcourant les noeuds. */
static bool rank_graph_nodes(GInstrBlock *, BlockVisitOrder, visitor_dot_params *);
/* Etablit le classement de tous les prochains noeuds pour dot. */
static void build_graph_ranking(visitor_dot_params *);
/* Construit les commandes pour dot en parcourant les noeuds. */
static bool register_graph_nodes(GInstrBlock *, BlockVisitOrder, visitor_dot_params *);
/* Etablit tous les liens entre les différents morceaux de code. */
static char *complete_graph_links(const GtkGraphView *, GtkViewPanel **, size_t, char *);
/******************************************************************************
* *
* Paramètres : view = support où placer les différents éléments. *
* views = morceaux de code à afficher de façon organisée. *
* count = quantité de ces morceaux de code. *
* *
* Description : Dispose une série de morceaux d'affichage en graphique. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
bool build_graph_view(GtkGraphView *view, GInstrBlock *blocks, GtkViewPanel **views, size_t count)
{
visitor_dot_params params; /* Paramètres de construction */
size_t i; /* Boucle de parcours */
graph_layout *layout; /* Graphique construit */
GtkLinkRenderer **links; /* Liens graphiques construits */
size_t links_count; /* Quantité de ces liens */
/* Création de la glue */
params.nodes = (GGraphNode **)calloc(count, sizeof(GGraphNode *));
params.count = count;
for (i = 0; i < count; i++)
params.nodes[i] = g_graph_node_new(GTK_WIDGET(views[i]));
/* Définition du graphique */
params.level = 1;
params.cmds = strdup("digraph G {\n overlap=false;\n splines=ortho;\n compound=true;\n");
params.ranks = (char **)calloc(count, sizeof(char *));
g_instr_block_visit(blocks, (instr_block_visitor_cb)rank_graph_nodes, ¶ms);
build_graph_ranking(¶ms);
g_instr_block_visit(blocks, (instr_block_visitor_cb)register_graph_nodes, ¶ms);
params.cmds = complete_graph_links(view, views, count, params.cmds);
params.cmds = stradd(params.cmds, "}");
layout = create_graph_layout(params.cmds);
/* Affichage du graphique */
place_nodes_of_graph_layout(layout, view, params.nodes, count);
links = create_links_from_graph_layout(layout, &links_count, params.nodes, count);
gtk_graph_view_attach_links(view, links, links_count);
gtk_widget_queue_draw(GTK_WIDGET(view));
delete_graph_layout(layout);
for (i = 0; i < count; i++)
g_object_unref(params.nodes[i]);
return true;
}
/******************************************************************************
* *
* Paramètres : block = bloc d'instructions concerné par la visite. *
* order = position dans la visite. *
* params = informations à mettre à jour pour dot. *
* *
* Description : Construit les rangs pour dot en parcourant les noeuds. *
* *
* Retour : true si le parcours a été jusqu'à son terme, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
static bool rank_graph_nodes(GInstrBlock *block, BlockVisitOrder order, visitor_dot_params *params)
{
vmpa_t start; /* Adresse de départ d'un bloc */
GGraphNode *node; /* Noeud rattaché */
unsigned int rank; /* Classement du bloc lié */
if (G_IS_FLOW_BLOCK(block))
{
g_flow_block_get_boundary_addresses(G_FLOW_BLOCK(block), &start, NULL);
node = find_graph_node_by_start_address(params->nodes, params->count, start);
rank = g_flow_block_get_rank(G_FLOW_BLOCK(block));
/* BUG_ON(count >= params->count) */
params->ranks[rank] = g_graph_node_append_name_to_rank(node, params->ranks[rank]);
}
return true;
}
/******************************************************************************
* *
* Paramètres : params = informations à mettre à jour pour dot. *
* *
* Description : Etablit le classement de tous les prochains noeuds pour dot. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void build_graph_ranking(visitor_dot_params *params)
{
unsigned int id; /* Identifiant unique */
size_t i; /* Boucle de parcours #1 */
char buffer[RANK_DESC_LEN]; /* Tampon pour les commandes */
unsigned int j; /* Boucle de parcours #2 */
id = 0;
for (i = 0; i < params->count; i++)
{
if (params->ranks[i] == NULL)
continue;
snprintf(buffer, CLUSTER_DESC_LEN, DOT_IDENT "{ rank = same; rk%u;", id++);
params->cmds = stradd(params->cmds, buffer);
params->cmds = stradd(params->cmds, params->ranks[i]);
params->cmds = stradd(params->cmds, " }\n");
}
params->cmds = stradd(params->cmds, DOT_IDENT);
for (j = 0; j < id; j++)
{
if (j == 0)
snprintf(buffer, CLUSTER_DESC_LEN, "rk%u", j);
else
snprintf(buffer, CLUSTER_DESC_LEN, " -> rk%u", j);
params->cmds = stradd(params->cmds, buffer);
}
params->cmds = stradd(params->cmds, "\n");
}
/******************************************************************************
* *
* Paramètres : block = bloc d'instructions concerné par la visite. *
* order = position dans la visite. *
* params = informations à mettre à jour pour dot. *
* *
* Description : Construit les commandes pour dot en parcourant les noeuds. *
* *
* Retour : true si le parcours a été jusqu'à son terme, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
static bool register_graph_nodes(GInstrBlock *block, BlockVisitOrder order, visitor_dot_params *params)
{
char *cmds; /* Raccourci d'usage pratique */
vmpa_t start; /* Adresse de départ d'un bloc */
GGraphNode *node; /* Noeud rattaché */
unsigned int i; /* Boucle de parcours */
char buffer[CLUSTER_DESC_LEN]; /* Tampon pour les commandes */
cmds = params->cmds;
if (G_IS_FLOW_BLOCK(block))
{
g_flow_block_get_boundary_addresses(G_FLOW_BLOCK(block), &start, NULL);
node = find_graph_node_by_start_address(params->nodes, params->count, start);
cmds = g_graph_node_register_for_dot(node, cmds, params->level);
}
else
{
if (order == BVO_IN)
{
for (i = 0; i < params->level; i++)
cmds = stradd(cmds, DOT_IDENT);
snprintf(buffer, CLUSTER_DESC_LEN, "subgraph cluster_v%p {\n", block);
cmds = stradd(cmds, buffer);
params->level++;
for (i = 0; i < params->level; i++)
cmds = stradd(cmds, DOT_IDENT);
cmds = stradd(cmds, "style=invisible;\n");
}
else if (order == BVO_OUT)
{
params->level--;
for (i = 0; i < params->level; i++)
cmds = stradd(cmds, DOT_IDENT);
cmds = stradd(cmds, "}\n");
}
}
params->cmds = cmds;
return true;
}
/******************************************************************************
* *
* Paramètres : view = support contenant les différentes lignes. *
* views = morceaux de code à afficher de façon organisée. *
* count = quantité de ces morceaux de code. *
* desc = description du graphique à compléter. [OUT] *
* *
* Description : Etablit tous les liens entre les différents morceaux de code.*
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static char *complete_graph_links(const GtkGraphView *view, GtkViewPanel **views, size_t count, char *desc)
{
GLoadedBinary *binary; /* Binaire rattaché aux vues */
GArchInstruction *instrs; /* Instructions pour assembleur*/
GBufferView *buffer; /* Tampon d'une partie de code */
vmpa_t end; /* Adresse finale du tampon */
size_t i; /* Boucle de parcours #1 */
GArchInstruction *last; /* Dernière instruc. d'un bloc */
vmpa_t addr; /* Addresse d'instruction */
GArchInstruction **dests; /* Instr. visée par une autre */
InstructionLinkType *types; /* Type de lien entre lignes */
size_t dcount; /* Nombre de liens de dest. */
size_t j; /* Boucle de parcours #2 */
size_t k; /* Boucle de parcours #3 */
char cmd[LINKS_DESC_LEN]; /* Tampon pour l'ajout de liens*/
if (count == 0)
return desc;
binary = gtk_view_panel_get_binary(views[0]);
instrs = g_loaded_binary_get_instructions(binary);
for (i = 0; i < count; i++)
{
buffer = gtk_buffer_view_get_buffer(GTK_BUFFER_VIEW(views[i]));
g_buffer_view_get_restrictions(buffer, NULL, &end);
last = g_arch_instruction_find_by_address(instrs, end, true);
g_arch_instruction_get_location(last, NULL, NULL, &addr);
if (g_arch_instruction_has_destinations(last))
{
dcount = g_arch_instruction_get_destinations(last, &dests, &types, NULL);
for (j = 0; j < dcount; j++)
{
g_arch_instruction_get_location(dests[j], NULL, NULL, &addr);
for (k = 0; k < count; k++)
if (gtk_view_panel_contain_address(views[k], addr))
break;
if (k < count)
switch (types[j])
{
case ILT_EXEC_FLOW:
case ILT_JUMP:
case ILT_CASE_JUMP:
snprintf(cmd, LINKS_DESC_LEN,
"_%p:s -> _%p:n [ltail=cluster_%p, lhead=cluster_%p];\n",
views[i], views[k], views[i], views[k]);
desc = stradd(desc, cmd);
break;
case ILT_JUMP_IF_TRUE:
snprintf(cmd, LINKS_DESC_LEN,
"_%p:s -> _%p:n [ltail=cluster_%p, lhead=cluster_%p, " \
"color=green];\n",
views[i], views[k], views[i], views[k]);
desc = stradd(desc, cmd);
break;
case ILT_JUMP_IF_FALSE:
snprintf(cmd, LINKS_DESC_LEN,
"_%p:s -> _%p:n [ltail=cluster_%p, lhead=cluster_%p, " \
"color=red];\n",
views[i], views[k], views[i], views[k]);
desc = stradd(desc, cmd);
break;
case ILT_LOOP:
snprintf(cmd, LINKS_DESC_LEN,
"_%p:s -> _%p:n [ltail=cluster_%p, lhead=cluster_%p, " \
"color=blue];\n",
views[i], views[k], views[i], views[k]);
desc = stradd(desc, cmd);
break;
case ILT_CATCH_EXCEPTION:
snprintf(cmd, LINKS_DESC_LEN,
"_%p:s -> _%p:n [ltail=cluster_%p, lhead=cluster_%p, " \
"color=gray];\n",
views[i], views[k], views[i], views[k]);
desc = stradd(desc, cmd);
break;
default:
break;
}
}
}
}
return desc;
}
#include "ranks.h"
#include "nodes/virtual.h"
/* Mise en disposition de blocs en graphique (instance) */
struct _GGraphLayout
{
GObject parent; /* A laisser en premier */
GGraphNode *nodes; /* Noeuds graphiques gérés */
GGraphRanks *ranks; /* Classement en rangs */
GGraphEdge **edges; /* Liens entre les noeuds */
size_t edges_count; /* Quantité de ces liens */
};
/* Mise en disposition de blocs en graphique (classe) */
struct _GGraphLayoutClass
{
GObjectClass parent; /* A laisser en premier */
};
/* Initialise la classe des mises en disposition graphique. */
static void g_graph_layout_class_init(GGraphLayoutClass *);
/* Initialise une mise en disposition de blocs en graphique. */
static void g_graph_layout_init(GGraphLayout *);
/* Supprime toutes les références externes. */
static void g_graph_layout_dispose(GGraphLayout *);
/* Procède à la libération totale de la mémoire. */
static void g_graph_layout_finalize(GGraphLayout *);
/* Indique le type définit par la GLib pour les mises en disposition graphique. */
G_DEFINE_TYPE(GGraphLayout, g_graph_layout, G_TYPE_OBJECT);
/******************************************************************************
* *
* Paramètres : klass = classe à initialiser. *
* *
* Description : Initialise la classe des mises en disposition graphique. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_graph_layout_class_init(GGraphLayoutClass *klass)
{
GObjectClass *object; /* Autre version de la classe */
object = G_OBJECT_CLASS(klass);
object->dispose = (GObjectFinalizeFunc/* ! */)g_graph_layout_dispose;
object->finalize = (GObjectFinalizeFunc)g_graph_layout_finalize;
}
/******************************************************************************
* *
* Paramètres : layout = instance à initialiser. *
* *
* Description : Initialise une mise en disposition de blocs en graphique. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_graph_layout_init(GGraphLayout *layout)
{
}
/******************************************************************************
* *
* Paramètres : node = instance d'objet GLib à traiter. *
* *
* Description : Supprime toutes les références externes. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_graph_layout_dispose(GGraphLayout *layout)
{
g_object_unref(G_OBJECT(layout->nodes));
g_object_unref(G_OBJECT(layout->ranks));
G_OBJECT_CLASS(g_graph_layout_parent_class)->dispose(G_OBJECT(layout));
}
/******************************************************************************
* *
* Paramètres : layout = instance d'objet GLib à traiter. *
* *
* Description : Procède à la libération totale de la mémoire. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_graph_layout_finalize(GGraphLayout *layout)
{
G_OBJECT_CLASS(g_graph_layout_parent_class)->finalize(G_OBJECT(layout));
}
/******************************************************************************
* *
* Paramètres : blocks = ensemble des blocs basiques déjà découpés. *
* views = morceaux de code à afficher de façon organisée. *
* count = quantité de ces morceaux de code. *
* *
* Description : Construit un graphique à partir de blocs basiques. *
* *
* Retour : Adresse de la structure mise en place. *
* *
* Remarques : - *
* *
******************************************************************************/
GGraphLayout *g_graph_layout_new(GInstrBlock *blocks, GtkBufferView **views, size_t count)
{
GGraphLayout *result; /* Structure à retourner */
result = g_object_new(G_TYPE_GRAPH_LAYOUT, NULL);
result->nodes = convert_blocks_into_nodes(blocks, views, count);
result->ranks = g_graph_ranks_new(count);
/* Situations verticales grossières */
bool _register_cb(GFlowNode *node, GNodeVisitState state, GGraphLayout *layout)
{
if (state == GVS_NODE)
g_flow_node_link(node, layout, layout->nodes);
return true;
}
g_graph_node_visit_nodes(result->nodes, (graph_node_visitor_cb)_register_cb, result);
bool _print_dbg_cb(GFlowNode *node, GNodeVisitState state, int *depth)
{
int i;
if (state == GVS_ENTER || state == GVS_NODE)
{
for (i = 0; i < *depth; i++)
printf(" ");
printf("- %p\n", node);
}
if (state == GVS_ENTER) (*depth)++;
else if (state == GVS_EXIT) (*depth)--;
return true;
}
printf("==== graph ====\n");
g_graph_node_visit_nodes(result->nodes, (graph_node_visitor_cb)_print_dbg_cb, (int []){ 0 });
printf("\n");
/* Actualisation... */
g_graph_layout_refresh(result);
bool _print_dbg_ext_cb(GGraphNode *node, GNodeVisitState state, int *depth)
{
int i;
GtkAllocation alloc;
if (state == GVS_ENTER || state == GVS_NODE)
{
for (i = 0; i < *depth; i++)
printf(" ");
alloc = g_graph_node_get_allocation(node);
printf("- %p - (%d ; %d) - (%d ; %d)\n", node,
alloc.x, alloc.y,
alloc.width, alloc.height);
}
if (state == GVS_ENTER) (*depth)++;
else if (state == GVS_EXIT) (*depth)--;
return true;
}
printf("==== graph ====\n");
g_graph_node_visit_nodes(result->nodes, (graph_node_visitor_cb)_print_dbg_ext_cb, (int []){ 0 });
printf("\n");
return result;
}
/******************************************************************************
* *
* Paramètres : layout = disposition en graphique à compléter. *
* edge = lien entre noeuds à conserver. *
* *
* Description : Ajoute un lien entre deux noeuds au graphique. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void g_graph_layout_add_edge(GGraphLayout *layout, GGraphEdge *edge)
{
layout->edges = (GGraphEdge **)realloc(layout->edges,
++layout->edges_count * sizeof(GGraphEdge *));
layout->edges[layout->edges_count - 1] = edge;
}
/******************************************************************************
* *
* Paramètres : layout = graphique à mettre à jour. *
* *
* Description : Met à jour les positions des différents noeuds. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void g_graph_layout_refresh(GGraphLayout *layout)
{
size_t i; /* Boucle de parcours */
g_graph_ranks_reset_reservations(layout->ranks);
bool _reset_cb(GGraphNode *node, GNodeVisitState state, void *unused)
{
g_graph_node_reset_position(node);
if (state == GVS_NODE)
g_flow_node_register_rank(G_FLOW_NODE(node), layout->ranks);
return true;
}
g_graph_node_visit_nodes(layout->nodes, (graph_node_visitor_cb)_reset_cb, NULL);
/* Traitement des positions horizontales */
for (i = 0; i < layout->edges_count; i++)
g_graph_edge_reserve_vertical_space(layout->edges[i], layout->nodes, layout->ranks);
/* Traitement des positions horizontales */
g_graph_node_set_x_position(layout->nodes, GRAPH_HORIZONTAL_MARGIN);
g_graph_node_prepare_x_line(layout->nodes, layout->nodes);
g_graph_node_apply_position(layout->nodes);
for (i = 0; i < layout->edges_count; i++)
g_graph_edge_reserve_horizontal_space(layout->edges[i], layout->ranks);
/* Traitement des positions verticales */
g_graph_ranks_compute_y_line(layout->ranks);
bool _apply_cb(GFlowNode *node, GNodeVisitState state, GGraphRanks *ranks)
{
if (state == GVS_NODE)
g_flow_node_apply_rank(node, ranks);
return true;
}
g_graph_node_visit_nodes(layout->nodes, (graph_node_visitor_cb)_apply_cb, layout->ranks);
/* Mise en place des liens */
for (i = 0; i < layout->edges_count; i++)
g_graph_edge_compute(layout->edges[i], layout->ranks);
}
/******************************************************************************
* *
* Paramètres : layout = disposition en graphique prête. *
* view = support de destination finale. *
* *
* Description : Dispose chaque noeud sur la surface de destination donnée. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void g_graph_layout_place(GGraphLayout *layout, GtkGraphView *view)
{
bool _place_cb(GFlowNode *node, GNodeVisitState state, GtkGraphView *view)
{
if (state == GVS_NODE)
g_flow_node_place(node, view);
return true;
}
g_graph_node_visit_nodes(layout->nodes, (graph_node_visitor_cb)_place_cb, view);
}
/******************************************************************************
* *
* Paramètres : layout = graphique constitué à consulter. *
* requisition = dimensions souhaitées. [OUT] *
* *
* Description : Fournit la taille requise pour un plein rendu du graphique. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void g_graph_layout_size_request(const GGraphLayout *layout, GtkRequisition *requisition)
{
GtkAllocation alloc; /* Largeur totale requise */
alloc = g_graph_node_get_allocation(layout->nodes);
requisition->width = alloc.width + 2 * GRAPH_HORIZONTAL_MARGIN;
requisition->height = g_graph_ranks_get_height(layout->ranks);
}
/******************************************************************************
* *
* Paramètres : layout = graphique à représenter. *
* cairo = assistant pour le rendu graphique. *
* arrow = indique le besoin en flèche à l'arrivée. *
* *
* Description : Dessine les liens graphiques enregistrés dans le moteur. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void g_graph_layout_draw(const GGraphLayout *layout, cairo_t *cairo, bool arrow)
{
size_t i; /* Boucle de parcours */
for (i = 0; i < layout->edges_count; i++)
g_graph_edge_draw(layout->edges[i], cairo, arrow);
}