annotate lib/vma-iter.h @ 16366:bb182ee4a09d

maint: replace FSF snail-mail addresses with URLs * config/argz.mk, lib/accept4.c, lib/alignof.h, lib/alloca.in.h: * lib/alphasort.c, lib/arcfour.c, lib/arcfour.h, lib/arctwo.c: * lib/arctwo.h, lib/argz.c, lib/arpa_inet.in.h, lib/asnprintf.c: * lib/asprintf.c, lib/assert.in.h, lib/base32.c, lib/base32.h: * lib/base64.c, lib/base64.h, lib/c-ctype.c, lib/c-ctype.h: * lib/c-strcase.h, lib/c-strcasecmp.c, lib/c-strncasecmp.c: * lib/check-version.c, lib/check-version.h, lib/config.charset: * lib/ctype.in.h, lib/des.c, lib/des.h, lib/dup3.c, lib/errno.in.h: * lib/float+.h, lib/fnmatch.c, lib/fnmatch.in.h, lib/fnmatch_loop.c: * lib/fseeko.c, lib/gai_strerror.c, lib/gc-gnulib.c: * lib/gc-libgcrypt.c, lib/gc-pbkdf2-sha1.c, lib/gc.h: * lib/getaddrinfo.c, lib/getdelim.c, lib/getfilecon.c, lib/getline.c: * lib/getlogin_r.c, lib/getpass.c, lib/getpass.h, lib/gettext.h: * lib/gettimeofday.c, lib/glob.in.h, lib/glthread/cond.c: * lib/glthread/cond.h, lib/glthread/lock.c, lib/glthread/lock.h: * lib/glthread/thread.c, lib/glthread/thread.h: * lib/glthread/threadlib.c, lib/glthread/yield.h, lib/hmac-md5.c: * lib/hmac-sha1.c, lib/hmac.h, lib/iconv.c, lib/iconv.in.h: * lib/iconv_close.c, lib/iconv_open.c, lib/inet_ntop.c, lib/isfinite.c: * lib/isinf.c, lib/iswblank.c, lib/langinfo.in.h, lib/link.c: * lib/localcharset.c, lib/localcharset.h, lib/lseek.c, lib/malloc.c: * lib/malloca.c, lib/malloca.h, lib/md2.c, lib/md2.h, lib/md4.c: * lib/md4.h, lib/md5.c, lib/md5.h, lib/memmem.c, lib/mempcpy.c: * lib/memset.c, lib/memxor.c, lib/memxor.h, lib/minmax.h, lib/mktime.c: * lib/msvc-inval.c, lib/msvc-inval.h, lib/msvc-nothrow.c: * lib/msvc-nothrow.h, lib/netdb.in.h, lib/netinet_in.in.h, lib/nproc.c: * lib/nproc.h, lib/obstack_printf.c, lib/pathmax.h, lib/pipe.c: * lib/pipe2.c, lib/poll.c, lib/poll.in.h, lib/printf-args.c: * lib/printf-args.h, lib/printf-parse.c, lib/printf-parse.h: * lib/pselect.c, lib/pthread.in.h, lib/pty-private.h, lib/pty.in.h: * lib/read-file.c, lib/read-file.h, lib/ref-add.sin, lib/ref-del.sin: * lib/regcomp.c, lib/regex.c, lib/regex.h, lib/regex_internal.c: * lib/regex_internal.h, lib/regexec.c, lib/rijndael-alg-fst.c: * lib/rijndael-alg-fst.h, lib/rijndael-api-fst.c: * lib/rijndael-api-fst.h, lib/rint.c, lib/rintf.c, lib/rintl.c: * lib/round.c, lib/roundf.c, lib/roundl.c, lib/scandir.c, lib/select.c: * lib/sha1.c, lib/sha1.h, lib/size_max.h, lib/snprintf.c: * lib/stdalign.in.h, lib/stdarg.in.h, lib/stdbool.in.h: * lib/stddef.in.h, lib/stdint.in.h, lib/stdio.in.h, lib/str-kmp.h: * lib/str-two-way.h, lib/strcasecmp.c, lib/strcasestr.c, lib/strdup.c: * lib/striconv.c, lib/striconv.h, lib/string.in.h, lib/strings.in.h: * lib/strncasecmp.c, lib/strndup.c, lib/strnlen.c, lib/strpbrk.c: * lib/strptime.c, lib/strsep.c, lib/strstr.c, lib/strverscmp.c: * lib/sys_file.in.h, lib/sys_ioctl.in.h, lib/sys_select.in.h: * lib/sys_socket.in.h, lib/sys_stat.in.h, lib/sys_time.in.h: * lib/sys_times.in.h, lib/sys_types.in.h, lib/sys_uio.in.h: * lib/sys_utsname.in.h, lib/sys_wait.in.h, lib/tcgetsid.c: * lib/termios.in.h, lib/time.in.h, lib/time_r.c, lib/timegm.c: * lib/times.c, lib/unictype/3level.h, lib/unictype/3levelbit.h: * lib/unistd.in.h, lib/vasnprintf.c, lib/vasnprintf.h, lib/vasprintf.c: * lib/vsnprintf.c, lib/waitpid.c, lib/wchar.in.h, lib/wctype.in.h: * lib/xsize.h, tests/test-closein.c, tests/test-des.c: * tests/test-fclose.c, tests/test-fgetc.c, tests/test-filevercmp.c: * tests/test-fputc.c, tests/test-fread.c, tests/test-fwrite.c: * tests/test-gc-arcfour.c, tests/test-gc-arctwo.c, tests/test-gc-des.c: * tests/test-gc-hmac-md5.c, tests/test-gc-hmac-sha1.c: * tests/test-gc-md2.c, tests/test-gc-md4.c, tests/test-gc-md5.c: * tests/test-gc-pbkdf2-sha1.c, tests/test-gc-rijndael.c: * tests/test-gc-sha1.c, tests/test-gc.c, tests/test-getdelim.c: * tests/test-getline.c, tests/test-getndelim2.c, tests/test-md2.c: * tests/test-md4.c, tests/test-parse-datetime.c, tests/test-perror.c: * tests/test-perror2.c, tests/test-pipe.c, tests/test-pipe2.c: * tests/test-poll.c, tests/test-quotearg-simple.c: * tests/test-quotearg.c, tests/test-quotearg.h: * tests/test-round-ieee.c, tests/test-round1.c: * tests/test-roundf-ieee.c, tests/test-roundf1.c: * tests/test-roundl-ieee.c, tests/test-roundl.c: * tests/test-safe-alloc.c, tests/test-sigpipe.c: * tests/test-spawn-pipe-child.c, tests/test-spawn-pipe-main.c: * tests/test-strerror.c, tests/test-strerror_r.c: * tests/test-strsignal.c, tests/test-strverscmp.c: * tests/test-xmemdup0.c: Replace FSF snail mail addresses with URLs, as per GNU coding standards. See glibc bug <http://sourceware.org/bugzilla/show_bug.cgi?id=13673>.
author Paul Eggert <eggert@cs.ucla.edu>
date Thu, 09 Feb 2012 21:39:05 -0800 (2012-02-10)
parents 8250f2777afc
children e542fd46ad6f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14220
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
1 /* Iteration over virtual memory areas.
16201
8250f2777afc maint: update all copyright year number ranges
Jim Meyering <meyering@redhat.com>
parents: 14235
diff changeset
2 Copyright (C) 2011-2012 Free Software Foundation, Inc.
14220
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
3 Written by Bruno Haible <bruno@clisp.org>, 2011.
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
4
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
5 This program is free software: you can redistribute it and/or modify
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
8 (at your option) any later version.
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
9
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
13 GNU General Public License for more details.
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
14
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
17
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
18 #ifndef _VMA_ITER_H
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
19 #define _VMA_ITER_H
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
20
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
21 #include <stdint.h>
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
22
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
23 #ifdef __cplusplus
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
24 extern "C" {
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
25 #endif
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
27
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
28 /* Bit mask for the FLAGS parameter of a vma_iterate callback function. */
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29 #define VMA_PROT_READ (1<<0)
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30 #define VMA_PROT_WRITE (1<<1)
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
31 #define VMA_PROT_EXECUTE (1<<2)
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33 typedef int (*vma_iterate_callback_fn) (void *data,
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 uintptr_t start, uintptr_t end,
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35 unsigned int flags);
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
37 /* Iterate over the virtual memory areas of the current process.
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
38 If such iteration is supported, the callback is called once for every
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
39 virtual memory area, in ascending order, with the following arguments:
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
40 - DATA is the same argument as passed to vma_iterate.
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
41 - START is the address of the first byte in the area, page-aligned.
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
42 - END is the address of the last byte in the area plus 1, page-aligned.
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
43 Note that it may be 0 for the last area in the address space.
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
44 - FLAGS is a combination of the VMA_* bits.
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
45 If the callback returns 0, the iteration continues. If it returns 1,
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
46 the iteration terminates prematurely.
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
47 This function may open file descriptors, but does not call malloc(). */
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
48 extern void vma_iterate (vma_iterate_callback_fn callback, void *data);
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
49
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
50 /* The macro VMA_ITERATE_SUPPORTED indicates that vma_iterate is supported on
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
51 this platform.
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
52 Note that even when this macro is defined, vma_iterate() may still fail to
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
53 find any virtual memory area, for example if /proc is not mounted. */
14235
6b8b94f919ce vma-iter, get-rusage-as: Add OpenBSD support.
Bruno Haible <bruno@clisp.org>
parents: 14226
diff changeset
54 #if defined __linux__ || defined __FreeBSD__ || defined __NetBSD__ || defined __sgi || defined __osf__ || (defined __APPLE__ && defined __MACH__) || (defined _WIN32 || defined __WIN32__) || defined __CYGWIN__ || defined __BEOS__ || defined __HAIKU__ || HAVE_MQUERY
14220
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
55 # define VMA_ITERATE_SUPPORTED 1
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
56 #endif
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
57
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
58
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
59 #ifdef __cplusplus
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
60 }
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
61 #endif
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
62
996391c07734 New module 'vma-iter'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
63 #endif /* _VMA_ITER_H */