1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2007, 2009 Free Software Foundation, Inc.
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.
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.
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/>. */
19 #include "sys-file-writer.h"
20 #include "sys-file-private.h"
29 #include <libpspp/float-format.h>
30 #include <libpspp/integer-format.h>
31 #include <libpspp/message.h>
32 #include <libpspp/misc.h>
33 #include <libpspp/str.h>
34 #include <libpspp/version.h>
36 #include <data/attributes.h>
37 #include <data/case.h>
38 #include <data/casewriter-provider.h>
39 #include <data/casewriter.h>
40 #include <data/dictionary.h>
41 #include <data/file-handle-def.h>
42 #include <data/file-name.h>
43 #include <data/format.h>
44 #include <data/make-file.h>
45 #include <data/missing-values.h>
46 #include <data/settings.h>
47 #include <data/short-names.h>
48 #include <data/value-labels.h>
49 #include <data/variable.h>
52 #include "unlocked-io.h"
56 #define _(msgid) gettext (msgid)
57 #define N_(msgid) (msgid)
59 /* Compression bias used by PSPP. Values between (1 -
60 COMPRESSION_BIAS) and (251 - COMPRESSION_BIAS) inclusive can be
62 #define COMPRESSION_BIAS 100
64 /* System file writer. */
67 struct file_handle *fh; /* File handle. */
68 struct fh_lock *lock; /* Mutual exclusion for file. */
69 FILE *file; /* File stream. */
70 struct replace_file *rf; /* Ticket for replacing output file. */
72 bool compress; /* 1=compressed, 0=not compressed. */
73 casenumber case_cnt; /* Number of cases written so far. */
75 /* Compression buffering.
77 Compressed data is output as groups of 8 1-byte opcodes
78 followed by up to 8 (depending on the opcodes) 8-byte data
79 items. Data items and opcodes arrive at the same time but
80 must be reordered for writing to disk, thus a small amount
82 uint8_t opcodes[8]; /* Buffered opcodes. */
83 int opcode_cnt; /* Number of buffered opcodes. */
84 uint8_t data[8][8]; /* Buffered data. */
85 int data_cnt; /* Number of buffered data items. */
88 struct sfm_var *sfm_vars; /* Variables. */
89 size_t sfm_var_cnt; /* Number of variables. */
90 size_t segment_cnt; /* Number of variables including extra segments
91 for long string variables. */
94 static const struct casewriter_class sys_file_casewriter_class;
96 static void write_header (struct sfm_writer *, const struct dictionary *);
97 static void write_variable (struct sfm_writer *, const struct variable *);
98 static void write_value_labels (struct sfm_writer *,
99 struct variable *, int idx);
100 static void write_integer_info_record (struct sfm_writer *);
101 static void write_float_info_record (struct sfm_writer *);
103 static void write_longvar_table (struct sfm_writer *w,
104 const struct dictionary *dict);
106 static void write_vls_length_table (struct sfm_writer *w,
107 const struct dictionary *dict);
110 static void write_variable_display_parameters (struct sfm_writer *w,
111 const struct dictionary *dict);
113 static void write_documents (struct sfm_writer *, const struct dictionary *);
115 static void write_data_file_attributes (struct sfm_writer *,
116 const struct dictionary *);
117 static void write_variable_attributes (struct sfm_writer *,
118 const struct dictionary *);
120 static void write_int (struct sfm_writer *, int32_t);
121 static inline void convert_double_to_output_format (double, uint8_t[8]);
122 static void write_float (struct sfm_writer *, double);
123 static void write_string (struct sfm_writer *, const char *, size_t);
124 static void write_bytes (struct sfm_writer *, const void *, size_t);
125 static void write_zeros (struct sfm_writer *, size_t);
126 static void write_spaces (struct sfm_writer *, size_t);
127 static void write_value (struct sfm_writer *, const union value *, int width);
129 static void write_case_uncompressed (struct sfm_writer *,
130 const struct ccase *);
131 static void write_case_compressed (struct sfm_writer *, const struct ccase *);
132 static void flush_compressed (struct sfm_writer *);
133 static void put_cmp_opcode (struct sfm_writer *, uint8_t);
134 static void put_cmp_number (struct sfm_writer *, double);
135 static void put_cmp_string (struct sfm_writer *, const void *, size_t);
137 bool write_error (const struct sfm_writer *);
138 bool close_writer (struct sfm_writer *);
140 /* Returns default options for writing a system file. */
141 struct sfm_write_options
142 sfm_writer_default_options (void)
144 struct sfm_write_options opts;
145 opts.create_writeable = true;
146 opts.compress = settings_get_scompression ();
151 /* Opens the system file designated by file handle FH for writing
152 cases from dictionary D according to the given OPTS. If
153 COMPRESS is nonzero, the system file will be compressed.
155 No reference to D is retained, so it may be modified or
156 destroyed at will after this function returns. D is not
157 modified by this function, except to assign short names. */
159 sfm_open_writer (struct file_handle *fh, struct dictionary *d,
160 struct sfm_write_options opts)
162 struct sfm_writer *w;
168 if (opts.version != 2 && opts.version != 3)
170 msg (ME, _("Unknown system file version %d. Treating as version %d."),
175 /* Create and initialize writer. */
176 w = xmalloc (sizeof *w);
182 w->compress = opts.compress;
185 w->opcode_cnt = w->data_cnt = 0;
187 /* Figure out how to map in-memory case data to on-disk case
188 data. Also count the number of segments. Very long strings
189 occupy multiple segments, otherwise each variable only takes
191 w->segment_cnt = sfm_dictionary_to_sfm_vars (d, &w->sfm_vars,
194 /* Open file handle as an exclusive writer. */
195 /* TRANSLATORS: this fragment will be interpolated into
196 messages in fh_lock() that identify types of files. */
197 w->lock = fh_lock (fh, FH_REF_FILE, N_("system file"), FH_ACC_WRITE, true);
201 /* Create the file on disk. */
202 mode = S_IRUSR | S_IRGRP | S_IROTH;
203 if (opts.create_writeable)
204 mode |= S_IWUSR | S_IWGRP | S_IWOTH;
205 w->rf = replace_file_start (fh_get_file_name (fh), "wb", mode,
209 msg (ME, _("Error opening \"%s\" for writing as a system file: %s."),
210 fh_get_file_name (fh), strerror (errno));
214 /* Write the file header. */
217 /* Write basic variable info. */
218 short_names_assign (d);
219 for (i = 0; i < dict_get_var_cnt (d); i++)
220 write_variable (w, dict_get_var (d, i));
222 /* Write out value labels. */
224 for (i = 0; i < dict_get_var_cnt (d); i++)
226 struct variable *v = dict_get_var (d, i);
228 write_value_labels (w, v, idx);
229 idx += sfm_width_to_octs (var_get_width (v));
232 if (dict_get_documents (d) != NULL)
233 write_documents (w, d);
235 write_integer_info_record (w);
236 write_float_info_record (w);
238 write_variable_display_parameters (w, d);
240 if (opts.version >= 3)
241 write_longvar_table (w, d);
243 write_vls_length_table (w, d);
245 if (attrset_count (dict_get_attributes (d)))
246 write_data_file_attributes (w, d);
247 write_variable_attributes (w, d);
249 /* Write end-of-headers record. */
259 return casewriter_create (dict_get_next_value_idx (d),
260 &sys_file_casewriter_class, w);
267 /* Returns value of X truncated to two least-significant digits. */
278 /* Calculates the offset of data for TARGET_VAR from the
279 beginning of each case's data for dictionary D. The return
280 value is in "octs" (8-byte units). */
282 calc_oct_idx (const struct dictionary *d, struct variable *target_var)
288 for (i = 0; i < dict_get_var_cnt (d); i++)
290 struct variable *var = dict_get_var (d, i);
291 if (var == target_var)
293 oct_idx += sfm_width_to_octs (var_get_width (var));
298 /* Write the sysfile_header header to system file W. */
300 write_header (struct sfm_writer *w, const struct dictionary *d)
303 char creation_date[10];
304 char creation_time[9];
305 const char *file_label;
306 struct variable *weight;
310 /* Record-type code. */
311 write_string (w, "$FL2", 4);
313 /* Product identification. */
314 snprintf (prod_name, sizeof prod_name, "@(#) SPSS DATA FILE %s - %s",
315 version, host_system);
316 write_string (w, prod_name, 60);
321 /* Number of `union value's per case. */
322 write_int (w, calc_oct_idx (d, NULL));
325 write_int (w, w->compress);
327 /* Weight variable. */
328 weight = dict_get_weight (d);
329 write_int (w, weight != NULL ? calc_oct_idx (d, weight) + 1 : 0);
331 /* Number of cases. We don't know this in advance, so we write
332 -1 to indicate an unknown number of cases. Later we can
333 come back and overwrite it with the true value. */
336 /* Compression bias. */
337 write_float (w, COMPRESSION_BIAS);
339 /* Creation date and time. */
340 if (time (&t) == (time_t) -1)
342 strcpy (creation_date, "01 Jan 70");
343 strcpy (creation_time, "00:00:00");
347 static const char *const month_name[12] =
349 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
350 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec",
352 struct tm *tmp = localtime (&t);
353 int day = rerange (tmp->tm_mday);
354 int mon = rerange (tmp->tm_mon + 1);
355 int year = rerange (tmp->tm_year);
356 int hour = rerange (tmp->tm_hour + 1);
357 int min = rerange (tmp->tm_min + 1);
358 int sec = rerange (tmp->tm_sec + 1);
360 snprintf (creation_date, sizeof creation_date,
361 "%02d %s %02d", day, month_name[mon - 1], year);
362 snprintf (creation_time, sizeof creation_time,
363 "%02d:%02d:%02d", hour - 1, min - 1, sec - 1);
365 write_string (w, creation_date, 9);
366 write_string (w, creation_time, 8);
369 file_label = dict_get_label (d);
370 if (file_label == NULL)
372 write_string (w, file_label, 64);
378 /* Write format spec FMT to W, after adjusting it to be
379 compatible with the given WIDTH. */
381 write_format (struct sfm_writer *w, struct fmt_spec fmt, int width)
383 assert (fmt_check_output (&fmt));
384 assert (sfm_width_to_segments (width) == 1);
387 fmt_resize (&fmt, width);
388 write_int (w, (fmt_to_io (fmt.type) << 16) | (fmt.w << 8) | fmt.d);
391 /* Write a string continuation variable record for each 8-byte
392 section beyond the initial 8 bytes, for a variable of the
395 write_variable_continuation_records (struct sfm_writer *w, int width)
399 assert (sfm_width_to_segments (width) == 1);
400 for (position = 8; position < width; position += 8)
402 write_int (w, 2); /* Record type. */
403 write_int (w, -1); /* Width. */
404 write_int (w, 0); /* No variable label. */
405 write_int (w, 0); /* No missing values. */
406 write_int (w, 0); /* Print format. */
407 write_int (w, 0); /* Write format. */
408 write_zeros (w, 8); /* Name. */
412 /* Write the variable record(s) for variable V to system file
415 write_variable (struct sfm_writer *w, const struct variable *v)
417 int width = var_get_width (v);
418 int segment_cnt = sfm_width_to_segments (width);
419 int seg0_width = sfm_segment_alloc_width (width, 0);
420 const struct missing_values *mv = var_get_missing_values (v);
427 write_int (w, seg0_width);
429 /* Variable has a variable label? */
430 write_int (w, var_has_label (v));
432 /* Number of missing values. If there is a range, then the
433 range counts as 2 missing values and causes the number to be
435 write_int (w, mv_has_range (mv) ? -2 - mv_n_values (mv) : mv_n_values (mv));
437 /* Print and write formats. */
438 write_format (w, *var_get_print_format (v), seg0_width);
439 write_format (w, *var_get_write_format (v), seg0_width);
442 The full name is in a translation table written
444 write_string (w, var_get_short_name (v, 0), 8);
447 if (var_has_label (v))
449 const char *label = var_get_label (v);
450 size_t padded_len = ROUND_UP (MIN (strlen (label), 255), 4);
451 write_int (w, padded_len);
452 write_string (w, label, padded_len);
455 /* Write the missing values, if any, range first. */
456 if (mv_has_range (mv))
459 mv_get_range (mv, &x, &y);
463 for (i = 0; i < mv_n_values (mv); i++)
466 mv_get_value (mv, &value, i);
467 write_value (w, &value, seg0_width);
470 write_variable_continuation_records (w, seg0_width);
472 /* Write additional segments for very long string variables. */
473 for (i = 1; i < segment_cnt; i++)
475 int seg_width = sfm_segment_alloc_width (width, i);
476 struct fmt_spec fmt = fmt_for_output (FMT_A, MAX (seg_width, 1), 0);
478 write_int (w, 2); /* Variable record. */
479 write_int (w, seg_width); /* Width. */
480 write_int (w, 0); /* No variable label. */
481 write_int (w, 0); /* No missing values. */
482 write_format (w, fmt, seg_width); /* Print format. */
483 write_format (w, fmt, seg_width); /* Write format. */
484 write_string (w, var_get_short_name (v, i), 8);
486 write_variable_continuation_records (w, seg_width);
490 /* Writes the value labels for variable V having system file
491 variable index IDX to system file W. */
493 write_value_labels (struct sfm_writer *w, struct variable *v, int idx)
495 const struct val_labs *val_labs;
496 struct val_labs_iterator *i;
499 val_labs = var_get_value_labels (v);
500 if (val_labs == NULL)
503 /* Value label record. */
504 write_int (w, 3); /* Record type. */
505 write_int (w, val_labs_count (val_labs));
506 for (vl = val_labs_first_sorted (val_labs, &i); vl != NULL;
507 vl = val_labs_next (val_labs, &i))
509 uint8_t len = MIN (strlen (vl->label), 255);
511 write_value (w, &vl->value, var_get_width (v));
512 write_bytes (w, &len, 1);
513 write_bytes (w, vl->label, len);
514 write_zeros (w, REM_RND_UP (len + 1, 8));
517 /* Value label variable record. */
518 write_int (w, 4); /* Record type. */
519 write_int (w, 1); /* Number of variables. */
520 write_int (w, idx + 1); /* Variable's dictionary index. */
523 /* Writes record type 6, document record. */
525 write_documents (struct sfm_writer *w, const struct dictionary *d)
527 size_t line_cnt = dict_get_document_line_cnt (d);
529 write_int (w, 6); /* Record type. */
530 write_int (w, line_cnt);
531 write_bytes (w, dict_get_documents (d), line_cnt * DOC_LINE_LENGTH);
535 put_attrset (struct string *string, const struct attrset *attrs)
537 const struct attribute *attr;
538 struct attrset_iterator i;
540 for (attr = attrset_first (attrs, &i); attr != NULL;
541 attr = attrset_next (attrs, &i))
543 size_t n_values = attribute_get_n_values (attr);
546 ds_put_cstr (string, attribute_get_name (attr));
547 ds_put_char (string, '(');
548 for (j = 0; j < n_values; j++)
549 ds_put_format (string, "'%s'\n", attribute_get_value (attr, j));
550 ds_put_char (string, ')');
555 write_attribute_record (struct sfm_writer *w, const struct string *content,
559 write_int (w, subtype);
561 write_int (w, ds_length (content));
562 write_bytes (w, ds_data (content), ds_length (content));
566 write_data_file_attributes (struct sfm_writer *w,
567 const struct dictionary *d)
569 struct string s = DS_EMPTY_INITIALIZER;
570 put_attrset (&s, dict_get_attributes (d));
571 write_attribute_record (w, &s, 17);
576 write_variable_attributes (struct sfm_writer *w, const struct dictionary *d)
578 struct string s = DS_EMPTY_INITIALIZER;
579 size_t n_vars = dict_get_var_cnt (d);
580 size_t n_attrsets = 0;
583 for (i = 0; i < n_vars; i++)
585 struct variable *v = dict_get_var (d, i);
586 struct attrset *attrs = var_get_attributes (v);
587 if (attrset_count (attrs))
590 ds_put_char (&s, '/');
591 ds_put_format (&s, "%s:", var_get_short_name (v, 0));
592 put_attrset (&s, attrs);
596 write_attribute_record (w, &s, 18);
600 /* Write the alignment, width and scale values. */
602 write_variable_display_parameters (struct sfm_writer *w,
603 const struct dictionary *dict)
607 write_int (w, 7); /* Record type. */
608 write_int (w, 11); /* Record subtype. */
609 write_int (w, 4); /* Data item (int32) size. */
610 write_int (w, w->segment_cnt * 3); /* Number of data items. */
612 for (i = 0; i < dict_get_var_cnt (dict); ++i)
614 struct variable *v = dict_get_var (dict, i);
615 int width = var_get_width (v);
616 int segment_cnt = sfm_width_to_segments (width);
617 int measure = (var_get_measure (v) == MEASURE_NOMINAL ? 1
618 : var_get_measure (v) == MEASURE_ORDINAL ? 2
620 int alignment = (var_get_alignment (v) == ALIGN_LEFT ? 0
621 : var_get_alignment (v) == ALIGN_RIGHT ? 1
625 for (i = 0; i < segment_cnt; i++)
627 int width_left = width - sfm_segment_effective_offset (width, i);
628 write_int (w, measure);
629 write_int (w, (i == 0 ? var_get_display_width (v)
630 : var_default_display_width (width_left)));
631 write_int (w, alignment);
636 /* Writes the table of lengths for very long string variables. */
638 write_vls_length_table (struct sfm_writer *w,
639 const struct dictionary *dict)
644 ds_init_empty (&map);
645 for (i = 0; i < dict_get_var_cnt (dict); ++i)
647 const struct variable *v = dict_get_var (dict, i);
648 if (sfm_width_to_segments (var_get_width (v)) > 1)
649 ds_put_format (&map, "%s=%05d%c\t",
650 var_get_short_name (v, 0), var_get_width (v), 0);
652 if (!ds_is_empty (&map))
654 write_int (w, 7); /* Record type. */
655 write_int (w, 14); /* Record subtype. */
656 write_int (w, 1); /* Data item (char) size. */
657 write_int (w, ds_length (&map)); /* Number of data items. */
658 write_bytes (w, ds_data (&map), ds_length (&map));
663 /* Writes the long variable name table. */
665 write_longvar_table (struct sfm_writer *w, const struct dictionary *dict)
670 ds_init_empty (&map);
671 for (i = 0; i < dict_get_var_cnt (dict); i++)
673 struct variable *v = dict_get_var (dict, i);
676 ds_put_char (&map, '\t');
677 ds_put_format (&map, "%s=%s",
678 var_get_short_name (v, 0), var_get_name (v));
681 write_int (w, 7); /* Record type. */
682 write_int (w, 13); /* Record subtype. */
683 write_int (w, 1); /* Data item (char) size. */
684 write_int (w, ds_length (&map)); /* Number of data items. */
685 write_bytes (w, ds_data (&map), ds_length (&map));
690 /* Write integer information record. */
692 write_integer_info_record (struct sfm_writer *w)
694 int version_component[3];
697 /* Parse the version string. */
698 memset (version_component, 0, sizeof version_component);
699 sscanf (bare_version, "%d.%d.%d",
700 &version_component[0], &version_component[1], &version_component[2]);
702 /* Figure out the floating-point format. */
703 if (FLOAT_NATIVE_64_BIT == FLOAT_IEEE_DOUBLE_LE
704 || FLOAT_NATIVE_64_BIT == FLOAT_IEEE_DOUBLE_BE)
706 else if (FLOAT_NATIVE_64_BIT == FLOAT_Z_LONG)
708 else if (FLOAT_NATIVE_64_BIT == FLOAT_VAX_D)
714 write_int (w, 7); /* Record type. */
715 write_int (w, 3); /* Record subtype. */
716 write_int (w, 4); /* Data item (int32) size. */
717 write_int (w, 8); /* Number of data items. */
718 write_int (w, version_component[0]);
719 write_int (w, version_component[1]);
720 write_int (w, version_component[2]);
721 write_int (w, -1); /* Machine code. */
722 write_int (w, float_format);
723 write_int (w, 1); /* Compression code. */
724 write_int (w, INTEGER_NATIVE == INTEGER_MSB_FIRST ? 1 : 2);
725 write_int (w, 2); /* 7-bit ASCII. */
728 /* Write floating-point information record. */
730 write_float_info_record (struct sfm_writer *w)
732 write_int (w, 7); /* Record type. */
733 write_int (w, 4); /* Record subtype. */
734 write_int (w, 8); /* Data item (flt64) size. */
735 write_int (w, 3); /* Number of data items. */
736 write_float (w, SYSMIS); /* System-missing value. */
737 write_float (w, HIGHEST); /* Value used for HIGHEST in missing values. */
738 write_float (w, LOWEST); /* Value used for LOWEST in missing values. */
741 /* Writes case C to system file W. */
743 sys_file_casewriter_write (struct casewriter *writer, void *w_,
746 struct sfm_writer *w = w_;
748 if (ferror (w->file))
750 casewriter_force_error (writer);
758 write_case_uncompressed (w, c);
760 write_case_compressed (w, c);
765 /* Destroys system file writer W. */
767 sys_file_casewriter_destroy (struct casewriter *writer, void *w_)
769 struct sfm_writer *w = w_;
770 if (!close_writer (w))
771 casewriter_force_error (writer);
774 /* Returns true if an I/O error has occurred on WRITER, false otherwise. */
776 write_error (const struct sfm_writer *writer)
778 return ferror (writer->file);
781 /* Closes a system file after we're done with it.
782 Returns true if successful, false if an I/O error occurred. */
784 close_writer (struct sfm_writer *w)
795 if (w->opcode_cnt > 0)
796 flush_compressed (w);
799 ok = !write_error (w);
801 /* Seek back to the beginning and update the number of cases.
802 This is just a courtesy to later readers, so there's no need
803 to check return values or report errors. */
804 if (ok && w->case_cnt <= INT32_MAX && !fseek (w->file, 80, SEEK_SET))
806 write_int (w, w->case_cnt);
810 if (fclose (w->file) == EOF)
814 msg (ME, _("An I/O error occurred writing system file \"%s\"."),
815 fh_get_file_name (w->fh));
817 if (ok ? !replace_file_commit (w->rf) : !replace_file_abort (w->rf))
830 /* System file writer casewriter class. */
831 static const struct casewriter_class sys_file_casewriter_class =
833 sys_file_casewriter_write,
834 sys_file_casewriter_destroy,
838 /* Writes case C to system file W, without compressing it. */
840 write_case_uncompressed (struct sfm_writer *w, const struct ccase *c)
844 for (i = 0; i < w->sfm_var_cnt; i++)
846 struct sfm_var *v = &w->sfm_vars[i];
849 write_float (w, case_num_idx (c, v->case_index));
852 write_bytes (w, case_str_idx (c, v->case_index) + v->offset,
854 write_spaces (w, v->padding);
859 /* Writes case C to system file W, with compression. */
861 write_case_compressed (struct sfm_writer *w, const struct ccase *c)
865 for (i = 0; i < w->sfm_var_cnt; i++)
867 struct sfm_var *v = &w->sfm_vars[i];
871 double d = case_num_idx (c, v->case_index);
873 put_cmp_opcode (w, 255);
874 else if (d >= 1 - COMPRESSION_BIAS
875 && d <= 251 - COMPRESSION_BIAS
877 put_cmp_opcode (w, (int) d + COMPRESSION_BIAS);
880 put_cmp_opcode (w, 253);
881 put_cmp_number (w, d);
886 int offset = v->offset;
889 /* This code properly deals with a width that is not a
890 multiple of 8, by ensuring that the final partial
891 oct (8 byte unit) is treated as padded with spaces
893 for (width = v->width; width > 0; width -= 8, offset += 8)
895 const void *data = case_str_idx (c, v->case_index) + offset;
896 int chunk_size = MIN (width, 8);
897 if (!memcmp (data, " ", chunk_size))
898 put_cmp_opcode (w, 254);
901 put_cmp_opcode (w, 253);
902 put_cmp_string (w, data, chunk_size);
906 /* This code deals properly with padding that is not a
907 multiple of 8 bytes, by discarding the remainder,
908 which was already effectively padded with spaces in
909 the previous loop. (Note that v->width + v->padding
910 is always a multiple of 8.) */
911 for (padding = v->padding / 8; padding > 0; padding--)
912 put_cmp_opcode (w, 254);
917 /* Flushes buffered compressed opcodes and data to W.
918 The compression buffer must not be empty. */
920 flush_compressed (struct sfm_writer *w)
922 assert (w->opcode_cnt > 0 && w->opcode_cnt <= 8);
924 write_bytes (w, w->opcodes, w->opcode_cnt);
925 write_zeros (w, 8 - w->opcode_cnt);
927 write_bytes (w, w->data, w->data_cnt * sizeof *w->data);
929 w->opcode_cnt = w->data_cnt = 0;
932 /* Appends OPCODE to the buffered set of compression opcodes in
933 W. Flushes the compression buffer beforehand if necessary. */
935 put_cmp_opcode (struct sfm_writer *w, uint8_t opcode)
937 if (w->opcode_cnt >= 8)
938 flush_compressed (w);
940 w->opcodes[w->opcode_cnt++] = opcode;
943 /* Appends NUMBER to the buffered compression data in W. The
944 buffer must not be full; the way to assure that is to call
945 this function only just after a call to put_cmp_opcode, which
946 will flush the buffer as necessary. */
948 put_cmp_number (struct sfm_writer *w, double number)
950 assert (w->opcode_cnt > 0);
951 assert (w->data_cnt < 8);
953 convert_double_to_output_format (number, w->data[w->data_cnt++]);
956 /* Appends SIZE bytes of DATA to the buffered compression data in
957 W, followed by enough spaces to pad the output data to exactly
958 8 bytes (thus, SIZE must be no greater than 8). The buffer
959 must not be full; the way to assure that is to call this
960 function only just after a call to put_cmp_opcode, which will
961 flush the buffer as necessary. */
963 put_cmp_string (struct sfm_writer *w, const void *data, size_t size)
965 assert (w->opcode_cnt > 0);
966 assert (w->data_cnt < 8);
969 memset (w->data[w->data_cnt], ' ', 8);
970 memcpy (w->data[w->data_cnt], data, size);
974 /* Writes 32-bit integer X to the output file for writer W. */
976 write_int (struct sfm_writer *w, int32_t x)
978 write_bytes (w, &x, sizeof x);
981 /* Converts NATIVE to the 64-bit format used in output files in
984 convert_double_to_output_format (double native, uint8_t output[8])
986 /* If "double" is not a 64-bit type, then convert it to a
987 64-bit type. Otherwise just copy it. */
988 if (FLOAT_NATIVE_DOUBLE != FLOAT_NATIVE_64_BIT)
989 float_convert (FLOAT_NATIVE_DOUBLE, &native, FLOAT_NATIVE_64_BIT, output);
991 memcpy (output, &native, sizeof native);
994 /* Writes floating-point number X to the output file for writer
997 write_float (struct sfm_writer *w, double x)
1000 convert_double_to_output_format (x, output);
1001 write_bytes (w, output, sizeof output);
1004 /* Writes contents of VALUE with the given WIDTH to W, padding
1005 with zeros to a multiple of 8 bytes.
1006 To avoid a branch, and because we don't actually need to
1007 support it, WIDTH must be no bigger than 8. */
1009 write_value (struct sfm_writer *w, const union value *value, int width)
1011 assert (width <= 8);
1013 write_float (w, value->f);
1016 write_bytes (w, value->s, width);
1017 write_zeros (w, 8 - width);
1021 /* Writes null-terminated STRING in a field of the given WIDTH to
1022 W. If WIDTH is longer than WIDTH, it is truncated; if WIDTH
1023 is narrowed, it is padded on the right with spaces. */
1025 write_string (struct sfm_writer *w, const char *string, size_t width)
1027 size_t data_bytes = MIN (strlen (string), width);
1028 size_t pad_bytes = width - data_bytes;
1029 write_bytes (w, string, data_bytes);
1030 while (pad_bytes-- > 0)
1031 putc (' ', w->file);
1034 /* Writes SIZE bytes of DATA to W's output file. */
1036 write_bytes (struct sfm_writer *w, const void *data, size_t size)
1038 fwrite (data, 1, size, w->file);
1041 /* Writes N zeros to W's output file. */
1043 write_zeros (struct sfm_writer *w, size_t n)
1049 /* Writes N spaces to W's output file. */
1051 write_spaces (struct sfm_writer *w, size_t n)
1054 putc (' ', w->file);