dnnl_types.h

Go to the documentation of this file.

/*******************************************************************************
* Copyright 2016-2019 Intel Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*******************************************************************************/


#ifndef DNNL_TYPES_H
#define DNNL_TYPES_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stddef.h>
#include <stdint.h>


typedef struct {
    int major;
    int minor;
    int patch;
    const char *hash;
} dnnl_version_t;

typedef enum {
    dnnl_success = 0,
    dnnl_out_of_memory = 1,
    dnnl_invalid_arguments = 2,
    dnnl_unimplemented = 3,
    dnnl_iterator_ends = 4,
    dnnl_runtime_error = 5,
    dnnl_not_required = 6,
} dnnl_status_t;

typedef enum {
    dnnl_data_type_undef = 0,
    dnnl_f16 = 1,
    dnnl_bf16 = 2,
    dnnl_f32 = 3,
    dnnl_s32 = 4,
    dnnl_s8 = 5,
    dnnl_u8 = 6,
} dnnl_data_type_t;

typedef enum {
    dnnl_format_kind_undef = 0,
    dnnl_format_kind_any,
    dnnl_blocked,
    dnnl_format_kind_wino,
    dnnl_format_kind_rnn_packed,
} dnnl_format_kind_t;

typedef enum {
    dnnl_format_tag_undef = 0,
    dnnl_format_tag_any,

    // Semantic agnostic section
    // The physical order of dimensions is defined by the permutation of the
    // characters, assuming that ab..z defines the natural order.

    // Plain formats

    dnnl_a, 
    dnnl_ab, 
    dnnl_abc, 
    dnnl_abcd, 
    dnnl_abcde, 
    dnnl_abcdef, 

    // Permuted plain formats

    dnnl_abdec, 
    dnnl_acb, 
    dnnl_acbde, 
    dnnl_acdb, 
    dnnl_acdeb, 
    dnnl_ba, 
    dnnl_bac, 
    dnnl_bacd, 
    dnnl_bca, 
    dnnl_bcda, 
    dnnl_bcdea, 
    dnnl_cba, 
    dnnl_cdba, 
    dnnl_cdeba, 
    dnnl_decab, 

    // Opaque blocked formats

    dnnl_Abc16a,
    dnnl_ABc16a16b,
    dnnl_aBc16b,
    dnnl_ABc16b16a,
    dnnl_Abc4a,
    dnnl_aBc4b,
    dnnl_ABc4b16a4b,
    dnnl_ABc4b4a,
    dnnl_ABc8a16b2a,
    dnnl_ABc8a8b,
    dnnl_aBc8b,
    dnnl_ABc8b16a2b,
    dnnl_BAc8a16b2a,
    dnnl_ABc8b8a,
    dnnl_Abcd16a,
    dnnl_ABcd16a16b,
    dnnl_ABcd32a32b,
    dnnl_aBcd16b,
    dnnl_ABcd16b16a,
    dnnl_aBCd16b16c,
    dnnl_aBCd16c16b,
    dnnl_Abcd4a,
    dnnl_aBcd4b,
    dnnl_ABcd4b16a4b,
    dnnl_ABcd4b4a,
    dnnl_aBCd4c16b4c,
    dnnl_aBCd4c4b,
    dnnl_ABcd8a16b2a,
    dnnl_ABcd8a8b,
    dnnl_aBcd8b,
    dnnl_ABcd8b16a2b,
    dnnl_aBCd8b16c2b,
    dnnl_BAcd8a16b2a,
    dnnl_ABcd8b8a,
    dnnl_aBCd8b8c,
    dnnl_aBCd8c16b2c,
    dnnl_ABcde8a16b2a,
    dnnl_aCBd8b16c2b,
    dnnl_aBCd8c8b,
    dnnl_Abcde16a,
    dnnl_ABcde16a16b,
    dnnl_BAcde8a16b2a,
    dnnl_aBcde16b,
    dnnl_ABcde16b16a,
    dnnl_aBCde16b16c,
    dnnl_aBCde16c16b,
    dnnl_aBCde2c8b4c,
    dnnl_Abcde4a,
    dnnl_aBcde4b,
    dnnl_ABcde4b4a,
    dnnl_aBCde4b4c,
    dnnl_aBCde4c16b4c,
    dnnl_aBCde4c4b,
    dnnl_Abcde8a,
    dnnl_ABcde8a8b,
    dnnl_BAcde16b16a,
    dnnl_aBcde8b,
    dnnl_ABcde8b16a2b,
    dnnl_aBCde8b16c2b,
    dnnl_aCBde8b16c2b,
    dnnl_ABcde8b8a,
    dnnl_aBCde8b8c,
    dnnl_ABcd4a8b8a4b,
    dnnl_ABcd2a8b8a2b,
    dnnl_aBCde4b8c8b4c,
    dnnl_aBCde2b8c8b2c,
    dnnl_aBCde8c16b2c,
    dnnl_aBCde8c8b,
    dnnl_aBcdef16b,
    dnnl_aBCdef16b16c,
    dnnl_aBCdef16c16b,
    dnnl_aBcdef4b,
    dnnl_aBCdef4c4b,
    dnnl_aBCdef8b8c,
    dnnl_aBCdef8c16b2c,
    dnnl_aBCdef8b16c2b,
    dnnl_aCBdef8b16c2b,
    dnnl_aBCdef8c8b,
    dnnl_aBdc16b,
    dnnl_aBdc4b,
    dnnl_aBdc8b,
    dnnl_aBdec16b,
    dnnl_aBdec32b,
    dnnl_aBdec4b,
    dnnl_aBdec8b,
    dnnl_aBdefc16b,
    dnnl_aCBdef16c16b,
    dnnl_aBdefc4b,
    dnnl_aBdefc8b,
    dnnl_Abcdef16a,
    dnnl_Acb16a,
    dnnl_Acb4a,
    dnnl_Acb8a,
    dnnl_aCBd16b16c,
    dnnl_aCBd16c16b,
    dnnl_aCBde16b16c,
    dnnl_aCBde16c16b,
    dnnl_Acdb16a,
    dnnl_Acdb32a,
    dnnl_Acdb4a,
    dnnl_Acdb8a,
    dnnl_Acdeb16a,
    dnnl_Acdeb4a,
    dnnl_Acdeb8a,
    dnnl_BAc16a16b,
    dnnl_BAc16b16a,
    dnnl_BAcd16a16b,
    dnnl_BAcd16b16a,

    dnnl_format_tag_last,

    // Aliases

    dnnl_x = dnnl_a,
    dnnl_nc = dnnl_ab,
    dnnl_cn = dnnl_ba,
    dnnl_tn = dnnl_ab,
    dnnl_nt = dnnl_ba,
    dnnl_ncw = dnnl_abc,
    dnnl_nwc = dnnl_acb,
    dnnl_nchw = dnnl_abcd,
    dnnl_nhwc = dnnl_acdb,
    dnnl_chwn = dnnl_bcda,
    dnnl_ncdhw = dnnl_abcde,
    dnnl_ndhwc = dnnl_acdeb,

    dnnl_oi = dnnl_ab,
    dnnl_io = dnnl_ba,
    dnnl_oiw = dnnl_abc,
    dnnl_owi = dnnl_acb,
    dnnl_wio = dnnl_cba,
    dnnl_iwo = dnnl_bca,
    dnnl_oihw = dnnl_abcd,
    dnnl_hwio = dnnl_cdba,
    dnnl_ohwi = dnnl_acdb,
    dnnl_ihwo = dnnl_bcda,
    dnnl_iohw = dnnl_bacd,
    dnnl_oidhw = dnnl_abcde,
    dnnl_dhwio = dnnl_cdeba,
    dnnl_odhwi = dnnl_acdeb,
    dnnl_idhwo = dnnl_bcdea,

    dnnl_goiw = dnnl_abcd,
    dnnl_goihw = dnnl_abcde,
    dnnl_hwigo = dnnl_decab,
    dnnl_giohw = dnnl_acbde,
    dnnl_goidhw = dnnl_abcdef,

    dnnl_tnc = dnnl_abc,
    dnnl_ntc = dnnl_bac,
    dnnl_ldnc = dnnl_abcd,
    dnnl_ldigo = dnnl_abcde,
    dnnl_ldgoi = dnnl_abdec,
    dnnl_ldgo = dnnl_abcd,

    // Opaque data types, are not to be used explicitly

    // data

    dnnl_nCdhw16c = dnnl_aBcde16b,
    dnnl_nCdhw4c = dnnl_aBcde4b,
    dnnl_nCdhw8c = dnnl_aBcde8b,
    dnnl_nChw16c = dnnl_aBcd16b,
    dnnl_nChw4c = dnnl_aBcd4b,
    dnnl_nChw8c = dnnl_aBcd8b,
    dnnl_nCw16c = dnnl_aBc16b,
    dnnl_nCw4c = dnnl_aBc4b,
    dnnl_nCw8c = dnnl_aBc8b,
    dnnl_NCw16n16c = dnnl_ABc16a16b,
    dnnl_NCdhw16n16c = dnnl_ABcde16a16b,
    dnnl_NChw16n16c = dnnl_ABcd16a16b,
    dnnl_NChw32n32c = dnnl_ABcd32a32b,

    // weights, 3D
    dnnl_IOw16o16i = dnnl_BAc16a16b,
    dnnl_IOw16i16o = dnnl_BAc16b16a,
    dnnl_OIw16i16o = dnnl_ABc16b16a,
    dnnl_OIw16o16i = dnnl_ABc16a16b,
    dnnl_Oiw16o = dnnl_Abc16a,
    dnnl_OIw4i16o4i = dnnl_ABc4b16a4b,
    dnnl_OIw4i4o = dnnl_ABc4b4a,
    dnnl_Oiw4o = dnnl_Abc4a,
    dnnl_OIw8i16o2i = dnnl_ABc8b16a2b,
    dnnl_OIw8i8o = dnnl_ABc8b8a,
    dnnl_OIw8o16i2o = dnnl_ABc8a16b2a,
    dnnl_IOw8o16i2o = dnnl_BAc8a16b2a,
    dnnl_OIw8o8i = dnnl_ABc8a8b,
    dnnl_Owi16o = dnnl_Acb16a,
    dnnl_Owi4o = dnnl_Acb4a,
    dnnl_Owi8o = dnnl_Acb8a,

    // weights, 4D
    dnnl_IOhw16i16o = dnnl_BAcd16b16a,
    dnnl_IOhw16o16i = dnnl_BAcd16a16b,
    dnnl_Ohwi16o = dnnl_Acdb16a,
    dnnl_Ohwi32o = dnnl_Acdb32a,
    dnnl_Ohwi4o = dnnl_Acdb4a,
    dnnl_Ohwi8o = dnnl_Acdb8a,
    dnnl_OIhw16i16o = dnnl_ABcd16b16a,
    dnnl_OIhw16o16i = dnnl_ABcd16a16b,
    dnnl_Oihw16o = dnnl_Abcd16a,
    dnnl_OIhw4i16o4i = dnnl_ABcd4b16a4b,
    dnnl_OIhw4i4o = dnnl_ABcd4b4a,
    dnnl_Oihw4o = dnnl_Abcd4a,
    dnnl_OIhw8i16o2i = dnnl_ABcd8b16a2b,
    dnnl_OIhw8i8o = dnnl_ABcd8b8a,
    dnnl_OIhw8o16i2o = dnnl_ABcd8a16b2a,
    dnnl_IOhw8o16i2o = dnnl_BAcd8a16b2a,
    dnnl_OIhw8o8i = dnnl_ABcd8a8b,

    // weights, 5D
    dnnl_Odhwi16o = dnnl_Acdeb16a,
    dnnl_Odhwi4o = dnnl_Acdeb4a,
    dnnl_Odhwi8o = dnnl_Acdeb8a,
    dnnl_OIdhw16i16o = dnnl_ABcde16b16a,
    dnnl_OIdhw16o16i = dnnl_ABcde16a16b,
    dnnl_Oidhw16o = dnnl_Abcde16a,
    dnnl_OIdhw4i4o = dnnl_ABcde4b4a,
    dnnl_Oidhw4o = dnnl_Abcde4a,
    dnnl_OIdhw8i16o2i = dnnl_ABcde8b16a2b,
    dnnl_OIdhw8i8o = dnnl_ABcde8b8a,
    dnnl_OIdhw8o16i2o = dnnl_ABcde8a16b2a,
    dnnl_IOdhw8o16i2o = dnnl_BAcde8a16b2a,
    dnnl_OIdhw8o8i = dnnl_ABcde8a8b,
    dnnl_IOdhw16i16o = dnnl_BAcde16b16a,

    // weights w/ groups, 3D
    dnnl_Goiw16g = dnnl_Abcd16a,
    dnnl_gIOw16o16i = dnnl_aCBd16b16c,
    dnnl_gIOw16i16o = dnnl_aCBd16c16b,
    dnnl_gOIw16i16o = dnnl_aBCd16c16b,
    dnnl_gOIw16o16i = dnnl_aBCd16b16c,
    dnnl_gOiw16o = dnnl_aBcd16b,
    dnnl_gOIw4i16o4i = dnnl_aBCd4c16b4c,
    dnnl_gOIw4i4o = dnnl_aBCd4c4b,
    dnnl_gOiw4o = dnnl_aBcd4b,
    dnnl_gOIw8i16o2i = dnnl_aBCd8c16b2c,
    dnnl_gOIw8i8o = dnnl_aBCd8c8b,
    dnnl_gOIw8o16i2o = dnnl_aBCd8b16c2b,
    dnnl_gIOw8o16i2o = dnnl_aCBd8b16c2b,
    dnnl_gOIw8o8i = dnnl_aBCd8b8c,
    dnnl_gOwi16o = dnnl_aBdc16b,
    dnnl_gOwi4o = dnnl_aBdc4b,
    dnnl_gOwi8o = dnnl_aBdc8b,

    // weights w/ groups, 4D
    dnnl_gIOhw16i16o = dnnl_aCBde16c16b,
    dnnl_gIOhw16o16i = dnnl_aCBde16b16c,
    dnnl_gOhwi16o = dnnl_aBdec16b,
    dnnl_gOhwi32o = dnnl_aBdec32b,
    dnnl_gOhwi4o = dnnl_aBdec4b,
    dnnl_gOhwi8o = dnnl_aBdec8b,
    dnnl_Goihw16g = dnnl_Abcde16a,
    dnnl_gOIhw16i16o = dnnl_aBCde16c16b,
    dnnl_gOIhw16o16i = dnnl_aBCde16b16c,
    dnnl_gOihw16o = dnnl_aBcde16b,
    dnnl_gOIhw2i8o4i = dnnl_aBCde2c8b4c,
    dnnl_gOIhw4i16o4i = dnnl_aBCde4c16b4c,
    dnnl_gOIhw4i4o = dnnl_aBCde4c4b,
    dnnl_gOIhw4o4i = dnnl_aBCde4b4c,
    dnnl_gOihw4o = dnnl_aBcde4b,
    dnnl_Goihw8g = dnnl_Abcde8a,
    dnnl_gOIhw8i16o2i = dnnl_aBCde8c16b2c,
    dnnl_gOIhw8i8o = dnnl_aBCde8c8b,
    dnnl_gOIhw8o16i2o = dnnl_aBCde8b16c2b,
    dnnl_gIOhw8o16i2o = dnnl_aCBde8b16c2b,
    dnnl_gOIhw8o8i = dnnl_aBCde8b8c,

    dnnl_OIhw4o8i8o4i = dnnl_ABcd4a8b8a4b,
    dnnl_OIhw2o8i8o2i = dnnl_ABcd2a8b8a2b,
    dnnl_gOIhw4o8i8o4i = dnnl_aBCde4b8c8b4c,
    dnnl_gOIhw2o8i8o2i = dnnl_aBCde2b8c8b2c,

    // weights w/ groups, 6D
    dnnl_gIOdhw16i16o = dnnl_aCBdef16c16b,
    dnnl_gOdhwi16o = dnnl_aBdefc16b,
    dnnl_gOdhwi4o = dnnl_aBdefc4b,
    dnnl_gOdhwi8o = dnnl_aBdefc8b,
    dnnl_gOIdhw16i16o = dnnl_aBCdef16c16b,
    dnnl_gOIdhw16o16i = dnnl_aBCdef16b16c,
    dnnl_gOidhw16o = dnnl_aBcdef16b,
    dnnl_gOIdhw4i4o = dnnl_aBCdef4c4b,
    dnnl_gOidhw4o = dnnl_aBcdef4b,
    dnnl_gOIdhw8i16o2i = dnnl_aBCdef8c16b2c,
    dnnl_gOIdhw8i8o = dnnl_aBCdef8c8b,
    dnnl_gOIdhw8o16i2o = dnnl_aBCdef8b16c2b,
    dnnl_gIOdhw8o16i2o = dnnl_aCBdef8b16c2b,
    dnnl_gOIdhw8o8i = dnnl_aBCdef8b8c,
    dnnl_Goidhw16g = dnnl_Abcdef16a,
} dnnl_format_tag_t;

typedef enum {
    // TODO: suggest renames
    dnnl_prop_kind_undef = 0,
    dnnl_forward_training = 64,
    dnnl_forward_inference = 96,
    dnnl_forward_scoring = dnnl_forward_inference,
    dnnl_forward = dnnl_forward_training,
    dnnl_backward = 128,
    dnnl_backward_data = 160,
    dnnl_backward_weights = 192,
    dnnl_backward_bias = 193,
} dnnl_prop_kind_t;

typedef enum {
    dnnl_undefined_primitive,
    dnnl_reorder,
    dnnl_shuffle,
    dnnl_concat,
    dnnl_sum,
    dnnl_convolution,
    dnnl_deconvolution,
    dnnl_eltwise,
    dnnl_softmax,
    dnnl_pooling,
    dnnl_lrn,
    dnnl_batch_normalization,
    dnnl_layer_normalization,
    dnnl_inner_product,
    dnnl_rnn,
    dnnl_gemm,
    dnnl_binary,
} dnnl_primitive_kind_t;

typedef enum {
    dnnl_alg_kind_undef,
    dnnl_convolution_direct = 0x1,
    dnnl_convolution_winograd = 0x2,
    dnnl_convolution_auto = 0x3,
    dnnl_deconvolution_direct = 0xa,
    dnnl_deconvolution_winograd = 0xb,
    dnnl_eltwise_relu = 0x1f,
    dnnl_eltwise_tanh = 0x2f,
    dnnl_eltwise_elu = 0x3f,
    dnnl_eltwise_square = 0x4f,
    dnnl_eltwise_abs = 0x5f,
    dnnl_eltwise_sqrt = 0x6f,
    dnnl_eltwise_linear = 0x7f,
    dnnl_eltwise_bounded_relu = 0x8f,
    dnnl_eltwise_soft_relu = 0x9f,
    dnnl_eltwise_logistic = 0xaf,
    dnnl_eltwise_exp = 0xbf,
    dnnl_eltwise_gelu = 0xcf,
    dnnl_eltwise_swish = 0xdf,
    dnnl_pooling_max = 0x1ff,
    dnnl_pooling_avg_include_padding = 0x2ff,
    dnnl_pooling_avg_exclude_padding = 0x3ff,
    dnnl_pooling_avg = dnnl_pooling_avg_exclude_padding,
    dnnl_lrn_across_channels = 0xaff,
    dnnl_lrn_within_channel = 0xbff,
    dnnl_vanilla_rnn = 0x1fff,
    dnnl_vanilla_lstm = 0x2fff,
    dnnl_vanilla_gru = 0x3fff,
    dnnl_lbr_gru = 0x4fff,
    dnnl_binary_add = 0x1fff0,
    dnnl_binary_mul = 0x1fff1,
} dnnl_alg_kind_t;

typedef enum {
    dnnl_use_global_stats = 0x1U,

    dnnl_use_scaleshift = 0x2U,

    dnnl_fuse_norm_relu = 0x4U,
} dnnl_normalization_flags_t;



#define DNNL_MAX_NDIMS 12

typedef int64_t dnnl_dim_t;

typedef dnnl_dim_t dnnl_dims_t[DNNL_MAX_NDIMS];

typedef struct {
    dnnl_dims_t strides;
    // Innermost section
    // ASSUMPTION: the innermost blocks are always dense
    int inner_nblks;
    dnnl_dims_t inner_blks;
    dnnl_dims_t inner_idxs;
} dnnl_blocking_desc_t;

typedef enum {
    dnnl_wino_undef = 0,
    // Tensors of weights for 2x3 winograd convolutions.
    dnnl_wino_wei_aaOIoi, 
    dnnl_wino_wei_aaOio, 
    dnnl_wino_wei_aaOBiOo, 
    // Tensor of weights for 4x3 convolution.
    dnnl_wino_wei_OBaaIBOIio 
} dnnl_wino_memory_format_t;

typedef struct {
    dnnl_wino_memory_format_t wino_format;
    int r;
    int alpha;
    int ic;
    int oc;
    int ic_block;
    int oc_block;
    int ic2_block;
    int oc2_block;
    float adj_scale;
    size_t size;
} dnnl_wino_desc_t;

typedef enum {
    dnnl_packed_format_undef = 0,
    dnnl_ldigo_p,
    dnnl_ldgoi_p
} dnnl_rnn_packed_memory_format_t;

#define DNNL_RNN_MAX_N_PARTS 4

typedef struct {
    dnnl_rnn_packed_memory_format_t format;
    int n_parts;
    int n;
    int ldb;
    int parts[DNNL_RNN_MAX_N_PARTS];
    size_t part_pack_size[DNNL_RNN_MAX_N_PARTS];
    unsigned pack_part[DNNL_RNN_MAX_N_PARTS];
    size_t offset_compensation;
    size_t size;
    char reserved[200];
} dnnl_rnn_packed_desc_t;

typedef enum {
    dnnl_memory_extra_flag_none = 0x0U,
    dnnl_memory_extra_flag_compensation_conv_s8s8 = 0x1U,
    dnnl_memory_extra_flag_scale_adjust = 0x2U,
    dnnl_memory_extra_flag_gpu_rnn_u8s8_compensation = 0x4U,
} dnnl_memory_extra_flags_t;

typedef struct {
    uint64_t flags;
    int compensation_mask;
    float scale_adjust;
    char reserved[64];
} dnnl_memory_extra_desc_t;

typedef struct {
    int ndims;
    dnnl_dims_t dims;

    dnnl_data_type_t data_type;

    dnnl_dims_t padded_dims;

    dnnl_dims_t padded_offsets;

    dnnl_dim_t offset0;

    dnnl_format_kind_t format_kind;
    union {
        dnnl_blocking_desc_t blocking;
        dnnl_wino_desc_t wino_desc;
        dnnl_rnn_packed_desc_t rnn_packed_desc;
        // ... other descriptions possible
    } format_desc;

    dnnl_memory_extra_desc_t extra;
} dnnl_memory_desc_t;

struct dnnl_memory;

typedef struct dnnl_memory *dnnl_memory_t;

typedef const struct dnnl_memory *const_dnnl_memory_t;

#define DNNL_MEMORY_NONE (NULL)
#define DNNL_MEMORY_ALLOCATE ((void *)(size_t)-1)



typedef void *dnnl_op_desc_t;
typedef const void *const_dnnl_op_desc_t;

typedef struct {
    dnnl_primitive_kind_t primitive_kind;
    dnnl_prop_kind_t prop_kind;
    dnnl_alg_kind_t alg_kind;
    dnnl_memory_desc_t src_desc;
    dnnl_memory_desc_t diff_src_desc;
    dnnl_memory_desc_t weights_desc;
    dnnl_memory_desc_t diff_weights_desc;
    dnnl_memory_desc_t bias_desc;
    dnnl_memory_desc_t diff_bias_desc;
    dnnl_memory_desc_t dst_desc;
    dnnl_memory_desc_t diff_dst_desc;
    dnnl_dims_t strides;
    dnnl_dims_t dilates;
    dnnl_dims_t padding[2];
    dnnl_data_type_t accum_data_type;
} dnnl_convolution_desc_t;

typedef dnnl_convolution_desc_t dnnl_deconvolution_desc_t;

typedef struct {
    dnnl_primitive_kind_t primitive_kind;
    dnnl_prop_kind_t prop_kind;
    dnnl_memory_desc_t data_desc;
    int axis;
    dnnl_dim_t group_size;
} dnnl_shuffle_desc_t;

typedef struct {
    dnnl_primitive_kind_t primitive_kind;
    dnnl_prop_kind_t prop_kind;
    dnnl_alg_kind_t alg_kind;
    dnnl_memory_desc_t data_desc;
    dnnl_memory_desc_t diff_data_desc;
    float alpha, beta;
} dnnl_eltwise_desc_t;

typedef struct {
    dnnl_primitive_kind_t primitive_kind;
    dnnl_prop_kind_t prop_kind;
    dnnl_memory_desc_t data_desc;
    dnnl_memory_desc_t diff_desc;
    int softmax_axis;
} dnnl_softmax_desc_t;

typedef struct {
    dnnl_primitive_kind_t primitive_kind;
    dnnl_prop_kind_t prop_kind;
    dnnl_alg_kind_t alg_kind;
    dnnl_memory_desc_t src_desc;
    dnnl_memory_desc_t diff_src_desc;
    dnnl_memory_desc_t dst_desc;
    dnnl_memory_desc_t diff_dst_desc;
    dnnl_dims_t strides;
    dnnl_dims_t kernel;
    dnnl_dims_t padding[2];
    dnnl_data_type_t accum_data_type;
} dnnl_pooling_desc_t;

typedef struct {
    dnnl_primitive_kind_t primitive_kind;
    dnnl_prop_kind_t prop_kind;
    dnnl_alg_kind_t alg_kind;
    dnnl_memory_desc_t data_desc;
    dnnl_memory_desc_t diff_data_desc;
    dnnl_dim_t local_size;
    float lrn_alpha;
    float lrn_beta;
    float lrn_k;
} dnnl_lrn_desc_t;

typedef struct {
    dnnl_primitive_kind_t primitive_kind;
    dnnl_prop_kind_t prop_kind;
    dnnl_memory_desc_t data_desc;
    dnnl_memory_desc_t diff_data_desc;
    dnnl_memory_desc_t data_scaleshift_desc;
    dnnl_memory_desc_t diff_data_scaleshift_desc;
    dnnl_memory_desc_t stat_desc;
    float batch_norm_epsilon;
    unsigned flags;
} dnnl_batch_normalization_desc_t;

typedef struct {
    dnnl_primitive_kind_t primitive_kind;
    dnnl_prop_kind_t prop_kind;
    dnnl_memory_desc_t data_desc;
    dnnl_memory_desc_t diff_data_desc;
    dnnl_memory_desc_t data_scaleshift_desc;
    dnnl_memory_desc_t diff_data_scaleshift_desc;
    dnnl_memory_desc_t stat_desc;
    float layer_norm_epsilon;
    unsigned flags;
} dnnl_layer_normalization_desc_t;

typedef struct {
    dnnl_primitive_kind_t primitive_kind;
    dnnl_prop_kind_t prop_kind;
    dnnl_memory_desc_t src_desc;
    dnnl_memory_desc_t diff_src_desc;
    dnnl_memory_desc_t weights_desc;
    dnnl_memory_desc_t diff_weights_desc;
    dnnl_memory_desc_t bias_desc;
    dnnl_memory_desc_t diff_bias_desc;
    dnnl_memory_desc_t dst_desc;
    dnnl_memory_desc_t diff_dst_desc;
    dnnl_data_type_t accum_data_type;
} dnnl_inner_product_desc_t;

typedef enum { dnnl_rnn_flags_undef = 0x0 } dnnl_rnn_flags_t;

typedef enum {
    dnnl_unidirectional_left2right,
    dnnl_unidirectional_right2left,
    dnnl_bidirectional_concat,
    dnnl_bidirectional_sum,
    dnnl_unidirectional = dnnl_unidirectional_left2right,
} dnnl_rnn_direction_t;

typedef struct {
    dnnl_primitive_kind_t primitive_kind;
    dnnl_prop_kind_t prop_kind;
    dnnl_alg_kind_t cell_kind;
    dnnl_rnn_direction_t direction;
    dnnl_memory_desc_t src_layer_desc;
    dnnl_memory_desc_t src_iter_desc;
    dnnl_memory_desc_t src_iter_c_desc;
    dnnl_memory_desc_t weights_layer_desc;
    dnnl_memory_desc_t weights_iter_desc;
    dnnl_memory_desc_t bias_desc;
    dnnl_memory_desc_t dst_layer_desc;
    dnnl_memory_desc_t dst_iter_desc;
    dnnl_memory_desc_t dst_iter_c_desc;
    dnnl_memory_desc_t placeholder_desc;
    dnnl_memory_desc_t placeholder2_desc;

    dnnl_memory_desc_t diff_src_layer_desc;
    dnnl_memory_desc_t diff_src_iter_desc;
    dnnl_memory_desc_t diff_src_iter_c_desc;
    dnnl_memory_desc_t diff_weights_layer_desc;
    dnnl_memory_desc_t diff_weights_iter_desc;
    dnnl_memory_desc_t diff_bias_desc;
    dnnl_memory_desc_t diff_dst_layer_desc;
    dnnl_memory_desc_t diff_dst_iter_desc;
    dnnl_memory_desc_t diff_dst_iter_c_desc;
    dnnl_memory_desc_t diff_placeholder_desc;
    dnnl_memory_desc_t diff_placeholder2_desc;

    unsigned int flags;
    dnnl_alg_kind_t activation_kind;
    float alpha;
    float beta;

} dnnl_rnn_desc_t;

typedef struct {
    dnnl_primitive_kind_t primitive_kind;
    dnnl_alg_kind_t alg_kind;
    dnnl_memory_desc_t src_desc[2];
    dnnl_memory_desc_t dst_desc;
} dnnl_binary_desc_t;



typedef enum {
    dnnl_any_engine,
    dnnl_cpu,
    dnnl_gpu,
} dnnl_engine_kind_t;

struct dnnl_engine;
typedef struct dnnl_engine *dnnl_engine_t;
#if 0
// FIXME: looks like this never happens
typedef const struct dnnl_engine *const_dnnl_engine_t;
#endif



struct dnnl_primitive_desc_iterator;

typedef struct dnnl_primitive_desc_iterator *dnnl_primitive_desc_iterator_t;

typedef const struct dnnl_primitive_desc_iterator
        *const_dnnl_primitive_desc_iterator_t;



struct dnnl_primitive_desc;

typedef struct dnnl_primitive_desc *dnnl_primitive_desc_t;

typedef const struct dnnl_primitive_desc *const_dnnl_primitive_desc_t;



typedef enum {
    dnnl_scratchpad_mode_library,
    dnnl_scratchpad_mode_user,
} dnnl_scratchpad_mode_t;

struct dnnl_primitive_attr;

typedef struct dnnl_primitive_attr *dnnl_primitive_attr_t;

typedef const struct dnnl_primitive_attr *const_dnnl_primitive_attr_t;

struct dnnl_post_ops;

typedef struct dnnl_post_ops *dnnl_post_ops_t;

typedef const struct dnnl_post_ops *const_dnnl_post_ops_t;



struct dnnl_primitive;
typedef struct dnnl_primitive *dnnl_primitive_t;
typedef const struct dnnl_primitive *const_dnnl_primitive_t;


#define DNNL_ARG_SRC_0 1
#define DNNL_ARG_SRC DNNL_ARG_SRC_0
#define DNNL_ARG_SRC_LAYER DNNL_ARG_SRC_0
#define DNNL_ARG_FROM DNNL_ARG_SRC_0

#define DNNL_ARG_SRC_1 2
#define DNNL_ARG_SRC_ITER DNNL_ARG_SRC_1

#define DNNL_ARG_SRC_2 3
#define DNNL_ARG_SRC_ITER_C DNNL_ARG_SRC_2

#define DNNL_ARG_DST_0 17
#define DNNL_ARG_DST DNNL_ARG_DST_0
#define DNNL_ARG_TO DNNL_ARG_DST_0
#define DNNL_ARG_DST_LAYER DNNL_ARG_DST_0

#define DNNL_ARG_DST_1 18
#define DNNL_ARG_DST_ITER DNNL_ARG_DST_1

#define DNNL_ARG_DST_2 19
#define DNNL_ARG_DST_ITER_C DNNL_ARG_DST_2

#define DNNL_ARG_WEIGHTS_0 33
#define DNNL_ARG_WEIGHTS DNNL_ARG_WEIGHTS_0
#define DNNL_ARG_SCALE_SHIFT DNNL_ARG_WEIGHTS_0
#define DNNL_ARG_WEIGHTS_LAYER DNNL_ARG_WEIGHTS_0

#define DNNL_ARG_WEIGHTS_1 34
#define DNNL_ARG_WEIGHTS_ITER DNNL_ARG_WEIGHTS_1

#define DNNL_ARG_BIAS 41

#define DNNL_ARG_MEAN 49
#define DNNL_ARG_VARIANCE 50

#define DNNL_ARG_WORKSPACE 64
#define DNNL_ARG_SCRATCHPAD 80

#define DNNL_ARG_DIFF_SRC_0 129
#define DNNL_ARG_DIFF_SRC DNNL_ARG_DIFF_SRC_0
#define DNNL_ARG_DIFF_SRC_LAYER DNNL_ARG_DIFF_SRC_0

#define DNNL_ARG_DIFF_SRC_1 130
#define DNNL_ARG_DIFF_SRC_ITER DNNL_ARG_DIFF_SRC_1

#define DNNL_ARG_DIFF_SRC_2 131
#define DNNL_ARG_DIFF_SRC_ITER_C DNNL_ARG_DIFF_SRC_2

#define DNNL_ARG_DIFF_DST_0 145
#define DNNL_ARG_DIFF_DST DNNL_ARG_DIFF_DST_0
#define DNNL_ARG_DIFF_DST_LAYER DNNL_ARG_DIFF_DST_0

#define DNNL_ARG_DIFF_DST_1 146
#define DNNL_ARG_DIFF_DST_ITER DNNL_ARG_DIFF_DST_1

#define DNNL_ARG_DIFF_DST_2 147
#define DNNL_ARG_DIFF_DST_ITER_C DNNL_ARG_DIFF_DST_2

#define DNNL_ARG_DIFF_WEIGHTS_0 161
#define DNNL_ARG_DIFF_WEIGHTS DNNL_ARG_DIFF_WEIGHTS_0
#define DNNL_ARG_DIFF_SCALE_SHIFT DNNL_ARG_DIFF_WEIGHTS_0
#define DNNL_ARG_DIFF_WEIGHTS_LAYER DNNL_ARG_DIFF_WEIGHTS_0

#define DNNL_ARG_DIFF_WEIGHTS_1 162
#define DNNL_ARG_DIFF_WEIGHTS_ITER DNNL_ARG_DIFF_WEIGHTS_1

#define DNNL_ARG_DIFF_BIAS 169

#define DNNL_ARG_MULTIPLE_SRC 1024
#define DNNL_ARG_MULTIPLE_DST 2048


typedef struct {
    int arg; 
    dnnl_memory_t memory; 
} dnnl_exec_arg_t;



typedef enum {
    dnnl_query_undef = 0, 

    dnnl_query_engine, 
    dnnl_query_primitive_kind, 

    dnnl_query_num_of_inputs_s32, 
    dnnl_query_num_of_outputs_s32, 

    dnnl_query_time_estimate_f64, 
    dnnl_query_memory_consumption_s64, 

    dnnl_query_scratchpad_engine, 

    dnnl_query_impl_info_str, 

    dnnl_query_reorder_src_engine, 
    dnnl_query_reorder_dst_engine, 

    dnnl_query_prop_kind, 

    // memory and op descriptor section
    dnnl_query_some_d = 64, 
    dnnl_query_op_d, 
    dnnl_query_convolution_d, 
    dnnl_query_deconvolution_d, 
    dnnl_query_shuffle_d, 
    dnnl_query_eltwise_d, 
    dnnl_query_softmax_d, 
    dnnl_query_pooling_d, 
    dnnl_query_lrn_d, 
    dnnl_query_batch_normalization_d, 
    dnnl_query_layer_normalization_d, 
    dnnl_query_inner_product_d, 
    dnnl_query_rnn_d, 
    dnnl_query_gemm_d, 
    dnnl_query_binary_d, 

    // memory descriptor section
    dnnl_query_some_md = 128, 
    dnnl_query_src_md, 
    dnnl_query_diff_src_md, 
    dnnl_query_weights_md, 
    dnnl_query_diff_weights_md, 
    dnnl_query_dst_md, 
    dnnl_query_diff_dst_md, 
    dnnl_query_workspace_md, 
    dnnl_query_scratchpad_md, 
} dnnl_query_t;



typedef enum {
    dnnl_stream_default_order = 0x1U,
    dnnl_stream_in_order = 0x2U,
    dnnl_stream_out_of_order = 0x4U,
    dnnl_stream_default_flags = dnnl_stream_default_order,
} dnnl_stream_flags_t;

struct dnnl_stream;
typedef struct dnnl_stream *dnnl_stream_t;
typedef const struct dnnl_stream *const_dnnl_stream_t;


#ifdef __cplusplus
}
#endif

#endif