/*
 * Copyright(c) 2012-2021 Intel Corporation
 * Copyright(c) 2023-2024 Huawei Technologies Co., Ltd.
 * SPDX-License-Identifier: BSD-3-Clause
 */

#ifndef __METADATA_PARTITION_STRUCTS_H__
#define __METADATA_PARTITION_STRUCTS_H__

#include "utils/utils_list.h"
#include "utils/utils_cleaner.h"
#include "cleaning/cleaning.h"
#include "ocf_space.h"

#define OCF_NUM_PARTITIONS OCF_USER_IO_CLASS_MAX + 2

struct ocf_user_part_config {
	char name[OCF_IO_CLASS_NAME_MAX];
	uint32_t min_size;
	uint32_t max_size;
	struct {
		uint8_t valid : 1;
		uint8_t added : 1;
		uint8_t eviction : 1;
			/*!< This bits is setting during partition sorting,
			* and means that can evict from this partition
			*/
	} flags;
	int16_t priority;
	ocf_cache_mode_t cache_mode;
};

struct ocf_part_runtime {
	env_atomic curr_size;
	struct ocf_lru_part_meta lru[OCF_NUM_LRU_LISTS];
};

typedef bool ( *_lru_hash_locked_pfn)(struct ocf_request *req,
		ocf_core_id_t core_id, uint64_t core_line);

/* Iterator state, visiting all lru lists within a partition
   in round robin order */
struct ocf_lru_iter
{
	/* per-partition cacheline iterator */
	ocf_cache_line_t curr_cline[OCF_NUM_LRU_LISTS];
	/* cache object */
	ocf_cache_t cache;
	/* cacheline concurrency */
	struct ocf_alock *c;
	/* target partition */
	struct ocf_part *part;
	/* available (non-empty) lru list bitmap rotated so that current
	   @lru_idx is on the most significant bit */
	unsigned long long next_avail_lru;
	/* number of available lru lists */
	uint32_t num_avail_lrus;
	/* current lru list index */
	uint32_t lru_idx;
	/* callback to determine whether given hash bucket is already
	 * locked by the caller */
	_lru_hash_locked_pfn hash_locked;
	/* optional caller request */
	struct ocf_request *req;
	/* 1 if iterating over clean lists, 0 if over dirty */
	bool clean : 1;
};

#define OCF_EVICTION_CLEAN_SIZE 32U

struct ocf_part_cleaning_ctx {
	ocf_cache_t cache;
	struct ocf_refcnt counter;
	struct flush_data entries[OCF_EVICTION_CLEAN_SIZE];
};

/* common partition data for both user-deined partitions as
 * well as freelist
 */
struct ocf_part {
	struct ocf_part_runtime *runtime;
	ocf_part_id_t id;
};

struct ocf_user_part {
	struct ocf_user_part_config *config;
	struct cleaning_policy *clean_pol;
	struct ocf_part part;
	struct ocf_part_cleaning_ctx cleaning;
	struct ocf_lst_entry lst_valid;
};


#endif /* __METADATA_PARTITION_STRUCTS_H__ */