2 * internal.h: Useful definitions
4 * Copyright (C) 2007-2015 David Lutterkort
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Author: David Lutterkort <dlutter@redhat.com>
42 * Various parameters about env vars, special tree nodes etc.
45 /* Define: AUGEAS_LENS_DIR
46 * The default location for lens definitions */
47 #define AUGEAS_LENS_DIR DATADIR "/augeas/lenses"
49 /* The directory where we install lenses distribute with Augeas */
50 #define AUGEAS_LENS_DIST_DIR DATADIR "/augeas/lenses/dist"
52 /* Define: AUGEAS_ROOT_ENV
53 * The env var that points to the chroot holding files we may modify.
54 * Mostly useful for testing */
55 #define AUGEAS_ROOT_ENV "AUGEAS_ROOT"
57 /* Define: AUGEAS_FILES_TREE
58 * The root for actual file contents */
59 #define AUGEAS_FILES_TREE "/files"
61 /* Define: AUGEAS_META_TREE
62 * Augeas reports some information in this subtree */
63 #define AUGEAS_META_TREE "/augeas"
65 /* Define: AUGEAS_META_FILES
66 * Information about files */
67 #define AUGEAS_META_FILES AUGEAS_META_TREE AUGEAS_FILES_TREE
69 /* Define: AUGEAS_META_TEXT
70 * Information about text (see aug_text_store and aug_text_retrieve) */
71 #define AUGEAS_META_TEXT AUGEAS_META_TREE "/text"
73 /* Define: AUGEAS_META_ROOT
74 * The root directory */
75 #define AUGEAS_META_ROOT AUGEAS_META_TREE "/root"
77 /* Define: AUGEAS_META_SAVE_MODE
78 * How we save files. One of 'backup', 'overwrite' or 'newfile' */
79 #define AUGEAS_META_SAVE_MODE AUGEAS_META_TREE "/save"
81 /* Define: AUGEAS_CLONE_IF_RENAME_FAILS
82 * Control what save does when renaming the temporary file to its final
83 * destination fails with EXDEV or EBUSY: when this tree node exists, copy
84 * the file contents. If it is not present, simply give up and report an
86 #define AUGEAS_COPY_IF_RENAME_FAILS \
87 AUGEAS_META_SAVE_MODE "/copy_if_rename_fails"
89 /* Define: AUGEAS_CONTEXT
90 * Context prepended to all non-absolute paths */
91 #define AUGEAS_CONTEXT AUGEAS_META_TREE "/context"
93 /* A hierarchy where we record certain 'events', e.g. which tree
94 * nodes actually gotsaved into files */
95 #define AUGEAS_EVENTS AUGEAS_META_TREE "/events"
97 #define AUGEAS_EVENTS_SAVED AUGEAS_EVENTS "/saved"
99 /* Where to put information about parsing of path expressions */
100 #define AUGEAS_META_PATHX AUGEAS_META_TREE "/pathx"
102 /* Define: AUGEAS_SPAN_OPTION
103 * Enable or disable node indexes */
104 #define AUGEAS_SPAN_OPTION AUGEAS_META_TREE "/span"
106 /* Define: AUGEAS_LENS_ENV
107 * Name of env var that contains list of paths to search for additional
109 #define AUGEAS_LENS_ENV "AUGEAS_LENS_LIB"
111 /* Define: MAX_ENV_SIZE
112 * Fairly arbitrary bound on the length of the path we
113 * accept from AUGEAS_SPEC_ENV */
114 #define MAX_ENV_SIZE 4096
116 /* Define: PATH_SEP_CHAR
117 * Character separating paths in a list of paths */
118 #define PATH_SEP_CHAR ':'
120 /* Constants for setting the save mode via the augeas path at
121 * AUGEAS_META_SAVE_MODE */
122 #define AUG_SAVE_BACKUP_TEXT "backup"
123 #define AUG_SAVE_NEWFILE_TEXT "newfile"
124 #define AUG_SAVE_NOOP_TEXT "noop"
125 #define AUG_SAVE_OVERWRITE_TEXT "overwrite"
127 /* constants for options in the tree */
128 #define AUG_ENABLE "enable"
129 #define AUG_DISABLE "disable"
131 /* default value for the relative path context */
132 #define AUG_CONTEXT_DEFAULT "/files"
136 #ifndef __GNUC_PREREQ
137 #define __GNUC_PREREQ(maj,min) 0
143 * Macro to flag conciously unused parameters to functions
145 #ifndef ATTRIBUTE_UNUSED
146 #define ATTRIBUTE_UNUSED __attribute__((__unused__))
152 * Macro used to check printf/scanf-like functions, if compiling
155 #ifndef ATTRIBUTE_FORMAT
156 #define ATTRIBUTE_FORMAT(args...) __attribute__((__format__ (args)))
159 #ifndef ATTRIBUTE_PURE
160 #define ATTRIBUTE_PURE __attribute__((pure))
163 #ifndef ATTRIBUTE_RETURN_CHECK
164 #if __GNUC_PREREQ (3, 4)
165 #define ATTRIBUTE_RETURN_CHECK __attribute__((__warn_unused_result__))
167 #define ATTRIBUTE_RETURN_CHECK
172 #define ATTRIBUTE_UNUSED
173 #define ATTRIBUTE_FORMAT(...)
174 #define ATTRIBUTE_PURE
175 #define ATTRIBUTE_RETURN_CHECK
176 #endif /* __GNUC__ */
178 #define ARRAY_CARDINALITY(array) (sizeof (array) / sizeof *(array))
180 /* String equality tests, suggested by Jim Meyering. */
181 #define STREQ(a,b) (strcmp((a),(b)) == 0)
182 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
183 #define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
184 #define STRNEQ(a,b) (strcmp((a),(b)) != 0)
185 #define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
186 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
187 #define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
190 static inline int streqv(const char *a, const char *b) {
191 if (a == NULL || b == NULL)
196 /* Path length and comparison */
200 /* Length of PATH without any trailing '/' */
202 static inline int pathlen(const char *path) {
203 int len = strlen(path);
205 if (len > 0 && path[len-1] == SEP)
211 /* Return 1 if P1 is a prefix of P2. P1 as a string must have length <= P2 */
213 static inline int pathprefix(const char *p1, const char *p2) {
214 if (p1 == NULL || p2 == NULL)
216 int l1 = pathlen(p1);
218 return STREQLEN(p1, p2, l1) && (p2[l1] == '\0' || p2[l1] == SEP);
221 static inline int pathendswith(const char *path, const char *basenam) {
222 const char *p = strrchr(path, SEP);
225 return streqv(p+1, basenam);
228 /* Join NSEG path components (passed as const char *) into one PATH.
229 Allocate as needed. Return 0 on success, -1 on failure */
230 int pathjoin(char **path, int nseg, ...);
232 /* Call calloc to allocate an array of N instances of *VAR */
233 #define CALLOC(Var,N) do { (Var) = calloc ((N), sizeof (*(Var))); } while (0)
235 #define MEMZERO(ptr, n) memset((ptr), 0, (n) * sizeof(*(ptr)));
237 #define MEMCPY(dest, src, n) memcpy((dest), (src), (n) * sizeof(*(src)))
239 #define MEMMOVE(dest, src, n) memmove((dest), (src), (n) * sizeof(*(src)))
244 * macro to flag unimplemented blocks
247 fprintf(stderr, "%s:%d Unimplemented block\n", \
250 #define FIXME(msg, args ...) \
252 fprintf(stderr, "%s:%d Fixme: ", \
253 __FILE__, __LINE__); \
254 fprintf(stderr, msg, ## args); \
255 fputc('\n', stderr); \
259 * Internal data structures
265 * Escape nonprintable characters within TEXT, similar to how it's done in
266 * C string literals. Caller must free the returned string.
268 char *escape(const char *text, int cnt, const char *extra);
270 /* Function: unescape */
271 char *unescape(const char *s, int len, const char *extra);
273 /* Extra characters to be escaped in strings and regexps respectively */
274 #define STR_ESCAPES "\"\\"
275 #define RX_ESCAPES "/\\"
277 /* Function: print_chars */
278 int print_chars(FILE *out, const char *text, int cnt);
280 /* Function: print_pos
281 * Print a pretty representation of being at position POS within TEXT */
282 void print_pos(FILE *out, const char *text, int pos);
283 char *format_pos(const char *text, int pos);
285 /* Function: xread_file
286 * Read the contents of file PATH and return them as one long string. The
287 * caller must free the result. Return NULL if any error occurs.
289 char* xread_file(const char *path);
291 /* Like xread_file, but caller supplies a file pointer */
292 char* xfread_file(FILE *fp);
294 /* Get the error message for ERRNUM in a threadsafe way. Based on libvirt's
297 const char *xstrerror(int errnum, char *buf, size_t len);
299 /* Like asprintf, but set *STRP to NULL on error */
300 int xasprintf(char **strp, const char *format, ...);
302 /* Convert S to RESULT with error checking */
303 int xstrtoint64(char const *s, int base, int64_t *result);
305 /* Calculate line and column number of character POS in TEXT */
306 void calc_line_ofs(const char *text, size_t pos, size_t *line, size_t *ofs);
308 /* Cleans path from user, removing trailing slashes and whitespace */
309 char *cleanpath(char *path);
311 /* Take the first LEN characters from the regexp *U and expand any
312 * character ranges in it. The expanded regexp, if expansion is necessary,
313 * is in U, and the old string is freed. If expansion is not needed or an
314 * error happens, U will be unchanged.
316 * Return 0 if expansion is not necessary, -1 if an error occurs, and 1 if
317 * expansion was needed.
319 int regexp_c_locale(char **u, size_t *len);
322 * The data structure representing a connection to Augeas. */
324 struct tree *origin; /* Actual tree root is origin->children */
325 const char *root; /* Filesystem root for all files */
326 /* always ends with '/' */
327 unsigned int flags; /* Flags passed to AUG_INIT */
328 struct module *modules; /* Loaded modules */
330 char *modpathz; /* The search path for modules as a
332 struct pathx_symtab *symtab;
334 uint api_entries; /* Number of entries through a public
335 * API, 0 when called from outside */
337 /* On systems that have a uselocale call, we switch to the C locale
338 * on entry into API functions, and back to the old user locale
340 * FIXME: We need some solution for systems without uselocale, like
341 * setlocale + critical section, though that is very heavy-handed
344 locale_t user_locale;
348 static inline struct error *err_of_aug(const struct augeas *aug) {
349 return ((struct augeas *) aug)->error;
352 /* Used by augparse for loading tests */
353 int __aug_load_module_file(struct augeas *aug, const char *filename);
355 /* Called at beginning and end of every _public_ API function */
356 void api_entry(const struct augeas *aug);
357 void api_exit(const struct augeas *aug);
360 * An entry in the global config tree. The data structure allows associating
361 * values with interior nodes, but the API currently marks that as an error.
363 * To make dealing with parents uniform, even for the root, we create
364 * standalone trees with a fake root, called origin. That root is generally
365 * not referenced from anywhere. Standalone trees should be created with
368 * The DIRTY flag is used to track which parts of the tree might need to be
369 * saved. For any node that is marked dirty, all of its ancestors must be
370 * marked dirty, too. Instead of setting this flag directly, the function
371 * TREE_MARK_DIRTY in augeas.c should be used (and only functions in that
372 * file should have a need to mark nodes as dirty)
376 struct tree *parent; /* Points to self for root */
377 char *label; /* Last component of PATH */
378 struct tree *children; /* List of children through NEXT */
381 uint8_t added; /* only used by ns_add and tree_rm to dedupe
386 /* The opaque structure used to represent path expressions. API's
387 * using STRUCT PATHX are declared farther below
391 #define ROOT_P(t) ((t) != NULL && (t)->parent == (t)->parent->parent)
393 /* Function: make_tree
394 * Allocate a new tree node with the given LABEL, VALUE, and CHILDREN,
395 * which are not copied. The new tree is marked as dirty
397 struct tree *make_tree(char *label, char *value,
398 struct tree *parent, struct tree *children);
400 /* Mark a tree as a standalone tree; this creates a fake parent for ROOT,
401 * so that even ROOT has a parent. A new node with only child ROOT is
402 * returned on success, and NULL on failure.
404 struct tree *make_tree_origin(struct tree *root);
406 /* Make a new tree node and append it to parent's children */
407 struct tree *tree_append(struct tree *parent, char *label, char *value);
409 int tree_rm(struct pathx *p);
410 int tree_unlink(struct augeas *aug, struct tree *tree);
411 struct tree *tree_set(struct pathx *p, const char *value);
412 int tree_insert(struct pathx *p, const char *label, int before);
413 int free_tree(struct tree *tree);
414 int dump_tree(FILE *out, struct tree *tree);
415 int tree_equal(const struct tree *t1, const struct tree *t2);
416 char *path_expand(struct tree *tree, const char *ppath);
417 char *path_of_tree(struct tree *tree);
418 /* Clear the dirty flag in the whole TREE */
419 void tree_clean(struct tree *tree);
420 /* Return first child with label LABEL or NULL */
421 struct tree *tree_child(struct tree *tree, const char *label);
422 /* Return first existing child with label LABEL or create one. Return NULL
423 * when allocation fails */
424 struct tree *tree_child_cr(struct tree *tree, const char *label);
425 /* Create a path in the tree; nodes along the path are looked up with
427 struct tree *tree_path_cr(struct tree *tree, int n, ...);
428 /* Store VALUE directly as the value of TREE and set VALUE to NULL.
429 * Update dirty flags */
430 void tree_store_value(struct tree *tree, char **value);
431 /* Set the value of TREE to a copy of VALUE and update dirty flags */
432 int tree_set_value(struct tree *tree, const char *value);
433 /* Cleanly remove all children of TREE, but leave TREE itself unchanged */
434 void tree_unlink_children(struct augeas *aug, struct tree *tree);
435 /* Find a node in the tree at path FPATH; FPATH is a file path, i.e.
436 * not interpreted as a path expression. If no such node exists, return NULL
438 struct tree *tree_fpath(struct augeas *aug, const char *fpath);
439 /* Find a node in the tree at path FPATH; FPATH is a file path, i.e.
440 * not interpreted as a path expression. If no such node exists, create
441 * it and all its missing ancestors.
443 struct tree *tree_fpath_cr(struct augeas *aug, const char *fpath);
444 /* Find the node matching PATH.
445 * Returns the node or NULL on error
446 * Errors: EMMATCH - more than one node matches PATH
447 * ENOMEM - allocation error
449 struct tree *tree_find(struct augeas *aug, const char *path);
450 /* Find the node matching PATH. Expand the tree to contain such a node if
452 * Returns the node or NULL on error
454 struct tree *tree_find_cr(struct augeas *aug, const char *path);
455 /* Find the node at the path stored in AUGEAS_CONTEXT, i.e. the root context
456 * node for relative paths.
457 * Errors: EMMATCH - more than one node matches PATH
458 * ENOMEM - allocation error
460 struct tree *tree_root_ctx(const struct augeas *aug);
463 * Wrappers to simulate OPEN_MEMSTREAM where that's not available. The
464 * STREAM member is opened by INIT_MEMSTREAM and closed by
465 * CLOSE_MEMSTREAM. The BUF is allocated automatically, but can not be used
466 * until after CLOSE_MEMSTREAM has been called. It is the callers
467 * responsibility to free up BUF.
475 /* Function: init_memstream
476 * Initialize a memstream. On systems that have OPEN_MEMSTREAM, it is used
477 * to open MS->STREAM. On systems without OPEN_MEMSTREAM, MS->STREAM is
478 * backed by a temporary file.
480 * MS must be allocated in advance; INIT_MEMSTREAM initializes it.
482 int __aug_init_memstream(struct memstream *ms);
483 #define init_memstream(ms) __aug_init_memstream(ms);
485 /* Function: close_memstream
486 * Close a memstream. After calling this, MS->STREAM can not be used
487 * anymore and a string representing whatever was written to it is
488 * available in MS->BUF. The caller must free MS->BUF.
490 * The caller must free the MEMSTREAM structure.
492 int __aug_close_memstream(struct memstream *ms);
493 #define close_memstream(ms) __aug_close_memstream(ms)
524 const char *pathx_error(struct pathx *pathx, const char **txt, int *pos);
526 /* Parse a path expression PATH rooted at TREE, which is a node somewhere
527 * in AUG->ORIGIN. If TREE is NULL, AUG->ORIGIN is used. If ROOT_CTX is not
528 * NULL and the PATH isn't absolute then it will be rooted at ROOT_CTX.
530 * Use this function rather than PATHX_PARSE for path expressions inside
531 * the tree in AUG->ORIGIN.
533 * If NEED_NODESET is true, the resulting path expression must evaluate toa
534 * nodeset, otherwise it can evaluate to a value of any type.
536 * Return the resulting path expression, or NULL on error. If an error
537 * occurs, the error struct in AUG contains details.
539 struct pathx *pathx_aug_parse(const struct augeas *aug,
541 struct tree *root_ctx,
542 const char *path, bool need_nodeset);
544 /* Parse the string PATH into a path expression PX that will be evaluated
545 * against the tree ORIGIN.
547 * If NEED_NODESET is true, the resulting path expression must evaluate toa
548 * nodeset, otherwise it can evaluate to a value of any type.
550 * Returns 0 on success, and -1 on error
552 int pathx_parse(const struct tree *origin,
556 struct pathx_symtab *symtab,
557 struct tree *root_ctx,
559 /* Return the error struct that was passed into pathx_parse */
560 struct error *err_of_pathx(struct pathx *px);
561 struct tree *pathx_first(struct pathx *path);
562 struct tree *pathx_next(struct pathx *path);
563 /* Return -1 if evalutating PATH runs into trouble, otherwise return the
564 * number of nodes matching PATH and set MATCH to the first matching
566 int pathx_find_one(struct pathx *path, struct tree **match);
567 int pathx_expand_tree(struct pathx *path, struct tree **tree);
568 void free_pathx(struct pathx *path);
570 struct pathx_symtab *pathx_get_symtab(struct pathx *pathx);
571 int pathx_symtab_define(struct pathx_symtab **symtab,
572 const char *name, struct pathx *px);
573 /* Returns 1 on success, and -1 when out of memory */
574 int pathx_symtab_assign_tree(struct pathx_symtab **symtab, const char *name,
576 int pathx_symtab_undefine(struct pathx_symtab **symtab, const char *name);
577 void pathx_symtab_remove_descendants(struct pathx_symtab *symtab,
578 const struct tree *tree);
579 void free_symtab(struct pathx_symtab *symtab);
581 /* Escape a name so that it is safe to pass to parse_name and have it
582 * interpreted as the literal name of a path component.
584 * On return, *OUT will be NULL if IN does not need escaping, otherwise it
585 * will contain an escaped copy of IN which the caller must free.
587 * Returns -1 if it failed to allocate memory for *OUT, 0 on success
589 int pathx_escape_name(const char *in, char **out);
591 /* Debug helpers, all defined in internal.c. When ENABLE_DEBUG is not
592 * set, they compile to nothing.
595 /* Return true if debugging for CATEGORY is turned on */
596 bool debugging(const char *category);
597 /* Format the arguments into a file name, prepend it with the directory
598 * from the environment variable AUGEAS_DEBUG_DIR, and open the file for
601 FILE *debug_fopen(const char *format, ...)
602 ATTRIBUTE_FORMAT(printf, 1, 2);
604 # define debugging(facility) (0)
605 # define debug_fopen(format ...) (NULL)
612 * indent-tabs-mode: nil