.TH "rte_memcpy.h" 3 "Version 25.11.0" "DPDK" \" -*- nroff -*-
.ad l
.nh
.SH NAME
rte_memcpy.h
.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "static void \fBrte_mov16\fP (uint8_t *dst, const uint8_t *src)"
.br
.ti -1c
.RI "static void \fBrte_mov32\fP (uint8_t *dst, const uint8_t *src)"
.br
.ti -1c
.RI "static void \fBrte_mov48\fP (uint8_t *dst, const uint8_t *src)"
.br
.ti -1c
.RI "static void \fBrte_mov64\fP (uint8_t *dst, const uint8_t *src)"
.br
.ti -1c
.RI "static void \fBrte_mov128\fP (uint8_t *dst, const uint8_t *src)"
.br
.ti -1c
.RI "static void \fBrte_mov256\fP (uint8_t *dst, const uint8_t *src)"
.br
.ti -1c
.RI "static void * \fBrte_memcpy\fP (void *dst, const void *src, size_t n)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Functions for vectorised implementation of memcpy()\&. 
.PP
Definition in file \fBrte_memcpy\&.h\fP\&.
.SH "Function Documentation"
.PP 
.SS "void rte_mov16 (uint8_t * dst, const uint8_t * src)\fR [inline]\fP, \fR [static]\fP"
Copy 16 bytes from one location to another using optimised instructions\&. The locations should not overlap\&.

.PP
\fBParameters\fP
.RS 4
\fIdst\fP Pointer to the destination of the data\&. 
.br
\fIsrc\fP Pointer to the source data\&. 
.RE
.PP

.SS "void rte_mov32 (uint8_t * dst, const uint8_t * src)\fR [inline]\fP, \fR [static]\fP"
Copy 32 bytes from one location to another using optimised instructions\&. The locations should not overlap\&.

.PP
\fBParameters\fP
.RS 4
\fIdst\fP Pointer to the destination of the data\&. 
.br
\fIsrc\fP Pointer to the source data\&. 
.RE
.PP

.SS "void rte_mov48 (uint8_t * dst, const uint8_t * src)\fR [inline]\fP, \fR [static]\fP"
Copy 48 bytes from one location to another using optimised instructions\&. The locations should not overlap\&.

.PP
\fBParameters\fP
.RS 4
\fIdst\fP Pointer to the destination of the data\&. 
.br
\fIsrc\fP Pointer to the source data\&. 
.RE
.PP

.SS "void rte_mov64 (uint8_t * dst, const uint8_t * src)\fR [inline]\fP, \fR [static]\fP"
Copy 64 bytes from one location to another using optimised instructions\&. The locations should not overlap\&.

.PP
\fBParameters\fP
.RS 4
\fIdst\fP Pointer to the destination of the data\&. 
.br
\fIsrc\fP Pointer to the source data\&. 
.RE
.PP

.SS "void rte_mov128 (uint8_t * dst, const uint8_t * src)\fR [inline]\fP, \fR [static]\fP"
Copy 128 bytes from one location to another using optimised instructions\&. The locations should not overlap\&.

.PP
\fBParameters\fP
.RS 4
\fIdst\fP Pointer to the destination of the data\&. 
.br
\fIsrc\fP Pointer to the source data\&. 
.RE
.PP

.SS "void rte_mov256 (uint8_t * dst, const uint8_t * src)\fR [inline]\fP, \fR [static]\fP"
Copy 256 bytes from one location to another using optimised instructions\&. The locations should not overlap\&.

.PP
\fBParameters\fP
.RS 4
\fIdst\fP Pointer to the destination of the data\&. 
.br
\fIsrc\fP Pointer to the source data\&. 
.RE
.PP

.SS "void * rte_memcpy (void * dst, const void * src, size_t n)\fR [static]\fP"
Copy bytes from one location to another\&. The locations must not overlap\&.

.PP
\fBNote\fP
.RS 4
This is implemented as a macro, so it's address should not be taken and care is needed as parameter expressions may be evaluated multiple times\&.

.PP
For x86 platforms to enable the AVX-512 memcpy implementation, set -DRTE_MEMCPY_AVX512 macro in CFLAGS, or define the RTE_MEMCPY_AVX512 macro explicitly in the source file before including the rte_memcpy header file\&.
.RE
.PP
\fBParameters\fP
.RS 4
\fIdst\fP Pointer to the destination of the data\&. 
.br
\fIsrc\fP Pointer to the source data\&. 
.br
\fIn\fP Number of bytes to copy\&. 
.RE
.PP
\fBReturns\fP
.RS 4
Pointer to the destination data\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for DPDK from the source code\&.
