Switched to GPLv3.
[gnupg.git] / mpi / generic / mpih-rshift.c
1 /* mpih-rshift.c  -  MPI helper functions
2  * Copyright (C) 1994, 1996, 1998, 1999,
3  *               2000, 2001 Free Software Foundation, Inc.
4  *
5  * This file is part of GNUPG
6  *
7  * GNUPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GNUPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  *
20  * Note: This code is heavily based on the GNU MP Library.
21  *       Actually it's the same code with only minor changes in the
22  *       way the data is stored; this is to support the abstraction
23  *       of an optional secure memory allocation which may be used
24  *       to avoid revealing of sensitive data due to paging etc.
25  *       The GNU MP Library itself is published under the LGPL;
26  *       however I decided to publish this code under the plain GPL.
27  */
28
29 #include <config.h>
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include "mpi-internal.h"
33
34
35 /* Shift U (pointed to by UP and USIZE limbs long) CNT bits to the right
36  * and store the USIZE least significant limbs of the result at WP.
37  * The bits shifted out to the right are returned.
38  *
39  * Argument constraints:
40  * 1. 0 < CNT < BITS_PER_MP_LIMB
41  * 2. If the result is to be written over the input, WP must be <= UP.
42  */
43
44 mpi_limb_t
45 mpihelp_rshift( mpi_ptr_t wp, mpi_ptr_t up, mpi_size_t usize, unsigned cnt)
46 {
47     mpi_limb_t high_limb, low_limb;
48     unsigned sh_1, sh_2;
49     mpi_size_t i;
50     mpi_limb_t retval;
51
52     sh_1 = cnt;
53     wp -= 1;
54     sh_2 = BITS_PER_MPI_LIMB - sh_1;
55     high_limb = up[0];
56     retval = high_limb << sh_2;
57     low_limb = high_limb;
58     for( i=1; i < usize; i++) {
59         high_limb = up[i];
60         wp[i] = (low_limb >> sh_1) | (high_limb << sh_2);
61         low_limb = high_limb;
62     }
63     wp[i] = low_limb >> sh_1;
64
65     return retval;
66 }
67