Add lockfree assignment
This commit is contained in:
commit
a125de585e
16
.gitignore
vendored
Normal file
16
.gitignore
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
# General
|
||||
*.DS_Store
|
||||
*.swp
|
||||
*~
|
||||
|
||||
# Dotty
|
||||
*.class
|
||||
*.tasty
|
||||
*.hasTasty
|
||||
|
||||
# sbt
|
||||
target/
|
||||
|
||||
# Dotty IDE
|
||||
/.dotty-ide-artifact
|
||||
/.dotty-ide.json
|
||||
36
.gitlab-ci.yml
Normal file
36
.gitlab-ci.yml
Normal file
@ -0,0 +1,36 @@
|
||||
# DO NOT EDIT THIS FILE
|
||||
|
||||
stages:
|
||||
- build
|
||||
- grade
|
||||
|
||||
compile:
|
||||
stage: build
|
||||
image: lampepfl/moocs:dotty-2020-02-12
|
||||
except:
|
||||
- tags
|
||||
tags:
|
||||
- cs206
|
||||
script:
|
||||
- sbt packageSubmission
|
||||
artifacts:
|
||||
expire_in: 1 day
|
||||
paths:
|
||||
- submission.jar
|
||||
|
||||
grade:
|
||||
stage: grade
|
||||
except:
|
||||
- tags
|
||||
tags:
|
||||
- cs206
|
||||
image:
|
||||
name: smarter3/moocs:concpar-lockfree-2020-03-24
|
||||
entrypoint: [""]
|
||||
allow_failure: true
|
||||
before_script:
|
||||
- mkdir -p /shared/submission/
|
||||
- cp submission.jar /shared/submission/submission.jar
|
||||
script:
|
||||
- cd /grader
|
||||
- /grader/grade | /grader/feedback-printer
|
||||
8
.vscode/settings.json
vendored
Normal file
8
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"dotty": {
|
||||
"trace": {
|
||||
"remoteTracingUrl": "wss://lamppc36.epfl.ch/dotty-remote-tracer/upload/lsp.log",
|
||||
"server": { "format": "JSON", "verbosity": "verbose" }
|
||||
}
|
||||
}
|
||||
}
|
||||
4
assignment.sbt
Normal file
4
assignment.sbt
Normal file
@ -0,0 +1,4 @@
|
||||
// Student tasks (i.e. submit, packageSubmission)
|
||||
enablePlugins(StudentTasks)
|
||||
|
||||
|
||||
11
build.sbt
Normal file
11
build.sbt
Normal file
@ -0,0 +1,11 @@
|
||||
course := "concpar"
|
||||
assignment := "lockfree"
|
||||
|
||||
scalaVersion := "0.23.0-bin-20200211-5b006fb-NIGHTLY"
|
||||
|
||||
scalacOptions ++= Seq("-language:implicitConversions", "-deprecation")
|
||||
|
||||
libraryDependencies += "com.novocode" % "junit-interface" % "0.11" % Test
|
||||
|
||||
testOptions in Test += Tests.Argument(TestFrameworks.JUnit, "-a", "-v", "-s")
|
||||
testSuite := "lockfree.SortedListSuite"
|
||||
BIN
grading-tests.jar
Normal file
BIN
grading-tests.jar
Normal file
Binary file not shown.
46
project/MOOCSettings.scala
Normal file
46
project/MOOCSettings.scala
Normal file
@ -0,0 +1,46 @@
|
||||
package ch.epfl.lamp
|
||||
|
||||
import sbt._
|
||||
import sbt.Keys._
|
||||
|
||||
/**
|
||||
* Coursera uses two versions of each assignment. They both have the same assignment key and part id but have
|
||||
* different item ids.
|
||||
*
|
||||
* @param key Assignment key
|
||||
* @param partId Assignment partId
|
||||
* @param itemId Item id of the non premium version
|
||||
* @param premiumItemId Item id of the premium version (`None` if the assignment is optional)
|
||||
*/
|
||||
case class CourseraId(key: String, partId: String, itemId: String, premiumItemId: Option[String])
|
||||
|
||||
/**
|
||||
* Settings shared by all assignments, reused in various tasks.
|
||||
*/
|
||||
object MOOCSettings extends AutoPlugin {
|
||||
|
||||
object autoImport {
|
||||
val course = SettingKey[String]("course")
|
||||
val assignment = SettingKey[String]("assignment")
|
||||
val options = SettingKey[Map[String, Map[String, String]]]("options")
|
||||
val courseraId = settingKey[CourseraId]("Coursera-specific information identifying the assignment")
|
||||
val testSuite = settingKey[String]("Fully qualified name of the test suite of this assignment")
|
||||
// Convenient alias
|
||||
type CourseraId = ch.epfl.lamp.CourseraId
|
||||
val CourseraId = ch.epfl.lamp.CourseraId
|
||||
}
|
||||
|
||||
import autoImport._
|
||||
|
||||
override val globalSettings: Seq[Def.Setting[_]] = Seq(
|
||||
// supershell is verbose, buggy and useless.
|
||||
useSuperShell := false
|
||||
)
|
||||
|
||||
override val projectSettings: Seq[Def.Setting[_]] = Seq(
|
||||
parallelExecution in Test := false,
|
||||
// Report test result after each test instead of waiting for every test to finish
|
||||
logBuffered in Test := false,
|
||||
name := s"${course.value}-${assignment.value}"
|
||||
)
|
||||
}
|
||||
318
project/StudentTasks.scala
Normal file
318
project/StudentTasks.scala
Normal file
@ -0,0 +1,318 @@
|
||||
package ch.epfl.lamp
|
||||
|
||||
import sbt._
|
||||
import Keys._
|
||||
|
||||
// import scalaj.http._
|
||||
import java.io.{File, FileInputStream, IOException}
|
||||
import org.apache.commons.codec.binary.Base64
|
||||
// import play.api.libs.json.{Json, JsObject, JsPath}
|
||||
import scala.util.{Failure, Success, Try}
|
||||
|
||||
/**
|
||||
* Provides tasks for submitting the assignment
|
||||
*/
|
||||
object StudentTasks extends AutoPlugin {
|
||||
|
||||
override def requires = super.requires && MOOCSettings
|
||||
|
||||
object autoImport {
|
||||
val packageSourcesOnly = TaskKey[File]("packageSourcesOnly", "Package the sources of the project")
|
||||
val packageBinWithoutResources = TaskKey[File]("packageBinWithoutResources", "Like packageBin, but without the resources")
|
||||
val packageSubmissionZip = TaskKey[File]("packageSubmissionZip")
|
||||
val packageSubmission = inputKey[Unit]("package solution as an archive file")
|
||||
val runGradingTests = taskKey[Unit]("run black-box tests used for final grading")
|
||||
}
|
||||
|
||||
|
||||
import autoImport._
|
||||
import MOOCSettings.autoImport._
|
||||
|
||||
override lazy val projectSettings = Seq(
|
||||
packageSubmissionSetting,
|
||||
// submitSetting,
|
||||
runGradingTestsSettings,
|
||||
|
||||
fork := true,
|
||||
connectInput in run := true,
|
||||
outputStrategy := Some(StdoutOutput),
|
||||
) ++ packageSubmissionZipSettings
|
||||
|
||||
lazy val runGradingTestsSettings = runGradingTests := {
|
||||
val testSuiteJar = "grading-tests.jar"
|
||||
if (!new File(testSuiteJar).exists) {
|
||||
throw new MessageOnlyException(s"Could not find tests JarFile: $testSuiteJar")
|
||||
}
|
||||
|
||||
val classPath = s"${(Test / dependencyClasspath).value.map(_.data).mkString(File.pathSeparator)}${File.pathSeparator}$testSuiteJar"
|
||||
val junitProcess =
|
||||
Fork.java.fork(
|
||||
ForkOptions(),
|
||||
"-cp" :: classPath ::
|
||||
"org.junit.runner.JUnitCore" ::
|
||||
(Test / testSuite).value ::
|
||||
Nil
|
||||
)
|
||||
|
||||
// Wait for tests to complete.
|
||||
junitProcess.exitValue()
|
||||
}
|
||||
|
||||
|
||||
/** **********************************************************
|
||||
* SUBMITTING A SOLUTION TO COURSERA
|
||||
*/
|
||||
|
||||
val packageSubmissionZipSettings = Seq(
|
||||
packageSubmissionZip := {
|
||||
val submission = crossTarget.value / "submission.zip"
|
||||
val sources = (packageSourcesOnly in Compile).value
|
||||
val binaries = (packageBinWithoutResources in Compile).value
|
||||
IO.zip(Seq(sources -> "sources.zip", binaries -> "binaries.jar"), submission)
|
||||
submission
|
||||
},
|
||||
artifactClassifier in packageSourcesOnly := Some("sources"),
|
||||
artifact in (Compile, packageBinWithoutResources) ~= (art => art.withName(art.name + "-without-resources"))
|
||||
) ++
|
||||
inConfig(Compile)(
|
||||
Defaults.packageTaskSettings(packageSourcesOnly, Defaults.sourceMappings) ++
|
||||
Defaults.packageTaskSettings(packageBinWithoutResources, Def.task {
|
||||
val relativePaths =
|
||||
(unmanagedResources in Compile).value.flatMap(Path.relativeTo((unmanagedResourceDirectories in Compile).value)(_))
|
||||
(mappings in (Compile, packageBin)).value.filterNot { case (_, path) => relativePaths.contains(path) }
|
||||
})
|
||||
)
|
||||
|
||||
val maxSubmitFileSize = {
|
||||
val mb = 1024 * 1024
|
||||
10 * mb
|
||||
}
|
||||
|
||||
/** Check that the jar exists, isn't empty, isn't crazy big, and can be read
|
||||
* If so, encode jar as base64 so we can send it to Coursera
|
||||
*/
|
||||
def prepareJar(jar: File, s: TaskStreams): String = {
|
||||
val errPrefix = "Error submitting assignment jar: "
|
||||
val fileLength = jar.length()
|
||||
if (!jar.exists()) {
|
||||
s.log.error(errPrefix + "jar archive does not exist\n" + jar.getAbsolutePath)
|
||||
failSubmit()
|
||||
} else if (fileLength == 0L) {
|
||||
s.log.error(errPrefix + "jar archive is empty\n" + jar.getAbsolutePath)
|
||||
failSubmit()
|
||||
} else if (fileLength > maxSubmitFileSize) {
|
||||
s.log.error(errPrefix + "jar archive is too big. Allowed size: " +
|
||||
maxSubmitFileSize + " bytes, found " + fileLength + " bytes.\n" +
|
||||
jar.getAbsolutePath)
|
||||
failSubmit()
|
||||
} else {
|
||||
val bytes = new Array[Byte](fileLength.toInt)
|
||||
val sizeRead = try {
|
||||
val is = new FileInputStream(jar)
|
||||
val read = is.read(bytes)
|
||||
is.close()
|
||||
read
|
||||
} catch {
|
||||
case ex: IOException =>
|
||||
s.log.error(errPrefix + "failed to read sources jar archive\n" + ex.toString)
|
||||
failSubmit()
|
||||
}
|
||||
if (sizeRead != bytes.length) {
|
||||
s.log.error(errPrefix + "failed to read the sources jar archive, size read: " + sizeRead)
|
||||
failSubmit()
|
||||
} else encodeBase64(bytes)
|
||||
}
|
||||
}
|
||||
|
||||
/** Task to package solution to a given file path */
|
||||
lazy val packageSubmissionSetting = packageSubmission := {
|
||||
val args: Seq[String] = Def.spaceDelimited("[path]").parsed
|
||||
val s: TaskStreams = streams.value // for logging
|
||||
val jar = (packageSubmissionZip in Compile).value
|
||||
|
||||
val base64Jar = prepareJar(jar, s)
|
||||
|
||||
val path = args.headOption.getOrElse((baseDirectory.value / "submission.jar").absolutePath)
|
||||
scala.tools.nsc.io.File(path).writeAll(base64Jar)
|
||||
}
|
||||
|
||||
/*
|
||||
/** Task to submit a solution to coursera */
|
||||
val submit = inputKey[Unit]("submit solution to Coursera")
|
||||
lazy val submitSetting = submit := {
|
||||
// Fail if scalafix linting does not pass.
|
||||
scalafixLinting.value
|
||||
|
||||
val args: Seq[String] = Def.spaceDelimited("<arg>").parsed
|
||||
val s: TaskStreams = streams.value // for logging
|
||||
val jar = (packageSubmissionZip in Compile).value
|
||||
|
||||
val assignmentDetails =
|
||||
courseraId.?.value.getOrElse(throw new MessageOnlyException("This assignment can not be submitted to Coursera because the `courseraId` setting is undefined"))
|
||||
val assignmentKey = assignmentDetails.key
|
||||
val courseName =
|
||||
course.value match {
|
||||
case "capstone" => "scala-capstone"
|
||||
case "bigdata" => "scala-spark-big-data"
|
||||
case other => other
|
||||
}
|
||||
|
||||
val partId = assignmentDetails.partId
|
||||
val itemId = assignmentDetails.itemId
|
||||
val premiumItemId = assignmentDetails.premiumItemId
|
||||
|
||||
val (email, secret) = args match {
|
||||
case email :: secret :: Nil =>
|
||||
(email, secret)
|
||||
case _ =>
|
||||
val inputErr =
|
||||
s"""|Invalid input to `submit`. The required syntax for `submit` is:
|
||||
|submit <email-address> <submit-token>
|
||||
|
|
||||
|The submit token is NOT YOUR LOGIN PASSWORD.
|
||||
|It can be obtained from the assignment page:
|
||||
|https://www.coursera.org/learn/$courseName/programming/$itemId
|
||||
|${
|
||||
premiumItemId.fold("") { id =>
|
||||
s"""or (for premium learners):
|
||||
|https://www.coursera.org/learn/$courseName/programming/$id
|
||||
""".stripMargin
|
||||
}
|
||||
}
|
||||
""".stripMargin
|
||||
s.log.error(inputErr)
|
||||
failSubmit()
|
||||
}
|
||||
|
||||
val base64Jar = prepareJar(jar, s)
|
||||
val json =
|
||||
s"""|{
|
||||
| "assignmentKey":"$assignmentKey",
|
||||
| "submitterEmail":"$email",
|
||||
| "secret":"$secret",
|
||||
| "parts":{
|
||||
| "$partId":{
|
||||
| "output":"$base64Jar"
|
||||
| }
|
||||
| }
|
||||
|}""".stripMargin
|
||||
|
||||
def postSubmission[T](data: String): Try[HttpResponse[String]] = {
|
||||
val http = Http("https://www.coursera.org/api/onDemandProgrammingScriptSubmissions.v1")
|
||||
val hs = List(
|
||||
("Cache-Control", "no-cache"),
|
||||
("Content-Type", "application/json")
|
||||
)
|
||||
s.log.info("Connecting to Coursera...")
|
||||
val response = Try(http.postData(data)
|
||||
.headers(hs)
|
||||
.option(HttpOptions.connTimeout(10000)) // scalaj default timeout is only 100ms, changing that to 10s
|
||||
.asString) // kick off HTTP POST
|
||||
response
|
||||
}
|
||||
|
||||
val connectMsg =
|
||||
s"""|Attempting to submit "${assignment.value}" assignment in "$courseName" course
|
||||
|Using:
|
||||
|- email: $email
|
||||
|- submit token: $secret""".stripMargin
|
||||
s.log.info(connectMsg)
|
||||
|
||||
def reportCourseraResponse(response: HttpResponse[String]): Unit = {
|
||||
val code = response.code
|
||||
val respBody = response.body
|
||||
|
||||
/* Sample JSON response from Coursera
|
||||
{
|
||||
"message": "Invalid email or token.",
|
||||
"details": {
|
||||
"learnerMessage": "Invalid email or token."
|
||||
}
|
||||
}
|
||||
*/
|
||||
|
||||
// Success, Coursera responds with 2xx HTTP status code
|
||||
if (response.is2xx) {
|
||||
val successfulSubmitMsg =
|
||||
s"""|Successfully connected to Coursera. (Status $code)
|
||||
|
|
||||
|Assignment submitted successfully!
|
||||
|
|
||||
|You can see how you scored by going to:
|
||||
|https://www.coursera.org/learn/$courseName/programming/$itemId/
|
||||
|${
|
||||
premiumItemId.fold("") { id =>
|
||||
s"""or (for premium learners):
|
||||
|https://www.coursera.org/learn/$courseName/programming/$id
|
||||
""".stripMargin
|
||||
}
|
||||
}
|
||||
|and clicking on "My Submission".""".stripMargin
|
||||
s.log.info(successfulSubmitMsg)
|
||||
}
|
||||
|
||||
// Failure, Coursera responds with 4xx HTTP status code (client-side failure)
|
||||
else if (response.is4xx) {
|
||||
val result = Try(Json.parse(respBody)).toOption
|
||||
val learnerMsg = result match {
|
||||
case Some(resp: JsObject) =>
|
||||
(JsPath \ "details" \ "learnerMessage").read[String].reads(resp).get
|
||||
case Some(x) => // shouldn't happen
|
||||
"Could not parse Coursera's response:\n" + x
|
||||
case None =>
|
||||
"Could not parse Coursera's response:\n" + respBody
|
||||
}
|
||||
val failedSubmitMsg =
|
||||
s"""|Submission failed.
|
||||
|There was something wrong while attempting to submit.
|
||||
|Coursera says:
|
||||
|$learnerMsg (Status $code)""".stripMargin
|
||||
s.log.error(failedSubmitMsg)
|
||||
}
|
||||
|
||||
// Failure, Coursera responds with 5xx HTTP status code (server-side failure)
|
||||
else if (response.is5xx) {
|
||||
val failedSubmitMsg =
|
||||
s"""|Submission failed.
|
||||
|Coursera seems to be unavailable at the moment (Status $code)
|
||||
|Check https://status.coursera.org/ and try again in a few minutes.
|
||||
""".stripMargin
|
||||
s.log.error(failedSubmitMsg)
|
||||
}
|
||||
|
||||
// Failure, Coursera repsonds with an unexpected status code
|
||||
else {
|
||||
val failedSubmitMsg =
|
||||
s"""|Submission failed.
|
||||
|Coursera replied with an unexpected code (Status $code)
|
||||
""".stripMargin
|
||||
s.log.error(failedSubmitMsg)
|
||||
}
|
||||
}
|
||||
|
||||
// kick it all off, actually make request
|
||||
postSubmission(json) match {
|
||||
case Success(resp) => reportCourseraResponse(resp)
|
||||
case Failure(e) =>
|
||||
val failedConnectMsg =
|
||||
s"""|Connection to Coursera failed.
|
||||
|There was something wrong while attempting to connect to Coursera.
|
||||
|Check your internet connection.
|
||||
|${e.toString}""".stripMargin
|
||||
s.log.error(failedConnectMsg)
|
||||
}
|
||||
|
||||
}
|
||||
*/
|
||||
|
||||
def failSubmit(): Nothing = {
|
||||
sys.error("Submission failed")
|
||||
}
|
||||
|
||||
/**
|
||||
* *****************
|
||||
* DEALING WITH JARS
|
||||
*/
|
||||
def encodeBase64(bytes: Array[Byte]): String =
|
||||
new String(Base64.encodeBase64(bytes))
|
||||
}
|
||||
1
project/build.properties
Normal file
1
project/build.properties
Normal file
@ -0,0 +1 @@
|
||||
sbt.version=1.3.8
|
||||
5
project/buildSettings.sbt
Normal file
5
project/buildSettings.sbt
Normal file
@ -0,0 +1,5 @@
|
||||
// Used for Coursera submission (StudentPlugin)
|
||||
// libraryDependencies += "org.scalaj" %% "scalaj-http" % "2.4.2"
|
||||
// libraryDependencies += "com.typesafe.play" %% "play-json" % "2.7.4"
|
||||
// Used for Base64 (StudentPlugin)
|
||||
libraryDependencies += "commons-codec" % "commons-codec" % "1.10"
|
||||
2
project/plugins.sbt
Normal file
2
project/plugins.sbt
Normal file
@ -0,0 +1,2 @@
|
||||
addSbtPlugin("org.scala-js" % "sbt-scalajs" % "0.6.28")
|
||||
addSbtPlugin("ch.epfl.lamp" % "sbt-dotty" % "0.4.0")
|
||||
32
src/main/scala/lockfree/AbstractSortedList.scala
Normal file
32
src/main/scala/lockfree/AbstractSortedList.scala
Normal file
@ -0,0 +1,32 @@
|
||||
package lockfree
|
||||
|
||||
import instrumentation.LockFreeMonitor
|
||||
import scala.collection._
|
||||
import java.util.concurrent.atomic._
|
||||
|
||||
|
||||
abstract class AbstractSortedList extends LockFreeMonitor {
|
||||
|
||||
def createNode(value: Int, tail: Option[Node], isHead: Boolean = false) = new Node(value, tail) {
|
||||
override def toString = if(isHead) "HEAD" else super.toString
|
||||
}
|
||||
|
||||
def firstNode: Option[Node]
|
||||
|
||||
def findNodeWithPrev(pred: Int => Boolean): (Node, Option[Node])
|
||||
|
||||
def insert(e: Int): Unit
|
||||
|
||||
def delete(e: Int): Boolean
|
||||
|
||||
def toList: List[Int] = {
|
||||
var curr = firstNode
|
||||
var list = List[Int]()
|
||||
while(curr.nonEmpty) {
|
||||
if(!curr.get.deleted) list :+= curr.get.value
|
||||
curr = curr.get.next
|
||||
}
|
||||
list
|
||||
}
|
||||
}
|
||||
|
||||
25
src/main/scala/lockfree/AtomicVariable.scala
Normal file
25
src/main/scala/lockfree/AtomicVariable.scala
Normal file
@ -0,0 +1,25 @@
|
||||
package lockfree
|
||||
|
||||
import java.util.concurrent.atomic._
|
||||
|
||||
abstract class AbstractAtomicVariable[T] {
|
||||
def get: T
|
||||
def compareAndSet(expect: T, newval: T) : Boolean
|
||||
}
|
||||
|
||||
class AtomicVariable[T](initial: T) extends AbstractAtomicVariable[T] {
|
||||
|
||||
private val atomic = new AtomicReference[T](initial)
|
||||
|
||||
override def get: T = atomic.get()
|
||||
|
||||
override def compareAndSet(expected: T, value: T): Boolean = {
|
||||
val current = atomic.get
|
||||
if (current == expected) {
|
||||
atomic.compareAndSet(current, value)
|
||||
}
|
||||
else {
|
||||
false
|
||||
}
|
||||
}
|
||||
}
|
||||
22
src/main/scala/lockfree/Node.scala
Normal file
22
src/main/scala/lockfree/Node.scala
Normal file
@ -0,0 +1,22 @@
|
||||
package lockfree
|
||||
|
||||
abstract class Node(val value: Int, initTail: Option[Node]) {
|
||||
|
||||
// The type of mutable state held by node.
|
||||
type State = Option[Node]
|
||||
|
||||
// The initial mutable state of the node.
|
||||
def initialState: State = initTail
|
||||
|
||||
// The atomic variable that holds the state.
|
||||
val atomicState: AbstractAtomicVariable[State] = new AtomicVariable[State](initialState)
|
||||
|
||||
// Function to read the next node from the state.
|
||||
def next: Option[Node] = atomicState.get
|
||||
|
||||
// Should return true if the node was marked as deleted.
|
||||
def deleted: Boolean = false
|
||||
|
||||
// Should mark the node as deleted.
|
||||
def mark: Boolean = ???
|
||||
}
|
||||
26
src/main/scala/lockfree/SortedList.scala
Normal file
26
src/main/scala/lockfree/SortedList.scala
Normal file
@ -0,0 +1,26 @@
|
||||
package lockfree
|
||||
|
||||
import scala.annotation.tailrec
|
||||
|
||||
class SortedList extends AbstractSortedList {
|
||||
|
||||
// The sentinel node at the head.
|
||||
private val _head: Node = createNode(0, None, isHead = true)
|
||||
|
||||
// The first logical node is referenced by the head.
|
||||
def firstNode: Option[Node] = _head.next
|
||||
|
||||
// Finds the first node whose value satisfies the predicate.
|
||||
// Returns the predecessor of the node and the node.
|
||||
def findNodeWithPrev(pred: Int => Boolean): (Node, Option[Node]) = ???
|
||||
|
||||
// Insert an element in the list.
|
||||
def insert(e: Int): Unit = ???
|
||||
|
||||
// Checks if the list contains an element.
|
||||
def contains(e: Int): Boolean = ???
|
||||
|
||||
// Delete an element from the list.
|
||||
// Should only delete one element when multiple occurences are present.
|
||||
def delete(e: Int): Boolean = ???
|
||||
}
|
||||
83
src/main/scala/lockfree/SortingBenchmarks.scala
Normal file
83
src/main/scala/lockfree/SortingBenchmarks.scala
Normal file
@ -0,0 +1,83 @@
|
||||
package lockfree
|
||||
|
||||
import scala.util.Random
|
||||
import instrumentation.Stats._
|
||||
|
||||
object SortingBenchmarks extends App {
|
||||
|
||||
val items = 2500
|
||||
val threads = 12
|
||||
|
||||
val insertions = List.fill(items)(Random.nextInt)
|
||||
val deletions = Random.shuffle(insertions)
|
||||
val parInsertions = parBuckets(threads, insertions)_
|
||||
val parDeletions = parBuckets(threads, deletions)_
|
||||
|
||||
private class SynchronizedSortedList extends SortedList {
|
||||
val lock = new Object
|
||||
def syncTraverse(stop: Int => Boolean) = lock.synchronized(super.findNodeWithPrev(stop))
|
||||
def syncInsert(e: Int) = lock.synchronized(super.insert(e))
|
||||
def syncDelete(e: Int) = lock.synchronized(super.delete(e))
|
||||
}
|
||||
|
||||
val syncSeqTime = {
|
||||
val l = new SynchronizedSortedList
|
||||
withTime {
|
||||
insertions.foreach(l.syncInsert)
|
||||
deletions.foreach(l.syncDelete)
|
||||
}._2
|
||||
}
|
||||
|
||||
val syncParTime = {
|
||||
val l = new SynchronizedSortedList
|
||||
withTime {
|
||||
val ops = parInsertions(l.syncInsert) ++ parDeletions(l.syncDelete)
|
||||
ops.foreach(_.start)
|
||||
ops.foreach(_.join)
|
||||
}._2
|
||||
}
|
||||
|
||||
val fineSeqTime = {
|
||||
val l = new SortedList
|
||||
withTime {
|
||||
insertions.foreach(l.insert)
|
||||
deletions.foreach(l.delete)
|
||||
}._2
|
||||
}
|
||||
|
||||
val fineParTime = {
|
||||
val l = new SortedList
|
||||
withTime {
|
||||
val ops = parInsertions(l.insert) ++ parDeletions(l.delete)
|
||||
ops.foreach(_.start)
|
||||
ops.foreach(_.join)
|
||||
}._2
|
||||
}
|
||||
|
||||
println(
|
||||
s"""
|
||||
|***** Results *****
|
||||
|
|
||||
|synchronized:
|
||||
| - sequential: $syncSeqTime
|
||||
| - parallel: $syncParTime
|
||||
| - speedup: ${syncSeqTime / syncParTime}
|
||||
|
|
||||
|fine-grained:
|
||||
| - sequential: $fineSeqTime
|
||||
| - parallel: $fineParTime
|
||||
| - speedup: ${fineSeqTime / fineParTime}
|
||||
|
|
||||
|synchronized/fine-grained:
|
||||
| - speedup: ${syncParTime / fineParTime}
|
||||
|
|
||||
""".stripMargin)
|
||||
|
||||
def parBuckets(threadCount: Int, items: List[Int])(op: Int => Any): List[Thread] =
|
||||
items.grouped(items.size / threadCount).toList.map { bucket =>
|
||||
new Thread {
|
||||
override def run(): Unit =
|
||||
bucket.foreach(op)
|
||||
}
|
||||
}
|
||||
}
|
||||
72
src/main/scala/lockfree/instrumentation/MockedMonitor.scala
Normal file
72
src/main/scala/lockfree/instrumentation/MockedMonitor.scala
Normal file
@ -0,0 +1,72 @@
|
||||
package instrumentation
|
||||
|
||||
trait MockedMonitor extends Monitor {
|
||||
def scheduler: Scheduler
|
||||
|
||||
// Can be overriden.
|
||||
override def waitDefault() = {
|
||||
scheduler.log("wait")
|
||||
scheduler updateThreadState Wait(this, scheduler.threadLocks.tail)
|
||||
}
|
||||
override def synchronizedDefault[T](toExecute: =>T): T = {
|
||||
scheduler.log("synchronized check")
|
||||
val prevLocks = scheduler.threadLocks
|
||||
scheduler updateThreadState Sync(this, prevLocks) // If this belongs to prevLocks, should just continue.
|
||||
scheduler.log("synchronized -> enter")
|
||||
try {
|
||||
toExecute
|
||||
} finally {
|
||||
scheduler updateThreadState Running(prevLocks)
|
||||
scheduler.log("synchronized -> out")
|
||||
}
|
||||
}
|
||||
override def notifyDefault() = {
|
||||
scheduler mapOtherStates {
|
||||
state => state match {
|
||||
case Wait(lockToAquire, locks) if lockToAquire == this => SyncUnique(this, state.locks)
|
||||
case e => e
|
||||
}
|
||||
}
|
||||
scheduler.log("notify")
|
||||
}
|
||||
override def notifyAllDefault() = {
|
||||
scheduler mapOtherStates {
|
||||
state => state match {
|
||||
case Wait(lockToAquire, locks) if lockToAquire == this => Sync(this, state.locks)
|
||||
case SyncUnique(lockToAquire, locks) if lockToAquire == this => Sync(this, state.locks)
|
||||
case e => e
|
||||
}
|
||||
}
|
||||
scheduler.log("notifyAll")
|
||||
}
|
||||
}
|
||||
|
||||
trait LockFreeMonitor extends Monitor {
|
||||
override def waitDefault() = {
|
||||
throw new Exception("Please use lock-free structures and do not use wait()")
|
||||
}
|
||||
override def synchronizedDefault[T](toExecute: =>T): T = {
|
||||
throw new Exception("Please use lock-free structures and do not use synchronized()")
|
||||
}
|
||||
override def notifyDefault() = {
|
||||
throw new Exception("Please use lock-free structures and do not use notify()")
|
||||
}
|
||||
override def notifyAllDefault() = {
|
||||
throw new Exception("Please use lock-free structures and do not use notifyAll()")
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
abstract class ThreadState {
|
||||
def locks: Seq[AnyRef]
|
||||
}
|
||||
trait CanContinueIfAcquiresLock extends ThreadState {
|
||||
def lockToAquire: AnyRef
|
||||
}
|
||||
case object Start extends ThreadState { def locks: Seq[AnyRef] = Seq.empty }
|
||||
case object End extends ThreadState { def locks: Seq[AnyRef] = Seq.empty }
|
||||
case class Wait(lockToAquire: AnyRef, locks: Seq[AnyRef]) extends ThreadState
|
||||
case class SyncUnique(lockToAquire: AnyRef, locks: Seq[AnyRef]) extends ThreadState with CanContinueIfAcquiresLock
|
||||
case class Sync(lockToAquire: AnyRef, locks: Seq[AnyRef]) extends ThreadState with CanContinueIfAcquiresLock
|
||||
case class Running(locks: Seq[AnyRef]) extends ThreadState
|
||||
case class VariableReadWrite(locks: Seq[AnyRef]) extends ThreadState
|
||||
23
src/main/scala/lockfree/instrumentation/Monitor.scala
Normal file
23
src/main/scala/lockfree/instrumentation/Monitor.scala
Normal file
@ -0,0 +1,23 @@
|
||||
package instrumentation
|
||||
|
||||
class Dummy
|
||||
|
||||
trait Monitor {
|
||||
implicit val dummy: Dummy = new Dummy
|
||||
|
||||
def wait()(implicit i: Dummy) = waitDefault()
|
||||
|
||||
def synchronized[T](e: => T)(implicit i: Dummy) = synchronizedDefault(e)
|
||||
|
||||
def notify()(implicit i: Dummy) = notifyDefault()
|
||||
|
||||
def notifyAll()(implicit i: Dummy) = notifyAllDefault()
|
||||
|
||||
private val lock = new AnyRef
|
||||
|
||||
// Can be overriden.
|
||||
def waitDefault(): Unit = lock.wait()
|
||||
def synchronizedDefault[T](toExecute: =>T): T = lock.synchronized(toExecute)
|
||||
def notifyDefault(): Unit = lock.notify()
|
||||
def notifyAllDefault(): Unit = lock.notifyAll()
|
||||
}
|
||||
@ -0,0 +1,35 @@
|
||||
package instrumentation
|
||||
|
||||
import scala.annotation.tailrec
|
||||
import lockfree._
|
||||
import java.util.concurrent.atomic._
|
||||
|
||||
class SchedulableAtomicVariable[T](initial: T, scheduler: Scheduler, self: Node) extends AbstractAtomicVariable[T] {
|
||||
private val proxied: AtomicVariable[T] = new AtomicVariable[T](initial)
|
||||
|
||||
override def get: T = scheduler.exec {
|
||||
proxied.get
|
||||
} ( s"", Some(res => s"$self: get $res") )
|
||||
|
||||
override def compareAndSet(expect: T, newval: T): Boolean = {
|
||||
scheduler.exec {
|
||||
proxied.compareAndSet(expect, newval)
|
||||
} (s"$self: compareAndSet expect = $expect, newval = $newval", Some(res => s"$self: Did it set? $res") )
|
||||
}
|
||||
}
|
||||
|
||||
class SchedulableNode(value: Int, initTail: Option[Node], val scheduler: Scheduler) extends Node(value, initTail) with LockFreeMonitor { self =>
|
||||
|
||||
override val atomicState: AbstractAtomicVariable[State] = new SchedulableAtomicVariable[State](initialState, scheduler, this)
|
||||
|
||||
override def toString: String =
|
||||
String.format("Node(%s)#%02d", value.toString, new Integer(## % 100))
|
||||
}
|
||||
|
||||
class SchedulableSortedList(val scheduler: Scheduler) extends SortedList with LockFreeMonitor {
|
||||
|
||||
override def createNode(value: Int, tail: Option[Node], isHead: Boolean) = new SchedulableNode(value, tail, scheduler) {
|
||||
override def toString = if(isHead) "HEAD" else super.toString
|
||||
}
|
||||
}
|
||||
|
||||
304
src/main/scala/lockfree/instrumentation/Scheduler.scala
Normal file
304
src/main/scala/lockfree/instrumentation/Scheduler.scala
Normal file
@ -0,0 +1,304 @@
|
||||
package instrumentation
|
||||
|
||||
import java.util.concurrent._;
|
||||
import scala.concurrent.duration._
|
||||
import scala.collection.mutable._
|
||||
import Stats._
|
||||
|
||||
import java.util.concurrent.atomic.AtomicInteger
|
||||
|
||||
sealed abstract class Result
|
||||
case class RetVal(rets: List[Any]) extends Result
|
||||
case class Except(msg: String, stackTrace: Array[StackTraceElement]) extends Result
|
||||
case class Timeout(msg: String) extends Result
|
||||
|
||||
/**
|
||||
* A class that maintains schedule and a set of thread ids.
|
||||
* The schedules are advanced after an operation of a SchedulableBuffer is performed.
|
||||
* Note: the real schedule that is executed may deviate from the input schedule
|
||||
* due to the adjustments that had to be made for locks
|
||||
*/
|
||||
class Scheduler(sched: List[Int]) {
|
||||
val maxOps = 500 // a limit on the maximum number of operations the code is allowed to perform
|
||||
|
||||
private var schedule = sched
|
||||
private var numThreads = 0
|
||||
private val realToFakeThreadId = Map[Long, Int]()
|
||||
private val opLog = ListBuffer[String]() // a mutable list (used for efficient concat)
|
||||
private val threadStates = Map[Int, ThreadState]()
|
||||
|
||||
/**
|
||||
* Runs a set of operations in parallel as per the schedule.
|
||||
* Each operation may consist of many primitive operations like reads or writes
|
||||
* to shared data structure each of which should be executed using the function `exec`.
|
||||
* @timeout in milliseconds
|
||||
* @return true - all threads completed on time, false -some tests timed out.
|
||||
*/
|
||||
def runInParallel(timeout: Long, ops: List[() => Any]): Result = {
|
||||
numThreads = ops.length
|
||||
val threadRes = Array.fill(numThreads) { None: Any }
|
||||
var exception: Option[Except] = None
|
||||
val syncObject = new Object()
|
||||
var completed = new AtomicInteger(0)
|
||||
// create threads
|
||||
val threads = ops.zipWithIndex.map {
|
||||
case (op, i) =>
|
||||
new Thread(new Runnable() {
|
||||
def run(): Unit = {
|
||||
val fakeId = i + 1
|
||||
setThreadId(fakeId)
|
||||
try {
|
||||
updateThreadState(Start)
|
||||
val res = op()
|
||||
updateThreadState(End)
|
||||
threadRes(i) = res
|
||||
// notify the master thread if all threads have completed
|
||||
if (completed.incrementAndGet() == ops.length) {
|
||||
syncObject.synchronized { syncObject.notifyAll() }
|
||||
}
|
||||
} catch {
|
||||
case e: Throwable if exception != None => // do nothing here and silently fail
|
||||
case e: Throwable =>
|
||||
log(s"throw ${e.toString}")
|
||||
exception = Some(Except(s"Thread $fakeId crashed on the following schedule: \n" + opLog.mkString("\n"),
|
||||
e.getStackTrace))
|
||||
syncObject.synchronized { syncObject.notifyAll() }
|
||||
//println(s"$fakeId: ${e.toString}")
|
||||
//Runtime.getRuntime().halt(0) //exit the JVM and all running threads (no other way to kill other threads)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
// start all threads
|
||||
threads.foreach(_.start())
|
||||
// wait for all threads to complete, or for an exception to be thrown, or for the time out to expire
|
||||
var remTime = timeout
|
||||
syncObject.synchronized {
|
||||
timed { if(completed.get() != ops.length) syncObject.wait(timeout) } { time => remTime -= time }
|
||||
}
|
||||
if (exception.isDefined) {
|
||||
exception.get
|
||||
} else if (remTime <= 1) { // timeout ? using 1 instead of zero to allow for some errors
|
||||
Timeout(opLog.mkString("\n"))
|
||||
} else {
|
||||
// every thing executed normally
|
||||
RetVal(threadRes.toList)
|
||||
}
|
||||
}
|
||||
|
||||
// Updates the state of the current thread
|
||||
def updateThreadState(state: ThreadState): Unit = {
|
||||
val tid = threadId
|
||||
synchronized {
|
||||
threadStates(tid) = state
|
||||
}
|
||||
state match {
|
||||
case Sync(lockToAquire, locks) =>
|
||||
if (locks.indexOf(lockToAquire) < 0) waitForTurn else {
|
||||
// Re-aqcuiring the same lock
|
||||
updateThreadState(Running(lockToAquire +: locks))
|
||||
}
|
||||
case Start => waitStart()
|
||||
case End => removeFromSchedule(tid)
|
||||
case Running(_) =>
|
||||
case _ => waitForTurn // Wait, SyncUnique, VariableReadWrite
|
||||
}
|
||||
}
|
||||
|
||||
def waitStart(): Unit = {
|
||||
//while (threadStates.size < numThreads) {
|
||||
//Thread.sleep(1)
|
||||
//}
|
||||
synchronized {
|
||||
if (threadStates.size < numThreads) {
|
||||
wait()
|
||||
} else {
|
||||
notifyAll()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
def threadLocks = {
|
||||
synchronized {
|
||||
threadStates(threadId).locks
|
||||
}
|
||||
}
|
||||
|
||||
def threadState = {
|
||||
synchronized {
|
||||
threadStates(threadId)
|
||||
}
|
||||
}
|
||||
|
||||
def mapOtherStates(f: ThreadState => ThreadState) = {
|
||||
val exception = threadId
|
||||
synchronized {
|
||||
for (k <- threadStates.keys if k != exception) {
|
||||
threadStates(k) = f(threadStates(k))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
def log(str: String) = {
|
||||
if((realToFakeThreadId contains Thread.currentThread().getId())) {
|
||||
val space = (" " * ((threadId - 1) * 2))
|
||||
val s = space + threadId + ":" + "\n".r.replaceAllIn(str, "\n" + space + " ")
|
||||
opLog += s
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes a read or write operation to a global data structure as per the given schedule
|
||||
* @param msg a message corresponding to the operation that will be logged
|
||||
*/
|
||||
def exec[T](primop: => T)(msg: => String, postMsg: => Option[T => String] = None): T = {
|
||||
if(! (realToFakeThreadId contains Thread.currentThread().getId())) {
|
||||
primop
|
||||
} else {
|
||||
updateThreadState(VariableReadWrite(threadLocks))
|
||||
val m = msg
|
||||
if(m != "") log(m)
|
||||
if (opLog.size > maxOps)
|
||||
throw new Exception(s"Total number of reads/writes performed by threads exceed $maxOps. A possible deadlock!")
|
||||
val res = primop
|
||||
postMsg match {
|
||||
case Some(m) => log(m(res))
|
||||
case None =>
|
||||
}
|
||||
res
|
||||
}
|
||||
}
|
||||
|
||||
private def setThreadId(fakeId: Int) = synchronized {
|
||||
realToFakeThreadId(Thread.currentThread.getId) = fakeId
|
||||
}
|
||||
|
||||
def threadId =
|
||||
try {
|
||||
realToFakeThreadId(Thread.currentThread().getId())
|
||||
} catch {
|
||||
case e: NoSuchElementException =>
|
||||
throw new Exception("You are accessing shared variables in the constructor. This is not allowed. The variables are already initialized!")
|
||||
}
|
||||
|
||||
private def isTurn(tid: Int) = synchronized {
|
||||
(!schedule.isEmpty && schedule.head != tid)
|
||||
}
|
||||
|
||||
def canProceed(): Boolean = {
|
||||
val tid = threadId
|
||||
canContinue match {
|
||||
case Some((i, state)) if i == tid =>
|
||||
//println(s"$tid: Runs ! Was in state $state")
|
||||
canContinue = None
|
||||
state match {
|
||||
case Sync(lockToAquire, locks) => updateThreadState(Running(lockToAquire +: locks))
|
||||
case SyncUnique(lockToAquire, locks) =>
|
||||
mapOtherStates {
|
||||
_ match {
|
||||
case SyncUnique(lockToAquire2, locks2) if lockToAquire2 == lockToAquire => Wait(lockToAquire2, locks2)
|
||||
case e => e
|
||||
}
|
||||
}
|
||||
updateThreadState(Running(lockToAquire +: locks))
|
||||
case VariableReadWrite(locks) => updateThreadState(Running(locks))
|
||||
}
|
||||
true
|
||||
case Some((i, state)) =>
|
||||
//println(s"$tid: not my turn but $i !")
|
||||
false
|
||||
case None =>
|
||||
false
|
||||
}
|
||||
}
|
||||
|
||||
var threadPreference = 0 // In the case the schedule is over, which thread should have the preference to execute.
|
||||
|
||||
/** returns true if the thread can continue to execute, and false otherwise */
|
||||
def decide(): Option[(Int, ThreadState)] = {
|
||||
if (!threadStates.isEmpty) { // The last thread who enters the decision loop takes the decision.
|
||||
//println(s"$threadId: I'm taking a decision")
|
||||
if (threadStates.values.forall { case e: Wait => true case _ => false }) {
|
||||
val waiting = threadStates.keys.map(_.toString).mkString(", ")
|
||||
val s = if (threadStates.size > 1) "s" else ""
|
||||
val are = if (threadStates.size > 1) "are" else "is"
|
||||
throw new Exception(s"Deadlock: Thread$s $waiting $are waiting but all others have ended and cannot notify them.")
|
||||
} else {
|
||||
// Threads can be in Wait, Sync, SyncUnique, and VariableReadWrite mode.
|
||||
// Let's determine which ones can continue.
|
||||
val notFree = threadStates.collect { case (id, state) => state.locks }.flatten.toSet
|
||||
val threadsNotBlocked = threadStates.toSeq.filter {
|
||||
case (id, v: VariableReadWrite) => true
|
||||
case (id, v: CanContinueIfAcquiresLock) => !notFree(v.lockToAquire) || (v.locks contains v.lockToAquire)
|
||||
case _ => false
|
||||
}
|
||||
if (threadsNotBlocked.isEmpty) {
|
||||
val waiting = threadStates.keys.map(_.toString).mkString(", ")
|
||||
val s = if (threadStates.size > 1) "s" else ""
|
||||
val are = if (threadStates.size > 1) "are" else "is"
|
||||
val whoHasLock = threadStates.toSeq.flatMap { case (id, state) => state.locks.map(lock => (lock, id)) }.toMap
|
||||
val reason = threadStates.collect {
|
||||
case (id, state: CanContinueIfAcquiresLock) if !notFree(state.lockToAquire) =>
|
||||
s"Thread $id is waiting on lock ${state.lockToAquire} held by thread ${whoHasLock(state.lockToAquire)}"
|
||||
}.mkString("\n")
|
||||
throw new Exception(s"Deadlock: Thread$s $waiting are interlocked. Indeed:\n$reason")
|
||||
} else if (threadsNotBlocked.size == 1) { // Do not consume the schedule if only one thread can execute.
|
||||
Some(threadsNotBlocked(0))
|
||||
} else {
|
||||
val next = schedule.indexWhere(t => threadsNotBlocked.exists { case (id, state) => id == t })
|
||||
if (next != -1) {
|
||||
//println(s"$threadId: schedule is $schedule, next chosen is ${schedule(next)}")
|
||||
val chosenOne = schedule(next) // TODO: Make schedule a mutable list.
|
||||
schedule = schedule.take(next) ++ schedule.drop(next + 1)
|
||||
Some((chosenOne, threadStates(chosenOne)))
|
||||
} else {
|
||||
threadPreference = (threadPreference + 1) % threadsNotBlocked.size
|
||||
val chosenOne = threadsNotBlocked(threadPreference) // Maybe another strategy
|
||||
Some(chosenOne)
|
||||
//threadsNotBlocked.indexOf(threadId) >= 0
|
||||
/*
|
||||
val tnb = threadsNotBlocked.map(_._1).mkString(",")
|
||||
val s = if (schedule.isEmpty) "empty" else schedule.mkString(",")
|
||||
val only = if (schedule.isEmpty) "" else " only"
|
||||
throw new Exception(s"The schedule is $s but$only threads ${tnb} can continue")*/
|
||||
}
|
||||
}
|
||||
}
|
||||
} else canContinue
|
||||
}
|
||||
|
||||
/**
|
||||
* This will be called before a schedulable operation begins.
|
||||
* This should not use synchronized
|
||||
*/
|
||||
var numThreadsWaiting = new AtomicInteger(0)
|
||||
//var waitingForDecision = Map[Int, Option[Int]]() // Mapping from thread ids to a number indicating who is going to make the choice.
|
||||
var canContinue: Option[(Int, ThreadState)] = None // The result of the decision thread Id of the thread authorized to continue.
|
||||
private def waitForTurn = {
|
||||
synchronized {
|
||||
if (numThreadsWaiting.incrementAndGet() == threadStates.size) {
|
||||
canContinue = decide()
|
||||
notifyAll()
|
||||
}
|
||||
//waitingForDecision(threadId) = Some(numThreadsWaiting)
|
||||
//println(s"$threadId Entering waiting with ticket number $numThreadsWaiting/${waitingForDecision.size}")
|
||||
while (!canProceed()) wait()
|
||||
}
|
||||
numThreadsWaiting.decrementAndGet()
|
||||
}
|
||||
|
||||
/**
|
||||
* To be invoked when a thread is about to complete
|
||||
*/
|
||||
private def removeFromSchedule(fakeid: Int) = synchronized {
|
||||
//println(s"$fakeid: I'm taking a decision because I finished")
|
||||
schedule = schedule.filterNot(_ == fakeid)
|
||||
threadStates -= fakeid
|
||||
if (numThreadsWaiting.get() == threadStates.size) {
|
||||
canContinue = decide()
|
||||
notifyAll()
|
||||
}
|
||||
}
|
||||
|
||||
def getOperationLog() = opLog
|
||||
}
|
||||
23
src/main/scala/lockfree/instrumentation/Stats.scala
Normal file
23
src/main/scala/lockfree/instrumentation/Stats.scala
Normal file
@ -0,0 +1,23 @@
|
||||
/* Copyright 2009-2015 EPFL, Lausanne */
|
||||
package instrumentation
|
||||
|
||||
import java.lang.management._
|
||||
|
||||
/**
|
||||
* A collection of methods that can be used to collect run-time statistics about Leon programs.
|
||||
* This is mostly used to test the resources properties of Leon programs
|
||||
*/
|
||||
object Stats {
|
||||
def timed[T](code: => T)(cont: Long => Unit): T = {
|
||||
var t1 = System.currentTimeMillis()
|
||||
val r = code
|
||||
cont((System.currentTimeMillis() - t1))
|
||||
r
|
||||
}
|
||||
|
||||
def withTime[T](code: => T): (T, Long) = {
|
||||
var t1 = System.currentTimeMillis()
|
||||
val r = code
|
||||
(r, (System.currentTimeMillis() - t1))
|
||||
}
|
||||
}
|
||||
124
src/main/scala/lockfree/instrumentation/TestHelper.scala
Normal file
124
src/main/scala/lockfree/instrumentation/TestHelper.scala
Normal file
@ -0,0 +1,124 @@
|
||||
package instrumentation
|
||||
|
||||
import scala.util.Random
|
||||
import scala.collection.mutable.{Map => MutableMap}
|
||||
|
||||
import Stats._
|
||||
|
||||
object TestHelper {
|
||||
val noOfSchedules = 10000 // set this to 100k during deployment
|
||||
val readWritesPerThread = 20 // maximum number of read/writes possible in one thread
|
||||
val contextSwitchBound = 10
|
||||
val testTimeout = 240 // the total time out for a test in seconds
|
||||
val schedTimeout = 15 // the total time out for execution of a schedule in secs
|
||||
|
||||
// Helpers
|
||||
/*def testManySchedules(op1: => Any): Unit = testManySchedules(List(() => op1))
|
||||
def testManySchedules(op1: => Any, op2: => Any): Unit = testManySchedules(List(() => op1, () => op2))
|
||||
def testManySchedules(op1: => Any, op2: => Any, op3: => Any): Unit = testManySchedules(List(() => op1, () => op2, () => op3))
|
||||
def testManySchedules(op1: => Any, op2: => Any, op3: => Any, op4: => Any): Unit = testManySchedules(List(() => op1, () => op2, () => op3, () => op4))*/
|
||||
|
||||
def testSequential[T](ops: Scheduler => Any)(assertions: T => (Boolean, String)) =
|
||||
testManySchedules(1,
|
||||
(sched: Scheduler) => {
|
||||
(List(() => ops(sched)),
|
||||
(res: List[Any]) => assertions(res.head.asInstanceOf[T]))
|
||||
})
|
||||
|
||||
/**
|
||||
* @numThreads number of threads
|
||||
* @ops operations to be executed, one per thread
|
||||
* @assertion as condition that will executed after all threads have completed (without exceptions)
|
||||
* the arguments are the results of the threads
|
||||
*/
|
||||
def testManySchedules(numThreads: Int,
|
||||
ops: Scheduler =>
|
||||
(List[() => Any], // Threads
|
||||
List[Any] => (Boolean, String)) // Assertion
|
||||
) = {
|
||||
var timeout = testTimeout * 1000L
|
||||
val threadIds = (1 to numThreads)
|
||||
//(1 to scheduleLength).flatMap(_ => threadIds).toList.permutations.take(noOfSchedules).foreach {
|
||||
val schedules = (new ScheduleGenerator(numThreads)).schedules()
|
||||
var schedsExplored = 0
|
||||
schedules.takeWhile(_ => schedsExplored <= noOfSchedules && timeout > 0).foreach {
|
||||
//case _ if timeout <= 0 => // break
|
||||
case schedule =>
|
||||
schedsExplored += 1
|
||||
val schedr = new Scheduler(schedule)
|
||||
//println("Exploring Sched: "+schedule)
|
||||
val (threadOps, assertion) = ops(schedr)
|
||||
if (threadOps.size != numThreads)
|
||||
throw new IllegalStateException(s"Number of threads: $numThreads, do not match operations of threads: $threadOps")
|
||||
timed { schedr.runInParallel(schedTimeout * 1000, threadOps) } { t => timeout -= t } match {
|
||||
case Timeout(msg) =>
|
||||
throw new java.lang.AssertionError("assertion failed\n"+"The schedule took too long to complete. A possible deadlock! \n"+msg)
|
||||
case Except(msg, stkTrace) =>
|
||||
val traceStr = "Thread Stack trace: \n"+stkTrace.map(" at "+_.toString).mkString("\n")
|
||||
throw new java.lang.AssertionError("assertion failed\n"+msg+"\n"+traceStr)
|
||||
case RetVal(threadRes) =>
|
||||
// check the assertion
|
||||
val (success, custom_msg) = assertion(threadRes)
|
||||
if (!success) {
|
||||
val msg = "The following schedule resulted in wrong results: \n" + custom_msg + "\n" + schedr.getOperationLog().mkString("\n")
|
||||
throw new java.lang.AssertionError("Assertion failed: "+msg)
|
||||
}
|
||||
}
|
||||
}
|
||||
if (timeout <= 0) {
|
||||
throw new java.lang.AssertionError("Test took too long to complete! Cannot check all schedules as your code is too slow!")
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A schedule generator that is based on the context bound
|
||||
*/
|
||||
class ScheduleGenerator(numThreads: Int) {
|
||||
val scheduleLength = readWritesPerThread * numThreads
|
||||
val rands = (1 to scheduleLength).map(i => new Random(0xcafe * i)) // random numbers for choosing a thread at each position
|
||||
def schedules(): LazyList[List[Int]] = {
|
||||
var contextSwitches = 0
|
||||
var contexts = List[Int]() // a stack of thread ids in the order of context-switches
|
||||
val remainingOps = MutableMap[Int, Int]()
|
||||
remainingOps ++= (1 to numThreads).map(i => (i, readWritesPerThread)) // num ops remaining in each thread
|
||||
val liveThreads = (1 to numThreads).toSeq.toBuffer
|
||||
|
||||
/**
|
||||
* Updates remainingOps and liveThreads once a thread is chosen for a position in the schedule
|
||||
*/
|
||||
def updateState(tid: Int): Unit = {
|
||||
val remOps = remainingOps(tid)
|
||||
if (remOps == 0) {
|
||||
liveThreads -= tid
|
||||
} else {
|
||||
remainingOps += (tid -> (remOps - 1))
|
||||
}
|
||||
}
|
||||
val schedule = rands.foldLeft(List[Int]()) {
|
||||
case (acc, r) if contextSwitches < contextSwitchBound =>
|
||||
val tid = liveThreads(r.nextInt(liveThreads.size))
|
||||
contexts match {
|
||||
case prev :: tail if prev != tid => // we have a new context switch here
|
||||
contexts +:= tid
|
||||
contextSwitches += 1
|
||||
case prev :: tail =>
|
||||
case _ => // init case
|
||||
contexts +:= tid
|
||||
}
|
||||
updateState(tid)
|
||||
acc :+ tid
|
||||
case (acc, _) => // here context-bound has been reached so complete the schedule without any more context switches
|
||||
if (!contexts.isEmpty) {
|
||||
contexts = contexts.dropWhile(remainingOps(_) == 0)
|
||||
}
|
||||
val tid = contexts match {
|
||||
case top :: tail => top
|
||||
case _ => liveThreads(0) // here, there has to be threads that have not even started
|
||||
}
|
||||
updateState(tid)
|
||||
acc :+ tid
|
||||
}
|
||||
schedule #:: schedules()
|
||||
}
|
||||
}
|
||||
}
|
||||
19
src/main/scala/lockfree/instrumentation/TestUtils.scala
Normal file
19
src/main/scala/lockfree/instrumentation/TestUtils.scala
Normal file
@ -0,0 +1,19 @@
|
||||
package instrumentation
|
||||
|
||||
import scala.concurrent._
|
||||
import scala.concurrent.duration._
|
||||
import scala.concurrent.ExecutionContext.Implicits.global
|
||||
|
||||
object TestUtils {
|
||||
def failsOrTimesOut[T](action: => T): Boolean = {
|
||||
val asyncAction = Future {
|
||||
action
|
||||
}
|
||||
try {
|
||||
Await.result(asyncAction, 2000.millisecond)
|
||||
} catch {
|
||||
case _: Throwable => return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
}
|
||||
96
src/test/scala/lockfree/SortedListSuite.scala
Normal file
96
src/test/scala/lockfree/SortedListSuite.scala
Normal file
@ -0,0 +1,96 @@
|
||||
package lockfree
|
||||
|
||||
import scala.concurrent._
|
||||
import scala.concurrent.duration._
|
||||
import scala.collection.mutable.HashMap
|
||||
import scala.util.Random
|
||||
import org.junit._
|
||||
import org.junit.Assert.assertEquals
|
||||
import instrumentation.SchedulableSortedList
|
||||
import instrumentation.TestHelper._
|
||||
import instrumentation.TestUtils._
|
||||
|
||||
class SortedListSuite {
|
||||
|
||||
@Test def `Should work when 1, 2, and 3 are inserted sequentially`: Unit = {
|
||||
val l = new SortedList
|
||||
l.insert(1)
|
||||
l.insert(2)
|
||||
l.insert(3)
|
||||
assertEquals(List(1, 2, 3), l.toList)
|
||||
}
|
||||
|
||||
@Test def `Should work when 3, 2, and 1 are inserted sequentially`: Unit = {
|
||||
val l = new SortedList
|
||||
l.insert(3)
|
||||
l.insert(2)
|
||||
l.insert(1)
|
||||
assertEquals(List(1, 2, 3), l.toList)
|
||||
}
|
||||
|
||||
@Test def `Should work when duplicate elements are inserted sequentially`: Unit = {
|
||||
val l = new SortedList
|
||||
l.insert(0)
|
||||
l.insert(0)
|
||||
l.insert(2)
|
||||
l.insert(2)
|
||||
assertEquals(List(0, 0, 2, 2), l.toList)
|
||||
}
|
||||
|
||||
@Test def `Should return [1,4,5] when from [1,2,3,5], a thread removes 3, 2 and then inserts 4`: Unit = {
|
||||
val l = new SortedList
|
||||
l.insert(1)
|
||||
l.insert(2)
|
||||
l.insert(3)
|
||||
l.insert(5)
|
||||
l.delete(3)
|
||||
l.delete(2)
|
||||
l.insert(4)
|
||||
assertEquals(List(1, 4, 5), l.toList)
|
||||
}
|
||||
|
||||
@Test def `Should work when a random list of 100 elements are inserted sequentially`: Unit = {
|
||||
val rand = new Random()
|
||||
val randvals = for(i <- 1 to 100) yield rand.nextInt()
|
||||
val l = new SortedList
|
||||
randvals.foreach { l.insert }
|
||||
assertEquals(randvals.sorted, l.toList)
|
||||
}
|
||||
|
||||
@Test def `Should insert in parallel 1, 2 and 3 in the list (0, 4)`: Unit = {
|
||||
testManySchedules(3, sched => {
|
||||
val sortedList = new SchedulableSortedList(sched)
|
||||
sortedList.insert(0)
|
||||
sortedList.insert(4)
|
||||
((for(i <- 1 to 3) yield () => sortedList.insert(i)).toList,
|
||||
results => {
|
||||
val res = sortedList.toList
|
||||
(res == List(0, 1, 2, 3, 4),
|
||||
s"expected List(0, 1, 2, 3, 4), got $res")
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
@Test def `Should return List(true, false) when the first thread deletes 2 and the sec`: Unit = {
|
||||
testManySchedules(2, sched => {
|
||||
val sortedList = new SchedulableSortedList(sched)
|
||||
sortedList.insert(1)
|
||||
sortedList.insert(2)
|
||||
sortedList.insert(3)
|
||||
(List(() => sortedList.delete(2),
|
||||
() => sortedList.delete(4)),
|
||||
results => {
|
||||
val res = sortedList.toList
|
||||
val expected = List(1, 3)
|
||||
if(res != expected) {
|
||||
(false, s"expected the final list to be $expected, your 'delete' implementation returned ${res}")
|
||||
} else if(results != List(true, false)) {
|
||||
(false, s"expected threads to return List(true, false), your 'delete' implementation returned ${results}")
|
||||
} else (true, "")
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
@Rule def individualTestTimeout = new org.junit.rules.Timeout(200 * 1000)
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user