Repository navigation
Expand file tree
/
Copy pathhcache.cpp
More file actions
523 lines (441 loc) · 14.5 KB
/
Copy pathhcache.cpp
File metadata and controls
523 lines (441 loc) · 14.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
/*
* This file has been donated to Jam.
*/
/*
* Craig W. McPheeters, Alias|Wavefront.
*
* hcache.c hcache.h - handle caching of #includes in source files.
*
* Create a cache of files scanned for headers. When starting jam, look for the
* cache file and load it if present. When finished the binding phase, create a
* new header cache. The cache contains files, their timestamps and the header
* files found in their scan. During the binding phase of jam, look in the
* header cache first for the headers contained in a file. If the cache is
* present and valid, use its contents. This results in dramatic speedups with
* large projects (e.g. 3min -> 1min startup for one project.)
*
* External routines:
* hcache_init() - read and parse the local .jamdeps file.
* hcache_done() - write a new .jamdeps file.
* hcache() - return list of headers on target. Use cache or do a scan.
*
* The dependency file format is an ASCII file with 1 line per target. Each line
* has the following fields:
* @boundname@ timestamp_sec timestamp_nsec @file@ @file@ @file@ ...
*/
#include "config.h"
#ifdef OPT_HEADER_CACHE_EXT
#include "jam.h"
#include "hcache.h"
#include "hash.h"
#include "headers.h"
#include "lists.h"
#include "modules.h"
#include "object.h"
#include "parse.h"
#include "regexp.h"
#include "rules.h"
#include "search.h"
#include "timestamp.h"
#include "variable.h"
#include "output.h"
#include <errno.h>
#include <string.h>
typedef struct hcachedata HCACHEDATA ;
struct hcachedata
{
OBJECT * boundname;
timestamp time;
LIST * includes;
LIST * hdrscan; /* the HDRSCAN value for this target */
int age; /* if too old, we will remove it from cache */
HCACHEDATA * next;
};
static struct hash * hcachehash = 0;
static HCACHEDATA * hcachelist = 0;
static int queries = 0;
static int hits = 0;
#define CACHE_FILE_VERSION "version 5"
#define CACHE_RECORD_HEADER "header"
#define CACHE_RECORD_END "end"
/*
* Return the name of the header cache file. May return NULL.
*
* The user sets this by setting the HCACHEFILE variable in a Jamfile. We cache
* the result so the user can not change the cache file during header scanning.
*/
static const char * cache_name( void )
{
static OBJECT * name = 0;
if ( !name )
{
LIST * const hcachevar = var_get( root_module(), constant_HCACHEFILE );
if ( !list_empty( hcachevar ) )
{
TARGET * const t = bindtarget( list_front( hcachevar ) );
pushsettings( root_module(), t->settings );
/* Do not expect the cache file to be generated, so pass 0 as the
* third argument to search. Expect the location to be specified via
* LOCATE, so pass 0 as the fourth argument.
*/
object_free( t->boundname );
t->boundname = search( t->name, &t->time, 0, 0 );
popsettings( root_module(), t->settings );
name = object_copy( t->boundname );
}
}
return name ? object_str( name ) : 0;
}
/*
* Return the maximum age a cache entry can have before it is purged from the
* cache.
*/
static int cache_maxage( void )
{
int age = 100;
LIST * const var = var_get( root_module(), constant_HCACHEMAXAGE );
if ( !list_empty( var ) )
{
age = atoi( object_str( list_front( var ) ) );
if ( age < 0 )
age = 0;
}
return age;
}
/*
* Read a netstring. The caveat is that the string can not contain ASCII 0. The
* returned value is as returned by object_new().
*/
OBJECT * read_netstring( FILE * f )
{
unsigned long len;
static char * buf = NULL;
static unsigned long buf_len = 0;
if ( fscanf( f, " %9lu", &len ) != 1 )
return NULL;
if ( fgetc( f ) != (int)'\t' )
return NULL;
if ( len > 1024 * 64 )
return NULL; /* sanity check */
if ( len > buf_len )
{
unsigned long new_len = buf_len * 2;
if ( new_len < len )
new_len = len;
buf = (char *)BJAM_REALLOC( buf, new_len + 1 );
if ( buf )
buf_len = new_len;
}
if ( !buf )
return NULL;
if ( fread( buf, 1, len, f ) != len )
return NULL;
if ( fgetc( f ) != (int)'\n' )
return NULL;
buf[ len ] = 0;
return object_new( buf );
}
/*
* Write a netstring.
*/
template <typename... Args>
void write_netstring( FILE * f, char const * format, Args... args )
{
if ( format == nullptr ) format = "";
auto size = std::snprintf(nullptr, 0, format, args...);
std::unique_ptr<char[]> s(new char[size+1]);
std::snprintf(s.get(), size+1, format, args...);
fprintf( f, "%lu\t%s\n", (long unsigned)size, s.get() );
}
void hcache_init()
{
FILE * f;
OBJECT * version = 0;
const char * hcachename;
if ( hcachehash )
return;
hcachehash = hashinit( sizeof( HCACHEDATA ), "hcache" );
if ( !( hcachename = cache_name() ) )
return;
if ( !( f = fopen( hcachename, "rb" ) ) )
{
if ( errno != ENOENT )
err_printf( "[errno %d] failed to read hcache file '%s': %s",
errno, hcachename, strerror(errno) );
return;
}
version = read_netstring( f );
if ( !version || strcmp( object_str( version ), CACHE_FILE_VERSION ) )
goto bail;
while ( 1 )
{
HCACHEDATA cachedata;
HCACHEDATA * c;
OBJECT * record_type = 0;
OBJECT * time_secs_str = 0;
OBJECT * time_nsecs_str = 0;
OBJECT * age_str = 0;
OBJECT * includes_count_str = 0;
OBJECT * hdrscan_count_str = 0;
int i;
int count;
LIST * l;
int found;
cachedata.boundname = 0;
cachedata.includes = 0;
cachedata.hdrscan = 0;
record_type = read_netstring( f );
if ( !record_type )
{
err_printf( "invalid %s\n", hcachename );
goto cleanup;
}
if ( !strcmp( object_str( record_type ), CACHE_RECORD_END ) )
{
object_free( record_type );
break;
}
if ( strcmp( object_str( record_type ), CACHE_RECORD_HEADER ) )
{
err_printf( "invalid %s with record separator <%s>\n",
hcachename, record_type ? object_str( record_type ) : "<null>" );
goto cleanup;
}
cachedata.boundname = read_netstring( f );
time_secs_str = read_netstring( f );
time_nsecs_str = read_netstring( f );
age_str = read_netstring( f );
includes_count_str = read_netstring( f );
if ( !cachedata.boundname || !time_secs_str || !time_nsecs_str ||
!age_str || !includes_count_str )
{
err_printf( "invalid %s\n", hcachename );
goto cleanup;
}
timestamp_init( &cachedata.time, atoi( object_str( time_secs_str ) ),
atoi( object_str( time_nsecs_str ) ) );
cachedata.age = atoi( object_str( age_str ) ) + 1;
count = atoi( object_str( includes_count_str ) );
for ( l = L0, i = 0; i < count; ++i )
{
OBJECT * const s = read_netstring( f );
if ( !s )
{
err_printf( "invalid %s\n", hcachename );
list_free( l );
goto cleanup;
}
l = list_push_back( l, s );
}
cachedata.includes = l;
hdrscan_count_str = read_netstring( f );
if ( !hdrscan_count_str )
{
err_printf( "invalid %s\n", hcachename );
goto cleanup;
}
count = atoi( object_str( hdrscan_count_str ) );
for ( l = L0, i = 0; i < count; ++i )
{
OBJECT * const s = read_netstring( f );
if ( !s )
{
err_printf( "invalid %s\n", hcachename );
list_free( l );
goto cleanup;
}
l = list_push_back( l, s );
}
cachedata.hdrscan = l;
c = (HCACHEDATA *)hash_insert( hcachehash, cachedata.boundname, &found )
;
if ( !found )
{
c->boundname = cachedata.boundname;
c->includes = cachedata.includes;
c->hdrscan = cachedata.hdrscan;
c->age = cachedata.age;
timestamp_copy( &c->time, &cachedata.time );
}
else
{
err_printf( "can not insert header cache item, bailing on %s"
"\n", hcachename );
goto cleanup;
}
c->next = hcachelist;
hcachelist = c;
object_free( record_type );
object_free( time_secs_str );
object_free( time_nsecs_str );
object_free( age_str );
object_free( includes_count_str );
object_free( hdrscan_count_str );
continue;
cleanup:
if ( record_type ) object_free( record_type );
if ( time_secs_str ) object_free( time_secs_str );
if ( time_nsecs_str ) object_free( time_nsecs_str );
if ( age_str ) object_free( age_str );
if ( includes_count_str ) object_free( includes_count_str );
if ( hdrscan_count_str ) object_free( hdrscan_count_str );
if ( cachedata.boundname ) object_free( cachedata.boundname );
if ( cachedata.includes ) list_free( cachedata.includes );
if ( cachedata.hdrscan ) list_free( cachedata.hdrscan );
goto bail;
}
if ( is_debug_header() )
out_printf( "hcache read from file %s\n", hcachename );
bail:
if ( version )
object_free( version );
fclose( f );
}
void hcache_done()
{
FILE * f;
HCACHEDATA * c;
int header_count = 0;
const char * hcachename;
int maxage;
if ( !hcachehash )
return;
if ( !( hcachename = cache_name() ) )
goto cleanup;
if ( !( f = fopen( hcachename, "wb" ) ) )
{
err_printf( "[errno %d] failed to write hcache file '%s': %s",
errno, hcachename, strerror(errno) );
goto cleanup;
}
maxage = cache_maxage();
/* Print out the version. */
write_netstring( f, "%s",CACHE_FILE_VERSION );
c = hcachelist;
for ( c = hcachelist; c; c = c->next )
{
LISTITER iter;
LISTITER end;
if ( maxage == 0 )
c->age = 0;
else if ( c->age > maxage )
continue;
write_netstring( f, "%s", CACHE_RECORD_HEADER );
write_netstring( f, "%s", object_str( c->boundname ) );
write_netstring( f, "%lu", (long unsigned)c->time.secs );
write_netstring( f, "%lu", (long unsigned)c->time.nsecs );
write_netstring( f, "%lu", (long unsigned)c->age );
write_netstring( f, "%lu", (long unsigned)list_length(
c->includes ) );
for ( iter = list_begin( c->includes ), end = list_end( c->includes );
iter != end; iter = list_next( iter ) )
write_netstring( f, "%s", object_str( list_item( iter ) ) );
write_netstring( f, "%lu", (long unsigned)list_length(
c->hdrscan ) );
for ( iter = list_begin( c->hdrscan ), end = list_end( c->hdrscan );
iter != end; iter = list_next( iter ) )
write_netstring( f, "%s", object_str( list_item( iter ) ) );
fputs( "\n", f );
++header_count;
}
write_netstring( f, "%s", CACHE_RECORD_END );
if ( is_debug_header() )
out_printf( "hcache written to %s. %d dependencies, %.0f%% hit rate\n",
hcachename, header_count, queries ? 100.0 * hits / queries : 0 );
fclose ( f );
cleanup:
for ( c = hcachelist; c; c = c->next )
{
list_free( c->includes );
list_free( c->hdrscan );
object_free( c->boundname );
}
hcachelist = 0;
if ( hcachehash )
hashdone( hcachehash );
hcachehash = 0;
}
LIST * hcache( TARGET * t, int rec, b2::regex::program re[], LIST * hdrscan )
{
HCACHEDATA * c;
++queries;
if ( ( c = (HCACHEDATA *)hash_find( hcachehash, t->boundname ) ) )
{
if ( !timestamp_cmp( &c->time, &t->time ) )
{
LIST * const l1 = hdrscan;
LIST * const l2 = c->hdrscan;
LISTITER iter1 = list_begin( l1 );
LISTITER const end1 = list_end( l1 );
LISTITER iter2 = list_begin( l2 );
LISTITER const end2 = list_end( l2 );
while ( iter1 != end1 && iter2 != end2 )
{
if ( !object_equal( list_item( iter1 ), list_item( iter2 ) ) )
iter1 = end1;
else
{
iter1 = list_next( iter1 );
iter2 = list_next( iter2 );
}
}
if ( iter1 != end1 || iter2 != end2 )
{
if ( is_debug_header() )
{
out_printf( "HDRSCAN out of date in cache for %s\n",
object_str( t->boundname ) );
out_printf(" real : ");
list_print( hdrscan );
out_printf( "\n cached: " );
list_print( c->hdrscan );
out_printf( "\n" );
}
list_free( c->includes );
list_free( c->hdrscan );
c->includes = L0;
c->hdrscan = L0;
}
else
{
if ( is_debug_header() )
out_printf( "using header cache for %s\n", object_str(
t->boundname ) );
c->age = 0;
++hits;
return list_copy( c->includes );
}
}
else
{
if ( is_debug_header() )
out_printf ("header cache out of date for %s\n", object_str(
t->boundname ) );
list_free( c->includes );
list_free( c->hdrscan );
c->includes = L0;
c->hdrscan = L0;
}
}
else
{
int found;
c = (HCACHEDATA *)hash_insert( hcachehash, t->boundname, &found );
if ( !found )
{
c->boundname = object_copy( t->boundname );
c->next = hcachelist;
hcachelist = c;
}
}
/* 'c' points at the cache entry. Its out of date. */
{
LIST * const l = headers1( L0, t->boundname, rec, re );
timestamp_copy( &c->time, &t->time );
c->age = 0;
c->includes = list_copy( l );
c->hdrscan = list_copy( hdrscan );
return l;
}
}
#endif /* OPT_HEADER_CACHE_EXT */