ccache.h

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