Blame source/vdo/kernel/deviceConfig.h

Packit Service d40955
/*
Packit Service d40955
 * Copyright (c) 2020 Red Hat, Inc.
Packit Service d40955
 *
Packit Service d40955
 * This program is free software; you can redistribute it and/or
Packit Service d40955
 * modify it under the terms of the GNU General Public License
Packit Service d40955
 * as published by the Free Software Foundation; either version 2
Packit Service d40955
 * of the License, or (at your option) any later version.
Packit Service d40955
 * 
Packit Service d40955
 * This program is distributed in the hope that it will be useful,
Packit Service d40955
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service d40955
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit Service d40955
 * GNU General Public License for more details.
Packit Service d40955
 * 
Packit Service d40955
 * You should have received a copy of the GNU General Public License
Packit Service d40955
 * along with this program; if not, write to the Free Software
Packit Service d40955
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
Packit Service d40955
 * 02110-1301, USA. 
Packit Service d40955
 *
Packit Service d40955
 * $Id: //eng/vdo-releases/aluminum/src/c++/vdo/kernel/deviceConfig.h#11 $
Packit Service d40955
 */
Packit Service d40955
#ifndef DEVICE_CONFIG_H
Packit Service d40955
#define DEVICE_CONFIG_H
Packit Service d40955
Packit Service d40955
#include <linux/device-mapper.h>
Packit Service d40955
Packit Service d40955
#include "ringNode.h"
Packit Service d40955
Packit Service d40955
#include "kernelTypes.h"
Packit Service d40955
Packit Service d40955
// This structure is memcmp'd for equality. Keep it
Packit Service d40955
// packed and don't add any fields that are not
Packit Service d40955
// properly set in both extant and parsed configs.
Packit Service d40955
typedef struct {
Packit Service d40955
  int bioAckThreads;
Packit Service d40955
  int bioThreads;
Packit Service d40955
  int bioRotationInterval;
Packit Service d40955
  int cpuThreads;
Packit Service d40955
  int logicalZones;
Packit Service d40955
  int physicalZones;
Packit Service d40955
  int hashZones;
Packit Service d40955
} __attribute__((packed)) ThreadCountConfig;
Packit Service d40955
Packit Service d40955
typedef uint32_t TableVersion;
Packit Service d40955
Packit Service d40955
typedef struct {
Packit Service d40955
  struct dm_target  *owningTarget;
Packit Service d40955
  struct dm_dev     *ownedDevice;
Packit Service d40955
  KernelLayer       *layer;
Packit Service d40955
  /** All configs referencing a layer are kept on a ring in the layer */
Packit Service d40955
  RingNode           configNode;
Packit Service d40955
  char              *originalString;
Packit Service d40955
  TableVersion       version;
Packit Service d40955
  char              *parentDeviceName;
Packit Service d40955
  BlockCount         physicalBlocks;
Packit Service d40955
  unsigned int       logicalBlockSize;
Packit Service d40955
  WritePolicy        writePolicy;
Packit Service d40955
  unsigned int       cacheSize;
Packit Service d40955
  unsigned int       blockMapMaximumAge;
Packit Service d40955
  bool               mdRaid5ModeEnabled;
Packit Service d40955
  bool               deduplication;
Packit Service d40955
  char              *poolName;
Packit Service d40955
  ThreadCountConfig  threadCounts;
Packit Service d40955
  BlockCount         maxDiscardBlocks;
Packit Service d40955
} DeviceConfig;
Packit Service d40955
Packit Service d40955
/**
Packit Service d40955
 * Convert a RingNode to the DeviceConfig that contains it.
Packit Service d40955
 *
Packit Service d40955
 * @param node  The RingNode to convert
Packit Service d40955
 *
Packit Service d40955
 * @return The DeviceConfig wrapping the RingNode
Packit Service d40955
 **/
Packit Service d40955
static inline DeviceConfig *asDeviceConfig(RingNode *node)
Packit Service d40955
{
Packit Service d40955
  if (node == NULL) {
Packit Service d40955
    return NULL;
Packit Service d40955
  }
Packit Service d40955
  return (DeviceConfig *) ((byte *) node - offsetof(DeviceConfig, configNode));
Packit Service d40955
}
Packit Service d40955
Packit Service d40955
/**
Packit Service d40955
 * Grab a pointer to the pool name out of argv.
Packit Service d40955
 *
Packit Service d40955
 * @param [in]  argc         The number of table values
Packit Service d40955
 * @param [in]  argv         The array of table values
Packit Service d40955
 * @param [out] errorPtr     A pointer to return a error string in
Packit Service d40955
 * @param [out] poolNamePtr  A pointer to return the pool name
Packit Service d40955
 *
Packit Service d40955
 * @return VDO_SUCCESS or an error code
Packit Service d40955
 **/
Packit Service d40955
int getPoolNameFromArgv(int    argc,
Packit Service d40955
                        char **argv,
Packit Service d40955
                        char **errorPtr,
Packit Service d40955
                        char **poolNamePtr)
Packit Service d40955
  __attribute__((warn_unused_result));
Packit Service d40955
Packit Service d40955
/**
Packit Service d40955
 * Convert the dmsetup table into a DeviceConfig.
Packit Service d40955
 *
Packit Service d40955
 * @param [in]  argc        The number of table values
Packit Service d40955
 * @param [in]  argv        The array of table values
Packit Service d40955
 * @param [in]  ti          The target structure for this table
Packit Service d40955
 * @param [in]  verbose     Whether to log about the underlying device
Packit Service d40955
 * @param [out] configPtr   A pointer to return the allocated config
Packit Service d40955
 *
Packit Service d40955
 * @return VDO_SUCCESS or an error code
Packit Service d40955
 **/
Packit Service d40955
int parseDeviceConfig(int                argc,
Packit Service d40955
                      char             **argv,
Packit Service d40955
                      struct dm_target  *ti,
Packit Service d40955
                      bool               verbose,
Packit Service d40955
                      DeviceConfig     **configPtr)
Packit Service d40955
  __attribute__((warn_unused_result));
Packit Service d40955
Packit Service d40955
/**
Packit Service d40955
 * Free a device config created by parseDeviceConfig().
Packit Service d40955
 *
Packit Service d40955
 * @param configPtr  The pointer holding the config, which will be nulled
Packit Service d40955
 **/
Packit Service d40955
void freeDeviceConfig(DeviceConfig **configPtr);
Packit Service d40955
Packit Service d40955
/**
Packit Service d40955
 * Get the text describing the write policy.
Packit Service d40955
 *
Packit Service d40955
 * @param config  The device config
Packit Service d40955
 *
Packit Service d40955
 * @returns a pointer to a string describing the write policy
Packit Service d40955
 **/
Packit Service d40955
const char *getConfigWritePolicyString(DeviceConfig *config)
Packit Service d40955
  __attribute__((warn_unused_result));
Packit Service d40955
Packit Service d40955
/**
Packit Service d40955
 * Acquire or release a reference from the config to a kernel layer.
Packit Service d40955
 *
Packit Service d40955
 * @param config  The config in question
Packit Service d40955
 * @param layer   The kernel layer in question
Packit Service d40955
 **/
Packit Service d40955
void setDeviceConfigLayer(DeviceConfig *config, KernelLayer *layer);
Packit Service d40955
Packit Service d40955
#endif // DEVICE_CONFIG_H