summaryrefslogtreecommitdiff
blob: 81dfa9913e1f9d2f1b12eef194736aaa1a1fec17 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <stdint.h> /* defines SIZE_MAX */

#include "../core/index.h"

#include "../error/error.h"

#include "sequence.h"

/******************************************************************************/
/** MEMORY (RE)ALLOCATION *****************************************************/
/******************************************************************************/

/*@
   requires \valid(required_capacity);
   requires \valid(io);
   requires
      \separated
      (
         (required_capacity+ (0 .. \block_length(required_capacity))),
         (io+ (0 .. \block_length(io)))
      );

   assigns \result;
   assigns (*required_capacity);

   ensures ((\result == 0) || (\result == -1));

   ensures \valid(required_capacity);
   ensures \valid(io);

   ensures
      \separated
      (
         (required_capacity+ (0 .. \block_length(required_capacity))),
         (io+ (0 .. \block_length(io)))
      );

   ensures
      (
         (\result == 0) <==>
               ((*required_capacity) == (\old(*required_capacity) + 1))
      );

   ensures
      (
         (\result == 0) ==>
            ((*required_capacity) * sizeof(ZoO_index)) <= SIZE_MAX
      );

   ensures
      (
         (\result == -1) <==>
            ((*required_capacity) == \old(*required_capacity))
      );

@*/
static int increment_required_capacity
(
   size_t required_capacity [const restrict static 1],
   FILE io [const restrict static 1]
)
{
   if
   (
      (*required_capacity == SIZE_MAX)
      || ((SIZE_MAX / sizeof(ZoO_index)) <= (*required_capacity + 1))
   )
   {
      /*@ assert \valid(io); @*/

      #ifndef ZoO_RUNNING_FRAMA_C
      ZoO_S_ERROR
      (
         io,
         "Sequence capacity increment aborted, as the new size would not fit"
         " in a size_t variable."
      );
      #endif

      return -1;
   }

   /*@ assert ((*required_capacity) < SIZE_MAX); @*/
   /*@ assert \valid(required_capacity); @*/
   *required_capacity = (*required_capacity + 1);

   /* assert (((*required_capacity) * sizeof(ZoO_index)) <= SIZE_MAX); @*/

   return 0;
}

/******************************************************************************/
/** EXPORTED ******************************************************************/
/******************************************************************************/

int ZoO_sequence_ensure_capacity
(
   ZoO_index * sequence [const restrict static 1],
   size_t sequence_capacity [const restrict static 1],
   const size_t sequence_required_capacity,
   FILE io [const restrict static 1]
)
{
   ZoO_index * new_sequence;

   /*@ assert \valid(sequence_capacity); @*/
   if (sequence_required_capacity <= *sequence_capacity)
   {
      return 0;
   }

   /*@
      assert
      (
         sequence_required_capacity
         <= (SIZE_MAX / sizeof(ZoO_index))
      );
   @*/
   /*@ assert \valid(sequence); @*/
   /*@ assert \valid(*sequence); @*/
   new_sequence =
      (ZoO_index *) realloc
      (
         (void *) *sequence,
         (sequence_required_capacity * sizeof(ZoO_index))
      );

   if (new_sequence == (ZoO_index *) NULL)
   {
      /*@ assert \valid(io); @*/

      #ifndef ZoO_RUNNING_FRAMA_C
      ZoO_S_ERROR
      (
         io,
         "Unable to reallocate memory to match sequence's required size."
      );
      #endif

      return -1;
   }

   *sequence_capacity = sequence_required_capacity;
   *sequence = new_sequence;

   return 1;
}

int ZoO_sequence_append_left
(
   const ZoO_index word_id,
   ZoO_index * sequence [const restrict static 1],
   size_t sequence_capacity [const restrict static 1],
   size_t sequence_length [const restrict static 1],
   FILE io [const restrict static 1]
)
{
   if (increment_required_capacity(sequence_length, io) < 0)
   {
      return -1;
   }

   /*@ assert (((*sequence_length) * sizeof(ZoO_index)) <= SIZE_MAX); @*/
   if
   (
      ZoO_sequence_ensure_capacity
      (
         sequence,
         sequence_capacity,
         *sequence_length,
         io
      ) < 0
   )
   {
      *sequence_length -= 1;

      return -1;
   }

   /*@ assert (*sequence_length) >= 0; @*/

   if ((*sequence_length) > 1)
   {
      /*@ assert(((*sequence_length) * sizeof(ZoO_index)) <= SIZE_MAX); @*/

      #ifndef ZoO_RUNNING_FRAMA_C
      memmove
      (
         (void *) ((*sequence) + 1),
         (const void *) (*sequence),
         (((*sequence_length) - 1) * sizeof(ZoO_index))
      );
      #endif
   }

   (*sequence)[0] = word_id;

   return 0;
}

int ZoO_sequence_append_right
(
   ZoO_index * sequence [const restrict static 1],
   const ZoO_index word_id,
   size_t sequence_capacity [const restrict static 1],
   size_t sequence_length [const restrict static 1],
   FILE io [const restrict static 1]
)
{
   if (increment_required_capacity(sequence_length, io) < 0)
   {
      return -1;
   }

   /*@ assert (((*sequence_length) * sizeof(ZoO_index)) <= SIZE_MAX); @*/

   if
   (
      ZoO_sequence_ensure_capacity
      (
         sequence,
         sequence_capacity,
         *sequence_length,
         io
      ) < 0
   )
   {
      *sequence_length -= 1;

      return -1;
   }

   /*@ assert ((*sequence_length) >= 1); @*/
   (*sequence)[(*sequence_length) - 1] = word_id;
   /*@ assert ((*sequence_length) >= 1); @*/

   return 0;
}