jscoverage/trunk/instrument.c

/*
    instrument.c - file and directory instrumentation routines
    Copyright (C) 2007, 2008, 2009 siliconforks.com

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

#include <config.h>

#include "instrument.h"

#include <assert.h>
#include <errno.h>
#include <string.h>

#include <dirent.h>
#include <sys/stat.h>
#include <sys/types.h>

#include "encoding.h"
#include "global.h"
#include "instrument-js.h"
#include "resource-manager.h"
#include "util.h"

static int g_verbose = 0;

static int string_ends_with(const char * s, const char * suffix) {
  size_t length = strlen(s);
  size_t suffix_length = strlen(suffix);
  if (length < suffix_length) {
    return 0;
  }
  return strcasecmp(s + (length - suffix_length), suffix) == 0;
}

static enum FileType get_file_type(const char * file) {
  if (string_ends_with(file, ".js")) {
    return FILE_TYPE_JS;
  }
  else if (string_ends_with(file, ".html") || string_ends_with(file, ".htm")) {
    return FILE_TYPE_HTML;
  }
  else {
    return FILE_TYPE_OTHER;
  }
}

static void check_same_file(const char * file1, const char * file2) {
  if (is_same_file(file1, file2)) {
    fatal("source and destination are the same");
  }
}

static void check_contains_file(const char * file1, const char * file2) {
  if (contains_file(file1, file2)) {
    fatal("%s contains %s", file1, file2);
  }
}

static void instrument_file(const char * source_file, const char * destination_file, const char * id, int instrumenting) {
  if (g_verbose) {
    printf("Instrumenting file %s\n", id);
  }

  /* check if they are the same */
  char * canonical_source_file = make_canonical_path(source_file);
  char * canonical_destination_file = make_canonical_path(destination_file);
  check_same_file(canonical_source_file, canonical_destination_file);
  free(canonical_source_file);
  free(canonical_destination_file);

  if (instrumenting) {
    enum FileType file_type = get_file_type(source_file);
    switch (file_type) {
    case FILE_TYPE_OTHER:
    case FILE_TYPE_HTML:
      copy_file(source_file, destination_file);
      break;
    case FILE_TYPE_JS:
      {
        FILE * input = xfopen(source_file, "rb");
        FILE * output = xfopen(destination_file, "wb");

        Stream * input_stream = Stream_new(0);
        Stream * output_stream = Stream_new(0);

        Stream_write_file_contents(input_stream, input);

        /*
        Check if the source file looks like an instrumented JavaScript file.
        */
        if (input_stream->length >= JSCOVERAGE_INSTRUMENTED_HEADER_LENGTH &&
            memcmp(input_stream->data, JSCOVERAGE_INSTRUMENTED_HEADER, JSCOVERAGE_INSTRUMENTED_HEADER_LENGTH) == 0) {
          fatal_command_line("file %s in the source directory appears to be already instrumented", id);
        }

        size_t num_characters = input_stream->length;
        uint16_t * characters = NULL;
        int result = jscoverage_bytes_to_characters(jscoverage_encoding, input_stream->data, input_stream->length, &characters, &num_characters);
        if (result == JSCOVERAGE_ERROR_ENCODING_NOT_SUPPORTED) {
          fatal("encoding %s not supported", jscoverage_encoding);
        }
        else if (result == JSCOVERAGE_ERROR_INVALID_BYTE_SEQUENCE) {
          fatal("error decoding %s in file %s", jscoverage_encoding, id);
        }
        jscoverage_instrument_js(id, characters, num_characters, output_stream);
        free(characters);

        if (fwrite(output_stream->data, 1, output_stream->length, output) != output_stream->length) {
          fatal("cannot write to file: %s", destination_file);
        }

        Stream_delete(input_stream);
        Stream_delete(output_stream);

        fclose(input);
        fclose(output);
      }
      break;
    }
  }
  else {
    copy_file(source_file, destination_file);
  }
}

void jscoverage_instrument(const char * source,
                           const char * destination,
                           int verbose,
                           char ** exclude,
                           int num_exclude,
                           char ** no_instrument,
                           int num_no_instrument)
{
  assert(source != NULL);
  assert(destination != NULL);

  g_verbose = verbose;

  /* check if they are the same */
  check_same_file(source, destination);

  /* check if source directory is an ancestor of destination directory */
  check_contains_file(source, destination);

  /* check that the source exists and is a directory */
  struct stat buf;
  xstat(source, &buf);
  if (! S_ISDIR(buf.st_mode)) {
    fatal("not a directory: %s", source);
  }

  /* if the destination directory exists, check that it is a jscoverage directory */
  if (stat(destination, &buf) == 0) {
    /* it exists */
    if (! S_ISDIR(buf.st_mode)) {
      fatal("not a directory: %s", destination);
    }
    if (! directory_is_empty(destination)) {
      char * expected_file = NULL;
      if (jscoverage_mode == JSCOVERAGE_MOZILLA) {
        char * modules_directory = make_path(destination, "modules");
        expected_file = make_path(modules_directory, "jscoverage.jsm");
        free(modules_directory);
      }
      else {
        expected_file = make_path(destination, "jscoverage.html");
      }
      if (stat(expected_file, &buf) == -1) {
        fatal("refusing to overwrite directory: %s", destination);
      }
      free(expected_file);
    }
  }
  else if (errno == ENOENT) {
    xmkdir(destination);
  }
  else {
    fatal("cannot stat directory: %s", destination);
  }

  /* copy the resources */
  if (jscoverage_mode == JSCOVERAGE_MOZILLA) {
    char * chrome_directory = make_path(destination, "chrome");
    char * jscoverage_chrome_directory = make_path(chrome_directory, "jscoverage");
    mkdirs(jscoverage_chrome_directory);
    copy_resource("jscoverage.manifest", chrome_directory);
    copy_resource("jscoverage.html", jscoverage_chrome_directory);
    copy_resource("jscoverage.css", jscoverage_chrome_directory);
    copy_resource("jscoverage.js", jscoverage_chrome_directory);
    copy_resource("jscoverage-throbber.gif", jscoverage_chrome_directory);
    copy_resource("jscoverage-highlight.css", jscoverage_chrome_directory);
    copy_resource("jscoverage.xul", jscoverage_chrome_directory);
    copy_resource("jscoverage-overlay.js", jscoverage_chrome_directory);
    free(jscoverage_chrome_directory);
    free(chrome_directory);

    char * modules_directory = make_path(destination, "modules");
    mkdirs(modules_directory);
    copy_resource("jscoverage.jsm", modules_directory);
    free(modules_directory);
  }
  else {
    jscoverage_copy_resources(destination);
  }

  /* finally: copy the directory */
  struct DirListEntry * list = make_recursive_dir_list(source);
  for (struct DirListEntry * p = list; p != NULL; p = p->next) {
    char * s = make_path(source, p->name);
    char * d = make_path(destination, p->name);

    /* check if it's on the exclude list */
    for (int i = 0; i < num_exclude; i++) {
      char * x = make_path(source, exclude[i]);
      if (is_same_file(x, s) || contains_file(x, s)) {
        free(x);
        goto cleanup;
      }
      free(x);
    }

    char * dd = make_dirname(d);
    mkdirs(dd);
    free(dd);

    int instrument_this = 1;

    /* check if it's on the no-instrument list */
    for (int i = 0; i < num_no_instrument; i++) {
      char * ni = make_path(source, no_instrument[i]);
      if (is_same_file(ni, s) || contains_file(ni, s)) {
        instrument_this = 0;
      }
      free(ni);
    }

    instrument_file(s, d, p->name, instrument_this);

  cleanup:
    free(s);
    free(d);
  }

  free_dir_list(list);
}
1	/*
2	instrument.c - file and directory instrumentation routines
3	Copyright (C) 2007, 2008, 2009 siliconforks.com
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	#include <config.h>
21
22	#include "instrument.h"
23
24	#include <assert.h>
25	#include <errno.h>
26	#include <string.h>
27
28	#include <dirent.h>
29	#include <sys/stat.h>
30	#include <sys/types.h>
31
32	#include "encoding.h"
33	#include "global.h"
34	#include "instrument-js.h"
35	#include "resource-manager.h"
36	#include "util.h"
37
38	static int g_verbose = 0;
39
40	static int string_ends_with(const char * s, const char * suffix) {
41	size_t length = strlen(s);
42	size_t suffix_length = strlen(suffix);
43	if (length < suffix_length) {
44	return 0;
45	}
46	return strcasecmp(s + (length - suffix_length), suffix) == 0;
47	}
48
49	static enum FileType get_file_type(const char * file) {
50	if (string_ends_with(file, ".js")) {
51	return FILE_TYPE_JS;
52	}
53	else if (string_ends_with(file, ".html") \|\| string_ends_with(file, ".htm")) {
54	return FILE_TYPE_HTML;
55	}
56	else {
57	return FILE_TYPE_OTHER;
58	}
59	}
60
61	static void check_same_file(const char * file1, const char * file2) {
62	if (is_same_file(file1, file2)) {
63	fatal("source and destination are the same");
64	}
65	}
66
67	static void check_contains_file(const char * file1, const char * file2) {
68	if (contains_file(file1, file2)) {
69	fatal("%s contains %s", file1, file2);
70	}
71	}
72
73	static void instrument_file(const char * source_file, const char * destination_file, const char * id, int instrumenting) {
74	if (g_verbose) {
75	printf("Instrumenting file %s\n", id);
76	}
77
78	/* check if they are the same */
79	char * canonical_source_file = make_canonical_path(source_file);
80	char * canonical_destination_file = make_canonical_path(destination_file);
81	check_same_file(canonical_source_file, canonical_destination_file);
82	free(canonical_source_file);
83	free(canonical_destination_file);
84
85	if (instrumenting) {
86	enum FileType file_type = get_file_type(source_file);
87	switch (file_type) {
88	case FILE_TYPE_OTHER:
89	case FILE_TYPE_HTML:
90	copy_file(source_file, destination_file);
91	break;
92	case FILE_TYPE_JS:
93	{
94	FILE * input = xfopen(source_file, "rb");
95	FILE * output = xfopen(destination_file, "wb");
96
97	Stream * input_stream = Stream_new(0);
98	Stream * output_stream = Stream_new(0);
99
100	Stream_write_file_contents(input_stream, input);
101
102	/*
103	Check if the source file looks like an instrumented JavaScript file.
104	*/
105	if (input_stream->length >= JSCOVERAGE_INSTRUMENTED_HEADER_LENGTH &&
106	memcmp(input_stream->data, JSCOVERAGE_INSTRUMENTED_HEADER, JSCOVERAGE_INSTRUMENTED_HEADER_LENGTH) == 0) {
107	fatal_command_line("file %s in the source directory appears to be already instrumented", id);
108	}
109
110	size_t num_characters = input_stream->length;
111	uint16_t * characters = NULL;
112	int result = jscoverage_bytes_to_characters(jscoverage_encoding, input_stream->data, input_stream->length, &characters, &num_characters);
113	if (result == JSCOVERAGE_ERROR_ENCODING_NOT_SUPPORTED) {
114	fatal("encoding %s not supported", jscoverage_encoding);
115	}
116	else if (result == JSCOVERAGE_ERROR_INVALID_BYTE_SEQUENCE) {
117	fatal("error decoding %s in file %s", jscoverage_encoding, id);
118	}
119	jscoverage_instrument_js(id, characters, num_characters, output_stream);
120	free(characters);
121
122	if (fwrite(output_stream->data, 1, output_stream->length, output) != output_stream->length) {
123	fatal("cannot write to file: %s", destination_file);
124	}
125
126	Stream_delete(input_stream);
127	Stream_delete(output_stream);
128
129	fclose(input);
130	fclose(output);
131	}
132	break;
133	}
134	}
135	else {
136	copy_file(source_file, destination_file);
137	}
138	}
139
140	void jscoverage_instrument(const char * source,
141	const char * destination,
142	int verbose,
143	char ** exclude,
144	int num_exclude,
145	char ** no_instrument,
146	int num_no_instrument)
147	{
148	assert(source != NULL);
149	assert(destination != NULL);
150
151	g_verbose = verbose;
152
153	/* check if they are the same */
154	check_same_file(source, destination);
155
156	/* check if source directory is an ancestor of destination directory */
157	check_contains_file(source, destination);
158
159	/* check that the source exists and is a directory */
160	struct stat buf;
161	xstat(source, &buf);
162	if (! S_ISDIR(buf.st_mode)) {
163	fatal("not a directory: %s", source);
164	}
165
166	/* if the destination directory exists, check that it is a jscoverage directory */
167	if (stat(destination, &buf) == 0) {
168	/* it exists */
169	if (! S_ISDIR(buf.st_mode)) {
170	fatal("not a directory: %s", destination);
171	}
172	if (! directory_is_empty(destination)) {
173	char * expected_file = NULL;
174	if (jscoverage_mode == JSCOVERAGE_MOZILLA) {
175	char * modules_directory = make_path(destination, "modules");
176	expected_file = make_path(modules_directory, "jscoverage.jsm");
177	free(modules_directory);
178	}
179	else {
180	expected_file = make_path(destination, "jscoverage.html");
181	}
182	if (stat(expected_file, &buf) == -1) {
183	fatal("refusing to overwrite directory: %s", destination);
184	}
185	free(expected_file);
186	}
187	}
188	else if (errno == ENOENT) {
189	xmkdir(destination);
190	}
191	else {
192	fatal("cannot stat directory: %s", destination);
193	}
194
195	/* copy the resources */
196	if (jscoverage_mode == JSCOVERAGE_MOZILLA) {
197	char * chrome_directory = make_path(destination, "chrome");
198	char * jscoverage_chrome_directory = make_path(chrome_directory, "jscoverage");
199	mkdirs(jscoverage_chrome_directory);
200	copy_resource("jscoverage.manifest", chrome_directory);
201	copy_resource("jscoverage.html", jscoverage_chrome_directory);
202	copy_resource("jscoverage.css", jscoverage_chrome_directory);
203	copy_resource("jscoverage.js", jscoverage_chrome_directory);
204	copy_resource("jscoverage-throbber.gif", jscoverage_chrome_directory);
205	copy_resource("jscoverage-highlight.css", jscoverage_chrome_directory);
206	copy_resource("jscoverage.xul", jscoverage_chrome_directory);
207	copy_resource("jscoverage-overlay.js", jscoverage_chrome_directory);
208	free(jscoverage_chrome_directory);
209	free(chrome_directory);
210
211	char * modules_directory = make_path(destination, "modules");
212	mkdirs(modules_directory);
213	copy_resource("jscoverage.jsm", modules_directory);
214	free(modules_directory);
215	}
216	else {
217	jscoverage_copy_resources(destination);
218	}
219
220	/* finally: copy the directory */
221	struct DirListEntry * list = make_recursive_dir_list(source);
222	for (struct DirListEntry * p = list; p != NULL; p = p->next) {
223	char * s = make_path(source, p->name);
224	char * d = make_path(destination, p->name);
225
226	/* check if it's on the exclude list */
227	for (int i = 0; i < num_exclude; i++) {
228	char * x = make_path(source, exclude[i]);
229	if (is_same_file(x, s) \|\| contains_file(x, s)) {
230	free(x);
231	goto cleanup;
232	}
233	free(x);
234	}
235
236	char * dd = make_dirname(d);
237	mkdirs(dd);
238	free(dd);
239
240	int instrument_this = 1;
241
242	/* check if it's on the no-instrument list */
243	for (int i = 0; i < num_no_instrument; i++) {
244	char * ni = make_path(source, no_instrument[i]);
245	if (is_same_file(ni, s) \|\| contains_file(ni, s)) {
246	instrument_this = 0;
247	}
248	free(ni);
249	}
250
251	instrument_file(s, d, p->name, instrument_this);
252
253	cleanup:
254	free(s);
255	free(d);
256	}
257
258	free_dir_list(list);
259	}