REM:
修改说明文档
This commit is contained in:
黄昕 2019-06-11 15:52:41 +08:00
parent 26fbd50cf3
commit 56b5d324e6
3 changed files with 51 additions and 36 deletions

View File

View File

@ -3,13 +3,31 @@
  安全网关项目产品侧仓库,主要存放应用与安全网关设备上的应用、内核等相关功能的代码。   安全网关项目产品侧仓库,主要存放应用与安全网关设备上的应用、内核等相关功能的代码。
## **目录结构** ## **目录结构**
<pre> <pre>
Product 安全网关产品源代码主目录 . 安全网关产品源代码主目录
├── build Makefile和编译脚本目录 ├── Common
├── common 公共代码/头文件/配置文件 目录 ├── Platform 平台侧工程目录
├── modules linux内核态源代码目录 │   ├── build 平台侧系统构建 Makefile 目录
│ └── demo 内核态驱动程序 demo 目录 | ├── common 平台侧公共代码目录
└── user 用户态源代码目录 │   ├── modules 平台侧内核态工程源代码目录
└── demo 用户态应用程序 demo 目录 │   │   ├── cfgrcv
│   │   ├── conntrack_api
│   │   │   ├── api
│   │   │   ├── demoA
│   │   │   └── test
│   │   ├── netlink_api
│   │   └── pdelivery
│   └── user 平台侧用户态工程源代码目录
│   ├── cfg2kernel
│   ├── netlink_uapi
│   └── pdeliv_u
├── Product 产品侧工程目录
│   ├── build 产品侧系统构建 Makefile 目录
│   ├── common 产品侧公共代码目录
│   ├── modules 产品侧内核态工程源代码目录
│   │   └── demo 内核态态应用程序 demo 目录
│   └── user 产品侧用户态工程源代码目录
│   └── demo 用户态应用程序 demo 目录
└── kernel 内核源码存放目录
</pre> </pre>
>#### **注意事项:** >#### **注意事项:**
@ -21,7 +39,7 @@ Product 安全网关产品源代码主目录
## **编译方法** ## **编译方法**
#### 1. 从仓库获取最新代码 #### 1. 从仓库获取最新代码
<code>git clone https://git.komect.net:SDX/vBRAS.git</code> <code>git clone git@git.komect.net:ISG/secogateway.git</code>
<code>git pull</code> <code>git pull</code>
@ -34,12 +52,9 @@ sudo apt-get -y install python-pip qemu-utils libncurses5-dev python-crypto biso
#### 3. 安装 linux 内核源代码 #### 3. 安装 linux 内核源代码
<code>sudo mkdir -p /opt/fsl-kernel /opt/fsl-kernel/arm64 /opt/fsl-kernel/x86 <code>sudo mkdir -p /opt/fsl-kernel /opt/fsl-kernel/arm64 /opt/fsl-kernel/x86
sudo chmod 777 /opt/fsl-kernel -R sudo chmod 644 /opt/fsl-kernel -R
cp ./vBRAS/Platform/kernel/linux-4.9.140.tar.gz /opt/fsl-kernel cp ./kernel/linux-4.14.83 /opt/fsl-kernel/x86 -rf
cd /opt/fsl-kernel cp ./kernel/linux-4.14.83 /opt/fsl-kernel/arm64 -rf
tar -xvaf ./linux-4.9.140.tar.gz ./
cp ./linux-4.9.140 ./x86
cp ./linux-4.9.140 ./arm64
</code> </code>
#### 4. 设置环境变量 #### 4. 设置环境变量
@ -66,8 +81,8 @@ CROSS_COMPILE ?= aarch64-fsl-linux-</code>
#### 6. 构建系统 #### 6. 构建系统
+ 构建 + 构建
<code>cd vBRAS/Product <code>cd secogateway
make</code> make OPT=clean && make</code>
</code> </code>
+ 清理 + 清理
<code>make OPT=clean</code> <code>make OPT=clean</code>
@ -86,15 +101,15 @@ _install
└── LINUX ARM64 平台的可执行程序、驱动调试符号信息 └── LINUX ARM64 平台的可执行程序、驱动调试符号信息
</pre> </pre>
+ 编译信息 + 编译信息
执行 make 命令进行编译结束后,vBRAS/Common/compile.h 文件中保存了当前系统编译信息,可以在代码中直接引用。 执行 make 命令进行编译结束后,./Common/compile.h 文件中保存了当前系统编译信息,可以在代码中直接引用。
<code>#define vBRAS_COMPILE_DATE "2019-05-22" <code>#define sGATE_COMPILE_DATE "2019-05-22"
#define vBRAS_COMPILE_TIME "11:19:58" #define sGATE_COMPILE_TIME "11:19:58"
#define vBRAS_COMPILE_MAJOR "20190522" #define sGATE_COMPILE_MAJOR "20190522"
#define vBRAS_COMPILE_SUB "111958" #define sGATE_COMPILE_SUB "111958"
#define vBRAS_COMPILE_BY "hx" #define sGATE_COMPILE_BY "hx"
#define vBRAS_COMPILE_HOST "hx-ubuntu" #define sGATE_COMPILE_HOST "hx-ubuntu"
#define vBRAS_GIT_TAGS "vBRAS1.0-20181213-stable-159-g1b4c69da2-dev" #define sGATE_GIT_TAGS "sGATE1.0-20181213-stable-159-g1b4c69da2-dev"
#define vBRAS_GIT_VERS "1b4c69da2d9cd6d133075f2fd96fbe0ac220fb72" #define sGATE_GIT_VERS "1b4c69da2d9cd6d133075f2fd96fbe0ac220fb72"
</code> </code>
vBRAS_GIT_TAGS 记录了当前源码在 gitlab 服务器上面的分支信息 sGATE_GIT_TAGS 记录了当前源码在 gitlab 服务器上面的分支信息
vBRAS_GIT_VERS 记录了当前源码在 gitlab 服务器上面的版本信息 sGATE_GIT_VERS 记录了当前源码在 gitlab 服务器上面的版本信息

View File

@ -5,17 +5,17 @@ UTS_TRUNCATE="cut -b -$UTS_LEN"
VERSION_FILE=./Common/compile.h VERSION_FILE=./Common/compile.h
( (
echo /\* This file is auto generated,for vBRAS version info \*/ echo /\* This file is auto generated,for sGATE version info \*/
echo /\* Used readelf to get this information form driver of application \*/ echo /\* Used readelf to get this information form driver of application \*/
echo /\* \"readelf --debug-dump=macro \<filename\>\" \*/ echo /\* \"readelf --debug-dump=macro \<filename\>\" \*/
echo \#define vBRAS_COMPILE_DATE \"`date +%F`\" echo \#define sGATE_COMPILE_DATE \"`date +%F`\"
echo \#define vBRAS_COMPILE_TIME \"`date +%T`\" echo \#define sGATE_COMPILE_TIME \"`date +%T`\"
echo \#define vBRAS_COMPILE_MAJOR \"`date +%Y%m%d`\" echo \#define sGATE_COMPILE_MAJOR \"`date +%Y%m%d`\"
echo \#define vBRAS_COMPILE_SUB \"`date +%H%M%S`\" echo \#define sGATE_COMPILE_SUB \"`date +%H%M%S`\"
echo \#define vBRAS_COMPILE_BY \"`whoami`\" echo \#define sGATE_COMPILE_BY \"`whoami`\"
echo \#define vBRAS_COMPILE_HOST \"`hostname | $UTS_TRUNCATE`\" echo \#define sGATE_COMPILE_HOST \"`hostname | $UTS_TRUNCATE`\"
echo \#define vBRAS_GIT_TAGS \"`git describe --tags --always --dirty="-dev"`\" echo \#define sGATE_GIT_TAGS \"`git describe --tags --always --dirty="-dev"`\"
echo \#define vBRAS_GIT_VERS \"`git rev-parse HEAD`\" echo \#define sGATE_GIT_VERS \"`git rev-parse HEAD`\"
) > $VERSION_FILE ) > $VERSION_FILE