This commit is contained in:
virusdefender 2016-10-05 23:43:54 +08:00
parent 4c924d4487
commit 03b9a058a3
11 changed files with 1 additions and 3081 deletions

2
CNAME
View File

@ -1 +1 @@
docs.onlinejudge.me
docs.onlinejudge.me

View File

@ -1,387 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../../../img/favicon.ico">
<title>API - Online Judge Docs</title>
<link href="../../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../../css/font-awesome-4.0.3.css" rel="stylesheet">
<link rel="stylesheet" href="../../../css/highlight.css">
<link href="../../../css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href="../../..">Online Judge Docs</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li >
<a href="../../..">Home</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Judger <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">English</a>
<ul class="dropdown-menu">
<li >
<a href="../../../judger/English/api/">API</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">JudgeServer <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">Chinese</a>
<ul class="dropdown-menu">
<li class="active">
<a href="./">API</a>
</li>
<li >
<a href="../deploy/">Deploy</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li >
<a rel="next" href="../../../judger/English/api/">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="../deploy/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#judgeserver-api">JudgeServer API</a></li>
<li class="main "><a href="#_1">获取系统状态</a></li>
<li><a href="#_2">参数</a></li>
<li><a href="#_3">响应</a></li>
<li class="main "><a href="#special-judge">判题非Special Judge)</a></li>
<li><a href="#_4">参数</a></li>
<li><a href="#_5">响应</a></li>
<li class="main "><a href="#special-judge_1">编译Special Judge</a></li>
<li><a href="#_6">参数</a></li>
<li><a href="#_7">响应</a></li>
<li class="main "><a href="#special-judge_2">判题Special Judge)</a></li>
<li><a href="#_8">参数</a></li>
<li><a href="#_9">响应</a></li>
<li class="main "><a href="#result">result 字段含义</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="judgeserver-api">JudgeServer API</h1>
<p>所有的请求请在HTTP头中放入<code>X-Judge-Server-Token</code>字段值为token的sha256结果。</p>
<p>所有的响应都是两个字段,<code>err</code><code>data</code>,正常情况下<code>err</code><code>null</code><code>data</code>为响应的数据。出现错误的情况下,<code>err</code>是错误代码,<code>data</code>为错误详情。下面所有的响应都是<code>data</code>的内容。</p>
<h1 id="_1">获取系统状态</h1>
<ul>
<li>URL <code>/ping</code></li>
<li>Method <code>POST</code></li>
</ul>
<h2 id="_2">参数</h2>
<ul>
<li>无参数</li>
</ul>
<h2 id="_3">响应</h2>
<pre><code class="js">{
&quot;judger_version&quot;: &quot;2.0.1&quot;,
&quot;hostname&quot;: &quot;d3765528134e&quot;,
// cpu核数这个数字也确定了可以并发运行的判题任务数量
&quot;cpu_core&quot;: 1,
// cpu和内存使用率百分比
&quot;cpu&quot;: 4.1,
&quot;memory&quot;: 24.5
}
</code></pre>
<h1 id="special-judge">判题非Special Judge)</h1>
<ul>
<li>URL <code>/judge</code></li>
<li>Method <code>POST</code></li>
</ul>
<h2 id="_4">参数</h2>
<ul>
<li>src源码</li>
<li>language_config参考<code>languages.py</code>中,一般不需要修改</li>
<li>submission_id这个提交唯一的id请不要出现重复比如使用时间戳也是不推荐的</li>
<li>max_cpu_time单位毫秒</li>
<li>max_memory最大内存单位字节</li>
<li>test_case_id用于找到存放有测试用例的文件夹</li>
</ul>
<h2 id="_5">响应</h2>
<pre><code class="js">[
// 每组都是一个测试用例通过test_case字段区分
{
// cpu时间毫秒
&quot;cpu_time&quot;: 1,
// 见本文档最后部分
&quot;result&quot;: 0,
// 内存,字节
&quot;memory&quot;: 12836864,
// 实际时间,毫秒
&quot;real_time&quot;: 2,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: &quot;eccbc87e4b5ce2fe28308fd9f2a7baf3&quot;,
// 测试用例id
&quot;test_case&quot;: 1
},
{
&quot;cpu_time&quot;: 1,
&quot;result&quot;: 0,
&quot;memory&quot;: 12849152,
&quot;real_time&quot;: 1,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: &quot;eccbc87e4b5ce2fe28308fd9f2a7baf3&quot;,
&quot;test_case&quot;: 2
}
]
</code></pre>
<p>在编译错误的时候,返回</p>
<pre><code class="js">{
&quot;err&quot;: &quot;CompileError&quot;,
&quot;data&quot;: &quot;编译器的错误输出&quot;
}
</code></pre>
<h1 id="special-judge_1">编译Special Judge</h1>
<ul>
<li>URL <code>/compile_spj</code></li>
<li>Method <code>POST</code></li>
</ul>
<h2 id="_6">参数</h2>
<ul>
<li>src源码</li>
<li>spj_versionSpecial Judge的版本用于决定是否要重新编译二进制</li>
<li>spj_compile_config参考<code>languages.py</code>,一般不需要修改</li>
<li>test_case_id</li>
</ul>
<h2 id="_7">响应</h2>
<pre><code class="js">&quot;success&quot;
</code></pre>
<p>在编译错误的时候,返回</p>
<pre><code class="js">{
&quot;err&quot;: &quot;SPJCompileError&quot;,
&quot;data&quot;: &quot;编译器的错误输出&quot;
}
</code></pre>
<h1 id="special-judge_2">判题Special Judge)</h1>
<p>注意必须提前编译Special Judge见上一个API</p>
<ul>
<li>URL <code>/judge</code></li>
<li>Method <code>POST</code></li>
</ul>
<h2 id="_8">参数</h2>
<ul>
<li>src</li>
<li>language_config</li>
<li>submission_id</li>
<li>max_cpu_time</li>
<li>max_memory</li>
<li>test_case_id</li>
<li>spj_version</li>
<li>spj_config参考<code>languages.py</code>,一般不需要修改</li>
</ul>
<h2 id="_9">响应</h2>
<pre><code class="js">[
// 每组都是一个测试用例通过test_case字段区分
{
// cpu时间毫秒
&quot;cpu_time&quot;: 1,
// 见本文档最后部分
&quot;result&quot;: 0,
// 内存,字节
&quot;memory&quot;: 12836864,
// 实际时间,毫秒
&quot;real_time&quot;: 2,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: None,
// 测试用例id
&quot;test_case&quot;: 1
},
{
&quot;cpu_time&quot;: 1,
&quot;result&quot;: 0,
&quot;memory&quot;: 12849152,
&quot;real_time&quot;: 1,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: None,
&quot;test_case&quot;: 2
}
]
</code></pre>
<p>在编译错误的时候,返回</p>
<pre><code class="js">{
&quot;err&quot;: &quot;CompileError&quot;,
&quot;data&quot;: &quot;编译器的错误输出&quot;
}
</code></pre>
<h1 id="result">result 字段含义</h1>
<ul>
<li>WRONG_ANSWER = -1</li>
<li>AEECPTED = 0</li>
<li>CPU_TIME_LIMITED = 1</li>
<li>REAL_TIME_LIMIT_EXCEEDED = 2</li>
<li>MEMORY_LIMIT_EXCEEDED = 3</li>
<li>RUNTIME_ERROR = 4</li>
<li>SYSTEM_ERROR = 5</li>
</ul></div>
</div>
<footer class="col-md-12">
<hr>
<center>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</center>
</footer>
<script src="../../../js/jquery-1.10.2.min.js"></script>
<script src="../../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../../js/highlight.pack.js"></script>
<script>var base_url = '../../..';</script>
<script data-main="../../../mkdocs/js/search.js" src="../../../mkdocs/js/require.js"></script>
<script src="../../../js/base.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form role="form">
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>

View File

@ -1,233 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../../../img/favicon.ico">
<title>部署 - Online Judge Docs</title>
<link href="../../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../../css/font-awesome-4.0.3.css" rel="stylesheet">
<link rel="stylesheet" href="../../../css/highlight.css">
<link href="../../../css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href="../../..">Online Judge Docs</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li >
<a href="../../..">Home</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Judger <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../../judger/">Index</a>
</li>
<li class="dropdown-submenu">
<a tabindex="-1" href="">English</a>
<ul class="dropdown-menu">
<li >
<a href="../../../judger/English/">API</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">JudgeServer <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../">Index</a>
</li>
<li class="dropdown-submenu">
<a tabindex="-1" href="">English</a>
<ul class="dropdown-menu">
<li >
<a href="../../English/">API</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a tabindex="-1" href="">中文</a>
<ul class="dropdown-menu">
<li >
<a href="../">API</a>
</li>
<li class="active">
<a href="./">部署</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li >
<a rel="next" href="../">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="disabled">
<a rel="prev" >
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#link">同主机link场景</a></li>
<li class="main "><a href="#_1">跨主机场景</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="link">同主机link场景</h1>
<p>oj_web_server和judge_server在同一台服务器上而且judge_server中link oj_web_server。</p>
<p>oj_web_server需要设置环境变量<code>judger_token</code>,这样<code>judge_server</code>就可以在<code>OJ_WEB_SERVER_ENV_judger_token</code>环境变量中得到token<code>OJ_WEB_SERVER_PORT_8080_TCP_ADDR</code>得到ip<code>OJ_WEB_SERVER_PORT_8080_TCP_PORT</code>得到端口从而每5秒向该ip发送心跳包在HTTP头中携带了<code>X-JUDGE-SERVER-TOKEN</code>值为token的sha256。</p>
<h1 id="_1">跨主机场景</h1>
<p>如果不在同一台服务器上需要手动设置judge_server的下面四个环境变量</p>
<ul>
<li><code>service_discovery_url</code></li>
<li><code>judger_token</code></li>
</ul>
<p>通过以上两个环境变量这样就可以向该url发送心跳包了</p>
<ul>
<li><code>service_host</code></li>
<li><code>service_port</code></li>
</ul>
<p>因为跨主机的情况下oj_web_server是无法得知judge_server的ip和端口的需要主动的设置然后在心跳包中会带上这两个信息让oj_web_server能够主动访问。此时judge_server只能使用固定端口映射。</p></div>
</div>
<footer class="col-md-12">
<hr>
<center>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</center>
</footer>
<script src="../../../js/jquery-1.10.2.min.js"></script>
<script src="../../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../../js/highlight.pack.js"></script>
<script>var base_url = '../../..';</script>
<script data-main="../../../mkdocs/js/search.js" src="../../../mkdocs/js/require.js"></script>
<script src="../../../js/base.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form role="form">
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>

View File

@ -1,414 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../../img/favicon.ico">
<title>API - Online Judge Docs</title>
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
<link rel="stylesheet" href="../../css/highlight.css">
<link href="../../css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href="../..">Online Judge Docs</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li >
<a href="../..">Home</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Judger <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../judger/">Index</a>
</li>
<li class="dropdown-submenu">
<a tabindex="-1" href="">English</a>
<ul class="dropdown-menu">
<li >
<a href="../../judger/English/">API</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">JudgeServer <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../">Index</a>
</li>
<li class="dropdown-submenu">
<a tabindex="-1" href="">English</a>
<ul class="dropdown-menu">
<li >
<a href="../English/">API</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a tabindex="-1" href="">中文</a>
<ul class="dropdown-menu">
<li class="active">
<a href="./">API</a>
</li>
<li >
<a href="deploy/">部署</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li >
<a rel="next" href="../English/">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="deploy/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#judgeserver-api">JudgeServer API</a></li>
<li class="main "><a href="#_1">获取系统状态</a></li>
<li><a href="#_2">参数</a></li>
<li><a href="#_3">响应</a></li>
<li class="main "><a href="#special-judge">判题非Special Judge)</a></li>
<li><a href="#_4">参数</a></li>
<li><a href="#_5">响应</a></li>
<li class="main "><a href="#special-judge_1">编译Special Judge</a></li>
<li><a href="#_6">参数</a></li>
<li><a href="#_7">响应</a></li>
<li class="main "><a href="#special-judge_2">判题Special Judge)</a></li>
<li><a href="#_8">参数</a></li>
<li><a href="#_9">响应</a></li>
<li class="main "><a href="#result">result 字段含义</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="judgeserver-api">JudgeServer API</h1>
<p>所有的请求请在HTTP头中放入<code>X-Judge-Server-Token</code>字段值为token的sha256结果。</p>
<p>所有的响应都是两个字段,<code>err</code><code>data</code>,正常情况下<code>err</code><code>null</code><code>data</code>为响应的数据。出现错误的情况下,<code>err</code>是错误代码,<code>data</code>为错误详情。下面所有的响应都是<code>data</code>的内容。</p>
<h1 id="_1">获取系统状态</h1>
<ul>
<li>URL <code>/ping</code></li>
<li>Method <code>POST</code></li>
</ul>
<h2 id="_2">参数</h2>
<ul>
<li>无参数</li>
</ul>
<h2 id="_3">响应</h2>
<pre><code class="js">{
&quot;judger_version&quot;: &quot;2.0.1&quot;,
&quot;hostname&quot;: &quot;d3765528134e&quot;,
// cpu核数这个数字也确定了可以并发运行的判题任务数量
&quot;cpu_core&quot;: 1,
// cpu和内存使用率百分比
&quot;cpu&quot;: 4.1,
&quot;memory&quot;: 24.5
}
</code></pre>
<h1 id="special-judge">判题非Special Judge)</h1>
<ul>
<li>URL <code>/judge</code></li>
<li>Method <code>POST</code></li>
</ul>
<h2 id="_4">参数</h2>
<ul>
<li>src源码</li>
<li>language_config参考<code>languages.py</code>中,一般不需要修改</li>
<li>submission_id这个提交唯一的id请不要出现重复比如使用时间戳也是不推荐的</li>
<li>max_cpu_time单位毫秒</li>
<li>max_memory最大内存单位字节</li>
<li>test_case_id用于找到存放有测试用例的文件夹</li>
</ul>
<h2 id="_5">响应</h2>
<pre><code class="js">[
// 每组都是一个测试用例通过test_case字段区分
{
// cpu时间毫秒
&quot;cpu_time&quot;: 1,
// 见本文档最后部分
&quot;result&quot;: 0,
// 内存,字节
&quot;memory&quot;: 12836864,
// 实际时间,毫秒
&quot;real_time&quot;: 2,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: &quot;eccbc87e4b5ce2fe28308fd9f2a7baf3&quot;,
// 测试用例id
&quot;test_case&quot;: 1
},
{
&quot;cpu_time&quot;: 1,
&quot;result&quot;: 0,
&quot;memory&quot;: 12849152,
&quot;real_time&quot;: 1,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: &quot;eccbc87e4b5ce2fe28308fd9f2a7baf3&quot;,
&quot;test_case&quot;: 2
}
]
</code></pre>
<p>在编译错误的时候,返回</p>
<pre><code class="js">{
&quot;err&quot;: &quot;CompileError&quot;,
&quot;data&quot;: &quot;编译器的错误输出&quot;
}
</code></pre>
<h1 id="special-judge_1">编译Special Judge</h1>
<ul>
<li>URL <code>/compile_spj</code></li>
<li>Method <code>POST</code></li>
</ul>
<h2 id="_6">参数</h2>
<ul>
<li>src源码</li>
<li>spj_versionSpecial Judge的版本用于决定是否要重新编译二进制</li>
<li>spj_compile_config参考<code>languages.py</code>,一般不需要修改</li>
<li>test_case_id</li>
</ul>
<h2 id="_7">响应</h2>
<pre><code class="js">&quot;success&quot;
</code></pre>
<p>在编译错误的时候,返回</p>
<pre><code class="js">{
&quot;err&quot;: &quot;SPJCompileError&quot;,
&quot;data&quot;: &quot;编译器的错误输出&quot;
}
</code></pre>
<h1 id="special-judge_2">判题Special Judge)</h1>
<p>注意必须提前编译Special Judge见上一个API</p>
<ul>
<li>URL <code>/judge</code></li>
<li>Method <code>POST</code></li>
</ul>
<h2 id="_8">参数</h2>
<ul>
<li>src</li>
<li>language_config</li>
<li>submission_id</li>
<li>max_cpu_time</li>
<li>max_memory</li>
<li>test_case_id</li>
<li>spj_version</li>
<li>spj_config参考<code>languages.py</code>,一般不需要修改</li>
</ul>
<h2 id="_9">响应</h2>
<pre><code class="js">[
// 每组都是一个测试用例通过test_case字段区分
{
// cpu时间毫秒
&quot;cpu_time&quot;: 1,
// 见本文档最后部分
&quot;result&quot;: 0,
// 内存,字节
&quot;memory&quot;: 12836864,
// 实际时间,毫秒
&quot;real_time&quot;: 2,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: None,
// 测试用例id
&quot;test_case&quot;: 1
},
{
&quot;cpu_time&quot;: 1,
&quot;result&quot;: 0,
&quot;memory&quot;: 12849152,
&quot;real_time&quot;: 1,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: None,
&quot;test_case&quot;: 2
}
]
</code></pre>
<p>在编译错误的时候,返回</p>
<pre><code class="js">{
&quot;err&quot;: &quot;CompileError&quot;,
&quot;data&quot;: &quot;编译器的错误输出&quot;
}
</code></pre>
<h1 id="result">result 字段含义</h1>
<ul>
<li>WRONG_ANSWER = -1</li>
<li>AEECPTED = 0</li>
<li>CPU_TIME_LIMITED = 1</li>
<li>REAL_TIME_LIMIT_EXCEEDED = 2</li>
<li>MEMORY_LIMIT_EXCEEDED = 3</li>
<li>RUNTIME_ERROR = 4</li>
<li>SYSTEM_ERROR = 5</li>
</ul></div>
</div>
<footer class="col-md-12">
<hr>
<center>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</center>
</footer>
<script src="../../js/jquery-1.10.2.min.js"></script>
<script src="../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../js/highlight.pack.js"></script>
<script>var base_url = '../..';</script>
<script data-main="../../mkdocs/js/search.js" src="../../mkdocs/js/require.js"></script>
<script src="../../js/base.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form role="form">
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>

View File

@ -1,254 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../../../img/favicon.ico">
<title>Deploy - Online Judge Docs</title>
<link href="../../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../../css/font-awesome-4.0.3.css" rel="stylesheet">
<link rel="stylesheet" href="../../../css/highlight.css">
<link href="../../../css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href="../../..">Online Judge Docs</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li >
<a href="../../..">Home</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Judger <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">English</a>
<ul class="dropdown-menu">
<li >
<a href="../../../judger/English/">API</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">JudgeServer <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">English</a>
<ul class="dropdown-menu">
<li >
<a href="../">API</a>
</li>
<li class="active">
<a href="./">Deploy</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li >
<a rel="next" href="../">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="disabled">
<a rel="prev" >
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#containers-are-in-the-same-host-and-can-be-linked">Containers are in the same host and can be linked</a></li>
<li class="main "><a href="#containers-are-deployed-in-multi-hosts">Containers are deployed in multi hosts</a></li>
<li class="main "><a href="#heartbeat-request">heartbeat request</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<p>There are two methods to deplloy this server depending on the scene.</p>
<h1 id="containers-are-in-the-same-host-and-can-be-linked">Containers are in the same host and can be linked</h1>
<p>Example of <code>docker-compose.yml</code></p>
<pre><code class="yml">oj_web_server:
environment:
- judger_token=SOME TOKEN
ports:
- &quot;0.0.0.0:8000:8080&quot;
judge_server:
links:
- oj_web_server:oj_web_server
ports:
- &quot;127.0.0.1::8080&quot;
</code></pre>
<p>When containers are linked, <code>judge_server</code> can get environment variable <code>OJ_WEB_SERVER_ENV_judger_token</code> as token get <code>OJ_WEB_SERVER_PORT_8080_TCP_ADDR</code> as server ip get <code>OJ_WEB_SERVER_PORT_8080_TCP_PORT</code> as server port. As a result, <code>judge_server</code> can send heartbeat request to <code>oj_web_server</code>.</p>
<h1 id="containers-are-deployed-in-multi-hosts">Containers are deployed in multi hosts</h1>
<p>Three environment variables below must be set manully in <code>docker-compose.yml</code></p>
<ul>
<li><code>service_discovery_url</code></li>
<li><code>judger_token</code></li>
<li><code>service_url</code></li>
</ul>
<p><code>judge_server</code> will send heartbeat request to <code>service_discovery_url</code>.</p>
<p><code>service_url</code> is used to tell server to send task to this url(<code>judge_server</code>).</p>
<p>Example of <code>docker-compose.yml</code></p>
<pre><code class="yml">judge_server:
- environment
- judger_token=SOME TOKEN
- service_discovery_url=http://onlinejudge.com/api/judge_server
- service_url=http://1.2.3.4:8005
- ports:
- &quot;0.0.0.0:8005:8080&quot;
</code></pre>
<h1 id="heartbeat-request">heartbeat request</h1>
<ul>
<li>Method <code>POST</code></li>
<li><code>X-JUDGE-SERVER-TOKEN</code>: <code>sha256(token)</code></li>
<li><code>Content-Type</code>: <code>application/json</code></li>
</ul>
<p>Request data</p>
<pre><code class="js"> {
&quot;judger_version&quot;: &quot;2.0.1&quot;,
&quot;hostname&quot;: &quot;c45acd557074&quot;,
&quot;cpu_core&quot;: 1,
&quot;memory&quot;: 30.3,
&quot;action&quot;: &quot;heartbeat&quot;,
&quot;cpu&quot;: 0,
&quot;service_url&quot;: null or &quot;http://1.2.3.4:8005&quot;
}
</code></pre>
<p>If everything is OK, you should give a JSON response as follows</p>
<pre><code class="js">{
&quot;data&quot;: &quot;success&quot;,
&quot;err&quot;: null
}
</code></pre></div>
</div>
<footer class="col-md-12">
<hr>
<center>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</center>
</footer>
<script src="../../../js/jquery-1.10.2.min.js"></script>
<script src="../../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../../js/highlight.pack.js"></script>
<script>var base_url = '../../..';</script>
<script data-main="../../../mkdocs/js/search.js" src="../../../mkdocs/js/require.js"></script>
<script src="../../../js/base.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form role="form">
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>

View File

@ -1,407 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../../img/favicon.ico">
<title>API - Online Judge Docs</title>
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
<link rel="stylesheet" href="../../css/highlight.css">
<link href="../../css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href="../..">Online Judge Docs</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li >
<a href="../..">Home</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Judger <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">English</a>
<ul class="dropdown-menu">
<li >
<a href="../../judger/English/">API</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">JudgeServer <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">English</a>
<ul class="dropdown-menu">
<li class="active">
<a href="./">API</a>
</li>
<li >
<a href="deploy/">Deploy</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li >
<a rel="next" href="../../judger/English/">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="deploy/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#judgeserver-api">JudgeServer API</a></li>
<li><a href="#preparement">Preparement</a></li>
<li class="main "><a href="#get-system-info">Get system info</a></li>
<li><a href="#args">Args</a></li>
<li><a href="#response">Response</a></li>
<li class="main "><a href="#judge-not-for-special-judge">Judge (not for Special Judge)</a></li>
<li><a href="#args_1">Args</a></li>
<li><a href="#response_1">Response</a></li>
<li class="main "><a href="#compile-special-judge">Compile Special Judge</a></li>
<li><a href="#args_2">Args</a></li>
<li><a href="#response_2">Response</a></li>
<li class="main "><a href="#judge-for-special-judge">Judge (for Special Judge)</a></li>
<li><a href="#args_3">Args</a></li>
<li><a href="#response_3">Response</a></li>
<li class="main "><a href="#result-field-return-value">result field return value</a></li>
<li class="main "><a href="#error-field-return-value">error field return value</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="judgeserver-api">JudgeServer API</h1>
<h2 id="preparement">Preparement</h2>
<ul>
<li><code>X-Judge-Server-Token</code> HTTP header is required for all requests, the value of this header is <code>sha256(token)</code>.</li>
<li>Type of request and response data is JSON.</li>
<li>Request method is <code>POST</code>.</li>
<li>
<p>For all responses, <code>err</code> and <code>data</code> fields will be returned. </p>
<ul>
<li>If the request is processed successfully, <code>err</code> field will be <code>null</code>, <code>data</code> field will be the data returned. </li>
<li>If error occured while processing request, <code>err</code> field will be error code, <code>data</code> field will be the reason.</li>
</ul>
</li>
</ul>
<h1 id="get-system-info">Get system info</h1>
<ul>
<li>URL <code>/ping</code></li>
</ul>
<h2 id="args">Args</h2>
<ul>
<li>Do not need args</li>
</ul>
<h2 id="response">Response</h2>
<pre><code class="js">{
&quot;judger_version&quot;: &quot;2.0.1&quot;,
&quot;hostname&quot;: &quot;d3765528134e&quot;,
// number of cpu cores, this value will determine the number of concurrent tasks
&quot;cpu_core&quot;: 1,
// usage of cpu and memory
&quot;cpu&quot;: 4.1,
&quot;memory&quot;: 24.5
}
</code></pre>
<h1 id="judge-not-for-special-judge">Judge (not for Special Judge)</h1>
<ul>
<li>URL <code>/judge</code></li>
</ul>
<h2 id="args_1">Args</h2>
<ul>
<li><code>src</code>: source code</li>
<li><code>language_config</code>: refer to <code>client/Python/languages.py</code>, do not need to modify generally</li>
<li><code>submission_id</code>: the only id of the submission, do not repeat</li>
<li><code>max_cpu_time</code>: unit is ms</li>
<li><code>max_memory</code>: unit is byte</li>
<li><code>test_case_id</code>: used to get the test_case directory</li>
</ul>
<h2 id="response_1">Response</h2>
<pre><code class="js">[
// each object/dict is a test case file running result
{
&quot;cpu_time&quot;: 1,
// refer to the end of this document
&quot;result&quot;: 0,
&quot;memory&quot;: 12836864,
&quot;real_time&quot;: 2,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
// refer to the end of this document
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: &quot;eccbc87e4b5ce2fe28308fd9f2a7baf3&quot;,
// test case file id
&quot;test_case&quot;: 1
},
{
&quot;cpu_time&quot;: 1,
&quot;result&quot;: 0,
&quot;memory&quot;: 12849152,
&quot;real_time&quot;: 1,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: &quot;eccbc87e4b5ce2fe28308fd9f2a7baf3&quot;,
&quot;test_case&quot;: 2
}
]
</code></pre>
<p>When compilation is failed, following data will be returned</p>
<pre><code class="js">{
&quot;err&quot;: &quot;CompileError&quot;,
&quot;data&quot;: &quot;error resson&quot;
}
</code></pre>
<h1 id="compile-special-judge">Compile Special Judge</h1>
<ul>
<li>URL <code>/compile_spj</code></li>
</ul>
<h2 id="args_2">Args</h2>
<ul>
<li><code>src</code>: special judge soure code</li>
<li><code>spj_version</code>: version of special judge, used to determine whether to recompile special judge</li>
<li><code>spj_compile_config</code>: refer to <code>client/Python/languages.py</code>, do not need to modify generally</li>
<li><code>test_case_id</code></li>
</ul>
<h2 id="response_2">Response</h2>
<pre><code class="js">&quot;success&quot;
</code></pre>
<p>When compilation is failed, following data will be returned</p>
<pre><code class="js">{
&quot;err&quot;: &quot;SPJCompileError&quot;,
&quot;data&quot;: &quot;error resson&quot;
}
</code></pre>
<h1 id="judge-for-special-judge">Judge (for Special Judge)</h1>
<p>Special Judge must be compiled before, refer to the above API</p>
<ul>
<li>URL <code>/judge</code></li>
</ul>
<h2 id="args_3">Args</h2>
<ul>
<li><code>src</code></li>
<li><code>language_config</code></li>
<li><code>submission_id</code></li>
<li><code>max_cpu_time</code></li>
<li><code>max_memory</code></li>
<li><code>test_case_id</code></li>
<li><code>spj_version</code></li>
<li><code>spj_config</code>, refer to <code>client/Python/languages.py</code>, do not need to modify generally</li>
</ul>
<h2 id="response_3">Response</h2>
<pre><code class="js">[
{
&quot;cpu_time&quot;: 1,
&quot;result&quot;: 0,
&quot;memory&quot;: 12836864,
&quot;real_time&quot;: 2,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: None,
&quot;test_case&quot;: 1
},
{
&quot;cpu_time&quot;: 1,
&quot;result&quot;: 0,
&quot;memory&quot;: 12849152,
&quot;real_time&quot;: 1,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: None,
&quot;test_case&quot;: 2
}
]
</code></pre>
<p>When compilation is failed, following data will be returned</p>
<pre><code class="js">{
&quot;err&quot;: &quot;CompileError&quot;,
&quot;data&quot;: &quot;error reason&quot;
}
</code></pre>
<p>If SPJ process crashed, <code>result = SYSTEM_ERROR</code> and <code>ERROR = SPJ_ERROR</code> is returned.</p>
<h1 id="result-field-return-value"><code>result</code> field return value</h1>
<ul>
<li>WRONG_ANSWER = -1 (this means the process exited normally, but the answer is wrong)</li>
<li>SUCCESS = 0 (this means the answer is accepted)</li>
<li>CPU_TIME_LIMIT_EXCEEDED = 1 </li>
<li>REAL_TIME_LIMIT_EXCEEDED = 2</li>
<li>MEMORY_LIMIT_EXCEEDED = 3</li>
<li>RUNTIME_ERROR = 4</li>
<li>SYSTEM_ERROR = 5</li>
</ul>
<h1 id="error-field-return-value"><code>error</code> field return value</h1>
<ul>
<li>SUCCESS = 0</li>
<li>INVALID_CONFIG = -1</li>
<li>CLONE_FAILED = -2</li>
<li>PTHREAD_FAILED = -3</li>
<li>WAIT_FAILED = -4</li>
<li>ROOT_REQUIRED = -5</li>
<li>LOAD_SECCOMP_FAILED = -6</li>
<li>SETRLIMIT_FAILED = -7</li>
<li>DUP2_FAILED = -8</li>
<li>SETUID_FAILED = -9</li>
<li>EXECVE_FAILED = -10</li>
<li>SPJ_ERROR = -11</li>
</ul></div>
</div>
<footer class="col-md-12">
<hr>
<center>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</center>
</footer>
<script src="../../js/jquery-1.10.2.min.js"></script>
<script src="../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../js/highlight.pack.js"></script>
<script>var base_url = '../..';</script>
<script data-main="../../mkdocs/js/search.js" src="../../mkdocs/js/require.js"></script>
<script src="../../js/base.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form role="form">
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>

View File

@ -1,387 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../../img/favicon.ico">
<title>API - Online Judge Docs</title>
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
<link rel="stylesheet" href="../../css/highlight.css">
<link href="../../css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href="../..">Online Judge Docs</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li >
<a href="../..">Home</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Judger <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">EN</a>
<ul class="dropdown-menu">
<li >
<a href="../../judger/api/">API</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">JudgeServer <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">zh-CN</a>
<ul class="dropdown-menu">
<li class="active">
<a href="./">API</a>
</li>
<li >
<a href="../deploy/">Deploy</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li >
<a rel="next" href="../../judger/api/">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="../deploy/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#judgeserver-api">JudgeServer API</a></li>
<li class="main "><a href="#_1">获取系统状态</a></li>
<li><a href="#_2">参数</a></li>
<li><a href="#_3">响应</a></li>
<li class="main "><a href="#special-judge">判题非Special Judge)</a></li>
<li><a href="#_4">参数</a></li>
<li><a href="#_5">响应</a></li>
<li class="main "><a href="#special-judge_1">编译Special Judge</a></li>
<li><a href="#_6">参数</a></li>
<li><a href="#_7">响应</a></li>
<li class="main "><a href="#special-judge_2">判题Special Judge)</a></li>
<li><a href="#_8">参数</a></li>
<li><a href="#_9">响应</a></li>
<li class="main "><a href="#result">result 字段含义</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="judgeserver-api">JudgeServer API</h1>
<p>所有的请求请在HTTP头中放入<code>X-Judge-Server-Token</code>字段值为token的sha256结果。</p>
<p>所有的响应都是两个字段,<code>err</code><code>data</code>,正常情况下<code>err</code><code>null</code><code>data</code>为响应的数据。出现错误的情况下,<code>err</code>是错误代码,<code>data</code>为错误详情。下面所有的响应都是<code>data</code>的内容。</p>
<h1 id="_1">获取系统状态</h1>
<ul>
<li>URL <code>/ping</code></li>
<li>Method <code>POST</code></li>
</ul>
<h2 id="_2">参数</h2>
<ul>
<li>无参数</li>
</ul>
<h2 id="_3">响应</h2>
<pre><code class="js">{
&quot;judger_version&quot;: &quot;2.0.1&quot;,
&quot;hostname&quot;: &quot;d3765528134e&quot;,
// cpu核数这个数字也确定了可以并发运行的判题任务数量
&quot;cpu_core&quot;: 1,
// cpu和内存使用率百分比
&quot;cpu&quot;: 4.1,
&quot;memory&quot;: 24.5
}
</code></pre>
<h1 id="special-judge">判题非Special Judge)</h1>
<ul>
<li>URL <code>/judge</code></li>
<li>Method <code>POST</code></li>
</ul>
<h2 id="_4">参数</h2>
<ul>
<li>src源码</li>
<li>language_config参考<code>languages.py</code>中,一般不需要修改</li>
<li>submission_id这个提交唯一的id请不要出现重复比如使用时间戳也是不推荐的</li>
<li>max_cpu_time单位毫秒</li>
<li>max_memory最大内存单位字节</li>
<li>test_case_id用于找到存放有测试用例的文件夹</li>
</ul>
<h2 id="_5">响应</h2>
<pre><code class="js">[
// 每组都是一个测试用例通过test_case字段区分
{
// cpu时间毫秒
&quot;cpu_time&quot;: 1,
// 见本文档最后部分
&quot;result&quot;: 0,
// 内存,字节
&quot;memory&quot;: 12836864,
// 实际时间,毫秒
&quot;real_time&quot;: 2,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: &quot;eccbc87e4b5ce2fe28308fd9f2a7baf3&quot;,
// 测试用例id
&quot;test_case&quot;: 1
},
{
&quot;cpu_time&quot;: 1,
&quot;result&quot;: 0,
&quot;memory&quot;: 12849152,
&quot;real_time&quot;: 1,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: &quot;eccbc87e4b5ce2fe28308fd9f2a7baf3&quot;,
&quot;test_case&quot;: 2
}
]
</code></pre>
<p>在编译错误的时候,返回</p>
<pre><code class="js">{
&quot;err&quot;: &quot;CompileError&quot;,
&quot;data&quot;: &quot;编译器的错误输出&quot;
}
</code></pre>
<h1 id="special-judge_1">编译Special Judge</h1>
<ul>
<li>URL <code>/compile_spj</code></li>
<li>Method <code>POST</code></li>
</ul>
<h2 id="_6">参数</h2>
<ul>
<li>src源码</li>
<li>spj_versionSpecial Judge的版本用于决定是否要重新编译二进制</li>
<li>spj_compile_config参考<code>languages.py</code>,一般不需要修改</li>
<li>test_case_id</li>
</ul>
<h2 id="_7">响应</h2>
<pre><code class="js">&quot;success&quot;
</code></pre>
<p>在编译错误的时候,返回</p>
<pre><code class="js">{
&quot;err&quot;: &quot;SPJCompileError&quot;,
&quot;data&quot;: &quot;编译器的错误输出&quot;
}
</code></pre>
<h1 id="special-judge_2">判题Special Judge)</h1>
<p>注意必须提前编译Special Judge见上一个API</p>
<ul>
<li>URL <code>/judge</code></li>
<li>Method <code>POST</code></li>
</ul>
<h2 id="_8">参数</h2>
<ul>
<li>src</li>
<li>language_config</li>
<li>submission_id</li>
<li>max_cpu_time</li>
<li>max_memory</li>
<li>test_case_id</li>
<li>spj_version</li>
<li>spj_config参考<code>languages.py</code>,一般不需要修改</li>
</ul>
<h2 id="_9">响应</h2>
<pre><code class="js">[
// 每组都是一个测试用例通过test_case字段区分
{
// cpu时间毫秒
&quot;cpu_time&quot;: 1,
// 见本文档最后部分
&quot;result&quot;: 0,
// 内存,字节
&quot;memory&quot;: 12836864,
// 实际时间,毫秒
&quot;real_time&quot;: 2,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: None,
// 测试用例id
&quot;test_case&quot;: 1
},
{
&quot;cpu_time&quot;: 1,
&quot;result&quot;: 0,
&quot;memory&quot;: 12849152,
&quot;real_time&quot;: 1,
&quot;signal&quot;: 0,
&quot;error&quot;: 0,
&quot;exit_code&quot;: 0,
&quot;output_md5&quot;: None,
&quot;test_case&quot;: 2
}
]
</code></pre>
<p>在编译错误的时候,返回</p>
<pre><code class="js">{
&quot;err&quot;: &quot;CompileError&quot;,
&quot;data&quot;: &quot;编译器的错误输出&quot;
}
</code></pre>
<h1 id="result">result 字段含义</h1>
<ul>
<li>WRONG_ANSWER = -1</li>
<li>AEECPTED = 0</li>
<li>CPU_TIME_LIMITED = 1</li>
<li>REAL_TIME_LIMIT_EXCEEDED = 2</li>
<li>MEMORY_LIMIT_EXCEEDED = 3</li>
<li>RUNTIME_ERROR = 4</li>
<li>SYSTEM_ERROR = 5</li>
</ul></div>
</div>
<footer class="col-md-12">
<hr>
<center>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</center>
</footer>
<script src="../../js/jquery-1.10.2.min.js"></script>
<script src="../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../js/highlight.pack.js"></script>
<script>var base_url = '../..';</script>
<script data-main="../../mkdocs/js/search.js" src="../../mkdocs/js/require.js"></script>
<script src="../../js/base.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form role="form">
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>

View File

@ -1,206 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../../img/favicon.ico">
<title>Deploy - Online Judge Docs</title>
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
<link rel="stylesheet" href="../../css/highlight.css">
<link href="../../css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href="../..">Online Judge Docs</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li >
<a href="../..">Home</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Judger <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">EN</a>
<ul class="dropdown-menu">
<li >
<a href="../../judger/api/">API</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">JudgeServer <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">zh-CN</a>
<ul class="dropdown-menu">
<li >
<a href="../api/">API</a>
</li>
<li class="active">
<a href="./">Deploy</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li >
<a rel="next" href="../api/">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="disabled">
<a rel="prev" >
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#link">同主机link场景</a></li>
<li class="main "><a href="#_1">跨主机场景</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="link">同主机link场景</h1>
<p>oj_web_server和judge_server在同一台服务器上而且judge_server中link oj_web_server。</p>
<p>oj_web_server需要设置环境变量<code>judger_token</code>,这样<code>judge_server</code>就可以在<code>OJ_WEB_SERVER_ENV_judger_token</code>环境变量中得到token<code>OJ_WEB_SERVER_PORT_8080_TCP_ADDR</code>得到ip<code>OJ_WEB_SERVER_PORT_8080_TCP_PORT</code>得到端口从而每5秒向该ip发送心跳包在HTTP头中携带了<code>X-JUDGE-SERVER-TOKEN</code>值为token的sha256。</p>
<h1 id="_1">跨主机场景</h1>
<p>如果不在同一台服务器上需要手动设置judge_server的下面四个环境变量</p>
<ul>
<li><code>service_discovery_url</code></li>
<li><code>judger_token</code></li>
</ul>
<p>通过以上两个环境变量这样就可以向该url发送心跳包了</p>
<ul>
<li><code>service_host</code></li>
<li><code>service_po</code></li>
</ul>
<p>因为跨主机的情况下oj_web_server是无法得知judge_server的ip和端口的需要主动的设置然后在心跳包中会带上这两个信息让oj_web_server能够主动访问。此时judge_server只能使用固定端口映射。</p></div>
</div>
<footer class="col-md-12">
<hr>
<center>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</center>
</footer>
<script src="../../js/jquery-1.10.2.min.js"></script>
<script src="../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../js/highlight.pack.js"></script>
<script>var base_url = '../..';</script>
<script data-main="../../mkdocs/js/search.js" src="../../mkdocs/js/require.js"></script>
<script src="../../js/base.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form role="form">
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>

View File

@ -1,222 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Index - Online Judge Docs</title>
<link href="../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../css/font-awesome-4.0.3.css" rel="stylesheet">
<link rel="stylesheet" href="../css/highlight.css">
<link href="../css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href="..">Online Judge Docs</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li >
<a href="..">Home</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Judger <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../judger/">Index</a>
</li>
<li class="dropdown-submenu">
<a tabindex="-1" href="">English</a>
<ul class="dropdown-menu">
<li >
<a href="../judger/English/">API</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">JudgeServer <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="active">
<a href="./">Index</a>
</li>
<li class="dropdown-submenu">
<a tabindex="-1" href="">English</a>
<ul class="dropdown-menu">
<li >
<a href="English/">API</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a tabindex="-1" href="">中文</a>
<ul class="dropdown-menu">
<li >
<a href="Chinese/">API</a>
</li>
<li >
<a href="Chinese/deploy/">部署</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li >
<a rel="next" href="../judger/English/">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="English/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#_1">中文版本</a></li>
<li class="main "><a href="#english-version">English Version</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="_1">中文版本</h1>
<p><a href="./Chinese">链接</a></p>
<h1 id="english-version">English Version</h1>
<p><a href="./English">link</a></p></div>
</div>
<footer class="col-md-12">
<hr>
<center>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</center>
</footer>
<script src="../js/jquery-1.10.2.min.js"></script>
<script src="../js/bootstrap-3.0.3.min.js"></script>
<script src="../js/highlight.pack.js"></script>
<script>var base_url = '..';</script>
<script data-main="../mkdocs/js/search.js" src="../mkdocs/js/require.js"></script>
<script src="../js/base.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form role="form">
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>

View File

@ -1,285 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../../../img/favicon.ico">
<title>API - Online Judge Docs</title>
<link href="../../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../../css/font-awesome-4.0.3.css" rel="stylesheet">
<link rel="stylesheet" href="../../../css/highlight.css">
<link href="../../../css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href="../../..">Online Judge Docs</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li >
<a href="../../..">Home</a>
</li>
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Judger <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">English</a>
<ul class="dropdown-menu">
<li class="active">
<a href="./">API</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">JudgeServer <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">Chinese</a>
<ul class="dropdown-menu">
<li >
<a href="../../../judge_server/Chinese/api/">API</a>
</li>
<li >
<a href="../../../judge_server/Chinese/deploy/">Deploy</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li >
<a rel="next" href="../../..">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="../../../judge_server/Chinese/api/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#judger-for-onlinejudge">Judger for OnlineJudge</a></li>
<li><a href="#build">build</a></li>
<li><a href="#c-api">C API</a></li>
<li><a href="#struct-config-members">struct config members</a></li>
<li><a href="#struct-result-members">struct result members</a></li>
<li><a href="#python-binding-python-27-only">Python binding (Python 2.7 only)</a></li>
<li><a href="#run-tests">Run tests</a></li>
<li><a href="#note">Note</a></li>
<li><a href="#license">License</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="judger-for-onlinejudge">Judger for OnlineJudge</h1>
<h2 id="build">build</h2>
<pre><code>sudo apt-get install libseccomp-dev
mkdir build &amp;&amp; cd build &amp;&amp; cmake .. &amp;&amp; make &amp;&amp; sudo make install
</code></pre>
<h2 id="c-api">C API</h2>
<p><code>#include &lt;runner.h&gt;</code> then call <code>run</code> function with <code>struct config</code> and <code>struct result</code> pointer.</p>
<h2 id="struct-config-members"><code>struct config</code> members</h2>
<ul>
<li><code>max_cpu_time</code>(ms): max cpu time this process can cost, -1 for unlimited</li>
<li><code>max_real_time</code>(ms): max time this process can run, -1 for unlimited</li>
<li><code>max_memory</code>(byte): max size of the process's virtual memory (address space), -1 for unlimited</li>
<li><code>max_process_number</code>: max number of child process this process can create (to avoid fork bomb), -1 for unlimited</li>
<li><code>max_output_size</code>(byte): max size of data this process can output to stdout, stderr and file, -1 for unlimited</li>
<li><code>exe_path</code>: path of file to run</li>
<li><code>input_file</code>: redirect content of this file to process's stdin</li>
<li><code>output_file</code>: redirect process's stdout to this file</li>
<li><code>error_file</code>: redirect process's stderr to this file</li>
<li><code>args</code>(string array terminated by NULL): arguments to run this process</li>
<li><code>env</code>(string array terminated by NULL): environment variables this process can get</li>
<li><code>log_path</code>: judger log path</li>
<li><code>seccomp_rule_so_path</code>(string or NULL): seccomp rules used to limit process system calls</li>
<li><code>uid</code>: user to run this process</li>
<li><code>gid</code>: user group this process belongs to</li>
</ul>
<h2 id="struct-result-members"><code>struct result</code> members</h2>
<ul>
<li><code>cpu_time</code>: cpu time the process has used</li>
<li><code>real_time</code>: actual running time of the process</li>
<li><code>signal</code>: signal number</li>
<li><code>exit_code</code>: process's exit code</li>
<li><code>result</code>: judger result, details in <code>runner.h</code></li>
<li><code>error</code>: args validation error or judger internal error, error code in <code>runner.h</code></li>
</ul>
<h2 id="python-binding-python-27-only">Python binding (Python 2.7 only)</h2>
<pre><code>sudo python setup.py install
</code></pre>
<h3 id="python-demo">Python demo</h3>
<pre><code>&gt;&gt;&gt; import _judger
&gt;&gt;&gt; _judger.run(max_cpu_time=1000,
... max_real_time=2000,
... max_memory=1000000000,
... max_process_number=200,
... max_output_size=10000,
... # five args above can be _judger.UNLIMITED
... exe_path=&quot;/bin/echo&quot;,
... input_path=&quot;/dev/null&quot;,
... output_path=&quot;echo.out&quot;,
... error_path=&quot;echo.out&quot;,
... # can be empty list
... args=[&quot;HelloWorld&quot;],
... # can be empty list
... env=[&quot;foo=bar&quot;],
... log_path=&quot;judger.log&quot;,
... # can be None
... seccomp_rule_so_path=&quot;/usr/lib/judger/librule_c_cpp.so&quot;,
... uid=0,
... gid=0)
{'cpu_time': 0, 'signal': 0, 'memory': 4554752, 'exit_code': 0, 'result': 0, 'error': 0, 'real_time': 2}
</code></pre>
<h2 id="run-tests">Run tests</h2>
<pre><code>cd tests &amp;&amp; sudo python test.py
</code></pre>
<h2 id="note">Note</h2>
<ul>
<li>Linux x64 and kernel version &gt; 3.17 required</li>
<li>Judger security relies on Docker with default security config <a href="../todo">More</a></li>
<li>Tested under Ubuntu 14.04 docker container. System calls may vary due to different system and kernel versions</li>
<li>Root user required to change uid / gid</li>
<li>Why use seccomp instead of ptrace? Ptrace can decrease process's performance significantly, for each system call, twice
context switch between child process and parent process is needed.</li>
<li>How to custom seccomp rule? <a href="">Example here</a> and then reinstall jduger, your code will be compiled and installed under
<code>/usr/lib/judger</code></li>
</ul>
<h2 id="license">License</h2>
<p>The Star And Thank Author License (SATA)</p></div>
</div>
<footer class="col-md-12">
<hr>
<center>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</center>
</footer>
<script src="../../../js/jquery-1.10.2.min.js"></script>
<script src="../../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../../js/highlight.pack.js"></script>
<script>var base_url = '../../..';</script>
<script data-main="../../../mkdocs/js/search.js" src="../../../mkdocs/js/require.js"></script>
<script src="../../../js/base.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form role="form">
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>

View File

@ -1,285 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../../img/favicon.ico">
<title>API - Online Judge Docs</title>
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
<link rel="stylesheet" href="../../css/highlight.css">
<link href="../../css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href="../..">Online Judge Docs</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li >
<a href="../..">Home</a>
</li>
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Judger <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">EN</a>
<ul class="dropdown-menu">
<li class="active">
<a href="./">API</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">JudgeServer <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a tabindex="-1" href="">zh-CN</a>
<ul class="dropdown-menu">
<li >
<a href="../../judge_server/api/">API</a>
</li>
<li >
<a href="../../judge_server/deploy/">Deploy</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li >
<a rel="next" href="../..">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="../../judge_server/api/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#judger-for-onlinejudge">Judger for OnlineJudge</a></li>
<li><a href="#build">build</a></li>
<li><a href="#c-api">C API</a></li>
<li><a href="#struct-config-members">struct config members</a></li>
<li><a href="#struct-result-members">struct result members</a></li>
<li><a href="#python-binding-python-27-only">Python binding (Python 2.7 only)</a></li>
<li><a href="#run-tests">Run tests</a></li>
<li><a href="#note">Note</a></li>
<li><a href="#license">License</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="judger-for-onlinejudge">Judger for OnlineJudge</h1>
<h2 id="build">build</h2>
<pre><code>sudo apt-get install libseccomp-dev
mkdir build &amp;&amp; cd build &amp;&amp; cmake .. &amp;&amp; make &amp;&amp; sudo make install
</code></pre>
<h2 id="c-api">C API</h2>
<p><code>#include &lt;runner.h&gt;</code> then call <code>run</code> function with <code>struct config</code> and <code>struct result</code> pointer.</p>
<h2 id="struct-config-members"><code>struct config</code> members</h2>
<ul>
<li><code>max_cpu_time</code>(ms): max cpu time this process can cost, -1 for unlimited</li>
<li><code>max_real_time</code>(ms): max time this process can run, -1 for unlimited</li>
<li><code>max_memory</code>(byte): max size of the process's virtual memory (address space), -1 for unlimited</li>
<li><code>max_process_number</code>: max number of child process this process can create (to avoid fork bomb), -1 for unlimited</li>
<li><code>max_output_size</code>(byte): max size of data this process can output to stdout, stderr and file, -1 for unlimited</li>
<li><code>exe_path</code>: path of file to run</li>
<li><code>input_file</code>: redirect content of this file to process's stdin</li>
<li><code>output_file</code>: redirect process's stdout to this file</li>
<li><code>error_file</code>: redirect process's stderr to this file</li>
<li><code>args</code>(string array terminated by NULL): arguments to run this process</li>
<li><code>env</code>(string array terminated by NULL): environment variables this process can get</li>
<li><code>log_path</code>: judger log path</li>
<li><code>seccomp_rule_so_path</code>(string or NULL): seccomp rules used to limit process system calls</li>
<li><code>uid</code>: user to run this process</li>
<li><code>gid</code>: user group this process belongs to</li>
</ul>
<h2 id="struct-result-members"><code>struct result</code> members</h2>
<ul>
<li><code>cpu_time</code>: cpu time the process has used</li>
<li><code>real_time</code>: actual running time of the process</li>
<li><code>signal</code>: signal number</li>
<li><code>exit_code</code>: process's exit code</li>
<li><code>result</code>: judger result, details in <code>runner.h</code></li>
<li><code>error</code>: args validation error or judger internal error, error code in <code>runner.h</code></li>
</ul>
<h2 id="python-binding-python-27-only">Python binding (Python 2.7 only)</h2>
<pre><code>sudo python setup.py install
</code></pre>
<h3 id="python-demo">Python demo</h3>
<pre><code>&gt;&gt;&gt; import _judger
&gt;&gt;&gt; _judger.run(max_cpu_time=1000,
... max_real_time=2000,
... max_memory=1000000000,
... max_process_number=200,
... max_output_size=10000,
... # five args above can be _judger.UNLIMITED
... exe_path=&quot;/bin/echo&quot;,
... input_path=&quot;/dev/null&quot;,
... output_path=&quot;echo.out&quot;,
... error_path=&quot;echo.out&quot;,
... # can be empty list
... args=[&quot;HelloWorld&quot;],
... # can be empty list
... env=[&quot;foo=bar&quot;],
... log_path=&quot;judger.log&quot;,
... # can be None
... seccomp_rule_so_path=&quot;/usr/lib/judger/librule_c_cpp.so&quot;,
... uid=0,
... gid=0)
{'cpu_time': 0, 'signal': 0, 'memory': 4554752, 'exit_code': 0, 'result': 0, 'error': 0, 'real_time': 2}
</code></pre>
<h2 id="run-tests">Run tests</h2>
<pre><code>cd tests &amp;&amp; sudo python test.py
</code></pre>
<h2 id="note">Note</h2>
<ul>
<li>Linux x64 and kernel version &gt; 3.17 required</li>
<li>Judger security relies on Docker with default security config <a href="../todo">More</a></li>
<li>Tested under Ubuntu 14.04 docker container. System calls may vary due to different system and kernel versions</li>
<li>Root user required to change uid / gid</li>
<li>Why use seccomp instead of ptrace? Ptrace can decrease process's performance significantly, for each system call, twice
context switch between child process and parent process is needed.</li>
<li>How to custom seccomp rule? <a href="">Example here</a> and then reinstall jduger, your code will be compiled and installed under
<code>/usr/lib/judger</code></li>
</ul>
<h2 id="license">License</h2>
<p>The Star And Thank Author License (SATA)</p></div>
</div>
<footer class="col-md-12">
<hr>
<center>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</center>
</footer>
<script src="../../js/jquery-1.10.2.min.js"></script>
<script src="../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../js/highlight.pack.js"></script>
<script>var base_url = '../..';</script>
<script data-main="../../mkdocs/js/search.js" src="../../mkdocs/js/require.js"></script>
<script src="../../js/base.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form role="form">
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>