ccache.h

   1 #ifndef CCACHE_H
   2 #define CCACHE_H
   3
   4 #include "system.h"
   5 #include "mdfour.h"
   6 #include "conf.h"
   7 #include "counters.h"
   8
   9 #ifdef __GNUC__
  10 #define ATTR_FORMAT(x, y, z) __attribute__((format (x, y, z)))
  11 #define ATTR_NORETURN __attribute__((noreturn));
  12 #else
  13 #define ATTR_FORMAT(x, y, z)
  14 #define ATTR_NORETURN
  15 #endif
  16
  17 #ifndef MYNAME
  18 #define MYNAME "ccache"
  19 #endif
  20
  21 extern const char CCACHE_VERSION[];
  22
  23 /* statistics fields in storage order */
  24 enum stats {
  25         STATS_NONE = 0,
  26         STATS_STDOUT = 1,
  27         STATS_STATUS = 2,
  28         STATS_ERROR = 3,
  29         STATS_TOCACHE = 4,
  30         STATS_PREPROCESSOR = 5,
  31         STATS_COMPILER = 6,
  32         STATS_MISSING = 7,
  33         STATS_CACHEHIT_CPP = 8,
  34         STATS_ARGS = 9,
  35         STATS_LINK = 10,
  36         STATS_NUMFILES = 11,
  37         STATS_TOTALSIZE = 12,
  38         STATS_OBSOLETE_MAXFILES = 13,
  39         STATS_OBSOLETE_MAXSIZE = 14,
  40         STATS_SOURCELANG = 15,
  41         STATS_DEVICE = 16,
  42         STATS_NOINPUT = 17,
  43         STATS_MULTIPLE = 18,
  44         STATS_CONFTEST = 19,
  45         STATS_UNSUPPORTED = 20,
  46         STATS_OUTSTDOUT = 21,
  47         STATS_CACHEHIT_DIR = 22,
  48         STATS_NOOUTPUT = 23,
  49         STATS_EMPTYOUTPUT = 24,
  50         STATS_BADEXTRAFILE = 25,
  51         STATS_COMPCHECK = 26,
  52         STATS_CANTUSEPCH = 27,
  53         STATS_PREPROCESSING = 28,
  54
  55         STATS_END
  56 };
  57
  58 #define SLOPPY_INCLUDE_FILE_MTIME 1
  59 #define SLOPPY_INCLUDE_FILE_CTIME 2
  60 #define SLOPPY_FILE_MACRO 4
  61 #define SLOPPY_TIME_MACROS 8
  62 #define SLOPPY_PCH_DEFINES 16
  63 /*
  64  * Allow us to match files based on their stats (size, mtime, ctime), without
  65  * looking at their contents.
  66  */
  67 #define SLOPPY_FILE_STAT_MATCHES 32
  68
  69 #define str_eq(s1, s2) (strcmp((s1), (s2)) == 0)
  70 #define str_startswith(s, p) (strncmp((s), (p), strlen((p))) == 0)
  71
  72 /* ------------------------------------------------------------------------- */
  73 /* args.c */
  74
  75 struct args {
  76         char **argv;
  77         int argc;
  78 };
  79
  80 struct args *args_init(int, char **);
  81 struct args *args_init_from_string(const char *);
  82 struct args *args_init_from_gcc_atfile(const char *filename);
  83 struct args *args_copy(struct args *args);
  84 void args_free(struct args *args);
  85 void args_add(struct args *args, const char *s);
  86 void args_add_prefix(struct args *args, const char *s);
  87 void args_extend(struct args *args, struct args *to_append);
  88 void args_insert(struct args *dest, int index, struct args *src, bool replace);
  89 void args_pop(struct args *args, int n);
  90 void args_set(struct args *args, int index, const char *value);
  91 void args_strip(struct args *args, const char *prefix);
  92 void args_remove_first(struct args *args);
  93 char *args_to_string(struct args *args);
  94 bool args_equal(struct args *args1, struct args *args2);
  95
  96 /* ------------------------------------------------------------------------- */
  97 /* hash.c */
  98
  99 void hash_start(struct mdfour *md);
 100 void hash_buffer(struct mdfour *md, const void *s, size_t len);
 101 char *hash_result(struct mdfour *md);
 102 void hash_result_as_bytes(struct mdfour *md, unsigned char *out);
 103 bool hash_equal(struct mdfour *md1, struct mdfour *md2);
 104 void hash_delimiter(struct mdfour *md, const char *type);
 105 void hash_string(struct mdfour *md, const char *s);
 106 void hash_string_length(struct mdfour *md, const char *s, int length);
 107 void hash_int(struct mdfour *md, int x);
 108 bool hash_fd(struct mdfour *md, int fd);
 109 bool hash_file(struct mdfour *md, const char *fname);
 110
 111 /* ------------------------------------------------------------------------- */
 112 /* util.c */
 113
 114 void cc_log(const char *format, ...) ATTR_FORMAT(printf, 1, 2);
 115 void cc_bulklog(const char *format, ...) ATTR_FORMAT(printf, 1, 2);
 116 void cc_log_argv(const char *prefix, char **argv);
 117 void fatal(const char *format, ...) ATTR_FORMAT(printf, 1, 2) ATTR_NORETURN;
 118
 119 void copy_fd(int fd_in, int fd_out);
 120 int copy_file(const char *src, const char *dest, int compress_level);
 121 int move_file(const char *src, const char *dest, int compress_level);
 122 int move_uncompressed_file(const char *src, const char *dest,
 123                            int compress_level);
 124 bool file_is_compressed(const char *filename);
 125 int create_dir(const char *dir);
 126 int create_parent_dirs(const char *path);
 127 const char *get_hostname(void);
 128 const char *tmp_string(void);
 129 char *format_hash_as_string(const unsigned char *hash, int size);
 130 int create_cachedirtag(const char *dir);
 131 char *format(const char *format, ...) ATTR_FORMAT(printf, 1, 2);
 132 void reformat(char **ptr, const char *format, ...) ATTR_FORMAT(printf, 2, 3);
 133 char *x_strdup(const char *s);
 134 char *x_strndup(const char *s, size_t n);
 135 void *x_malloc(size_t size);
 136 void *x_calloc(size_t nmemb, size_t size);
 137 void *x_realloc(void *ptr, size_t size);
 138 void x_unsetenv(const char *name);
 139 void traverse(const char *dir, void (*fn)(const char *, struct stat *));
 140 char *basename(const char *path);
 141 char *dirname(const char *path);
 142 const char *get_extension(const char *path);
 143 char *remove_extension(const char *path);
 144 size_t file_size(struct stat *st);
 145 char *format_human_readable_size(uint64_t size);
 146 char *format_parsable_size_with_suffix(uint64_t size);
 147 bool parse_size_with_suffix(const char *str, uint64_t *size);
 148 char *x_realpath(const char *path);
 149 char *gnu_getcwd(void);
 150 #ifndef HAVE_STRTOK_R
 151 char *strtok_r(char *str, const char *delim, char **saveptr);
 152 #endif
 153 int create_tmp_fd(char **fname);
 154 FILE *create_tmp_file(char **fname, const char *mode);
 155 void create_empty_tmp_file(char **fname);
 156 const char *get_home_directory(void);
 157 char *get_cwd(void);
 158 bool same_executable_name(const char *s1, const char *s2);
 159 size_t common_dir_prefix_length(const char *s1, const char *s2);
 160 char *get_relative_path(const char *from, const char *to);
 161 bool is_absolute_path(const char *path);
 162 bool is_full_path(const char *path);
 163 void update_mtime(const char *path);
 164 int x_rename(const char *oldpath, const char *newpath);
 165 int tmp_unlink(const char *path);
 166 int x_unlink(const char *path);
 167 #ifndef _WIN32
 168 char *x_readlink(const char *path);
 169 #endif
 170 bool read_file(const char *path, size_t size_hint, char **data, size_t *size);
 171 char *read_text_file(const char *path, size_t size_hint);
 172 char *subst_env_in_string(const char *str, char **errmsg);
 173
 174 /* ------------------------------------------------------------------------- */
 175 /* stats.c */
 176
 177 void stats_update(enum stats stat);
 178 void stats_flush(void);
 179 unsigned stats_get_pending(enum stats stat);
 180 void stats_zero(void);
 181 void stats_summary(struct conf *conf);
 182 void stats_update_size(uint64_t size, unsigned files);
 183 void stats_get_obsolete_limits(const char *dir, unsigned *maxfiles,
 184                                uint64_t *maxsize);
 185 void stats_set_sizes(const char *dir, size_t num_files, size_t total_size);
 186 void stats_read(const char *path, struct counters *counters);
 187 void stats_write(const char *path, struct counters *counters);
 188
 189 /* ------------------------------------------------------------------------- */
 190 /* unify.c */
 191
 192 int unify_hash(struct mdfour *hash, const char *fname);
 193
 194 /* ------------------------------------------------------------------------- */
 195 /* exitfn.c */
 196
 197 void exitfn_init(void);
 198 void exitfn_add_nullary(void (*function)(void));
 199 void exitfn_add(void (*function)(void *), void *context);
 200 void exitfn_call(void);
 201
 202 /* ------------------------------------------------------------------------- */
 203 /* cleanup.c */
 204
 205 void cleanup_dir(struct conf *conf, const char *dir);
 206 void cleanup_all(struct conf *conf);
 207 void wipe_all(struct conf *conf);
 208
 209 /* ------------------------------------------------------------------------- */
 210 /* execute.c */
 211
 212 int execute(char **argv, int fd_out, int fd_err);
 213 char *find_executable(const char *name, const char *exclude_name);
 214 void print_command(FILE *fp, char **argv);
 215
 216 /* ------------------------------------------------------------------------- */
 217 /* lockfile.c */
 218
 219 bool lockfile_acquire(const char *path, unsigned staleness_limit);
 220 void lockfile_release(const char *path);
 221
 222 /* ------------------------------------------------------------------------- */
 223 /* ccache.c */
 224
 225 extern time_t time_of_compilation;
 226 bool cc_process_args(struct args *args, struct args **preprocessor_args,
 227                     struct args **compiler_args);
 228 void cc_reset(void);
 229 bool is_precompiled_header(const char *path);
 230
 231 /* ------------------------------------------------------------------------- */
 232
 233 #if HAVE_COMPAR_FN_T
 234 #define COMPAR_FN_T __compar_fn_t
 235 #else
 236 typedef int (*COMPAR_FN_T)(const void *, const void *);
 237 #endif
 238
 239 /* work with silly DOS binary open */
 240 #ifndef O_BINARY
 241 #define O_BINARY 0
 242 #endif
 243
 244 /* mkstemp() on some versions of cygwin don't handle binary files, so
 245    override */
 246 #ifdef __CYGWIN__
 247 #undef HAVE_MKSTEMP
 248 #endif
 249
 250 #ifdef _WIN32
 251 char *win32argvtos(char *prefix, char **argv);
 252 char *win32getshell(char *path);
 253 int win32execute(char *path, char **argv, int doreturn,
 254                  const char *path_stdout, const char *path_stderr);
 255 #    ifndef _WIN32_WINNT
 256 #    define _WIN32_WINNT 0x0501
 257 #    endif
 258 #    include <windows.h>
 259 #    define mkdir(a,b) mkdir(a)
 260 #    define link(src,dst) (CreateHardLink(dst,src,NULL) ? 0 : -1)
 261 #    define lstat(a,b) stat(a,b)
 262 #    define execv(a,b) win32execute(a,b,0,NULL,NULL)
 263 #error TODO: Adapt win32execute to new execute API
 264 #    define execute(a,b,c) win32execute(*(a),a,1,b,c)
 265 #    define PATH_DELIM ";"
 266 #    define F_RDLCK 0
 267 #    define F_WRLCK 0
 268 #else
 269 #    define PATH_DELIM ":"
 270 #endif
 271
 272 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
 273
 274 #endif /* ifndef CCACHE_H */