ltsmin.cc 33.8 KB
Newer Older
1
// -*- coding: utf-8 -*-
2
// Copyright (C) 2011, 2012, 2014-2019 Laboratoire de
3
// Recherche et Développement de l'Epita (LRDE)
4 5 6 7 8
//
// 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
9
// the Free Software Foundation; either version 3 of the License, or
10 11 12 13 14 15 16 17
// (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
18
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
19

20
#include "config.h"
21 22 23 24
#include <ltdl.h>
#include <cstring>
#include <cstdlib>
#include <vector>
25
#include <sstream>
26 27
#include <sys/stat.h>
#include <unistd.h>
28

29 30 31 32 33
// MinGW does not define this.
#ifndef WEXITSTATUS
# define WEXITSTATUS(x) ((x) & 0xff)
#endif

34
#include <spot/ltsmin/ltsmin.hh>
35 36 37 38 39
#include <spot/misc/hashfunc.hh>
#include <spot/misc/fixpool.hh>
#include <spot/misc/mspool.hh>
#include <spot/misc/intvcomp.hh>
#include <spot/misc/intvcmp2.hh>
40

Etienne Renault's avatar
Etienne Renault committed
41 42 43 44
#include <spot/twaalgos/reachiter.hh>
#include <string.h>
#include <spot/mc/utils.hh>

45 46
using namespace std::string_literals;

47 48
namespace spot
{
49 50
  namespace
  {
51 52 53
    ////////////////////////////////////////////////////////////////////////
    // STATE

54
    struct spins_state final: public state
55
    {
56
      spins_state(int s, fixed_size_pool<pool_type::Safe>* p)
57
        : pool(p), size(s), count(1)
58 59 60 61 62
      {
      }

      void compute_hash()
      {
63 64 65
        hash_value = 0;
        for (int i = 0; i < size; ++i)
          hash_value = wang32_hash(hash_value ^ vars[i]);
66 67
      }

68
      spins_state* clone() const override
69
      {
70 71
        ++count;
        return const_cast<spins_state*>(this);
72 73
      }

74
      void destroy() const override
75
      {
76 77
        if (--count)
          return;
78
        pool->deallocate(const_cast<spins_state*>(this));
79 80
      }

81
      size_t hash() const override
82
      {
83
        return hash_value;
84 85
      }

86
      int compare(const state* other) const override
87
      {
88 89 90 91 92 93 94 95
        if (this == other)
          return 0;
        const spins_state* o = down_cast<const spins_state*>(other);
        if (hash_value < o->hash_value)
          return -1;
        if (hash_value > o->hash_value)
          return 1;
        return memcmp(vars, o->vars, size * sizeof(*vars));
96 97 98 99
      }

    private:

100
      ~spins_state()
101 102 103
      {
      }

104
    public:
105
      fixed_size_pool<pool_type::Safe>* pool;
106 107 108
      size_t hash_value: 32;
      int size: 16;
      mutable unsigned count: 16;
109
      int vars[1];
110 111
    };

112
    struct spins_compressed_state final: public state
113
    {
114
      spins_compressed_state(int s, multiple_size_pool* p)
115
        : pool(p), size(s), count(1)
116 117 118 119 120
      {
      }

      void compute_hash()
      {
121 122 123
        hash_value = 0;
        for (int i = 0; i < size; ++i)
          hash_value = wang32_hash(hash_value ^ vars[i]);
124 125
      }

126
      spins_compressed_state* clone() const override
127
      {
128 129
        ++count;
        return const_cast<spins_compressed_state*>(this);
130 131
      }

132
      void destroy() const override
133
      {
134 135
        if (--count)
          return;
136 137
        pool->deallocate(this, sizeof(*this) - sizeof(vars)
                         + size * sizeof(*vars));
138 139
      }

140
      size_t hash() const override
141
      {
142
        return hash_value;
143 144
      }

145
      int compare(const state* other) const override
146
      {
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
        if (this == other)
          return 0;
        const spins_compressed_state* o =
          down_cast<const spins_compressed_state*>(other);
        if (hash_value < o->hash_value)
          return -1;
        if (hash_value > o->hash_value)
          return 1;

        if (size < o->size)
          return -1;
        if (size > o->size)
          return 1;

        return memcmp(vars, o->vars, size * sizeof(*vars));
162 163 164 165
      }

    private:

166
      ~spins_compressed_state()
167 168 169 170
      {
      }

    public:
171
      multiple_size_pool* pool;
172 173 174
      size_t hash_value: 32;
      int size: 16;
      mutable unsigned count: 16;
175
      int vars[1];
176 177
    };

178 179 180 181 182
    ////////////////////////////////////////////////////////////////////////
    // CALLBACK FUNCTION for transitions.

    struct callback_context
    {
183
      typedef std::list<state*> transitions_t;
184 185
      transitions_t transitions;
      int state_size;
186 187
      void* pool;
      int* compressed;
188
      void (*compress)(const int*, size_t, int*, size_t&);
189 190 191

      ~callback_context()
      {
192 193
        for (auto t: transitions)
          t->destroy();
194
      }
195 196 197 198 199
    };

    void transition_callback(void* arg, transition_info_t*, int *dst)
    {
      callback_context* ctx = static_cast<callback_context*>(arg);
200 201
      fixed_size_pool<pool_type::Safe>* p =
        static_cast<fixed_size_pool<pool_type::Safe>*>(ctx->pool);
202
      spins_state* out =
203
        new(p->allocate()) spins_state(ctx->state_size, p);
204
      SPOT_ASSUME(out != nullptr);
205 206
      memcpy(out->vars, dst, ctx->state_size * sizeof(int));
      out->compute_hash();
207
      ctx->transitions.emplace_back(out);
208 209
    }

210 211 212
    void transition_callback_compress(void* arg, transition_info_t*, int *dst)
    {
      callback_context* ctx = static_cast<callback_context*>(arg);
213 214 215
      multiple_size_pool* p = static_cast<multiple_size_pool*>(ctx->pool);

      size_t csize = ctx->state_size * 2;
216
      ctx->compress(dst, ctx->state_size, ctx->compressed, csize);
217

218
      void* mem = p->allocate(sizeof(spins_compressed_state)
219
                              - sizeof(spins_compressed_state::vars)
220
                              + sizeof(int) * csize);
221
      spins_compressed_state* out = new(mem) spins_compressed_state(csize, p);
222
      SPOT_ASSUME(out != nullptr);
223
      memcpy(out->vars, ctx->compressed, csize * sizeof(int));
224
      out->compute_hash();
225
      ctx->transitions.emplace_back(out);
226 227
    }

228 229 230
    ////////////////////////////////////////////////////////////////////////
    // SUCC_ITERATOR

231
    class spins_succ_iterator final: public kripke_succ_iterator
232 233 234
    {
    public:

235
      spins_succ_iterator(const callback_context* cc,
236 237
                         bdd cond)
        : kripke_succ_iterator(cond), cc_(cc)
238 239 240
      {
      }

241 242
      void recycle(const callback_context* cc, bdd cond)
      {
243 244 245
        delete cc_;
        cc_ = cc;
        kripke_succ_iterator::recycle(cond);
246 247
      }

248
      ~spins_succ_iterator()
249
      {
250
        delete cc_;
251 252
      }

253
      virtual bool first() override
254
      {
255 256
        it_ = cc_->transitions.begin();
        return it_ != cc_->transitions.end();
257 258
      }

259
      virtual bool next() override
260
      {
261 262
        ++it_;
        return it_ != cc_->transitions.end();
263 264
      }

265
      virtual bool done() const override
266
      {
267
        return it_ == cc_->transitions.end();
268 269
      }

270
      virtual state* dst() const override
271
      {
272
        return (*it_)->clone();
273 274 275 276 277 278 279
      }

    private:
      const callback_context* cc_;
      callback_context::transitions_t::const_iterator it_;
    };

280 281 282 283 284 285 286 287 288 289 290
    ////////////////////////////////////////////////////////////////////////
    // PREDICATE EVALUATION

    typedef enum { OP_EQ, OP_NE, OP_LT, OP_GT, OP_LE, OP_GE } relop;

    struct one_prop
    {
      int var_num;
      relop op;
      int val;
      int bddvar;  // if "var_num op val" is true, output bddvar,
291
                   // else its negation
292 293 294
    };
    typedef std::vector<one_prop> prop_set;

295 296 297 298 299 300 301 302

    struct var_info
    {
      int num;
      int type;
    };


303
    void
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
304
    convert_aps(const atomic_prop_set* aps,
305 306 307 308
                spins_interface_ptr d,
                bdd_dict_ptr dict,
                formula dead,
                prop_set& out)
309 310
    {
      int errors = 0;
311
      std::ostringstream err;
312

313
      int state_size = d->get_state_size();
314 315 316
      typedef std::map<std::string, var_info> val_map_t;
      val_map_t val_map;

317
      for (int i = 0; i < state_size; ++i)
318 319 320 321 322 323
        {
          const char* name = d->get_state_variable_name(i);
          int type = d->get_state_variable_type(i);
          var_info v = { i , type };
          val_map[name] = v;
        }
324

325
      int type_count = d->get_type_count();
326 327 328
      typedef std::map<std::string, int> enum_map_t;
      std::vector<enum_map_t> enum_map(type_count);
      for (int i = 0; i < type_count; ++i)
329 330 331 332 333
        {
          int enum_count = d->get_type_value_count(i);
          for (int j = 0; j < enum_count; ++j)
            enum_map[i].emplace(d->get_type_value_name(i, j), j);
        }
334

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
335
      for (atomic_prop_set::const_iterator ap = aps->begin();
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
           ap != aps->end(); ++ap)
        {
          if (*ap == dead)
            continue;

          const std::string& str = ap->ap_name();
          const char* s = str.c_str();

          // Skip any leading blank.
          while (*s && (*s == ' ' || *s == '\t'))
            ++s;
          if (!*s)
            {
              err << "Proposition `" << str << "' cannot be parsed.\n";
              ++errors;
              continue;
            }


          char* name = (char*) malloc(str.size() + 1);
          char* name_p = name;
          char* lastdot = nullptr;
          while (*s && (*s != '=') && *s != '<' && *s != '!'  && *s != '>')
            {

              if (*s == ' ' || *s == '\t')
                ++s;
              else
                {
                  if (*s == '.')
                    lastdot = name_p;
                  *name_p++ = *s++;
                }
            }
          *name_p = 0;

          if (name == name_p)
            {
              err << "Proposition `" << str << "' cannot be parsed.\n";
              free(name);
              ++errors;
              continue;
            }

          // Lookup the name
          val_map_t::const_iterator ni = val_map.find(name);
          if (ni == val_map.end())
            {
              // We may have a name such as X.Y.Z
              // If it is not a known variable, it might mean
              // an enumerated variable X.Y with value Z.
              if (lastdot)
                {
                  *lastdot++ = 0;
                  ni = val_map.find(name);
                }

              if (ni == val_map.end())
                {
                  err << "No variable `" << name
                      << "' found in model (for proposition `"
                      << str << "').\n";
                  free(name);
                  ++errors;
                  continue;
                }

              // We have found the enumerated variable, and lastdot is
              // pointing to its expected value.
              int type_num = ni->second.type;
              enum_map_t::const_iterator ei = enum_map[type_num].find(lastdot);
              if (ei == enum_map[type_num].end())
                {
                  err << "No state `" << lastdot << "' known for variable `"
                      << name << "'.\n";
                  err << "Possible states are:";
                  for (auto& ej: enum_map[type_num])
                    err << ' ' << ej.first;
                  err << '\n';

                  free(name);
                  ++errors;
                  continue;
                }

              // At this point, *s should be 0.
              if (*s)
                {
                  err << "Trailing garbage `" << s
                      << "' at end of proposition `"
                      << str << "'.\n";
                  free(name);
                  ++errors;
                  continue;
                }

              // Record that X.Y must be equal to Z.
              int v = dict->register_proposition(*ap, d.get());
              one_prop p = { ni->second.num, OP_EQ, ei->second, v };
435
              out.emplace_back(p);
436 437 438 439 440 441 442 443 444 445
              free(name);
              continue;
            }

          int var_num = ni->second.num;

          if (!*s)                // No operator?  Assume "!= 0".
            {
              int v = dict->register_proposition(*ap, d);
              one_prop p = { var_num, OP_NE, 0, v };
446
              out.emplace_back(p);
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 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
              free(name);
              continue;
            }

          relop op;

          switch (*s)
            {
            case '!':
              if (s[1] != '=')
                goto report_error;
              op = OP_NE;
              s += 2;
              break;
            case '=':
              if (s[1] != '=')
                goto report_error;
              op = OP_EQ;
              s += 2;
              break;
            case '<':
              if (s[1] == '=')
                {
                  op = OP_LE;
                  s += 2;
                }
              else
                {
                  op = OP_LT;
                  ++s;
                }
              break;
            case '>':
              if (s[1] == '=')
                {
                  op = OP_GE;
                  s += 2;
                }
              else
                {
                  op = OP_GT;
                  ++s;
                }
              break;
            default:
            report_error:
              err << "Unexpected `" << s
                  << "' while parsing atomic proposition `" << str
                  << "'.\n";
              ++errors;
              free(name);
              continue;
            }

          while (*s && (*s == ' ' || *s == '\t'))
            ++s;

          int val = 0; // Initialize to kill a warning from old compilers.
          int type_num = ni->second.type;
          if (type_num == 0 || (*s >= '0' && *s <= '9') || *s == '-')
            {
              char* s_end;
              val = strtol(s, &s_end, 10);
              if (s == s_end)
                {
                  err << "Failed to parse `" << s << "' as an integer.\n";
                  ++errors;
                  free(name);
                  continue;
                }
              s = s_end;
            }
          else
            {
              // We are in a case such as P_0 == S, trying to convert
              // the string S into an integer.
              const char* end = s;
              while (*end && *end != ' ' && *end != '\t')
                ++end;
              std::string st(s, end);

              // Lookup the string.
              enum_map_t::const_iterator ei = enum_map[type_num].find(st);
              if (ei == enum_map[type_num].end())
                {
                  err << "No state `" << st << "' known for variable `"
                      << name << "'.\n";
                  err << "Possible states are:";
                  for (ei = enum_map[type_num].begin();
                       ei != enum_map[type_num].end(); ++ei)
                    err << ' ' << ei->first;
                  err << '\n';

                  free(name);
                  ++errors;
                  continue;
                }
              s = end;
              val = ei->second;
            }

          free(name);

          while (*s && (*s == ' ' || *s == '\t'))
            ++s;
          if (*s)
            {
              err << "Unexpected `" << s
                  << "' while parsing atomic proposition `" << str
                  << "'.\n";
              ++errors;
              continue;
            }


          int v = dict->register_proposition(*ap, d);
          one_prop p = { var_num, op, val, v };
564
          out.emplace_back(p);
565
        }
566

567
      if (errors)
568
        throw std::runtime_error(err.str());
569 570
    }

571 572 573
    ////////////////////////////////////////////////////////////////////////
    // KRIPKE

574
    class spins_kripke final: public kripke
575 576 577
    {
    public:

578
      spins_kripke(spins_interface_ptr d, const bdd_dict_ptr& dict,
579 580 581 582 583 584 585 586 587 588 589 590 591 592
                   const spot::prop_set* ps, formula dead,
                   int compress)
        : kripke(dict),
          d_(d),
          state_size_(d_->get_state_size()),
          ps_(ps),
          compress_(compress == 0 ? nullptr
                    : compress == 1 ? int_array_array_compress
                    : int_array_array_compress2),
          decompress_(compress == 0 ? nullptr
                      : compress == 1 ? int_array_array_decompress
                      : int_array_array_decompress2),
          uncompressed_(compress ? new int[state_size_ + 30] : nullptr),
          compressed_(compress ? new int[state_size_ * 2] : nullptr),
593 594 595 596 597
          statepool_(compress ?
                     (sizeof(spins_compressed_state)
                      - sizeof(spins_compressed_state::vars)) :
                     (sizeof(spins_state) - sizeof(spins_state::vars)
                      + (state_size_ * sizeof(int)))),
598 599
          state_condition_last_state_(nullptr),
          state_condition_last_cc_(nullptr)
600
      {
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
        vname_ = new const char*[state_size_];
        format_filter_ = new bool[state_size_];
        for (int i = 0; i < state_size_; ++i)
          {
            vname_[i] = d_->get_state_variable_name(i);
            // We don't want to print variables that can take a single
            // value (e.g. process with a single state) to shorten the
            // output.
            int type = d->get_state_variable_type(i);
            format_filter_[i] =
              (d->get_type_value_count(type) != 1);
          }

        // Register the "dead" proposition.  There are three cases to
        // consider:
        //  * If DEAD is "false", it means we are not interested in finite
        //    sequences of the system.
        //  * If DEAD is "true", we want to check finite sequences as well
        //    as infinite sequences, but do not need to distinguish them.
        //  * If DEAD is any other string, this is the name a property
        //    that should be true when looping on a dead state, and false
        //    otherwise.
        // We handle these three cases by setting ALIVE_PROP and DEAD_PROP
        // appropriately.  ALIVE_PROP is the bdd that should be ANDed
        // to all transitions leaving a live state, while DEAD_PROP should
        // be ANDed to all transitions leaving a dead state.
        if (dead.is_ff())
          {
            alive_prop = bddtrue;
            dead_prop = bddfalse;
          }
        else if (dead.is_tt())
          {
            alive_prop = bddtrue;
            dead_prop = bddtrue;
          }
        else
          {
            int var = dict->register_proposition(dead, d_);
            dead_prop = bdd_ithvar(var);
            alive_prop = bdd_nithvar(var);
          }
643 644
      }

645
      ~spins_kripke()
646
      {
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
        if (iter_cache_)
          {
            delete iter_cache_;
            iter_cache_ = nullptr;
          }
        delete[] format_filter_;
        delete[] vname_;
        if (compress_)
          {
            delete[] uncompressed_;
            delete[] compressed_;
          }
        dict_->unregister_all_my_variables(d_.get());

        delete ps_;

        if (state_condition_last_state_)
          state_condition_last_state_->destroy();
        delete state_condition_last_cc_; // Might be 0 already.
666 667
      }

668
      virtual state* get_init_state() const override
669
      {
670 671 672 673 674 675 676 677 678
        if (compress_)
          {
            d_->get_initial_state(uncompressed_);
            size_t csize = state_size_ * 2;
            compress_(uncompressed_, state_size_, compressed_, csize);

            multiple_size_pool* p =
              const_cast<multiple_size_pool*>(&compstatepool_);
            void* mem = p->allocate(sizeof(spins_compressed_state)
679
                                    - sizeof(spins_compressed_state::vars)
680 681 682
                                    + sizeof(int) * csize);
            spins_compressed_state* res = new(mem)
              spins_compressed_state(csize, p);
683
            SPOT_ASSUME(res != nullptr);
684 685 686 687 688 689
            memcpy(res->vars, compressed_, csize * sizeof(int));
            res->compute_hash();
            return res;
          }
        else
          {
690 691
            fixed_size_pool<pool_type::Safe>* p =
              const_cast<fixed_size_pool<pool_type::Safe>*>(&statepool_);
692
            spins_state* res = new(p->allocate()) spins_state(state_size_, p);
693
            SPOT_ASSUME(res != nullptr);
694 695 696 697
            d_->get_initial_state(res->vars);
            res->compute_hash();
            return res;
          }
698 699
      }

700
      bdd
701
      compute_state_condition_aux(const int* vars) const
702
      {
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
        bdd res = bddtrue;
        for (auto& i: *ps_)
          {
            int l = vars[i.var_num];
            int r = i.val;

            bool cond = false;
            switch (i.op)
              {
              case OP_EQ:
                cond = (l == r);
                break;
              case OP_NE:
                cond = (l != r);
                break;
              case OP_LT:
                cond = (l < r);
                break;
              case OP_GT:
                cond = (l > r);
                break;
              case OP_LE:
                cond = (l <= r);
                break;
              case OP_GE:
                cond = (l >= r);
                break;
              }

            if (cond)
              res &= bdd_ithvar(i.bddvar);
            else
              res &= bdd_nithvar(i.bddvar);
          }
        return res;
738 739
      }

740 741
      callback_context* build_cc(const int* vars, int& t) const
      {
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
        callback_context* cc = new callback_context;
        cc->state_size = state_size_;
        cc->pool =
          const_cast<void*>(compress_
                            ? static_cast<const void*>(&compstatepool_)
                            : static_cast<const void*>(&statepool_));
        cc->compress = compress_;
        cc->compressed = compressed_;
        t = d_->get_successors(nullptr, const_cast<int*>(vars),
                               compress_
                               ? transition_callback_compress
                               : transition_callback,
                               cc);
        assert((unsigned)t == cc->transitions.size());
        return cc;
757 758
      }

759 760 761
      bdd
      compute_state_condition(const state* st) const
      {
762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
        // If we just computed it, don't do it twice.
        if (st == state_condition_last_state_)
          return state_condition_last_cond_;

        if (state_condition_last_state_)
          {
            state_condition_last_state_->destroy();
            delete state_condition_last_cc_; // Might be 0 already.
            state_condition_last_cc_ = nullptr;
          }

        const int* vars = get_vars(st);

        bdd res = compute_state_condition_aux(vars);
        int t;
        callback_context* cc = build_cc(vars, t);

        if (t)
          {
            res &= alive_prop;
          }
        else
          {
            res &= dead_prop;

            // Add a self-loop to dead-states if we care about these.
            if (res != bddfalse)
789
              cc->transitions.emplace_back(st->clone());
790 791 792 793 794 795 796
          }

        state_condition_last_cc_ = cc;
        state_condition_last_cond_ = res;
        state_condition_last_state_ = st->clone();

        return res;
797 798
      }

799 800 801
      const int*
      get_vars(const state* st) const
      {
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
        const int* vars;
        if (compress_)
          {
            const spins_compressed_state* s =
              down_cast<const spins_compressed_state*>(st);

            decompress_(s->vars, s->size, uncompressed_, state_size_);
            vars = uncompressed_;
          }
        else
          {
            const spins_state* s = down_cast<const spins_state*>(st);
            vars = s->vars;
          }
        return vars;
817 818 819
      }


820
      virtual
821
      spins_succ_iterator* succ_iter(const state* st) const override
822
      {
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
        // This may also compute successors in state_condition_last_cc
        bdd scond = compute_state_condition(st);

        callback_context* cc;
        if (state_condition_last_cc_)
          {
            cc = state_condition_last_cc_;
            state_condition_last_cc_ = nullptr; // Now owned by the iterator.
          }
        else
          {
            int t;
            cc = build_cc(get_vars(st), t);

            // Add a self-loop to dead-states if we care about these.
            if (t == 0 && scond != bddfalse)
839
              cc->transitions.emplace_back(st->clone());
840 841 842 843 844 845 846 847 848 849 850
          }

        if (iter_cache_)
          {
            spins_succ_iterator* it =
              down_cast<spins_succ_iterator*>(iter_cache_);
            it->recycle(cc, scond);
            iter_cache_ = nullptr;
            return it;
          }
        return new spins_succ_iterator(cc, scond);
851 852 853
      }

      virtual
854
      bdd state_condition(const state* st) const override
855
      {
856
        return compute_state_condition(st);
857 858 859
      }

      virtual
860
      std::string format_state(const state *st) const override
861
      {
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
        const int* vars = get_vars(st);

        std::stringstream res;

        if (state_size_ == 0)
          return "empty state";

        int i = 0;
        for (;;)
          {
            if (!format_filter_[i])
              {
                ++i;
                if (i == state_size_)
                  break;
                continue;
              }
            res << vname_[i] << '=' << vars[i];
            ++i;
            if (i == state_size_)
              break;
            res << ", ";
          }
        return res.str();
886 887 888
      }

    private:
889
      spins_interface_ptr d_;
890
      int state_size_;
891
      const char** vname_;
892
      bool* format_filter_;
893
      const spot::prop_set* ps_;
894 895
      bdd alive_prop;
      bdd dead_prop;
896 897
      void (*compress_)(const int*, size_t, int*, size_t&);
      void (*decompress_)(const int*, size_t, int*, size_t);
898
      int* uncompressed_;
899
      int* compressed_;
900
      fixed_size_pool<pool_type::Safe> statepool_;
901
      multiple_size_pool compstatepool_;
902

903 904 905 906 907
      // This cache is used to speedup repeated calls to state_condition()
      // and get_succ().
      // If state_condition_last_state_ != 0, then state_condition_last_cond_
      // contain its (recently computed) condition.  If additionally
      // state_condition_last_cc_ != 0, then it contains the successors.
908
      mutable const state* state_condition_last_state_;
909 910
      mutable bdd state_condition_last_cond_;
      mutable callback_context* state_condition_last_cc_;
911 912 913
    };


914 915
    //////////////////////////////////////////////////////////////////////////
    // LOADER
916

917 918
    // Call spins to compile "foo.prom" as "foo.prom.spins" if the latter
    // does not exist already or is older.
919
    static void
920
    compile_model(std::string& filename, const std::string& ext)
921 922 923
    {
      std::string command;
      std::string compiled_ext;
924

925 926 927 928 929 930
      if (ext == ".gal")
        {
          command = "gal2c " + filename;
          compiled_ext = "2C";
        }
      else if (ext == ".prom" || ext == ".pm" || ext == ".pml")
931 932 933 934
        {
          command = "spins " + filename;
          compiled_ext = ".spins";
        }
935
      else if (ext == ".dve")
936 937
        {
          command = "divine compile --ltsmin " + filename;
Etienne Renault's avatar
Etienne Renault committed
938
          command += " 2> /dev/null"; // FIXME needed for Clang on MacOSX
939 940
          compiled_ext = "2C";
        }
941
      else
942
        {
943 944
          throw std::runtime_error("Unknown extension '"s + ext +
                                   "'.  Use '.prom', '.pm', '.pml', "
945 946
                                   "'.dve', '.dve2C', '.gal', '.gal2C' or "
                                   "'.prom.spins'.");
947
        }
948

949 950
      struct stat s;
      if (stat(filename.c_str(), &s) != 0)
951
        throw std::runtime_error("Cannot open "s + filename);
952

953
      filename += compiled_ext;
954

955 956 957 958
      // Remove any directory, because the new file will
      // be compiled in the current directory.
      size_t pos = filename.find_last_of("/\\");
      if (pos != std::string::npos)
959
        filename = "./" + filename.substr(pos + 1);
960

961 962
      struct stat d;
      if (stat(filename.c_str(), &d) == 0)
963
        if (s.st_mtime < d.st_mtime)
964
          // The .spins or .dve2C or .gal2C is up-to-date, no need to compile.
965
          return;
966

967 968
      int res = system(command.c_str());
      if (res)
969
        throw std::runtime_error("Execution of '"s
970 971
                                 + command.c_str() + "' returned exit code "
                                 + std::to_string(WEXITSTATUS(res)));
972
    }
973 974
  }

975 976
  ltsmin_model
  ltsmin_model::load(const std::string& file_arg)
977
  {
978 979 980 981 982 983
    std::string file;
    if (file_arg.find_first_of("/\\") != std::string::npos)
      file = file_arg;
    else
      file = "./" + file_arg;

984
    std::string ext = file.substr(file.find_last_of("."));
985
    if (ext != ".spins" && ext != ".dve2C" && ext != ".gal2C")
986 987 988 989
      {
        compile_model(file, ext);
        ext = file.substr(file.find_last_of("."));
      }
990

991
    if (lt_dlinit())
992
      throw std::runtime_error("Failed to initialize libltldl.");
993 994 995 996

    lt_dlhandle h = lt_dlopen(file.c_str());
    if (!h)
      {
997
        std::string lt_error = lt_dlerror();
998
        lt_dlexit();
999
        throw std::runtime_error("Failed to load '"s
1000
                                 + file + "'.\n" + lt_error);
1001 1002
      }

1003
    auto d = std::make_shared<spins_interface>();
1004 1005
    assert(d); // Superfluous, but Debian's GCC 7 snapshot 20161207-1 warns
               // about potential null pointer dereference on the next line.
1006 1007
    d->handle = h;

1008

1009
    auto sym = [&](auto* dst, const char* name)
1010
      {
1011 1012 1013
        // Work around -Wpendantic complaining that pointer-to-objects
        // should not be converted to pointer-to-functions (we have to
        // assume they can for POSIX).
1014 1015
        *reinterpret_cast<void**>(dst) = lt_dlsym(h, name);
        if (dst == nullptr)
1016
          throw std::runtime_error("Failed to resolve symbol '"s
1017 1018 1019
                                   + name + "' in '" + file + "'.");
      };

1020
    // SpinS interface.
1021
    if (ext == ".spins")
1022
      {
1023
        sym(&d->get_initial_state, "spins_get_initial_state");
1024
        d->have_property = nullptr;
1025 1026 1027 1028 1029 1030 1031 1032
        sym(&d->get_successors, "spins_get_successor_all");
        sym(&d->get_state_size, "spins_get_state_size");
        sym(&d->get_state_variable_name, "spins_get_state_variable_name");
        sym(&d->get_state_variable_type, "spins_get_state_variable_type");
        sym(&d->get_type_count, "spins_get_type_count");
        sym(&d->get_type_name, "spins_get_type_name");
        sym(&d->get_type_value_count, "spins_get_type_value_count");
        sym(&d->get_type_value_name, "spins_get_type_value_name");
1033
      }
1034
    // dve2 and gal2C interfaces.
1035 1036
    else
      {
1037
        sym(&d->get_initial_state, "get_initial_state");
1038
        *reinterpret_cast<void**>(&d->have_property) =
1039
          lt_dlsym(h, "have_property");
1040 1041 1042 1043 1044 1045 1046 1047
        sym(&d->get_successors, "get_successors");
        sym(&d->get_state_size, "get_state_variable_count");
        sym(&d->get_state_variable_name, "get_state_variable_name");
        sym(&d->get_state_variable_type, "get_state_variable_type");
        sym(&d->get_type_count, "get_state_variable_type_count");
        sym(&d->get_type_name, "get_state_variable_type_name");
        sym(&d->get_type_value_count, "get_state_variable_type_value_count");
        sym(&d->get_type_value_name, "get_state_variable_type_value");
1048 1049 1050
      }

    if (d->have_property && d->have_property())
1051
      throw std::runtime_error("Models with embedded properties "
1052
                               "are not supported.");
1053

1054 1055 1056
    return { d };
  }

Etienne Renault's avatar
Etienne Renault committed
1057

Etienne Renault's avatar
Etienne Renault committed
1058
  ltsmin_kripkecube_ptr
1059
  ltsmin_model::kripkecube(std::vector<std::string> to_observe,
1060 1061
                           const formula dead, int compress,
                           unsigned int nb_threads) const
Etienne Renault's avatar
Etienne Renault committed
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
  {
    // Register the "dead" proposition.  There are three cases to
    // consider:
    //  * If DEAD is "false", it means we are not interested in finite
    //    sequences of the system.
    //  * If DEAD is "true", we want to check finite sequences as well
    //    as infinite sequences, but do not need to distinguish them.
    //  * If DEAD is any other string, this is the name a property
    //    that should be true when looping on a dead state, and false
    //    otherwise.
    std::string dead_ap = "";
    bool selfloopize = true;
    if (dead == spot::formula::ff())
      selfloopize = false;
    else if (dead != spot::formula::tt())
      dead_ap = dead.ap_name();

1079
    // Is dead proposition is already in to_observe?
Etienne Renault's avatar
Etienne Renault committed
1080
    bool add_dead = true;
1081 1082 1083
    for (auto it: to_observe)
      if (it.compare(dead_ap))
        add_dead = false;
Etienne Renault's avatar
Etienne Renault committed
1084 1085

    if (dead_ap.compare("") != 0 && add_dead)
1086
      to_observe.push_back(dead_ap);
Etienne Renault's avatar
Etienne Renault committed
1087 1088

    // Finally build the system.
Etienne Renault's avatar
Etienne Renault committed
1089 1090
    return std::make_shared<spot::kripkecube<spot::cspins_state,
                                             spot::cspins_iterator>>
1091
      (iface, compress, to_observe, selfloopize, dead_ap, nb_threads);
Etienne Renault's avatar
Etienne Renault committed
1092
  }
1093 1094 1095

  kripke_ptr
  ltsmin_model::kripke(const atomic_prop_set* to_observe,
1096 1097
                       bdd_dict_ptr dict,
                       const formula dead, int compress) const
1098
  {
1099
    spot::prop_set* ps = new spot::prop_set;
1100 1101
    try
      {
1102
        convert_aps(to_observe, iface, dict, dead, *ps);
1103
      }
1104
    catch (const std::runtime_error&)
1105
      {
1106 1107 1108
        delete ps;
        dict->unregister_all_my_variables(iface.get());
        throw;
1109
      }
1110 1111
    auto res = SPOT_make_shared_enabled__(spins_kripke,
                                          iface, dict, ps, dead, compress);
1112 1113 1114 1115 1116
    // All atomic propositions have been registered to the bdd_dict
    // for iface, but we also need to add them to the automaton so
    // twa::ap() works.
    for (auto ap: *to_observe)
      res->register_ap(ap);
1117 1118
    if (dead.is(op::ap))
      res->register_ap(dead);
1119
    return res;
1120 1121 1122 1123
  }

  ltsmin_model::~ltsmin_model()
  {
1124
  }
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159

  int ltsmin_model::state_size() const
  {
    return iface->get_state_size();
  }

  const char* ltsmin_model::state_variable_name(int var) const
  {
    return iface->get_state_variable_name(var);
  }

  int ltsmin_model::state_variable_type(int var) const
  {
    return iface->get_state_variable_type(var);
  }

  int ltsmin_model::type_count() const
  {
    return iface->get_type_count();
  }

  const char* ltsmin_model::type_name(int type) const
  {
    return iface->get_type_name(type);
  }

  int ltsmin_model::type_value_count(int type)
  {
    return iface->get_type_value_count(type);
  }

  const char* ltsmin_model::type_value_name(int type, int val)
  {
    return iface->get_type_value_name(type, val);
  }
1160
}