1 Star 0 Fork 12

Ayrz / xdp

forked from 範輝 / Xdp 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
GPL-3.0

一、概述    

  xdp 是一套纯 C 语言实现的、基于 libgit2 的高性能布署系统后端(即:CI/CD 中的 CD 部分功能),专注于最终线上产品的分发环节,支持无限量大规模布署场景;同时具备监控数据收集、分析功能的朴素布署系统。

1. 系统环境需求

  - 服务端 linux 内核版本 >= 2.6.37
  - 目标端 git 命令可用
  - 目标端 md5sum 命令可用

2. 编译器需求

  - gcc >= 4.4
  - 或 clang >= 3.4

3. 数据库需求

  - postgresql = 10.1

4. 第三方库需求

  - libssh2 = 1.8.0
  - libgit2 = 0.26 [cmake options: THREADSAFE=ON]
  - cJSON = 1.6.0

5. 布署环境需求

  - 服务端可连接所有目标机的 SSH 服务;
  - 所有目标机可连接服务端的 TCP 端口,通常是 20000;
  - 所有目标机可连接服务端的 UDP 端口,通常是 20000(若不使用监控数据收集功能,则不需要)。

6. 安装、启/停方法

  - 可使用源码路径下的 serv_tools/zstart.sh 脚本一键下载、编译、启动 xdp 及数据库、第三方库;
  - 用户无须手动配置上述 3、4 步所述需求;
  - 暂不提供 rpm、deb 等预编译包。

**如下所示,将使用默认配置启动 xdp,监听在本地 20000 端口**              
git clone https://github.com/kt10/xdp.git /tmp/xdp2        
sh /tmp/xdp2/serv_tools/zstart.sh ::1 20000          

7. 命令行参数

选项 描述
-x xdp 的运行路径,通常与 git clone 的目标路径相同
-u xdp 进程所属的用户名
-h xdp 的服务地址,支持 IPv6、IPv4、主机名、域名等形式
-p xdp 服务端口
-H [可选] PostgreSQL host name, default 'localhost'
-A [可选] PostgreSQL host IP addr, if exist, '-H' will be ignored
-P [可选] PostgreSQL host serv port, default '5432'
-U [可选] PostgreSQL login name, default 'git'
-F [可选] PostgreSQL pass file, default '$HOME/.pgpass'
-D [可选] which database to login, default 'svdp'

8. 设计模型

master process(multi threads) > project process(multi threads) > deploy process(single thread)

二、服务接口     

总揽

  xdp 根据用户提供的 opsID 字段,map 到将被调用的接口;标注 “-” 的项表示系统内部私有接口,不对外开放。

  !注!:强烈建议将所有请求中的 repoID 字段置于首位,可提升服务端响应速度。

opsID 描述
0 服务在线状态确认,接收到任意内容,均会会回复一个 "!"
1 新建项目
2 删除项目
3 更新源库 URL 或 分支名称
4 -
5 -
6 -
7 -
8 -
9 打印版本号列表
10 打印两个版本之间的差异文件列表
11 打印两个版本之间的同一个文件的内容差异
12 核心布署接口,并发执行,执行结果影响系统状态
13 -
14 -
15 查询项目元信息与最近一次布署的实时状态

A、项目管理类接口

[opsID 1] 新建项目

  1. 功能描述
- 创建新项目。    
  1. json 请求示例
{
    "repoID": 9,
    "opsID": 1,
    "pathOnHost": "/home/git/xdp2",
    "sshUserName": "john",
    "sshPort": "22",
    "needPull": "Yes",
    "sourceURL": "https://github.com/kt10/xdp.git",
    "sourceBranch": "master",
    "sourceVcsType": "git"
}
字段 描述
repoID [int] 将要创建的项目 ID
pathOnHost [string] 新项目文件在目标机上的存放路径
sshUserName [string] 服务端使用哪个用户身份登陆该项目的所有目标机
sshPort [string] 本项目所有目标机的 SSH 服务端口
needPull [string 可选] 是否需要服务端主动同步源库的文件更新,可使用 "Y" "yes" "N" "no" 等,只要保证首字母为 Y 或 N 即可,不区分大小写
sourceURL [string 条件可选] 若 needPull 为 "Y",则必须提供源库的地址
sourceBranch [string 条件可选] 若 needPull 为 "Y",则必须提供与源库对接的分支名称
sourceVcsType [string 条件可选] 若 needPull 为 "Y",则必须指定源库的 VCS 类型,可使用 "G" "git" 等,以首字母判断,不区分大小写
  1. json 返回示例
**成功返回**
{
    "errNo": 0
}
**出错返回**
{
    "errNo": -1,
    "content": "..."
}
字段 描述
errNo 0 表示成功;否则表示出错
content 存放错误信息
  1. 注意事项
    - 返回成功仅表示服务端所有动作执行成功,各项信息确认无误并写入数据库。

[opsID 2] 删除项目

  1. 功能描述
- 删除指定的项目。    
  1. json 请求示例
{
    "repoID": 9,
    "opsID": 2
}
字段 描述
repoID [int] 将要创建的项目 ID
  1. json 返回示例
**成功返回**
{
    "errNo": 0
}
**出错返回**
{
    "errNo": -1,
    "content": "..."
}
字段 描述
errNo 0 表示成功;否则表示出错
content 存放错误信息
  1. 注意事项
    - 服务端项目路径、数据库中的项目元信息均会被删除;目标机端的项目路径不会被删除。

B、查询类接口

[opsID 9] 打印版本号列表

  1. 功能描述
- 打印最近一次布署之后新产生的版本号列表;
- 打印已布署的版本号列表。    
  1. json 请求示例
{
    "repoID": 35,
    "opsID": 9,
    "dataType": 0
}
字段 描述
repoID [int] 项目 ID
dataType [int] 请求查询的数据类型,0 表示新产生的版本号列表,1 表示已布署版本号列表
  1. json 返回示例
**成功返回**
{
  “errNo”: 0,
  "cacheID": 1555555555,
  ”data”: [
    {
      “revID”: 0,
      “revSig”: "3d93f7220b58a395ba2c56dab024b6d252c5a10e",
      “revTimeStamp”: 1555555555
    },
    {
      “revID”: 1,
      “revSig”: "3d93f7220b58a395ba2c56dab024b6d252c5a10a",
      “revTimeStamp”: 1555555550
    }
  ]
}
**出错返回**
{
    "errNo": -1,
    "content": "..."
}
字段 描述
errNo [int] 0 表示成功,否则表示出错
data [obj array] 存放数据正文
data/revID [int] 版本号 ID
data/revSig [string] 版本号
data/revTimeStamp [int] 版本号 UNIX 时间戳
content [string] 存放错误信息
  1. 注意事项
    - 仅会显示最新的 64 条记录,无论 dataType 是 0 还是 1。

[opsID 10] 打印两个版本之间的差异文件列表

  1. 功能描述
- 打印全部有变动的文件的路径(基于项目顶层的相对路径)。
  1. json 请求示例
{
    "repoID": 35,
    "opsID": 10,
    "dataType": 0,
    "revID": 3,
    "cacheID": 1555555555
}
字段 描述
repoID [int] 项目 ID
dataType [int] 请求查询的数据类型,0 表示新产生的版本号列表,1 表示已布署版本号列表
revID [int] 查询版本号列表时,服务端返回的 revID 字段值
cacheID [int] 查询版本号列表时,服务端返回的 cacheID 字段值
  1. json 返回示例
**成功返回**
{
  “errNo”: 0,
  ”data”: [
    {
      “fileID”: 0,
      “filePath”: "doc/README"
    },
    {
      “fileID”: 1,
      “filePath”: "index.php"
    }
  ]
}
**出错返回**
{
    "errNo": -1,
    "content": "..."
}
字段 描述
errNo [int] 0 表示成功,否则表示出错
data [obj array] 存放数据正文
data/fileID [int] 差异文件 ID
data/filePath [string] 差异文件相对于项目顶层目录的路径
content [string] 存放错误信息
  1. 注意事项
    - 差异文件数量 <=24 时,
    - 以类似 tree 命令视图的形式显示路径的层级关系,
    - 此时 fileID 为 -1 的条目,存放各级目录的名称,
    - fileID >= 0 的条目,存放最终的差异文件名称;
    - 差异文件数量 > 24 时,
    - 以类似 git diff --name-only 命令视图的形式显示原始的路径字符串。

[opsID 11] 打印两个版本之间的同一个文件的差异内容

  1. 功能描述
- 打印单一文件的变动内容。
  1. json 请求示例
{
    "repoID": 35,
    "opsID": 11,
    "dataType": 0,
    "revID": 3,
    "fileID": 8,
    "cacheID": 1555555555
}
字段 描述
repoID [int] 项目 ID
dataType [int] 请求查询的数据类型,0 表示新产生的版本号列表,1 表示已布署版本号列表
revID [int] 查询版本号列表时,服务端返回的 revID 字段值
fileID [int] 查询差异文件列表时,服务端返回的 fileID 字段值
cacheID [int] 查询版本号列表时,服务端返回的 cacheID 字段值
  1. json 返回示例
**成功返回**
{
  “errNo”: 0,
  ”data”: [
    {
      “content”: "+abc\n-efg"
    }
  ]
}
**出错返回**
{
    "errNo": -1,
    "content": "..."
}
字段 描述
errNo [int] 0 表示成功,否则表示出错
data [obj array] 存放数据正文
data/content [int] 同一文件在不同版本之间的差异内容
content [string] 存放错误信息

[opsID 15] 实时进度查询(核心接口)

  1. 功能描述
- 查询最近一次布署的实时进度,包含项目元信息。
  1. json 请求示例
{
    "repoID": 35,
    "opsID": 15
}
字段 描述
repoID [int] 项目 ID
  1. json 返回示例
**成功返回**
{
  "errNo": 0,
  "repoMeta": {
    "id": 35,
    "path": "/home/git/abc",
    "aliasPath": "/home/git/www",
    "createdTime": "2011-11-11 10:00:00"
  },
  "recentDpInfo": {
    "revSig": "123456789009876543211234567890qhwgtsgydt",
    "result": "fail",
    "timeStamp": 1555555555,
    "timeSpent": 6,
    "process": {
      "total": 100,
      "success": 90,
      "fail": {
        "cnt": 2,
        "detail": {
          "servErr": [],
          "netServToHost": ["::1|conn fail","::2|conn fail"],
          "sshAuth": [],
          "hostDisk": [],
          "hostPermission": [],
          "hostFileConflict": [],
          "hostPathNotExist": [],
          "hostDupDeploy": [],
          "hostAddrInvalid": [],
          "netHostToServ": [],
          "hostLoad": [],
          "reqFileNotExist": []
        }
      },
      "inProcess": {
        "cnt": 8,
        "stage": {
          "hostInit": [],
          "servDpOps": [],
          "hostRecvWaiting": ["1.2.3.4"],
          "hostConfirmWaiting": ["fe80::9"]
        }
      }
    }
  },
  "dpDataAnalysis": {
    "successRate": 99.87,
    "avgTimeSpent": 12,
    "errClassification": {
      "total": 5,
      "servErr": 0,
      "netServToHost": 2,
      "sshAuth": 0,
      "hostDisk": 1,
      "hostPermission": 0,
      "hostFileConflict": 1,
      "hostPathNotExist": 0,
      "hostDupDeploy": 0,
      "hostAddrInvalid": 0,
      "netHostToServ": 1,
      "hostLoad": 0,
      "reqFileNotExist": 0
    }
  },
  "hostDataAnalysis": {
    "cpu": {
      "avgLoad": 0.00,
      "loadBalance": 0.00
    },
    "mem": {
      "avgLoad": 0.00,
      "loadBalance": 0.00
    },
    "io/Net": {
      "avgLoad": 0.00,
      "loadBalance": 0.00
    },
    "io/Disk": {
      "avgLoad": 0.00,
      "loadBalance": 0.00
    },
    "diskUsage": {
      "current": 0.00,
      "avg": 0.00,
      "max": 0.00
    }
  }
}
}
**出错返回**
{
    "errNo": -1,
    "content": "..."
}
字段 描述
errNo [int] 0 表示成功,否则表示出错
repoMeta [obj] 项目元信息数据块
repoMeta / id [int] 项目 ID
repoMeta / path [string] 目标机上的项目路径
repoMeta / aliasPath [string] 目标机上的项目路径别名,即软链接
repoMeta / createdTime [string] 项目创建时间
recentDpInfo [obj] 最近一次布署信息数据块
recentDpInfo / revSig [string] 最近一次布署的版本号
recentDpInfo / result [string] 最近一次布署的实时结果
recentDpInfo / timeStamp [int] 最近一次布署的开始时间,UNIX 时间戳格式
recentDpInfo / timeSpent [int] 最近一次布署的实时耗时,单位:秒
recentDpInfo / process [obj] 最近一次布署信息的详情数据块
recentDpInfo / process / total [int] 目标机总数
recentDpInfo / process / success [int] 截止查询当时,已布署成功的目标机数量
recentDpInfo / process / fail [obj] 截止查询当时,已确定布署失败的目标机信息数据块
recentDpInfo / process / fail / cnt [int] 截止查询当时,已确定布署失败的目标机数量
recentDpInfo / process / fail / detail [obj] 截止查询当时,已确定布署失败的目标机的错误详情分类汇总数据块
recentDpInfo / process / fail / detail / servErr [string array] 因服务端错误而失败的目标机列表及详情
recentDpInfo / process / fail / detail / netServToHost [string array] 因服务端到目标机方向网络错误而失败的目标机列表及详情
recentDpInfo / process / fail / detail / sshAuth [string array] 因 SSH 认证错误而失败的目标机列表及详情
recentDpInfo / process / fail / detail / hostDisk [string array] 因目标机磁盘满而失败的目标机列表及详情
recentDpInfo / process / fail / detail / hostPermission [string array] 因目标机上的权限问题而失败的目标机列表及详情
recentDpInfo / process / fail / detail / hostFileConflict [string array] 因目标机上文件冲突而失败的目标机列表及详情
recentDpInfo / process / fail / detail / hostPathNotExist [string array] 因目标机上必须的路径异常缺失而失败的目标机列表及详情
recentDpInfo / process / fail / detail / hostDupDeploy [string array] 因向同一目标机的多个IP布署,造成重复布署而失败的目标机列表及详情
recentDpInfo / process / fail / detail / hostAddrInvalid [string array] 因目标机 IP 地址格式错误而失败的目标机列表及详情
recentDpInfo / process / fail / detail / netHostToServ [string array] 因目标机到服务端方向的网络错误而失败的目标机列表及详情
recentDpInfo / process / fail / detail / hostLoad [string array] 因目标机负载过高而失败的目标机列表及详情
recentDpInfo / process / fail / detail / reqFileNotExist [string array] 因目标机向服务端请求的文件不存在而失败的目标机列表及详情
recentDpInfo / process / inProcess [obj] 截止查询当时,尚未确定最终结果的目标机信息数据块
recentDpInfo / process / inProcess / cnt [int] 截止查询当时,尚未确定最终结果的目标机数据
recentDpInfo / process / inProcess / stage [obj] 截止查询当时,尚未确定最终结果的每个目标机所处的阶段信息数据块
recentDpInfo / process / inProcess / stage / hostInit [string array] 截止查询当时,正处于目标机初始化环节的目标机列表
recentDpInfo / process / inProcess / stage / servDpOps [string array] 截止查询当时,正处于服务端操作环节的目标机列表
recentDpInfo / process / inProcess / stage / hostRecvWaiting [string array] 截止查询当时,正处于确认是否收到布署内容环节的目标机列表
recentDpInfo / process / inProcess / stage / hostConfirmWaiting [string array] 截止查询当时,正处于确认是否确定所收到的内容完整无误环节的目标机列表
dpDataAnalysis [obj] 最近 30 天布署历史分析信息数据块
dpDataAnalysis / successRate [int] 最近 30 天的布署成功率,即 布署成功的次数 / 布署请求次数
dpDataAnalysis / avgTimeSpent [int] 最近 30 天的布署平均耗时,即:所有布署成功的请求耗时之和 / 所有布署成功的目标机台次之和
dpDataAnalysis / errClassification [obj] 最近 30 天发生的错误分类统计
... ...
... ...

C、布署类接口

[opsID 3] 源库 URL 或分支名称更新

  1. 功能描述
- 更新源库的地址或分支名称,多用于测试场景。     
  1. json 请求示例
{
    "repoID": 35,
    "opsID": 13,
    "sourceURL": "https://github.com/kt10/xdp.git",
    "sourceBranch": "dev-tree"
}
字段 描述
repoID [int] 创建项目时指定的 ID
sourceURL [string 可选] 新的源库地址
sourceBranch [string 可选] 新的源库分支名称,即服务端要和哪个分支保持同步
  1. json 返回示例
**成功返回**
{
    "errNo": 0
}
**出错返回**
{
    "errNo": -1,
    "content": "..."
}
字段 描述
errNo 0 表示成功;否则表示出错
content 存放错误信息
  1. 注意事项
    - 更新成功之后,在下一次更新之前,会一直生效;
    - 线上正式环境,不建议频繁更新,可能会产生无法自动处理的文件冲突 。

[opsID 12] 布署(核心接口)

  1. 功能描述
- 批量布署。     
  1. json 请求示例
**使用 revID 布署**
{
    "repoID": 9,
    "opsID": 12,
    "cacheID": 1555555555,
    "revID": 5,
    "dataType": 1,
    "forceDp": "Yes",
    "aliasPath": "/home/git/www",
    "ipCnt": 4,
    "ipList": "::1 , ::2 @ ::3 _ ::4",
    "delim": ", @_",
    "sshUserName": "zhangsan",
    "sshPort": "2222",
    "postDpCmd": "rm -rf /tmp/xxx/*"
}

**使用 revSig 布署**
{
    "repoID": 9,
    "opsID": 12,
    "revSig": "abcdefg12345678abcdefg12345678qwertyui"
    "dataType": 1,
    "forceDp": "N",
    "aliasPath": "/home/git/www",
    "ipCnt": 4,
    "ipList": "::1 , ::2 @ ::3 _ ::4",
    "delim": ", @_",
    "sshUserName": "zhangsan",
    "sshPort": "2222",
    "postDpCmd": "rm -rf /tmp/xxx/*"
}
字段 描述
repoID [int] 创建项目时指定的 ID
cacheID [int 条件可选] 查询版本号列表时取得的 cacheID,未指定 revSig 时此项不能为空
revID [int 条件可选] 查询版本号列表时取得的 revID,未指定 revSig 时此项不能为空
revSig [string 条件可选] 版本号字符串,若指定了此项,则 cacheID 与 revID 两项将被忽略
forceDp [string 可选] 强制布署标志,若指定为 "Y",则目标机端的冲突文件将会被直接清除,默认为 "N"
aliasPath [string 可选] 新建链接到项目路径
ipCnt [int] 目标机数量
ipList [string] 目标机IP列表,以 delim 字段指定的分割符分割,若不指定 delim,则默认使用空格
delim [string 可选] 字段可同时指定多个分割符,如上述示例可被正确解析
sshUserName [string 可选] 更新连接目标机所用的用户名称
sshPort [string 可选] 更新本项目所有目标机的 SSH 服务端口
postDpCmd [string 可选] 布署成功后需要执行的命令
  1. json 返回示例
**出错返回**
{
    "errNo": -1,
    "content": "..."
}
字段 描述
errNo 0 表示成功;否则表示出错
content 存放错误信息
  1. 注意事项
    - 只有服务端发生错误时,才会同步返回结果;
    - 除此之外,无论成败,都不会同步返回结果;
    - 用户可通过实时进度查询接口获取布署结果;
    - 或等待前端系统的邮件、微信通知; - 布署成功,并不代表通过 postDpCmd 字段指定的布署后命令也一定成功。

D、系统内部接口

!!! ==== 仅供了解,用户无需调用 ==== !!!

  • ping-pang:测试服务器在线状态,向服务端发送 "?”,若正常在线会回复 “!”;
  • history-import:系统升级后,导入旧版历史数据;
  • glob_res_confirm:已确认自身布署成功的目标机,通过此接口请求服务端的全局布署结果,若全局布署结果是失败,则该目标机将回滚至原有状态;
  • state_confirm:目标机通过此接口上报布署结果及错误信息;
  • req_file:目标机通过此接口,请求服务端发送指定的文件,如 post-update 缺失时;
  • ... ...

三、常见问题

  1. 无限量大规模布署实现原理?
- 布署服务端,实质是由多个服务器组成的集群,由一台主服务器及多个从服务器(也称为代理机:PROXY)构成,从服务器以 NFS 方式共享主服务器的所有布署数据;        
- 故而,无论需要布署的目标机数量是多少,只要配套足够大的布署服务端集群,即可实现高效布署;     
- 主服务器负责与前端及目标机的交互工作,从服务负责实际的数据推送工作;当不存在从服务器时,主服务器直接进行数据的推送;    
- 当布署请求到来时,主服务器会将布署任务分派至每个从服务器执行推送动作,自身则等待接收所有目标机的状态返回,并处理其间发生的所有错误。        
  1. 目标机 100% 原子性、一致性保证?
- 保证最终一致性,但推送代码或失败回滚的过程中,难免会存在时间差。    
  1. 用户定制的布署后动作结果,如何保证?
- 非核心功能,目前不保证执行结果。    

四、代码结构简介

  • bin/:存放最终编译出的二进制文件,即 xdp 服务程序;
  • src/:存放主程序核心代码;
  • inc/:与 src/ 中的源文件一一对应的头文件;
  • lib/:存放第三方库的源码及编译结果;
  • tools/:需要传送到布署目标机上运行的 shell 脚本,如:post-update 勾子等;
  • serv_tools/:用于方便服务端管理的 shell 脚本,非必须;
  • screen_shoot_sample/:运行示例截图,非必须;
  • qemu_kvm/:一组 qemu/kvm 虚拟机 shell 脚本,用于快速启动测试环境,非必须;
  • log/:shell 重定向产生的日志信息,非必须。

五、宏观架构图 [已过时,需要更新]

GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: <program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <http://www.gnu.org/licenses/>. The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.

简介

一个纯 C 语言实现的 CD 引擎 展开 收起
C
GPL-3.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C
1
https://gitee.com/ayrz2010/xdp.git
git@gitee.com:ayrz2010/xdp.git
ayrz2010
xdp
xdp
master

搜索帮助

14c37bed 8189591 565d56ea 8189591