include/shm-directory.h

   1 /* Header for directory for shm/sem files.
   2    Copyright (C) 2014-2024 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, see
  17    <https://www.gnu.org/licenses/>.  */
  18
  19 #ifndef _SHM_DIRECTORY_H
  20
  21 #include <limits.h>
  22 #include <paths.h>
  23 #include <stdbool.h>
  24
  25 /* The directory that contains shared POSIX objects.  */
  26 #define SHMDIR _PATH_DEV "shm/"
  27
  28 struct shmdir_name
  29 {
  30   /* The combined prefix/name.  The sizeof includes the terminating
  31      NUL byte.  4 bytes are needed for the optional "sem." prefix.  */
  32   char name[sizeof (SHMDIR) + 4 + NAME_MAX];
  33 };
  34
  35 /* Sets RESULT->name to the constructed name and returns 0 on success,
  36    or -1 on failure.  Includes the "sem." prefix in the name if
  37    SEM_PREFIX is true.  */
  38 int __shm_get_name (struct shmdir_name *result, const char *name,
  39                     bool sem_prefix);
  40 libc_hidden_proto (__shm_get_name)
  41
  42 #endif  /* shm-directory.h */