libreport  2.13.1.67.gaeb7
A tool to inform users about various problems on the running system
internal_libreport.h
1 /*
2  Copyright (C) 2010 ABRT team
3  Copyright (C) 2010 RedHat Inc
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9 
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU General Public License for more details.
14 
15  You should have received a copy of the GNU General Public License along
16  with this program; if not, write to the Free Software Foundation, Inc.,
17  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19 
20 #ifndef LIBREPORT_INTERNAL_H_
21 #define LIBREPORT_INTERNAL_H_
22 
23 #include <assert.h>
24 #include <ctype.h>
25 #include <dirent.h>
26 #include <errno.h>
27 #include <fcntl.h>
28 #include <inttypes.h>
29 #include <setjmp.h>
30 #include <signal.h>
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <stdarg.h>
34 #include <stddef.h>
35 #include <string.h>
36 #include <syslog.h>
37 #include <sys/poll.h>
38 #include <sys/mman.h>
39 #include <sys/socket.h>
40 #include <sys/stat.h>
41 #include <sys/time.h>
42 #include <sys/types.h>
43 #include <sys/wait.h>
44 #include <arpa/inet.h> /* sockaddr_in, sockaddr_in6 etc */
45 #include <termios.h>
46 #include <time.h>
47 #include <unistd.h>
48 /* Try to pull in PATH_MAX */
49 #include <limits.h>
50 #include <sys/param.h>
51 #ifndef PATH_MAX
52 # define PATH_MAX 256
53 #endif
54 #include <pwd.h>
55 #include <grp.h>
56 
57 #ifdef HAVE_CONFIG_H
58 # include "config.h"
59 #endif
60 
61 /* Must be after #include "config.h" */
62 #ifdef ENABLE_NLS
63 # include <libintl.h>
64 # define _(S) dgettext(PACKAGE, S)
65 #else
66 # define _(S) (S)
67 #endif
68 
69 #ifdef HAVE_LOCALE_H
70 # include <locale.h>
71 #endif /* HAVE_LOCALE_H */
72 
73 /* Some libc's forget to declare these, do it ourself */
74 extern char **environ;
75 #if defined(__GLIBC__) && __GLIBC__ < 2
76 int vdprintf(int d, const char *format, va_list ap);
77 #endif
78 
79 #undef NORETURN
80 #define NORETURN __attribute__ ((noreturn))
81 
82 #undef ERR_PTR
83 #define ERR_PTR ((void*)(uintptr_t)1)
84 
85 #undef ARRAY_SIZE
86 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
87 
88 /* consts used across whole libreport */
89 #define CREATE_PRIVATE_TICKET "ABRT_CREATE_PRIVATE_TICKET"
90 #define STOP_ON_NOT_REPORTABLE "ABRT_STOP_ON_NOT_REPORTABLE"
91 
92 /* path of user's local config, path is relative to user's home */
93 #define USER_HOME_CONFIG_PATH "/.config/libreport"
94 
95 /* Pull in entire public libreport API */
96 #include "global_configuration.h"
97 #include "dump_dir.h"
98 #include "event_config.h"
99 #include "problem_data.h"
100 #include "report.h"
101 #include "run_event.h"
102 #include "workflow.h"
103 #include "file_obj.h"
104 #include "libreport_types.h"
105 #include "reporters.h"
106 
107 #ifdef __cplusplus
108 extern "C" {
109 #endif
110 
111 char *libreport_trim_all_whitespace(const char *str);
112 char *libreport_shorten_string_to_length(const char *str, unsigned length);
113 char *libreport_strtrimch(char *str, int ch);
114 char *libreport_strremovech(char *str, int ch);
115 char *libreport_append_to_malloced_string(char *mstr, const char *append);
116 char *libreport_skip_blank(const char *s);
117 char *libreport_skip_whitespace(const char *s);
118 char *libreport_skip_non_whitespace(const char *s);
119 /* Like strcpy but can copy overlapping strings. */
120 void libreport_overlapping_strcpy(char *dst, const char *src);
121 
122 /*
123  * Used to construct a name in a different directory with the basename
124  * similar to the old name, if possible.
125  */
126 char *libreport_concat_path_basename(const char *path, const char *filename);
127 
128 /* Allows all printable characters except '/',
129  * the string must not exceed 64 characters of length
130  * and must not equal neither "." nor ".." (these strings may appear in the string) */
131 bool libreport_str_is_correct_filename(const char *str);
132 
133 /* A-la fgets, but malloced and of unlimited size */
134 char *libreport_xmalloc_fgets(FILE *file);
135 /* Similar, but removes trailing \n */
136 char *libreport_xmalloc_fgetline(FILE *file);
137 /* Useful for easy reading of various /proc files */
138 char *libreport_xmalloc_fopen_fgetline_fclose(const char *filename);
139 
140 
141 typedef enum {
142  COPYFD_SPARSE = 1 << 0,
143 } libreport_copyfd_flags;
144 
145 /* Writes up to 'size' Bytes from a file descriptor to a file in a directory
146  *
147  * If you need to write all Bytes of the file descriptor, pass 0 as the size.
148  *
149  * @param src The source file descriptor
150  * @param dir_fd A file descriptor for the parent directory of the destination file
151  * @param name The destination file name
152  * @param mode The destination file open mode
153  * @param uid The destination file's uid
154  * @param gid The destination file's gid
155  * @param open_flags The destination file open flags
156  * @param copy_flags libreport_copyfd_flags
157  * @param size The upper limit for written bytes (0 for no limit).
158  * @return Number of read Bytes on success. On errors, return -1 and prints out
159  * reasonable good error messages.
160  */
161 off_t libreport_copyfd_ext_at(int src, int dir_fd, const char *name, int mode,
162  uid_t uid, gid_t gid, int open_flags, int copy_flags, off_t size);
163 
164 /* On error, copyfd_XX prints error messages and returns -1 */
165 off_t libreport_copyfd_eof(int src_fd, int dst_fd, int flags);
166 off_t libreport_copyfd_size(int src_fd, int dst_fd, off_t size, int flags);
167 void libreport_copyfd_exact_size(int src_fd, int dst_fd, off_t size);
168 off_t libreport_copy_file_ext_2at(int src_dir_fd, const char *src_name, int dir_fd, const char *name, int mode, uid_t uid, gid_t gid, int src_flags, int dst_flags);
169 off_t libreport_copy_file_ext_at(const char *src_name, int dir_fd, const char *name, int mode, uid_t uid, gid_t gid, int src_flags, int dst_flags);
170 #define libreport_copy_file_ext(src_name, dst_name, mode, uid, gid, src_flags, dst_flags) \
171  libreport_copy_file_ext_at(src_name, AT_FDCWD, dst_name, mode, uid, gid, src_flags, dst_flags)
172 off_t libreport_copy_file(const char *src_name, const char *dst_name, int mode);
173 off_t libreport_copy_file_at(const char *src_name, int dir_fd, const char *name, int mode);
174 int libreport_copy_file_recursive(const char *source, const char *dest);
175 
176 int libreport_decompress_fd(int fdi, int fdo);
177 int libreport_decompress_file(const char *path_in, const char *path_out, mode_t mode_out);
178 int libreport_decompress_file_ext_at(const char *path_in, int dir_fd, const char *path_out,
179  mode_t mode_out, uid_t uid, gid_t gid, int src_flags, int dst_flags);
180 
181 // NB: will return short read on error, not -1,
182 // if some data was read before error occurred
183 void libreport_xread(int fd, void *buf, size_t count);
184 ssize_t libreport_safe_read(int fd, void *buf, size_t count);
185 ssize_t libreport_safe_write(int fd, const void *buf, size_t count);
186 ssize_t libreport_full_read(int fd, void *buf, size_t count);
187 ssize_t libreport_full_write(int fd, const void *buf, size_t count);
188 ssize_t libreport_full_write_str(int fd, const char *buf);
189 void *libreport_xmalloc_read(int fd, size_t *maxsz_p);
190 void *libreport_xmalloc_open_read_close(const char *filename, size_t *maxsz_p);
191 void *libreport_xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p);
192 char *libreport_malloc_readlink(const char *linkname);
193 char *libreport_malloc_readlinkat(int dir_fd, const char *linkname);
194 
195 
196 /* Returns malloc'ed block */
197 char *libreport_encode_base64(const void *src, int length);
198 
199 /* Returns NULL if the string needs no sanitizing.
200  * control_chars_to_sanitize is a bit mask.
201  * If Nth bit is set, Nth control char will be sanitized (replaced by [XX]).
202  */
203 char *libreport_sanitize_utf8(const char *src, uint32_t control_chars_to_sanitize);
204 enum {
205  SANITIZE_ALL = 0xffffffff,
206  SANITIZE_TAB = (1 << 9),
207  SANITIZE_LF = (1 << 10),
208  SANITIZE_CR = (1 << 13),
209 };
210 
211 //unused for now
212 //unsigned long long monotonic_ns(void);
213 //unsigned long long monotonic_us(void);
214 //unsigned monotonic_sec(void);
215 
216 pid_t libreport_safe_waitpid(pid_t pid, int *wstat, int options);
217 
218 enum {
219  /* on return, pipefds[1] is fd to which parent may write
220  * and deliver data to child's stdin: */
221  EXECFLG_INPUT = 1 << 0,
222  /* on return, pipefds[0] is fd from which parent may read
223  * child's stdout: */
224  EXECFLG_OUTPUT = 1 << 1,
225  /* open child's stdin to /dev/null: */
226  EXECFLG_INPUT_NUL = 1 << 2,
227  /* open child's stdout to /dev/null: */
228  EXECFLG_OUTPUT_NUL = 1 << 3,
229  /* redirect child's stderr to stdout: */
230  EXECFLG_ERR2OUT = 1 << 4,
231  /* open child's stderr to /dev/null: */
232  EXECFLG_ERR_NUL = 1 << 5,
233  /* suppress perror_msg("Can't execute 'foo'") if exec fails */
234  EXECFLG_QUIET = 1 << 6,
235  EXECFLG_SETGUID = 1 << 7,
236  EXECFLG_SETSID = 1 << 8,
237  EXECFLG_SETPGID = 1 << 9,
238 };
239 /*
240  * env_vec: list of variables to set in environment (if string has
241  * "VAR=VAL" form) or unset in environment (if string has no '=' char).
242  *
243  * Returns pid.
244  */
245 pid_t libreport_fork_execv_on_steroids(int flags,
246  char **argv,
247  int *pipefds,
248  char **env_vec,
249  const char *dir,
250  uid_t uid);
251 /* Returns malloc'ed string. NULs are retained, and extra one is appended
252  * after the last byte (this NUL is not accounted for in *size_p) */
253 char *libreport_run_in_shell_and_save_output(int flags,
254  const char *cmd,
255  const char *dir,
256  size_t *size_p);
257 
258 /* Random utility functions */
259 
260 bool libreport_is_in_string_list(const char *name, const char *const *v);
261 
262 int libreport_index_of_string_in_list(const char *name, const char *const *v);
263 
264 bool libreport_is_in_comma_separated_list(const char *value, const char *list);
265 bool libreport_is_in_comma_separated_list_of_glob_patterns(const char *value, const char *list);
266 
267 /* Calls GLib version appropriate initialization function.
268  */
269 void libreport_glib_init(void);
270 
271 /* Frees every element'd data using free(),
272  * then frees list itself using g_list_free(list):
273  */
274 void libreport_list_free_with_free(GList *list);
275 
276 double libreport_get_dirsize(const char *pPath);
277 double libreport_get_dirsize_find_largest_dir(
278  const char *pPath,
279  char **worst_dir, /* can be NULL */
280  const char *excluded, /* can be NULL */
281  const char *proc_dir /* can be NULL */
282 );
283 
284 int libreport_ndelay_on(int fd);
285 int libreport_ndelay_off(int fd);
286 int libreport_close_on_exec_on(int fd);
287 
288 char *libreport_xstrdup_between(const char *s, const char *open, const char *close);
289 
290 int libreport_xdup(int from);
291 void libreport_xdup2(int from, int to);
292 void libreport_xmove_fd(int from, int to);
293 
294 void libreport_xwrite(int fd, const void *buf, size_t count);
295 void libreport_xwrite_str(int fd, const char *str);
296 
297 off_t libreport_xlseek(int fd, off_t offset, int whence);
298 
299 char *libreport_xvasprintf(const char *format, va_list p);
300 
301 /*
302  * Utility function to unsetenv a string which was possibly putenv'ed.
303  * The problem here is that "natural" optimization:
304  * strchrnul(var_val, '=')[0] = '\0';
305  * unsetenv(var_val);
306  * is BUGGY: if string was put into environment via putenv,
307  * its modification (s/=/NUL/) is illegal, and unsetenv will fail to unset it.
308  * Of course, saving/restoring the char wouldn't work either.
309  * This helper creates a copy up to '=', unsetenv's it, and frees:
310  */
311 void libreport_safe_unsetenv(const char *var_val);
312 
313 int libreport_xsocket(int domain, int type, int protocol);
314 void libreport_xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
315 void libreport_xlisten(int s, int backlog);
316 ssize_t libreport_xsendto(int s, const void *buf, size_t len,
317  const struct sockaddr *to, socklen_t tolen);
318 
319 off_t libreport_fstat_st_size_or_die(int fd);
320 off_t libreport_stat_st_size_or_die(const char *filename);
321 
322 int libreport_xopen3(const char *pathname, int flags, int mode);
323 void libreport_xunlinkat(int dir_fd, const char *pathname, int flags);
324 
325 /* Just testing dent->d_type == DT_REG is wrong: some filesystems
326  * do not report the type, they report DT_UNKNOWN for every dirent
327  * (and this is not a bug in filesystem, this is allowed by standards).
328  * This function handles this case. Note: it returns 0 on symlinks
329  * even if they point to regular files.
330  */
331 int libreport_is_regular_file(struct dirent *dent, const char *dirname);
332 int libreport_is_regular_file_at(struct dirent *dent, int dir_fd);
333 
334 bool libreport_dot_or_dotdot(const char *filename);
335 char *libreport_last_char_is(const char *s, int c);
336 
337 bool libreport_string_to_bool(const char *s);
338 
339 void libreport_xseteuid(uid_t euid);
340 void libreport_xsetegid(gid_t egid);
341 void libreport_xsetreuid(uid_t ruid, uid_t euid);
342 void libreport_xsetregid(gid_t rgid, gid_t egid);
343 
344 FILE *libreport_xfdopen(int fd, const char *mode);
345 
346 /* Emit a string of hex representation of bytes */
347 char *libreport_bin2hex(char *dst, const char *str, int count);
348 /* Convert "xxxxxxxx" hex string to binary, no more than COUNT bytes */
349 char* libreport_hex2bin(char *dst, const char *str, int count);
350 
351 
352 enum {
353  LOGMODE_NONE = 0,
354  LOGMODE_STDIO = (1 << 0),
355  LOGMODE_SYSLOG = (1 << 1),
356  LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
357  LOGMODE_CUSTOM = (1 << 2),
358  LOGMODE_JOURNAL = (1 << 3),
359 };
360 
361 enum libreport_diemode {
362  DIEMODE_EXIT = 0,
363  DIEMODE_ABORT = 1,
364 };
365 
366 extern void (*libreport_g_custom_logger)(const char*);
367 extern const char *libreport_msg_prefix;
368 extern const char *libreport_msg_eol;
369 extern int libreport_logmode;
370 extern int libreport_xfunc_error_retval;
371 
372 /* A few magic exit codes */
373 #define EXIT_CANCEL_BY_USER 69
374 #define EXIT_STOP_EVENT_RUN 70
375 
376 void libreport_set_xfunc_error_retval(int retval);
377 
378 void libreport_set_xfunc_diemode(enum libreport_diemode mode);
379 
380 /* Verbosity level */
381 extern int libreport_g_verbose;
382 /* VERB1 log_warning("what you sometimes want to see, even on a production box") */
383 #define VERB1 if (libreport_g_verbose >= 1)
384 /* VERB2 log_warning("debug message, not going into insanely small details") */
385 #define VERB2 if (libreport_g_verbose >= 2)
386 /* VERB3 log_warning("lots and lots of details") */
387 #define VERB3 if (libreport_g_verbose >= 3)
388 /* there is no level > 3 */
389 
390 void libreport_xfunc_die(void) NORETURN;
391 
392 void libreport_die_out_of_memory(void) NORETURN;
393 
394 /* It's a macro, not function, since it collides with log_warning() from math.h */
395 #undef log
396 #define log_warning(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
397 #define log_debug(...) log_standard(LOG_DEBUG, __FILE__, __LINE__, __func__, __VA_ARGS__)
398 #define log_info(...) log_standard(LOG_INFO, __FILE__, __LINE__, __func__, __VA_ARGS__)
399 #define log_notice(...) log_standard(LOG_NOTICE, __FILE__, __LINE__, __func__, __VA_ARGS__)
400 #define log_warning(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
401 #define log_error(...) log_standard(LOG_ERR, __FILE__, __LINE__, __func__, __VA_ARGS__)
402 
403 // specific subsystem debugging
404 #define log_parser(...) if(0) log_debug(__VA_ARGS__)
405 
406 #define log_standard(level, file, line, func, ...) log_wrapper(level, __FILE__, __LINE__, __func__, false, false, __VA_ARGS__)
407 
408 // level, file, line, func, perror, custom logger, format & args
409 #define log_error_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, false,__VA_ARGS__)
410 #define log_perror(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
411 #define log_perror_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
412 
413 #define error_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
414 #define perror_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
415 #define warn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
416 #define pwarn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
417 #define notice_msg(...) log_wrapper(LOG_NOTICE, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
418 #define pnotice_msg(...) log_wrapper(LOG_NOTICE, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
419 #define error_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
420 #define perror_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
421 
422 
423 void log_wrapper(int level,
424  const char *file,
425  int line,
426  const char *func,
427  bool process_perror,
428  bool use_custom_logger,
429  const char *format, ...) __attribute__ ((format (printf, 7,8)));
430 
431 void log_and_die_wrapper(int level,
432  const char *file,
433  int line,
434  const char *func,
435  bool process_perror,
436  bool use_custom_logger,
437  const char *format, ...) __attribute__ ((noreturn, format (printf, 7,8)));
438 
439 
444 GString *libreport_strbuf_append_strfv(GString *strbuf,
445  const char *format, va_list p);
446 
452 GString *libreport_strbuf_prepend_strf(GString *strbuf,
453  const char *format, ...);
454 
459 GString *libreport_strbuf_prepend_strfv(GString *strbuf,
460  const char *format, va_list p);
461 
462 /* Returns command line of running program.
463  * Caller is responsible to free() the returned value.
464  * If the pid is not valid or command line can not be obtained,
465  * empty string is returned.
466  */
467 int libreport_open_proc_pid_dir(pid_t pid);
468 char *libreport_get_cmdline_at(pid_t pid);
469 char *libreport_get_cmdline(pid_t pid);
470 char *libreport_get_environ_at(pid_t pid);
471 char *libreport_get_environ(pid_t pid);
472 char *libreport_get_executable_at(pid_t pid);
473 char *libreport_get_executable(pid_t pid);
474 char *libreport_get_cwd_at(pid_t pid);
475 char *libreport_get_cwd(pid_t pid);
476 char *libreport_get_rootdir_at(pid_t pid);
477 char *libreport_get_rootdir(pid_t pid);
478 
479 int libreport_get_fsuid(const char *proc_pid_status);
480 int libreport_get_fsgid(const char *proc_pid_status);
481 int libreport_dump_fd_info_at(int pid_proc_fd, FILE *dest);
482 int libreport_dump_fd_info_ext(const char *dest_filename, const char *proc_pid_fd_path, uid_t uid, gid_t gid);
483 int libreport_dump_fd_info(const char *dest_filename, const char *proc_pid_fd_path);
484 int libreport_get_env_variable_ext(int fd, char delim, const char *name, char **value);
485 int libreport_get_env_variable(pid_t pid, const char *name, char **value);
486 
487 #define PROC_NS_UNSUPPORTED ((ino_t)-1)
488 #define PROC_NS_ID_CGROUP 0
489 #define PROC_NS_ID_IPC 1
490 #define PROC_NS_ID_MNT 2
491 #define PROC_NS_ID_NET 3
492 #define PROC_NS_ID_PID 4
493 #define PROC_NS_ID_TIME 6
494 #define PROC_NS_ID_USER 8
495 #define PROC_NS_ID_UTS 9
496 static const char * libreport_proc_namespaces[] = {
497  "cgroup",
498  "ipc",
499  "mnt",
500  "net",
501  "pid",
502  "pid_for_children",
503  "time",
504  "time_for_children",
505  "user",
506  "uts",
507 };
508 
509 struct ns_ids {
510  ino_t nsi_ids[ARRAY_SIZE(libreport_proc_namespaces)];
511 };
512 
513 int libreport_get_ns_ids_at(int pid_proc_fd, struct ns_ids *ids);
514 int libreport_get_ns_ids(pid_t pid, struct ns_ids *ids);
515 
516 /* These functions require a privileged user and does not work correctly in
517  * processes running in own PID namespace
518  */
519 int libreport_process_has_own_root_at(int proc_pid_fd);
520 int libreport_process_has_own_root(pid_t pid);
521 
522 int libreport_get_pid_of_container_at(int pid_proc_fd, pid_t *init_pid);
523 int libreport_get_pid_of_container(pid_t pid, pid_t *init_pid);
524 int libreport_dump_namespace_diff_at(int base_pid_proc_fd, int tested_pid_proc_fd, FILE *dest);
525 int libreport_dump_namespace_diff_ext(const char *dest_filename, pid_t base_pid, pid_t tested_pid, uid_t uid, gid_t gid);
526 int libreport_dump_namespace_diff(const char *dest_filename, pid_t base_pid, pid_t tested_pid);
527 
528 enum
529 {
530  MOUNTINFO_INDEX_MOUNT_ID,
531  MOUNTINFO_INDEX_PARENT_ID,
532  MOUNTINFO_INDEX_MAJOR_MINOR,
533  MOUNTINFO_INDEX_ROOT,
534  MOUNTINFO_INDEX_MOUNT_POINT,
535  MOUNTINFO_INDEX_MOUNT_OPTIONS,
536  MOUNTINFO_INDEX_OPTIONAL_FIELDS,
537  MOUNTINFO_INDEX_FS_TYPE,
538  MOUNTINFO_INDEX_MOUNT_SOURCE,
539  MOUNTINFO_INDEX_SUPER_OPITONS,
540  _MOUNTINFO_INDEX_MAX,
541 };
542 
543 #define MOUNTINFO_ROOT(val) (val.mntnf_items[MOUNTINFO_INDEX_ROOT])
544 #define MOUNTINFO_MOUNT_POINT(val) (val.mntnf_items[MOUNTINFO_INDEX_MOUNT_POINT])
545 #define MOUNTINFO_MOUNT_SOURCE(val) (val.mntnf_items[MOUNTINFO_INDEX_MOUNT_SOURCE])
546 
547 struct mountinfo
548 {
549  /* 4 : root of the mount within the filesystem */
550  /* 5 : mount point relative to the process's root */
551  /* 10 : mount source: filesystem specific information or "none" */
552  /* but it mount source is preceded by 0 or more optional fields */
553  /* so the effective value is 9 */
554  char *mntnf_items[_MOUNTINFO_INDEX_MAX];
555 };
556 void libreport_mountinfo_destroy(struct mountinfo *mntnf);
557 int libreport_get_mountinfo_for_mount_point(FILE *fin, struct mountinfo *mntnf, const char *mnt_point);
558 
559 /* Takes ptr to time_t, or NULL if you want to use current time.
560  * Returns "YYYY-MM-DD-hh:mm:ss" string.
561  */
562 char *libreport_iso_date_string(const time_t *pt);
563 #define LIBREPORT_ISO_DATE_STRING_SAMPLE "YYYY-MM-DD-hh:mm:ss"
564 #define LIBREPORT_ISO_DATE_STRING_FORMAT "%Y-%m-%d-%H:%M:%S"
565 
566 /* Parses date into integer UNIX time stamp
567  *
568  * @param date The parsed date string
569  * @param pt Return value
570  * @return 0 on success; otherwise non-0 number. -EINVAL if the parameter date
571  * does not match LIBREPORT_ISO_DATE_STRING_FORMAT
572  */
573 int libreport_iso_date_string_parse(const char *date, time_t *pt);
574 
575 enum {
576  MAKEDESC_SHOW_FILES = (1 << 0),
577  MAKEDESC_SHOW_MULTILINE = (1 << 1),
578  MAKEDESC_SHOW_ONLY_LIST = (1 << 2),
579  MAKEDESC_WHITELIST = (1 << 3),
580  /* Include all URLs from FILENAME_REPORTED_TO element in the description text */
581  MAKEDESC_SHOW_URLS = (1 << 4),
582 };
583 char *libreport_make_description(problem_data_t *problem_data, char **names_to_skip, unsigned max_text_size, unsigned desc_flags);
584 char *libreport_make_description_logger(problem_data_t *problem_data, unsigned max_text_size);
585 
586 /* See man os-release(5) for details */
587 #define OSINFO_ID "ID"
588 #define OSINFO_NAME "NAME"
589 #define OSINFO_VERSION_ID "VERSION_ID"
590 #define OSINFO_PRETTY_NAME "PRETTY_NAME"
591 
592 /* @brief Loads a text in format of os-release(5) in to a map
593  *
594  * Function doesn't check for format errors much. It just tries to avoid
595  * program errors. In case of error the function prints out a log message and
596  * continues in parsing.
597  *
598  * @param osinfo_bytes Non-NULL pointer to osinfo bytes.
599  * @param osinfo The map where result is stored
600  */
601 void libreport_parse_osinfo(const char *osinfo_bytes, GHashTable *osinfo);
602 
603 /* @brief Builds product string and product's version string for Bugzilla
604  *
605  * At first tries to get strings from the os specific variables
606  * (REDHAT_BUGZILLA_PRODUCT, REDHAT_BUGZILLA_PRODUCT_VERSION) if no such
607  * variables are found, uses NAME key for the product and VERSION_ID key for
608  * the product's version. If neither NAME nor VERSION_ID are provided fallbacks
609  * to parsing of os_release which should be stored under PRETTY_NAME key.
610  *
611  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
612  *
613  * @param osinfo Input data from which the values are built
614  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
615  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
616  */
617 void libreport_parse_osinfo_for_bz(GHashTable *osinfo, char **product, char **version);
618 
619 /* @brief Extract BUG_REPORT_URL from os-release
620  *
621  * A default location for bug reports can be stored in os-release.
622  * This extracts the value if present and stores it in url.
623  * If unset, url will become NULL
624  *
625  * https://github.com/abrt/libreport/issues/459
626  *
627  * @param osinfo Input data from which the values are built
628  * @param url Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
629  */
630 void libreport_parse_osinfo_for_bug_url(GHashTable *osinfo, char** url);
631 
632 /* @brief Builds product string and product's version string for Red Hat Support
633  *
634  * At first tries to get strings from the os specific variables
635  * (REDHAT_SUPPORT_PRODUCT, REDHAT_SUPPORT_PRODUCT_VERSION) if no such
636  * variables are found, uses NAME key for the product and VERSION_ID key for
637  * the product's version. If no NAME nor VERSION_ID are provided fallbacks to
638  * parsing of os_release which should be stored under PRETTY_NAME key.
639  *
640  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
641  *
642  * @param osinfo Input data from which the values are built
643  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
644  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
645  */
646 void libreport_parse_osinfo_for_rhts(GHashTable *osinfo, char **product, char **version);
647 
648 void libreport_parse_release_for_bz(const char *pRelease, char **product, char **version);
649 void libreport_parse_release_for_rhts(const char *pRelease, char **product, char **version);
650 
665 bool libreport_load_conf_file(const char *pPath, GHashTable *settings, bool skipKeysWithoutValue);
666 bool libreport_load_plugin_conf_file(const char *name, GHashTable *settings, bool skipKeysWithoutValue);
667 
668 const char *libreport_get_user_conf_base_dir(void);
669 
670 bool libreport_load_conf_file_from_dirs(const char *base_name, const char *const *directories, GHashTable *settings, bool skipKeysWithoutValue);
671 
672 enum {
673  CONF_DIR_FLAG_NONE = 0,
674  CONF_DIR_FLAG_OPTIONAL = 1,
675 };
676 
677 bool libreport_load_conf_file_from_dirs_ext(const char *base_name, const char *const *directories,
678  const int * dir_flags, GHashTable *settings,
679  bool skipKeysWithoutValue);
680 
681 bool libreport_save_conf_file(const char *path, GHashTable *settings);
682 bool libreport_save_plugin_conf_file(const char *name, GHashTable *settings);
683 
684 bool libreport_save_app_conf_file(const char* application_name, GHashTable *settings);
685 bool libreport_load_app_conf_file(const char *application_name, GHashTable *settings);
686 void libreport_set_app_user_setting(GHashTable *settings, const char *name, const char *value);
687 const char *libreport_get_app_user_setting(GHashTable *settings, const char *name);
688 
689 bool libreport_save_user_settings(void);
690 bool libreport_load_user_settings(const char *application_name);
691 void libreport_set_user_setting(const char *name, const char *value);
692 const char *libreport_get_user_setting(const char *name);
693 
694 /* filename is expected to exist in CONF_DIR
695  * usually /etc/libreport
696  */
697 GList *libreport_load_words_from_file(const char *filename);
698 GList *libreport_get_file_list(const char *path, const char *ext);
699 void libreport_free_file_list(GList *filelist);
700 file_obj_t *libreport_new_file_obj(const char* fullpath, const char* filename);
701 void libreport_free_file_obj(file_obj_t *f);
702 GList *libreport_parse_delimited_list(const char *string, const char *delimiter);
703 
704 /* Connect to abrtd over unix domain socket, issue DELETE command */
705 int delete_dump_dir_possibly_using_abrtd(const char *dump_dir_name);
706 
707 /* Tries to create a copy of dump_dir_name in base_dir, with same or similar basename.
708  * Returns NULL if copying failed. In this case, logs a message before returning. */
709 struct dump_dir *libreport_steal_directory(const char *base_dir, const char *dump_dir_name);
710 
711 /* Resolves if the given user is in given group
712  *
713  * @param uid user ID
714  * @param gid group ID
715  * @returns TRUE in case the user is in the group otherwise returns FALSE
716  */
717 bool libreport_uid_in_group(uid_t uid, gid_t gid);
718 
719 /* Tries to open dump_dir_name with writing access. If function needs to steal
720  * directory calls ask_continue(new base dir, dump dir) callback to ask user
721  * for permission. If ask_continue param is NULL the function thinks that an
722  * answer is positive and steals directory.
723  * Returns NULL if opening failed or if stealing was dismissed. In this case,
724  * logs a message before returning. */
725 struct dump_dir *libreport_open_directory_for_writing(
726  const char *dump_dir_name,
727  bool (*ask_continue)(const char *, const char *));
728 
729 // Files bigger than this are never considered to be text.
730 //
731 // Started at 64k limit. But _some_ limit is necessary:
732 // fields declared "text" may end up in editing fields and such.
733 // We don't want to accidentally end up with 100meg text in a textbox!
734 // So, don't remove this. If you really need to, raise the limit.
735 //
736 // Bumped up to 200k: saw 124740 byte /proc/PID/smaps file
737 // Bumped up to 500k: saw 375252 byte anaconda traceback file
738 // Bumped up to 1M: bugzilla.redhat.com/show_bug.cgi?id=746727
739 // mentions 853646 byte anaconda-tb-* file.
740 // Bumped up to 8M: bugzilla.redhat.com/show_bug.cgi?id=887570
741 // (anaconda-tb file of 1.38 MBytes)
742 //
743 #define CD_MAX_TEXT_SIZE (8*1024*1024)
744 
745 // Text bigger than this usually is attached, not added inline
746 // was 2k, 20kb is too much, let's try 4kb
747 //
748 // For bug databases
749 #define CD_TEXT_ATT_SIZE_BZ (4*1024)
750 // For dumping problem data into a text file, email, etc
751 #define CD_TEXT_ATT_SIZE_LOGGER (CD_MAX_TEXT_SIZE)
752 
753 // Filenames in problem directory:
754 // filled by a hook:
755 #define FILENAME_TIME "time" /* mandatory */
756 #define FILENAME_LAST_OCCURRENCE "last_occurrence" /* optional */
757 #define FILENAME_REASON "reason" /* mandatory? */
758 #define FILENAME_UID "uid" /* mandatory? */
759 
760 /*
761  * "analyzer" is to be gradually changed to "type":
762  * For now, we fetch and look at "analyzer" element,
763  * but we always save both "analyzer" and "type" (with same contents).
764  * By 2013, we switch to looking at "type". Then we will stop generating
765  * "analyzer" element.
766  * ----
767  * Update 2015: based on the recent changes where we have introduced several
768  * tools generating one problem type, we have decided to retain 'analyzer'
769  * file, but it shall contain string identifier of a tool that created the
770  * problem.
771  */
772 #define FILENAME_ANALYZER "analyzer"
773 #define FILENAME_TYPE "type"
774 #define FILENAME_EXECUTABLE "executable"
775 #define FILENAME_PID "pid"
776 #define FILENAME_TID "tid"
777 #define FILENAME_GLOBAL_PID "global_pid"
778 #define FILENAME_PWD "pwd"
779 #define FILENAME_ROOTDIR "rootdir"
780 #define FILENAME_BINARY "binary"
781 #define FILENAME_CMDLINE "cmdline"
782 #define FILENAME_COREDUMP "coredump"
783 #define FILENAME_CGROUP "cgroup"
784 #define FILENAME_BACKTRACE "backtrace"
785 #define FILENAME_MAPS "maps"
786 #define FILENAME_SMAPS "smaps"
787 #define FILENAME_PROC_PID_STATUS "proc_pid_status"
788 #define FILENAME_ENVIRON "environ"
789 #define FILENAME_LIMITS "limits"
790 #define FILENAME_OPEN_FDS "open_fds"
791 #define FILENAME_MOUNTINFO "mountinfo"
792 #define FILENAME_NAMESPACES "namespaces"
793 #define FILENAME_CPUINFO "cpuinfo"
794 
795 /* Global problem identifier which is usually generated by some "analyze_*"
796  * event because it may take a lot of time to obtain strong problem
797  * identification */
798 #define FILENAME_DUPHASH "duphash"
799 
800 // Name of the function where the application crashed.
801 // Optional.
802 #define FILENAME_CRASH_FUNCTION "crash_function"
803 #define FILENAME_ARCHITECTURE "architecture"
804 #define FILENAME_KERNEL "kernel"
805 /*
806  * From /etc/os-release
807  * os_release filename name is alredy occupied by /etc/redhat-release (see
808  * below) in sake of backward compatibility /etc/os-release is stored in
809  * os_info file
810  */
811 #define FILENAME_OS_INFO "os_info"
812 #define FILENAME_OS_INFO_IN_ROOTDIR "os_info_in_rootdir"
813 // From /etc/system-release or /etc/redhat-release
814 #define FILENAME_OS_RELEASE "os_release"
815 #define FILENAME_OS_RELEASE_IN_ROOTDIR "os_release_in_rootdir"
816 // Filled by <what?>
817 #define FILENAME_PACKAGE "package"
818 #define FILENAME_COMPONENT "component"
819 #define FILENAME_COMMENT "comment"
820 #define FILENAME_RATING "backtrace_rating"
821 #define FILENAME_HOSTNAME "hostname"
822 // Optional. Set to "1" by abrt-handle-upload for every unpacked dump
823 #define FILENAME_REMOTE "remote"
824 #define FILENAME_TAINTED "kernel_tainted"
825 #define FILENAME_TAINTED_SHORT "kernel_tainted_short"
826 #define FILENAME_TAINTED_LONG "kernel_tainted_long"
827 #define FILENAME_VMCORE "vmcore"
828 #define FILENAME_KERNEL_LOG "kernel_log"
829 // File created by createAlertSignature() from libreport's python module
830 // The file should contain a description of an alert
831 #define FILENAME_DESCRIPTION "description"
832 
833 /* Local problem identifier (weaker than global identifier) designed for fast
834  * local for fast local duplicate identification. This file is usually provided
835  * by crashed application (problem creator).
836  */
837 #define FILENAME_UUID "uuid"
838 
839 #define FILENAME_COUNT "count"
840 /* Multi-line list of places problem was reported.
841  * Recommended line format:
842  * "Reporter: VAR=VAL VAR=VAL"
843  * Use libreport_add_reported_to(dd, "line_without_newline"): it adds line
844  * only if it is not already there.
845  */
846 #define FILENAME_REPORTED_TO "reported_to"
847 #define FILENAME_EVENT_LOG "event_log"
848 /*
849  * If exists, should contain a full sentence (with trailing period)
850  * which describes why this problem should not be reported.
851  * Example: "Your laptop firmware 1.9a is buggy, version 1.10 contains the fix."
852  */
853 #define FILENAME_NOT_REPORTABLE "not-reportable"
854 #define FILENAME_CORE_BACKTRACE "core_backtrace"
855 #define FILENAME_REMOTE_RESULT "remote_result"
856 #define FILENAME_PKG_EPOCH "pkg_epoch"
857 #define FILENAME_PKG_NAME "pkg_name"
858 #define FILENAME_PKG_VERSION "pkg_version"
859 #define FILENAME_PKG_RELEASE "pkg_release"
860 #define FILENAME_PKG_ARCH "pkg_arch"
861 
862 /* RHEL packages - Red Hat, Inc. */
863 #define FILENAME_PKG_VENDOR "pkg_vendor"
864 /* RHEL keys - https://access.redhat.com/security/team/key */
865 #define FILENAME_PKG_FINGERPRINT "pkg_fingerprint"
866 
867 #define FILENAME_USERNAME "username"
868 #define FILENAME_ABRT_VERSION "abrt_version"
869 #define FILENAME_EXPLOITABLE "exploitable"
870 
871 /* reproducible element is used by functions from problem_data.h */
872 #define FILENAME_REPRODUCIBLE "reproducible"
873 #define FILENAME_REPRODUCER "reproducer"
874 
875 /* File names related to Anaconda problems
876  */
877 #define FILENAME_KICKSTART_CFG "ks.cfg"
878 #define FILENAME_ANACONDA_TB "anaconda-tb"
879 
880 /* Containers
881  */
882 #define FILENAME_CONTAINER "container"
883 #define FILENAME_CONTAINER_ID "container_id"
884 #define FILENAME_CONTAINER_UUID "container_uuid"
885 #define FILENAME_CONTAINER_IMAGE "container_image"
886 #define FILENAME_CONTAINER_CMDLINE "container_cmdline"
887 /* Container root file-system directory as seen from the host. */
888 #define FILENAME_CONTAINER_ROOTFS "container_rootfs"
889 #define FILENAME_DOCKER_INSPECT "docker_inspect"
890 
891 /* Type of catched exception
892  * Optional.
893  */
894 #define FILENAME_EXCEPTION_TYPE "exception_type"
895 
896 // Not stored as files, added "on the fly":
897 #define CD_DUMPDIR "Directory"
898 
899 gint libreport_cmp_problem_data(gconstpointer a, gconstpointer b, gpointer filename);
900 
901 //UNUSED:
904 //#define CD_EVENTS "Events"
905 
906 /* FILENAME_EVENT_LOG is trimmed to below LOW_WATERMARK
907  * when it reaches HIGH_WATERMARK size
908  */
909 enum {
910  EVENT_LOG_HIGH_WATERMARK = 30 * 1024,
911  EVENT_LOG_LOW_WATERMARK = 20 * 1024,
912 };
913 
914 void libreport_log_problem_data(problem_data_t *problem_data, const char *pfx);
915 
916 extern int g_libreport_inited;
917 void libreport_init(void);
918 
919 #define INITIALIZE_LIBREPORT() \
920  do \
921  { \
922  if (!g_libreport_inited) \
923  { \
924  g_libreport_inited = 1; \
925  libreport_init(); \
926  } \
927  } \
928  while (0)
929 
930 const char *abrt_init(char **argv);
931 void libreport_export_abrt_envvars(int pfx);
932 extern const char *libreport_g_progname;
933 
934 enum parse_opt_type {
935  OPTION_BOOL,
936  OPTION_GROUP,
937  OPTION_STRING,
938  OPTION_INTEGER,
939  OPTION_OPTSTRING,
940  OPTION_LIST,
941  OPTION_END,
942 };
943 
944 struct options {
945  enum parse_opt_type type;
946  int short_name;
947  const char *long_name;
948  void *value;
949  const char *argh;
950  const char *help;
951 };
952 
953 /*
954  * s - short_name
955  * l - long_name
956  * v - value
957  * a - option parameter name (for help text)
958  * h - help
959  */
960 #define OPT_END() { OPTION_END, 0, NULL, NULL, NULL, NULL }
961 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
962 #define OPT_BOOL( s, l, v, h) { OPTION_BOOL , (s), (l), (v), NULL , (h) }
963 #define OPT_INTEGER( s, l, v, h) { OPTION_INTEGER , (s), (l), (v), "NUM", (h) }
964 #define OPT_STRING( s, l, v, a, h) { OPTION_STRING , (s), (l), (v), (a) , (h) }
965 #define OPT_OPTSTRING(s, l, v, a, h) { OPTION_OPTSTRING, (s), (l), (v), (a) , (h) }
966 #define OPT_LIST( s, l, v, a, h) { OPTION_LIST , (s), (l), (v), (a) , (h) }
967 
968 #define OPT__VERBOSE(v) OPT_BOOL('v', "verbose", (v), _("Be verbose"))
969 #define OPT__DUMP_DIR(v) OPT_STRING('d', "problem-dir", (v), "DIR", _("Problem directory"))
970 
971 unsigned libreport_parse_opts(int argc, char **argv, const struct options *opt,
972  const char *usage);
973 
974 void libreport_show_usage_and_die(const char *usage, const struct options *opt) NORETURN;
975 
976 /* Can't include "abrt_curl.h", it's not a public API.
977  * Resorting to just forward-declaring the struct we need.
978  */
979 struct abrt_post_state;
980 
981 /* Decomposes uri to its base elements, removes userinfo out of the hostname and
982  * composes a new uri without userinfo.
983  *
984  * The function does not validate the url.
985  *
986  * @param uri The uri that might contain userinfo
987  * @param result The userinfo free uri will be store here. Cannot be null. Must
988  * be de-allocated by free.
989  * @param scheme Scheme of the uri. Can be NULL. Result can be NULL. Result
990  * must be de-allocated by free.
991  * @param hostname Hostname of the uri. Can be NULL. Result can be NULL. Result
992  * must be de-allocated by free.
993  * @param username Username of the uri. Can be NULL. Result can be NULL. Result
994  * must be de-allocated by free.
995  * @param password Password of the uri. Can be NULL. Result can be NULL. Result
996  * must be de-allocated by free.
997  * @param location Location of the uri. Can be NULL. Result is never NULL. Result
998  * must be de-allocated by free.
999  */
1000 int libreport_uri_userinfo_remove(const char *uri, char **result, char **scheme, char **hostname, char **username, char **password, char **location);
1001 
1002 #ifdef __cplusplus
1003 }
1004 #endif
1005 
1006 #endif
problem_data.h
mountinfo
Definition: internal_libreport.h:548
file_obj
Definition: file_obj.h:21
options
Definition: internal_libreport.h:944
dump_dir
Definition: dump_dir.h:97
ns_ids
Definition: internal_libreport.h:509