Formerly generic/memcopy.h.~7~
[kopensolaris-gnu/glibc.git] / sysdeps / generic / memcopy.h
1 /* memcopy.h -- definitions for memory copy functions.  Generic C version.
2    Copyright (C) 1991, 1992 Free Software Foundation, Inc.
3    Contributed by Torbjorn Granlund (tege@sics.se).
4
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 License, or (at your option) any later version.
9
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with the GNU C Library; see the file COPYING.LIB.  If
17 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
18 Cambridge, MA 02139, USA.  */
19
20 /* The strategy of the memory functions is:
21
22      1. Copy bytes until the destination pointer is aligned.
23
24      2. Copy words in unrolled loops.  If the source and destination
25      are not aligned in the same way, use word memory operations,
26      but shift and merge two read words before writing.
27
28      3. Copy the few remaining bytes.
29
30    This is fast on processors that have at least 10 registers for
31    allocation by GCC, and that can access memory at reg+const in one
32    instruction.
33
34    I made an "exhaustive" test of this memmove when I wrote it,
35    exhaustive in the sense that I tried all alignment and length
36    combinations, with and without overlap.  */
37
38 #include <endian.h>
39
40 /* The macros defined in this file are:
41
42    BYTE_COPY_FWD(dst_beg_ptr, src_beg_ptr, nbytes_to_copy)
43
44    BYTE_COPY_BWD(dst_end_ptr, src_end_ptr, nbytes_to_copy)
45
46    WORD_COPY_FWD(dst_beg_ptr, src_beg_ptr, nbytes_remaining, nbytes_to_copy)
47
48    WORD_COPY_BWD(dst_end_ptr, src_end_ptr, nbytes_remaining, nbytes_to_copy)
49
50    MERGE(old_word, sh_1, new_word, sh_2)
51      [I fail to understand.  I feel stupid.  --roland]
52 */
53
54 /* Type to use for aligned memory operations.
55    This should normally be the biggest type supported by a single load
56    and store.  */
57 #define op_t    unsigned long int
58 #define OPSIZ   (sizeof(op_t))
59
60 /* Type to use for unaligned operations.  */
61 typedef unsigned char byte;
62
63 /* Optimal type for storing bytes in registers.  */
64 #define reg_char        char
65
66 #if __BYTE_ORDER == __LITTLE_ENDIAN
67 #define MERGE(w0, sh_1, w1, sh_2) (((w0) >> (sh_1)) | ((w1) << (sh_2)))
68 #endif
69 #if __BYTE_ORDER == __BIG_ENDIAN
70 #define MERGE(w0, sh_1, w1, sh_2) (((w0) << (sh_1)) | ((w1) >> (sh_2)))
71 #endif
72
73 /* Copy exactly NBYTES bytes from SRC_BP to DST_BP,
74    without any assumptions about alignment of the pointers.  */
75 #define BYTE_COPY_FWD(dst_bp, src_bp, nbytes)                                 \
76   do                                                                          \
77     {                                                                         \
78       size_t __nbytes = (nbytes);                                             \
79       while (__nbytes > 0)                                                    \
80         {                                                                     \
81           byte __x = ((byte *) src_bp)[0];                                    \
82           src_bp += 1;                                                        \
83           __nbytes -= 1;                                                      \
84           ((byte *) dst_bp)[0] = __x;                                         \
85           dst_bp += 1;                                                        \
86         }                                                                     \
87     } while (0)
88
89 /* Copy exactly NBYTES_TO_COPY bytes from SRC_END_PTR to DST_END_PTR,
90    beginning at the bytes right before the pointers and continuing towards
91    smaller addresses.  Don't assume anything about alignment of the
92    pointers.  */
93 #define BYTE_COPY_BWD(dst_ep, src_ep, nbytes)                                 \
94   do                                                                          \
95     {                                                                         \
96       size_t __nbytes = (nbytes);                                             \
97       while (__nbytes > 0)                                                    \
98         {                                                                     \
99           byte __x;                                                           \
100           src_ep -= 1;                                                        \
101           __x = ((byte *) src_ep)[0];                                         \
102           dst_ep -= 1;                                                        \
103           __nbytes -= 1;                                                      \
104           ((byte *) dst_ep)[0] = __x;                                         \
105         }                                                                     \
106     } while (0)
107
108 /* Copy *up to* NBYTES bytes from SRC_BP to DST_BP, with
109    the assumption that DST_BP is aligned on an OPSIZ multiple.  If
110    not all bytes could be easily copied, store remaining number of bytes
111    in NBYTES_LEFT, otherwise store 0.  */
112 extern void EXFUN(_wordcopy_fwd_aligned, (long int, long int, size_t));
113 extern void EXFUN(_wordcopy_fwd_dest_aligned, (long int, long int, size_t));
114 #define WORD_COPY_FWD(dst_bp, src_bp, nbytes_left, nbytes)                    \
115   do                                                                          \
116     {                                                                         \
117       if (src_bp % OPSIZ == 0)                                                \
118         _wordcopy_fwd_aligned (dst_bp, src_bp, (nbytes) / OPSIZ);             \
119       else                                                                    \
120         _wordcopy_fwd_dest_aligned (dst_bp, src_bp, (nbytes) / OPSIZ);        \
121       src_bp += (nbytes) & -OPSIZ;                                            \
122       dst_bp += (nbytes) & -OPSIZ;                                            \
123       (nbytes_left) = (nbytes) % OPSIZ;                                       \
124     } while (0)
125
126 /* Copy *up to* NBYTES_TO_COPY bytes from SRC_END_PTR to DST_END_PTR,
127    beginning at the words (of type op_t) right before the pointers and
128    continuing towards smaller addresses.  May take advantage of that
129    DST_END_PTR is aligned on an OPSIZ multiple.  If not all bytes could be
130    easily copied, store remaining number of bytes in NBYTES_REMAINING,
131    otherwise store 0.  */
132 extern void EXFUN(_wordcopy_bwd_aligned, (long int, long int, size_t));
133 extern void EXFUN(_wordcopy_bwd_dest_aligned, (long int, long int, size_t));
134 #define WORD_COPY_BWD(dst_ep, src_ep, nbytes_left, nbytes)                    \
135   do                                                                          \
136     {                                                                         \
137       if (src_ep % OPSIZ == 0)                                                \
138         _wordcopy_bwd_aligned (dst_ep, src_ep, (nbytes) / OPSIZ);             \
139       else                                                                    \
140         _wordcopy_bwd_dest_aligned (dst_ep, src_ep, (nbytes) / OPSIZ);        \
141       src_ep -= (nbytes) & -OPSIZ;                                            \
142       dst_ep -= (nbytes) & -OPSIZ;                                            \
143       (nbytes_left) = (nbytes) % OPSIZ;                                       \
144     } while (0)
145
146
147 /* Threshold value for when to enter the unrolled loops.  */
148 #define OP_T_THRES      16