/*
* Copyright (c) 2020 Red Hat, Inc.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*
* $Id: //eng/vdo-releases/aluminum/src/c++/vdo/base/allocationSelector.h#1 $
*/
#ifndef ALLOCATION_SELECTOR_H
#define ALLOCATION_SELECTOR_H
#include "completion.h"
/**
* An AllocationSelector is used by any zone which does data block allocations.
* The selector is used to round-robin allocation requests to different
* physical zones. Currently, 128 allocations will be made to a given physical
* zone before switching to the next.
**/
/**
* Make a new allocation selector.
*
* @param [in] physicalZoneCount The number of physical zones
* @param [in] threadID The ID of the thread using this selector
* @param [out] selectorPtr A pointer to receive the new selector
*
* @return VDO_SUCCESS or an error
**/
int makeAllocationSelector(ZoneCount physicalZoneCount,
ThreadID threadID,
AllocationSelector **selectorPtr)
__attribute__((warn_unused_result));
/**
* Free an AllocationSelector and null out the reference to it.
*
* @param selectorPtr A reference to the selector to free
**/
void freeAllocationSelector(AllocationSelector **selectorPtr);
/**
* Get number of the physical zone from which to allocate next.
*
* @param selector The selector to query
*
* @return The number of the physical zone from which to allocate
**/
ZoneCount getNextAllocationZone(AllocationSelector *selector)
__attribute__((warn_unused_result));
#endif /* ALLOCATION_SELECTOR_H */