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 USING_YOSYS_NAMESPACE
  26 PRIVATE_NAMESPACE_BEGIN
  27
  28 struct TeePass : public Pass {
  29         TeePass() : Pass("tee", "redirect command output to file") { }
  30         virtual void help()
  31         {
  32                 //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
  33                 log("\n");
  34                 log("    tee [-q] [-o logfile|-a logfile] cmd\n");
  35                 log("\n");
  36                 log("Execute the specified command, optionally writing the commands output to the\n");
  37                 log("specified logfile(s).\n");
  38                 log("\n");
  39                 log("    -q\n");
  40                 log("        Do not print output to the normal destination (console and/or log file)\n");
  41                 log("\n");
  42                 log("    -o logfile\n");
  43                 log("        Write output to this file, truncate if exists.\n");
  44                 log("\n");
  45                 log("    -a logfile\n");
  46                 log("        Write output to this file, append if exists.\n");
  47                 log("\n");
  48         }
  49         virtual void execute(std::vector<std::string> args, RTLIL::Design *design)
  50         {
  51                 std::vector<FILE*> backup_log_files, files_to_close;
  52                 backup_log_files = log_files;
  53
  54                 size_t argidx;
  55                 for (argidx = 1; argidx < args.size(); argidx++)
  56                 {
  57                         if (args[argidx] == "-q" && files_to_close.empty()) {
  58                                 log_files.clear();
  59                                 continue;
  60                         }
  61                         if ((args[argidx] == "-o" || args[argidx] == "-a") && argidx+1 < args.size()) {
  62                                 const char *open_mode = args[argidx] == "-o" ? "w" : "a+";
  63                                 FILE *f = fopen(args[++argidx].c_str(), open_mode);
  64                                 if (f == NULL) {
  65                                         for (auto cf : files_to_close)
  66                                                 fclose(cf);
  67                                         log_cmd_error("Can't create file %s.\n", args[argidx].c_str());
  68                                 }
  69                                 log_files.push_back(f);
  70                                 files_to_close.push_back(f);
  71                                 continue;
  72                         }
  73                         break;
  74                 }
  75
  76                 try {
  77                         std::vector<std::string> new_args(args.begin() + argidx, args.end());
  78                         Pass::call(design, new_args);
  79                 } catch (log_cmd_error_expection) {
  80                         for (auto cf : files_to_close)
  81                                 fclose(cf);
  82                         log_files = backup_log_files;
  83                         throw log_cmd_error_expection();
  84                 }
  85
  86                 for (auto cf : files_to_close)
  87                         fclose(cf);
  88                 log_files = backup_log_files;
  89         }
  90 } TeePass;
  91
  92 PRIVATE_NAMESPACE_END