git.sur5r.net Git - cc65/blob - src/common/alignment.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                alignment.h                                */
   4 /*                                                                           */
   5 /*                             Address aligment                              */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2011,      Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 52                                           */
  11 /*                70794 Filderstadt                                          */
  12 /* EMail:         uz@cc65.org                                                */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef ALIGNMENT_H
  37 #define ALIGNMENT_H
  38
  39
  40
  41 /* common */
  42 #include "inline.h"
  43
  44
  45
  46 /*****************************************************************************/
  47 /*                                   Data                                    */
  48 /*****************************************************************************/
  49
  50
  51
  52 /* Maximum possible alignment. Beware: To increase the possible alignment it
  53  * is not enough to bump this value. Check the code inside.
  54  */
  55 #define MAX_ALIGNMENT   0x10000UL
  56
  57 /* The following value marks what is considered a "large alignment" and worth
  58  * a warning if not suppressed.
  59  */
  60 #define LARGE_ALIGNMENT 0x101UL
  61
  62
  63
  64 /*****************************************************************************/
  65 /*                                   Code                                    */
  66 /*****************************************************************************/
  67
  68
  69
  70 unsigned long LeastCommonMultiple (unsigned long Left, unsigned long Right);
  71 /* Calculate the least common multiple of two numbers and return
  72  * the result.
  73  */
  74
  75 unsigned long AlignAddr (unsigned long Addr, unsigned long Alignment);
  76 /* Align an address to the given alignment */
  77
  78 unsigned long AlignCount (unsigned long Addr, unsigned long Alignment);
  79 /* Calculate how many bytes must be inserted to align Addr to Alignment */
  80
  81
  82
  83 /* End of alignment.h */
  84
  85 #endif