1 /* Generic implementation of the UNPACK intrinsic
2 Copyright 2002, 2003, 2004, 2005, 2007, 2009 Free Software Foundation, Inc.
3 Contributed by Paul Brook <paul@nowt.org>
5 This file is part of the GNU Fortran 95 runtime library (libgfortran).
7 Libgfortran is free software; you can redistribute it and/or
8 modify it under the terms of the GNU General Public
9 License as published by the Free Software Foundation; either
10 version 3 of the License, or (at your option) any later version.
12 Ligbfortran is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 Under Section 7 of GPL version 3, you are granted additional
18 permissions described in the GCC Runtime Library Exception, version
19 3.1, as published by the Free Software Foundation.
21 You should have received a copy of the GNU General Public License and
22 a copy of the GCC Runtime Library Exception along with this program;
23 see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 <http://www.gnu.org/licenses/>. */
26 #include "libgfortran.h"
31 /* All the bounds checking for unpack in one function. If field is NULL,
32 we don't check it, for the unpack0 functions. */
35 unpack_bounds (gfc_array_char
*ret
, const gfc_array_char
*vector
,
36 const gfc_array_l1
*mask
, const gfc_array_char
*field
)
38 index_type vec_size
, mask_count
;
39 vec_size
= size0 ((array_t
*) vector
);
40 mask_count
= count_0 (mask
);
41 if (vec_size
< mask_count
)
42 runtime_error ("Incorrect size of return value in UNPACK"
43 " intrinsic: should be at least %ld, is"
44 " %ld", (long int) mask_count
,
48 bounds_equal_extents ((array_t
*) field
, (array_t
*) mask
,
51 if (ret
->data
!= NULL
)
52 bounds_equal_extents ((array_t
*) ret
, (array_t
*) mask
,
53 "return value", "UNPACK");
58 unpack_internal (gfc_array_char
*ret
, const gfc_array_char
*vector
,
59 const gfc_array_l1
*mask
, const gfc_array_char
*field
,
62 /* r.* indicates the return array. */
63 index_type rstride
[GFC_MAX_DIMENSIONS
];
67 /* v.* indicates the vector array. */
70 /* f.* indicates the field array. */
71 index_type fstride
[GFC_MAX_DIMENSIONS
];
74 /* m.* indicates the mask array. */
75 index_type mstride
[GFC_MAX_DIMENSIONS
];
77 const GFC_LOGICAL_1
*mptr
;
79 index_type count
[GFC_MAX_DIMENSIONS
];
80 index_type extent
[GFC_MAX_DIMENSIONS
];
91 /* Use the same loop for all logical types, by using GFC_LOGICAL_1
92 and using shifting to address size and endian issues. */
94 mask_kind
= GFC_DESCRIPTOR_SIZE (mask
);
96 if (mask_kind
== 1 || mask_kind
== 2 || mask_kind
== 4 || mask_kind
== 8
97 #ifdef HAVE_GFC_LOGICAL_16
102 /* Don't convert a NULL pointer as we use test for NULL below. */
104 mptr
= GFOR_POINTER_TO_L1 (mptr
, mask_kind
);
107 runtime_error ("Funny sized logical array");
109 if (ret
->data
== NULL
)
111 /* The front end has signalled that we need to populate the
112 return array descriptor. */
113 dim
= GFC_DESCRIPTOR_RANK (mask
);
115 for (n
= 0; n
< dim
; n
++)
118 GFC_DIMENSION_SET(ret
->dim
[n
], 0,
119 GFC_DESCRIPTOR_EXTENT(mask
,n
) - 1, rs
);
120 extent
[n
] = GFC_DESCRIPTOR_EXTENT(ret
,n
);
121 empty
= empty
|| extent
[n
] <= 0;
122 rstride
[n
] = GFC_DESCRIPTOR_STRIDE_BYTES(ret
, n
);
123 fstride
[n
] = GFC_DESCRIPTOR_STRIDE_BYTES(field
, n
);
124 mstride
[n
] = GFC_DESCRIPTOR_STRIDE_BYTES(mask
, n
);
128 ret
->data
= internal_malloc_size (rs
* size
);
132 dim
= GFC_DESCRIPTOR_RANK (ret
);
133 for (n
= 0; n
< dim
; n
++)
136 extent
[n
] = GFC_DESCRIPTOR_EXTENT(ret
,n
);
137 empty
= empty
|| extent
[n
] <= 0;
138 rstride
[n
] = GFC_DESCRIPTOR_STRIDE_BYTES(ret
, n
);
139 fstride
[n
] = GFC_DESCRIPTOR_STRIDE_BYTES(field
, n
);
140 mstride
[n
] = GFC_DESCRIPTOR_STRIDE_BYTES(mask
, n
);
147 vstride0
= GFC_DESCRIPTOR_STRIDE_BYTES(vector
,0);
148 rstride0
= rstride
[0];
149 fstride0
= fstride
[0];
150 mstride0
= mstride
[0];
160 memcpy (rptr
, vptr
, size
);
166 memcpy (rptr
, fptr
, size
);
168 /* Advance to the next element. */
174 while (count
[n
] == extent
[n
])
176 /* When we get to the end of a dimension, reset it and increment
177 the next dimension. */
179 /* We could precalculate these products, but this is a less
180 frequently used path so probably not worth it. */
181 rptr
-= rstride
[n
] * extent
[n
];
182 fptr
-= fstride
[n
] * extent
[n
];
183 mptr
-= mstride
[n
] * extent
[n
];
187 /* Break out of the loop. */
202 extern void unpack1 (gfc_array_char
*, const gfc_array_char
*,
203 const gfc_array_l1
*, const gfc_array_char
*);
204 export_proto(unpack1
);
207 unpack1 (gfc_array_char
*ret
, const gfc_array_char
*vector
,
208 const gfc_array_l1
*mask
, const gfc_array_char
*field
)
210 index_type type_size
;
213 if (unlikely(compile_options
.bounds_check
))
214 unpack_bounds (ret
, vector
, mask
, field
);
216 type_size
= GFC_DTYPE_TYPE_SIZE (vector
);
217 size
= GFC_DESCRIPTOR_SIZE (vector
);
221 case GFC_DTYPE_LOGICAL_1
:
222 case GFC_DTYPE_INTEGER_1
:
223 case GFC_DTYPE_DERIVED_1
:
224 unpack1_i1 ((gfc_array_i1
*) ret
, (gfc_array_i1
*) vector
,
225 mask
, (gfc_array_i1
*) field
);
228 case GFC_DTYPE_LOGICAL_2
:
229 case GFC_DTYPE_INTEGER_2
:
230 unpack1_i2 ((gfc_array_i2
*) ret
, (gfc_array_i2
*) vector
,
231 mask
, (gfc_array_i2
*) field
);
234 case GFC_DTYPE_LOGICAL_4
:
235 case GFC_DTYPE_INTEGER_4
:
236 unpack1_i4 ((gfc_array_i4
*) ret
, (gfc_array_i4
*) vector
,
237 mask
, (gfc_array_i4
*) field
);
240 case GFC_DTYPE_LOGICAL_8
:
241 case GFC_DTYPE_INTEGER_8
:
242 unpack1_i8 ((gfc_array_i8
*) ret
, (gfc_array_i8
*) vector
,
243 mask
, (gfc_array_i8
*) field
);
246 #ifdef HAVE_GFC_INTEGER_16
247 case GFC_DTYPE_LOGICAL_16
:
248 case GFC_DTYPE_INTEGER_16
:
249 unpack1_i16 ((gfc_array_i16
*) ret
, (gfc_array_i16
*) vector
,
250 mask
, (gfc_array_i16
*) field
);
253 case GFC_DTYPE_REAL_4
:
254 unpack1_r4 ((gfc_array_r4
*) ret
, (gfc_array_r4
*) vector
,
255 mask
, (gfc_array_r4
*) field
);
258 case GFC_DTYPE_REAL_8
:
259 unpack1_r8 ((gfc_array_r8
*) ret
, (gfc_array_r8
*) vector
,
260 mask
, (gfc_array_r8
*) field
);
263 #ifdef HAVE_GFC_REAL_10
264 case GFC_DTYPE_REAL_10
:
265 unpack1_r10 ((gfc_array_r10
*) ret
, (gfc_array_r10
*) vector
,
266 mask
, (gfc_array_r10
*) field
);
270 #ifdef HAVE_GFC_REAL_16
271 case GFC_DTYPE_REAL_16
:
272 unpack1_r16 ((gfc_array_r16
*) ret
, (gfc_array_r16
*) vector
,
273 mask
, (gfc_array_r16
*) field
);
277 case GFC_DTYPE_COMPLEX_4
:
278 unpack1_c4 ((gfc_array_c4
*) ret
, (gfc_array_c4
*) vector
,
279 mask
, (gfc_array_c4
*) field
);
282 case GFC_DTYPE_COMPLEX_8
:
283 unpack1_c8 ((gfc_array_c8
*) ret
, (gfc_array_c8
*) vector
,
284 mask
, (gfc_array_c8
*) field
);
287 #ifdef HAVE_GFC_COMPLEX_10
288 case GFC_DTYPE_COMPLEX_10
:
289 unpack1_c10 ((gfc_array_c10
*) ret
, (gfc_array_c10
*) vector
,
290 mask
, (gfc_array_c10
*) field
);
294 #ifdef HAVE_GFC_COMPLEX_16
295 case GFC_DTYPE_COMPLEX_16
:
296 unpack1_c16 ((gfc_array_c16
*) ret
, (gfc_array_c16
*) vector
,
297 mask
, (gfc_array_c16
*) field
);
301 case GFC_DTYPE_DERIVED_2
:
302 if (GFC_UNALIGNED_2(ret
->data
) || GFC_UNALIGNED_2(vector
->data
)
303 || GFC_UNALIGNED_2(field
->data
))
307 unpack1_i2 ((gfc_array_i2
*) ret
, (gfc_array_i2
*) vector
,
308 mask
, (gfc_array_i2
*) field
);
312 case GFC_DTYPE_DERIVED_4
:
313 if (GFC_UNALIGNED_4(ret
->data
) || GFC_UNALIGNED_4(vector
->data
)
314 || GFC_UNALIGNED_4(field
->data
))
318 unpack1_i4 ((gfc_array_i4
*) ret
, (gfc_array_i4
*) vector
,
319 mask
, (gfc_array_i4
*) field
);
323 case GFC_DTYPE_DERIVED_8
:
324 if (GFC_UNALIGNED_8(ret
->data
) || GFC_UNALIGNED_8(vector
->data
)
325 || GFC_UNALIGNED_8(field
->data
))
329 unpack1_i8 ((gfc_array_i8
*) ret
, (gfc_array_i8
*) vector
,
330 mask
, (gfc_array_i8
*) field
);
334 #ifdef HAVE_GFC_INTEGER_16
335 case GFC_DTYPE_DERIVED_16
:
336 if (GFC_UNALIGNED_16(ret
->data
) || GFC_UNALIGNED_16(vector
->data
)
337 || GFC_UNALIGNED_16(field
->data
))
341 unpack1_i16 ((gfc_array_i16
*) ret
, (gfc_array_i16
*) vector
,
342 mask
, (gfc_array_i16
*) field
);
348 unpack_internal (ret
, vector
, mask
, field
, size
);
352 extern void unpack1_char (gfc_array_char
*, GFC_INTEGER_4
,
353 const gfc_array_char
*, const gfc_array_l1
*,
354 const gfc_array_char
*, GFC_INTEGER_4
,
356 export_proto(unpack1_char
);
359 unpack1_char (gfc_array_char
*ret
,
360 GFC_INTEGER_4 ret_length
__attribute__((unused
)),
361 const gfc_array_char
*vector
, const gfc_array_l1
*mask
,
362 const gfc_array_char
*field
, GFC_INTEGER_4 vector_length
,
363 GFC_INTEGER_4 field_length
__attribute__((unused
)))
366 if (unlikely(compile_options
.bounds_check
))
367 unpack_bounds (ret
, vector
, mask
, field
);
369 unpack_internal (ret
, vector
, mask
, field
, vector_length
);
373 extern void unpack1_char4 (gfc_array_char
*, GFC_INTEGER_4
,
374 const gfc_array_char
*, const gfc_array_l1
*,
375 const gfc_array_char
*, GFC_INTEGER_4
,
377 export_proto(unpack1_char4
);
380 unpack1_char4 (gfc_array_char
*ret
,
381 GFC_INTEGER_4 ret_length
__attribute__((unused
)),
382 const gfc_array_char
*vector
, const gfc_array_l1
*mask
,
383 const gfc_array_char
*field
, GFC_INTEGER_4 vector_length
,
384 GFC_INTEGER_4 field_length
__attribute__((unused
)))
387 if (unlikely(compile_options
.bounds_check
))
388 unpack_bounds (ret
, vector
, mask
, field
);
390 unpack_internal (ret
, vector
, mask
, field
,
391 vector_length
* sizeof (gfc_char4_t
));
395 extern void unpack0 (gfc_array_char
*, const gfc_array_char
*,
396 const gfc_array_l1
*, char *);
397 export_proto(unpack0
);
400 unpack0 (gfc_array_char
*ret
, const gfc_array_char
*vector
,
401 const gfc_array_l1
*mask
, char *field
)
405 index_type type_size
;
407 if (unlikely(compile_options
.bounds_check
))
408 unpack_bounds (ret
, vector
, mask
, NULL
);
410 type_size
= GFC_DTYPE_TYPE_SIZE (vector
);
414 case GFC_DTYPE_LOGICAL_1
:
415 case GFC_DTYPE_INTEGER_1
:
416 case GFC_DTYPE_DERIVED_1
:
417 unpack0_i1 ((gfc_array_i1
*) ret
, (gfc_array_i1
*) vector
,
418 mask
, (GFC_INTEGER_1
*) field
);
421 case GFC_DTYPE_LOGICAL_2
:
422 case GFC_DTYPE_INTEGER_2
:
423 unpack0_i2 ((gfc_array_i2
*) ret
, (gfc_array_i2
*) vector
,
424 mask
, (GFC_INTEGER_2
*) field
);
427 case GFC_DTYPE_LOGICAL_4
:
428 case GFC_DTYPE_INTEGER_4
:
429 unpack0_i4 ((gfc_array_i4
*) ret
, (gfc_array_i4
*) vector
,
430 mask
, (GFC_INTEGER_4
*) field
);
433 case GFC_DTYPE_LOGICAL_8
:
434 case GFC_DTYPE_INTEGER_8
:
435 unpack0_i8 ((gfc_array_i8
*) ret
, (gfc_array_i8
*) vector
,
436 mask
, (GFC_INTEGER_8
*) field
);
439 #ifdef HAVE_GFC_INTEGER_16
440 case GFC_DTYPE_LOGICAL_16
:
441 case GFC_DTYPE_INTEGER_16
:
442 unpack0_i16 ((gfc_array_i16
*) ret
, (gfc_array_i16
*) vector
,
443 mask
, (GFC_INTEGER_16
*) field
);
446 case GFC_DTYPE_REAL_4
:
447 unpack0_r4 ((gfc_array_r4
*) ret
, (gfc_array_r4
*) vector
,
448 mask
, (GFC_REAL_4
*) field
);
451 case GFC_DTYPE_REAL_8
:
452 unpack0_r8 ((gfc_array_r8
*) ret
, (gfc_array_r8
*) vector
,
453 mask
, (GFC_REAL_8
*) field
);
456 #ifdef HAVE_GFC_REAL_10
457 case GFC_DTYPE_REAL_10
:
458 unpack0_r10 ((gfc_array_r10
*) ret
, (gfc_array_r10
*) vector
,
459 mask
, (GFC_REAL_10
*) field
);
463 #ifdef HAVE_GFC_REAL_16
464 case GFC_DTYPE_REAL_16
:
465 unpack0_r16 ((gfc_array_r16
*) ret
, (gfc_array_r16
*) vector
,
466 mask
, (GFC_REAL_16
*) field
);
470 case GFC_DTYPE_COMPLEX_4
:
471 unpack0_c4 ((gfc_array_c4
*) ret
, (gfc_array_c4
*) vector
,
472 mask
, (GFC_COMPLEX_4
*) field
);
475 case GFC_DTYPE_COMPLEX_8
:
476 unpack0_c8 ((gfc_array_c8
*) ret
, (gfc_array_c8
*) vector
,
477 mask
, (GFC_COMPLEX_8
*) field
);
480 #ifdef HAVE_GFC_COMPLEX_10
481 case GFC_DTYPE_COMPLEX_10
:
482 unpack0_c10 ((gfc_array_c10
*) ret
, (gfc_array_c10
*) vector
,
483 mask
, (GFC_COMPLEX_10
*) field
);
487 #ifdef HAVE_GFC_COMPLEX_16
488 case GFC_DTYPE_COMPLEX_16
:
489 unpack0_c16 ((gfc_array_c16
*) ret
, (gfc_array_c16
*) vector
,
490 mask
, (GFC_COMPLEX_16
*) field
);
493 case GFC_DTYPE_DERIVED_2
:
494 if (GFC_UNALIGNED_2(ret
->data
) || GFC_UNALIGNED_2(vector
->data
)
495 || GFC_UNALIGNED_2(field
))
499 unpack0_i2 ((gfc_array_i2
*) ret
, (gfc_array_i2
*) vector
,
500 mask
, (GFC_INTEGER_2
*) field
);
504 case GFC_DTYPE_DERIVED_4
:
505 if (GFC_UNALIGNED_4(ret
->data
) || GFC_UNALIGNED_4(vector
->data
)
506 || GFC_UNALIGNED_4(field
))
510 unpack0_i4 ((gfc_array_i4
*) ret
, (gfc_array_i4
*) vector
,
511 mask
, (GFC_INTEGER_4
*) field
);
515 case GFC_DTYPE_DERIVED_8
:
516 if (GFC_UNALIGNED_8(ret
->data
) || GFC_UNALIGNED_8(vector
->data
)
517 || GFC_UNALIGNED_8(field
))
521 unpack0_i8 ((gfc_array_i8
*) ret
, (gfc_array_i8
*) vector
,
522 mask
, (GFC_INTEGER_8
*) field
);
525 #ifdef HAVE_GFC_INTEGER_16
526 case GFC_DTYPE_DERIVED_16
:
527 if (GFC_UNALIGNED_16(ret
->data
) || GFC_UNALIGNED_16(vector
->data
)
528 || GFC_UNALIGNED_16(field
))
532 unpack0_i16 ((gfc_array_i16
*) ret
, (gfc_array_i16
*) vector
,
533 mask
, (GFC_INTEGER_16
*) field
);
539 memset (&tmp
, 0, sizeof (tmp
));
542 unpack_internal (ret
, vector
, mask
, &tmp
, GFC_DESCRIPTOR_SIZE (vector
));
546 extern void unpack0_char (gfc_array_char
*, GFC_INTEGER_4
,
547 const gfc_array_char
*, const gfc_array_l1
*,
548 char *, GFC_INTEGER_4
, GFC_INTEGER_4
);
549 export_proto(unpack0_char
);
552 unpack0_char (gfc_array_char
*ret
,
553 GFC_INTEGER_4 ret_length
__attribute__((unused
)),
554 const gfc_array_char
*vector
, const gfc_array_l1
*mask
,
555 char *field
, GFC_INTEGER_4 vector_length
,
556 GFC_INTEGER_4 field_length
__attribute__((unused
)))
560 if (unlikely(compile_options
.bounds_check
))
561 unpack_bounds (ret
, vector
, mask
, NULL
);
563 memset (&tmp
, 0, sizeof (tmp
));
566 unpack_internal (ret
, vector
, mask
, &tmp
, vector_length
);
570 extern void unpack0_char4 (gfc_array_char
*, GFC_INTEGER_4
,
571 const gfc_array_char
*, const gfc_array_l1
*,
572 char *, GFC_INTEGER_4
, GFC_INTEGER_4
);
573 export_proto(unpack0_char4
);
576 unpack0_char4 (gfc_array_char
*ret
,
577 GFC_INTEGER_4 ret_length
__attribute__((unused
)),
578 const gfc_array_char
*vector
, const gfc_array_l1
*mask
,
579 char *field
, GFC_INTEGER_4 vector_length
,
580 GFC_INTEGER_4 field_length
__attribute__((unused
)))
584 if (unlikely(compile_options
.bounds_check
))
585 unpack_bounds (ret
, vector
, mask
, NULL
);
587 memset (&tmp
, 0, sizeof (tmp
));
590 unpack_internal (ret
, vector
, mask
, &tmp
,
591 vector_length
* sizeof (gfc_char4_t
));