ir_gdar.c

Go to the documentation of this file.

/*

  Copyright (C) 2000, 2001 Silicon Graphics, Inc.  All Rights Reserved.

  This program is free software; you can redistribute it and/or modify it
  under the terms of version 2 of the GNU General Public License as
  published by the Free Software Foundation.

  This program is distributed in the hope that it would be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  

  Further, this software is distributed without any warranty that it is
  free of the rightful claim of any third person regarding infringement 
  or the like.  Any license provided herein, whether implied or 
  otherwise, applies only to this software file.  Patent licenses, if 
  any, provided herein do not apply to combinations of this program with 
  other software, or any other product whatsoever.  

  You should have received a copy of the GNU General Public License along
  with this program; if not, write the Free Software Foundation, Inc., 59
  Temple Place - Suite 330, Boston MA 02111-1307, USA.

  Contact information:  Silicon Graphics, Inc., 1600 Amphitheatre Pky,
  Mountain View, CA 94043, or:

  http://www.sgi.com

  For further information regarding this notice, see:

  http://oss.sgi.com/projects/GenInfo/NoticeExplan

*/


/* ====================================================================
 * ====================================================================
 *
 *
 * Revision history:
 *  20-Jun-97 - Original Version
 *
 * Description:
 *
 *   This program is just a stand-alone driver for the GDAR capability.
 *   The GDAR option is built into each of the front-ends so that this
 *   program is needed when you only have *.B files to work with.
 *
 *      ir_gdar [-v] [-o <Whirl_File_Name_out>] -g <GDAR_File_Name>
 *                                                      <Whirl_File_Name>
 *
 *   Note that the <Whirl_File_Name> is a mandatory argument, and in
 *   its absence a message about usage will be emitted.  If the program
 *   is written to output a modified WHIRL file then it will either be
 *   written to the optional -o argument or to the original WHIRL file.
 *
 * ====================================================================
 * ====================================================================
 */

#include <elf.h>
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <search.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>

#include "wn.h"
#include "stab.h"
#include "aux_stab.h"
#include "irbdata.h"
#include "wintrinsic.h"
#include "glob.h"
#include "pu_info.h"
#include "ir_bread.h"
#include "ir_bwrite.h"
#include "file_util.h"
#include "gdar.h"


/* ====================================================================
 *
 * Local data.
 *
 * ====================================================================
 */

#define MAX_FNAME_LENGTH 256

char filename_in[MAX_FNAME_LENGTH];
char filename_out[MAX_FNAME_LENGTH];
char gdar_filename[MAX_FNAME_LENGTH];
char temp_filename[MAX_FNAME_LENGTH+16];

char *GDAR_File_Name = NULL;
char *Irb_File_Name_out = NULL;

struct stat statbuf;

BOOL gflag = FALSE;
BOOL oflag = FALSE;
BOOL vflag = FALSE;


/* ====================================================================
 *
 * Usage
 *
 * Give a warning about the usage of this tool, in terms of the
 * command line options it accepts.
 *
 * ====================================================================
 */

static void
Usage (void)
{
   fprintf (stderr, 
            "USAGE:\n"
            "\n"
            "\t [-v] [-o <Whirl_File_Name_out>] -g <GDAR_File_Name> <Whirl_File_Name>\n"
            "\n"
            "The optional -v flag controls verbose trace messages.\n"
            "The optional -o flag is used to specify an alternate out file.\n"
            "The -g <GDAR_File_Name> is a mandatory command line argument.\n"
            "The <Whirl_File_Name> is a mandatory command line argument.\n"
            "\n"
            );
   
} /* Usage */


/* ====================================================================
 *
 * Get_Irb_File_Name
 *
 * Process the command line arguments to get the input file name,
 * the optional output file name and any other options.  Return the
 * number of input filename arguments found on this command line
 * (where Irb_File_Name will be set to the first one encountered).
 *
 * ====================================================================
 */

static INT32
Get_Irb_File_Name (INT argc, char *argv[])
{
   /* Find the WHIRL input filename.  There should only be one. */
   char *fname;
   INT32       argidx;
   INT32       src_count = 0;
   
   for (argidx = 1; argidx < argc; argidx++)
   {
      /* Null argument => end of list: */
      if (argv[argidx][0] == '-' ) 
      {
         /* Process regular options */
        if (strcmp (argv[argidx], "-o") == 0) {
          oflag = TRUE;
          fname = argv[++argidx];
          if (strlen(fname) > MAX_FNAME_LENGTH)
          {
            Irb_File_Name_out = strncpy (filename_out, fname, MAX_FNAME_LENGTH);
            filename_out[MAX_FNAME_LENGTH] = '\0';
            fprintf (stderr, 
                     "WARNING: output filename truncated to "
                     "(max=%d chars): \"%s\"\n",
                     MAX_FNAME_LENGTH, fname);
          }
          else
            Irb_File_Name_out = strcpy (filename_out, fname);
        } else if (strcmp (argv[argidx], "-g") == 0) {
          gflag = TRUE;
          fname = argv[++argidx];
          if (strlen(fname) > MAX_FNAME_LENGTH)
          {
            GDAR_File_Name = strncpy (gdar_filename, fname, MAX_FNAME_LENGTH);
            gdar_filename[MAX_FNAME_LENGTH] = '\0';
            fprintf (stderr, 
                     "WARNING: GDAR filename truncated to "
                     "(max=%d chars): \"%s\"\n",
                     MAX_FNAME_LENGTH, fname);
          }
          else
            GDAR_File_Name = strcpy (gdar_filename, fname);
        } else if (strcmp (argv[argidx], "-v") == 0) {
          vflag = TRUE;
        } else {
          fprintf (stderr,
                   "WARNING: unrecognized command option "
                   "%s\n",
                   argv[argidx]);
        }
      }
      else if (src_count > 0)
         src_count += 1;
      else if (src_count == 0) /* Presumably a WHIRL input file name */
      {
         /* Copy the original filename to a static buffer */
         fname = argv[argidx];
         if (strlen(fname) > MAX_FNAME_LENGTH)
         {
            Irb_File_Name = strncpy (filename_in, fname, MAX_FNAME_LENGTH);
            filename_in[MAX_FNAME_LENGTH] = '\0';
            fprintf (stderr, 
                     "WARNING: input filename truncated to "
                     "(max=%d chars): \"%s\"\n",
                     MAX_FNAME_LENGTH, fname);
         }
         else
            Irb_File_Name = strcpy (filename_in, fname);

         src_count = 1;
      } /* If source file argument */
   } /* While not found */
   return src_count;
} /* Get_Irb_File_Name */


/* ====================================================================
 *
 * read_pu
 *
 * Read each PU.
 *
 * ====================================================================
 */

static void
read_pu (PU_Info *pu_tree)
{
    PU_Info *pu;

    for (pu = pu_tree; pu != NULL; pu = PU_Info_next(pu)) {
        Current_PU_Info = pu;
        Read_Local_Info (MEM_pu_nz_pool_ptr, pu);

        if (PU_Info_child(pu)) {
            read_pu (PU_Info_child(pu));
        }
    }
}


/* ====================================================================
 *
 * write_pu
 *
 * Write each PU.
 *
 * ====================================================================
 */

static void
write_pu (PU_Info *pu_tree)
{
    PU_Info *pu;

    for (pu = pu_tree; pu != NULL; pu = PU_Info_next(pu)) {
        Current_PU_Info = pu;
        Write_PU_Info (pu);
    }
}


/* ====================================================================
 *
 * main
 *
 * Main entry point and driver for the ir_walker program.
 *
 * ====================================================================
 */

void
main (INT argc,       /* Number of command line arguments */
      char *argv[],   /* Array of command line arguments */
      char *envp[])   /* Array of environment pointers */
{
   WN          *pu;
   INT32        inp_file_count;
   PU_Info     *pu_tree, *current_pu;

   /* Here are things that every process driver should do as soon as
    * possible upon start-up.
    */
   MEM_Initialize ();
   Init_Error_Handler (10);
   Set_Error_Line (ERROR_LINE_UNKNOWN);
   Set_Error_Phase ("IR Walker");
   Set_Error_File (NULL);

   Init_Operator_To_Opcode_Table ();
    
   /* Process the input file */
   inp_file_count = Get_Irb_File_Name (argc, argv);
   if (inp_file_count == 0)
   {
      Usage ();
      fprintf (stderr, "ERROR: missing input file on command line\n");
   }
   else if (inp_file_count > 1)
   {
      Usage ();
      fprintf (stderr, "ERROR: too many input files on command line\n");
   }
   else if (stat (Irb_File_Name, &statbuf) != 0)
   {
      fprintf (stderr, "ERROR: input file (%s) does not exist\n",
               Irb_File_Name);
   }
   else if (!gflag)
   {
      Usage ();
      fprintf (stderr, "ERROR: missing GDAR file on command line\n");
   }
   else if (stat (GDAR_File_Name, &statbuf) != 0)
   {
      fprintf (stderr, "ERROR: GDAR file (%s) does not exist\n",
               GDAR_File_Name);
   }
   else
   {

      /* Setup output file */
      if (!oflag)
        (void) strcpy (filename_out, filename_in);
      (void) sprintf (temp_filename, "%s$%d", filename_out, (INT32) getpid ());
      (void) remove (temp_filename);

      /* Get the global symbol table, the string table, the constant table,
       * and the initialization table.
       */
      (void) Open_Input_Info (Irb_File_Name);
      pu_tree = Read_Global_Info (NULL);

      /* Open output file */
      (void) Open_Output_Info (temp_filename);

      /* Read all the PUs */
      read_pu (pu_tree);

      /* Process global symbol table. */
      Process_GDAR (GDAR_File_Name, Global_Symtab, &pu_tree);

      /* Write all the PUs */
      write_pu (pu_tree);

      /* Finish up output file */
      Write_Global_Info (pu_tree);
      Close_Output_Info ();
      (void) remove (filename_out);
      (void) rename (temp_filename, filename_out);

   }
   
   exit (0);
} /* main */


/* Dummy definitions to satisify references from routines that got pulled
 * in by the header files but are never called
 */
void Signal_Cleanup (INT sig) { }

char * Host_Format_Parm (INT kind, MEM_PTR parm) { return NULL; }

INT8 Debug_Level = 0;