From 8f5bd0f85282e044da867bf12c38144b5131e915 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sat, 20 Oct 2018 20:48:13 +0200 Subject: Add memelem and memrelem MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- man/libsimple_memelem.3 | 82 ++++++++++++++++++++++++++++++++++++++++++++++++ man/libsimple_memmem.3 | 1 + man/libsimple_memrelem.3 | 82 ++++++++++++++++++++++++++++++++++++++++++++++++ man/libsimple_memrmem.3 | 1 + 4 files changed, 166 insertions(+) create mode 100644 man/libsimple_memelem.3 create mode 100644 man/libsimple_memrelem.3 (limited to 'man') diff --git a/man/libsimple_memelem.3 b/man/libsimple_memelem.3 new file mode 100644 index 0000000..be182c3 --- /dev/null +++ b/man/libsimple_memelem.3 @@ -0,0 +1,82 @@ +.TH LIBSIMPLE_MEMELEM 3 2018-10-20 libsimple +.SH NAME +libsimple_memelem \- find byte string in memory +.SH SYNOPSIS +.nf +#include + +void *libsimple_memelem(const void *haystack, size_t nhaystack, const void *needle, size_t nneedle); + +#ifndef memelem +# define memelem libsimple_memelem +#endif +.fi + +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_memelem () +function scans the memory segment +.IR haystack , +with the size +.IR nhaystack*nneedle , +for the first occurence of the byte string +.I needle +with the size +.IR nneedle , +and with an offset equivalent to zero modulo +.IR nneedle . +.SH RETURN VALUE +The +.BR libsimple_memelem () +function returns the pointer +.I s +with a minimal offset such that +.IR !memcmp(r,needle,nneedle) , +where +.I r +is the returned pointer, and such that +the offset is equivalent to zero modulo +.IR nneedle . +If no such offset exists, +.B NULL +is returned. +.SH ERRORS +The +.BR libsimple_memelem () +function cannot fail. +.SH ATTRIBUTES +For an explanation of the terms used in this section, see +.BR attributes (7). +.TS +allbox; +lb lb lb +l l l. +Interface Attribute Value +T{ +.BR libsimple_memelem () +T} Thread safety MT-Safe +T{ +.BR libsimple_memelem () +T} Async-signal safety AS-Safe +T{ +.BR libsimple_memelem () +T} Async-cancel safety AC-Safe +.TE +.SH EXAMPLES +None. +.SH APPLICATION USAGE +None. +.SH RATIONALE +None. +.SH FUTURE DIRECTIONS +None. +.SH NOTES +None. +.SH BUGS +None. +.SH SEE ALSO +.BR libsimple_memrelem (3), +.BR libsimple_memmem (3), +.BR memchr (3) diff --git a/man/libsimple_memmem.3 b/man/libsimple_memmem.3 index f084de9..6701b46 100644 --- a/man/libsimple_memmem.3 +++ b/man/libsimple_memmem.3 @@ -74,4 +74,5 @@ None. None. .SH SEE ALSO .BR libsimple_memrmem (3), +.BR libsimple_memelem (3), .BR memchr (3) diff --git a/man/libsimple_memrelem.3 b/man/libsimple_memrelem.3 new file mode 100644 index 0000000..77f5293 --- /dev/null +++ b/man/libsimple_memrelem.3 @@ -0,0 +1,82 @@ +.TH LIBSIMPLE_MEMRELEM 3 2018-10-20 libsimple +.SH NAME +libsimple_memrelem \- find byte string in memory +.SH SYNOPSIS +.nf +#include + +void *libsimple_memrelem(const void *haystack, size_t nhaystack, const void *needle, size_t nneedle); + +#ifndef memrelem +# define memrelem libsimple_memrelem +#endif +.fi + +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_memrelem () +function scans the memory segment +.IR haystack , +with the size +.IR nhaystack*nneedle , +for the last occurence of the byte string +.I needle +with the size +.IR nneedle , +and with an offset equivalent to zero modulo +.IR nneedle . +.SH RETURN VALUE +The +.BR libsimple_memrelem () +function returns the pointer +.I s +with a maximal offset such that +.IR !memcmp(r,needle,nneedle) , +where +.I r +is the returned pointer, and such that +the offset is equivalent to zero modulo +.IR nneedle . +If no such offset exists, +.B NULL +is returned. +.SH ERRORS +The +.BR libsimple_memrelem () +function cannot fail. +.SH ATTRIBUTES +For an explanation of the terms used in this section, see +.BR attributes (7). +.TS +allbox; +lb lb lb +l l l. +Interface Attribute Value +T{ +.BR libsimple_memrelem () +T} Thread safety MT-Safe +T{ +.BR libsimple_memrelem () +T} Async-signal safety AS-Safe +T{ +.BR libsimple_memrelem () +T} Async-cancel safety AC-Safe +.TE +.SH EXAMPLES +None. +.SH APPLICATION USAGE +None. +.SH RATIONALE +None. +.SH FUTURE DIRECTIONS +None. +.SH NOTES +None. +.SH BUGS +None. +.SH SEE ALSO +.BR libsimple_memelem (3), +.BR libsimple_memrmem (3), +.BR libsimple_memrchr (3) diff --git a/man/libsimple_memrmem.3 b/man/libsimple_memrmem.3 index 71bf251..c9daf17 100644 --- a/man/libsimple_memrmem.3 +++ b/man/libsimple_memrmem.3 @@ -74,4 +74,5 @@ None. None. .SH SEE ALSO .BR libsimple_memmem (3), +.BR libsimple_memrelem (3), .BR libsimple_memrchr (3) -- cgit v1.2.3-70-g09d2