shaba/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-10 05:17:59 +03:00
Code Releases Activity

Add simple bitmap operations to utils

Browse Source 
V2:
  - Move bitmap impl to src/util/bitmap.[ch]
  - Use CHAR_BIT instead of explicit '8'
  - Use size_t instead of unsigned int
  - Fix calculation of bitmap size in virBitmapAlloc
  - Ensure bit is within range of map in the set, clear, and get
    operations
  - Use bool in virBitmapGetBit
  - Add virBitmapFree to free-like funcs in cfg.mk

V3:
  - Check for overflow in virBitmapAlloc
  - Fix copy and paste bug in virBitmapAlloc
  - Use size_t in prototypes
  - Add ATTRIBUTE_NONNULL in prototypes where appropriate
    and remove NULL check from impl

V4:
  - Add ATTRIBUTE_RETURN_CHECK in prototypes where appropriate.
This commit is contained in:
Jim Fehlig 2010-05-20 22:23:48 -06:00
parent 377bc412ce
commit 2f32d7afd5
5 changed files with 224 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
cfg.mk
View File

@ -67,6 +67,7 @@ local-checks-to-skip = \
useless_free_options = \
--name=VIR_FREE \
--name=sexpr_free \
--name=virBitmapFree \
--name=virCPUDefFree \
--name=virCapabilitiesFree \
--name=virCapabilitiesFreeGuest \

1
src/Makefile.am
View File

@ -50,6 +50,7 @@ augeastest_DATA =
# helper APIs for various purposes
UTIL_SOURCES = \
util/authhelper.c util/authhelper.h \
util/bitmap.c util/bitmap.h \
util/bridge.c util/bridge.h \
util/buf.c util/buf.h \
util/conf.c util/conf.h \

8
src/libvirt_private.syms
View File

@ -4,6 +4,14 @@
#
# bitmap.h
virBitmapAlloc;
virBitmapFree;
virBitmapSetBit;
virBitmapClearBit;
virBitmapGetBit;
# buf.h
virBufferVSprintf;
virBufferEscapeString;

151
src/util/bitmap.c Normal file
View File

@ -0,0 +1,151 @@
/*
* bitmap.h: Simple bitmap operations
*
* Copyright (C) 2010 Novell, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Jim Fehlig <jfehlig@novell.com>
*/
#include <config.h>
#include <limits.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <sys/types.h>
#include "bitmap.h"
#include "memory.h"
struct _virBitmap {
size_t size;
uint32_t *map;
};
#define VIR_BITMAP_BITS_PER_UNIT (sizeof(uint32_t) * CHAR_BIT)
#define VIR_BITMAP_UNIT_OFFSET(b) ((b) / VIR_BITMAP_BITS_PER_UNIT)
#define VIR_BITMAP_BIT_OFFSET(b) ((b) % VIR_BITMAP_BITS_PER_UNIT)
/**
* virBitmapAlloc:
* @size: number of bits
*
* Allocate a bitmap capable of containing @size bits.
*
* Returns a pointer to the allocated bitmap or NULL if
* memory cannot be allocated.
*/
virBitmapPtr virBitmapAlloc(size_t size)
{
virBitmapPtr bitmap;
size_t sz;
if (SIZE_MAX - VIR_BITMAP_BITS_PER_UNIT < size)
return NULL;
sz = (size + VIR_BITMAP_BITS_PER_UNIT - 1) /
VIR_BITMAP_BITS_PER_UNIT;
if (VIR_ALLOC(bitmap) < 0)
return NULL;
if (VIR_ALLOC_N(bitmap->map, sz) < 0) {
VIR_FREE(bitmap);
return NULL;
}
return bitmap;
}
/**
* virBitmapFree:
* @bitmap: previously allocated bitmap
*
* Free @bitmap previously allocated by virBitmapAlloc.
*/
void virBitmapFree(virBitmapPtr bitmap)
{
if (bitmap) {
VIR_FREE(bitmap->map);
VIR_FREE(bitmap);
}
}
/**
* virBitmapSetBit:
* @bitmap: Pointer to bitmap
* @b: bit position to set
*
* Set bit position @b in @bitmap
*
* Returns 0 on if bit is successfully set, -1 on error.
*/
int virBitmapSetBit(virBitmapPtr bitmap, size_t b)
{
if (b > bitmap->size - 1)
return -1;
bitmap->map[VIR_BITMAP_UNIT_OFFSET(b)] |= (1 << VIR_BITMAP_BIT_OFFSET(b));
return 0;
}
/**
* virBitmapClearBit:
* @bitmap: Pointer to bitmap
* @b: bit position to clear
*
* Clear bit position @b in @bitmap
*
* Returns 0 on if bit is successfully clear, -1 on error.
*/
int virBitmapClearBit(virBitmapPtr bitmap, size_t b)
{
if (b > bitmap->size - 1)
return -1;
bitmap->map[VIR_BITMAP_UNIT_OFFSET(b)] &= ~(1 << VIR_BITMAP_BIT_OFFSET(b));
return 0;
}
/**
* virBitmapGetBit:
* @bitmap: Pointer to bitmap
* @b: bit position to get
* @result: bool pointer to receive bit setting
*
* Get setting of bit position @b in @bitmap and store in @result
*
* On success, @result will contain the setting of @b and 0 is
* returned. On failure, -1 is returned and @result is unchanged.
*/
int virBitmapGetBit(virBitmapPtr bitmap, size_t b, bool *result)
{
uint32_t bit;
if (b > bitmap->size - 1)
return -1;
bit = bitmap->map[VIR_BITMAP_UNIT_OFFSET(b)] &
(1 << VIR_BITMAP_BIT_OFFSET(b));
*result = bit != 0;
return 0;
}

63
src/util/bitmap.h Normal file
View File

@ -0,0 +1,63 @@
/*
* bitmap.h: Simple bitmap operations
*
* Copyright (C) 2010 Novell, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Jim Fehlig <jfehlig@novell.com>
*/
#ifndef __BITMAP_H__
# define __BITMAP_H__
#include "internal.h"
#include <stdbool.h>
#include <sys/types.h>
typedef struct _virBitmap virBitmap;
typedef virBitmap *virBitmapPtr;
/*
* Allocate a bitmap capable of containing @size bits.
*/
virBitmapPtr virBitmapAlloc(size_t size) ATTRIBUTE_RETURN_CHECK;
/*
* Free previously allocated bitmap
*/
void virBitmapFree(virBitmapPtr bitmap);
/*
* Set bit position @b in @bitmap
*/
int virBitmapSetBit(virBitmapPtr bitmap, size_t b)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK;
/*
* Clear bit position @b in @bitmap
*/
int virBitmapClearBit(virBitmapPtr bitmap, size_t b)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK;
/*
* Get setting of bit position @b in @bitmap and store in @result
*/
int virBitmapGetBit(virBitmapPtr bitmap, size_t b, bool *result)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
#endif