include/parted/natmath.h

   1 /*
   2     libparted - a library for manipulating disk partitions
   3     Copyright (C) 2000, 2007-2010 Free Software Foundation, Inc.
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 3 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 /**
  20  * \addtogroup PedAlignment
  21  * @{
  22  */
  23
  24 /** \file natmath.h */
  25
  26 #ifndef PED_NATMATH_H_INCLUDED
  27 #define PED_NATMATH_H_INCLUDED
  28
  29
  30 typedef struct _PedAlignment    PedAlignment;
  31
  32 #include <parted/disk.h>
  33 #include <parted/device.h>
  34 #include <parted/geom.h>
  35
  36 #define PED_MIN(a, b)   ( ((a)<(b)) ? (a) : (b) )
  37 #define PED_MAX(a, b)   ( ((a)>(b)) ? (a) : (b) )
  38
  39 /* this is weird (I'm still not sure I should be doing this!)
  40  *
  41  * For the functions: new, destroy, duplicate and merge: the following values
  42  * for align are valid:
  43  *      * align == NULL  (!)            represents no solution
  44  *      * align->grain_size == 0        represents a single solution
  45  *                                      (align->offset)
  46  *      * align->grain_size > 0         represents a set of solutions
  47  *
  48  * These are invalid:
  49  *      * align->offset < 0             Note: this gets "normalized"
  50  *      * align->grain_size < 0
  51  *
  52  * For the align_* operations, there must be a solution.  i.e. align != NULL
  53  * All solutions must be greater than zero.
  54  */
  55
  56 struct _PedAlignment {
  57         PedSector       offset;
  58         PedSector       grain_size;
  59 };
  60
  61 extern PedSector ped_round_up_to (PedSector sector, PedSector grain_size);
  62 extern PedSector ped_round_down_to (PedSector sector, PedSector grain_size);
  63 extern PedSector ped_round_to_nearest (PedSector sector, PedSector grain_size);
  64 extern PedSector ped_greatest_common_divisor (PedSector a, PedSector b);
  65
  66 extern int ped_alignment_init (PedAlignment* align, PedSector offset,
  67                                PedSector grain_size);
  68 extern PedAlignment* ped_alignment_new (PedSector offset, PedSector grain_size);
  69 extern void ped_alignment_destroy (PedAlignment* align);
  70 extern PedAlignment* ped_alignment_duplicate (const PedAlignment* align);
  71 extern PedAlignment* ped_alignment_intersect (const PedAlignment* a,
  72                                               const PedAlignment* b);
  73
  74 extern PedSector
  75 ped_alignment_align_up (const PedAlignment* align, const PedGeometry* geom,
  76                         PedSector sector);
  77 extern PedSector
  78 ped_alignment_align_down (const PedAlignment* align, const PedGeometry* geom,
  79                           PedSector sector);
  80 extern PedSector
  81 ped_alignment_align_nearest (const PedAlignment* align, const PedGeometry* geom,
  82                              PedSector sector);
  83
  84 extern int
  85 ped_alignment_is_aligned (const PedAlignment* align, const PedGeometry* geom,
  86                           PedSector sector);
  87
  88 extern const PedAlignment* ped_alignment_any;
  89 extern const PedAlignment* ped_alignment_none;
  90
  91 static inline PedSector
  92 ped_div_round_up (PedSector numerator, PedSector divisor)
  93 {
  94         return (numerator + divisor - 1) / divisor;
  95 }
  96
  97
  98 static inline PedSector
  99 ped_div_round_to_nearest (PedSector numerator, PedSector divisor)
 100 {
 101         return (numerator + divisor/2) / divisor;
 102 }
 103
 104 #endif /* PED_NATMATH_H_INCLUDED */
 105
 106 /**
 107  * @}
 108  */