Intel® Integrated Performance Primitives Cryptography Developer Guide for Intel® oneAPI Base Toolkit

Developer Guide

Contents

Function Naming Conventions

Intel IPP Cryptography functions have the same naming conventions for all domains.
Function names in Intel IPP Cryptography have the following general format:
ipp<
data-domain
><
name
>[_<
descriptor
>](<
parameters
>)
The support functions in Intel IPP Cryptography like
ippcpGetCpuFeatures()
 do not need an input data type. These functions have
ippcp
 as a prefix without the data-domain field.

Data-domain

The
data-domain
 element is a single character indicating type of input data. Intel IPP Cryptography supports the following data-domain:
s
one-dimensional operations on signals, vectors, buffers

Parameters

The
parameters
 element specifies the function parameters (arguments).
The order of parameters is as follows:
  • All source operands. Constants follow vectors.
  • All destination operands. Constants follow vectors.
  • Other, operation-specific parameters.
A parameter name has the following conventions:
  • All parameters defined as pointers start with
    p
    , for example,
    pBuffer
    ,
    pSrc
    ; parameters defined as double pointers start with
    pp
    , for example,
    ppData
    . All parameters defined as values start with a lowercase letter, for example,
    length
    ,
    bitSize
    ,
    keyLen
    .
  • Each new part of a parameter name starts with an uppercase character, without underscore; for example,
    pSrc
    ,
    bitSize
    ,
    pResult
    .
  • Each parameter name specifies its functionality. Source parameters are named
    pSrc
     or
    src
    , in some cases followed by names or numbers, for example,
    pSrc2
    ,
    srcLen
    . Output parameters are named
    pDst
     or
    dst
     followed by names or numbers, for example,
    pDst2
    ,
    dstLen
    . For in-place operations, the input/output parameter contains the name
    pSrcDst
     or
    srcDst
    .

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.