getgrent_r(3)

NAME#

getgrent_r, fgetgrent_r - get group file entry reentrantly

LIBRARY#

Standard C library (libc, -lc)

SYNOPSIS#

#include <grp.h>

int getgrent_r(struct group *restrict \ngbuf\n,\n
\n               char \nbuf\n[restrict .\nbuflen\n], size_t \nbuflen\n,\n
\n               struct group **restrict \ngbufp\n);\n
\nint fgetgrent_r(FILE *restrict \nstream\n, struct group *restrict \ngbuf\n,\n
\n               char \nbuf\n[restrict .\nbuflen\n], size_t \nbuflen\n,\n
\n               struct group **restrict \ngbufp\n);

getgrent_r():

\n
    _GNU_SOURCE

fgetgrent_r():

\n
    Since glibc 2.19:
\n
        _DEFAULT_SOURCE
\n
    glibc 2.19 and earlier:
\n
        _SVID_SOURCE

DESCRIPTION#

The functions getgrent_r() and fgetgrent_r() are the reentrant versions of getgrent(3) and fgetgrent(3). The former reads the next group entry from the stream initialized by setgrent(3). The latter reads the next group entry from stream.

The group structure is defined in <grp.h> as follows:

struct group {
\n
    char   *gr_name;        /* group name */
\n
    char   *gr_passwd;      /* group password */
\n
    gid_t   gr_gid;         /* group ID */
\n
    char  **gr_mem;         /* NULL-terminated array of pointers
\n
                               to names of group members */
};

For more information about the fields of this structure, see group(5).

The nonreentrant functions return a pointer to static storage, where this static storage contains further pointers to group name, password, and members. The reentrant functions described here return all of that in caller-provided buffers. First of all there is the buffer gbuf that can hold a struct group. And next the buffer buf of size buflen that can hold additional strings. The result of these functions, the struct group read from the stream, is stored in the provided buffer *gbuf, and a pointer to this struct group is returned in *gbufp.

RETURN VALUE#

On success, these functions return 0 and *gbufp is a pointer to the struct group. On error, these functions return an error value and *gbufp is NULL.

ERRORS#

ENOENT

No more entries.

ERANGE

Insufficient buffer space supplied. Try again with larger buffer.

ATTRIBUTES#

For an explanation of the terms used in this section, see attributes(7).

In the above table, grent in race:grent signifies that if any of the functions setgrent(3), getgrent(3), endgrent(3), or getgrent_r() are used in parallel in different threads of a program, then data races could occur.

VERSIONS#

Other systems use the prototype

struct group *getgrent_r(struct group *grp, char *buf,
\n
                         int buflen);

or, better,

int getgrent_r(struct group *grp, char *buf, int buflen,
\n
               FILE **gr_fp);

STANDARDS#

GNU.

HISTORY#

These functions are done in a style resembling the POSIX version of functions like getpwnam_r(3).

NOTES#

The function getgrent_r() is not really reentrant since it shares the reading position in the stream with all other threads.

EXAMPLES#

#define _GNU_SOURCE
#include <grp.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#define BUFLEN 4096
int
main(void)
{
\n
    struct group grp;
\n
    struct group *grpp;
\n
    char buf[BUFLEN];
\n
    int i;
\n
    setgrent();
\n
    while (1) {
\n
        i = getgrent_r(&grp, buf, sizeof(buf), &grpp);
\n
        if (i)
\n
            break;
\n
        printf("%s (%jd):", grpp->gr_name, (intmax_t) grpp->gr_gid);
\n
        for (size_t j = 0; ; j++) {
\n
            if (grpp->gr_mem[j] == NULL)
\n
                break;
\n
            printf(" %s", grpp->gr_mem[j]);
\n
        }
\n
        printf("\n");
\n
    }
\n
    endgrent();
\n
    exit(EXIT_SUCCESS);
}

SEE ALSO#

fgetgrent(3), getgrent(3), getgrgid(3), getgrnam(3), putgrent(3), group(5)