forked from JuliaLang/julia
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs and deprecations for Libc/Libdl
- Loading branch information
1 parent
f281b4f
commit 074286c
Showing
14 changed files
with
198 additions
and
163 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1132,6 +1132,7 @@ export | |
mark, | ||
mmap_array, | ||
mmap_bitarray, | ||
msync, | ||
nb_available, | ||
ntoh, | ||
open, | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,4 +25,6 @@ | |
collections | ||
test | ||
c | ||
libc | ||
libdl | ||
profile |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
.. module:: Libc | ||
|
||
******************** | ||
C Standard Library | ||
******************** | ||
|
||
.. function:: malloc(size::Integer) -> Ptr{Void} | ||
|
||
Call ``malloc`` from the C standard library. | ||
|
||
.. function:: calloc(num::Integer, size::Integer) -> Ptr{Void} | ||
|
||
Call ``calloc`` from the C standard library. | ||
|
||
.. function:: realloc(addr::Ptr, size::Integer) -> Ptr{Void} | ||
|
||
Call ``realloc`` from the C standard library. | ||
|
||
See warning in the documentation for ``free`` regarding only using this on memory originally obtained from ``malloc``. | ||
|
||
.. function:: free(addr::Ptr) | ||
|
||
Call ``free`` from the C standard library. Only use this on memory obtained from ``malloc``, | ||
not on pointers retrieved from other C libraries. | ||
``Ptr`` objects obtained from C libraries should be freed by the free functions defined in that library, | ||
to avoid assertion failures if multiple ``libc`` libraries exist on the system. | ||
|
||
.. function:: errno([code]) | ||
|
||
Get the value of the C library's ``errno``. If an argument is specified, it is | ||
used to set the value of ``errno``. | ||
|
||
The value of ``errno`` is only valid immediately after a ``ccall`` to a C | ||
library routine that sets it. Specifically, you cannot call ``errno`` at the next | ||
prompt in a REPL, because lots of code is executed between prompts. | ||
|
||
.. function:: strerror(n) | ||
|
||
Convert a system call error code to a descriptive string | ||
|
||
.. function:: time(t::TmStruct) | ||
|
||
Converts a ``TmStruct`` struct to a number of seconds since the epoch. | ||
|
||
.. function:: strftime([format], time) | ||
|
||
Convert time, given as a number of seconds since the epoch or a ``TmStruct``, to a formatted string using the given format. Supported formats are the same as those in the standard C library. | ||
|
||
.. function:: strptime([format], timestr) | ||
|
||
Parse a formatted time string into a ``TmStruct`` giving the seconds, minute, hour, date, etc. Supported formats are the same as those in the standard C library. On some platforms, timezones will not be parsed correctly. If the result of this function will be passed to ``time`` to convert it to seconds since the epoch, the ``isdst`` field should be filled in manually. Setting it to ``-1`` will tell the C library to use the current system settings to determine the timezone. | ||
|
||
.. function:: TmStruct([seconds]) | ||
|
||
Convert a number of seconds since the epoch to broken-down format, with fields ``sec``, ``min``, ``hour``, ``mday``, ``month``, ``year``, ``wday``, ``yday``, and ``isdst``. | ||
|
||
.. function:: flush_cstdio() | ||
|
||
Flushes the C ``stdout`` and ``stderr`` streams (which may have been | ||
written to by external C code). | ||
|
||
.. function:: msync(ptr, len, [flags]) | ||
|
||
Forces synchronization of the :func:`mmap`\ ped memory region from ``ptr`` to ``ptr+len``. Flags defaults to ``MS_SYNC``, but can be a combination of ``MS_ASYNC``, ``MS_SYNC``, or ``MS_INVALIDATE``. See your platform man page for specifics. The flags argument is not valid on Windows. | ||
|
||
You may not need to call ``msync``, because synchronization is performed at intervals automatically by the operating system. However, you can call this directly if, for example, you are concerned about losing the result of a long-running calculation. | ||
|
||
.. data:: MS_ASYNC | ||
|
||
Enum constant for :func:`msync`. See your platform man page for details. (not available on Windows). | ||
|
||
.. data:: MS_SYNC | ||
|
||
Enum constant for :func:`msync`. See your platform man page for details. (not available on Windows). | ||
|
||
.. data:: MS_INVALIDATE | ||
|
||
Enum constant for :func:`msync`. See your platform man page for details. (not available on Windows). | ||
|
||
.. function:: mmap(len, prot, flags, fd, offset) | ||
|
||
Low-level interface to the ``mmap`` system call. See the man page. | ||
|
||
.. function:: munmap(pointer, len) | ||
|
||
Low-level interface for unmapping memory (see the man page). With :func:`mmap_array` you do not need to call this directly; the memory is unmapped for you when the array goes out of scope. |
Oops, something went wrong.