passes/cmds/tee.cc

   1 /*
   2  *  yosys -- Yosys Open SYnthesis Suite
   3  *
   4  *  Copyright (C) 2014  Clifford Wolf <clifford@clifford.at>
   5  *  Copyright (C) 2014  Johann Glaser <Johann.Glaser@gmx.at>
   6  *
   7  *  Permission to use, copy, modify, and/or distribute this software for any
   8  *  purpose with or without fee is hereby granted, provided that the above
   9  *  copyright notice and this permission notice appear in all copies.
  10  *
  11  *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  12  *  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  13  *  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  14  *  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  15  *  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  16  *  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  17  *  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18  *
  19  */
  20
  21 #include "kernel/register.h"
  22 #include "kernel/rtlil.h"
  23 #include "kernel/log.h"
  24
  25 struct TeePass : public Pass {
  26         TeePass() : Pass("tee", "redirect command output to file") { }
  27         virtual void help()
  28         {
  29                 //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
  30                 log("\n");
  31                 log("    tee [-q] [-o logfile|-a logfile] cmd\n");
  32                 log("\n");
  33                 log("Execute the specified command, optionally writing the commands output to the\n");
  34                 log("specified logfile(s).\n");
  35                 log("\n");
  36                 log("    -q\n");
  37                 log("        Do not print output to the normal destination (console and/or log file)\n");
  38                 log("\n");
  39                 log("    -o logfile\n");
  40                 log("        Write output to this file, truncate if exists.\n");
  41                 log("\n");
  42                 log("    -a logfile\n");
  43                 log("        Write output to this file, append if exists.\n");
  44                 log("\n");
  45         }
  46         virtual void execute(std::vector<std::string> args, RTLIL::Design *design)
  47         {
  48                 std::vector<FILE*> backup_log_files, files_to_close;
  49                 backup_log_files = log_files;
  50
  51                 size_t argidx;
  52                 for (argidx = 1; argidx < args.size(); argidx++)
  53                 {
  54                         if (args[argidx] == "-q" && files_to_close.empty()) {
  55                                 log_files.clear();
  56                                 continue;
  57                         }
  58                         if ((args[argidx] == "-o" || args[argidx] == "-a") && argidx+1 < args.size()) {
  59                                 const char *open_mode = args[argidx] == "-o" ? "w" : "a+";
  60                                 FILE *f = fopen(args[++argidx].c_str(), open_mode);
  61                                 if (f == NULL) {
  62                                         for (auto cf : files_to_close)
  63                                                 fclose(cf);
  64                                         log_cmd_error("Can't create file %s.\n", args[argidx].c_str());
  65                                 }
  66                                 log_files.push_back(f);
  67                                 files_to_close.push_back(f);
  68                                 continue;
  69                         }
  70                         break;
  71                 }
  72
  73                 try {
  74                         std::vector<std::string> new_args(args.begin() + argidx, args.end());
  75                         Pass::call(design, new_args);
  76                 } catch (log_cmd_error_expection) {
  77                         for (auto cf : files_to_close)
  78                                 fclose(cf);
  79                         log_files = backup_log_files;
  80                         throw log_cmd_error_expection();
  81                 }
  82
  83                 for (auto cf : files_to_close)
  84                         fclose(cf);
  85                 log_files = backup_log_files;
  86         }
  87 } TeePass;
  88