userenv.h

Go to the documentation of this file.

/*
 *  COPYRIGHT (c) 1989-2011.
 *  On-Line Applications Research Corporation (OAR).
 *
 *  Modifications to support reference counting in the file system are
 *  Copyright (c) 2012 embedded brains GmbH.
 *
 *  The license and distribution terms for this file may be
 *  found in the file LICENSE in this distribution or at
 *  http://www.rtems.org/license/LICENSE.
 */

#ifndef _RTEMS_USERENV_H
#define _RTEMS_USERENV_H

/*
 * According to IEEE Std 1003.1-2001,
 * limits.h is supposed to provide _POSIX_LOGIN_NAME_MAX
 * XXX: We do not rely on this.
 */
#include <sys/param.h>
#include <limits.h>

#include <rtems.h>
#include <rtems/fs.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifndef LOGIN_NAME_MAX
  #ifdef _POSIX_LOGIN_NAME_MAX
    #define LOGIN_NAME_MAX _POSIX_LOGIN_NAME_MAX
  #else
    /* Fallback */
    #define LOGIN_NAME_MAX 9
  #endif
#endif

typedef struct rtems_user_env_t rtems_user_env_t;

struct rtems_user_env_t {
  rtems_filesystem_global_location_t *current_directory;

  rtems_filesystem_global_location_t *root_directory;

  mode_t umask;

  uid_t uid;

  gid_t gid;

  uid_t euid;

  gid_t egid;

  char login_buffer[LOGIN_NAME_MAX];

  pid_t pgrp;

  size_t ngroups;

  gid_t groups[NGROUPS];
};

extern rtems_user_env_t rtems_global_user_env;

rtems_user_env_t * rtems_current_user_env_get(void);

#define rtems_current_user_env rtems_current_user_env_get()

#define rtems_filesystem_current     (rtems_current_user_env->current_directory)
#define rtems_filesystem_root        (rtems_current_user_env->root_directory)
#define rtems_filesystem_umask       (rtems_current_user_env->umask)

#define _POSIX_types_Uid             (rtems_current_user_env->uid)
#define _POSIX_types_Gid             (rtems_current_user_env->gid)
#define _POSIX_types_Euid            (rtems_current_user_env->euid)
#define _POSIX_types_Egid            (rtems_current_user_env->egid)
#define _POSIX_types_Getlogin_buffer (rtems_current_user_env->login_buffer)

rtems_status_code rtems_libio_set_private_env(void);

void rtems_libio_use_global_env(void);

void rtems_current_user_env_getgroups(void);

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */