1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup LibIOEnv
* @brief User Environment Support
*/
/*
* 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 & Co. KG
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#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
/**
* @defgroup LibIOEnv User Environment
*
* @ingroup LibIO
*
* @brief Provides a POSIX like user environment for tasks.
*/
/**@{**/
#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;
/**
* @brief User environment.
*/
struct rtems_user_env_t {
/**
* @brief The anchor directory for relative paths.
*/
rtems_filesystem_global_location_t *current_directory;
/**
* @brief The anchor directory for absolute paths.
*/
rtems_filesystem_global_location_t *root_directory;
/**
* @brief The file mode creation mask.
*/
mode_t umask;
/**
* @brief The real user ID.
*/
uid_t uid;
/**
* @brief The real group ID.
*/
gid_t gid;
/**
* @brief The effective user ID.
*/
uid_t euid;
/**
* @brief The effective group ID.
*/
gid_t egid;
/**
* @brief The login buffer.
*/
char login_buffer[LOGIN_NAME_MAX];
/**
* @brief The process group ID.
*/
pid_t pgrp;
/**
* @brief The count of supplementary group IDs.
*/
size_t ngroups;
/**
* @brief The list of supplementary group IDs.
*/
gid_t groups[NGROUPS];
};
extern rtems_user_env_t rtems_global_user_env;
/**
* @brief Fetch the pointer to the current user environment.
*
* If the task has a private user environment the pointer to it will be
* returned. Otherwise the pointer to rtems_global_user_env will be returned.
*/
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)
/**
* @brief Creates a private environment.
*
* If the task has already a private environment nothing will be changed. This
* function must be called from normal thread context and may block on a mutex.
* Thread dispatching is disabled to protect some critical sections.
*
* The private environment internally uses a POSIX key. The key is added to the
* configuration implicitly. But for each thread that uses a private environment
* a key value pair has to be configured by the application. If only the global
* environment is used there is no need to configure a key value pair.
*
* @retval RTEMS_SUCCESSFUL Successful operation.
* @retval RTEMS_NO_MEMORY Not enough memory.
* @retval RTEMS_UNSATISFIED Cloning of the current environment failed.
* @retval RTEMS_TOO_MANY Cannot register the private environment.
*/
rtems_status_code rtems_libio_set_private_env(void);
/**
* @brief Use the global environment.
*
* A private environment will be released. This function may be called from
* every thread context. Thread dispatching is disabled to protect the
* critical sections.
*/
void rtems_libio_use_global_env(void);
/**
* @brief Gets the supplementary group IDs using the current user ID and
* updates the table of supplementary group IDs in the current user
* environment.
*
* In case of an error, the count of supplementary group IDs is set to zero.
*/
void rtems_current_user_env_getgroups(void);
/** @} */
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
