* ./modules/audio_output/oss.c: compilation fixes.
[vlc.git] / modules / misc / memcpy / fastmemcpy.h
1 /*****************************************************************************
2  * fastmemcpy.h : fast memcpy routines
3  *****************************************************************************
4  * $Id: fastmemcpy.h,v 1.2 2002/08/08 00:35:11 sam Exp $
5  *
6  * Authors: various Linux kernel hackers
7  *          various MPlayer hackers
8  *          Nick Kurshev <nickols_k@mail.ru>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  * 
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23  *****************************************************************************/
24
25 /*
26   aclib - advanced C library ;)
27   This file contains functions which improve and expand standard C-library
28 */
29
30 #define BLOCK_SIZE 4096
31 #define CONFUSION_FACTOR 0
32 /*Feel free to fine-tune the above 2, it might be possible to get some speedup with them :)*/
33
34 /*#define STATISTICS*/
35
36 #ifndef HAVE_SSE2
37 /*
38    P3 processor has only one SSE decoder so can execute only 1 sse insn per
39    cpu clock, but it has 3 mmx decoders (include load/store unit)
40    and executes 3 mmx insns per cpu clock.
41    P4 processor has some chances, but after reading:
42    http://www.emulators.com/pentium4.htm
43    I have doubts. Anyway SSE2 version of this code can be written better.
44 */
45 #undef HAVE_SSE
46 #endif
47
48
49 /*
50  This part of code was taken by me from Linux-2.4.3 and slightly modified
51 for MMX, MMX2, SSE instruction set. I have done it since linux uses page aligned
52 blocks but mplayer uses weakly ordered data and original sources can not
53 speedup them. Only using PREFETCHNTA and MOVNTQ together have effect!
54
55 >From IA-32 Intel Architecture Software Developer's Manual Volume 1,
56
57 Order Number 245470:
58 "10.4.6. Cacheability Control, Prefetch, and Memory Ordering Instructions"
59
60 Data referenced by a program can be temporal (data will be used again) or
61 non-temporal (data will be referenced once and not reused in the immediate
62 future). To make efficient use of the processor's caches, it is generally
63 desirable to cache temporal data and not cache non-temporal data. Overloading
64 the processor's caches with non-temporal data is sometimes referred to as
65 "polluting the caches".
66 The non-temporal data is written to memory with Write-Combining semantics.
67
68 The PREFETCHh instructions permits a program to load data into the processor
69 at a suggested cache level, so that it is closer to the processors load and
70 store unit when it is needed. If the data is already present in a level of
71 the cache hierarchy that is closer to the processor, the PREFETCHh instruction
72 will not result in any data movement.
73 But we should you PREFETCHNTA: Non-temporal data fetch data into location
74 close to the processor, minimizing cache pollution.
75
76 The MOVNTQ (store quadword using non-temporal hint) instruction stores
77 packed integer data from an MMX register to memory, using a non-temporal hint.
78 The MOVNTPS (store packed single-precision floating-point values using
79 non-temporal hint) instruction stores packed floating-point data from an
80 XMM register to memory, using a non-temporal hint.
81
82 The SFENCE (Store Fence) instruction controls write ordering by creating a
83 fence for memory store operations. This instruction guarantees that the results
84 of every store instruction that precedes the store fence in program order is
85 globally visible before any store instruction that follows the fence. The
86 SFENCE instruction provides an efficient way of ensuring ordering between
87 procedures that produce weakly-ordered data and procedures that consume that
88 data.
89
90 If you have questions please contact with me: Nick Kurshev: nickols_k@mail.ru.
91 */
92
93 /* 3dnow memcpy support from kernel 2.4.2 */
94 /*  by Pontscho/fresh!mindworkz           */
95
96 #if defined( HAVE_MMX2 ) || defined( HAVE_3DNOW ) || defined( HAVE_MMX )
97
98 #undef HAVE_MMX1
99 #if defined(HAVE_MMX) && !defined(HAVE_MMX2) && !defined(HAVE_3DNOW) && !defined(HAVE_SSE)
100 /*  means: mmx v.1. Note: Since we added alignment of destinition it speedups
101     of memory copying on PentMMX, Celeron-1 and P2 upto 12% versus
102     standard (non MMX-optimized) version.
103     Note: on K6-2+ it speedups memory copying upto 25% and
104           on K7 and P3 about 500% (5 times). */
105 #define HAVE_MMX1
106 #endif
107
108
109 #undef HAVE_K6_2PLUS
110 #if !defined( HAVE_MMX2) && defined( HAVE_3DNOW)
111 #define HAVE_K6_2PLUS
112 #endif
113
114 /* for small memory blocks (<256 bytes) this version is faster */
115 #define small_memcpy(to,from,n)\
116 {\
117 register unsigned long int dummy;\
118 __asm__ __volatile__(\
119         "rep; movsb"\
120         :"=&D"(to), "=&S"(from), "=&c"(dummy)\
121 /* It's most portable way to notify compiler */\
122 /* that edi, esi and ecx are clobbered in asm block. */\
123 /* Thanks to A'rpi for hint!!! */\
124         :"0" (to), "1" (from),"2" (n)\
125         : "memory");\
126 }
127
128 #ifdef HAVE_SSE
129 #define MMREG_SIZE 16
130 #else
131 #define MMREG_SIZE 64 /*8*/
132 #endif
133
134 /* Small defines (for readability only) ;) */
135 #ifdef HAVE_K6_2PLUS
136 #define PREFETCH "prefetch"
137 /* On K6 femms is faster of emms. On K7 femms is directly mapped on emms. */
138 #define EMMS     "femms"
139 #else
140 #define PREFETCH "prefetchnta"
141 #define EMMS     "emms"
142 #endif
143
144 #ifdef HAVE_MMX2
145 #define MOVNTQ "movntq"
146 #else
147 #define MOVNTQ "movq"
148 #endif
149
150 #ifdef HAVE_MMX1
151 #define MIN_LEN 0x800  /* 2K blocks */
152 #else
153 #define MIN_LEN 0x40  /* 64-byte blocks */
154 #endif
155
156 void * fast_memcpy(void * to, const void * from, size_t len)
157 {
158         void *retval;
159         size_t i;
160         retval = to;
161 #ifdef STATISTICS
162         {
163                 static int freq[33];
164                 static int t=0;
165                 int i;
166                 for(i=0; len>(1<<i); i++);
167                 freq[i]++;
168                 t++;
169                 if(1024*1024*1024 % t == 0)
170                         for(i=0; i<32; i++)
171                                 printf("freq < %8d %4d\n", 1<<i, freq[i]);
172         }
173 #endif
174 #ifndef HAVE_MMX1
175         /* PREFETCH has effect even for MOVSB instruction ;) */
176         __asm__ __volatile__ (
177                 PREFETCH" (%0)\n"
178                 PREFETCH" 64(%0)\n"
179                 PREFETCH" 128(%0)\n"
180                 PREFETCH" 192(%0)\n"
181                 PREFETCH" 256(%0)\n"
182                 : : "r" (from) );
183 #endif
184         if(len >= MIN_LEN)
185         {
186           register unsigned long int delta;
187           /* Align destinition to MMREG_SIZE -boundary */
188           delta = ((unsigned long int)to)&(MMREG_SIZE-1);
189           if(delta)
190           {
191             delta=MMREG_SIZE-delta;
192             len -= delta;
193             small_memcpy(to, from, delta);
194           }
195           i = len >> 6; /* len/64 */
196           len&=63;
197         /*
198            This algorithm is top effective when the code consequently
199            reads and writes blocks which have size of cache line.
200            Size of cache line is processor-dependent.
201            It will, however, be a minimum of 32 bytes on any processors.
202            It would be better to have a number of instructions which
203            perform reading and writing to be multiple to a number of
204            processor's decoders, but it's not always possible.
205         */
206 #ifdef HAVE_SSE /* Only P3 (may be Cyrix3) */
207         if(((unsigned long)from) & 15)
208         /* if SRC is misaligned */
209         for(; i>0; i--)
210         {
211                 __asm__ __volatile__ (
212                 PREFETCH" 320(%0)\n"
213                 "movups (%0), %%xmm0\n"
214                 "movups 16(%0), %%xmm1\n"
215                 "movups 32(%0), %%xmm2\n"
216                 "movups 48(%0), %%xmm3\n"
217                 "movntps %%xmm0, (%1)\n"
218                 "movntps %%xmm1, 16(%1)\n"
219                 "movntps %%xmm2, 32(%1)\n"
220                 "movntps %%xmm3, 48(%1)\n"
221                 :: "r" (from), "r" (to) : "memory");
222                 ((const unsigned char *)from)+=64;
223                 ((unsigned char *)to)+=64;
224         }
225         else
226         /*
227            Only if SRC is aligned on 16-byte boundary.
228            It allows to use movaps instead of movups, which required data
229            to be aligned or a general-protection exception (#GP) is generated.
230         */
231         for(; i>0; i--)
232         {
233                 __asm__ __volatile__ (
234                 PREFETCH" 320(%0)\n"
235                 "movaps (%0), %%xmm0\n"
236                 "movaps 16(%0), %%xmm1\n"
237                 "movaps 32(%0), %%xmm2\n"
238                 "movaps 48(%0), %%xmm3\n"
239                 "movntps %%xmm0, (%1)\n"
240                 "movntps %%xmm1, 16(%1)\n"
241                 "movntps %%xmm2, 32(%1)\n"
242                 "movntps %%xmm3, 48(%1)\n"
243                 :: "r" (from), "r" (to) : "memory");
244                 ((const unsigned char *)from)+=64;
245                 ((unsigned char *)to)+=64;
246         }
247 #else
248         /* Align destination at BLOCK_SIZE boundary */
249         for(; ((int)to & (BLOCK_SIZE-1)) && i>0; i--)
250         {
251                 __asm__ __volatile__ (
252 #ifndef HAVE_MMX1
253                 PREFETCH" 320(%0)\n"
254 #endif
255                 "movq (%0), %%mm0\n"
256                 "movq 8(%0), %%mm1\n"
257                 "movq 16(%0), %%mm2\n"
258                 "movq 24(%0), %%mm3\n"
259                 "movq 32(%0), %%mm4\n"
260                 "movq 40(%0), %%mm5\n"
261                 "movq 48(%0), %%mm6\n"
262                 "movq 56(%0), %%mm7\n"
263                 MOVNTQ" %%mm0, (%1)\n"
264                 MOVNTQ" %%mm1, 8(%1)\n"
265                 MOVNTQ" %%mm2, 16(%1)\n"
266                 MOVNTQ" %%mm3, 24(%1)\n"
267                 MOVNTQ" %%mm4, 32(%1)\n"
268                 MOVNTQ" %%mm5, 40(%1)\n"
269                 MOVNTQ" %%mm6, 48(%1)\n"
270                 MOVNTQ" %%mm7, 56(%1)\n"
271                 :: "r" (from), "r" (to) : "memory");
272                 from = (const void *) (((const unsigned char *)from)+64);
273                 to = (void *) (((unsigned char *)to)+64);
274         }
275
276 /*      printf(" %d %d\n", (int)from&1023, (int)to&1023); */
277         /* Pure Assembly cuz gcc is a bit unpredictable ;) */
278 # if 0
279         if(i>=BLOCK_SIZE/64)
280                 asm volatile(
281                         "xorl %%eax, %%eax      \n\t"
282                         ".balign 16             \n\t"
283                         "1:                     \n\t"
284                                 "movl (%0, %%eax), %%ebx        \n\t"
285                                 "movl 32(%0, %%eax), %%ebx      \n\t"
286                                 "movl 64(%0, %%eax), %%ebx      \n\t"
287                                 "movl 96(%0, %%eax), %%ebx      \n\t"
288                                 "addl $128, %%eax               \n\t"
289                                 "cmpl %3, %%eax                 \n\t"
290                                 " jb 1b                         \n\t"
291
292                         "xorl %%eax, %%eax      \n\t"
293
294                                 ".balign 16             \n\t"
295                                 "2:                     \n\t"
296                                 "movq (%0, %%eax), %%mm0\n"
297                                 "movq 8(%0, %%eax), %%mm1\n"
298                                 "movq 16(%0, %%eax), %%mm2\n"
299                                 "movq 24(%0, %%eax), %%mm3\n"
300                                 "movq 32(%0, %%eax), %%mm4\n"
301                                 "movq 40(%0, %%eax), %%mm5\n"
302                                 "movq 48(%0, %%eax), %%mm6\n"
303                                 "movq 56(%0, %%eax), %%mm7\n"
304                                 MOVNTQ" %%mm0, (%1, %%eax)\n"
305                                 MOVNTQ" %%mm1, 8(%1, %%eax)\n"
306                                 MOVNTQ" %%mm2, 16(%1, %%eax)\n"
307                                 MOVNTQ" %%mm3, 24(%1, %%eax)\n"
308                                 MOVNTQ" %%mm4, 32(%1, %%eax)\n"
309                                 MOVNTQ" %%mm5, 40(%1, %%eax)\n"
310                                 MOVNTQ" %%mm6, 48(%1, %%eax)\n"
311                                 MOVNTQ" %%mm7, 56(%1, %%eax)\n"
312                                 "addl $64, %%eax                \n\t"
313                                 "cmpl %3, %%eax         \n\t"
314                                 "jb 2b                          \n\t"
315
316 #if CONFUSION_FACTOR > 0
317         /* a few percent speedup on out of order executing CPUs */
318                         "movl %5, %%eax         \n\t"
319                                 "2:                     \n\t"
320                                 "movl (%0), %%ebx       \n\t"
321                                 "movl (%0), %%ebx       \n\t"
322                                 "movl (%0), %%ebx       \n\t"
323                                 "movl (%0), %%ebx       \n\t"
324                                 "decl %%eax             \n\t"
325                                 " jnz 2b                \n\t"
326 #endif
327
328                         "xorl %%eax, %%eax      \n\t"
329                         "addl %3, %0            \n\t"
330                         "addl %3, %1            \n\t"
331                         "subl %4, %2            \n\t"
332                         "cmpl %4, %2            \n\t"
333                         " jae 1b                \n\t"
334                                 : "+r" (from), "+r" (to), "+r" (i)
335                                 : "r" (BLOCK_SIZE), "i" (BLOCK_SIZE/64), "i" (CONFUSION_FACTOR)
336                                 : "%eax", "%ebx"
337                 );
338 #endif
339
340         for(; i>0; i--)
341         {
342                 __asm__ __volatile__ (
343 #ifndef HAVE_MMX1
344                 PREFETCH" 320(%0)\n"
345 #endif
346                 "movq (%0), %%mm0\n"
347                 "movq 8(%0), %%mm1\n"
348                 "movq 16(%0), %%mm2\n"
349                 "movq 24(%0), %%mm3\n"
350                 "movq 32(%0), %%mm4\n"
351                 "movq 40(%0), %%mm5\n"
352                 "movq 48(%0), %%mm6\n"
353                 "movq 56(%0), %%mm7\n"
354                 MOVNTQ" %%mm0, (%1)\n"
355                 MOVNTQ" %%mm1, 8(%1)\n"
356                 MOVNTQ" %%mm2, 16(%1)\n"
357                 MOVNTQ" %%mm3, 24(%1)\n"
358                 MOVNTQ" %%mm4, 32(%1)\n"
359                 MOVNTQ" %%mm5, 40(%1)\n"
360                 MOVNTQ" %%mm6, 48(%1)\n"
361                 MOVNTQ" %%mm7, 56(%1)\n"
362                 :: "r" (from), "r" (to) : "memory");
363                 from = (const void *) (((const unsigned char *)from)+64);
364                 to = (void *) (((unsigned char *)to)+64);
365         }
366
367 #endif /* Have SSE */
368 #ifdef HAVE_MMX2
369                 /* since movntq is weakly-ordered, a "sfence"
370                  * is needed to become ordered again. */
371                 __asm__ __volatile__ ("sfence":::"memory");
372 #endif
373 #ifndef HAVE_SSE
374                 /* enables to use FPU */
375                 __asm__ __volatile__ (EMMS:::"memory");
376 #endif
377         }
378         /*
379          *      Now do the tail of the block
380          */
381         if(len) small_memcpy(to, from, len);
382         return retval;
383 }
384
385
386 #endif /* #if defined( HAVE_MMX2 ) || defined( HAVE_3DNOW ) || defined( HAVE_MMX ) */