jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added cmpMem export (#16484)

Browse source 
* added cmpMem export

* updates

* fix test

* Tiny changelog change

* Add a dot.

Co-authored-by: Clyybber <darkmine956@gmail.com>
This commit is contained in:
Antonis Geralis 2020-12-29 14:27:08 +02:00 • committed by GitHub
commit d5a3c2c2da
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 81 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

2
changelog.md
View file

@ -36,6 +36,8 @@
- `nodejs` backend now supports osenv: `getEnv`, `putEnv`, `envPairs`, `delEnv`, `existsEnv`.
- Added `cmpMem` to `system`.
- `doAssertRaises` now correctly handles foreign exceptions.
- Added `asyncdispatch.activeDescriptors` that returns the number of currently

2
lib/system.nim
View file

@ -2182,6 +2182,8 @@ when notJSnotNims:
memTrackerOp("moveMem", dest, size)
proc equalMem(a, b: pointer, size: Natural): bool =
nimCmpMem(a, b, size) == 0
proc cmpMem(a, b: pointer, size: Natural): int =
nimCmpMem(a, b, size)
when not defined(js):
proc cmp(x, y: string): int =

95
lib/system/memalloc.nim
View file

@ -1,38 +1,51 @@
when notJSnotNims:
proc zeroMem*(p: pointer, size: Natural) {.inline, noSideEffect,
tags: [], locks: 0, raises: [].}
## Overwrites the contents of the memory at ``p`` with the value 0.
## Overwrites the contents of the memory at `p` with the value 0.
##
## Exactly ``size`` bytes will be overwritten. Like any procedure
## Exactly `size` bytes will be overwritten. Like any procedure
## dealing with raw memory this is **unsafe**.
proc copyMem*(dest, source: pointer, size: Natural) {.inline, benign,
tags: [], locks: 0, raises: [].}
## Copies the contents from the memory at ``source`` to the memory
## at ``dest``.
## Exactly ``size`` bytes will be copied. The memory
## Copies the contents from the memory at `source` to the memory
## at `dest`.
## Exactly `size` bytes will be copied. The memory
## regions may not overlap. Like any procedure dealing with raw
## memory this is **unsafe**.
proc moveMem*(dest, source: pointer, size: Natural) {.inline, benign,
tags: [], locks: 0, raises: [].}
## Copies the contents from the memory at ``source`` to the memory
## at ``dest``.
## Copies the contents from the memory at `source` to the memory
## at `dest`.
##
## Exactly ``size`` bytes will be copied. The memory
## regions may overlap, ``moveMem`` handles this case appropriately
## and is thus somewhat more safe than ``copyMem``. Like any procedure
## Exactly `size` bytes will be copied. The memory
## regions may overlap, `moveMem` handles this case appropriately
## and is thus somewhat more safe than `copyMem`. Like any procedure
## dealing with raw memory this is still **unsafe**, though.
proc equalMem*(a, b: pointer, size: Natural): bool {.inline, noSideEffect,
tags: [], locks: 0, raises: [].}
## Compares the memory blocks ``a`` and ``b``. ``size`` bytes will
## Compares the memory blocks `a` and `b`. `size` bytes will
## be compared.
##
## If the blocks are equal, `true` is returned, `false`
## otherwise. Like any procedure dealing with raw memory this is
## **unsafe**.
proc cmpMem*(a, b: pointer, size: Natural): int {.inline, noSideEffect,
tags: [], locks: 0, raises: [].}
## Compares the memory blocks `a` and `b`. `size` bytes will
## be compared.
##
## Returns:
## * a value less than zero, if `a < b`
## * a value greater than zero, if `a > b`
## * zero, if `a == b`
##
## Like any procedure dealing with raw memory this is
## **unsafe**.
when hasAlloc and not defined(js):
proc allocImpl*(size: Natural): pointer {.noconv, rtl, tags: [], benign, raises: [].}
@ -75,7 +88,7 @@ when hasAlloc and not defined(js):
proc getAllocStats*(): AllocStats = discard
template alloc*(size: Natural): pointer =
## Allocates a new memory block with at least ``size`` bytes.
## Allocates a new memory block with at least `size` bytes.
##
## The block has to be freed with `realloc(block, 0) <#realloc.t,pointer,Natural>`_
## or `dealloc(block) <#dealloc,pointer>`_.
@ -91,7 +104,7 @@ when hasAlloc and not defined(js):
allocImpl(size)
proc createU*(T: typedesc, size = 1.Positive): ptr T {.inline, benign, raises: [].} =
## Allocates a new memory block with at least ``T.sizeof * size`` bytes.
## Allocates a new memory block with at least `T.sizeof * size` bytes.
##
## The block has to be freed with `resize(block, 0) <#resize,ptr.T,Natural>`_
## or `dealloc(block) <#dealloc,pointer>`_.
@ -106,7 +119,7 @@ when hasAlloc and not defined(js):
cast[ptr T](alloc(T.sizeof * size))
template alloc0*(size: Natural): pointer =
## Allocates a new memory block with at least ``size`` bytes.
## Allocates a new memory block with at least `size` bytes.
##
## The block has to be freed with `realloc(block, 0) <#realloc.t,pointer,Natural>`_
## or `dealloc(block) <#dealloc,pointer>`_.
@ -119,7 +132,7 @@ when hasAlloc and not defined(js):
alloc0Impl(size)
proc create*(T: typedesc, size = 1.Positive): ptr T {.inline, benign, raises: [].} =
## Allocates a new memory block with at least ``T.sizeof * size`` bytes.
## Allocates a new memory block with at least `T.sizeof * size` bytes.
##
## The block has to be freed with `resize(block, 0) <#resize,ptr.T,Natural>`_
## or `dealloc(block) <#dealloc,pointer>`_.
@ -134,8 +147,8 @@ when hasAlloc and not defined(js):
## Grows or shrinks a given memory block.
##
## If `p` is **nil** then a new memory block is returned.
## In either way the block has at least ``newSize`` bytes.
## If ``newSize == 0`` and `p` is not **nil** ``realloc`` calls ``dealloc(p)``.
## In either way the block has at least `newSize` bytes.
## If `newSize == 0` and `p` is not **nil** `realloc` calls `dealloc(p)`.
## In other cases the block has to be freed with
## `dealloc(block) <#dealloc,pointer>`_.
##
@ -148,8 +161,8 @@ when hasAlloc and not defined(js):
## Grows or shrinks a given memory block.
##
## If `p` is **nil** then a new memory block is returned.
## In either way the block has at least ``newSize`` bytes.
## If ``newSize == 0`` and `p` is not **nil** ``realloc`` calls ``dealloc(p)``.
## In either way the block has at least `newSize` bytes.
## If `newSize == 0` and `p` is not **nil** `realloc` calls `dealloc(p)`.
## In other cases the block has to be freed with
## `dealloc(block) <#dealloc,pointer>`_.
##
@ -165,9 +178,9 @@ when hasAlloc and not defined(js):
## Grows or shrinks a given memory block.
##
## If `p` is **nil** then a new memory block is returned.
## In either way the block has at least ``T.sizeof * newSize`` bytes.
## If ``newSize == 0`` and `p` is not **nil** ``resize`` calls ``dealloc(p)``.
## In other cases the block has to be freed with ``free``.
## In either way the block has at least `T.sizeof * newSize` bytes.
## If `newSize == 0` and `p` is not **nil** `resize` calls `dealloc(p)`.
## In other cases the block has to be freed with `free`.
##
## The allocated memory belongs to its allocating thread!
## Use `resizeShared <#resizeShared,ptr.T,Natural>`_ to reallocate
@ -175,8 +188,8 @@ when hasAlloc and not defined(js):
cast[ptr T](realloc(p, T.sizeof * newSize))
proc dealloc*(p: pointer) {.noconv, compilerproc, rtl, benign, raises: [], tags: [].} =
## Frees the memory allocated with ``alloc``, ``alloc0`` or
## ``realloc``.
## Frees the memory allocated with `alloc`, `alloc0` or
## `realloc`.
##
## **This procedure is dangerous!**
## If one forgets to free the memory a leak occurs; if one tries to
@ -190,7 +203,7 @@ when hasAlloc and not defined(js):
template allocShared*(size: Natural): pointer =
## Allocates a new memory block on the shared heap with at
## least ``size`` bytes.
## least `size` bytes.
##
## The block has to be freed with
## `reallocShared(block, 0) <#reallocShared.t,pointer,Natural>`_
@ -207,7 +220,7 @@ when hasAlloc and not defined(js):
proc createSharedU*(T: typedesc, size = 1.Positive): ptr T {.inline, tags: [],
benign, raises: [].} =
## Allocates a new memory block on the shared heap with at
## least ``T.sizeof * size`` bytes.
## least `T.sizeof * size` bytes.
##
## The block has to be freed with
## `resizeShared(block, 0) <#resizeShared,ptr.T,Natural>`_ or
@ -222,7 +235,7 @@ when hasAlloc and not defined(js):
template allocShared0*(size: Natural): pointer =
## Allocates a new memory block on the shared heap with at
## least ``size`` bytes.
## least `size` bytes.
##
## The block has to be freed with
## `reallocShared(block, 0) <#reallocShared.t,pointer,Natural>`_
@ -236,7 +249,7 @@ when hasAlloc and not defined(js):
proc createShared*(T: typedesc, size = 1.Positive): ptr T {.inline.} =
## Allocates a new memory block on the shared heap with at
## least ``T.sizeof * size`` bytes.
## least `T.sizeof * size` bytes.
##
## The block has to be freed with
## `resizeShared(block, 0) <#resizeShared,ptr.T,Natural>`_ or
@ -251,9 +264,9 @@ when hasAlloc and not defined(js):
## Grows or shrinks a given memory block on the heap.
##
## If `p` is **nil** then a new memory block is returned.
## In either way the block has at least ``newSize`` bytes.
## If ``newSize == 0`` and `p` is not **nil** ``reallocShared`` calls
## ``deallocShared(p)``.
## In either way the block has at least `newSize` bytes.
## If `newSize == 0` and `p` is not **nil** `reallocShared` calls
## `deallocShared(p)`.
## In other cases the block has to be freed with
## `deallocShared <#deallocShared,pointer>`_.
reallocSharedImpl(p, newSize)
@ -265,9 +278,9 @@ when hasAlloc and not defined(js):
## containing zero, so it is somewhat safer then reallocShared
##
## If `p` is **nil** then a new memory block is returned.
## In either way the block has at least ``newSize`` bytes.
## If ``newSize == 0`` and `p` is not **nil** ``reallocShared`` calls
## ``deallocShared(p)``.
## In either way the block has at least `newSize` bytes.
## If `newSize == 0` and `p` is not **nil** `reallocShared` calls
## `deallocShared(p)`.
## In other cases the block has to be freed with
## `deallocShared <#deallocShared,pointer>`_.
reallocShared0Impl(p, oldSize, newSize)
@ -276,16 +289,16 @@ when hasAlloc and not defined(js):
## Grows or shrinks a given memory block on the heap.
##
## If `p` is **nil** then a new memory block is returned.
## In either way the block has at least ``T.sizeof * newSize`` bytes.
## If ``newSize == 0`` and `p` is not **nil** ``resizeShared`` calls
## ``freeShared(p)``.
## In either way the block has at least `T.sizeof * newSize` bytes.
## If `newSize == 0` and `p` is not **nil** `resizeShared` calls
## `freeShared(p)`.
## In other cases the block has to be freed with
## `freeShared <#freeShared,ptr.T>`_.
cast[ptr T](reallocShared(p, T.sizeof * newSize))
proc deallocShared*(p: pointer) {.noconv, compilerproc, rtl, benign, raises: [], tags: [].} =
## Frees the memory allocated with ``allocShared``, ``allocShared0`` or
## ``reallocShared``.
## Frees the memory allocated with `allocShared`, `allocShared0` or
## `reallocShared`.
##
## **This procedure is dangerous!**
## If one forgets to free the memory a leak occurs; if one tries to
@ -295,8 +308,8 @@ when hasAlloc and not defined(js):
deallocSharedImpl(p)
proc freeShared*[T](p: ptr T) {.inline, benign, raises: [].} =
## Frees the memory allocated with ``createShared``, ``createSharedU`` or
## ``resizeShared``.
## Frees the memory allocated with `createShared`, `createSharedU` or
## `resizeShared`.
##
## **This procedure is dangerous!**
## If one forgets to free the memory a leak occurs; if one tries to

15
tests/stdlib/tmemory.nim Normal file
View file

@ -0,0 +1,15 @@
block: # cmpMem
type
SomeHash = array[15, byte]
var
a: SomeHash
b: SomeHash
a[^1] = byte(1)
let c = a
doAssert cmpMem(a.addr, b.addr, sizeof(SomeHash)) > 0
doAssert cmpMem(b.addr, a.addr, sizeof(SomeHash)) < 0
doAssert cmpMem(a.addr, c.unsafeAddr, sizeof(SomeHash)) == 0