openGauss5.1应用开发指南：版本编译

openGauss的编译过程和生成安装包的过程已经写成了一个一键式的脚本build.sh，可以方便的通过脚本进行编译操作。也可以自己配置环境变量，通过命令进行编译。

• 版本编译
  • 编译前准备
    • 代码下载
    • 开源软件编译构建
    • 编译脚本介绍
  • 软件安装编译
    • 前提条件
    • 一键式脚本编译
    • 手动编译
  • openGauss-OM编译
    • 操作步骤
  • 产品安装包编译
    • 前提条件-1
    • 操作步骤-1
  • 编译后验证

本章节会介绍openGauss编译需要满足的前提条件，编译的操作步骤等，下图是对编译流程的大致概括，详细内容见下文。

编译前准备

代码下载

前提条件

已在本地安装并配置git和git-lfs。

操作步骤

1. 执行如下命令下载代码和开源第三方软件仓库：

   [user@linux sda]$ git clone https://gitee.com/opengauss/openGauss-server.git openGauss-server -b branchname #openGauss的代码仓库
[user@linux sda]$ git clone https://gitee.com/opengauss/openGauss-third_party.git openGauss-third_party #openGauss依赖的开源第三方软件仓库
[user@linux sda]$ # mkdir binarylibs 关于此注释步骤，请阅读说明


    说明：

   • branchname：代码分支名称，缺省可不填，如需编译openGauss 2.1.0的代码，可加上-b 2.1.0的参数。
   • binarylibs：存放编译构建好的开源第三方软件的文件夹，用户可通过开源软件编译构建获取。由于开源软件编译构建耗时长，我们特地使用openGauss-third_party编译构建出了一份binarylibs并压缩上传到了网上，用户可以直接下载获取。
     社区提供三个平台编译好的二进制文件。对应各个平台下载地址：
     openEuler_arm: https://opengauss.obs.cn-south-1.myhuaweicloud.com/latest/binarylibs/gcc10.3/openGauss-third_party_binarylibs_openEuler_arm.tar.gz openEuler_x86: https://opengauss.obs.cn-south-1.myhuaweicloud.com/latest/binarylibs/gcc10.3/openGauss-third_party_binarylibs_openEuler_x86_64.tar.gz Centos_x86: https://opengauss.obs.cn-south-1.myhuaweicloud.com/latest/binarylibs/gcc10.3/openGauss-third_party_binarylibs_Centos7.6_x86_64.tar.gz

   下载完毕后执行解压并重命名 mv openGauss-third_party_binarylibs binarylibs。

2. 下载项进度均显示为100%时表示下载成功。

开源软件编译构建

开源软件编译构建

openGauss的编译，需要提前把所依赖的开源第三方软件进行编译和构建。这些开源第三方软件存放在代码openGauss-third_party代码仓中，用户下载完毕之后应用git lfs pull获取代码仓中的大文件，并且用户通常只需要构建一次。若存在开源软件版本更新，则需要重新构建。

由于此步骤耗时较长，我们使用openGauss-third_party编译构建出了一份binarylibs，用户可以参考代码下载直接下载获取。

表 1 openGauss开源第三方软件编译前置软件要求

在开始编译第三方库之前，请自行准备好gcc7.3。建议用已发布的编译好的第三方库中gcc，并配置好环境变量。

在安装完表1 openGauss开源三方件编译前置软件要求中的软件后，请将python默认版本指向python3.x并执行如下操作：

1. 执行如下命令进入内核依赖的开源第三方软件目录，进行开源第三方软件的编译和构建，产生相应的二进制程序或库文件。/sda/openGauss-third_party为开源第三方软件下载目录。

   [user@linux sda]$ cd /sda/openGauss-third_party/build
[user@linux build]$ sh build_all.sh


2. 用户执行以上命令之后，可以自动生成数据库编译所需的开源第三方软件，如果想单独的生成某个开源三方软件，可以进入对应的目录，执行build.sh脚本，如：

   [user@linux sda]$ cd /sda/openGauss-third_party/dependency/openssl
[user@linux openssl]$ sh build.sh


   即可编译生成openssl

    说明：

   相关的报错日志可以查看对应的build目录下对应名字的log以及对应模块下的log，如dependency模块下的openssl的相关编译安装日志可以查看：

   • /sda/openGauss-third_party/build/dependency_build.log
   • /sda/openGauss-third_party/dependency/build/openssl_build.log
   • /sda/openGauss-third_party/dependency/openssl/build_openssl.log

编译构建结果

执行上述脚本，最终编译构建出的结果会存放在openGauss-third_party目录下的output目录。这些文件会在后面编译openGauss-server时使用到。

编译脚本介绍

openGauss-server/build.sh是编译过程中的重要脚本工具。其集成了软件安装编译、产品安装包编译两种功能，可快速进行代码编译和打包。

详细参数选项如下表所示：

表 2 build.sh参数功能选项介绍

 说明：

• -m [debug | release | memcheck]表示可选择三种目标版本：

  • release：代表生成release版本的二进制程序，该版本编译时，配置GCC高级别优化选项，去除内核调试代码，通常用于生产环境或性能测试环境。

  • debug：代表生成debug版本的二进制程序，该版本编译时，增加内核代码调试功能，通常用于开发自测环境。

  • memcheck：代表生成memcheck版本的二进制程序，该版本编译时，在debug版本基础上新增ASAN功能，通常用于定位内存问题。

• -3rd [binarylibs path]为binarylibs的路径。缺省情况下，会认为当前代码文件夹下存在binarylibs。因此如果将binarylibs移动到openGauss-server下，或在openGauss-server下创建了指向binarylibs的软链接，可不指定此选项。但需要注意其容易被git clean等操作删除。

• 此脚本每个参数选项都设置了缺省值，且数量并不多，依赖关系简单，因此使用时非常方便。如果用户需求值与缺省值不同，请根据实际情况进行设置。

软件安装编译

软件安装编译即将代码编译生成软件，并将软件安装到机器上。提供一键式编译脚本build.sh进行操作，也可以自己配置环境变量手动操作。两种方式将在本章节的一键式脚本编译操作步骤、手动编译操作步骤中进行讲解。

前提条件

• 已按照搭建编译环境的要求准备好相关软硬件，并且已参考代码下载下载了代码。
• 已完成开源软件编译构建，具体请参见开源软件编译构建。并将gcc7.3按已发布的编译好的第三方库目录结构放置在output目录中。
• 了解build.sh介绍脚本的参数选项和功能。
• 代码环境干净，没有以前编译生成的文件。具体请参见FAQ。

一键式脚本编译

1. 执行如下命令进入到软件代码编译脚本目录。

   [user@linux sda]$ cd /sda/openGauss-server


2. 执行如下命令，编译安装openGauss。

   [user@linux openGauss-server]$ sh build.sh -m [debug | release | memcheck] -3rd [binarylibs path]


   例如：

   sh build.sh # 编译安装release版本的openGauss。需代码目录下有binarylibs或者其软链接，否则将会失败。
sh build.sh -m debug -3rd /sdc/binarylibs # 编译安装debug版本的openGauss


3. 显示如下内容，表示编译成功。

   make compile successfully!


   • 编译后软件安装路径为：/sda/openGauss-server/mppdb_temp_install
   • 编译后的二进制放置路径为：/sda/openGauss-server/mppdb_temp_install/bin
   • 编译日志为：./build/script/makemppdb_pkg.log

4. 导入环境变量，即可进行初始化和启动数据库。

   export CODE_BASE=________ # openGauss-server的路径
export GAUSSHOME=$CODE_BASE/mppdb_temp_install/
export LD_LIBRARY_PATH=$GAUSSHOME/lib::$LD_LIBRARY_PATH
export PATH=$GAUSSHOME/bin:$PATH


手动编译

1. 执行如下命令进入到软件代码目录。

   [user@linux sda]$ cd /sda/openGauss-server


2. 获取对应平台的三方库二进制文件。

3. 配置环境变量，根据自己的代码下载位置补充两处“____”

   export CODE_BASE=________ # openGauss-server的路径
export BINARYLIBS=________ # binarylibs的路径
export GAUSSHOME=$CODE_BASE/dest/
export GCC_PATH=$BINARYLIBS/buildtools/________ # gcc的版本，根据三方包中对应的gcc版本进行填写即可，一般由gcc7.3或gcc10.3两种
export CC=$GCC_PATH/gcc/bin/gcc
export CXX=$GCC_PATH/gcc/bin/g++
export LD_LIBRARY_PATH=$GAUSSHOME/lib:$GCC_PATH/gcc/lib64:$GCC_PATH/isl/lib:$GCC_PATH/mpc/lib/:$GCC_PATH/mpfr/lib/:$GCC_PATH/gmp/lib/:$LD_LIBRARY_PATH
export PATH=$GAUSSHOME/bin:$GCC_PATH/gcc/bin:$PATH


4. 选择版本进行configure。

   debug版：

   # gcc7.3.0版本
./configure --gcc-version=7.3.0 CC=g++ CFLAGS='-O0' --prefix=$GAUSSHOME --3rd=$BINARYLIBS --enable-debug --enable-cassert --enable-thread-safety --with-readline --without-zlib

   # gcc10.3.1版本（一般用于openEuler + ARM架构）
   ./configure --gcc-version=10.3.1 CC=g++ CFLAGS='-O0' --prefix=$GAUSSHOME --3rd=$BINARYLIBS --enable-debug --enable-cassert --enable-thread-safety --with-readline --without-zlib

   # gcc10.3.0版本
./configure --gcc-version=10.3.0 CC=g++ CFLAGS='-O0' --prefix=$GAUSSHOME --3rd=$BINARYLIBS --enable-debug --enable-cassert --enable-thread-safety --with-readline --without-zlib


   release版：

   # gcc7.3.0版本
./configure --gcc-version=7.3.0 CC=g++ CFLAGS="-O2 -g3" --prefix=$GAUSSHOME --3rd=$BINARYLIBS --enable-thread-safety --with-readline --without-zlib

   # gcc10.3.1版本（一般用于openEuler + ARM架构）
   ./configure --gcc-version=10.3.1 CC=g++ CFLAGS="-O2 -g3" --prefix=$GAUSSHOME --3rd=$BINARYLIBS --enable-thread-safety --with-readline --without-zlib

   # gcc10.3.0版本
./configure --gcc-version=10.3.0 CC=g++ CFLAGS="-O2 -g3" --prefix=$GAUSSHOME --3rd=$BINARYLIBS --enable-thread-safety --with-readline --without-zlib


   memcheck版：

   # gcc7.3.0版本
./configure --gcc-version=7.3.0 CC=g++ CFLAGS='-O0' --prefix=$GAUSSHOME --3rd=$BINARYLIBS --enable-debug --enable-cassert --enable-thread-safety --with-readline --without-zlib --enable-memory-check

   # gcc10.3.1版本（一般用于openEuler + ARM架构）
   ./configure --gcc-version=10.3.1 CC=g++ CFLAGS='-O0' --prefix=$GAUSSHOME --3rd=$BINARYLIBS --enable-debug --enable-cassert --enable-thread-safety --with-readline --without-zlib --enable-memory-check

   # gcc10.3.0版本
./configure --gcc-version=10.3.0 CC=g++ CFLAGS='-O0' --prefix=$GAUSSHOME --3rd=$BINARYLIBS --enable-debug --enable-cassert --enable-thread-safety --with-readline --without-zlib --enable-memory-check


    说明：

   • [debug | release | memcheck] 表示可选择三种目标版本，三种目标版本如下所示：

     • release：代表生成release版本的二进制程序，该版本编译时，配置GCC高级别优化选项，去除内核调试代码，通常用于生产环境或性能测试环境。

     • debug：代表生成debug版本的二进制程序，该版本编译时，增加内核代码调试功能，通常用于开发自测环境。

     • memcheck：代表生成memcheck版本的二进制程序。该版本编译时，实质上是在debug版本基础上增加了ASAN功能，此版本通常用于定位内存问题。

   • 在ARM平台上，CFLAGS需要添加-D__USE_NUMA。在ARMv8.1或者更高的平台上（例如鲲鹏920），CFLAGS需要添加-D__ARM_LSE。

   • 若将binarylibs移动到openGauss-server下，或在openGauss-server下创建了指向binarylibs的软链接，可不指定–3rd参数。但这样做的话需要注意其容易被git clean等操作删除。

   • 如需使用MOT，需要在命令中添加 –enable-mot。

5. 执行如下命令，编译安装。

   [user@linux openGauss-server]$ make -sj
[user@linux openGauss-server]$ make install -sj


   说明：

   • -s参数是silent模式，有些编译信息不会打印出来。
   • 如果使用-j参数，make执行的时候会一直增加并发数，有时会遇到“cannot allicate memory”的错。一般-j参数后可指定数字为 cpu数 X 2。如编译环境是4 CPU，可使用make -j8的参数进行编译。

6. 显示如下内容，表示编译安装成功。

   openGauss InstallationGuide complete.


   • 编译后软件安装路径为：$GAUSSHOME
   • 编译后的二进制放置路径为：$GAUSSHOME/bin

openGauss-OM编译

源码编译完openGauss-server代码仓之后，并没有gs_om。如需使用gs_om，需单独编译openGauss-OM，并将编译好的openGauss-xxx-om.tar.gz的包拷贝到openGauss-server安装包所在的目录，再按照企业版的方式进行安装。

操作步骤

1. git clone OM代码仓：

   [user@linux sda]$ git clone https://gitee.com/opengauss/openGauss-OM.git


2. 执行编译：

   [user@linux sda]$ cd openGauss-OM
[user@linux sda]$ chmod +x build.sh
[user@linux sda]$ export BINARYLIBS_PATH=/root/binarylibs (这里填写前面的第三方软件包解压后的目录)
[user@linux sda]$ ./build.sh -3rd $BINARYLIBS_PATH


3. 显示以下内容，表示 Gauss-OM编译成功：

ROOT_DIR: /root/binarylibs
Everything is ready.
success!


产品安装包编译

本步骤是制作openGauss软件安装包，安装包的编译打包过程也集成在build.sh之中。本步骤的编译结果将不含gs_om软件，如需使用，请按openGauss-OM编译的方式处理。

前提条件-1

• 已按照搭建编译环境的要求准备好相关软硬件，并且已参考代码下载下载了代码。
• 已完成开源软件编译构建，具体请参见开源软件编译构建。
• 了解 build.sh介绍脚本的参数选项和功能。
• 代码环境干净，没有以前编译生成的文件。具体请参见FAQ。

操作步骤-1

1. 执行如下命令进入到代码目录。

   [user@linux sda]$ cd /sda/openGauss-server


2. 执行如下命令编译出openGauss产品安装包。

   [user@linux openGauss-server]$ sh build.sh -m [debug | release | memcheck] -3rd [binarylibs path] -pkg


   例如：

   sh build.sh -pkg # 生成release版本的openGauss安装包。需代码目录下有binarylibs或者其软链接，否则将会失败。
sh build.sh -m debug -3rd /sdc/binarylibs -pkg # 生成debug版本的openGauss安装包


   本操作和软件安装编译相比，同样会经历的一键式编译最终生成软件的过程与将软件封装成安装包的过程。对比 build.sh介绍 的使用命令可发现，此处仅增加了一个“-pkg” 功能选项。

3. 显示如下内容，表示安装包编译成功。

   success!


   • 生成的安装包会存放在./output目录下。
   • 编译和打包日志为：./build/script/makemppdb_pkg.log。

编译后验证

编译结束后，可按以下方式对编译后的openGauss进行验证:

1. 使用root用户，创建用户omm：

[user@linux sda]# useradd omm -g dbgrp
[user@linux sda]# passwd omm


1. 使用omm用户，在~/.bashrc中增加以下环境变量：

export GAUSSHOME=/root/openGauss-server/dest/ ##编译结果的路径，可根据实际情况修改
export LD_LIBRARY_PATH=$GAUSSHOME/lib:$LD_LIBRARY_PATH
export PATH=$GAUSSHOME/bin:$PATH


并使环境变量生效：

[user@linux sda]$ source ~/.bashrc


1. 建立数据目录和日志目录：

[user@linux sda]$ mkdir ~/data
[user@linux sda]$ mkdir ~/log
[user@linux sda]$ chown -R omm:dbgrp /root/openGauss-server


1. 数据库初始化：

[user@linux sda]$ gs_initdb -D /home/omm/data --nodename=db1


1. 启动数据库：

[user@linux sda]$ gs_ctl start -D /home/omm/data -Z single_node -l /home/omm/log/opengauss.log


启动完毕后可通过 ps -ef | grep gaussdb检查数据库进程情况，或通过 gs_ctl query -D /home/omm/data检查数据库状态，或使用 gsql -d postgres 进入gsql命令行查看数据库的相关信息。