Add cool quote
[alexxy/gromacs.git] / src / gromacs / hardware / architecture.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2017, by the GROMACS development team, led by
5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6  * and including many others, as listed in the AUTHORS file in the
7  * top-level source directory and at http://www.gromacs.org.
8  *
9  * GROMACS is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public License
11  * as published by the Free Software Foundation; either version 2.1
12  * of the License, or (at your option) any later version.
13  *
14  * GROMACS is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with GROMACS; if not, see
21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
23  *
24  * If you want to redistribute modifications to GROMACS, please
25  * consider that scientific software is very special. Version
26  * control is crucial - bugs must be traceable. We will be happy to
27  * consider code for inclusion in the official distribution, but
28  * derived work must not be called official GROMACS. Details are found
29  * in the README & COPYING files - if they are missing, get the
30  * official version at http://www.gromacs.org.
31  *
32  * To help us fund GROMACS development, we humbly ask that you cite
33  * the research papers on the package. Check out http://www.gromacs.org.
34  */
35 /*! \internal \file
36  * \brief
37  * Declares and defines architecture booleans to minimize preprocessed code
38  *
39  * \ingroup module_hardware
40  */
41 #ifndef GMX_ARCHITECTURE_H
42 #define GMX_ARCHITECTURE_H
43
44 namespace gmx
45 {
46
47 //! Enum for GROMACS CPU hardware detection support
48 enum class Architecture
49 {
50     Unknown, //! Not one of the cases below
51     X86,     //! X86
52     Arm,     //! ARM
53     PowerPC  //! IBM PowerPC
54 };
55
56 //! Whether the compilation is targeting 32-bit x86.
57 # if (defined __i386__ || defined __i386 || defined _X86_ || defined _M_IX86)
58 #define GMX_IS_X86_32 1
59 #else
60 #define GMX_IS_X86_32 0
61 #endif
62
63 //! Whether the compilation is targeting 64-bit x86.
64 #if (defined __x86_64__ || defined __x86_64 || defined __amd64__ || defined __amd64 || defined _M_X64 || defined _M_AMD64)
65 #define GMX_IS_X86_64 1
66 #else
67 #define GMX_IS_X86_64 0
68 #endif
69
70 //! Constant that tells what the architecture is
71 static constexpr Architecture c_architecture =
72 #if GMX_IS_X86_32 || GMX_IS_X86_64
73     Architecture::X86;
74 #elif defined __arm__ || defined __arm || defined _M_ARM || defined __aarch64_
75     Architecture::Arm;
76 #elif defined __powerpc__ || defined __ppc__ || defined __PPC__
77     Architecture::PowerPC;
78 #else
79     Architecture::Unknown;
80 #endif
81
82 }      // namespace gmx
83
84 #endif // GMX_ARCHITECTURE_H