deer_executor

README

Deer Executor

A program executor for online judge written by golang.

English | 简体中文

✨ Features

• Most languages supported.
• You can build and run it standalone.
• Support Linux and Darwin(MacOS), maybe Windows in the future.

📦 Get && Install

go get github.com/LanceLRQ/deer-executor

Environment: Go 1.11+ is best!

🔨 Usage

import (
    "fmt"
    "github.com/LanceLRQ/deer-executor"
    "github.com/LanceLRQ/deer-executor/compile"
)

// Create a compiler provider
compiler := new(deer_compile.GnucCompileProvider)
compiler.Init("#include<stdio.h>\nint main(){ return 0; }", "/tmp")    // The second argument means the work directory.

// Do compile
success, ceinfo := compiler.Compile()
if !success {
    fmt.Println("Compile Error: " + ceinfo)
}

// Get compile result
cmds := compiler.GetRunArgs()

judgeOptions := deer_executor.JudgeOption {

    // Executable program commands
    // Commands:      []string{ "/tmp/a.out", "-a", "123" },      // It means: /tmp/a.out -a 123
    Commands:      cmds, 
    
    // Resource Limitation
    TimeLimit:     1000,                     // Maximum time limit (ms)
    MemoryLimit:   32768,                    // Maximum memory limit (Kbytes)
    FileSizeLimit: 100 * 1024 * 1024,        // Maximum file size output limit (Kbytes)
    
    // Test Cases
    TestCaseIn:    "/data/1.in",             // TestCase-In file path
    TestCaseOut:   "/data/1.out",            // TestCase-Out file path
    ProgramOut:    "/tmp/user.out",          // Program's stdout file path
    ProgramError:  "/tmp/user.err",          // Program's stderr file path
    
    // Special Judge
    SpecialJudge struct {
        Mode int                    // Mode
        Checker string				// Checker file path
        RedirectStd bool 			// Redirect target program's Stdout to checker's Stdin (only for checker mode)
        TimeLimit int				// Time limit (ms)
        MemoryLimit int				// Memory limit (kb)
        Stdout string				// checker's stdout
        Stderr string				// checker's stderr
    }
    // Other
    Uid:    -1,                              // Linux user id (optional)
}

judgeResult, err := deer_executor.Judge(judgeOptions)

judgeResult define like this:

type JudgeResult struct {
	JudgeResult int 			// Judge result flag number
	TimeUsed int				// Maximum time used (ms)
	MemoryUsed int				// Maximum memory used  (Kbytes)
	ReSignum int				// Runtime error signal number
	SameLines int				// Same Lines when WA
	TotalLines int				// Total Lines when WA
	SeInfo string				// SeInfo When System Error
	CeInfo string				// CeInfo When CeInfo
}

💡 Special Judge

Special Judge supported two modes:

• Checker Mode
• Interactive Mode

Checker Mode Deer-executor will run the target program first. When it finished without any error, deer-executor will call the special judge checker. The checker should check up the target program's answer text, and exit with a code to tell deer-executor finally result.

The special judge checker's arguments is:

./checker [1] [2] [3]

[1]: TestCase-In File; [2]: TestCases-Out File; [3]: Answer File

Interactive Mode Deer-executor will run the target program and special judge checker at the same time, redirect checker's stdout to programs's stdin and checker's stdin from program's stdout. Deer-executor will use checker's exit-code as the result. The special judge checker's arguments is:

./checker [1] [2] [3]

[1]: TestCase-In File; [2]: TestCases-Out File; [3] Run-result File

Run-result: Maybe you can output your communication with program, it can be the special judge checker's logs.

Exit Code

Special judge checker report the judge result with it's exit code. like this (checker.c):

#define RESULT_AC 0
#define RESULT_PE 1
#define RESULT_WA 4
#define RESULT_OLE 6
#define REQUIRE_DEFAULT_CHECKER 12

int main(int argc,char **argv) {
    // Do anything you want.
    
    return RESULT_AC;
}

REQUIRE_DEFAULT_CHECKER

Special judge checker sometimes not only a checker, but also a processor program. You can use the checker to process the target program's output, e.p keep two decimal for type double and so on. After that you can return REQUIRE_DEFAULT_CHECKER for calling the default text-diff checker supported from deer-executor.

🧬 Compile

To compile code, deer-executor supported:

GCC、GNU C++、Java、Python2、Python3、Golang、NodeJS、PHP、Ruby

Sure, you can add any compiler you like. Deer make an interface CodeCompileProviderInterface

type CodeCompileProviderInterface interface {

    // Initial the provider, set code content and work directory.
    Init(code string, workDir string) error
    
    // Compile the code. it must be run after Init() called.
    Compile() (result bool, errmsg string)
    
    // Get compiled program's file path and run arguments.
    GetRunArgs() (args []string)

    // If your compiler is a real-time compiler, like python.
    // It should't compile first, and will output compile error when running.
    // So you can use it to check if VM output a compile error
    IsCompileError(remsg string) bool
    
    // Is it a realtime compiler?
    IsRealTime() bool
    
    // Is code compiled?
    IsReady() bool

	
    /** 
     ** Private Methods
     **/

    // Write code content to file before compile.
    initFiles(codeExt string, programExt string) error
    
	// Call the system shell
	shell(commands string) (success bool, errout string)
	// Save your code content to file
	saveCode() error
	// Check if work dir exists
	checkWorkDir() error
}

type CodeCompileProvider struct {
	CodeCompileProviderInterface
	
	codeContent string		        // Code content
	realTime bool			        // Is it a realtime compiler?
	isReady bool			        // Is code compiled?
	codeFileName string             // Target code file name
	codeFilePath string			    // Target code file  path
	programFileName string          // Target program file name
	programFilePath string		    // Target program file path
	workDir string			        // Work Directory
}

🤝 Thanks！

First, I'm really appreciate to the author of Loco's runner.

Then, my classmates Wolf Zheng and Tosh Qiu propose the interactive judge and describe how it works.

Finally，thanks to my alma mater Beijing Normal University (Zhuhai), BNUZ IT college, ACM association and WeJudge team

🔗 Links

📃 My blog：https://www.lanrongqi.com

🖥️ WeJudge：

https://www.wejudge.net

https://oj.bnuz.edu.cn

WeJudge 1.0 Open Source

We welcome all contributions. You can submit any ideas as pull requests or as GitHub issues. have a good time! :)

License

Documentation

Overview

Deer executor * (C) 2019 LanceLRQ * * This code is licenced under the GPLv3.

Deer executor * (C) 2019 LanceLRQ * * This code is licenced under the GPLv3.

Deer executor * (C) 2019 LanceLRQ * * This code is licenced under the GPLv3.

Deer executor * (C) 2019 LanceLRQ * * This code is licenced under the GPLv3.

Deer executor * (C) 2019 LanceLRQ * * This code is licenced under the GPLv3.

Index

• Constants
• func CharDiffIoUtil(useroutBuffer, answerBuffer []byte, useroutLen, answerLen int64) (rel int, logtext string)
• func CustomChecker(options JudgeOption, result *JudgeResult, msg chan string) error
• func DiffText(options JudgeOption, result *JudgeResult) (err error, logtext string)
• func InteractiveChecker(options JudgeOption, result *JudgeResult, msg chan string) error
• func Max(x, y int64) int64
• func RunProgram(options JudgeOption, result *JudgeResult, msg chan string) error
• func StrictDiff(useroutBuffer, answerBuffer []byte, useroutLen, answerLen int64) bool
• type ITimerVal
• type JudgeOption
• type JudgeResult
  • func Judge(options JudgeOption) (*JudgeResult, error)
  • func (conf *JudgeResult) String() string
• type TimeVal

Constants

const (
	JudgeFlagAC  int = 0 // 0 Accepted
	JudgeFlagPE  int = 1 // 1 Presentation Error
	JudgeFlagTLE int = 2 // 2 Time Limit Exceeded
	JudgeFlagMLE int = 3 // 3 Memory Limit Exceeded
	JudgeFlagWA  int = 4 // 4 Wrong Answer
	JudgeFlagRE  int = 5 // 5 Runtime Error
	JudgeFlagOLE int = 6 // 6 Output Limit Exceeded
	JudgeFlagCE  int = 7 // 7 Compile Error
	JudgeFlagSE  int = 8 // 8 System Error

	JudgeFlagSpecialJudgeTimeout        int = 10 // 10 Special Judger Time OUT
	JudgeFlagSpecialJudgeError          int = 11 // 11 Special Judger ERROR
	JudgeFlagSpecialJudgeRequireChecker int = 12 // 12 Special Judger Finish, Need Standard Checkup
)

const (
	JudgeFileSizeLimit          = 200 * 1024 * 1024 // 200MB
	SpecialJudgeModeDisabled    = 0
	SpecialJudgeModeChecker     = 1
	SpecialJudgeModeInteractive = 2

	SpecialJudgeTimeLimit   = 10 * 1000  // ms
	SpecialJudgeMemoryLimit = 256 * 1024 // kb

)

const (
	ITIMER_REAL    = 0
	ITIMER_VIRTUAL = 1
	ITIMER_PROF    = 2
)

Functions

func CharDiffIoUtil

func CharDiffIoUtil(useroutBuffer, answerBuffer []byte, useroutLen, answerLen int64) (rel int, logtext string)

字符比较（忽略空白）

func CustomChecker

func CustomChecker(options JudgeOption, result *JudgeResult, msg chan string) error

func DiffText

func DiffText(options JudgeOption, result *JudgeResult) (err error, logtext string)

func InteractiveChecker

func InteractiveChecker(options JudgeOption, result *JudgeResult, msg chan string) error

func Max

func Max(x, y int64) int64

func RunProgram

func RunProgram(options JudgeOption, result *JudgeResult, msg chan string) error

func StrictDiff

func StrictDiff(useroutBuffer, answerBuffer []byte, useroutLen, answerLen int64) bool

字符比较（严格比对)

Types

type ITimerVal

type ITimerVal struct {
	ItInterval TimeVal
	ItValue    TimeVal
}

type JudgeOption

type JudgeOption struct {
	Commands      []string // Executable program commands
	TestCaseIn    string
	TestCaseOut   string
	ProgramOut    string
	ProgramError  string
	TimeLimit     int // Time limit (ms)
	MemoryLimit   int // Memory limit (kb)
	FileSizeLimit int // File Size Limit (kb)
	Uid           int // User id (optional)
	SpecialJudge  struct {
		Mode        int    // Mode
		Checker     string // Checker file path
		RedirectStd bool   // Redirect target program's Stdout to checker's Stdin
		TimeLimit   int    // Time limit (ms)
		MemoryLimit int    // Memory limit (kb)
		Stdout      string // checker's stdout
		Stderr      string // checker's stderr
	}
}

type JudgeResult

type JudgeResult struct {
	JudgeResult int    // Judge result flag number
	TimeUsed    int    // Maximum time used
	MemoryUsed  int    // Maximum memory used
	ReSignum    int    // Runtime error signal number
	SameLines   int    // sameLines when WA
	TotalLines  int    // totalLines when WA
	SeInfo      string // SeInfo When System Error
	CeInfo      string // CeInfo When CeInfo
}

func Judge

func Judge(options JudgeOption) (*JudgeResult, error)

这个函数实现了判题的基本用法，考虑到实际情况不一定会使用这个函数，你可以模仿这个函数的写法来调用自己需要的功能

func (*JudgeResult) String

func (conf *JudgeResult) String() string

type TimeVal

type TimeVal struct {
	TvSec  uint64
	TvUsec uint64
}