1 /* Generic implementation of the PACK intrinsic
2 Copyright (C) 2002-2017 Free Software Foundation, Inc.
3 Contributed by Paul Brook <paul@nowt.org>
5 This file is part of the GNU Fortran 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"
29 /* PACK is specified as follows:
31 13.14.80 PACK (ARRAY, MASK, [VECTOR])
33 Description: Pack an array into an array of rank one under the
36 Class: Transformational function.
39 ARRAY may be of any type. It shall not be scalar.
40 MASK shall be of type LOGICAL. It shall be conformable with ARRAY.
41 VECTOR (optional) shall be of the same type and type parameters
42 as ARRAY. VECTOR shall have at least as many elements as
43 there are true elements in MASK. If MASK is a scalar
44 with the value true, VECTOR shall have at least as many
45 elements as there are in ARRAY.
47 Result Characteristics: The result is an array of rank one with the
48 same type and type parameters as ARRAY. If VECTOR is present, the
49 result size is that of VECTOR; otherwise, the result size is the
50 number /t/ of true elements in MASK unless MASK is scalar with the
51 value true, in which case the result size is the size of ARRAY.
53 Result Value: Element /i/ of the result is the element of ARRAY
54 that corresponds to the /i/th true element of MASK, taking elements
55 in array element order, for /i/ = 1, 2, ..., /t/. If VECTOR is
56 present and has size /n/ > /t/, element /i/ of the result has the
57 value VECTOR(/i/), for /i/ = /t/ + 1, ..., /n/.
59 Examples: The nonzero elements of an array M with the value
61 | 9 0 0 | may be "gathered" by the function PACK. The result of
63 PACK (M, MASK = M.NE.0) is [9,7] and the result of PACK (M, M.NE.0,
64 VECTOR = (/ 2,4,6,8,10,12 /)) is [9,7,6,8,10,12].
66 There are two variants of the PACK intrinsic: one, where MASK is
67 array valued, and the other one where MASK is scalar. */
70 pack_internal (gfc_array_char
*ret
, const gfc_array_char
*array
,
71 const gfc_array_l1
*mask
, const gfc_array_char
*vector
,
74 /* r.* indicates the return array. */
77 /* s.* indicates the source array. */
78 index_type sstride
[GFC_MAX_DIMENSIONS
];
81 /* m.* indicates the mask array. */
82 index_type mstride
[GFC_MAX_DIMENSIONS
];
84 const GFC_LOGICAL_1
*mptr
;
86 index_type count
[GFC_MAX_DIMENSIONS
];
87 index_type extent
[GFC_MAX_DIMENSIONS
];
94 dim
= GFC_DESCRIPTOR_RANK (array
);
96 sptr
= array
->base_addr
;
97 mptr
= mask
->base_addr
;
99 /* Use the same loop for all logical types, by using GFC_LOGICAL_1
100 and using shifting to address size and endian issues. */
102 mask_kind
= GFC_DESCRIPTOR_SIZE (mask
);
104 if (mask_kind
== 1 || mask_kind
== 2 || mask_kind
== 4 || mask_kind
== 8
105 #ifdef HAVE_GFC_LOGICAL_16
110 /* Don't convert a NULL pointer as we use test for NULL below. */
112 mptr
= GFOR_POINTER_TO_L1 (mptr
, mask_kind
);
115 runtime_error ("Funny sized logical array");
117 for (n
= 0; n
< dim
; n
++)
120 extent
[n
] = GFC_DESCRIPTOR_EXTENT(array
,n
);
121 sstride
[n
] = GFC_DESCRIPTOR_STRIDE_BYTES(array
,n
);
122 mstride
[n
] = GFC_DESCRIPTOR_STRIDE_BYTES(mask
,n
);
127 mstride
[0] = mask_kind
;
129 if (ret
->base_addr
== NULL
|| unlikely (compile_options
.bounds_check
))
131 /* Count the elements, either for allocating memory or
132 for bounds checking. */
136 /* The return array will have as many
137 elements as there are in VECTOR. */
138 total
= GFC_DESCRIPTOR_EXTENT(vector
,0);
142 /* We have to count the true elements in MASK. */
144 total
= count_0 (mask
);
147 if (ret
->base_addr
== NULL
)
149 /* Setup the array descriptor. */
150 GFC_DIMENSION_SET(ret
->dim
[0], 0, total
-1, 1);
153 /* xmallocarray allocates a single byte for zero size. */
154 ret
->base_addr
= xmallocarray (total
, size
);
157 return; /* In this case, nothing remains to be done. */
161 /* We come here because of range checking. */
162 index_type ret_extent
;
164 ret_extent
= GFC_DESCRIPTOR_EXTENT(ret
,0);
165 if (total
!= ret_extent
)
166 runtime_error ("Incorrect extent in return value of PACK intrinsic;"
167 " is %ld, should be %ld", (long int) total
,
168 (long int) ret_extent
);
172 rstride0
= GFC_DESCRIPTOR_STRIDE_BYTES(ret
,0);
175 sstride0
= sstride
[0];
176 mstride0
= mstride
[0];
177 rptr
= ret
->base_addr
;
181 /* Test this element. */
185 memcpy (rptr
, sptr
, size
);
188 /* Advance to the next element. */
193 while (count
[n
] == extent
[n
])
195 /* When we get to the end of a dimension, reset it and increment
196 the next dimension. */
198 /* We could precalculate these products, but this is a less
199 frequently used path so probably not worth it. */
200 sptr
-= sstride
[n
] * extent
[n
];
201 mptr
-= mstride
[n
] * extent
[n
];
205 /* Break out of the loop. */
218 /* Add any remaining elements from VECTOR. */
221 n
= GFC_DESCRIPTOR_EXTENT(vector
,0);
222 nelem
= ((rptr
- ret
->base_addr
) / rstride0
);
225 sstride0
= GFC_DESCRIPTOR_STRIDE_BYTES(vector
,0);
229 sptr
= vector
->base_addr
+ sstride0
* nelem
;
233 memcpy (rptr
, sptr
, size
);
241 extern void pack (gfc_array_char
*, const gfc_array_char
*,
242 const gfc_array_l1
*, const gfc_array_char
*);
246 pack (gfc_array_char
*ret
, const gfc_array_char
*array
,
247 const gfc_array_l1
*mask
, const gfc_array_char
*vector
)
249 index_type type_size
;
252 type_size
= GFC_DTYPE_TYPE_SIZE(array
);
256 case GFC_DTYPE_LOGICAL_1
:
257 case GFC_DTYPE_INTEGER_1
:
258 case GFC_DTYPE_DERIVED_1
:
259 pack_i1 ((gfc_array_i1
*) ret
, (gfc_array_i1
*) array
,
260 (gfc_array_l1
*) mask
, (gfc_array_i1
*) vector
);
263 case GFC_DTYPE_LOGICAL_2
:
264 case GFC_DTYPE_INTEGER_2
:
265 pack_i2 ((gfc_array_i2
*) ret
, (gfc_array_i2
*) array
,
266 (gfc_array_l1
*) mask
, (gfc_array_i2
*) vector
);
269 case GFC_DTYPE_LOGICAL_4
:
270 case GFC_DTYPE_INTEGER_4
:
271 pack_i4 ((gfc_array_i4
*) ret
, (gfc_array_i4
*) array
,
272 (gfc_array_l1
*) mask
, (gfc_array_i4
*) vector
);
275 case GFC_DTYPE_LOGICAL_8
:
276 case GFC_DTYPE_INTEGER_8
:
277 pack_i8 ((gfc_array_i8
*) ret
, (gfc_array_i8
*) array
,
278 (gfc_array_l1
*) mask
, (gfc_array_i8
*) vector
);
281 #ifdef HAVE_GFC_INTEGER_16
282 case GFC_DTYPE_LOGICAL_16
:
283 case GFC_DTYPE_INTEGER_16
:
284 pack_i16 ((gfc_array_i16
*) ret
, (gfc_array_i16
*) array
,
285 (gfc_array_l1
*) mask
, (gfc_array_i16
*) vector
);
289 case GFC_DTYPE_REAL_4
:
290 pack_r4 ((gfc_array_r4
*) ret
, (gfc_array_r4
*) array
,
291 (gfc_array_l1
*) mask
, (gfc_array_r4
*) vector
);
294 case GFC_DTYPE_REAL_8
:
295 pack_r8 ((gfc_array_r8
*) ret
, (gfc_array_r8
*) array
,
296 (gfc_array_l1
*) mask
, (gfc_array_r8
*) vector
);
299 /* FIXME: This here is a hack, which will have to be removed when
300 the array descriptor is reworked. Currently, we don't store the
301 kind value for the type, but only the size. Because on targets with
302 __float128, we have sizeof(logn double) == sizeof(__float128),
303 we cannot discriminate here and have to fall back to the generic
304 handling (which is suboptimal). */
305 #if !defined(GFC_REAL_16_IS_FLOAT128)
306 # ifdef HAVE_GFC_REAL_10
307 case GFC_DTYPE_REAL_10
:
308 pack_r10 ((gfc_array_r10
*) ret
, (gfc_array_r10
*) array
,
309 (gfc_array_l1
*) mask
, (gfc_array_r10
*) vector
);
313 # ifdef HAVE_GFC_REAL_16
314 case GFC_DTYPE_REAL_16
:
315 pack_r16 ((gfc_array_r16
*) ret
, (gfc_array_r16
*) array
,
316 (gfc_array_l1
*) mask
, (gfc_array_r16
*) vector
);
321 case GFC_DTYPE_COMPLEX_4
:
322 pack_c4 ((gfc_array_c4
*) ret
, (gfc_array_c4
*) array
,
323 (gfc_array_l1
*) mask
, (gfc_array_c4
*) vector
);
326 case GFC_DTYPE_COMPLEX_8
:
327 pack_c8 ((gfc_array_c8
*) ret
, (gfc_array_c8
*) array
,
328 (gfc_array_l1
*) mask
, (gfc_array_c8
*) vector
);
331 /* FIXME: This here is a hack, which will have to be removed when
332 the array descriptor is reworked. Currently, we don't store the
333 kind value for the type, but only the size. Because on targets with
334 __float128, we have sizeof(logn double) == sizeof(__float128),
335 we cannot discriminate here and have to fall back to the generic
336 handling (which is suboptimal). */
337 #if !defined(GFC_REAL_16_IS_FLOAT128)
338 # ifdef HAVE_GFC_COMPLEX_10
339 case GFC_DTYPE_COMPLEX_10
:
340 pack_c10 ((gfc_array_c10
*) ret
, (gfc_array_c10
*) array
,
341 (gfc_array_l1
*) mask
, (gfc_array_c10
*) vector
);
345 # ifdef HAVE_GFC_COMPLEX_16
346 case GFC_DTYPE_COMPLEX_16
:
347 pack_c16 ((gfc_array_c16
*) ret
, (gfc_array_c16
*) array
,
348 (gfc_array_l1
*) mask
, (gfc_array_c16
*) vector
);
353 /* For derived types, let's check the actual alignment of the
354 data pointers. If they are aligned, we can safely call
355 the unpack functions. */
357 case GFC_DTYPE_DERIVED_2
:
358 if (GFC_UNALIGNED_2(ret
->base_addr
) || GFC_UNALIGNED_2(array
->base_addr
)
359 || (vector
&& GFC_UNALIGNED_2(vector
->base_addr
)))
363 pack_i2 ((gfc_array_i2
*) ret
, (gfc_array_i2
*) array
,
364 (gfc_array_l1
*) mask
, (gfc_array_i2
*) vector
);
368 case GFC_DTYPE_DERIVED_4
:
369 if (GFC_UNALIGNED_4(ret
->base_addr
) || GFC_UNALIGNED_4(array
->base_addr
)
370 || (vector
&& GFC_UNALIGNED_4(vector
->base_addr
)))
374 pack_i4 ((gfc_array_i4
*) ret
, (gfc_array_i4
*) array
,
375 (gfc_array_l1
*) mask
, (gfc_array_i4
*) vector
);
379 case GFC_DTYPE_DERIVED_8
:
380 if (GFC_UNALIGNED_8(ret
->base_addr
) || GFC_UNALIGNED_8(array
->base_addr
)
381 || (vector
&& GFC_UNALIGNED_8(vector
->base_addr
)))
385 pack_i8 ((gfc_array_i8
*) ret
, (gfc_array_i8
*) array
,
386 (gfc_array_l1
*) mask
, (gfc_array_i8
*) vector
);
390 #ifdef HAVE_GFC_INTEGER_16
391 case GFC_DTYPE_DERIVED_16
:
392 if (GFC_UNALIGNED_16(ret
->base_addr
) || GFC_UNALIGNED_16(array
->base_addr
)
393 || (vector
&& GFC_UNALIGNED_16(vector
->base_addr
)))
397 pack_i16 ((gfc_array_i16
*) ret
, (gfc_array_i16
*) array
,
398 (gfc_array_l1
*) mask
, (gfc_array_i16
*) vector
);
405 size
= GFC_DESCRIPTOR_SIZE (array
);
406 pack_internal (ret
, array
, mask
, vector
, size
);
410 extern void pack_char (gfc_array_char
*, GFC_INTEGER_4
, const gfc_array_char
*,
411 const gfc_array_l1
*, const gfc_array_char
*,
412 GFC_INTEGER_4
, GFC_INTEGER_4
);
413 export_proto(pack_char
);
416 pack_char (gfc_array_char
*ret
,
417 GFC_INTEGER_4 ret_length
__attribute__((unused
)),
418 const gfc_array_char
*array
, const gfc_array_l1
*mask
,
419 const gfc_array_char
*vector
, GFC_INTEGER_4 array_length
,
420 GFC_INTEGER_4 vector_length
__attribute__((unused
)))
422 pack_internal (ret
, array
, mask
, vector
, array_length
);
426 extern void pack_char4 (gfc_array_char
*, GFC_INTEGER_4
, const gfc_array_char
*,
427 const gfc_array_l1
*, const gfc_array_char
*,
428 GFC_INTEGER_4
, GFC_INTEGER_4
);
429 export_proto(pack_char4
);
432 pack_char4 (gfc_array_char
*ret
,
433 GFC_INTEGER_4 ret_length
__attribute__((unused
)),
434 const gfc_array_char
*array
, const gfc_array_l1
*mask
,
435 const gfc_array_char
*vector
, GFC_INTEGER_4 array_length
,
436 GFC_INTEGER_4 vector_length
__attribute__((unused
)))
438 pack_internal (ret
, array
, mask
, vector
, array_length
* sizeof (gfc_char4_t
));
443 pack_s_internal (gfc_array_char
*ret
, const gfc_array_char
*array
,
444 const GFC_LOGICAL_4
*mask
, const gfc_array_char
*vector
,
447 /* r.* indicates the return array. */
450 /* s.* indicates the source array. */
451 index_type sstride
[GFC_MAX_DIMENSIONS
];
455 index_type count
[GFC_MAX_DIMENSIONS
];
456 index_type extent
[GFC_MAX_DIMENSIONS
];
463 dim
= GFC_DESCRIPTOR_RANK (array
);
464 /* Initialize sstride[0] to avoid -Wmaybe-uninitialized
468 for (n
= 0; n
< dim
; n
++)
471 extent
[n
] = GFC_DESCRIPTOR_EXTENT(array
,n
);
475 sstride
[n
] = GFC_DESCRIPTOR_STRIDE_BYTES(array
,n
);
481 sstride0
= sstride
[0];
484 sptr
= array
->base_addr
;
488 if (ret
->base_addr
== NULL
)
490 /* Allocate the memory for the result. */
494 /* The return array will have as many elements as there are
496 total
= GFC_DESCRIPTOR_EXTENT(vector
,0);
507 /* The result array will have as many elements as the input
510 for (n
= 1; n
< dim
; n
++)
514 /* The result array will be empty. */
518 /* Setup the array descriptor. */
519 GFC_DIMENSION_SET(ret
->dim
[0],0,total
-1,1);
523 ret
->base_addr
= xmallocarray (total
, size
);
529 rstride0
= GFC_DESCRIPTOR_STRIDE_BYTES(ret
,0);
532 rptr
= ret
->base_addr
;
534 /* The remaining possibilities are now:
535 If MASK is .TRUE., we have to copy the source array into the
536 result array. We then have to fill it up with elements from VECTOR.
537 If MASK is .FALSE., we have to copy VECTOR into the result
538 array. If VECTOR were not present we would have already returned. */
540 if (*mask
&& ssize
!= 0)
544 /* Add this element. */
545 memcpy (rptr
, sptr
, size
);
548 /* Advance to the next element. */
552 while (count
[n
] == extent
[n
])
554 /* When we get to the end of a dimension, reset it and
555 increment the next dimension. */
557 /* We could precalculate these products, but this is a
558 less frequently used path so probably not worth it. */
559 sptr
-= sstride
[n
] * extent
[n
];
563 /* Break out of the loop. */
576 /* Add any remaining elements from VECTOR. */
579 n
= GFC_DESCRIPTOR_EXTENT(vector
,0);
580 nelem
= ((rptr
- ret
->base_addr
) / rstride0
);
583 sstride0
= GFC_DESCRIPTOR_STRIDE_BYTES(vector
,0);
587 sptr
= vector
->base_addr
+ sstride0
* nelem
;
591 memcpy (rptr
, sptr
, size
);
599 extern void pack_s (gfc_array_char
*ret
, const gfc_array_char
*array
,
600 const GFC_LOGICAL_4
*, const gfc_array_char
*);
601 export_proto(pack_s
);
604 pack_s (gfc_array_char
*ret
, const gfc_array_char
*array
,
605 const GFC_LOGICAL_4
*mask
, const gfc_array_char
*vector
)
607 pack_s_internal (ret
, array
, mask
, vector
, GFC_DESCRIPTOR_SIZE (array
));
611 extern void pack_s_char (gfc_array_char
*ret
, GFC_INTEGER_4
,
612 const gfc_array_char
*array
, const GFC_LOGICAL_4
*,
613 const gfc_array_char
*, GFC_INTEGER_4
,
615 export_proto(pack_s_char
);
618 pack_s_char (gfc_array_char
*ret
,
619 GFC_INTEGER_4 ret_length
__attribute__((unused
)),
620 const gfc_array_char
*array
, const GFC_LOGICAL_4
*mask
,
621 const gfc_array_char
*vector
, GFC_INTEGER_4 array_length
,
622 GFC_INTEGER_4 vector_length
__attribute__((unused
)))
624 pack_s_internal (ret
, array
, mask
, vector
, array_length
);
628 extern void pack_s_char4 (gfc_array_char
*ret
, GFC_INTEGER_4
,
629 const gfc_array_char
*array
, const GFC_LOGICAL_4
*,
630 const gfc_array_char
*, GFC_INTEGER_4
,
632 export_proto(pack_s_char4
);
635 pack_s_char4 (gfc_array_char
*ret
,
636 GFC_INTEGER_4 ret_length
__attribute__((unused
)),
637 const gfc_array_char
*array
, const GFC_LOGICAL_4
*mask
,
638 const gfc_array_char
*vector
, GFC_INTEGER_4 array_length
,
639 GFC_INTEGER_4 vector_length
__attribute__((unused
)))
641 pack_s_internal (ret
, array
, mask
, vector
,
642 array_length
* sizeof (gfc_char4_t
));