2 * kmp_environment.h -- Handle environment varoiables OS-independently.
5 //===----------------------------------------------------------------------===//
7 // The LLVM Compiler Infrastructure
9 // This file is dual licensed under the MIT and the University of Illinois Open
10 // Source Licenses. See LICENSE.txt for details.
12 //===----------------------------------------------------------------------===//
14 #ifndef KMP_ENVIRONMENT_H
15 #define KMP_ENVIRONMENT_H
21 // Return a copy of the value of environment variable or NULL if the variable
23 // *Note*: Returned pointed *must* be freed after use with __kmp_env_free().
24 char *__kmp_env_get(char const *name);
25 void __kmp_env_free(char const **value);
27 // Return 1 if the environment variable exists or 0 if does not exist.
28 int __kmp_env_exists(char const *name);
30 // Set the environment variable.
31 void __kmp_env_set(char const *name, char const *value, int overwrite);
33 // Unset (remove) environment variable.
34 void __kmp_env_unset(char const *name);
36 // -----------------------------------------------------------------------------
37 // Working with environment blocks.
39 /* kmp_env_blk_t is read-only collection of environment variables (or
40 environment-like). Usage:
43 __kmp_env_blk_init( & block, NULL ); // Initialize block from process
46 __kmp_env_blk_init( & block, "KMP_WARNING=1|KMP_AFFINITY=none" ); // from string
47 __kmp_env_blk_sort( & block ); // Optionally, sort list.
48 for ( i = 0; i < block.count; ++ i ) {
49 // Process block.vars[ i ].name and block.vars[ i ].value...
51 __kmp_env_block_free( & block );
54 struct __kmp_env_var {
58 typedef struct __kmp_env_var kmp_env_var_t;
60 struct __kmp_env_blk {
65 typedef struct __kmp_env_blk kmp_env_blk_t;
67 void __kmp_env_blk_init(kmp_env_blk_t *block, char const *bulk);
68 void __kmp_env_blk_free(kmp_env_blk_t *block);
69 void __kmp_env_blk_sort(kmp_env_blk_t *block);
70 char const *__kmp_env_blk_var(kmp_env_blk_t *block, char const *name);
76 #endif // KMP_ENVIRONMENT_H