libgfortran/intrinsics/cshift0.c

   1 /* Generic implementation of the CSHIFT intrinsic
   2    Copyright (C) 2003-2017 Free Software Foundation, Inc.
   3    Contributed by Feng Wang <wf_cs@yahoo.com>
   4
   5 This file is part of the GNU Fortran runtime library (libgfortran).
   6
   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.
  11
  12 Libgfortran 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.
  16
  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.
  20
  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/>.  */
  25
  26 #include "libgfortran.h"
  27 #include <string.h>
  28
  29 static void
  30 cshift0 (gfc_array_char * ret, const gfc_array_char * array,
  31          ptrdiff_t shift, int which, index_type size)
  32 {
  33   /* r.* indicates the return array.  */
  34   index_type rstride[GFC_MAX_DIMENSIONS];
  35   index_type rstride0;
  36   index_type roffset;
  37   char *rptr;
  38
  39   /* s.* indicates the source array.  */
  40   index_type sstride[GFC_MAX_DIMENSIONS];
  41   index_type sstride0;
  42   index_type soffset;
  43   const char *sptr;
  44
  45   index_type count[GFC_MAX_DIMENSIONS];
  46   index_type extent[GFC_MAX_DIMENSIONS];
  47   index_type dim;
  48   index_type len;
  49   index_type n;
  50   index_type arraysize;
  51
  52   index_type type_size;
  53
  54   if (which < 1 || which > GFC_DESCRIPTOR_RANK (array))
  55     runtime_error ("Argument 'DIM' is out of range in call to 'CSHIFT'");
  56
  57   arraysize = size0 ((array_t *) array);
  58
  59   if (ret->base_addr == NULL)
  60     {
  61       int i;
  62
  63       ret->offset = 0;
  64       ret->dtype = array->dtype;
  65       for (i = 0; i < GFC_DESCRIPTOR_RANK (array); i++)
  66         {
  67           index_type ub, str;
  68
  69           ub = GFC_DESCRIPTOR_EXTENT(array,i) - 1;
  70
  71           if (i == 0)
  72             str = 1;
  73           else
  74             str = GFC_DESCRIPTOR_EXTENT(ret,i-1) *
  75               GFC_DESCRIPTOR_STRIDE(ret,i-1);
  76
  77           GFC_DIMENSION_SET(ret->dim[i], 0, ub, str);
  78         }
  79
  80       /* xmallocarray allocates a single byte for zero size.  */
  81       ret->base_addr = xmallocarray (arraysize, size);
  82     }
  83   else if (unlikely (compile_options.bounds_check))
  84     {
  85       bounds_equal_extents ((array_t *) ret, (array_t *) array,
  86                                  "return value", "CSHIFT");
  87     }
  88
  89   if (arraysize == 0)
  90     return;
  91
  92   type_size = GFC_DTYPE_TYPE_SIZE (array);
  93
  94   switch(type_size)
  95     {
  96     case GFC_DTYPE_LOGICAL_1:
  97     case GFC_DTYPE_INTEGER_1:
  98     case GFC_DTYPE_DERIVED_1:
  99       cshift0_i1 ((gfc_array_i1 *)ret, (gfc_array_i1 *) array, shift, which);
 100       return;
 101
 102     case GFC_DTYPE_LOGICAL_2:
 103     case GFC_DTYPE_INTEGER_2:
 104       cshift0_i2 ((gfc_array_i2 *)ret, (gfc_array_i2 *) array, shift, which);
 105       return;
 106
 107     case GFC_DTYPE_LOGICAL_4:
 108     case GFC_DTYPE_INTEGER_4:
 109       cshift0_i4 ((gfc_array_i4 *)ret, (gfc_array_i4 *) array, shift, which);
 110       return;
 111
 112     case GFC_DTYPE_LOGICAL_8:
 113     case GFC_DTYPE_INTEGER_8:
 114       cshift0_i8 ((gfc_array_i8 *)ret, (gfc_array_i8 *) array, shift, which);
 115       return;
 116
 117 #ifdef HAVE_GFC_INTEGER_16
 118     case GFC_DTYPE_LOGICAL_16:
 119     case GFC_DTYPE_INTEGER_16:
 120       cshift0_i16 ((gfc_array_i16 *)ret, (gfc_array_i16 *) array, shift,
 121                    which);
 122       return;
 123 #endif
 124
 125     case GFC_DTYPE_REAL_4:
 126       cshift0_r4 ((gfc_array_r4 *)ret, (gfc_array_r4 *) array, shift, which);
 127       return;
 128
 129     case GFC_DTYPE_REAL_8:
 130       cshift0_r8 ((gfc_array_r8 *)ret, (gfc_array_r8 *) array, shift, which);
 131       return;
 132
 133 /* FIXME: This here is a hack, which will have to be removed when
 134    the array descriptor is reworked.  Currently, we don't store the
 135    kind value for the type, but only the size.  Because on targets with
 136    __float128, we have sizeof(logn double) == sizeof(__float128),
 137    we cannot discriminate here and have to fall back to the generic
 138    handling (which is suboptimal).  */
 139 #if !defined(GFC_REAL_16_IS_FLOAT128)
 140 # ifdef HAVE_GFC_REAL_10
 141     case GFC_DTYPE_REAL_10:
 142       cshift0_r10 ((gfc_array_r10 *)ret, (gfc_array_r10 *) array, shift,
 143                    which);
 144       return;
 145 # endif
 146
 147 # ifdef HAVE_GFC_REAL_16
 148     case GFC_DTYPE_REAL_16:
 149       cshift0_r16 ((gfc_array_r16 *)ret, (gfc_array_r16 *) array, shift,
 150                    which);
 151       return;
 152 # endif
 153 #endif
 154
 155     case GFC_DTYPE_COMPLEX_4:
 156       cshift0_c4 ((gfc_array_c4 *)ret, (gfc_array_c4 *) array, shift, which);
 157       return;
 158
 159     case GFC_DTYPE_COMPLEX_8:
 160       cshift0_c8 ((gfc_array_c8 *)ret, (gfc_array_c8 *) array, shift, which);
 161       return;
 162
 163 /* FIXME: This here is a hack, which will have to be removed when
 164    the array descriptor is reworked.  Currently, we don't store the
 165    kind value for the type, but only the size.  Because on targets with
 166    __float128, we have sizeof(logn double) == sizeof(__float128),
 167    we cannot discriminate here and have to fall back to the generic
 168    handling (which is suboptimal).  */
 169 #if !defined(GFC_REAL_16_IS_FLOAT128)
 170 # ifdef HAVE_GFC_COMPLEX_10
 171     case GFC_DTYPE_COMPLEX_10:
 172       cshift0_c10 ((gfc_array_c10 *)ret, (gfc_array_c10 *) array, shift,
 173                    which);
 174       return;
 175 # endif
 176
 177 # ifdef HAVE_GFC_COMPLEX_16
 178     case GFC_DTYPE_COMPLEX_16:
 179       cshift0_c16 ((gfc_array_c16 *)ret, (gfc_array_c16 *) array, shift,
 180                    which);
 181       return;
 182 # endif
 183 #endif
 184
 185     default:
 186       break;
 187     }
 188
 189   switch (size)
 190     {
 191       /* Let's check the actual alignment of the data pointers.  If they
 192          are suitably aligned, we can safely call the unpack functions.  */
 193
 194     case sizeof (GFC_INTEGER_1):
 195       cshift0_i1 ((gfc_array_i1 *) ret, (gfc_array_i1 *) array, shift,
 196                   which);
 197       break;
 198
 199     case sizeof (GFC_INTEGER_2):
 200       if (GFC_UNALIGNED_2(ret->base_addr) || GFC_UNALIGNED_2(array->base_addr))
 201         break;
 202       else
 203         {
 204           cshift0_i2 ((gfc_array_i2 *) ret, (gfc_array_i2 *) array, shift,
 205                       which);
 206           return;
 207         }
 208
 209     case sizeof (GFC_INTEGER_4):
 210       if (GFC_UNALIGNED_4(ret->base_addr) || GFC_UNALIGNED_4(array->base_addr))
 211         break;
 212       else
 213         {
 214           cshift0_i4 ((gfc_array_i4 *)ret, (gfc_array_i4 *) array, shift,
 215                       which);
 216           return;
 217         }
 218
 219     case sizeof (GFC_INTEGER_8):
 220       if (GFC_UNALIGNED_8(ret->base_addr) || GFC_UNALIGNED_8(array->base_addr))
 221         {
 222           /* Let's try to use the complex routines.  First, a sanity
 223              check that the sizes match; this should be optimized to
 224              a no-op.  */
 225           if (sizeof(GFC_INTEGER_8) != sizeof(GFC_COMPLEX_4))
 226             break;
 227
 228           if (GFC_UNALIGNED_C4(ret->base_addr)
 229               || GFC_UNALIGNED_C4(array->base_addr))
 230             break;
 231
 232           cshift0_c4 ((gfc_array_c4 *) ret, (gfc_array_c4 *) array, shift,
 233                       which);
 234           return;
 235         }
 236       else
 237         {
 238           cshift0_i8 ((gfc_array_i8 *)ret, (gfc_array_i8 *) array, shift,
 239                       which);
 240           return;
 241         }
 242
 243 #ifdef HAVE_GFC_INTEGER_16
 244     case sizeof (GFC_INTEGER_16):
 245       if (GFC_UNALIGNED_16(ret->base_addr)
 246           || GFC_UNALIGNED_16(array->base_addr))
 247         {
 248           /* Let's try to use the complex routines.  First, a sanity
 249              check that the sizes match; this should be optimized to
 250              a no-op.  */
 251           if (sizeof(GFC_INTEGER_16) != sizeof(GFC_COMPLEX_8))
 252             break;
 253
 254           if (GFC_UNALIGNED_C8(ret->base_addr)
 255               || GFC_UNALIGNED_C8(array->base_addr))
 256             break;
 257
 258           cshift0_c8 ((gfc_array_c8 *) ret, (gfc_array_c8 *) array, shift,
 259                       which);
 260           return;
 261         }
 262       else
 263         {
 264           cshift0_i16 ((gfc_array_i16 *) ret, (gfc_array_i16 *) array,
 265                        shift, which);
 266           return;
 267         }
 268 #else
 269     case sizeof (GFC_COMPLEX_8):
 270
 271       if (GFC_UNALIGNED_C8(ret->base_addr)
 272           || GFC_UNALIGNED_C8(array->base_addr))
 273         break;
 274       else
 275         {
 276           cshift0_c8 ((gfc_array_c8 *) ret, (gfc_array_c8 *) array, shift,
 277                       which);
 278           return;
 279         }
 280 #endif
 281
 282     default:
 283       break;
 284     }
 285
 286
 287   which = which - 1;
 288   sstride[0] = 0;
 289   rstride[0] = 0;
 290
 291   extent[0] = 1;
 292   count[0] = 0;
 293   n = 0;
 294   /* Initialized for avoiding compiler warnings.  */
 295   roffset = size;
 296   soffset = size;
 297   len = 0;
 298
 299   for (dim = 0; dim < GFC_DESCRIPTOR_RANK (array); dim++)
 300     {
 301       if (dim == which)
 302         {
 303           roffset = GFC_DESCRIPTOR_STRIDE_BYTES(ret,dim);
 304           if (roffset == 0)
 305             roffset = size;
 306           soffset = GFC_DESCRIPTOR_STRIDE_BYTES(array,dim);
 307           if (soffset == 0)
 308             soffset = size;
 309           len = GFC_DESCRIPTOR_EXTENT(array,dim);
 310         }
 311       else
 312         {
 313           count[n] = 0;
 314           extent[n] = GFC_DESCRIPTOR_EXTENT(array,dim);
 315           rstride[n] = GFC_DESCRIPTOR_STRIDE_BYTES(ret,dim);
 316           sstride[n] = GFC_DESCRIPTOR_STRIDE_BYTES(array,dim);
 317           n++;
 318         }
 319     }
 320   if (sstride[0] == 0)
 321     sstride[0] = size;
 322   if (rstride[0] == 0)
 323     rstride[0] = size;
 324
 325   dim = GFC_DESCRIPTOR_RANK (array);
 326   rstride0 = rstride[0];
 327   sstride0 = sstride[0];
 328   rptr = ret->base_addr;
 329   sptr = array->base_addr;
 330
 331   shift = len == 0 ? 0 : shift % (ptrdiff_t)len;
 332   if (shift < 0)
 333     shift += len;
 334
 335   while (rptr)
 336     {
 337       /* Do the shift for this dimension.  */
 338
 339       /* If elements are contiguous, perform the operation
 340          in two block moves.  */
 341       if (soffset == size && roffset == size)
 342         {
 343           size_t len1 = shift * size;
 344           size_t len2 = (len - shift) * size;
 345           memcpy (rptr, sptr + len1, len2);
 346           memcpy (rptr + len2, sptr, len1);
 347         }
 348       else
 349         {
 350           /* Otherwise, we'll have to perform the copy one element at
 351              a time.  */
 352           char *dest = rptr;
 353           const char *src = &sptr[shift * soffset];
 354
 355           for (n = 0; n < len - shift; n++)
 356             {
 357               memcpy (dest, src, size);
 358               dest += roffset;
 359               src += soffset;
 360             }
 361           for (src = sptr, n = 0; n < shift; n++)
 362             {
 363               memcpy (dest, src, size);
 364               dest += roffset;
 365               src += soffset;
 366             }
 367         }
 368
 369       /* Advance to the next section.  */
 370       rptr += rstride0;
 371       sptr += sstride0;
 372       count[0]++;
 373       n = 0;
 374       while (count[n] == extent[n])
 375         {
 376           /* When we get to the end of a dimension, reset it and increment
 377              the next dimension.  */
 378           count[n] = 0;
 379           /* We could precalculate these products, but this is a less
 380              frequently used path so probably not worth it.  */
 381           rptr -= rstride[n] * extent[n];
 382           sptr -= sstride[n] * extent[n];
 383           n++;
 384           if (n >= dim - 1)
 385             {
 386               /* Break out of the loop.  */
 387               rptr = NULL;
 388               break;
 389             }
 390           else
 391             {
 392               count[n]++;
 393               rptr += rstride[n];
 394               sptr += sstride[n];
 395             }
 396         }
 397     }
 398 }
 399
 400 #define DEFINE_CSHIFT(N)                                                      \
 401   extern void cshift0_##N (gfc_array_char *, const gfc_array_char *,          \
 402                            const GFC_INTEGER_##N *, const GFC_INTEGER_##N *); \
 403   export_proto(cshift0_##N);                                                  \
 404                                                                               \
 405   void                                                                        \
 406   cshift0_##N (gfc_array_char *ret, const gfc_array_char *array,              \
 407                const GFC_INTEGER_##N *pshift, const GFC_INTEGER_##N *pdim)    \
 408   {                                                                           \
 409     cshift0 (ret, array, *pshift, pdim ? *pdim : 1,                           \
 410              GFC_DESCRIPTOR_SIZE (array));                                    \
 411   }                                                                           \
 412                                                                               \
 413   extern void cshift0_##N##_char (gfc_array_char *, GFC_INTEGER_4,            \
 414                                   const gfc_array_char *,                     \
 415                                   const GFC_INTEGER_##N *,                    \
 416                                   const GFC_INTEGER_##N *, GFC_INTEGER_4);    \
 417   export_proto(cshift0_##N##_char);                                           \
 418                                                                               \
 419   void                                                                        \
 420   cshift0_##N##_char (gfc_array_char *ret,                                    \
 421                       GFC_INTEGER_4 ret_length __attribute__((unused)),       \
 422                       const gfc_array_char *array,                            \
 423                       const GFC_INTEGER_##N *pshift,                          \
 424                       const GFC_INTEGER_##N *pdim,                            \
 425                       GFC_INTEGER_4 array_length)                             \
 426   {                                                                           \
 427     cshift0 (ret, array, *pshift, pdim ? *pdim : 1, array_length);            \
 428   }                                                                           \
 429                                                                               \
 430   extern void cshift0_##N##_char4 (gfc_array_char *, GFC_INTEGER_4,           \
 431                                    const gfc_array_char *,                    \
 432                                    const GFC_INTEGER_##N *,                   \
 433                                    const GFC_INTEGER_##N *, GFC_INTEGER_4);   \
 434   export_proto(cshift0_##N##_char4);                                          \
 435                                                                               \
 436   void                                                                        \
 437   cshift0_##N##_char4 (gfc_array_char *ret,                                   \
 438                        GFC_INTEGER_4 ret_length __attribute__((unused)),      \
 439                        const gfc_array_char *array,                           \
 440                        const GFC_INTEGER_##N *pshift,                         \
 441                        const GFC_INTEGER_##N *pdim,                           \
 442                        GFC_INTEGER_4 array_length)                            \
 443   {                                                                           \
 444     cshift0 (ret, array, *pshift, pdim ? *pdim : 1,                           \
 445              array_length * sizeof (gfc_char4_t));                            \
 446   }
 447
 448 DEFINE_CSHIFT (1);
 449 DEFINE_CSHIFT (2);
 450 DEFINE_CSHIFT (4);
 451 DEFINE_CSHIFT (8);
 452 #ifdef HAVE_GFC_INTEGER_16
 453 DEFINE_CSHIFT (16);
 454 #endif