2 /* $NetBSD: rcorder.c,v 1.7 2000/08/04 07:33:55 enami Exp $ */
6 * Copyright (c) 1998, 1999 Matthew R. Green
9 * Perry E. Metzger. All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed for the NetBSD Project
22 * by Perry E. Metzger.
23 * 4. The name of the author may not be used to endorse or promote products
24 * derived from this software without specific prior written permission.
26 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 #include <sys/types.h>
39 __FBSDID("$FreeBSD$");
56 # define DPRINTF(args) if (debug) { fflush(stdout); fprintf args; }
58 # define DPRINTF(args)
61 #define REQUIRE_STR "# REQUIRE:"
62 #define REQUIRE_LEN (sizeof(REQUIRE_STR) - 1)
63 #define REQUIRES_STR "# REQUIRES:"
64 #define REQUIRES_LEN (sizeof(REQUIRES_STR) - 1)
65 #define PROVIDE_STR "# PROVIDE:"
66 #define PROVIDE_LEN (sizeof(PROVIDE_STR) - 1)
67 #define PROVIDES_STR "# PROVIDES:"
68 #define PROVIDES_LEN (sizeof(PROVIDES_STR) - 1)
69 #define BEFORE_STR "# BEFORE:"
70 #define BEFORE_LEN (sizeof(BEFORE_STR) - 1)
71 #define KEYWORD_STR "# KEYWORD:"
72 #define KEYWORD_LEN (sizeof(KEYWORD_STR) - 1)
73 #define KEYWORDS_STR "# KEYWORDS:"
74 #define KEYWORDS_LEN (sizeof(KEYWORDS_STR) - 1)
87 Hash_Table provide_hash_s, *provide_hash;
89 typedef struct provnode provnode;
90 typedef struct filenode filenode;
91 typedef struct f_provnode f_provnode;
92 typedef struct f_reqnode f_reqnode;
93 typedef struct strnodelist strnodelist;
99 provnode *next, *last;
121 filenode *next, *last;
123 f_provnode *prov_list;
124 strnodelist *keyword_list;
127 filenode fn_head_s, *fn_head;
129 strnodelist *bl_list;
130 strnodelist *keep_list;
131 strnodelist *skip_list;
133 void do_file(filenode *fnode);
134 void strnode_add(strnodelist **, char *, filenode *);
135 int skip_ok(filenode *fnode);
136 int keep_ok(filenode *fnode);
137 void satisfy_req(f_reqnode *rnode, char *filename);
138 void crunch_file(char *);
139 void parse_require(filenode *, char *);
140 void parse_provide(filenode *, char *);
141 void parse_before(filenode *, char *);
142 void parse_keywords(filenode *, char *);
143 filenode *filenode_new(char *);
144 void add_require(filenode *, char *);
145 void add_provide(filenode *, char *);
146 void add_before(filenode *, char *);
147 void add_keyword(filenode *, char *);
148 void insert_before(void);
149 Hash_Entry *make_fake_provision(filenode *);
150 void crunch_all_files(void);
151 void initialize(void);
152 void generate_ordering(void);
153 int main(int, char *[]);
156 main(int argc, char *argv[])
160 while ((ch = getopt(argc, argv, "dk:s:")) != -1)
166 warnx("debugging not compiled in, -d ignored");
170 strnode_add(&keep_list, optarg, 0);
173 strnode_add(&skip_list, optarg, 0);
176 /* XXX should crunch it? */
185 DPRINTF((stderr, "parse_args\n"));
187 DPRINTF((stderr, "initialize\n"));
189 DPRINTF((stderr, "crunch_all_files\n"));
191 DPRINTF((stderr, "generate_ordering\n"));
197 * initialise various variables.
203 fn_head = &fn_head_s;
205 provide_hash = &provide_hash_s;
206 Hash_InitTable(provide_hash, file_count);
209 /* generic function to insert a new strnodelist element */
211 strnode_add(strnodelist **listp, char *s, filenode *fnode)
215 ent = emalloc(sizeof *ent + strlen(s));
223 * below are the functions that deal with creating the lists
224 * from the filename's given and the dependancies and provisions
225 * in each of these files. no ordering or checking is done here.
229 * we have a new filename, create a new filenode structure.
230 * fill in the bits, and put it in the filenode linked list
233 filenode_new(char *filename)
237 temp = emalloc(sizeof(*temp));
238 memset(temp, 0, sizeof(*temp));
239 temp->filename = estrdup(filename);
240 temp->req_list = NULL;
241 temp->prov_list = NULL;
242 temp->keyword_list = NULL;
243 temp->in_progress = RESET;
245 * link the filenode into the list of filenodes.
246 * note that the double linking means we can delete a
247 * filenode without searching for where it belongs.
249 temp->next = fn_head->next;
250 if (temp->next != NULL)
251 temp->next->last = temp;
252 temp->last = fn_head;
253 fn_head->next = temp;
258 * add a requirement to a filenode.
261 add_require(filenode *fnode, char *s)
267 entry = Hash_CreateEntry(provide_hash, s, &new);
269 Hash_SetValue(entry, NULL);
270 rnode = emalloc(sizeof(*rnode));
271 rnode->entry = entry;
272 rnode->next = fnode->req_list;
273 fnode->req_list = rnode;
277 * add a provision to a filenode. if this provision doesn't
278 * have a head node, create one here.
281 add_provide(filenode *fnode, char *s)
285 provnode *pnode, *head;
288 entry = Hash_CreateEntry(provide_hash, s, &new);
289 head = Hash_GetValue(entry);
291 /* create a head node if necessary. */
293 head = emalloc(sizeof(*head));
295 head->in_progress = RESET;
297 head->last = head->next = NULL;
298 Hash_SetValue(entry, head);
302 * Don't warn about this. We want to be able to support
303 * scripts that do two complex things:
305 * - Two independent scripts which both provide the
306 * same thing. Both scripts must be executed in
307 * any order to meet the barrier. An example:
319 * - Two interdependent scripts which both provide the
320 * same thing. Both scripts must be executed in
321 * graph order to meet the barrier. An example:
325 * PROVIDE: nameservice dnscache
330 * PROVIDE: nameservice nscd
334 warnx("file `%s' provides `%s'.", fnode->filename, s);
335 warnx("\tpreviously seen in `%s'.",
336 head->next->fnode->filename);
340 pnode = emalloc(sizeof(*pnode));
342 pnode->in_progress = RESET;
343 pnode->fnode = fnode;
344 pnode->next = head->next;
347 if (pnode->next != NULL)
348 pnode->next->last = pnode;
350 f_pnode = emalloc(sizeof(*f_pnode));
351 f_pnode->pnode = pnode;
352 f_pnode->next = fnode->prov_list;
353 fnode->prov_list = f_pnode;
357 * put the BEFORE: lines to a list and handle them later.
360 add_before(filenode *fnode, char *s)
364 bf_ent = emalloc(sizeof *bf_ent + strlen(s));
365 bf_ent->node = fnode;
366 strcpy(bf_ent->s, s);
367 bf_ent->next = bl_list;
372 * add a key to a filenode.
375 add_keyword(filenode *fnode, char *s)
378 strnode_add(&fnode->keyword_list, s, fnode);
382 * loop over the rest of a REQUIRE line, giving each word to
383 * add_require() to do the real work.
386 parse_require(filenode *node, char *buffer)
390 while ((s = strsep(&buffer, " \t\n")) != NULL)
392 add_require(node, s);
396 * loop over the rest of a PROVIDE line, giving each word to
397 * add_provide() to do the real work.
400 parse_provide(filenode *node, char *buffer)
404 while ((s = strsep(&buffer, " \t\n")) != NULL)
406 add_provide(node, s);
410 * loop over the rest of a BEFORE line, giving each word to
411 * add_before() to do the real work.
414 parse_before(filenode *node, char *buffer)
418 while ((s = strsep(&buffer, " \t\n")) != NULL)
424 * loop over the rest of a KEYWORD line, giving each word to
425 * add_keyword() to do the real work.
428 parse_keywords(filenode *node, char *buffer)
432 while ((s = strsep(&buffer, " \t\n")) != NULL)
434 add_keyword(node, s);
438 * given a file name, create a filenode for it, read in lines looking
439 * for provision and requirement lines, building the graphs as needed.
442 crunch_file(char *filename)
446 int require_flag, provide_flag, before_flag, keywords_flag;
447 enum { BEFORE_PARSING, PARSING, PARSING_DONE } state;
449 char delims[3] = { '\\', '\\', '\0' };
452 if ((fp = fopen(filename, "r")) == NULL) {
453 warn("could not open %s", filename);
457 if (fstat(fileno(fp), &st) == -1) {
458 warn("could not stat %s", filename);
463 if (!S_ISREG(st.st_mode)) {
465 warnx("%s is not a file", filename);
471 node = filenode_new(filename);
474 * we don't care about length, line number, don't want # for comments,
477 for (state = BEFORE_PARSING; state != PARSING_DONE &&
478 (buf = fparseln(fp, NULL, NULL, delims, 0)) != NULL; free(buf)) {
479 require_flag = provide_flag = before_flag = keywords_flag = 0;
480 if (strncmp(REQUIRE_STR, buf, REQUIRE_LEN) == 0)
481 require_flag = REQUIRE_LEN;
482 else if (strncmp(REQUIRES_STR, buf, REQUIRES_LEN) == 0)
483 require_flag = REQUIRES_LEN;
484 else if (strncmp(PROVIDE_STR, buf, PROVIDE_LEN) == 0)
485 provide_flag = PROVIDE_LEN;
486 else if (strncmp(PROVIDES_STR, buf, PROVIDES_LEN) == 0)
487 provide_flag = PROVIDES_LEN;
488 else if (strncmp(BEFORE_STR, buf, BEFORE_LEN) == 0)
489 before_flag = BEFORE_LEN;
490 else if (strncmp(KEYWORD_STR, buf, KEYWORD_LEN) == 0)
491 keywords_flag = KEYWORD_LEN;
492 else if (strncmp(KEYWORDS_STR, buf, KEYWORDS_LEN) == 0)
493 keywords_flag = KEYWORDS_LEN;
495 if (state == PARSING)
496 state = PARSING_DONE;
502 parse_require(node, buf + require_flag);
503 else if (provide_flag)
504 parse_provide(node, buf + provide_flag);
505 else if (before_flag)
506 parse_before(node, buf + before_flag);
507 else if (keywords_flag)
508 parse_keywords(node, buf + keywords_flag);
514 make_fake_provision(filenode *node)
518 provnode *head, *pnode;
524 snprintf(buffer, sizeof buffer, "fake_prov_%08d", i++);
525 entry = Hash_CreateEntry(provide_hash, buffer, &new);
527 head = emalloc(sizeof(*head));
529 head->in_progress = RESET;
531 head->last = head->next = NULL;
532 Hash_SetValue(entry, head);
534 pnode = emalloc(sizeof(*pnode));
536 pnode->in_progress = RESET;
538 pnode->next = head->next;
541 if (pnode->next != NULL)
542 pnode->next->last = pnode;
544 f_pnode = emalloc(sizeof(*f_pnode));
545 f_pnode->pnode = pnode;
546 f_pnode->next = node->prov_list;
547 node->prov_list = f_pnode;
553 * go through the BEFORE list, inserting requirements into the graph(s)
554 * as required. in the before list, for each entry B, we have a file F
555 * and a string S. we create a "fake" provision (P) that F provides.
556 * for each entry in the provision list for S, add a requirement to
557 * that provisions filenode for P.
562 Hash_Entry *entry, *fake_prov_entry;
568 while (bl_list != NULL) {
571 fake_prov_entry = make_fake_provision(bl_list->node);
573 entry = Hash_CreateEntry(provide_hash, bl_list->s, &new);
575 warnx("file `%s' is before unknown provision `%s'", bl_list->node->filename, bl_list->s);
577 for (pnode = Hash_GetValue(entry); pnode; pnode = pnode->next) {
581 rnode = emalloc(sizeof(*rnode));
582 rnode->entry = fake_prov_entry;
583 rnode->next = pnode->fnode->req_list;
584 pnode->fnode->req_list = rnode;
593 * loop over all the files calling crunch_file() on them to do the
594 * real work. after we have built all the nodes, insert the BEFORE:
595 * lines into graph(s).
598 crunch_all_files(void)
602 for (i = 0; i < file_count; i++)
603 crunch_file(file_list[i]);
608 * below are the functions that traverse the graphs we have built
609 * finding out the desired ordering, printing each file in turn.
610 * if missing requirements, or cyclic graphs are detected, a
611 * warning will be issued, and we will continue on..
615 * given a requirement node (in a filename) we attempt to satisfy it.
616 * we do some sanity checking first, to ensure that we have providers,
617 * aren't already satisfied and aren't already being satisfied (ie,
618 * cyclic). if we pass all this, we loop over the provision list
619 * calling do_file() (enter recursion) for each filenode in this
623 satisfy_req(f_reqnode *rnode, char *filename)
628 entry = rnode->entry;
629 head = Hash_GetValue(entry);
632 warnx("requirement `%s' in file `%s' has no providers.",
633 Hash_GetKey(entry), filename);
638 /* return if the requirement is already satisfied. */
639 if (head->next == NULL)
643 * if list is marked as in progress,
644 * print that there is a circular dependency on it and abort
646 if (head->in_progress == SET) {
647 warnx("Circular dependency on provision `%s' in file `%s'.",
648 Hash_GetKey(entry), filename);
653 head->in_progress = SET;
656 * while provision_list is not empty
657 * do_file(first_member_of(provision_list));
659 while (head->next != NULL)
660 do_file(head->next->fnode);
664 skip_ok(filenode *fnode)
669 for (s = skip_list; s; s = s->next)
670 for (k = fnode->keyword_list; k; k = k->next)
671 if (strcmp(k->s, s->s) == 0)
678 keep_ok(filenode *fnode)
683 for (s = keep_list; s; s = s->next)
684 for (k = fnode->keyword_list; k; k = k->next)
685 if (strcmp(k->s, s->s) == 0)
688 /* an empty keep_list means every one */
693 * given a filenode, we ensure we are not a cyclic graph. if this
694 * is ok, we loop over the filenodes requirements, calling satisfy_req()
695 * for each of them.. once we have done this, remove this filenode
696 * from each provision table, as we are now done.
698 * NOTE: do_file() is called recursively from several places and cannot
699 * safely free() anything related to items that may be recursed on.
700 * Circular dependancies will cause problems if we do.
703 do_file(filenode *fnode)
705 f_reqnode *r, *r_tmp;
706 f_provnode *p, *p_tmp;
710 DPRINTF((stderr, "do_file on %s.\n", fnode->filename));
713 * if fnode is marked as in progress,
714 * print that fnode; is circularly depended upon and abort.
716 if (fnode->in_progress == SET) {
717 warnx("Circular dependency on file `%s'.",
719 was_set = exit_code = 1;
724 fnode->in_progress = SET;
727 * for each requirement of fnode -> r
728 * satisfy_req(r, filename)
733 satisfy_req(r, fnode->filename);
740 fnode->req_list = NULL;
743 * for each provision of fnode -> p
744 * remove fnode from provision list for p in hash table
746 p = fnode->prov_list;
750 if (pnode->next != NULL) {
751 pnode->next->last = pnode->last;
753 if (pnode->last != NULL) {
754 pnode->last->next = pnode->next;
760 fnode->prov_list = NULL;
763 DPRINTF((stderr, "next do: "));
765 /* if we were already in progress, don't print again */
766 if (was_set == 0 && skip_ok(fnode) && keep_ok(fnode))
767 printf("%s\n", fnode->filename);
769 if (fnode->next != NULL) {
770 fnode->next->last = fnode->last;
772 if (fnode->last != NULL) {
773 fnode->last->next = fnode->next;
776 DPRINTF((stderr, "nuking %s\n", fnode->filename));
779 free(fnode->filename);
786 generate_ordering(void)
790 * while there remain undone files{f},
791 * pick an arbitrary f, and do_file(f)
792 * Note that the first file in the file list is perfectly
793 * arbitrary, and easy to find, so we use that.
797 * N.B.: the file nodes "self delete" after they execute, so
798 * after each iteration of the loop, the head will be pointing
799 * to something totally different. The loop ends up being
800 * executed only once for every strongly connected set of
803 while (fn_head->next != NULL) {
804 DPRINTF((stderr, "generate on %s\n", fn_head->next->filename));
805 do_file(fn_head->next);