1 /* Generic infrastructure to implement various diff algorithms (implementation). */
2 /*
3  * Copyright (c) 2020 Neels Hofmeyr <neels@hofmeyr.de>
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 
19 #include <sys/queue.h>
20 #include <ctype.h>
21 #include <errno.h>
22 #include <stdint.h>
23 #include <stdlib.h>
24 #include <stdbool.h>
25 #include <stdio.h>
26 #include <string.h>
27 #include <limits.h>
28 #include <unistd.h>
29 
30 #include <assert.h>
31 
32 #include <arraylist.h>
33 #include <diff_main.h>
34 
35 #include "diff_internal.h"
36 #include "diff_debug.h"
37 
38 static int
39 read_at(FILE *f, off_t at_pos, unsigned char *buf, size_t len)
40 {
41 	int r;
42 	if (fseeko(f, at_pos, SEEK_SET) == -1)
43 		return errno;
44 	r = fread(buf, sizeof(char), len, f);
45 	if ((r == 0 || r < len) && ferror(f))
46 		return errno;
47 	if (r != len)
48 		return EIO;
49 	return 0;
50 }
51 
52 static int
53 buf_cmp(const unsigned char *left, size_t left_len,
54 	const unsigned char *right, size_t right_len,
55 	bool ignore_whitespace)
56 {
57 	int cmp;
58 
59 	if (ignore_whitespace) {
60 		int il = 0, ir = 0;
61 		while (il < left_len && ir < right_len) {
62 			unsigned char cl = left[il];
63 			unsigned char cr = right[ir];
64 
65 			if (isspace(cl) && il < left_len) {
66 				il++;
67 				continue;
68 			}
69 			if (isspace(cr) && ir < right_len) {
70 				ir++;
71 				continue;
72 			}
73 
74 			if (cl > cr)
75 				return 1;
76 			if (cr > cl)
77 				return -1;
78 			il++;
79 			ir++;
80 		}
81 		while (il < left_len) {
82 			unsigned char cl = left[il++];
83 			if (!isspace(cl))
84 				return 1;
85 		}
86 		while (ir < right_len) {
87 			unsigned char cr = right[ir++];
88 			if (!isspace(cr))
89 				return -1;
90 		}
91 
92 		return 0;
93 	}
94 
95 	cmp = memcmp(left, right, MIN(left_len, right_len));
96 	if (cmp)
97 		return cmp;
98 	if (left_len == right_len)
99 		return 0;
100 	return (left_len > right_len) ? 1 : -1;
101 }
102 
103 int
104 diff_atom_cmp(int *cmp,
105 	      const struct diff_atom *left,
106 	      const struct diff_atom *right)
107 {
108 	off_t remain_left, remain_right;
109 	int flags = (left->root->diff_flags | right->root->diff_flags);
110 	bool ignore_whitespace = (flags & DIFF_FLAG_IGNORE_WHITESPACE);
111 
112 	if (!ignore_whitespace) {
113 		if (!left->len && !right->len) {
114 			*cmp = 0;
115 			return 0;
116 		}
117 		if (!right->len) {
118 			*cmp = 1;
119 			return 0;
120 		}
121 		if (!left->len) {
122 			*cmp = -1;
123 			return 0;
124 		}
125 	}
126 
127 	if (left->at != NULL && right->at != NULL) {
128 		*cmp = buf_cmp(left->at, left->len, right->at, right->len,
129 		    ignore_whitespace);
130 		return 0;
131 	}
132 
133 	remain_left = left->len;
134 	remain_right = right->len;
135 	while (remain_left > 0 || remain_right > 0) {
136 		const size_t chunksz = 8192;
137 		unsigned char buf_left[chunksz], buf_right[chunksz];
138 		const uint8_t *p_left, *p_right;
139 		off_t n_left, n_right;
140 		ssize_t r;
141 
142 		if (!remain_right) {
143 			*cmp = 1;
144 			return 0;
145 		}
146 		if (!remain_left) {
147 			*cmp = -1;
148 			return 0;
149 		}
150 
151 		n_left = MIN(chunksz, remain_left);
152 		n_right = MIN(chunksz, remain_right);
153 
154 		if (left->at == NULL) {
155 			r = read_at(left->root->f,
156 				    left->pos + (left->len - remain_left),
157 				    buf_left, n_left);
158 			if (r) {
159 				*cmp = 0;
160 				return r;
161 			}
162 			p_left = buf_left;
163 		} else {
164 			p_left = left->at + (left->len - remain_left);
165 		}
166 
167 		if (right->at == NULL) {
168 			r = read_at(right->root->f,
169 				    right->pos + (right->len - remain_right),
170 				    buf_right, n_right);
171 			if (r) {
172 				*cmp = 0;
173 				return r;
174 			}
175 			p_right = buf_right;
176 		} else {
177 			p_right = right->at + (right->len - remain_right);
178 		}
179 
180 		r = buf_cmp(p_left, n_left, p_right, n_right,
181 		    ignore_whitespace);
182 		if (r) {
183 			*cmp = r;
184 			return 0;
185 		}
186 
187 		remain_left -= n_left;
188 		remain_right -= n_right;
189 	}
190 
191 	*cmp = 0;
192 	return 0;
193 }
194 
195 int
196 diff_atom_same(bool *same,
197 	       const struct diff_atom *left,
198 	       const struct diff_atom *right)
199 {
200 	int cmp;
201 	int r = diff_atom_cmp(&cmp, left, right);
202 	if (r) {
203 		*same = true;
204 		return r;
205 	}
206 	*same = (cmp == 0);
207 	return 0;
208 }
209 
210 static struct diff_chunk *
211 diff_state_add_solved_chunk(struct diff_state *state,
212 			    const struct diff_chunk *chunk)
213 {
214 	diff_chunk_arraylist_t *result;
215 	struct diff_chunk *new_chunk;
216 	enum diff_chunk_type last_t;
217 	enum diff_chunk_type new_t;
218 
219 	/* Append to solved chunks; make sure that adjacent chunks of same type are combined, and that a minus chunk
220 	 * never directly follows a plus chunk. */
221 	result = &state->result->chunks;
222 
223 	last_t = diff_chunk_type(&result->head[result->len - 1]);
224 	new_t = diff_chunk_type(chunk);
225 
226 	debug("Add %s chunk:\n", chunk->solved ? "solved" : "UNSOLVED");
227 	debug("L\n");
228 	debug_dump_atoms(&state->left, chunk->left_start, chunk->left_count);
229 	debug("R\n");
230 	debug_dump_atoms(&state->right, chunk->right_start, chunk->right_count);
231 
232 	if (new_t == last_t) {
233 		new_chunk = &result->head[result->len - 1];
234 		new_chunk->left_count += chunk->left_count;
235 		new_chunk->right_count += chunk->right_count;
236 		debug("  - added chunk touches previous one of same type, joined:\n");
237 		debug("L\n");
238 		debug_dump_atoms(&state->left, new_chunk->left_start, new_chunk->left_count);
239 		debug("R\n");
240 		debug_dump_atoms(&state->right, new_chunk->right_start, new_chunk->right_count);
241 	} else if (last_t == CHUNK_PLUS && new_t == CHUNK_MINUS) {
242 		enum diff_chunk_type prev_last_t =
243 			result->len > 1 ?
244 				diff_chunk_type(&result->head[result->len - 2])
245 				: CHUNK_EMPTY;
246 		/* If a minus-chunk follows a plus-chunk, place it above the plus-chunk->
247 		 * Is the one before that also a minus? combine. */
248 		if (prev_last_t == CHUNK_MINUS) {
249 			new_chunk = &result->head[result->len - 2];
250 			new_chunk->left_count += chunk->left_count;
251 			new_chunk->right_count += chunk->right_count;
252 
253 			debug("  - added minus-chunk follows plus-chunk,"
254 			      " put before that plus-chunk and joined"
255 			      " with preceding minus-chunk:\n");
256 			debug("L\n");
257 			debug_dump_atoms(&state->left, new_chunk->left_start, new_chunk->left_count);
258 			debug("R\n");
259 			debug_dump_atoms(&state->right, new_chunk->right_start, new_chunk->right_count);
260 		} else {
261 			ARRAYLIST_INSERT(new_chunk, *result, result->len - 1);
262 			if (!new_chunk)
263 				return NULL;
264 			*new_chunk = *chunk;
265 
266 			debug("  - added minus-chunk follows plus-chunk,"
267 			      " put before that plus-chunk\n");
268 		}
269 	} else {
270 		ARRAYLIST_ADD(new_chunk, *result);
271 		if (!new_chunk)
272 			return NULL;
273 		*new_chunk = *chunk;
274 	}
275 	return new_chunk;
276 }
277 
278 /* Even if a left or right side is empty, diff output may need to know the
279  * position in that file.
280  * So left_start or right_start must never be NULL -- pass left_count or
281  * right_count as zero to indicate staying at that position without consuming
282  * any lines. */
283 struct diff_chunk *
284 diff_state_add_chunk(struct diff_state *state, bool solved,
285 		     struct diff_atom *left_start, unsigned int left_count,
286 		     struct diff_atom *right_start, unsigned int right_count)
287 {
288 	diff_chunk_arraylist_t *result = NULL;
289 	struct diff_chunk *new_chunk;
290 	struct diff_chunk chunk = {
291 		.solved = solved,
292 		.left_start = left_start,
293 		.left_count = left_count,
294 		.right_start = right_start,
295 		.right_count = right_count,
296 	};
297 
298 	if (!solved || state->temp_result.len) {
299 		/* Append to temp_result */
300 		debug("append to temp_result\n");
301 		result = &state->temp_result;
302 	} else if (!state->result->chunks.len) {
303 		/* Append to final result */
304 		result = &state->result->chunks;
305 		debug("Add first chunk:\n");
306 		debug("L\n");
307 		debug_dump_atoms(&state->left, left_start, left_count);
308 		debug("R\n");
309 		debug_dump_atoms(&state->right, right_start, right_count);
310 	}
311 	if (result) {
312 		ARRAYLIST_ADD(new_chunk, *result);
313 		if (!new_chunk)
314 			return NULL;
315 		*new_chunk = chunk;
316 		return new_chunk;
317 	}
318 
319 	return diff_state_add_solved_chunk(state, &chunk);
320 }
321 
322 void
323 diff_data_init_root(struct diff_data *d, FILE *f, const uint8_t *data,
324     unsigned long long len, int diff_flags)
325 {
326 	*d = (struct diff_data){
327 		.f = f,
328 		.pos = 0,
329 		.data = data,
330 		.len = len,
331 		.root = d,
332 		.diff_flags = diff_flags,
333 	};
334 }
335 
336 void
337 diff_data_init_subsection(struct diff_data *d, struct diff_data *parent,
338 			  struct diff_atom *from_atom, unsigned int atoms_count)
339 {
340 	struct diff_atom *last_atom;
341 
342 	if (atoms_count == 0) {
343 		*d = (struct diff_data){
344 			.f = NULL,
345 			.pos = 0,
346 			.data = NULL,
347 			.len = 0,
348 			.root = parent->root,
349 			.atoms.head = NULL,
350 			.atoms.len = atoms_count,
351 		};
352 
353 		return;
354 	}
355 
356 	last_atom = from_atom + atoms_count - 1;
357 	*d = (struct diff_data){
358 		.f = NULL,
359 		.pos = from_atom->pos,
360 		.data = from_atom->at,
361 		.len = (last_atom->pos + last_atom->len) - from_atom->pos,
362 		.root = parent->root,
363 		.atoms.head = from_atom,
364 		.atoms.len = atoms_count,
365 	};
366 
367 	debug("subsection:\n");
368 	debug_dump(d);
369 }
370 
371 void
372 diff_data_free(struct diff_data *diff_data)
373 {
374 	if (!diff_data)
375 		return;
376 	if (diff_data->atoms.allocated)
377 		ARRAYLIST_FREE(diff_data->atoms);
378 }
379 
380 int
381 diff_algo_none(const struct diff_algo_config *algo_config,
382 	       struct diff_state *state)
383 {
384 	debug("\n** %s\n", __func__);
385 	debug("left:\n");
386 	debug_dump(&state->left);
387 	debug("right:\n");
388 	debug_dump(&state->right);
389 	debug_dump_myers_graph(&state->left, &state->right, NULL, NULL, 0, NULL,
390 			       0);
391 
392 	/* Add a chunk of equal lines, if any */
393 	struct diff_atom *l = state->left.atoms.head;
394 	unsigned int l_len = state->left.atoms.len;
395 	struct diff_atom *r = state->right.atoms.head;
396 	unsigned int r_len = state->right.atoms.len;
397 	unsigned int equal_atoms_start = 0;
398 	unsigned int equal_atoms_end = 0;
399 	unsigned int l_idx = 0;
400 	unsigned int r_idx = 0;
401 
402 	while (equal_atoms_start < l_len
403 	       && equal_atoms_start < r_len) {
404 		int err;
405 		bool same;
406 		err = diff_atom_same(&same, &l[equal_atoms_start],
407 				     &r[equal_atoms_start]);
408 		if (err)
409 			return err;
410 		if (!same)
411 			break;
412 		equal_atoms_start++;
413 	}
414 	while (equal_atoms_end < (l_len - equal_atoms_start)
415 	       && equal_atoms_end < (r_len - equal_atoms_start)) {
416 		int err;
417 		bool same;
418 		err = diff_atom_same(&same, &l[l_len - 1 - equal_atoms_end],
419 				   &r[r_len - 1 - equal_atoms_end]);
420 		if (err)
421 			return err;
422 		if (!same)
423 			break;
424 		equal_atoms_end++;
425 	}
426 
427 	/* Add a chunk of equal lines at the start */
428 	if (equal_atoms_start) {
429 		if (!diff_state_add_chunk(state, true,
430 					  l, equal_atoms_start,
431 					  r, equal_atoms_start))
432 			return ENOMEM;
433 		l_idx += equal_atoms_start;
434 		r_idx += equal_atoms_start;
435 	}
436 
437 	/* Add a "minus" chunk with all lines from the left. */
438 	if (equal_atoms_start + equal_atoms_end < l_len) {
439 		unsigned int add_len = l_len - equal_atoms_start - equal_atoms_end;
440 		if (!diff_state_add_chunk(state, true,
441 					  &l[l_idx], add_len,
442 					  &r[r_idx], 0))
443 			return ENOMEM;
444 		l_idx += add_len;
445 	}
446 
447 	/* Add a "plus" chunk with all lines from the right. */
448 	if (equal_atoms_start + equal_atoms_end < r_len) {
449 		unsigned int add_len = r_len - equal_atoms_start - equal_atoms_end;
450 		if (!diff_state_add_chunk(state, true,
451 					  &l[l_idx], 0,
452 					  &r[r_idx], add_len))
453 			return ENOMEM;
454 		r_idx += add_len;
455 	}
456 
457 	/* Add a chunk of equal lines at the end */
458 	if (equal_atoms_end) {
459 		if (!diff_state_add_chunk(state, true,
460 					  &l[l_idx], equal_atoms_end,
461 					  &r[r_idx], equal_atoms_end))
462 			return ENOMEM;
463 	}
464 
465 	return DIFF_RC_OK;
466 }
467 
468 int
469 diff_run_algo(const struct diff_algo_config *algo_config,
470 	      struct diff_state *state)
471 {
472 	int rc;
473 
474 	if (!algo_config || !algo_config->impl
475 	    || !state->recursion_depth_left
476 	    || !state->left.atoms.len || !state->right.atoms.len) {
477 		debug("Fall back to diff_algo_none():%s%s%s\n",
478 		      (!algo_config || !algo_config->impl) ? " no-cfg" : "",
479 		      (!state->recursion_depth_left) ? " max-depth" : "",
480 		      (!state->left.atoms.len || !state->right.atoms.len)?
481 			      " trivial" : "");
482 		return diff_algo_none(algo_config, state);
483 	}
484 
485 	ARRAYLIST_FREE(state->temp_result);
486 	ARRAYLIST_INIT(state->temp_result, DIFF_RESULT_ALLOC_BLOCKSIZE);
487 	rc = algo_config->impl(algo_config, state);
488 	switch (rc) {
489 	case DIFF_RC_USE_DIFF_ALGO_FALLBACK:
490 		debug("Got DIFF_RC_USE_DIFF_ALGO_FALLBACK (%p)\n",
491 		      algo_config->fallback_algo);
492 		rc = diff_run_algo(algo_config->fallback_algo, state);
493 		goto return_rc;
494 
495 	case DIFF_RC_OK:
496 		/* continue below */
497 		break;
498 
499 	default:
500 		/* some error happened */
501 		goto return_rc;
502 	}
503 
504 	/* Pick up any diff chunks that are still unsolved and feed to
505 	 * inner_algo.  inner_algo will solve unsolved chunks and append to
506 	 * result, and subsequent solved chunks on this level are then appended
507 	 * to result afterwards. */
508 	int i;
509 	for (i = 0; i < state->temp_result.len; i++) {
510 		struct diff_chunk *c = &state->temp_result.head[i];
511 		if (c->solved) {
512 			diff_state_add_solved_chunk(state, c);
513 			continue;
514 		}
515 
516 		/* c is an unsolved chunk, feed to inner_algo */
517 		struct diff_state inner_state = {
518 			.result = state->result,
519 			.recursion_depth_left = state->recursion_depth_left - 1,
520 		};
521 		diff_data_init_subsection(&inner_state.left, &state->left,
522 					  c->left_start, c->left_count);
523 		diff_data_init_subsection(&inner_state.right, &state->right,
524 					  c->right_start, c->right_count);
525 
526 		rc = diff_run_algo(algo_config->inner_algo, &inner_state);
527 
528 		if (rc != DIFF_RC_OK)
529 			goto return_rc;
530 	}
531 
532 	rc = DIFF_RC_OK;
533 return_rc:
534 	ARRAYLIST_FREE(state->temp_result);
535 	return rc;
536 }
537 
538 struct diff_result *
539 diff_main(const struct diff_config *config,
540 	  FILE *left_f, const uint8_t *left_data, off_t left_len,
541 	  FILE *right_f, const uint8_t *right_data, off_t right_len,
542 	  int diff_flags)
543 {
544 	struct diff_result *result = malloc(sizeof(struct diff_result));
545 	if (!result)
546 		return NULL;
547 
548 	*result = (struct diff_result){};
549 	diff_data_init_root(&result->left, left_f, left_data, left_len,
550 	    diff_flags);
551 	diff_data_init_root(&result->right, right_f, right_data, right_len,
552 	    diff_flags);
553 
554 	if (!config->atomize_func) {
555 		result->rc = EINVAL;
556 		return result;
557 	}
558 
559 	result->rc = config->atomize_func(config->atomize_func_data,
560 					  &result->left, &result->right);
561 	if (result->rc != DIFF_RC_OK)
562 		return result;
563 
564 	struct diff_state state = {
565 		.result = result,
566 		.recursion_depth_left = config->max_recursion_depth ? : 32,
567 	};
568 	diff_data_init_subsection(&state.left, &result->left,
569 				  result->left.atoms.head,
570 				  result->left.atoms.len);
571 	diff_data_init_subsection(&state.right, &result->right,
572 				  result->right.atoms.head,
573 				  result->right.atoms.len);
574 
575 	result->rc = diff_run_algo(config->algo, &state);
576 
577 	return result;
578 }
579 
580 void
581 diff_result_free(struct diff_result *result)
582 {
583 	if (!result)
584 		return;
585 	diff_data_free(&result->left);
586 	diff_data_free(&result->right);
587 	ARRAYLIST_FREE(result->chunks);
588 	free(result);
589 }