]> git.ipfire.org Git - thirdparty/glibc.git/blobdiff - grp/initgroups.c
Use glibc_likely instead __builtin_expect.
[thirdparty/glibc.git] / grp / initgroups.c
index 2150fa968c590318e81d27e6030f4f17fa02a215..bdde097b0f58fa3f5b2af4fdc0c14ee1cb9ff562 100644 (file)
-/* Copyright (C) 1989, 91, 93, 96, 97, 98 Free Software Foundation, Inc.
+/* Copyright (C) 1989, 1991-2014 Free Software Foundation, Inc.
    This file is part of the GNU C Library.
 
    The GNU C Library is free software; you can redistribute it and/or
-   modify it under the terms of the GNU Library General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
 
    The GNU C Library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   Library General Public License for more details.
+   Lesser General Public License for more details.
 
-   You should have received a copy of the GNU Library General Public
-   License along with the GNU C Library; see the file COPYING.LIB.  If not,
-   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, see
+   <http://www.gnu.org/licenses/>.  */
 
 #include <alloca.h>
+#include <assert.h>
 #include <errno.h>
 #include <grp.h>
 #include <limits.h>
+#include <stdlib.h>
 #include <string.h>
 #include <unistd.h>
+#include <sys/param.h>
 #include <sys/types.h>
 #include <nsswitch.h>
 
+#include "../nscd/nscd-client.h"
+#include "../nscd/nscd_proto.h"
 
-/* Type of the lookup function.  */
-typedef enum nss_status (*initgroups_function) (const char *, gid_t,
-                                               long int *, long int *,
-                                               gid_t *, long int, int *);
-/* Prototype for the setgrent functions we use here.  */
-typedef enum nss_status (*set_function) (void);
-
-/* Prototype for the endgrent functions we use here.  */
-typedef enum nss_status (*end_function) (void);
 
-/* Prototype for the setgrent functions we use here.  */
-typedef enum nss_status (*get_function) (struct group *, char *,
-                                        size_t, int *);
+/* Type of the lookup function.  */
+typedef enum nss_status (*initgroups_dyn_function) (const char *, gid_t,
+                                                   long int *, long int *,
+                                                   gid_t **, long int, int *);
 
 /* The lookup function for the first entry of this service.  */
 extern int __nss_group_lookup (service_user **nip, const char *name,
                                   void **fctp);
 extern void *__nss_lookup_function (service_user *ni, const char *fct_name);
 
-extern service_user *__nss_group_database;
+extern service_user *__nss_group_database attribute_hidden;
+service_user *__nss_initgroups_database;
+static bool use_initgroups_entry;
+
 
-static enum nss_status
-compat_call (service_user *nip, const char *user, gid_t group, long int *start,
-            long int *size, gid_t *groups, long int limit, int *errnop)
+#include "compat-initgroups.c"
+
+
+static int
+internal_getgrouplist (const char *user, gid_t group, long int *size,
+                      gid_t **groupsp, long int limit)
 {
-  struct group grpbuf, *g;
-  size_t buflen = sysconf (_SC_GETPW_R_SIZE_MAX);
-  char *tmpbuf;
-  enum nss_status status;
-  set_function setgrent_fct;
-  get_function getgrent_fct;
-  end_function endgrent_fct;
+#ifdef USE_NSCD
+  if (__nss_not_use_nscd_group > 0
+      && ++__nss_not_use_nscd_group > NSS_NSCD_RETRY)
+    __nss_not_use_nscd_group = 0;
+  if (!__nss_not_use_nscd_group
+      && !__nss_database_custom[NSS_DBSIDX_group])
+    {
+      int n = __nscd_getgrouplist (user, group, size, groupsp, limit);
+      if (n >= 0)
+       return n;
 
-  setgrent_fct = __nss_lookup_function (nip, "setgrent");
-  status = (*setgrent_fct) ();
-  if (status != NSS_STATUS_SUCCESS)
-    return status;
+      /* nscd is not usable.  */
+      __nss_not_use_nscd_group = 1;
+    }
+#endif
 
-  getgrent_fct = __nss_lookup_function (nip, "getgrent_r");
-  endgrent_fct = __nss_lookup_function (nip, "endgrent");
+  enum nss_status status = NSS_STATUS_UNAVAIL;
+  int no_more = 0;
 
-  tmpbuf = __alloca (buflen);
+  /* Never store more than the starting *SIZE number of elements.  */
+  assert (*size > 0);
+  (*groupsp)[0] = group;
+  /* Start is one, because we have the first group as parameter.  */
+  long int start = 1;
 
-  do
+  if (__nss_initgroups_database == NULL)
+    {
+      if (__nss_database_lookup ("initgroups", NULL, "",
+                                &__nss_initgroups_database) < 0)
+       {
+         if (__nss_group_database == NULL)
+           no_more = __nss_database_lookup ("group", NULL, "compat files",
+                                            &__nss_group_database);
+
+         __nss_initgroups_database = __nss_group_database;
+       }
+      else
+       use_initgroups_entry = true;
+    }
+  else
+    /* __nss_initgroups_database might have been set through
+       __nss_configure_lookup in which case use_initgroups_entry was
+       not set here.  */
+    use_initgroups_entry = __nss_initgroups_database != __nss_group_database;
+
+  service_user *nip = __nss_initgroups_database;
+  while (! no_more)
     {
-      while ((status =
-             (*getgrent_fct) (&grpbuf, tmpbuf, buflen, errnop)) ==
-            NSS_STATUS_TRYAGAIN && *errnop == ERANGE)
-        {
-          buflen *= 2;
-          tmpbuf = __alloca (buflen);
-        }
-
-      if (status != NSS_STATUS_SUCCESS)
-        goto done;
-
-      g = &grpbuf;
-      if (g->gr_gid != group)
-        {
-          char **m;
-
-          for (m = g->gr_mem; *m != NULL; ++m)
-            if (strcmp (*m, user) == 0)
-              {
-                /* Matches user.  Insert this group.  */
-                if (*start == *size && limit <= 0)
-                  {
-                    /* Need a bigger buffer.  */
-                    groups = realloc (groups, *size * sizeof (*groups));
-                    if (groups == NULL)
-                      goto done;
-                    *size *= 2;
-                  }
-
-                groups[*start] = g->gr_gid;
-                *start += 1;
-
-                if (*start == limit)
-                  /* Can't take any more groups; stop searching.  */
-                  goto done;
-
-                break;
-              }
-        }
+      long int prev_start = start;
+
+      initgroups_dyn_function fct = __nss_lookup_function (nip,
+                                                          "initgroups_dyn");
+      if (fct == NULL)
+       status = compat_call (nip, user, group, &start, size, groupsp,
+                             limit, &errno);
+      else
+       status = DL_CALL_FCT (fct, (user, group, &start, size, groupsp,
+                                   limit, &errno));
+
+      /* Remove duplicates.  */
+      long int cnt = prev_start;
+      while (cnt < start)
+       {
+         long int inner;
+         for (inner = 0; inner < prev_start; ++inner)
+           if ((*groupsp)[inner] == (*groupsp)[cnt])
+             break;
+
+         if (inner < prev_start)
+           (*groupsp)[cnt] = (*groupsp)[--start];
+         else
+           ++cnt;
+       }
+
+      /* This is really only for debugging.  */
+      if (NSS_STATUS_TRYAGAIN > status || status > NSS_STATUS_RETURN)
+       __libc_fatal ("illegal status in internal_getgrouplist");
+
+      /* For compatibility reason we will continue to look for more
+        entries using the next service even though data has already
+        been found if the nsswitch.conf file contained only a 'groups'
+        line and no 'initgroups' line.  If the latter is available
+        we always respect the status.  This means that the default
+        for successful lookups is to return.  */
+      if ((use_initgroups_entry || status != NSS_STATUS_SUCCESS)
+         && nss_next_action (nip, status) == NSS_ACTION_RETURN)
+        break;
+
+      if (nip->next == NULL)
+       no_more = -1;
+      else
+       nip = nip->next;
     }
-  while (status == NSS_STATUS_SUCCESS);
 
- done:
-  (*endgrent_fct) ();
+  return start;
+}
+
+/* Store at most *NGROUPS members of the group set for USER into
+   *GROUPS.  Also include GROUP.  The actual number of groups found is
+   returned in *NGROUPS.  Return -1 if the if *NGROUPS is too small.  */
+int
+getgrouplist (const char *user, gid_t group, gid_t *groups, int *ngroups)
+{
+  long int size = MAX (1, *ngroups);
+
+  gid_t *newgroups = (gid_t *) malloc (size * sizeof (gid_t));
+  if (__glibc_unlikely (newgroups == NULL))
+    /* No more memory.  */
+    // XXX This is wrong.  The user provided memory, we have to use
+    // XXX it.  The internal functions must be called with the user
+    // XXX provided buffer and not try to increase the size if it is
+    // XXX too small.  For initgroups a flag could say: increase size.
+    return -1;
+
+  int total = internal_getgrouplist (user, group, &size, &newgroups, -1);
 
-  return NSS_STATUS_SUCCESS;
+  memcpy (groups, newgroups, MIN (*ngroups, total) * sizeof (gid_t));
+
+  free (newgroups);
+
+  int retval = total > *ngroups ? -1 : total;
+  *ngroups = total;
+
+  return retval;
 }
 
+nss_interface_function (getgrouplist)
+
 /* Initialize the group set for the current user
    by reading the group database and using all groups
    of which USER is a member.  Also include GROUP.  */
 int
-initgroups (user, group)
-     const char *user;
-     gid_t group;
+initgroups (const char *user, gid_t group)
 {
 #if defined NGROUPS_MAX && NGROUPS_MAX == 0
 
@@ -134,58 +194,39 @@ initgroups (user, group)
 
 #else
 
-  service_user *nip = NULL;
-  initgroups_function fct;
-  enum nss_status status = NSS_STATUS_UNAVAIL;
-  int no_more;
-  /* Start is one, because we have the first group as parameter.  */
-  long int start = 1;
   long int size;
   gid_t *groups;
-#ifdef NGROUPS_MAX
-# define limit NGROUPS_MAX
+  int ngroups;
+  int result;
 
-  size = limit;
-#else
-  long int limit = sysconf (_SC_NGROUPS_MAX);
+ /* We always use sysconf even if NGROUPS_MAX is defined.  That way, the
+     limit can be raised in the kernel configuration without having to
+     recompile libc.  */
+  long int limit = __sysconf (_SC_NGROUPS_MAX);
 
   if (limit > 0)
-    size = limit;
+    /* We limit the size of the intially allocated array.  */
+    size = MIN (limit, 64);
   else
     /* No fixed limit on groups.  Pick a starting buffer size.  */
     size = 16;
-#endif
-
-  groups = malloc (size * sizeof (gid_t *));
-
-  groups[0] = group;
 
-  if (__nss_group_database != NULL)
-    {
-      no_more = 0;
-      nip = __nss_group_database;
-    }
-  else
-    no_more = __nss_database_lookup ("group", NULL,
-                                    "compat [NOTFOUND=return] files", &nip);
+  groups = (gid_t *) malloc (size * sizeof (gid_t));
+  if (__glibc_unlikely (groups == NULL))
+    /* No more memory.  */
+    return -1;
 
-  while (! no_more)
-    {
-      fct = __nss_lookup_function (nip, "initgroups");
+  ngroups = internal_getgrouplist (user, group, &size, &groups, limit);
 
-      if (fct == NULL)
-       status = compat_call (nip, user, group, &start, &size, groups,
-                             limit, &errno);
-      else
-       status = (*fct) (user, group, &start, &size, groups, limit,
-                        &errno);
+  /* Try to set the maximum number of groups the kernel can handle.  */
+  do
+    result = setgroups (ngroups, groups);
+  while (result == -1 && errno == EINVAL && --ngroups > 0);
 
-      if (nip->next == NULL)
-       no_more = -1;
-      else
-       nip = nip->next;
-    }
+  free (groups);
 
-  return setgroups (start, groups);
+  return result;
 #endif
 }
+
+nss_interface_function (initgroups)