2 * Copyright (c) 1998, 1999 Matthew R. Green
5 * Perry E. Metzger. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed for the NetBSD Project
18 * by Perry E. Metzger.
19 * 4. The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 * $NetBSD: rcorder.c,v 1.7 2000/08/04 07:33:55 enami Exp $
36 #include <sys/types.h>
51 # define DPRINTF(args) if (debug) { fflush(stdout); fprintf args; }
53 # define DPRINTF(args)
58 #define REQUIRE_STR "# REQUIRE:"
59 #define REQUIRE_LEN (sizeof(REQUIRE_STR) - 1)
60 #define REQUIRES_STR "# REQUIRES:"
61 #define REQUIRES_LEN (sizeof(REQUIRES_STR) - 1)
62 #define PROVIDE_STR "# PROVIDE:"
63 #define PROVIDE_LEN (sizeof(PROVIDE_STR) - 1)
64 #define PROVIDES_STR "# PROVIDES:"
65 #define PROVIDES_LEN (sizeof(PROVIDES_STR) - 1)
66 #define BEFORE_STR "# BEFORE:"
67 #define BEFORE_LEN (sizeof(BEFORE_STR) - 1)
68 #define KEYWORD_STR "# KEYWORD:"
69 #define KEYWORD_LEN (sizeof(KEYWORD_STR) - 1)
70 #define KEYWORDS_STR "# KEYWORDS:"
71 #define KEYWORDS_LEN (sizeof(KEYWORDS_STR) - 1)
84 Hash_Table provide_hash_s
, *provide_hash
;
86 typedef struct provnode provnode
;
87 typedef struct filenode filenode
;
88 typedef struct f_provnode f_provnode
;
89 typedef struct f_reqnode f_reqnode
;
90 typedef struct strnodelist strnodelist
;
96 provnode
*next
, *last
;
119 filenode
*next
, *last
;
121 f_provnode
*prov_list
;
122 strnodelist
*keyword_list
;
125 filenode fn_head_s
, *fn_head
;
127 strnodelist
*bl_list
;
128 strnodelist
*keep_list
;
129 strnodelist
*skip_list
;
130 strnodelist
*onetime_list
;
132 void do_file(filenode
*fnode
);
133 void strnode_add(strnodelist
**, char *, filenode
*);
134 int skip_ok(filenode
*fnode
);
135 int keep_ok(filenode
*fnode
);
136 void satisfy_req(f_reqnode
*rnode
, char *filename
);
137 void crunch_file(char *);
138 void parse_require(filenode
*, char *);
139 void parse_provide(filenode
*, char *);
140 void parse_before(filenode
*, char *);
141 void parse_keywords(filenode
*, char *);
142 filenode
*filenode_new(char *);
143 void add_require(filenode
*, char *);
144 void add_provide(filenode
*, char *);
145 void add_before(filenode
*, char *);
146 void add_keyword(filenode
*, char *);
147 void insert_before(void);
148 Hash_Entry
*make_fake_provision(filenode
*);
149 void crunch_all_files(void);
150 void initialize(void);
151 void generate_ordering(void);
154 main(int argc
, char **argv
)
158 while ((ch
= getopt(argc
, argv
, "dpk:s:o:")) != -1)
164 warnx("debugging not compiled in, -d ignored");
168 strnode_add(&keep_list
, optarg
, 0);
171 strnode_add(&skip_list
, optarg
, 0);
174 strnode_add(&onetime_list
, optarg
, 0);
180 /* XXX should crunch it? */
189 DPRINTF((stderr
, "parse_args\n"));
191 DPRINTF((stderr
, "initialize\n"));
193 DPRINTF((stderr
, "crunch_all_files\n"));
195 DPRINTF((stderr
, "generate_ordering\n"));
201 * initialise various variables.
207 fn_head
= &fn_head_s
;
209 provide_hash
= &provide_hash_s
;
210 Hash_InitTable(provide_hash
, file_count
);
213 /* generic function to insert a new strnodelist element */
215 strnode_add(strnodelist
**listp
, char *s
, filenode
*fnode
)
219 ent
= emalloc(sizeof *ent
+ strlen(s
));
227 * below are the functions that deal with creating the lists
228 * from the filename's given and the dependancies and provisions
229 * in each of these files. no ordering or checking is done here.
233 * we have a new filename, create a new filenode structure.
234 * fill in the bits, and put it in the filenode linked list
237 filenode_new(char *filename
)
241 temp
= emalloc(sizeof(*temp
));
242 memset(temp
, 0, sizeof(*temp
));
243 temp
->filename
= estrdup(filename
);
244 temp
->req_list
= NULL
;
245 temp
->prov_list
= NULL
;
246 temp
->keyword_list
= NULL
;
247 temp
->in_progress
= RESET
;
249 * link the filenode into the list of filenodes.
250 * note that the double linking means we can delete a
251 * filenode without searching for where it belongs.
253 temp
->next
= fn_head
->next
;
254 if (temp
->next
!= NULL
)
255 temp
->next
->last
= temp
;
256 temp
->last
= fn_head
;
257 fn_head
->next
= temp
;
262 * add a requirement to a filenode.
265 add_require(filenode
*fnode
, char *s
)
271 entry
= Hash_CreateEntry(provide_hash
, s
, &new);
273 Hash_SetValue(entry
, NULL
);
274 rnode
= emalloc(sizeof(*rnode
));
275 rnode
->entry
= entry
;
276 rnode
->next
= fnode
->req_list
;
277 fnode
->req_list
= rnode
;
281 * add a provision to a filenode. if this provision doesn't
282 * have a head node, create one here.
285 add_provide(filenode
*fnode
, char *s
)
289 provnode
*pnode
, *head
;
292 entry
= Hash_CreateEntry(provide_hash
, s
, &new);
293 head
= Hash_GetValue(entry
);
295 /* create a head node if necessary. */
297 head
= emalloc(sizeof(*head
));
299 head
->in_progress
= RESET
;
301 head
->last
= head
->next
= NULL
;
302 Hash_SetValue(entry
, head
);
306 * Don't warn about this. We want to be able to support
307 * scripts that do two complex things:
309 * - Two independent scripts which both provide the
310 * same thing. Both scripts must be executed in
311 * any order to meet the barrier. An example:
323 * - Two interdependent scripts which both provide the
324 * same thing. Both scripts must be executed in
325 * graph order to meet the barrier. An example:
329 * PROVIDE: nameservice dnscache
334 * PROVIDE: nameservice nscd
338 warnx("file `%s' provides `%s'.", fnode
->filename
, s
);
339 warnx("\tpreviously seen in `%s'.",
340 head
->next
->fnode
->filename
);
344 pnode
= emalloc(sizeof(*pnode
));
346 pnode
->in_progress
= RESET
;
347 pnode
->fnode
= fnode
;
348 pnode
->next
= head
->next
;
350 pnode
->name
= strdup(s
);
352 if (pnode
->next
!= NULL
)
353 pnode
->next
->last
= pnode
;
355 f_pnode
= emalloc(sizeof(*f_pnode
));
356 f_pnode
->pnode
= pnode
;
357 f_pnode
->next
= fnode
->prov_list
;
358 fnode
->prov_list
= f_pnode
;
362 * put the BEFORE: lines to a list and handle them later.
365 add_before(filenode
*fnode
, char *s
)
369 bf_ent
= emalloc(sizeof *bf_ent
+ strlen(s
));
370 bf_ent
->node
= fnode
;
371 strcpy(bf_ent
->s
, s
);
372 bf_ent
->next
= bl_list
;
377 * add a key to a filenode.
380 add_keyword(filenode
*fnode
, char *s
)
383 strnode_add(&fnode
->keyword_list
, s
, fnode
);
387 * loop over the rest of a REQUIRE line, giving each word to
388 * add_require() to do the real work.
391 parse_require(filenode
*node
, char *buffer
)
395 while ((s
= strsep(&buffer
, " \t\n")) != NULL
)
397 add_require(node
, s
);
401 * loop over the rest of a PROVIDE line, giving each word to
402 * add_provide() to do the real work.
405 parse_provide(filenode
*node
, char *buffer
)
409 while ((s
= strsep(&buffer
, " \t\n")) != NULL
)
411 add_provide(node
, s
);
415 * loop over the rest of a BEFORE line, giving each word to
416 * add_before() to do the real work.
419 parse_before(filenode
*node
, char *buffer
)
423 while ((s
= strsep(&buffer
, " \t\n")) != NULL
)
429 * loop over the rest of a KEYWORD line, giving each word to
430 * add_keyword() to do the real work.
433 parse_keywords(filenode
*node
, char *buffer
)
437 while ((s
= strsep(&buffer
, " \t\n")) != NULL
)
439 add_keyword(node
, s
);
443 * given a file name, create a filenode for it, read in lines looking
444 * for provision and requirement lines, building the graphs as needed.
447 crunch_file(char *filename
)
451 int require_flag
, provide_flag
, before_flag
, keywords_flag
;
452 enum { BEFORE_PARSING
, PARSING
, PARSING_DONE
} state
;
454 char delims
[3] = { '\\', '\\', '\0' };
457 if ((fp
= fopen(filename
, "r")) == NULL
) {
458 warn("could not open %s", filename
);
462 if (fstat(fileno(fp
), &st
) == -1) {
463 warn("could not stat %s", filename
);
468 if (!S_ISREG(st
.st_mode
)) {
470 warnx("%s is not a file", filename
);
476 node
= filenode_new(filename
);
479 * we don't care about length, line number, don't want # for comments,
482 for (state
= BEFORE_PARSING
; state
!= PARSING_DONE
&&
483 (buf
= fparseln(fp
, NULL
, NULL
, delims
, 0)) != NULL
; free(buf
)) {
484 require_flag
= provide_flag
= before_flag
= keywords_flag
= 0;
485 if (strncmp(REQUIRE_STR
, buf
, REQUIRE_LEN
) == 0)
486 require_flag
= REQUIRE_LEN
;
487 else if (strncmp(REQUIRES_STR
, buf
, REQUIRES_LEN
) == 0)
488 require_flag
= REQUIRES_LEN
;
489 else if (strncmp(PROVIDE_STR
, buf
, PROVIDE_LEN
) == 0)
490 provide_flag
= PROVIDE_LEN
;
491 else if (strncmp(PROVIDES_STR
, buf
, PROVIDES_LEN
) == 0)
492 provide_flag
= PROVIDES_LEN
;
493 else if (strncmp(BEFORE_STR
, buf
, BEFORE_LEN
) == 0)
494 before_flag
= BEFORE_LEN
;
495 else if (strncmp(KEYWORD_STR
, buf
, KEYWORD_LEN
) == 0)
496 keywords_flag
= KEYWORD_LEN
;
497 else if (strncmp(KEYWORDS_STR
, buf
, KEYWORDS_LEN
) == 0)
498 keywords_flag
= KEYWORDS_LEN
;
500 if (state
== PARSING
)
501 state
= PARSING_DONE
;
507 parse_require(node
, buf
+ require_flag
);
508 else if (provide_flag
)
509 parse_provide(node
, buf
+ provide_flag
);
510 else if (before_flag
)
511 parse_before(node
, buf
+ before_flag
);
512 else if (keywords_flag
)
513 parse_keywords(node
, buf
+ keywords_flag
);
519 make_fake_provision(filenode
*node
)
523 provnode
*head
, *pnode
;
529 snprintf(buffer
, sizeof buffer
, "fake_prov_%08d", i
++);
530 entry
= Hash_CreateEntry(provide_hash
, buffer
, &new);
532 head
= emalloc(sizeof(*head
));
534 head
->in_progress
= RESET
;
536 head
->last
= head
->next
= NULL
;
537 Hash_SetValue(entry
, head
);
539 pnode
= emalloc(sizeof(*pnode
));
541 pnode
->in_progress
= RESET
;
543 pnode
->next
= head
->next
;
545 pnode
->name
= strdup(buffer
);
547 if (pnode
->next
!= NULL
)
548 pnode
->next
->last
= pnode
;
550 f_pnode
= emalloc(sizeof(*f_pnode
));
551 f_pnode
->pnode
= pnode
;
552 f_pnode
->next
= node
->prov_list
;
553 node
->prov_list
= f_pnode
;
559 * go through the BEFORE list, inserting requirements into the graph(s)
560 * as required. in the before list, for each entry B, we have a file F
561 * and a string S. we create a "fake" provision (P) that F provides.
562 * for each entry in the provision list for S, add a requirement to
563 * that provisions filenode for P.
568 Hash_Entry
*entry
, *fake_prov_entry
;
574 while (bl_list
!= NULL
) {
577 fake_prov_entry
= make_fake_provision(bl_list
->node
);
579 entry
= Hash_CreateEntry(provide_hash
, bl_list
->s
, &new);
580 if (new == 1 && !provide
)
581 warnx("file `%s' is before unknown provision `%s'", bl_list
->node
->filename
, bl_list
->s
);
583 for (pnode
= Hash_GetValue(entry
); pnode
; pnode
= pnode
->next
) {
587 rnode
= emalloc(sizeof(*rnode
));
588 rnode
->entry
= fake_prov_entry
;
589 rnode
->next
= pnode
->fnode
->req_list
;
590 pnode
->fnode
->req_list
= rnode
;
599 * loop over all the files calling crunch_file() on them to do the
600 * real work. after we have built all the nodes, insert the BEFORE:
601 * lines into graph(s).
604 crunch_all_files(void)
608 for (i
= 0; i
< file_count
; i
++)
609 crunch_file(file_list
[i
]);
614 * below are the functions that traverse the graphs we have built
615 * finding out the desired ordering, printing each file in turn.
616 * if missing requirements, or cyclic graphs are detected, a
617 * warning will be issued, and we will continue on..
621 * given a requirement node (in a filename) we attempt to satisfy it.
622 * we do some sanity checking first, to ensure that we have providers,
623 * aren't already satisfied and aren't already being satisfied (ie,
624 * cyclic). if we pass all this, we loop over the provision list
625 * calling do_file() (enter recursion) for each filenode in this
629 satisfy_req(f_reqnode
*rnode
, char *filename
)
634 entry
= rnode
->entry
;
635 head
= Hash_GetValue(entry
);
638 warnx("requirement `%s' in file `%s' has no providers.",
639 Hash_GetKey(entry
), filename
);
644 /* return if the requirement is already satisfied. */
645 if (head
->next
== NULL
)
649 * if list is marked as in progress,
650 * print that there is a circular dependency on it and abort
652 if (head
->in_progress
== SET
) {
653 warnx("Circular dependency on provision `%s' in file `%s'.",
654 Hash_GetKey(entry
), filename
);
659 head
->in_progress
= SET
;
662 * while provision_list is not empty
663 * do_file(first_member_of(provision_list));
665 while (head
->next
!= NULL
)
666 do_file(head
->next
->fnode
);
670 skip_ok(filenode
*fnode
)
675 for (s
= skip_list
; s
; s
= s
->next
)
676 for (k
= fnode
->keyword_list
; k
; k
= k
->next
)
677 if (strcmp(k
->s
, s
->s
) == 0)
684 keep_ok(filenode
*fnode
)
689 for (s
= keep_list
; s
; s
= s
->next
)
690 for (k
= fnode
->keyword_list
; k
; k
= k
->next
)
691 if (strcmp(k
->s
, s
->s
) == 0)
694 /* an empty keep_list means every one */
699 * given a filenode, we ensure we are not a cyclic graph. if this
700 * is ok, we loop over the filenodes requirements, calling satisfy_req()
701 * for each of them.. once we have done this, remove this filenode
702 * from each provision table, as we are now done.
704 * NOTE: do_file() is called recursively from several places and cannot
705 * safely free() anything related to items that may be recursed on.
706 * Circular dependancies will cause problems if we do.
709 do_file(filenode
*fnode
)
712 /*f_reqnode *r_tmp;*/
713 f_provnode
*p
, *p_tmp
;
717 DPRINTF((stderr
, "do_file on %s.\n", fnode
->filename
));
720 * if fnode is marked as in progress,
721 * print that fnode; is circularly depended upon and abort.
723 if (fnode
->in_progress
== SET
) {
724 warnx("Circular dependency on file `%s'.",
726 was_set
= exit_code
= 1;
731 fnode
->in_progress
= SET
;
734 * for each requirement of fnode -> r
735 * satisfy_req(r, filename)
740 satisfy_req(r
, fnode
->filename
);
744 fnode
->req_list
= NULL
;
747 * for each provision of fnode -> p
748 * remove fnode from provision list for p in hash table
750 p
= fnode
->prov_list
;
754 if (pnode
->next
!= NULL
) {
755 pnode
->next
->last
= pnode
->last
;
757 if (pnode
->last
!= NULL
) {
758 pnode
->last
->next
= pnode
->next
;
764 fnode
->prov_list
= NULL
;
767 DPRINTF((stderr
, "next do: "));
769 /* if we were already in progress, don't print again */
770 if (was_set
== 0 && skip_ok(fnode
) && keep_ok(fnode
))
771 printf("%s\n", fnode
->filename
);
773 if (fnode
->next
!= NULL
) {
774 fnode
->next
->last
= fnode
->last
;
776 if (fnode
->last
!= NULL
) {
777 fnode
->last
->next
= fnode
->next
;
780 DPRINTF((stderr
, "nuking %s\n", fnode
->filename
));
781 /*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
805 * List all keywords provided by the listed files
810 for (file
= fn_head
->next
; file
; file
= file
->next
) {
811 for (f_prov
= file
->prov_list
; f_prov
; f_prov
= f_prov
->next
) {
812 if (strncmp(f_prov
->pnode
->name
, "fake_", 5) != 0)
813 printf("%s\n", f_prov
->pnode
->name
);
816 } else if (onetime_list
) {
818 * Only list dependanacies required to start particular
825 for (scan
= onetime_list
; scan
; scan
= scan
->next
) {
826 for (file
= fn_head
->next
; file
; file
= file
->next
) {
827 for (f_prov
= file
->prov_list
; f_prov
; f_prov
= f_prov
->next
) {
828 if (strcmp(scan
->s
, f_prov
->pnode
->name
) == 0) {
838 while (fn_head
->next
!= NULL
) {
839 DPRINTF((stderr
, "generate on %s\n", fn_head
->next
->filename
));
840 do_file(fn_head
->next
);