ReadOptions.h File Reference

#include "OptionTokens.h"

Include dependency graph for ReadOptions.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	s_options

Typedefs
typedef struct s_options	t_options

Enumerations
enum	e_echo_files {   E_ECHO_INITIAL_CLB_PLACEMENT = 0, E_ECHO_INITIAL_PLACEMENT_TIMING_GRAPH, E_ECHO_INITIAL_PLACEMENT_SLACK, E_ECHO_INITIAL_PLACEMENT_CRITICALITY,   E_ECHO_END_CLB_PLACEMENT, E_ECHO_PLACEMENT_SINK_DELAYS, E_ECHO_FINAL_PLACEMENT_TIMING_GRAPH, E_ECHO_FINAL_PLACEMENT_SLACK,   E_ECHO_FINAL_PLACEMENT_CRITICALITY, E_ECHO_PLACEMENT_CRIT_PATH, E_ECHO_PB_GRAPH, E_ECHO_ARCH,   E_ECHO_PLACEMENT_CRITICAL_PATH, E_ECHO_PLACEMENT_LOWER_BOUND_SINK_DELAYS, E_ECHO_PLACEMENT_LOGIC_SINK_DELAYS, E_ECHO_ROUTING_SINK_DELAYS,   E_ECHO_POST_FLOW_TIMING_GRAPH, E_ECHO_POST_PACK_NETLIST, E_ECHO_BLIF_INPUT, E_ECHO_NET_DELAY,   E_ECHO_TIMING_GRAPH, E_ECHO_LUT_REMAPPING, E_ECHO_PRE_PACKING_TIMING_GRAPH, E_ECHO_PRE_PACKING_TIMING_GRAPH_AS_BLIF,   E_ECHO_CLUSTERING_TIMING_INFO, E_ECHO_PRE_PACKING_SLACK, E_ECHO_PRE_PACKING_CRITICALITY, E_ECHO_CLUSTERING_BLOCK_CRITICALITIES,   E_ECHO_PRE_PACKING_MOLECULES_AND_PATTERNS, E_ECHO_MEM, E_ECHO_RR_GRAPH, E_ECHO_TIMING_CONSTRAINTS,   E_ECHO_CRITICAL_PATH, E_ECHO_SLACK, E_ECHO_CRITICALITY, E_ECHO_COMPLETE_NET_TRACE,   E_ECHO_SEG_DETAILS, E_ECHO_END_TOKEN }
enum	e_output_files { E_CRIT_PATH_FILE, E_SLACK_FILE, E_CRITICALITY_FILE, E_FILE_END_TOKEN }

Functions
void	ReadOptions (INP int argc, INP char **argv, OUTP t_options *Options)
boolean	getEchoEnabled (void)
void	setEchoEnabled (boolean echo_enabled)
void	setAllEchoFileEnabled (boolean value)
void	setEchoFileEnabled (enum e_echo_files echo_option, boolean value)
void	setEchoFileName (enum e_echo_files echo_option, const char *name)
boolean	isEchoFileEnabled (enum e_echo_files echo_option)
char *	getEchoFileName (enum e_echo_files echo_option)
void	alloc_and_load_echo_file_info ()
void	free_echo_file_info ()
void	setOutputFileName (enum e_output_files ename, const char *name, const char *default_name)
char *	getOutputFileName (enum e_output_files ename)
void	alloc_and_load_output_file_names (const char *default_name)
void	free_output_file_names ()
boolean	IsTimingEnabled (INP t_options *Options)
boolean	IsEchoEnabled (INP t_options *Options)
boolean	GetPostSynthesisOption (void)
void	SetPostSynthesisOption (boolean post_synthesis_enabled)
boolean	IsPostSynthesisEnabled (INP t_options *Options)

Typedef Documentation

typedef struct s_options t_options

Definition at line 6 of file ReadOptions.h.

Enumeration Type Documentation

enum e_echo_files

Enumerator
E_ECHO_INITIAL_CLB_PLACEMENT
E_ECHO_INITIAL_PLACEMENT_TIMING_GRAPH
E_ECHO_INITIAL_PLACEMENT_SLACK
E_ECHO_INITIAL_PLACEMENT_CRITICALITY
E_ECHO_END_CLB_PLACEMENT
E_ECHO_PLACEMENT_SINK_DELAYS
E_ECHO_FINAL_PLACEMENT_TIMING_GRAPH
E_ECHO_FINAL_PLACEMENT_SLACK
E_ECHO_FINAL_PLACEMENT_CRITICALITY
E_ECHO_PLACEMENT_CRIT_PATH
E_ECHO_PB_GRAPH
E_ECHO_ARCH
E_ECHO_PLACEMENT_CRITICAL_PATH
E_ECHO_PLACEMENT_LOWER_BOUND_SINK_DELAYS
E_ECHO_PLACEMENT_LOGIC_SINK_DELAYS
E_ECHO_ROUTING_SINK_DELAYS
E_ECHO_POST_FLOW_TIMING_GRAPH
E_ECHO_POST_PACK_NETLIST
E_ECHO_BLIF_INPUT
E_ECHO_NET_DELAY
E_ECHO_TIMING_GRAPH
E_ECHO_LUT_REMAPPING
E_ECHO_PRE_PACKING_TIMING_GRAPH
E_ECHO_PRE_PACKING_TIMING_GRAPH_AS_BLIF
E_ECHO_CLUSTERING_TIMING_INFO
E_ECHO_PRE_PACKING_SLACK
E_ECHO_PRE_PACKING_CRITICALITY
E_ECHO_CLUSTERING_BLOCK_CRITICALITIES
E_ECHO_PRE_PACKING_MOLECULES_AND_PATTERNS
E_ECHO_MEM
E_ECHO_RR_GRAPH
E_ECHO_TIMING_CONSTRAINTS
E_ECHO_CRITICAL_PATH
E_ECHO_SLACK
E_ECHO_CRITICALITY
E_ECHO_COMPLETE_NET_TRACE
E_ECHO_SEG_DETAILS
E_ECHO_END_TOKEN

Definition at line 95 of file ReadOptions.h.

                  {
    E_ECHO_INITIAL_CLB_PLACEMENT = 0,
    E_ECHO_INITIAL_PLACEMENT_TIMING_GRAPH,
    E_ECHO_INITIAL_PLACEMENT_SLACK,
    E_ECHO_INITIAL_PLACEMENT_CRITICALITY,
    E_ECHO_END_CLB_PLACEMENT,
    E_ECHO_PLACEMENT_SINK_DELAYS,
    E_ECHO_FINAL_PLACEMENT_TIMING_GRAPH,
    E_ECHO_FINAL_PLACEMENT_SLACK,
    E_ECHO_FINAL_PLACEMENT_CRITICALITY,
    E_ECHO_PLACEMENT_CRIT_PATH,
    E_ECHO_PB_GRAPH,
    E_ECHO_ARCH,
    E_ECHO_PLACEMENT_CRITICAL_PATH,
    E_ECHO_PLACEMENT_LOWER_BOUND_SINK_DELAYS,
    E_ECHO_PLACEMENT_LOGIC_SINK_DELAYS,
    E_ECHO_ROUTING_SINK_DELAYS,
    E_ECHO_POST_FLOW_TIMING_GRAPH,
    E_ECHO_POST_PACK_NETLIST,
    E_ECHO_BLIF_INPUT,
    E_ECHO_NET_DELAY,
    E_ECHO_TIMING_GRAPH,
    E_ECHO_LUT_REMAPPING,
    E_ECHO_PRE_PACKING_TIMING_GRAPH,
    E_ECHO_PRE_PACKING_TIMING_GRAPH_AS_BLIF,
    E_ECHO_CLUSTERING_TIMING_INFO,
    E_ECHO_PRE_PACKING_SLACK,
    E_ECHO_PRE_PACKING_CRITICALITY,
    E_ECHO_CLUSTERING_BLOCK_CRITICALITIES,
    E_ECHO_PRE_PACKING_MOLECULES_AND_PATTERNS,
    E_ECHO_MEM,
    E_ECHO_RR_GRAPH,
    E_ECHO_TIMING_CONSTRAINTS,
    E_ECHO_CRITICAL_PATH,
    E_ECHO_SLACK,
    E_ECHO_CRITICALITY,
    E_ECHO_COMPLETE_NET_TRACE,
    E_ECHO_SEG_DETAILS,
    E_ECHO_END_TOKEN
};

enum e_output_files

Enumerator
E_CRIT_PATH_FILE
E_SLACK_FILE
E_CRITICALITY_FILE
E_FILE_END_TOKEN

Definition at line 137 of file ReadOptions.h.

                    {
    E_CRIT_PATH_FILE,
    E_SLACK_FILE,
    E_CRITICALITY_FILE,
    E_FILE_END_TOKEN
};

Function Documentation

void alloc_and_load_echo_file_info

(

)

Definition at line 126 of file ReadOptions.c.

                                     {
    echoFileEnabled = (boolean*)my_calloc((int) E_ECHO_END_TOKEN, sizeof(boolean));
    echoFileNames = (char**)my_calloc((int) E_ECHO_END_TOKEN, sizeof(char*));

    setAllEchoFileEnabled(TRUE);

    setEchoFileName(E_ECHO_INITIAL_CLB_PLACEMENT, "initial_clb_placement.echo");
    setEchoFileName(E_ECHO_INITIAL_PLACEMENT_TIMING_GRAPH, "initial_placement_timing_graph.echo");
    setEchoFileName(E_ECHO_INITIAL_PLACEMENT_SLACK, "initial_placement_slack.echo");
    setEchoFileName(E_ECHO_INITIAL_PLACEMENT_CRITICALITY, "initial_placement_criticality.echo");
    setEchoFileName(E_ECHO_END_CLB_PLACEMENT, "end_clb_placement.echo");
    setEchoFileName(E_ECHO_PLACEMENT_SINK_DELAYS, "placement_sink_delays.echo");
    setEchoFileName(E_ECHO_FINAL_PLACEMENT_TIMING_GRAPH, "final_placement_timing_graph.echo");
    setEchoFileName(E_ECHO_FINAL_PLACEMENT_SLACK, "final_placement_slack.echo");
    setEchoFileName(E_ECHO_FINAL_PLACEMENT_CRITICALITY, "final_placement_criticality.echo");
    setEchoFileName(E_ECHO_PLACEMENT_CRIT_PATH, "placement_crit_path.echo");
    setEchoFileName(E_ECHO_PB_GRAPH, "pb_graph.echo");
    setEchoFileName(E_ECHO_ARCH, "arch.echo");
    setEchoFileName(E_ECHO_PLACEMENT_CRITICAL_PATH, "placement_critical_path.echo");
    setEchoFileName(E_ECHO_PLACEMENT_LOWER_BOUND_SINK_DELAYS, "placement_lower_bound_sink_delays.echo");
    setEchoFileName(E_ECHO_PLACEMENT_LOGIC_SINK_DELAYS, "placement_logic_sink_delays.echo");
    setEchoFileName(E_ECHO_ROUTING_SINK_DELAYS, "routing_sink_delays.echo");
    setEchoFileName(E_ECHO_POST_FLOW_TIMING_GRAPH, "post_flow_timing_graph.blif");
    setEchoFileName(E_ECHO_POST_PACK_NETLIST, "post_pack_netlist.blif");
    setEchoFileName(E_ECHO_BLIF_INPUT, "blif_input.echo");
    setEchoFileName(E_ECHO_NET_DELAY, "net_delay.echo");
    setEchoFileName(E_ECHO_TIMING_GRAPH, "timing_graph.echo");
    setEchoFileName(E_ECHO_LUT_REMAPPING, "lut_remapping.echo");
    setEchoFileName(E_ECHO_PRE_PACKING_TIMING_GRAPH, "pre_packing_timing_graph.echo");
    setEchoFileName(E_ECHO_PRE_PACKING_TIMING_GRAPH_AS_BLIF, "pre_packing_timing_graph_as_blif.blif");
    setEchoFileName(E_ECHO_CLUSTERING_TIMING_INFO, "clustering_timing_info.echo");
    setEchoFileName(E_ECHO_PRE_PACKING_SLACK, "pre_packing_slack.echo");
    setEchoFileName(E_ECHO_PRE_PACKING_CRITICALITY, "pre_packing_criticality.echo");
    setEchoFileName(E_ECHO_CLUSTERING_BLOCK_CRITICALITIES, "clustering_block_criticalities.echo");
    setEchoFileName(E_ECHO_PRE_PACKING_MOLECULES_AND_PATTERNS, "pre_packing_molecules_and_patterns.echo");
    setEchoFileName(E_ECHO_MEM, "mem.echo");
    setEchoFileName(E_ECHO_RR_GRAPH, "rr_graph.echo");
    setEchoFileName(E_ECHO_TIMING_CONSTRAINTS, "timing_constraints.echo");  
    setEchoFileName(E_ECHO_CRITICAL_PATH, "critical_path.echo");    
    setEchoFileName(E_ECHO_SLACK, "slack.echo");    
    setEchoFileName(E_ECHO_CRITICALITY, "criticality.echo");
    setEchoFileName(E_ECHO_COMPLETE_NET_TRACE, "complete_net_trace.echo");
    setEchoFileName(E_ECHO_SEG_DETAILS, "seg_details.txt");
}

Here is the call graph for this function:

Here is the caller graph for this function:

void alloc_and_load_output_file_names

(

const char *

default_name

)

Definition at line 200 of file ReadOptions.c.

                                                                {
    char *name;

    if(outputFileNames == NULL) {

        outputFileNames = (char**)my_calloc((int)E_FILE_END_TOKEN, sizeof(char*));

        name = (char*)my_malloc((strlen(default_name) + 40) * sizeof(char));
        sprintf(name, "%s.critical_path.out", default_name);
        setOutputFileName(E_CRIT_PATH_FILE, name, default_name);
    
        sprintf(name, "%s.slack.out", default_name);
        setOutputFileName(E_SLACK_FILE, name, default_name);

        sprintf(name, "%s.criticality.out", default_name);
        setOutputFileName(E_CRITICALITY_FILE, name, default_name);

        free(name);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void free_echo_file_info

(

)

Definition at line 171 of file ReadOptions.c.

                           {
    int i;
    if(echoFileEnabled != NULL) {
        for(i = 0; i < (int) E_ECHO_END_TOKEN; i++) {
            if(echoFileNames[i] != NULL) {
                free(echoFileNames[i]);
            }
        }
        free(echoFileNames);
        free(echoFileEnabled);
        echoFileNames = NULL;
        echoFileEnabled = NULL;
    }
}

Here is the caller graph for this function:

void free_output_file_names

(

)

Definition at line 221 of file ReadOptions.c.

                              {
    int i;
    if(outputFileNames != NULL) {
        for(i = 0; i < (int)E_FILE_END_TOKEN; i++) {
            if(outputFileNames[i] != NULL) {
                free(outputFileNames[i]);
                outputFileNames[i] = NULL;
            }
        }
        free(outputFileNames);
        outputFileNames = NULL;
    }
}

Here is the caller graph for this function:

boolean getEchoEnabled

(

void

)

Definition at line 67 of file ReadOptions.c.

                             {
    return EchoEnabled;
}

Here is the caller graph for this function:

char* getEchoFileName

(

enum e_echo_files

echo_option

)

Definition at line 122 of file ReadOptions.c.

                                                     {
    return echoFileNames[(int)echo_option];
}

Here is the caller graph for this function:

char* getOutputFileName

(

enum e_output_files

ename

)

Definition at line 196 of file ReadOptions.c.

                                                   {
    return outputFileNames[(int)ename];
}

Here is the caller graph for this function:

boolean GetPostSynthesisOption

(

void

)

Definition at line 80 of file ReadOptions.c.

                                    {
  return Generate_PostSynthesis_Netlist;
}

Here is the caller graph for this function:

boolean IsEchoEnabled

(

INP t_options *

Options

)

Definition at line 58 of file ReadOptions.c.

                                              {
    /* First priority to the '--echo_file' flag */
    if (Options->Count[OT_CREATE_ECHO_FILE]) {
        return Options->CreateEchoFile;
    }
    return FALSE;
}

Here is the caller graph for this function:

boolean isEchoFileEnabled

(

enum e_echo_files

echo_option

)

Definition at line 115 of file ReadOptions.c.

                                                         {
    if(echoFileEnabled == NULL) {
        return FALSE;
    } else {
        return echoFileEnabled[(int)echo_option];
    }
}

Here is the caller graph for this function:

boolean IsPostSynthesisEnabled

(

INP t_options *

Options

)

Definition at line 88 of file ReadOptions.c.

                                                       {
  /* First priority to the '--generate_postsynthesis_netlist' flag */
  if (Options->Count[OT_GENERATE_POST_SYNTHESIS_NETLIST]) {
    return Options->Generate_Post_Synthesis_Netlist;
  }
  return FALSE;
}

Here is the caller graph for this function:

boolean IsTimingEnabled

(

INP t_options *

Options

)

Definition at line 47 of file ReadOptions.c.

                                                {
    /* First priority to the '--timing_analysis' flag */
    if (Options->Count[OT_TIMING_ANALYSIS]) {
        return Options->TimingAnalysis;
    }
    return TRUE;
}

Here is the caller graph for this function:

void ReadOptions	(	INP int	argc,
		INP char **	argv,
		OUTP t_options *	Options
	)

Definition at line 239 of file ReadOptions.c.

                                                                          {
    char **Args, **head;
    int offset;
    
    /* Clear values and pointers to zero */
    memset(Options, 0, sizeof(t_options));

    /* Alloc a new pointer list for args with a NULL at end.
     * This makes parsing the same as for archfile for consistency.
     * Skips the first arg as it is the program image path */
    --argc;
    ++argv;
    head = Args = (char **) my_malloc(sizeof(char *) * (argc + 1));
    memcpy(Args, argv, (sizeof(char *) * argc));
    Args[argc] = NULL;

    /* Go through the command line args. If they have hyphens they are 
     * options. Otherwise assume they are part of the four mandatory
     * arguments */
    while (*Args) {
        if (strncmp("--", *Args, 2) == 0) {
            *Args += 2; /* Skip the prefix */
            Args = ProcessOption(Args, Options);
        } else if (strncmp("-", *Args, 1) == 0) {
            *Args += 1; /* Skip the prefix */
            Args = ProcessOption(Args, Options);
        } else if (NULL == Options->ArchFile) {
            Options->ArchFile = my_strdup(*Args);
            vpr_printf(TIO_MESSAGE_INFO, "Architecture file: %s\n", Options->ArchFile);
            ++Args;
        } else if (NULL == Options->CircuitName) {
            Options->CircuitName = my_strdup(*Args);
            /*if the user entered the circuit name with the .blif extension, remove it now*/
            offset = strlen(Options->CircuitName) - 5;
            if (offset > 0 && !strcmp(Options->CircuitName + offset, ".blif")) {
                Options->CircuitName[offset] = '\0';
            }
            vpr_printf(TIO_MESSAGE_INFO, "Circuit name: %s.blif\n", Options->CircuitName);
            vpr_printf(TIO_MESSAGE_INFO, "\n");
            ++Args;
        } else {
            /* Not an option and arch and net already specified so fail */
            Error(*Args);
        }

        if (Options->Count[OT_SETTINGS_FILE] != Options->read_settings)
        {
            int tmp_argc = 0;
            char **tmp_argv = NULL;
            t_options SettingsFileOptions;

            tmp_argc = read_settings_file(Options->SettingsFile, &tmp_argv);

            ReadOptions(tmp_argc, tmp_argv, &SettingsFileOptions);

            MergeOptions(Options, &SettingsFileOptions, Options->Count[OT_SETTINGS_FILE]);

            Options->read_settings = Options->Count[OT_SETTINGS_FILE];

            /* clean up local data structures */
            free(tmp_argv);
        }
    }
    free(head);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void setAllEchoFileEnabled

(

boolean

value

)

Definition at line 97 of file ReadOptions.c.

                                          {
    int i;
    for(i = 0; i < (int) E_ECHO_END_TOKEN; i++) {
        echoFileEnabled[i] = value;
    }
}

Here is the caller graph for this function:

void setEchoEnabled

(

boolean

echo_enabled

)

Definition at line 71 of file ReadOptions.c.

                                          {
    /* enable echo outputs */
    EchoEnabled = echo_enabled;
    if(echoFileEnabled == NULL) {
        /* initialize default echo options */
        alloc_and_load_echo_file_info();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void setEchoFileEnabled	(	enum e_echo_files	echo_option,
		boolean	value
	)

Definition at line 104 of file ReadOptions.c.

                                                                      {
    echoFileEnabled[(int)echo_option] = value;
}

void setEchoFileName	(	enum e_echo_files	echo_option,
		const char *	name
	)

Definition at line 108 of file ReadOptions.c.

                                                                      {
    if(echoFileNames[(int)echo_option] != NULL) {
        free(echoFileNames[(int)echo_option]);
    }
    echoFileNames[(int)echo_option] = my_strdup(name);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void setOutputFileName	(	enum e_output_files	ename,
		const char *	name,
		const char *	default_name
	)

Definition at line 186 of file ReadOptions.c.

                                                                                              {
    if(outputFileNames == NULL) {
        alloc_and_load_output_file_names(default_name);
    }
    if(outputFileNames[(int)ename] != NULL) {
        free(outputFileNames[(int)ename]);
    }
    outputFileNames[(int)ename] = my_strdup(name);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SetPostSynthesisOption

(

boolean

post_synthesis_enabled

)

Definition at line 84 of file ReadOptions.c.

                                                           {
  Generate_PostSynthesis_Netlist = post_synthesis_enabled;
}

Here is the caller graph for this function: