summaryrefslogtreecommitdiffstats
path: root/posix-users/process_environment.rst
blob: 0556d12f6c0f8910b46fad1f3f23c828a0a71d77 (plain) (blame)
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
.. comment SPDX-License-Identifier: CC-BY-SA-4.0

.. COMMENT: COPYRIGHT (c) 1988-2002.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.

Process Environment Manager
###########################

Introduction
============

The process environment manager is responsible for providing the functions
related to user and group Id management.

The directives provided by the process environment manager are:

- getpid_ - Get Process ID

- getppid_ - Get Parent Process ID

- getuid_ - Get User ID

- geteuid_ - Get Effective User ID

- getgid_ - Get Real Group ID

- getegid_ - Get Effective Group ID

- setuid_ - Set User ID

- setgid_ - Set Group ID

- getgroups_ - Get Supplementary Group IDs

- getlogin_ - Get User Name

- getlogin_r_ - Reentrant Get User Name

- getpgrp_ - Get Process Group ID

- setsid_ - Create Session and Set Process Group ID

- setpgid_ - Set Process Group ID for Job Control

- uname_ - Get System Name

- times_ - Get Process Times

- getenv_ - Get Environment Variables

- setenv_ - Set Environment Variables

- ctermid_ - Generate Terminal Pathname

- ttyname_ - Determine Terminal Device Name

- ttyname_r_ - Reentrant Determine Terminal Device Name

- isatty_ - Determine if File Descriptor is Terminal

- sysconf_ - Get Configurable System Variables

Background
==========

Users and Groups
----------------

RTEMS provides a single process, multi-threaded execution environment.  In this
light, the notion of user and group is somewhat without meaning.  But RTEMS
does provide services to provide a synthetic version of user and group.  By
default, a single user and group is associated with the application.  Thus
unless special actions are taken, every thread in the application shares the
same user and group Id.  The initial rationale for providing user and group Id
functionality in RTEMS was for the filesystem infrastructure to implement file
permission checks.  The effective user/group Id capability has since been used
to implement permissions checking by the ``ftpd`` server.

In addition to the "real" user and group Ids, a process may have an effective
user/group Id.  This allows a process to function using a more limited
permission set for certain operations.

User and Group Names
--------------------

POSIX considers user and group Ids to be a unique integer that may be
associated with a name.  This is usually accomplished via a file named
:file:`/etc/passwd` for user Id mapping and :file:`/etc/groups` for group Id
mapping.  Again, although RTEMS is effectively a single process and thus single
user system, it provides limited support for user and group names.  When
configured with an appropriate filesystem, RTEMS will access the appropriate
files to map user and group Ids to names.

If these files do not exist, then RTEMS will synthesize a minimal version so
this family of services return without error.  It is important to remember that
a design goal of the RTEMS POSIX services is to provide useable and meaningful
results even though a full process model is not available.

Environment Variables
---------------------

POSIX allows for variables in the run-time environment.  These are name/value
pairs that make be dynamically set and obtained by programs.  In a full POSIX
environment with command line shell and multiple processes, environment
variables may be set in one process - such as the shell - and inherited by
child processes.  In RTEMS, there is only one process and thus only one set of
environment variables across all processes.

Operations
==========

Accessing User and Group Ids
----------------------------

The user Id associated with the current thread may be obtain using the
``getuid()`` service.  Similarly, the group Id may be obtained using the
``getgid()`` service.

Accessing Environment Variables
-------------------------------

The value associated with an environment variable may be obtained using the
``getenv()`` service and set using the ``putenv()`` service.

Directives
==========

This section details the process environment manager's directives.  A
subsection is dedicated to each of this manager's directives and describes the
calling sequence, related constants, usage, and status codes.

.. _getpid:

getpid - Get Process ID
-----------------------
.. index:: getpid
.. index:: get process id

**CALLING SEQUENCE:**

.. code-block:: c

    int getpid( void );

**STATUS CODES:**

The process Id is returned.

**DESCRIPTION:**

This service returns the process Id.

**NOTES:**

NONE

.. _getppid:

getppid - Get Parent Process ID
-------------------------------
.. index:: getppid
.. index:: get parent process id

**CALLING SEQUENCE:**

.. code-block:: c

    int getppid( void );

**STATUS CODES:**

The parent process Id is returned.

**DESCRIPTION:**

This service returns the parent process Id.

**NOTES:**

NONE

.. _getuid:

getuid - Get User ID
--------------------
.. index:: getuid
.. index:: get user id

**CALLING SEQUENCE:**

.. code-block:: c

    int getuid( void );

**STATUS CODES:**

The effective user Id is returned.

**DESCRIPTION:**

This service returns the effective user Id.

**NOTES:**

NONE

.. _geteuid:

geteuid - Get Effective User ID
-------------------------------
.. index:: geteuid
.. index:: get effective user id

**CALLING SEQUENCE:**

.. code-block:: c

    int geteuid( void );

**STATUS CODES:**

The effective group Id is returned.

**DESCRIPTION:**

This service returns the effective group Id.

**NOTES:**

NONE

.. _getgid:

getgid - Get Real Group ID
--------------------------
.. index:: getgid
.. index:: get real group id

**CALLING SEQUENCE:**

.. code-block:: c

    int getgid( void );

**STATUS CODES:**

The group Id is returned.

**DESCRIPTION:**

This service returns the group Id.

**NOTES:**

NONE

.. _getegid:

getegid - Get Effective Group ID
--------------------------------
.. index:: getegid
.. index:: get effective group id

**CALLING SEQUENCE:**

.. code-block:: c

    int getegid( void );

**STATUS CODES:**

The effective group Id is returned.

**DESCRIPTION:**

This service returns the effective group Id.

**NOTES:**

NONE

.. _setuid:

setuid - Set User ID
--------------------
.. index:: setuid
.. index:: set user id

**CALLING SEQUENCE:**

.. code-block:: c

    int setuid(
        uid_t uid
    );

**STATUS CODES:**

This service returns 0.

**DESCRIPTION:**

This service sets the user Id to ``uid``.

**NOTES:**

NONE

.. _setgid:

setgid - Set Group ID
---------------------
.. index:: setgid
.. index:: set group id

**CALLING SEQUENCE:**

.. code-block:: c

    int setgid(
        gid_t  gid
    );

**STATUS CODES:**

This service returns 0.

**DESCRIPTION:**

This service sets the group Id to ``gid``.

**NOTES:**

NONE

.. _getgroups:

getgroups - Get Supplementary Group IDs
---------------------------------------
.. index:: getgroups
.. index:: get supplementary group ids

**CALLING SEQUENCE:**

.. code-block:: c

    int getgroups(
        int    gidsetsize,
        gid_t  grouplist[]
    );

**STATUS CODES:**

NA

**DESCRIPTION:**

This service is not implemented as RTEMS has no notion of supplemental groups.

**NOTES:**

If supported, this routine would only be allowed for the super-user.

.. _getlogin:

getlogin - Get User Name
------------------------
.. index:: getlogin
.. index:: get user name

**CALLING SEQUENCE:**

.. code-block:: c

    char *getlogin( void );

**STATUS CODES:**

Returns a pointer to a string containing the name of the current user.

**DESCRIPTION:**

This routine returns the name of the current user.

**NOTES:**

This routine is not reentrant and subsequent calls to ``getlogin()`` will
overwrite the same buffer.

.. _getlogin_r:

getlogin_r - Reentrant Get User Name
------------------------------------
.. index:: getlogin_r
.. index:: reentrant get user name
.. index:: get user name, reentrant

**CALLING SEQUENCE:**

.. code-block:: c

    int getlogin_r(
        char   *name,
        size_t  namesize
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The arguments were invalid.

**DESCRIPTION:**

This is a reentrant version of the ``getlogin()`` service.  The caller
specified their own buffer, ``name``, as well as the length of this buffer,
``namesize``.

**NOTES:**

NONE

.. _getpgrp:

getpgrp - Get Process Group ID
------------------------------
.. index:: getpgrp
.. index:: get process group id

**CALLING SEQUENCE:**

.. code-block:: c

    pid_t getpgrp( void );

**STATUS CODES:**

The procress group Id is returned.

**DESCRIPTION:**

This service returns the current progress group Id.

**NOTES:**

This routine is implemented in a somewhat meaningful way for RTEMS but is truly
not functional.

.. _setsid:

setsid - Create Session and Set Process Group ID
------------------------------------------------
.. index:: setsid
.. index:: create session and set process group id

**CALLING SEQUENCE:**

.. code-block:: c

    pid_t setsid( void );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EPERM``
   - The application does not have permission to create a process group.

**DESCRIPTION:**

This routine always returns ``EPERM`` as RTEMS has no way to create new
processes and thus no way to create a new process group.

**NOTES:**

NONE

.. _setpgid:

setpgid - Set Process Group ID for Job Control
----------------------------------------------
.. index:: setpgid
.. index:: set process group id for job control

**CALLING SEQUENCE:**

.. code-block:: c

    int setpgid(
        pid_t pid,
        pid_t pgid
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``ENOSYS``
   - The routine is not implemented.

**DESCRIPTION:**

This service is not implemented for RTEMS as process groups are not supported.

**NOTES:**

NONE

.. _uname:

uname - Get System Name
-----------------------
.. index:: uname
.. index:: get system name

**CALLING SEQUENCE:**

.. code-block:: c

    int uname(
        struct utsname *name
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EPERM``
   - The provided structure pointer is invalid.

**DESCRIPTION:**

This service returns system information to the caller.  It does this by filling
in the ``struct utsname`` format structure for the caller.

**NOTES:**

The information provided includes the operating system (RTEMS in all
configurations), the node number, the release as the RTEMS version, and the CPU
family and model.  The CPU model name will indicate the multilib executive
variant being used.

.. _times:

times - Get process times
-------------------------
.. index:: times
.. index:: get process times

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/time.h>
    clock_t times(
        struct tms *ptms
    );

**STATUS CODES:**

This routine returns the number of clock ticks that have elapsed since the
system was initialized (e.g. the application was started).

**DESCRIPTION:**

``times`` stores the current process times in ``ptms``.  The format of ``struct
tms`` is as defined in ``<sys/times.h>``.  RTEMS fills in the field
``tms_utime`` with the number of ticks that the calling thread has executed and
the field ``tms_stime`` with the number of clock ticks since system boot (also
returned).  All other fields in the ``ptms`` are left zero.

**NOTES:**

RTEMS has no way to distinguish between user and system time so this routine
returns the most meaningful information possible.

.. _getenv:

getenv - Get Environment Variables
----------------------------------
.. index:: getenv
.. index:: get environment variables

**CALLING SEQUENCE:**

.. code-block:: c

    char *getenv(
        const char *name
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``NULL``
   - when no match
 * - `pointer to value`
   - when successful

**DESCRIPTION:**

This service searches the set of environment variables for a string that
matches the specified ``name``.  If found, it returns the associated value.

**NOTES:**

The environment list consists of name value pairs that are of the form ``name =
value``.

.. _setenv:

setenv - Set Environment Variables
----------------------------------
.. index:: setenv
.. index:: set environment variables

**CALLING SEQUENCE:**

.. code-block:: c

    int setenv(
        const char *name,
        const char *value,
        int overwrite
    );

**STATUS CODES:**

Returns 0 if successful and -1 otherwise.

**DESCRIPTION:**

This service adds the variable ``name`` to the environment with ``value``.  If
``name`` is not already exist, then it is created.  If ``name`` exists and
``overwrite`` is zero, then the previous value is not overwritten.

**NOTES:**

NONE

.. _ctermid:

ctermid - Generate Terminal Pathname
------------------------------------
.. index:: ctermid
.. index:: generate terminal pathname

**CALLING SEQUENCE:**

.. code-block:: c

    char *ctermid(
        char *s
    );

**STATUS CODES:**

Returns a pointer to a string indicating the pathname for the controlling
terminal.

**DESCRIPTION:**

This service returns the name of the terminal device associated with this
process.  If ``s`` is NULL, then a pointer to a static buffer is returned.
Otherwise, ``s`` is assumed to have a buffer of sufficient size to contain the
name of the controlling terminal.

**NOTES:**

By default on RTEMS systems, the controlling terminal is :file:`/dev/console`.
Again this implementation is of limited meaning, but it provides true and
useful results which should be sufficient to ease porting applications from a
full POSIX implementation to the reduced profile supported by RTEMS.

.. _ttyname:

ttyname - Determine Terminal Device Name
----------------------------------------
.. index:: ttyname
.. index:: determine terminal device name

**CALLING SEQUENCE:**

.. code-block:: c

    char *ttyname(
        int fd
    );

**STATUS CODES:**

Pointer to a string containing the terminal device name or ``NULL`` is returned
on any error.

**DESCRIPTION:**

This service returns a pointer to the pathname of the terminal device that is
open on the file descriptor ``fd``.  If ``fd`` is not a valid descriptor for a
terminal device, then NULL is returned.

**NOTES:**

This routine uses a static buffer.

.. _ttyname_r:

ttyname_r - Reentrant Determine Terminal Device Name
----------------------------------------------------
.. index:: ttyname_r
.. index:: reentrant determine terminal device name

**CALLING SEQUENCE:**

.. code-block:: c

    int ttyname_r(
        int   fd,
        char *name,
        int   namesize
    );

**STATUS CODES:**

This routine returns -1 and sets ``errno`` as follows:

.. list-table::
 :class: rtems-table

 * - ``EBADF``
   - If not a valid descriptor for a terminal device.
 * - ``EINVAL``
   - If ``name`` is ``NULL`` or ``namesize`` are insufficient.

**DESCRIPTION:**

This service the pathname of the terminal device that is open on the file
descriptor ``fd``.

**NOTES:**

NONE

.. _isatty:

isatty - Determine if File Descriptor is Terminal
-------------------------------------------------
.. index:: isatty
.. index:: determine if file descriptor is terminal

**CALLING SEQUENCE:**

.. code-block:: c

    int isatty(
        int fd
    );

**STATUS CODES:**

Returns 1 if ``fd`` is a terminal device and 0 otherwise.

**DESCRIPTION:**

This service returns 1 if ``fd`` is an open file descriptor connected to a
terminal and 0 otherwise.

**NOTES:**

.. _sysconf:

sysconf - Get Configurable System Variables
-------------------------------------------
.. index:: sysconf
.. index:: get configurable system variables

**CALLING SEQUENCE:**

.. code-block:: c

    long sysconf(
        int name
    );

**STATUS CODES:**

The value returned is the actual value of the system resource.  If the
requested configuration name is a feature flag, then 1 is returned if the
available and 0 if it is not.  On any other error condition, -1 is returned.

**DESCRIPTION:**

This service is the mechanism by which an application determines values for
system limits or options at runtime.

**NOTES:**

Much of the information that may be obtained via ``sysconf`` has equivalent
macros in ``unistd.h``.  However, those macros reflect conservative limits
which may have been altered by application configuration.