ocf_def.h

Go to the documentation of this file.

/*
 * Copyright(c) 2012-2020 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause-Clear
 */


#ifndef __OCF_DEF_H__
#define __OCF_DEF_H__

#include "ocf_cfg.h"
#define OCF_CACHE_ID_MIN 1

#define OCF_CACHE_ID_MAX 16384

#define OCF_CACHE_ID_INVALID 0

#define OCF_CACHE_SIZE_MIN      (20 * MiB)

#define OCF_CACHE_NAME_SIZE 32

#define OCF_CACHE_FALLBACK_PT_INACTIVE  0

#define OCF_CACHE_FALLBACK_PT_MIN_ERROR_THRESHOLD       \
        OCF_CACHE_FALLBACK_PT_INACTIVE

#define OCF_CACHE_FALLBACK_PT_MAX_ERROR_THRESHOLD       1000000

#define OCF_CORE_MAX OCF_CONFIG_MAX_CORES

#define OCF_CORE_ID_MIN 0

#define OCF_CORE_ID_MAX (OCF_CORE_MAX - 1)

#define OCF_CORE_ID_INVALID OCF_CORE_MAX

#define OCF_CORE_NAME_SIZE 32

#define OCF_SEQ_NO_MIN 1

#define OCF_SEQ_NO_MAX (65535UL)
/*
 * Invalid value of core sequence number
 */
#define OCF_SEQ_NO_INVALID 0

#define KiB (1ULL << 10)
#define MiB (1ULL << 20)
#define GiB (1ULL << 30)

#if OCF_CONFIG_DEBUG_STATS == 1

#define OCF_DEBUG_STATS
#endif

typedef enum {
        ocf_cache_state_running = 0,     

        ocf_cache_state_stopping = 1,    

        ocf_cache_state_initializing = 2, 

        ocf_cache_state_incomplete = 3, 

        ocf_cache_state_max              

} ocf_cache_state_t;

typedef enum {
        ocf_core_state_active = 0,
        ocf_core_state_inactive,
        ocf_core_state_max,
} ocf_core_state_t;


typedef enum {
        ocf_cache_mode_wt = 0,
        ocf_cache_mode_wb,
        ocf_cache_mode_wa,
        ocf_cache_mode_pt,
        ocf_cache_mode_wi,
        ocf_cache_mode_wo,
        ocf_cache_mode_max,
        ocf_cache_mode_default = ocf_cache_mode_wt,
        ocf_cache_mode_none = -1,
} ocf_cache_mode_t;

#define OCF_SEQ_CUTOFF_MAX_STREAMS 256

typedef enum {
        ocf_seq_cutoff_policy_always = 0,
        ocf_seq_cutoff_policy_full,
        ocf_seq_cutoff_policy_never,
        ocf_seq_cutoff_policy_max,
        ocf_seq_cutoff_policy_default = ocf_seq_cutoff_policy_full,
} ocf_seq_cutoff_policy;

typedef enum {
        ocf_eviction_lru = 0,
        ocf_eviction_max,
        ocf_eviction_default = ocf_eviction_lru,
} ocf_eviction_t;

typedef enum {
        ocf_promotion_always = 0,
        ocf_promotion_nhit,
        ocf_promotion_max,
        ocf_promotion_default = ocf_promotion_always,
} ocf_promotion_t;

typedef enum {
        ocf_cleaning_nop = 0,
        ocf_cleaning_alru,
        ocf_cleaning_acp,
        ocf_cleaning_max,
        ocf_cleaning_default = ocf_cleaning_alru,
} ocf_cleaning_t;

typedef enum {
        ocf_cache_line_size_none = 0,
        ocf_cache_line_size_4 = 4 * KiB,
        ocf_cache_line_size_8 = 8 * KiB,
        ocf_cache_line_size_16 = 16 * KiB,
        ocf_cache_line_size_32 = 32 * KiB,
        ocf_cache_line_size_64 = 64 * KiB,
        ocf_cache_line_size_default = ocf_cache_line_size_4,
        ocf_cache_line_size_min = ocf_cache_line_size_4,
        ocf_cache_line_size_max = ocf_cache_line_size_64,
        ocf_cache_line_size_inf = ~0ULL,
} ocf_cache_line_size_t;

typedef enum {
        ocf_metadata_layout_striping = 0,
        ocf_metadata_layout_seq = 1,
        ocf_metadata_layout_max,
        ocf_metadata_layout_default = ocf_metadata_layout_striping
} ocf_metadata_layout_t;

#define OCF_IO_CLASS_MAX OCF_CONFIG_MAX_IO_CLASSES

#define OCF_IO_CLASS_ID_MIN 0

#define OCF_IO_CLASS_ID_MAX (OCF_IO_CLASS_MAX - 1)

#define OCF_IO_CLASS_INVALID OCF_IO_CLASS_MAX

#define OCF_IO_CLASS_NAME_MAX 1024

#define OCF_IO_CLASS_PRIO_PINNED -1

#define OCF_IO_CLASS_PRIO_HIGHEST 0

#define OCF_IO_CLASS_PRIO_LOWEST 255

#define OCF_IO_CLASS_PRIO_DEFAULT OCF_IO_CLASS_PRIO_LOWEST

#define OCF_READ                0
#define OCF_WRITE               1

#define OCF_CLEANER_DISABLE ~0U

#define MAX_TRIM_RQ_SIZE        (512 * KiB)

#endif /* __OCF_DEF_H__ */