diff --git a/docker/asyncfutures2.nim b/docker/asyncfutures2.nim deleted file mode 100644 index e026f977..00000000 --- a/docker/asyncfutures2.nim +++ /dev/null @@ -1,1040 +0,0 @@ -# -# Chronos -# -# (c) Copyright 2015 Dominik Picheta -# (c) Copyright 2018-2021 Status Research & Development GmbH -# -# Licensed under either of -# Apache License, version 2.0, (LICENSE-APACHEv2) -# MIT license (LICENSE-MIT) - -import std/[os, tables, strutils, heapqueue, deques, sequtils] -import stew/base10 -import ./srcloc -export srcloc - -when defined(nimHasStacktracesModule): - import system/stacktraces -else: - const - reraisedFromBegin = -10 - reraisedFromEnd = -100 - -const - LocCreateIndex* = 0 - LocCompleteIndex* = 1 - -when defined(chronosStackTrace): - type StackTrace = string - -type - FutureState* {.pure.} = enum - Pending, Finished, Cancelled, Failed - - FutureBase* = ref object of RootObj ## Untyped future. - location*: array[2, ptr SrcLoc] - callbacks: seq[AsyncCallback] - cancelcb*: CallbackFunc - child*: FutureBase - state*: FutureState - error*: ref CatchableError ## Stored exception - mustCancel*: bool - id*: uint - - when defined(chronosStackTrace): - errorStackTrace*: StackTrace - stackTrace: StackTrace ## For debugging purposes only. - - when defined(chronosFutureTracking): - next*: FutureBase - prev*: FutureBase - - # ZAH: we have discussed some possible optimizations where - # the future can be stored within the caller's stack frame. - # How much refactoring is needed to make this a regular non-ref type? - # Obviously, it will still be allocated on the heap when necessary. - Future*[T] = ref object of FutureBase ## Typed future. - when defined(chronosStrictException): - closure*: iterator(f: Future[T]): FutureBase {.raises: [Defect, CatchableError], gcsafe.} - else: - closure*: iterator(f: Future[T]): FutureBase {.raises: [Defect, CatchableError, Exception], gcsafe.} - value: T ## Stored value - - FutureStr*[T] = ref object of Future[T] - ## Future to hold GC strings - gcholder*: string - - FutureSeq*[A, B] = ref object of Future[A] - ## Future to hold GC seqs - gcholder*: seq[B] - - FutureDefect* = object of Defect - cause*: FutureBase - - FutureError* = object of CatchableError - - CancelledError* = object of FutureError - - FutureList* = object - head*: FutureBase - tail*: FutureBase - count*: uint - -var currentID* {.threadvar.}: uint -currentID = 0'u - -when defined(chronosFutureTracking): - var futureList* {.threadvar.}: FutureList - futureList = FutureList() - -template setupFutureBase(loc: ptr SrcLoc) = - new(result) - currentID.inc() - result.state = FutureState.Pending - when defined(chronosStackTrace): - result.stackTrace = getStackTrace() - result.id = currentID - result.location[LocCreateIndex] = loc - - when defined(chronosFutureTracking): - result.next = nil - result.prev = futureList.tail - if not(isNil(futureList.tail)): - futureList.tail.next = result - futureList.tail = result - if isNil(futureList.head): - futureList.head = result - futureList.count.inc() - -proc newFutureImpl[T](loc: ptr SrcLoc): Future[T] = - setupFutureBase(loc) - -proc newFutureSeqImpl[A, B](loc: ptr SrcLoc): FutureSeq[A, B] = - setupFutureBase(loc) - -proc newFutureStrImpl[T](loc: ptr SrcLoc): FutureStr[T] = - setupFutureBase(loc) - -template newFuture*[T](fromProc: static[string] = ""): Future[T] = - ## Creates a new future. - ## - ## Specifying ``fromProc``, which is a string specifying the name of the proc - ## that this future belongs to, is a good habit as it helps with debugging. - newFutureImpl[T](getSrcLocation(fromProc)) - -template newFutureSeq*[A, B](fromProc: static[string] = ""): FutureSeq[A, B] = - ## Create a new future which can hold/preserve GC sequence until future will - ## not be completed. - ## - ## Specifying ``fromProc``, which is a string specifying the name of the proc - ## that this future belongs to, is a good habit as it helps with debugging. - newFutureSeqImpl[A, B](getSrcLocation(fromProc)) - -template newFutureStr*[T](fromProc: static[string] = ""): FutureStr[T] = - ## Create a new future which can hold/preserve GC string until future will - ## not be completed. - ## - ## Specifying ``fromProc``, which is a string specifying the name of the proc - ## that this future belongs to, is a good habit as it helps with debugging. - newFutureStrImpl[T](getSrcLocation(fromProc)) - -proc finished*(future: FutureBase): bool {.inline.} = - ## Determines whether ``future`` has completed, i.e. ``future`` state changed - ## from state ``Pending`` to one of the states (``Finished``, ``Cancelled``, - ## ``Failed``). - result = (future.state != FutureState.Pending) - -proc cancelled*(future: FutureBase): bool {.inline.} = - ## Determines whether ``future`` has cancelled. - (future.state == FutureState.Cancelled) - -proc failed*(future: FutureBase): bool {.inline.} = - ## Determines whether ``future`` completed with an error. - (future.state == FutureState.Failed) - -proc completed*(future: FutureBase): bool {.inline.} = - ## Determines whether ``future`` completed without an error. - (future.state == FutureState.Finished) - -proc done*(future: FutureBase): bool {.inline.} = - ## This is an alias for ``completed(future)`` procedure. - completed(future) - -when defined(chronosFutureTracking): - proc futureDestructor(udata: pointer) = - ## This procedure will be called when Future[T] got finished, cancelled or - ## failed and all Future[T].callbacks are already scheduled and processed. - let future = cast[FutureBase](udata) - if future == futureList.tail: futureList.tail = future.prev - if future == futureList.head: futureList.head = future.next - if not(isNil(future.next)): future.next.prev = future.prev - if not(isNil(future.prev)): future.prev.next = future.next - futureList.count.dec() - - proc scheduleDestructor(future: FutureBase) {.inline.} = - callSoon(futureDestructor, cast[pointer](future)) - -proc checkFinished(future: FutureBase, loc: ptr SrcLoc) = - ## Checks whether `future` is finished. If it is then raises a - ## ``FutureDefect``. - if future.finished(): - var msg = "" - msg.add("An attempt was made to complete a Future more than once. ") - msg.add("Details:") - msg.add("\n Future ID: " & Base10.toString(future.id)) - msg.add("\n Creation location:") - msg.add("\n " & $future.location[LocCreateIndex]) - msg.add("\n First completion location:") - msg.add("\n " & $future.location[LocCompleteIndex]) - msg.add("\n Second completion location:") - msg.add("\n " & $loc) - when defined(chronosStackTrace): - msg.add("\n Stack trace to moment of creation:") - msg.add("\n" & indent(future.stackTrace.strip(), 4)) - msg.add("\n Stack trace to moment of secondary completion:") - msg.add("\n" & indent(getStackTrace().strip(), 4)) - msg.add("\n\n") - var err = newException(FutureDefect, msg) - err.cause = future - raise err - else: - future.location[LocCompleteIndex] = loc - -proc finish(fut: FutureBase, state: FutureState) = - # We do not perform any checks here, because: - # 1. `finish()` is a private procedure and `state` is under our control. - # 2. `fut.state` is checked by `checkFinished()`. - fut.state = state - fut.cancelcb = nil # release cancellation callback memory - for item in fut.callbacks.mitems(): - if not(isNil(item.function)): - callSoon(item) - item = default(AsyncCallback) # release memory as early as possible - fut.callbacks = default(seq[AsyncCallback]) # release seq as well - - when defined(chronosFutureTracking): - scheduleDestructor(fut) - -proc complete[T](future: Future[T], val: T, loc: ptr SrcLoc) = - if not(future.cancelled()): - checkFinished(FutureBase(future), loc) - doAssert(isNil(future.error)) - future.value = val - future.finish(FutureState.Finished) - -template complete*[T](future: Future[T], val: T) = - ## Completes ``future`` with value ``val``. - complete(future, val, getSrcLocation()) - -proc complete(future: Future[void], loc: ptr SrcLoc) = - if not(future.cancelled()): - checkFinished(FutureBase(future), loc) - doAssert(isNil(future.error)) - future.finish(FutureState.Finished) - -template complete*(future: Future[void]) = - ## Completes a void ``future``. - complete(future, getSrcLocation()) - -proc fail[T](future: Future[T], error: ref CatchableError, loc: ptr SrcLoc) = - if not(future.cancelled()): - checkFinished(FutureBase(future), loc) - future.error = error - when defined(chronosStackTrace): - future.errorStackTrace = if getStackTrace(error) == "": - getStackTrace() - else: - getStackTrace(error) - future.finish(FutureState.Failed) - -template fail*[T](future: Future[T], error: ref CatchableError) = - ## Completes ``future`` with ``error``. - fail(future, error, getSrcLocation()) - -template newCancelledError(): ref CancelledError = - (ref CancelledError)(msg: "Future operation cancelled!") - -proc cancelAndSchedule(future: FutureBase, loc: ptr SrcLoc) = - if not(future.finished()): - checkFinished(future, loc) - future.error = newCancelledError() - when defined(chronosStackTrace): - future.errorStackTrace = getStackTrace() - future.finish(FutureState.Cancelled) - -template cancelAndSchedule*[T](future: Future[T]) = - cancelAndSchedule(FutureBase(future), getSrcLocation()) - -proc cancel(future: FutureBase, loc: ptr SrcLoc): bool = - ## Request that Future ``future`` cancel itself. - ## - ## This arranges for a `CancelledError` to be thrown into procedure which - ## waits for ``future`` on the next cycle through the event loop. - ## The procedure then has a chance to clean up or even deny the request - ## using `try/except/finally`. - ## - ## This call do not guarantee that the ``future`` will be cancelled: the - ## exception might be caught and acted upon, delaying cancellation of the - ## ``future`` or preventing cancellation completely. The ``future`` may also - ## return value or raise different exception. - ## - ## Immediately after this procedure is called, ``future.cancelled()`` will - ## not return ``true`` (unless the Future was already cancelled). - if future.finished(): - return false - - if not(isNil(future.child)): - if cancel(future.child, getSrcLocation()): - return true - else: - if not(isNil(future.cancelcb)): - future.cancelcb(cast[pointer](future)) - future.cancelcb = nil - cancelAndSchedule(future, getSrcLocation()) - - future.mustCancel = true - return true - -template cancel*(future: FutureBase) = - ## Cancel ``future``. - discard cancel(future, getSrcLocation()) - -template cancel*[T](future: Future[T]) = - ## Cancel ``future``. - discard cancel(FutureBase(future), getSrcLocation()) - -proc clearCallbacks(future: FutureBase) = - future.callbacks = default(seq[AsyncCallback]) - -proc addCallback*(future: FutureBase, cb: CallbackFunc, udata: pointer = nil) = - ## Adds the callbacks proc to be called when the future completes. - ## - ## If future has already completed then ``cb`` will be called immediately. - doAssert(not isNil(cb)) - if future.finished(): - callSoon(cb, udata) - else: - var acb = newAsyncCallback(cb, udata) - acb.location = future.location - - future.callbacks.add acb - -proc addCallback*[T](future: Future[T], cb: CallbackFunc) = - ## Adds the callbacks proc to be called when the future completes. - ## - ## If future has already completed then ``cb`` will be called immediately. - future.addCallback(cb, cast[pointer](future)) - -proc removeCallback*(future: FutureBase, cb: CallbackFunc, - udata: pointer = nil) = - ## Remove future from list of callbacks - this operation may be slow if there - ## are many registered callbacks! - doAssert(not isNil(cb)) - # Make sure to release memory associated with callback, or reference chains - # may be created! - future.callbacks.keepItIf: - it.function != cb or it.udata != udata - -proc removeCallback*[T](future: Future[T], cb: CallbackFunc) = - future.removeCallback(cb, cast[pointer](future)) - -proc `callback=`*(future: FutureBase, cb: CallbackFunc, udata: pointer = nil) = - ## Clears the list of callbacks and sets the callback proc to be called when - ## the future completes. - ## - ## If future has already completed then ``cb`` will be called immediately. - ## - ## It's recommended to use ``addCallback`` or ``then`` instead. - # ZAH: how about `setLen(1); callbacks[0] = cb` - future.clearCallbacks - future.addCallback(cb, udata) - -proc `callback=`*[T](future: Future[T], cb: CallbackFunc) = - ## Sets the callback proc to be called when the future completes. - ## - ## If future has already completed then ``cb`` will be called immediately. - `callback=`(future, cb, cast[pointer](future)) - -proc `cancelCallback=`*[T](future: Future[T], cb: CallbackFunc) = - ## Sets the callback procedure to be called when the future is cancelled. - ## - ## This callback will be called immediately as ``future.cancel()`` invoked. - future.cancelcb = cb - -{.push stackTrace: off.} -proc internalContinue[T](fut: pointer) {.gcsafe, raises: [Defect].} - -proc futureContinue*[T](fut: Future[T]) {.gcsafe, raises: [Defect].} = - # Used internally by async transformation - try: - if not(fut.closure.finished()): - var next = fut.closure(fut) - # Continue while the yielded future is already finished. - while (not next.isNil()) and next.finished(): - next = fut.closure(fut) - if fut.closure.finished(): - break - - if fut.closure.finished(): - fut.closure = nil - if next == nil: - if not(fut.finished()): - raiseAssert "Async procedure (" & ($fut.location[LocCreateIndex]) & ") yielded `nil`, " & - "are you await'ing a `nil` Future?" - else: - GC_ref(fut) - next.addCallback(internalContinue[T], cast[pointer](fut)) - except CancelledError: - fut.cancelAndSchedule() - except CatchableError as exc: - fut.fail(exc) - except Exception as exc: - if exc of Defect: - raise (ref Defect)(exc) - - fut.fail((ref ValueError)(msg: exc.msg, parent: exc)) - -proc internalContinue[T](fut: pointer) {.gcsafe, raises: [Defect].} = - let asFut = cast[Future[T]](fut) - GC_unref(asFut) - futureContinue(asFut) - -{.pop.} - -template getFilenameProcname(entry: StackTraceEntry): (string, string) = - when compiles(entry.filenameStr) and compiles(entry.procnameStr): - # We can't rely on "entry.filename" and "entry.procname" still being valid - # cstring pointers, because the "string.data" buffers they pointed to might - # be already garbage collected (this entry being a non-shallow copy, - # "entry.filename" no longer points to "entry.filenameStr.data", but to the - # buffer of the original object). - (entry.filenameStr, entry.procnameStr) - else: - ($entry.filename, $entry.procname) - -proc getHint(entry: StackTraceEntry): string = - ## We try to provide some hints about stack trace entries that the user - ## may not be familiar with, in particular calls inside the stdlib. - - let (filename, procname) = getFilenameProcname(entry) - - if procname == "processPendingCallbacks": - if cmpIgnoreStyle(filename, "asyncdispatch.nim") == 0: - return "Executes pending callbacks" - elif procname == "poll": - if cmpIgnoreStyle(filename, "asyncdispatch.nim") == 0: - return "Processes asynchronous completion events" - - if procname == "internalContinue": - if cmpIgnoreStyle(filename, "asyncfutures.nim") == 0: - return "Resumes an async procedure" - -proc `$`(stackTraceEntries: seq[StackTraceEntry]): string = - try: - when defined(nimStackTraceOverride) and declared(addDebuggingInfo): - let entries = addDebuggingInfo(stackTraceEntries) - else: - let entries = stackTraceEntries - - # Find longest filename & line number combo for alignment purposes. - var longestLeft = 0 - for entry in entries: - let (filename, procname) = getFilenameProcname(entry) - - if procname == "": continue - - let leftLen = filename.len + len($entry.line) - if leftLen > longestLeft: - longestLeft = leftLen - - var indent = 2 - # Format the entries. - for entry in entries: - let (filename, procname) = getFilenameProcname(entry) - - if procname == "": - if entry.line == reraisedFromBegin: - result.add(spaces(indent) & "#[\n") - indent.inc(2) - elif entry.line == reraisedFromEnd: - indent.dec(2) - result.add(spaces(indent) & "]#\n") - continue - - let left = "$#($#)" % [filename, $entry.line] - result.add((spaces(indent) & "$#$# $#\n") % [ - left, - spaces(longestLeft - left.len + 2), - procname - ]) - let hint = getHint(entry) - if hint.len > 0: - result.add(spaces(indent+2) & "## " & hint & "\n") - except ValueError as exc: - return exc.msg # Shouldn't actually happen since we set the formatting - # string - -when defined(chronosStackTrace): - proc injectStacktrace(future: FutureBase) = - const header = "\nAsync traceback:\n" - - var exceptionMsg = future.error.msg - if header in exceptionMsg: - # This is messy: extract the original exception message from the msg - # containing the async traceback. - let start = exceptionMsg.find(header) - exceptionMsg = exceptionMsg[0.. chronosDurationThreshold: - - # callable.location*: array[2, ptr SrcLoc] - # procedure*: cstring - # file*: cstring - # line*: int - - var trace = "trace: " - if not(isNil(callable.location[0])): trace = trace & "[0]=" & $callable.location[0] - if not(isNil(callable.location[1])): trace = trace & "[1]=" & $callable.location[1] - invokeChronosDurationThresholdBreachedHandler(trace, durationUs) + invokeChronosDurationThresholdBreachedHandler(durationUs) proc raiseAsDefect*(exc: ref Exception, msg: string) {. raises: [Defect], noreturn, noinline.} = diff --git a/docker/codex.Dockerfile b/docker/codex.Dockerfile index 28848770..a35851f2 100644 --- a/docker/codex.Dockerfile +++ b/docker/codex.Dockerfile @@ -21,9 +21,7 @@ WORKDIR ${BUILD_HOME} COPY . . RUN make clean RUN make -j ${MAKE_PARALLEL} update -COPY docker/asyncfutures2.nim ./vendor/nim-chronos/chronos COPY docker/asyncloop.nim ./vendor/nim-chronos/chronos -COPY docker/srcloc.nim ./vendor/nim-chronos/chronos RUN make -j ${MAKE_PARALLEL} # Create diff --git a/docker/srcloc.nim b/docker/srcloc.nim deleted file mode 100644 index 6edaefb5..00000000 --- a/docker/srcloc.nim +++ /dev/null @@ -1,42 +0,0 @@ -# -# Chronos source location utilities -# (c) Copyright 2018-Present -# Status Research & Development GmbH -# -# Licensed under either of -# Apache License, version 2.0, (LICENSE-APACHEv2) -# MIT license (LICENSE-MIT) -when (NimMajor, NimMinor) < (1, 4): - {.push raises: [Defect].} -else: - {.push raises: [].} -import stew/base10 - -type - SrcLoc* = object - procedure*: cstring - file*: cstring - line*: int - -proc `$`*(loc: ptr SrcLoc): string = - var res = $loc.file - res.add("(") - res.add(Base10.toString(uint64(loc.line))) - res.add(")") - res.add(" ") - if len(loc.procedure) == 0: - res.add("[unspecified]") - else: - res.add($loc.procedure) - res - -proc srcLocImpl(procedure: static string, - file: static string, line: static int): ptr SrcLoc = - var loc {.global.} = SrcLoc( - file: cstring(file), line: line, procedure: procedure - ) - return addr(loc) - -template getSrcLocation*(procedure: static string = ""): ptr SrcLoc = - srcLocImpl(procedure, - instantiationInfo(-2).filename, instantiationInfo(-2).line)