ltlcross.cc 33.2 KB
Newer Older
1
// -*- coding: utf-8 -*-
2
3
// Copyright (C) 2012, 2013 Laboratoire de Recherche et Développement
// de l'Epita (LRDE).
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
//
// This file is part of Spot, a model checking library.
//
// Spot 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.
//
// Spot 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 this program.  If not, see <http://www.gnu.org/licenses/>.


#include "common_sys.hh"

#include <string>
#include <iostream>
#include <sstream>
26
#include <fstream>
27
28
29
#include <cstdlib>
#include <cstdio>
#include <argp.h>
30
31
32
#include <signal.h>
#include <unistd.h>
#include <sys/wait.h>
33
#include "error.h"
34
#include "gethrxtime.h"
35
#include "argmatch.h"
36
37
38
39
40
41
42
43
44

#include "common_setup.hh"
#include "common_cout.hh"
#include "common_finput.hh"
#include "neverparse/public.hh"
#include "ltlast/unop.hh"
#include "ltlvisit/tostring.hh"
#include "ltlvisit/apcollect.hh"
#include "ltlvisit/lbt.hh"
45
#include "ltlvisit/relabel.hh"
46
#include "tgbaalgos/lbtt.hh"
47
48
49
50
51
#include "tgba/tgbaproduct.hh"
#include "tgbaalgos/gtec/gtec.hh"
#include "tgbaalgos/randomgraph.hh"
#include "tgbaalgos/scc.hh"
#include "tgbaalgos/dotty.hh"
52
#include "tgbaalgos/isweakscc.hh"
53
#include "misc/formater.hh"
54
55
#include "tgbaalgos/stats.hh"
#include "tgbaalgos/isdet.hh"
56
#include "misc/escape.hh"
57
#include "misc/hash.hh"
58
#include "misc/random.hh"
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
59
#include "misc/tmpfile.hh"
60

61
62
63
64
65
66
67
68
// Disable handling of timeout on systems that miss kill() or alarm().
// For instance MinGW.
#if HAVE_KILL && HAVE_ALARM
# define ENABLE_TIMEOUT 1
#else
# define ENABLE_TIMEOUT 0
#endif

69
70
const char argp_program_doc[] ="\
Call several LTL/PSL translators and cross-compare their output to detect \
71
bugs, or to gather statistics.  The list of formulas to use should be \
72
supplied on standard input, or using the -f or -F options.\v\
73
74
75
76
Exit status:\n\
  0  everything went fine (timeouts are OK too)\n\
  1  some translator failed to output something we understand, or failed\n\
     sanity checks (statistics were output nonetheless)\n\
77
  2  ltlcross aborted on error\n\
78
";
79
80
81
82


#define OPT_STATES 1
#define OPT_DENSITY 2
83
84
#define OPT_JSON 3
#define OPT_CSV 4
85
#define OPT_DUPS 5
86
#define OPT_NOCHECKS 6
87
#define OPT_STOP_ERR 7
88
#define OPT_SEED 8
89
#define OPT_PRODUCTS 9
90
#define OPT_COLOR 10
91
92
93
94

static const argp_option options[] =
  {
    /**************************************************/
95
    { 0, 0, 0, 0, "Specifying translators to call:", 2 },
96
    { "translator", 't', "COMMANDFMT", 0,
97
      "register one translator to call", 0 },
98
    { "timeout", 'T', "NUMBER", 0, "kill translators after NUMBER seconds", 0 },
99
100
101
102
    /**************************************************/
    { 0, 0, 0, 0,
      "COMMANDFMT should specify input and output arguments using the "
      "following character sequences:", 3 },
103
104
105
106
107
    { "%f,%s,%l,%w", 0, 0, OPTION_DOC | OPTION_NO_USAGE,
      "the formula as a (quoted) string in Spot, Spin, LBT, or Wring's syntax",
      0 },
    { "%F,%S,%L,%W", 0, 0, OPTION_DOC | OPTION_NO_USAGE,
      "the formula as a file in Spot, Spin, LBT, or Wring's syntax", 0 },
108
109
    { "%N,%T", 0, 0, OPTION_DOC | OPTION_NO_USAGE,
      "the output automaton as a Never claim, or in LBTT's format", 0 },
110
111
112
113
    { 0, 0, 0, 0,
      "If either %l, %L, or %T are used, any input formula that does "
      "not use LBT-style atomic propositions (i.e. p0, p1, ...) will be "
      "relabeled automatically.", 0 },
114
    /**************************************************/
115
    { 0, 0, 0, 0, "ltlcross behavior:", 4 },
116
117
118
119
120
    { "allow-dups", OPT_DUPS, 0, 0,
      "translate duplicate formulas in input", 0 },
    { "no-checks", OPT_NOCHECKS, 0, 0,
      "do not perform any sanity checks (negated formulas "
      "will not be translated)", 0 },
121
122
123
    { "stop-on-error", OPT_STOP_ERR, 0, 0,
      "stop on first execution error or failure to pass"
      " sanity checks (timeouts are OK)", 0 },
124
125
    /**************************************************/
    { 0, 0, 0, 0, "State-space generation:", 5 },
126
127
128
129
130
    { "states", OPT_STATES, "INT", 0,
      "number of the states in the state-spaces (200 by default)", 0 },
    { "density", OPT_DENSITY, "FLOAT", 0,
      "probability, between 0.0 and 1.0, to add a transition between "
      "two states (0.1 by default)", 0 },
131
132
    { "seed", OPT_SEED, "INT", 0,
      "seed for the random number generator (0 by default)", 0 },
133
134
135
    { "products", OPT_PRODUCTS, "INT", 0,
      "number of product to perform (1 by default), statistics will be "
      "averaged", 0 },
136
    /**************************************************/
137
    { 0, 0, 0, 0, "Statistics output:", 6 },
138
139
140
141
142
    { "json", OPT_JSON, "FILENAME", OPTION_ARG_OPTIONAL,
      "output statistics as JSON in FILENAME or on standard output", 0 },
    { "csv", OPT_CSV, "FILENAME", OPTION_ARG_OPTIONAL,
      "output statistics as CSV in FILENAME or on standard output", 0 },
    /**************************************************/
143
    { 0, 0, 0, 0, "Miscellaneous options:", -1 },
144
145
146
147
    { "color", OPT_COLOR, "WHEN", OPTION_ARG_OPTIONAL,
      "colorize output; WHEN can be 'never', 'always' (the default if "
      "--color is used without argument), or "
      "'auto' (the default if --color is not used)", 0 },
148
149
150
151
152
153
    { 0, 0, 0, 0, 0, 0 }
  };

const struct argp_child children[] =
  {
    { &finput_argp, 0, 0, 1 },
154
    { &misc_argp, 0, 0, -1 },
155
156
157
    { 0, 0, 0, 0 }
  };

158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

enum color_type { color_never, color_always, color_if_tty };

static char const *const color_args[] =
{
  "always", "yes", "force",
  "never", "no", "none",
  "auto", "tty", "if-tty", 0
};
static color_type const color_types[] =
{
  color_always, color_always, color_always,
  color_never, color_never, color_never,
  color_if_tty, color_if_tty, color_if_tty
};
ARGMATCH_VERIFY(color_args, color_types);

color_type color_opt = color_if_tty;
const char* bright_red = "\033[01;31m";
const char* bright_white = "\033[01;37m";
const char* reset_color = "\033[m";

180
181
unsigned states = 200;
float density = 0.1;
182
unsigned timeout = 0;
183
184
185
const char* json_output = 0;
const char* csv_output = 0;
bool want_stats = false;
186
bool allow_dups = false;
187
bool no_checks = false;
188
bool stop_on_error = false;
189
int seed = 0;
190
unsigned products = 1;
191

192
std::vector<char*> translators;
193
194
195
196
197
198
bool global_error_flag = false;

static std::ostream&
global_error()
{
  global_error_flag = true;
199
200
  if (color_opt)
    std::cerr << bright_red;
201
202
  return std::cerr;
}
203

204
205
206
207
208
209
210
211
static void
end_error()
{
  if (color_opt)
    std::cerr << reset_color;
}


212
213
struct statistics
{
214
215
  statistics()
    : ok(false),
216
217
218
219
220
221
222
223
224
225
226
227
228
229
      states(0),
      transitions(0),
      acc(0),
      scc(0),
      nonacc_scc(0),
      terminal_scc(0),
      weak_scc(0),
      strong_scc(0),
      nondetstates(0),
      nondeterministic(false),
      terminal_aut(false),
      weak_aut(false),
      strong_aut(false),
      time(0),
230
231
232
233
234
235
      product_states(0),
      product_transitions(0),
      product_scc(0)
  {
  }

236
237
238
239
240
241
  bool ok;
  unsigned states;
  unsigned edges;
  unsigned transitions;
  unsigned acc;
  unsigned scc;
242
243
244
245
  unsigned nonacc_scc;
  unsigned terminal_scc;
  unsigned weak_scc;
  unsigned strong_scc;
246
247
  unsigned nondetstates;
  bool nondeterministic;
248
249
250
  bool terminal_aut;
  bool weak_aut;
  bool strong_aut;
251
  double time;
252
253
254
  double product_states;
  double product_transitions;
  double product_scc;
255
256
257
258

  static void
  fields(std::ostream& os)
  {
259
260
261
262
263
    os << (" \"states\","
	   " \"edges\","
	   " \"transitions\","
	   " \"acc\","
	   " \"scc\","
264
265
266
267
268
269
270
271
272
	   " \"nonacc_scc\","
	   " \"terminal_scc\","
	   " \"weak_scc\","
	   " \"strong_scc\","
	   " \"nondet_states\","
	   " \"nondet_aut\","
	   " \"terminal_aut\","
	   " \"weak_aut\","
	   " \"strong_aut\","
273
274
275
276
	   " \"time\","
	   " \"product_states\","
	   " \"product_transitions\","
	   " \"product_scc\"");
277
278
279
280
281
282
283
284
285
286
  }

  void
  to_csv(std::ostream& os)
  {
    os << states << ", "
       << edges << ", "
       << transitions << ", "
       << acc << ", "
       << scc << ", "
287
288
289
290
       << nonacc_scc << ", "
       << terminal_scc << ", "
       << weak_scc << ", "
       << strong_scc << ", "
291
292
       << nondetstates << ", "
       << nondeterministic << ", "
293
294
295
       << terminal_aut << ", "
       << weak_aut << ", "
       << strong_aut << ", "
296
       << time << ", "
297
298
299
300
301
302
303
304
305
306
307
       << product_states << ", "
       << product_transitions << ", "
       << product_scc;
  }
};

typedef std::vector<statistics> statistics_formula;
typedef std::vector<statistics_formula> statistics_vector;
statistics_vector vstats;
std::vector<std::string> formulas;

308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
static int
to_int(const char* s)
{
  char* endptr;
  int res = strtol(s, &endptr, 10);
  if (*endptr)
    error(2, 0, "failed to parse '%s' as an integer.", s);
  return res;
}

static int
to_pos_int(const char* s)
{
  int res = to_int(s);
  if (res < 0)
    error(2, 0, "%d is not positive", res);
  return res;
}

static float
to_float(const char* s)
{
  char* endptr;
  // Do not use strtof(), it does not exist on Solaris 9.
  float res = strtod(s, &endptr);
  if (*endptr)
    error(2, 0, "failed to parse '%s' as a float.", s);
  return res;
}

static float
to_probability(const char* s)
{
  float res = to_float(s);
  if (res < 0.0 || res > 1.0)
    error(2, 0, "%f is not between 0 and 1.", res);
  return res;
}


static int
parse_opt(int key, char* arg, struct argp_state*)
{
  // This switch is alphabetically-ordered.
  switch (key)
    {
    case 't':
    case ARGP_KEY_ARG:
      translators.push_back(arg);
      break;
358
359
    case 'T':
      timeout = to_pos_int(arg);
360
361
362
363
#if !ENABLE_TIMEOUT
      std::cerr << "warning: setting a timeout is not supported "
		<< "on your platform" << std::endl;
#endif
364
      break;
365
366
367
368
369
370
371
372
    case OPT_COLOR:
      {
	if (arg)
	  color_opt = XARGMATCH("--color", arg, color_args, color_types);
	else
	  color_opt = color_always;
	break;
      }
373
374
375
376
    case OPT_CSV:
      want_stats = true;
      csv_output = arg ? arg : "-";
      break;
377
378
379
    case OPT_DENSITY:
      density = to_probability(arg);
      break;
380
381
382
    case OPT_DUPS:
      allow_dups = true;
      break;
383
384
385
386
    case OPT_JSON:
      want_stats = true;
      json_output = arg ? arg : "-";
      break;
387
388
389
    case OPT_PRODUCTS:
      products = to_pos_int(arg);
      break;
390
391
392
    case OPT_NOCHECKS:
      no_checks = true;
      break;
393
394
395
    case OPT_SEED:
      seed = to_pos_int(arg);
      break;
396
397
398
    case OPT_STATES:
      states = to_pos_int(arg);
      break;
399
400
401
    case OPT_STOP_ERR:
      stop_on_error = true;
      break;
402
403
404
405
406
407
    default:
      return ARGP_ERR_UNKNOWN;
    }
  return 0;
}

408
static volatile bool timed_out = false;
409
unsigned timeout_count = 0;
410

411
412
#if ENABLE_TIMEOUT
static volatile int alarm_on = 0;
413
414
415
416
417
418
419
420
421
422
423
424
425
426
static int child_pid = -1;

static void
sig_handler(int sig)
{
  if (child_pid == 0)
    error(2, 0, "child received signal %d before starting", sig);

  if (sig == SIGALRM && alarm_on)
    {
      timed_out = true;
      if (--alarm_on)
	{
	  // Send SIGTERM to children.
427
	  kill(-child_pid, SIGTERM);
428
429
430
431
432
433
434
	  // Try again later if it didn't work.  (alarm() will be reset
	  // if it did work and the call to wait() returns)
	  alarm(2);
	}
      else
	{
	  // After a few gentle tries, really kill that child.
435
	  kill(-child_pid, SIGKILL);
436
437
438
439
440
	}
    }
  else
    {
      // forward signal
441
      kill(-child_pid, sig);
442
      // cleanup files
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
443
      spot::cleanup_tmpfiles();
444
445
      // and die verbosely
      error(2, 0, "received signal %d", sig);
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
    }
}

static void
setup_sig_handler()
{
  struct sigaction sa;
  sa.sa_handler = sig_handler;
  sigemptyset(&sa.sa_mask);
  sa.sa_flags = SA_RESTART; // So that wait() doesn't get aborted by SIGALRM.
  sigaction(SIGALRM, &sa, 0);
  // Catch termination signals, so we can kill the subprocess.
  sigaction(SIGHUP, &sa, 0);
  sigaction(SIGINT, &sa, 0);
  sigaction(SIGQUIT, &sa, 0);
  sigaction(SIGTERM, &sa, 0);
}

static int
exec_with_timeout(const char* cmd)
{
  int status;

  timed_out = false;

  child_pid = fork();
  if (child_pid == -1)
    error(2, errno, "failed to fork()");

  if (child_pid == 0)
    {
      setpgid(0, 0);
      execlp("sh", "sh", "-c", cmd, (char*)0);
      error(2, errno, "failed to run 'sh'");
480
481
      // never reached
      return -1;
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
    }
  else
    {
      alarm(timeout);
      // Upon SIGALRM, the child will receive up to 3
      // signals: SIGTERM, SIGTERM, SIGKILL.
      alarm_on = 3;
      int w = waitpid(child_pid, &status, 0);
      alarm_on = 0;

      if (w == -1)
	error(2, errno, "error during wait()");

      alarm(0);
    }
  return status;
}
499
500
501
502
#else // !ENABLE_TIMEOUT
#define exec_with_timeout(cmd) system(cmd)
#define setup_sig_handler() while (0);
#endif // !ENABLE_TIMEOUT
503

504
namespace
505
{
506
507
508
  struct quoted_string: public spot::printable_value<std::string>
  {
    using spot::printable_value<std::string>::operator=;
509

510
511
512
513
514
515
516
517
    void
    print(std::ostream& os, const char* pos) const
    {
      os << '\'';
      this->spot::printable_value<std::string>::print(os, pos);
      os << '\'';
    }
  };
518

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
519
520
  struct printable_result_filename:
    public spot::printable_value<spot::temporary_file*>
521
522
523
524
  {
    unsigned translator_num;
    enum output_format { None, Spin, Lbtt };
    mutable output_format format;
525

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
526
527
528
529
530
531
532
533
534
535
    printable_result_filename()
    {
      val_ = 0;
    }

    ~printable_result_filename()
    {
      delete val_;
    }

536
537
538
539
540
    void reset(unsigned n)
    {
      translator_num = n;
      format = None;
    }
541

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
542
543
544
545
546
547
    void cleanup()
    {
      delete val_;
      val_ = 0;
    }

548
549
550
551
552
553
554
    void
    print(std::ostream& os, const char* pos) const
    {
      if (*pos == 'N')
	format = Spin;
      else
	format = Lbtt;
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
555
      if (val_)
556
557
	error(2, 0, "you may have only one %%N or %%T specifier: %s",
	      translators[translator_num]);
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
558
559
560
561
      char prefix[30];
      snprintf(prefix, sizeof prefix, "lcr-o%u-", translator_num);
      const_cast<printable_result_filename*>(this)->val_
	= spot::create_tmpfile(prefix);
562
563
564
      os << '\'' << val_ << '\'';
    }
  };
565

566
567
568
  class translator_runner: protected spot::formater
  {
  private:
569
    spot::bdd_dict& dict;
570
571
572
573
    // Round-specific variables
    quoted_string string_ltl_spot;
    quoted_string string_ltl_spin;
    quoted_string string_ltl_lbt;
574
    quoted_string string_ltl_wring;
575
576
577
    quoted_string filename_ltl_spot;
    quoted_string filename_ltl_spin;
    quoted_string filename_ltl_lbt;
578
    quoted_string filename_ltl_wring;
579
580
581
    // Run-specific variables
    printable_result_filename output;
  public:
582
583
    using spot::formater::has;

584
585
    translator_runner(spot::bdd_dict& dict)
      : dict(dict)
586
587
588
589
    {
      declare('f', &string_ltl_spot);
      declare('s', &string_ltl_spin);
      declare('l', &string_ltl_lbt);
590
      declare('w', &string_ltl_wring);
591
592
593
      declare('F', &filename_ltl_spot);
      declare('S', &filename_ltl_spin);
      declare('L', &filename_ltl_lbt);
594
      declare('W', &filename_ltl_wring);
595
596
597
      declare('N', &output);
      declare('T', &output);

598
      std::vector<bool> has(256);
599
600
601
      size_t s = translators.size();
      assert(s);
      for (size_t n = 0; n < s; ++n)
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
	{
	  // Check that each translator uses at least one input and
	  // one output.
	  has.clear();
	  scan(translators[n], has);
	  if (!(has['f'] || has['s'] || has['l'] || has['w']
		|| has['F'] || has['S'] || has['L'] || has['W']))
	    error(2, 0, "no input %%-sequence in '%s'.\n       Use "
		  "one of %%f,%%s,%%l,%%w,%%F,%%S,%%L,%%W to indicate how "
		  "to pass the formula.", translators[n]);
	  if (!(has['N'] || has['T']))
	    error(2, 0, "no output %%-sequence in '%s'.\n      Use "
		  "one of %%N,%%T to indicate where the automaton is saved.",
		  translators[n]);

	  // Remember the %-sequences used by all translators.
	  prime(translators[n]);
	}
620

621
622
623
624
    }

    void
    string_to_tmp(std::string& str, unsigned n, std::string& tmpname)
625
    {
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
626
627
628
629
630
      char prefix[30];
      snprintf(prefix, sizeof prefix, "lcr-i%u-", n);
      spot::open_temporary_file* tmpfile = spot::create_open_tmpfile(prefix);
      tmpname = tmpfile->name();
      int fd = tmpfile->fd();
631
632
633
634
      ssize_t s = str.size();
      if (write(fd, str.c_str(), s) != s
	  || write(fd, "\n", 1) != 1)
	error(2, errno, "failed to write into %s", tmpname.c_str());
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
635
      tmpfile->close();
636
637
    }

638
639
    const std::string&
    formula() const
640
641
642
643
644
645
    {
      // Pick the most readable format we have...
      if (!string_ltl_spot.val().empty())
	return string_ltl_spot;
      if (!string_ltl_spin.val().empty())
	return string_ltl_spin;
646
647
      if (!string_ltl_wring.val().empty())
	return string_ltl_wring;
648
649
      if (!string_ltl_lbt.val().empty())
	return string_ltl_lbt;
650
      assert(!"None of the translators need the input formula?");
651
652
653
      return string_ltl_spot;
    }

654
655
    void
    round_formula(const spot::ltl::formula* f, unsigned serial)
656
657
658
659
660
661
662
    {
      if (has('f') || has('F'))
	string_ltl_spot = spot::ltl::to_string(f, true);
      if (has('s') || has('S'))
	string_ltl_spin = spot::ltl::to_spin_string(f, true);
      if (has('l') || has('L'))
	string_ltl_lbt = spot::ltl::to_lbt_string(f);
663
664
      if (has('w') || has('W'))
	string_ltl_wring = spot::ltl::to_wring_string(f);
665
666
667
668
669
670
      if (has('F'))
	string_to_tmp(string_ltl_spot, serial, filename_ltl_spot);
      if (has('S'))
	string_to_tmp(string_ltl_spin, serial, filename_ltl_spin);
      if (has('L'))
	string_to_tmp(string_ltl_lbt, serial, filename_ltl_lbt);
671
672
      if (has('W'))
	string_to_tmp(string_ltl_wring, serial, filename_ltl_wring);
673
674
    }

675
676
    const spot::tgba*
    translate(unsigned int translator_num, char l, statistics_formula* fstats)
677
678
679
680
681
    {
      output.reset(translator_num);

      std::ostringstream command;
      format(command, translators[translator_num]);
682

683
      assert(output.format != printable_result_filename::None);
684

685
686
687
      std::string cmd = command.str();
      std::cerr << "Running [" << l << translator_num << "]: "
		<< cmd << std::endl;
688
      xtime_t before = gethrxtime();
689
      int es = exec_with_timeout(cmd.c_str());
690
      xtime_t after = gethrxtime();
691
692

      const spot::tgba* res = 0;
693
694
      if (timed_out)
	{
695
696
	  // This is not considered to be a global error.
	  std::cerr << "warning: timeout during execution of command\n";
697
	  ++timeout_count;
698
699
700
	}
      else if (WIFSIGNALED(es))
	{
701
702
	  global_error() << "error: execution terminated by signal "
			 << WTERMSIG(es) << ".\n";
703
	  end_error();
704
705
	}
      else if (WIFEXITED(es) && WEXITSTATUS(es) != 0)
706
	{
707
708
	  global_error() << "error: execution returned exit code "
			 << WEXITSTATUS(es) << ".\n";
709
	  end_error();
710
711
712
713
714
715
	}
      else
	{
	  switch (output.format)
	    {
	    case printable_result_filename::Spin:
716
	      {
717
		spot::neverclaim_parse_error_list pel;
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
718
719
		std::string filename = output.val()->name();
		res = spot::neverclaim_parse(filename, pel, &dict);
720
721
		if (!pel.empty())
		  {
722
723
		    std::ostream& err = global_error();
		    err << "error: failed to parse the produced neverclaim.\n";
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
724
		    spot::format_neverclaim_parse_errors(err, filename, pel);
725
		    end_error();
726
727
728
729
		    delete res;
		    res = 0;
		  }
		break;
730
	      }
731
	    case printable_result_filename::Lbtt:
732
	      {
733
		std::string error;
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
734
		std::ifstream f(output.val()->name());
735
736
		if (!f)
		  {
737
738
		    global_error() << "Cannot open " << output.val()
				   << std::endl;
739
		    end_error();
740
741
742
		  }
		else
		  {
743
		    res = spot::lbtt_parse(f, error, &dict);
744
		    if (!res)
745
746
747
748
749
750
		      {
			global_error() << ("error: failed to parse output in "
					   "LBTT format: ")
				       << error << std::endl;
			end_error();
		      }
751
752
		  }
		break;
753
	      }
754
755
756
	    case printable_result_filename::None:
	      assert(!"unreachable code");
	    }
757
	}
758
      // Compute statistics.
759
      if (res && want_stats)
760
761
762
763
764
765
766
767
768
769
	{
	  statistics* st = &(*fstats)[translator_num];
	  st->ok = true;
	  spot::tgba_sub_statistics s = sub_stats_reachable(res);
	  st->states = s.states;
	  st->edges = s.transitions;
	  st->transitions = s.sub_transitions;
	  st->acc = res->number_of_acceptance_conditions();
	  spot::scc_map m(res);
	  m.build_map();
770
	  unsigned c = m.scc_count();
771
772
773
	  st->scc = m.scc_count();
	  st->nondetstates = spot::count_nondet_states(res);
	  st->nondeterministic = st->nondetstates != 0;
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
	  for (unsigned n = 0; n < c; ++n)
	    {
	      if (!m.accepting(n))
		++st->nonacc_scc;
	      else if (is_terminal_scc(m, n))
		++st->terminal_scc;
	      else if (is_weak_scc(m, n))
		++st->weak_scc;
	      else
		++st->strong_scc;
	    }
	  if (st->strong_scc)
	    st->strong_aut = true;
	  else if (st->weak_scc)
	    st->weak_aut = true;
	  else
	    st->terminal_aut = true;
791
792
          double prec = XTIME_PRECISION;
	  st->time = (after - before) / prec;
793
	}
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
794
      output.cleanup();
795
      return res;
796
    }
797
  };
798

799
800
801
802
803
804
805
806
807
808
809
  static bool
  is_empty(const spot::tgba* aut)
  {
    spot::emptiness_check* ec = spot::couvreur99(aut);
    spot::emptiness_check_result* res = ec->check();
    delete res;
    delete ec;
    return !res;
  }

  static void
810
  cross_check(const std::vector<spot::scc_map*>& maps, char l, unsigned p)
811
812
  {
    size_t m = maps.size();
813

814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
    std::vector<bool> res(m);
    unsigned verified = 0;
    unsigned violated = 0;
    for (size_t i = 0; i < m; ++i)
      if (spot::scc_map* m = maps[i])
	{
	  // r == true iff the automaton i is accepting.
	  bool r = false;
	  unsigned c = m->scc_count();
	  for (unsigned j = 0; (j < c) && !r; ++j)
	    r |= m->accepting(j);
	  res[i] = r;
	  if (r)
	    ++verified;
	  else
	    ++violated;
	}
    if (verified != 0 && violated != 0)
832
      {
833
834
	std::ostream& err = global_error();
	err << "error: {";
835
836
837
838
839
840
841
	bool first = true;
	for (size_t i = 0; i < m; ++i)
	  if (maps[i] && res[i])
	    {
	      if (first)
		first = false;
	      else
842
843
		err << ",";
	      err << l << i;
844
	    }
845
	err << "} disagree with {";
846
847
848
849
850
851
852
	first = true;
	for (size_t i = 0; i < m; ++i)
	  if (maps[i] && !res[i])
	    {
	      if (first)
		first = false;
	      else
853
854
		err << ",";
	      err << l << i;
855
	    }
856
857
	err << "} when evaluating ";
	if (products > 1)
858
	  err << "state-space #" << p << "/" << products << "\n";
859
	else
860
	  err << "the state-space\n";
861
	end_error();
862
      }
863
  }
864

865
  typedef std::set<spot::state*, spot::state_ptr_less_than> state_set;
866

867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
  // Collect all the states of SSPACE that appear in the accepting SCCs
  // of PROD.
  static void
  states_in_acc(const spot::scc_map* m, const spot::tgba* sspace,
		state_set& s)
  {
    const spot::tgba* aut = m->get_aut();
    unsigned c = m->scc_count();
    for (unsigned n = 0; n < c; ++n)
      if (m->accepting(n))
	{
	  const std::list<const spot::state*>& l = m->states_of(n);
	  for (std::list<const spot::state*>::const_iterator i = l.begin();
	       i != l.end(); ++i)
	    {
	      spot::state* x = aut->project_state(*i, sspace);
	      if (!s.insert(x).second)
		x->destroy();
	    }
	}
  }
888

889
890
891
892
893
894
895
896
897
898
899
  static bool
  consistency_check(const spot::scc_map* pos, const spot::scc_map* neg,
		    const spot::tgba* sspace)
  {
    // the states of SSPACE should appear in the accepting SCC of at
    // least one of POS or NEG.  Maybe both.
    state_set s;
    states_in_acc(pos, sspace, s);
    states_in_acc(neg, sspace, s);
    bool res = s.size() == states;
    state_set::iterator it;
900
    for (it = s.begin(); it != s.end(); ++it)
901
902
903
      (*it)->destroy();
    return res;
  }
904

905
906
907
908
909
  typedef
  Sgi::hash_set<const spot::ltl::formula*,
		const spot::ptr_hash<const spot::ltl::formula> > fset_t;


910
911
  class processor: public job_processor
  {
912
    spot::bdd_dict dict;
913
    translator_runner runner;
914
    fset_t unique_set;
915
  public:
916
917
918
919
920
    processor()
      : runner(dict)
    {
    }

921
922
923
924
925
926
927
    ~processor()
    {
      fset_t::iterator i = unique_set.begin();
      while (i != unique_set.end())
	(*i++)->destroy();
    }

928
929
930
931
932
933
    int
    process_formula(const spot::ltl::formula* f,
		    const char* filename = 0, int linenum = 0)
    {
      (void) filename;
      (void) linenum;
934
      static unsigned round = 0;
935

936
937
938
939
940
941
942
943
944
945
      // If we need LBT atomic proposition in any of the input or
      // output, relabel the formula.
      if (!f->has_lbt_atomic_props() &&
	  (runner.has('l') || runner.has('L') || runner.has('T')))
	{
	  const spot::ltl::formula* g = spot::ltl::relabel(f, spot::ltl::Pnn);
	  f->destroy();
	  f = g;
	}

946
947
      // ---------- Positive Formula ----------

948
      runner.round_formula(f, round);
949

950
951
952
      // Call formula() before printing anything else, in case it
      // complains.
      std::string fstr = runner.formula();
953
954
955
956
957
958
      if (filename)
	std::cerr << filename << ":";
      if (linenum)
	std::cerr << linenum << ":";
      if (filename || linenum)
	std::cerr << " ";
959
960
      if (color_opt)
	std::cerr << bright_white;
961
      std::cerr << fstr << "\n";
962
963
      if (color_opt)
	std::cerr << reset_color;
964

965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
      // Make sure we do not translate the same formula twice.
      if (!allow_dups)
	{
	  if (unique_set.insert(f).second)
	    {
	      f->clone();
	    }
	  else
	    {
	      std::cerr
		<< ("warning: This formula or its negation has already"
		    " been checked.\n         Use --allow-dups if it "
		    "should not be ignored.\n")
		<< std::endl;
	      f->destroy();
	      return 0;
	    }
	}

      size_t m = translators.size();
      std::vector<const spot::tgba*> pos(m);
      std::vector<const spot::tgba*> neg(m);

      unsigned n = vstats.size();
989
      vstats.resize(n + (no_checks ? 1 : 2));
990
      statistics_formula* pstats = &vstats[n];
991
      statistics_formula* nstats = 0;
992
      pstats->resize(m);
993
994
      formulas.push_back(fstr);

995
      for (size_t n = 0; n < m; ++n)
996
997
998
	pos[n] = runner.translate(n, 'P', pstats);

      // ---------- Negative Formula ----------
999

1000
1001
1002
      // The negative formula is only needed when checks are
      // activated.
      if (!no_checks)
1003
	{
1004
1005
	  nstats = &vstats[n + 1];
	  nstats->resize(m);
1006

1007
1008
	  const spot::ltl::formula* nf =
	    spot::ltl::unop::instance(spot::ltl::unop::Not, f->clone());
1009

1010
1011
1012
1013
1014
1015
1016
1017
1018
	  if (!allow_dups)
	    {
	      bool res = unique_set.insert(nf->clone()).second;
	      // It is not possible to discover that nf has already been
	      // translated, otherwise that would mean that f had been
	      // translated too and we would have caught it before.
	      assert(res);
	      (void) res;
	    }
1019

1020
1021
	  runner.round_formula(nf, round);
	  formulas.push_back(runner.formula());
1022

1023
1024
1025
1026
	  for (size_t n = 0; n < m; ++n)
	    neg[n] = runner.translate(n, 'N', nstats);
	  nf->destroy();
	}
1027

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1028
      spot::cleanup_tmpfiles();
1029
      ++round;
1030

1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
      if (!no_checks)
	{
	  std::cerr << "Performing sanity checks and gathering statistics..."
		    << std::endl;

	  // intersection test
	  for (size_t i = 0; i < m; ++i)
	    if (pos[i])
	      for (size_t j = 0; j < m; ++j)
		if (neg[j])
		  {
		    spot::tgba_product* prod =
		      new spot::tgba_product(pos[i], neg[j]);
		    if (!is_empty(prod))
1045
1046
1047
1048
1049
		      {
			global_error() << "error: P" << i << "*N" << j
				       << " is nonempty\n";
			end_error();
		      }
1050
1051
1052
1053
1054
1055
1056
		    delete prod;
		  }
	}
      else
	{
	  std::cerr << "Gathering statistics..." << std::endl;
	}
1057

1058
      spot::ltl::atomic_prop_set* ap = spot::ltl::atomic_prop_collect(f);
1059
      f->destroy();
1060

1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
      for (unsigned p = 0; p < products; ++p)
	{
	  // build a random state-space.
	  spot::srand(seed);
	  spot::tgba* statespace = spot::random_graph(states, density,
						      ap, &dict);

	  // Products of the state space with the positive automata.
	  std::vector<spot::tgba*> pos_prod(m);
	  // Products of the state space with the negative automata.
	  std::vector<spot::tgba*> neg_prod(m);
	  // Associated SCC maps.
	  std::vector<spot::scc_map*> pos_map(m);
	  std::vector<spot::scc_map*> neg_map(m);
	  for (size_t i = 0; i < m; ++i)
	    if (pos[i])
1077
	      {
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
		spot::tgba* p = new spot::tgba_product(pos[i], statespace);
		pos_prod[i] = p;
		spot::scc_map* sm = new spot::scc_map(p);
		sm->build_map();
		pos_map[i] = sm;

		// Statistics
		if (want_stats)
		  {
		    (*pstats)[i].product_scc += sm->scc_count();
		    spot::tgba_statistics s = spot::stats_reachable(p);
		    (*pstats)[i].product_states += s.states;
		    (*pstats)[i].product_transitions += s.transitions;
		  }
1092
	      }
1093

1094
1095
1096
1097

	  if (!no_checks)
	    for (size_t i = 0; i < m; ++i)
	      if (neg[i])
1098
		{
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
		  spot::tgba* p = new spot::tgba_product(neg[i], statespace);
		  neg_prod[i] = p;
		  spot::scc_map* sm = new spot::scc_map(p);
		  sm->build_map();
		  neg_map[i] = sm;

		  // Statistics
		  if (want_stats)
		    {
		      (*nstats)[i].product_scc += sm->scc_count();
		      spot::tgba_statistics s = spot::stats_reachable(p);
		      (*nstats)[i].product_states += s.states;
		      (*nstats)[i].product_transitions += s.transitions;
		    }
1113
		}
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125

	  if (!no_checks)
	    {
	      // cross-comparison test
	      cross_check(pos_map, 'P', p);
	      cross_check(neg_map, 'N', p);

	      // consistency check
	      for (size_t i = 0; i < m; ++i)
		if (pos_map[i] && neg_map[i] &&
		    !(consistency_check(pos_map[i], neg_map[i], statespace)))
		  {
1126
1127
1128
		    std::ostream& err = global_error();
		    err << "error: inconsistency between P" << i
			<< " and N" << i;
1129
		    if (products > 1)
1130
1131
		      err << " for state-space #" << p
			  << "/" << products << "\n";
1132
		    else
1133
1134
		      err << "\n";
		    end_error();
1135
		  }
1136
	    }
1137

1138
	  // Cleanup.
1139

1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
	  if (!no_checks)
	    for (size_t i = 0; i < m; ++i)
	      {
		delete neg_map[i];
		delete neg_prod[i];
		if (want_stats)
		  {
		    (*nstats)[i].product_scc /= products;
		    (*nstats)[i].product_states /= products;
		    (*nstats)[i].product_transitions /= products;
		  }
	      }
1152
	  for (size_t i = 0; i < m; ++i)
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
	    {
	      delete pos_map[i];
	      delete pos_prod[i];
	      if (want_stats)
		{
		  (*pstats)[i].product_scc /= products;
		  (*pstats)[i].product_states /= products;
		  (*pstats)[i].product_transitions /= products;
		}
	    }
	  delete statespace;
	  ++seed;
1165
	}
1166
1167
      std::cerr << std::endl;
      delete ap;
1168

1169
      if (!no_checks)
1170
1171
1172
1173
	for (size_t i = 0; i < m; ++i)
	  delete neg[i];
      for (size_t i = 0; i < m; ++i)
	delete pos[i];
1174
1175
1176

      // Shall we stop processing formulas now?
      abort_run = global_error_flag && stop_on_error;
1177
1178
1179
1180
1181
      return 0;
    }
  };
}

1182
static void
1183
print_stats_csv(const char* filename)
1184
{
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
  std::ofstream* outfile = 0;
  std::ostream* out;
  if (!strncmp(filename, "-", 2))
    {
      out = &std::cout;
    }
  else
    {
      out = outfile = new std::ofstream(filename);
      if (!outfile)
	error(2, errno, "cannot open '%s'", filename);
    }

  unsigned ntrans = translators.size();
1199
  unsigned rounds = vstats.size();
1200
  assert(rounds == formulas.size());
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235

  *out << "\"formula\", \"tool\", ";
  statistics::fields(*out);
  *out << "\n";
  for (unsigned r = 0; r < rounds; ++r)
    for (unsigned t = 0; t < ntrans; ++t)
      if (vstats[r][t].ok)
	{
	  *out << "\"";
	  spot::escape_str(*out, formulas[r]);
	  *out << "\", \"";
	  spot::escape_str(*out, translators[t]);
	  *out << "\", ";
	  vstats[r][t].to_csv(*out);
	  *out << "\n";
	}
  delete outfile;
}

static void
print_stats_json(const char* filename)
{
  std::ofstream* outfile = 0;
  std::ostream* out;
  if (!strncmp(filename, "-", 2))
    {
      out = &std::cout;
    }
  else
    {
      out = outfile = new std::ofstream(filename);
      if (!outfile)
	error(2, errno, "cannot open '%s'", filename);
    }

1236
  unsigned ntrans = translators.size();
1237
  unsigned rounds = vstats.size();
1238
  assert(rounds == formulas.size());
1239

Elie Abi Saad's avatar
Elie Abi Saad committed
1240
  *out << "{\n  \"tool\": [\n    \"";
1241
  spot::escape_str(*out, translators[0]);
1242
  for (unsigned t = 1; t < ntrans; ++t)
1243
1244
1245
1246
    {
      *out << "\",\n    \"";
      spot::escape_str(*out, translators[t]);
    }
Elie Abi Saad's avatar
Elie Abi Saad committed
1247
  *out << "\"\n  ],\n  \"formula\": [\n    \"";
1248
  spot::escape_str(*out, formulas[0]);
1249
  for (unsigned r = 1; r < rounds; ++r)
1250
1251
1252
1253
    {
      *out << "\",\n    \"";
      spot::escape_str(*out, formulas[r]);
    }
Elie Abi Saad's avatar
Elie Abi Saad committed
1254
  *out << ("\"\n  ],\n  \"fields\":  [\n  \"formula\", \"tool\",");
1255
  statistics::fields(*out);
Elie Abi Saad's avatar
Elie Abi Saad committed
1256
1257
  *out << "\n  ],\n  \"inputs\":  [ 0, 1 ],";
  *out << "\n  \"results\": [";
1258
1259
1260
1261
1262
1263
  bool notfirst = false;
  for (unsigned r = 0; r < rounds; ++r)
    for (unsigned t = 0; t < ntrans; ++t)
      if (vstats[r][t].ok)
	{
	  if (notfirst)
1264
	    *out << ",";
1265
	  notfirst = true;
1266
1267
1268
	  *out << "\n    [ " << r << ", " << t << ", ";
	  vstats[r][t].to_csv(*out);
	  *out << " ]";
1269
	}
1270
1271
1272
  *out << "\n  ]\n}\n";

  delete outfile;
1273
}
1274
1275