home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / gdb-4.16-base.tgz / gdb-4.16-base.tar / fsf / gdb / sim / ppc / bits.h < prev    next >
Encoding:
C/C++ Source or Header  |  1995-12-19  |  6.9 KB  |  255 lines
  1. /*  This file is part of the program psim.
  2.  
  3.     Copyright (C) 1994-1995, Andrew Cagney <cagney@highland.com.au>
  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 2 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, write to the Free Software
  17.     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18.  
  19.     */
  20.  
  21.  
  22. #ifndef _BITS_H_
  23. #define _BITS_H_
  24.  
  25.  
  26. /* bit manipulation routines:
  27.  
  28.    Bit numbering: The bits are numbered according to the PowerPC
  29.    convention - the left most (or most significant) is bit 0 while the
  30.    right most (least significant) is bit 1.
  31.  
  32.    Size convention: Each macro is in three forms - <MACRO>32 which
  33.    operates in 32bit quantity (bits are numbered 0..31); <MACRO>64
  34.    which operates using 64bit quantites (and bits are numbered 0..64);
  35.    and <MACRO> which operates using the bit size of the target
  36.    architecture (bits are still numbered 0..63), with 32bit
  37.    architectures ignoring the first 32bits having bit 32 as the most
  38.    significant.
  39.  
  40.    BIT*(POS): Quantity with just 1 bit set.
  41.  
  42.    MASK*(FIRST, LAST): Create a constant bit mask of the specified
  43.    size with bits [FIRST .. LAST] set.
  44.  
  45.    MASKED*(VALUE, FIRST, LAST): Masks out all but bits [FIRST
  46.    .. LAST].
  47.  
  48.    EXTRACTED*(VALUE, FIRST, LAST): Masks out bits [FIRST .. LAST] but
  49.    also right shifts the masked value so that bit LAST becomes the
  50.    least significant (right most).
  51.  
  52.    SHUFFLED**(VALUE, OLD, NEW): Mask then move a single bit from OLD
  53.    new NEW.
  54.  
  55.    MOVED**(VALUE, OLD_FIRST, OLD_LAST, NEW_FIRST, NEW_LAST): Moves
  56.    things around so that bits OLD_FIRST..OLD_LAST are masked then
  57.    moved to NEW_FIRST..NEW_LAST.
  58.  
  59.    INSERTED*(VALUE, FIRST, LAST): Takes VALUE and `inserts' the (LAST
  60.    - FIRST + 1) least significant bits into bit positions [ FIRST
  61.    .. LAST ].  This is almost the complement to EXTRACTED.
  62.  
  63.    IEA_MASKED(SHOULD_MASK, ADDR): Convert the address to the targets
  64.    natural size.  If in 32bit mode, discard the high 32bits.
  65.  
  66.    EXTENDED(VALUE): Convert VALUE (32bits of it) to the targets
  67.    natural size.  If in 64bit mode, sign extend the value.
  68.  
  69.    ALIGN_*(VALUE): Round upwards the value so that it is aligned.
  70.  
  71.    FLOOR_*(VALUE): Truncate the value so that it is aligned.
  72.  
  73.    ROTL*(VALUE, NR_BITS): Return the value rotated by NR_BITS
  74.  
  75.    */
  76.  
  77. #define _MAKE_SHIFT(WIDTH, pos) ((WIDTH) - 1 - (pos))
  78.  
  79.  
  80. /* MakeBit */
  81. #define _BITn(WIDTH, pos) (((natural##WIDTH)(1)) \
  82.                << _MAKE_SHIFT(WIDTH, pos))
  83.  
  84. #define BIT4(POS)  (1 << _MAKE_SHIFT(4, POS))
  85. #define BIT5(POS)  (1 << _MAKE_SHIFT(5, POS))
  86. #define BIT10(POS)  (1 << _MAKE_SHIFT(10, POS))
  87. #define BIT32(POS) _BITn(32, POS)
  88. #define BIT64(POS) _BITn(64, POS)
  89.  
  90. #if (WITH_TARGET_WORD_BITSIZE == 64)
  91. #define BIT(POS)   BIT64(POS)
  92. #else
  93. #define BIT(POS)   (((POS) < 32) ? 0 : _BITn(32, (POS)-32))
  94. #endif
  95.  
  96.  
  97. /* multi bit mask */
  98. #define _MASKn(WIDTH, START, STOP) \
  99. (((((unsigned##WIDTH)0) - 1) \
  100.   >> (WIDTH - ((STOP) - (START) + 1))) \
  101.  << (WIDTH - 1 - (STOP)))
  102.  
  103. #define MASK32(START, STOP)   _MASKn(32, START, STOP)
  104. #define MASK64(START, STOP)   _MASKn(64, START, STOP)
  105.  
  106. #if (WITH_TARGET_WORD_BITSIZE == 64)
  107. #define MASK(START, STOP) \
  108. (((START) <= (STOP)) \
  109.  ? _MASKn(64, START, STOP) \
  110.  : (_MASKn(64, 0, STOP) \
  111.     | _MASKn(64, START, 63)))
  112. #else
  113. #define MASK(START, STOP) \
  114. (((START) <= (STOP)) \
  115.  ? (((STOP) < 32) \
  116.     ? 0 \
  117.     : _MASKn(32, \
  118.          (START) < 32 ? 0 : (START) - 32, \
  119.          (STOP)-32)) \
  120.  : (_MASKn(32, \
  121.        (START) < 32 ? 0 : (START) - 32, \
  122.        31) \
  123.     | (((STOP) < 32) \
  124.        ? 0 \
  125.        : _MASKn(32, \
  126.         0, \
  127.         (STOP) - 32))))
  128. #endif
  129.  
  130.  
  131. /* mask the required bits, leaving them in place */
  132.  
  133. INLINE_BITS\
  134. (unsigned32) MASKED32
  135. (unsigned32 word,
  136.  unsigned start,
  137.  unsigned stop);
  138.  
  139. INLINE_BITS\
  140. (unsigned64) MASKED64
  141. (unsigned64 word,
  142.  unsigned start,
  143.  unsigned stop);
  144.  
  145. INLINE_BITS\
  146. (unsigned_word) MASKED
  147. (unsigned_word word,
  148.  unsigned start,
  149.  unsigned stop);
  150.  
  151.  
  152. /* extract the required bits aligning them with the lsb */
  153. #define _EXTRACTEDn(WIDTH, WORD, START, STOP) \
  154. ((((natural##WIDTH)(WORD)) >> (WIDTH - (STOP) - 1)) \
  155.  & _MASKn(WIDTH, WIDTH-1+(START)-(STOP), WIDTH-1))
  156.  
  157. /* #define EXTRACTED10(WORD, START, STOP) _EXTRACTEDn(10, WORD, START, STOP) */
  158. #define EXTRACTED32(WORD, START, STOP) _EXTRACTEDn(32, WORD, START, STOP)
  159. #define EXTRACTED64(WORD, START, STOP) _EXTRACTEDn(64, WORD, START, STOP)
  160.  
  161. INLINE_BITS\
  162. (unsigned_word) EXTRACTED
  163. (unsigned_word val,
  164.  unsigned start,
  165.  unsigned stop);
  166.  
  167.  
  168. /* move a single bit around */
  169. /* NB: the wierdness (N>O?N-O:0) is to stop a warning from GCC */
  170. #define _SHUFFLEDn(N, WORD, OLD, NEW) \
  171. ((OLD) < (NEW) \
  172.  ? (((unsigned##N)(WORD) \
  173.      >> (((NEW) > (OLD)) ? ((NEW) - (OLD)) : 0)) \
  174.     & MASK32((NEW), (NEW))) \
  175.  : (((unsigned##N)(WORD) \
  176.      << (((OLD) > (NEW)) ? ((OLD) - (NEW)) : 0)) \
  177.     & MASK32((NEW), (NEW))))
  178.  
  179. #define SHUFFLED32(WORD, OLD, NEW) _SHUFFLEDn(32, WORD, OLD, NEW)
  180. #define SHUFFLED64(WORD, OLD, NEW) _SHUFFLEDn(64, WORD, OLD, NEW)
  181.  
  182. #define SHUFFLED(WORD, OLD, NEW) _SHUFFLEDn(_word, WORD, OLD, NEW)
  183.  
  184.  
  185. /* move a group of bits around */
  186. #define _INSERTEDn(N, WORD, START, STOP) \
  187. (((natural##N)(WORD) << _MAKE_SHIFT(N, STOP)) & _MASKn(N, START, STOP))
  188.  
  189. #define INSERTED32(WORD, START, STOP) _INSERTEDn(32, WORD, START, STOP)
  190. #define INSERTED64(WORD, START, STOP) _INSERTEDn(64, WORD, START, STOP)
  191.  
  192. #define INSERTED(WORD, START, STOP) \
  193. _INSERTEDn(WITH_TARGET_WORD_BITSIZE, WORD, START, STOP)
  194.  
  195.  
  196.  
  197. /* depending on MODE return a 64bit or 32bit (sign extended) value */
  198. #if (WITH_TARGET_WORD_BITSIZE == 64)
  199. #define EXTENDED(X)     ((signed64)(signed32)(X))
  200. #else
  201. #define EXTENDED(X)     (X)
  202. #endif
  203.  
  204.  
  205. /* memory alignment macro's */
  206. #define _ALIGNa(A,X)  (((X) + ((A) - 1)) & ~((A) - 1))
  207. #define _FLOORa(A,X)  ((X) & ~((A) - 1))
  208.  
  209. #define ALIGN_8(X)    _ALIGNa(8, X)
  210. #define ALIGN_16(X)    _ALIGNa(16, X)
  211.  
  212. #define ALIGN_PAGE(X)    _ALIGNa(0x1000, X)
  213. #define FLOOR_PAGE(X)   ((X) & ~(0x1000 - 1))
  214.  
  215.  
  216. /* bit bliting macro's */
  217. #define BLIT32(V, POS, BIT) \
  218. do { \
  219.   if (BIT) \
  220.     V |= BIT32(POS); \
  221.   else \
  222.     V &= ~BIT32(POS); \
  223. } while (0)
  224. #define MBLIT32(V, LO, HI, VAL) \
  225. do { \
  226.   (V) = (((V) & ~MASK32((LO), (HI))) \
  227.      | INSERTED32(VAL, LO, HI)); \
  228. } while (0)
  229.  
  230.  
  231. /* some rotate functions to make things easier
  232.  
  233.    NOTE: These are functions not macro's as the latter tickles bugs in
  234.    gcc-2.6.3 */
  235.  
  236. #define _ROTLn(N, VAL, SHIFT) \
  237. (((VAL) << (SHIFT)) | ((VAL) >> ((N)-(SHIFT))))
  238.  
  239. INLINE_BITS\
  240. (unsigned32) ROTL32
  241. (unsigned32 val,
  242.  long shift);
  243.  
  244. INLINE_BITS\
  245. (unsigned64) ROTL64
  246. (unsigned64 val,
  247.  long shift);
  248.  
  249.  
  250. #if (BITS_INLINE & INCLUDE_MODULE)
  251. #include "bits.c"
  252. #endif
  253.  
  254. #endif /* _BITS_H_ */
  255.