magic-elimination.patch from patch #6230.
[pspp-builds.git] / src / language / tests / check-model.q
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2007 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18
19 #include <language/tests/check-model.h>
20
21 #include <errno.h>
22
23 #include <libpspp/model-checker.h>
24 #include <language/lexer/lexer.h>
25
26 #include "error.h"
27 #include "fwriteerror.h"
28
29 #include "gettext.h"
30 #define _(msgid) gettext (msgid)
31 #define N_(msgid) msgid
32
33 /* (headers) */
34
35 /* (specification)
36    "CHECK MODEL" (chm_):
37     search=strategy:broad/deep/random,
38            :mxd(n:max_depth),
39            :hash(n:hash_bits);
40     path=integer list;
41     queue=:limit(n:queue_limit,"%s>0"),
42           drop:newest/oldest/random;
43     seed=integer;
44     stop=:states(n:max_unique_states,"%s>0"),
45          :errors(n:max_errors),
46          :timeout(d:time_limit,"%s>0");
47     progress=progress:none/dots/fancy;
48     output=:verbosity(n:verbosity),
49            :errverbosity(n:err_verbosity),
50            :file(s:output_file).
51 */
52 /* (declarations) */
53 /* (functions) */
54
55 static struct mc_options *parse_options (struct lexer *);
56 static void print_results (const struct mc_results *, FILE *);
57
58 /* Parses a syntax description of model checker options from
59    LEXER and passes them, along with AUX, to the CHECKER
60    function, which must wrap a call to mc_run and return the
61    mc_results that it returned.  This function then prints a
62    description of the mc_results to the output file.  Returns
63    true if the model checker run found no errors, false
64    otherwise. */
65 bool
66 check_model (struct lexer *lexer,
67              struct mc_results *(*checker) (struct mc_options *, void *aux),
68              void *aux)
69 {
70   struct mc_options *options;
71   struct mc_results *results;
72   FILE *output_file;
73   bool ok;
74
75   options = parse_options (lexer);
76   if (options == NULL)
77     return false;
78   output_file = mc_options_get_output_file (options);
79
80   results = checker (options, aux);
81
82   print_results (results, output_file);
83
84   if (output_file != stdout && output_file != stderr)
85     {
86       if (fwriteerror (output_file) < 0)
87         {
88           /* We've already discarded the name of the output file.
89              Oh well. */
90           error (0, errno, "error closing output file");
91         }
92     }
93
94   ok = mc_results_get_error_count (results) == 0;
95   mc_results_destroy (results);
96
97   return ok;
98 }
99
100 /* Fancy progress function for mc_options_set_progress_func. */
101 static bool
102 fancy_progress (struct mc *mc)
103 {
104   const struct mc_results *results = mc_get_results (mc);
105   if (mc_results_get_stop_reason (results) == MC_CONTINUING)
106     fprintf (stderr, "Processed %d unique states, max depth %d, "
107              "dropped %d duplicates...\r",
108              mc_results_get_unique_state_count (results),
109              mc_results_get_max_depth_reached (results),
110              mc_results_get_duplicate_dropped_states (results));
111   else
112     putc ('\n', stderr);
113   return true;
114 }
115
116 /* Parses options from LEXER and returns a corresponding
117    mc_options, or a null pointer if parsing fails. */
118 static struct mc_options *
119 parse_options (struct lexer *lexer)
120 {
121   struct cmd_check_model cmd;
122   struct mc_options *options;
123
124   if (!parse_check_model (lexer, NULL, &cmd, NULL))
125     return NULL;
126
127   options = mc_options_create ();
128   if (cmd.strategy != -1)
129     mc_options_set_strategy (options,
130                              cmd.strategy == CHM_BROAD ? MC_BROAD
131                              : cmd.strategy == CHM_DEEP ? MC_DEEP
132                              : cmd.strategy == CHM_RANDOM ? MC_RANDOM
133                              : -1);
134   if (cmd.sbc_path > 0)
135     {
136       if (cmd.sbc_search > 0)
137         msg (SW, _("PATH and SEARCH subcommands are mutually exclusive.  "
138                    "Ignoring PATH."));
139       else
140         {
141           struct subc_list_int *list = &cmd.il_path[0];
142           int count = subc_list_int_count (list);
143           if (count > 0)
144             {
145               struct mc_path path;
146               int i;
147
148               mc_path_init (&path);
149               for (i = 0; i < count; i++)
150                 mc_path_push (&path, subc_list_int_at (list, i));
151               mc_options_set_follow_path (options, &path);
152               mc_path_destroy (&path);
153             }
154           else
155             msg (SW, _("At least one value must be specified on PATH."));
156         }
157     }
158   if (cmd.max_depth != LONG_MIN)
159     mc_options_set_max_depth (options, cmd.max_depth);
160   if (cmd.hash_bits != LONG_MIN)
161     {
162       int hash_bits;
163       mc_options_set_hash_bits (options, cmd.hash_bits);
164       hash_bits = mc_options_get_hash_bits (options);
165       if (hash_bits != cmd.hash_bits)
166         msg (SW, _("Hash bits adjusted to %d."), hash_bits);
167     }
168   if (cmd.queue_limit != LONG_MIN)
169     mc_options_set_queue_limit (options, cmd.queue_limit);
170   if (cmd.drop != -1)
171     {
172       enum mc_queue_limit_strategy drop
173         = (cmd.drop == CHM_NEWEST ? MC_DROP_NEWEST
174            : cmd.drop == CHM_OLDEST ? MC_DROP_OLDEST
175            : cmd.drop == CHM_RANDOM ? MC_DROP_RANDOM
176            : -1);
177       mc_options_set_queue_limit_strategy (options, drop);
178     }
179   if (cmd.sbc_search > 0)
180     mc_options_set_seed (options, cmd.n_seed[0]);
181   if (cmd.max_unique_states != LONG_MIN)
182     mc_options_set_max_unique_states (options, cmd.max_unique_states);
183   if (cmd.max_errors != LONG_MIN)
184     mc_options_set_max_errors (options, cmd.max_errors);
185   if (cmd.time_limit != SYSMIS)
186     mc_options_set_time_limit (options, cmd.time_limit);
187   if (cmd.verbosity != LONG_MIN)
188     mc_options_set_verbosity (options, cmd.verbosity);
189   if (cmd.err_verbosity != LONG_MIN)
190     mc_options_set_failure_verbosity (options, cmd.err_verbosity);
191   if (cmd.progress != -1)
192     {
193       if (cmd.progress == CHM_NONE)
194         mc_options_set_progress_usec (options, 0);
195       else if (cmd.progress == CHM_DOTS)
196         {
197           /* Nothing to do: that's the default anyway. */
198         }
199       else if (cmd.progress == CHM_FANCY)
200         mc_options_set_progress_func (options, fancy_progress);
201     }
202   if (cmd.output_file != NULL)
203     {
204       FILE *output_file = fopen (cmd.output_file, "w");
205       if (output_file == NULL)
206         {
207           error (0, errno, _("error opening \"%s\" for writing"),
208                  cmd.output_file);
209           free_check_model (&cmd);
210           mc_options_destroy (options);
211           return NULL;
212         }
213       mc_options_set_output_file (options, output_file);
214     }
215
216
217   free_check_model (&cmd);
218
219   return options;
220 }
221
222 /* Prints a description of RESULTS to stream F. */
223 static void
224 print_results (const struct mc_results *results, FILE *f)
225 {
226   enum mc_stop_reason reason = mc_results_get_stop_reason (results);
227
228   fputs ("\n"
229          "MODEL CHECKING SUMMARY\n"
230          "----------------------\n\n", f);
231
232   fprintf (f, "Stopped by: %s\n",
233            reason == MC_SUCCESS ? "state space exhaustion"
234            : reason == MC_MAX_UNIQUE_STATES ? "reaching max unique states"
235            : reason == MC_MAX_ERROR_COUNT ? "reaching max error count"
236            : reason == MC_END_OF_PATH ? "reached end of specified path"
237            : reason == MC_TIMEOUT ? "reaching time limit"
238            : reason == MC_INTERRUPTED ? "user interruption"
239            : "unknown reason");
240   fprintf (f, "Errors found: %d\n\n", mc_results_get_error_count (results));
241
242   fprintf (f, "Unique states checked: %d\n",
243            mc_results_get_unique_state_count (results));
244   fprintf (f, "Maximum depth reached: %d\n",
245            mc_results_get_max_depth_reached (results));
246   fprintf (f, "Mean depth reached: %.2f\n\n",
247            mc_results_get_mean_depth_reached (results));
248
249   fprintf (f, "Dropped duplicate states: %d\n",
250            mc_results_get_duplicate_dropped_states (results));
251   fprintf (f, "Dropped off-path states: %d\n",
252            mc_results_get_off_path_dropped_states (results));
253   fprintf (f, "Dropped too-deep states: %d\n",
254            mc_results_get_depth_dropped_states (results));
255   fprintf (f, "Dropped queue-overflow states: %d\n",
256            mc_results_get_queue_dropped_states (results));
257   fprintf (f, "Checked states still queued when stopped: %d\n",
258            mc_results_get_queued_unprocessed_states (results));
259   fprintf (f, "Maximum queue length reached: %d\n\n",
260            mc_results_get_max_queue_length (results));
261
262   fprintf (f, "Runtime: %.2f seconds\n",
263            mc_results_get_duration (results));
264
265   putc ('\n', f);
266 }
267
268 /*
269   Local Variables:
270   mode: c
271   End:
272 */