BIND 10 trac547, updated. 7fa757c0318ac40d78a88c31ffbf2a3d32292c6c Merge branch 'trac547' of ssh://bind10.isc.org/var/bind10/git/bind10 into trac547
BIND 10 source code commits
bind10-changes at lists.isc.org
Tue Mar 8 00:53:52 UTC 2011
The branch, trac547 has been updated
via 7fa757c0318ac40d78a88c31ffbf2a3d32292c6c (commit)
via 9cc7ba7d0f50343dfacfb0d2e5721ef70ae79a19 (commit)
via c90a3505687965368aa9651021e6bc8881c93bb5 (commit)
via 115d5f517ec3edc5c55838bc13272a952276d2ed (commit)
via f2d89900b8c767c4753c62cd13a8c76a5b49ee04 (commit)
via fa2449830ad1233b2b4c09a66b63d6c07e550942 (commit)
via fedd65092f4a821f7dfad997ae5bd6ae8895d19b (commit)
via c0f01437d2bc929ca2d5ee5b911e670f5ad72e9f (commit)
via 1b61922320ddd0502772850292dc7b9a7eb039aa (commit)
via 000f720401ac1438b79c4ee01533e1ec519daeb4 (commit)
via 78633ca5fac57b0df6878e76837914c8348c76e9 (commit)
via f608f499e7c674efc744a483ce63712c6539b7c9 (commit)
via 2eb5b1d97ecda703cd507ad42c6974d6cf1283d3 (commit)
via 0125d6f9ec42ea97ce9b3fd4c0b3107588ee0440 (commit)
via 2974c62be639161fb6b26ecfc25335b1f87995b9 (commit)
via aedbebba16f0197b05fc00a3aae37fa939f653b1 (commit)
via 4311bc125b23c27f413b35958f353a96b207dba1 (commit)
via bcffc57fca8edde93455d5b38de184629aca94d8 (commit)
via c0f466ccc9784de00ca8fd251d2c7c0508d8abf2 (commit)
via 974f274c2843709b7b60b49a2a29fea84d085a23 (commit)
via 33a8c3076c4d14ea7349312cec46a9f5fe5f8bac (commit)
via c83d8c30853f4a1dd41821acdec7147633e64a05 (commit)
via cee80c373192fb23e8552ee309b5da88d0d5d7a8 (commit)
via ad146024dfd4ed0ef84d79431eb3d38db29584ea (commit)
via feb88922e55f03a8c0774b9be8e6cfca1769236f (commit)
via d13e5d9b35c08a9d9b06281ebabbb97cead789b9 (commit)
via 947a781b99e1fc20745be6d7d7214dd4fc15da19 (commit)
via 3bad3036df1b8e8297e350eca468d818d8e52f1c (commit)
via 3eb010149bcca1bb30fb7e7bcd366b883f17aa78 (commit)
via 9cdeaf91cb2032cabfc4c37779ab49c4639c0cf1 (commit)
via 9fed238ba71bb95c9598004652dcb62b00cbbf7a (commit)
via d20617367cff2a3a830cad059edf4039a137dfc1 (commit)
via 9881083dc71093d56643b347f34a5403bfcc72da (commit)
via 96fafe5598fa4fb7272bc9e6524934740896101c (commit)
via 134ae031b57e042c44136292d462b7c58b146ad1 (commit)
via bbe7747b959c88eea8ae3e6e558001abd741559e (commit)
via 7fe7b83f8f7f4a15efef41d5c1950de0e0181a1d (commit)
via 5aa235b1b4e1cb5c529b3d48c1d184f613ddf181 (commit)
via 1453ae34f134c5cdfd089437400fb0f848c99994 (commit)
via 0564f77ee1efb24f25c078fc69c2218428175e1f (commit)
via 1ec37962fd9cca0401a653bbed98f1da5e00ea71 (commit)
via f8d38b2d2e2c6fd93027f414132e881fc55d4192 (commit)
via a34caa759a881b06443f613b7242f26f57412792 (commit)
via 9badce6f07064efe0afd25f70bc650992331f30d (commit)
via 8c10b819856a2c05e5fa49f6c2a293a51b015caf (commit)
via 02eba6203ce3c280a48dc70695e7f953bbd497e4 (commit)
via 7536f2791cf5e7f3df5f8243ce196ecb2e841bd0 (commit)
via 061ce0be909574669959c3ba4943d8c4ef85d798 (commit)
via fa8d22bae415d17c5e2982764619d6048a34bf2a (commit)
via b3c386d0e03b917eecbf08dab2c196634ee5a6d1 (commit)
via a484448ed3ed5b754fbc68e14ed055d3c22f8dc9 (commit)
via 77b533cb39350632632e27726775d25e3af81ea1 (commit)
via e80b8485aeedf21c1d4376fd96f274b615a3a208 (commit)
via 2085c06c7e17cedbe342eb6b5f01dd10c446f544 (commit)
via 94b2fcd12bbf4ce4f62025b93b1ad4d934bed723 (commit)
via 52fa2af94be9bfb11a97e326314ea49f9a7ee1f7 (commit)
via 4b9dfed12d04f40d3c5aa9eaefb189979f46d980 (commit)
via e8d57bdfb45d053dd1292dafd0c17d2e7d17129d (commit)
via 8686101e19aa3e98a6eb8447c1c4e88ce7914487 (commit)
via 578d0587ae756c16333cd439406c0f2e4dc0817f (commit)
via 372d7e3fca653ba5470bd6a8aef708904dfa2feb (commit)
via 8c0c020c0578814c5632933827a30c20a1ad6441 (commit)
via 76cfbdb23966c082a37734d09789df4f958139dd (commit)
via f14d6a560d668d68f9a11b0b0ebd2ad604355191 (commit)
via fd3b484a687235d849182ee80b6780d037f04597 (commit)
via 94b85f892f5a550bfbbcebbf2907527746a2e6c9 (commit)
via 7e8b395f849d977c16b4c10e8dfb265bd8ac6153 (commit)
via 4c31ef687e44726d1f986e61581fb580e133cafb (commit)
via 987161dbeb59b39571b7ade56e030aceb4c729de (commit)
via 606c271b43dadaa0dcf8e71df9c7c221e0b3076f (commit)
via eb90b10a106ff60e99fdcd1bcd2351017ed6f3fd (commit)
via 2ff3386c34e41cdc6282fe266d98c4b1f6f8de38 (commit)
via b7e8a7047affb0fc8806575a927d55433c48b0e4 (commit)
via e867ee63ed2b79bdb1a6d408214fe6d172486ce2 (commit)
via a1130969e5d3c3756ef0198b03c7579546885071 (commit)
via d86b5d60336200053663232086310815e661b09c (commit)
via ae58e18545c559b048400ab789e388b43b44e784 (commit)
via c71733afe02f9e22bb8b0f62f2a5761dc5aba07b (commit)
via cfb94665b80fdaf9bd256cb24b277de506206b29 (commit)
via 5159a714bae31e9399a9bc82c7d8b9a7515525a0 (commit)
via 7645f0efb685c61e1571132d52aa5bbda8525519 (commit)
via fe583fe386f0fff4b5160a9cb9ba5375a619cbc4 (commit)
via 94ceca2b401b38da185c6599078add082aa17429 (commit)
via ecfc195a79410e661099d7e970ebc0c33dc4e87f (commit)
via 5af02c8a8a682d97eaaf4e409155d9530a7f0af8 (commit)
via 463fc1ba644c3fc65ede9319348a655fd77b61c1 (commit)
via a7e0abbe2eba92c3f9d900865c1b0d68fe8d17f8 (commit)
via c348b858b66a08f396550d29a9aeb6ab537de4de (commit)
via 3689ac862f2953efaa6b88e2125d853d5625ce8f (commit)
via 56f5aba505ec4ecea11b22f9e590223bdce2a123 (commit)
via c8c8253fd8fa48cd042b80b69b617063fb3d4090 (commit)
via 5d1799a3c91e8d6536f9a2c0a0a3e1bd8752c058 (commit)
via 4c1e71ca596a0a5ae229ab4ec86353e6bbcaf654 (commit)
via 45d9a1b947afb473769db360a96f111f0a0f00d9 (commit)
via 4e11df4e520e76f5956733629474ca0cd86548ee (commit)
via 1cb949f9018f77a9cf15d7d85dfb2437752ebb13 (commit)
via fb0e5110d6cb2fdf38bced9de0e87b5372552236 (commit)
via 4b9a2f8a426c1355eb96fe7ddf20ceab693b8685 (commit)
via 919bb7adaee80433cf72ce784668a19975f7f04f (commit)
via a50389017dec77f3a555eb7b67504cab4957a2d2 (commit)
via 403f9037b8713da7c90c8c72b7d27bcf12960a6c (commit)
via 86d57c374d3d7dd61a756e14c566f310a963ee30 (commit)
via b9406cc0d396f99f10c494cc7e70235de6f33411 (commit)
via cead48c8e156e111fd7d65f7eb43bf0aed5ad669 (commit)
via 2495b96e3a3adeaaca091d7bf2533c1a58971ee5 (commit)
via eb6441aca464980d00e3ff827cbf4195c5a7afc5 (commit)
via 5e2e3fa2759475313d69d3f9cf1cd339f3db8bc7 (commit)
via ed6b07b60ae503e97e284eff351386ba24377981 (commit)
via 19197b5bc9f2955bd6a8ca48a2d04472ed696e81 (commit)
via fa64874fe02ff6ab8a782e0ede0d70ff2c95783e (commit)
via 44bf7654cb3ce85fe63fa47c7b39f48bb041d4de (commit)
via 1c8557996bdd428c9a3bf0935c30bf42fb167f35 (commit)
via dfbeea4eb3f414dcb66d2447e59216c23dade515 (commit)
via 54e61304131965c4a1d88c9151f8697dcbb3ce12 (commit)
via 242cb68113bd4d2c0a3ea3b61cc56e143a42b38e (commit)
via 3ffa099e0969468d0f16f00c503b8936b895a2d4 (commit)
via fa83bb99518bd8c4dede832769fe4f7a6405ea62 (commit)
via 0ca10e6357d7a41bc308f90183848ce41582adf8 (commit)
via 25a5f4ec755bc09b54410fcdff22691283147f32 (commit)
via 2275e0d7afa15b69bd7511616a6ebae0b9de0d22 (commit)
via 301da7d26d41e64d87c0cf72727f3347aa61fb40 (commit)
via eeacd1d5adeb27ee536fb04296cc20ffa898cdab (commit)
via 33cf7e5a182bc98cd168928fa8b5c775581fe90a (commit)
via 87829d23b5d698611c94ee92f758558d8ad95468 (commit)
via 996e2593c867478eec8f2b3700aa52776528394b (commit)
via 5cde27560e4b8e3cd098daae572ca4d0124358de (commit)
via 1fd5547c170550880268ba0eb83a374231be348b (commit)
via f06ce638877acf6f8e1994962bf2dbfbab029edf (commit)
via 8053d85447560fa3c64f276881496513c66f4ba0 (commit)
via 5d246e92aef87505e9392274cacbabbd20478d3e (commit)
via ae0b20c57c48c4932b9aff2146f5d76f9eff5a90 (commit)
via 0047c74393959975ffd9f75a687a60f1f1c42a9c (commit)
via 1d60afb59e9606f312caef352ecb2fe488c4e751 (commit)
via 9c22af762d0cb6cdcb0bcbcea2b302b1165a0f66 (commit)
via f9152fae80f751adc95c894b872204e98504dcb8 (commit)
via 40f87a0aa5e6b2e8f86346f181b5e1d785c36e67 (commit)
via 3d69f66a688c09a20083a52f2a64b9327ede70c6 (commit)
via 76843dc3d8538f932d58e55ab6189091cd709f48 (commit)
via 451fdd5e7209a31420d2a61df99d66d2abfe34ca (commit)
via 34066d5d8486b9d3dad08e0b13269db14a8d8aae (commit)
via 543f406610c4fc2c0236f8f9c7fdc37014937fb6 (commit)
via 42d9589eb5c3fb6dd9f1a73206510d01bb29bedc (commit)
via bb8d9d376a1e2caadfdc3631c221cb7ca118f60f (commit)
via fa05a534849c2e3ba68d6fdc4c5ddc6531948fc3 (commit)
via e55ec73b0bdcc2b7d6286c6a18886de194280947 (commit)
via 2f0de2e7a8d594fd40c4fb2449232bb5cd64efa9 (commit)
via dadeedb633df1f3793c32fa283c82f22fcdb7ff4 (commit)
via 0a9ce967a515894bd7c46cf86a6ff4bc3d856b3a (commit)
via db2594e846ccf340ed9820f049b9839231a4832b (commit)
via b973f67520682b63ef38b1451d309be9f4f4b218 (commit)
via 0de367c06c8e4c730729de446cc5c54b7cee9ea4 (commit)
via a4a2b5aba9b2b16c4aa2cc8af01c19a4b9b61aea (commit)
via be8886364d3e7466a0a5007a75df797b6839004c (commit)
via 25747d9b65fccbe5e37b4c49377382381edf1e78 (commit)
via 9186edcad7735f16c835bd845572e74f8069f2d3 (commit)
via 8c7144c6aef7eb26215f045ee95551ed7a6fe307 (commit)
via a2dbc20364f13ddd393e51e711db7e5e3bd2551f (commit)
via 529119357642023c02dc40fd3c07bd2797062ba9 (commit)
via 86355ec5ded2f1988dc466f8844360c78e8454a7 (commit)
via 09191932190ac8a64a4b77def3877fc5801d8aeb (commit)
via f79cea1f5a7ce45498a7a94cb5ed9aae6dfe1a7f (commit)
via 9e7943a5c72c19247d6ae7e7c264ef37e11d3561 (commit)
via 96c47a07bb44b6667816e576d8907fc223d1d771 (commit)
via 6458b98ea487620fd4c47b0de5b5bc2e5fe97794 (commit)
via 910df2cc9298c1c7697f6f38c303b26169e62305 (commit)
via 2bd3a99bb2580fa3c783058f490eb1c8130c65ab (commit)
via ba727c17d3517232a3c40fa3a30c6924a30ed7dc (commit)
via d3b169adf97f9c5a4990400e54562d644016fdaf (commit)
via 91193e42d664fbb494a15cdf5b01a0c5da19d0b7 (commit)
via ab86095a11e912123c40f6b41879dfa634e491a8 (commit)
via d1a73e27eb7d3c133e871809efeea5174b01a2ee (commit)
via 1022129fcea6743037ed7ae2b363b0af082afd30 (commit)
via 7de2a6f3f96d466ed24f7d8b24708a30ee679729 (commit)
via da0e644a1c4826da8587bee6fe1902a6f28e5931 (commit)
via 8f6657a13b4e6e140e3c5a52201fd4c998ee9560 (commit)
via 2e46317ec615067947983aa9ebcce371a6a8fd2f (commit)
via e5e62873bcc14a7aba87bf0bdc7d2d354aba331b (commit)
via a42df8e3040bc9cfa52aca8d45d09ef016810862 (commit)
via 5ac67ede03892a5eacf42ce3ace1e4e376164c9f (commit)
via a9e9a2b26fbe93fda5174e4482c9c13e05287539 (commit)
via f54d8505d8ac997fca63d2cd82485b19c248a804 (commit)
via 950fc0ab5f04dc55c41ad93179cc188f8695f335 (commit)
via b229aa1c060b0d3a21b3173b97c835ff10dc3b17 (commit)
via ba66913e80236f8b33afd055317fc0356580970e (commit)
via 4bdd50ce23081a45afbcb653a6b75a1b408c4e0b (commit)
via a232b085dfef35b196013423e25927cd6e230276 (commit)
via 4fa3cf5c5f623d24c357aac1d689a068528c73ce (commit)
via d3f8f8fce7957a2227dbc38d2faf58ca33f85fd1 (commit)
via 923a47079606a6ba9368d94007b3c24aaa4ca7e5 (commit)
via 6e0b7398570e219d417f991681f6d6428fb12a67 (commit)
via e8460092b6addf9ce69dddb49d80d91037178ba7 (commit)
via ddd04eed61f4945303400569629d66cf685833d2 (commit)
via add0f697aec63c9af1df661951bda2ae007c98bf (commit)
via 1a5be7480941be67947095ab12297d157f8fb572 (commit)
via 71d27e416b025bc77edd70f9e885fd804d043efd (commit)
via 89ad5194ebbbc808c7e5f317da47550e99efa9ea (commit)
via 9a75a9c73b0bb361f1952e92eb4b5a62694be4d6 (commit)
via 6fb5dd6bf0e9fcb0d00eb3f659b5b9c45340bb37 (commit)
via c3d81863bc201dc1fab9690565158b8f09d61061 (commit)
via 199599a979e331026ec5dc8ff07f1bb08f3228e9 (commit)
via d7ec12be1f1e87ca0cc4675165f126f8d010b6b3 (commit)
via 13204f9c20a03dcc041cd22fff22fb28af569eaf (commit)
via 7c9c7811d3d8642ae675073e0cf9e8b83df49c4c (commit)
via b7d8ac6afdd51bb18fcb0c1c0f7389d4975f7c54 (commit)
via 586df2b37d5f26ac1998d12c86f280b11bf077b7 (commit)
via 0ac0b4602fa30852b0d86cc3c0b4730deb1a58fe (commit)
via 40f74edaaf73a8a5a7798fd79646e2279b82b5cc (commit)
via 24ef7a16425e696fbb794605a89ff8d7bdd7172c (commit)
via 59455cd6b9de13d63c2b6cf17eb7e8c88c8a99cc (commit)
via 8a47d8d2b9123df707aebfa14141a5c11c5a6228 (commit)
via 6bdfcf31fed84b413714a0ef446578ebbb3002a9 (commit)
via 54f4650b7de4d275b29bc1d70b2cba98d59d305a (commit)
via 33deff727f64139d15f45173679fd0e73531e7da (commit)
via 354ca192db138bdd942734ff985b6e21c8445a82 (commit)
via bb708b6586815ae9ac14d99b0d4bfd714f315273 (commit)
via d3120390ae945b88432c48aa82daf90ef67f6715 (commit)
via 27025d831a4d06672458004ec70b5c2cef73904d (commit)
via 34be7c60c8cd01a3693cdc35346ea8bed77a4c88 (commit)
via 008a3bf75b8aef0b813c5109fe8749f32ca6c7a9 (commit)
via cce105f44bf716ed738a1465e5412468d796aa13 (commit)
via 57b77aa7c09f568a9adf7f9ad475cc80f278fedc (commit)
via e5961a4ce06bb430469c457856f5392ca147d857 (commit)
via 14a51327ed408ed5a957147720f7ad3e3db6a95d (commit)
via 8f331c78a07959b413f4a00e3b3f7a935cd42b2f (commit)
via 60f301c235b9d83b7fde6f06abac18d0a1168260 (commit)
via 4a8925ec51c064a456795ba17042bdf30ff2b8ab (commit)
via 0227b4b17e2bdbbf5472c145ce14f1fb08aa7791 (commit)
via 795a77a4651542f80ba8906d3f02b4987d414f79 (commit)
via 41a2bfb4045de0547186a8dca60c30314a3ae28c (commit)
via 8b41f77f0099ddc7ca7d34d39ad8c39bb1a8363c (commit)
via 34d182ec09a5674e87470772cce024d49043cbd9 (commit)
via f9e5f363f3abf3c08d65ff14421491b44ccbe8af (commit)
via e4ee8c985e9adf5f734f0f693b79fe459ef848db (commit)
via 9739cbce2eaffc7e80640db58a8513295cf684de (commit)
via 6df94e2db856c1adc020f658cc77da5edc967555 (commit)
via c6b5e0f57cb473f7e2731d8ca1d3619139263a12 (commit)
via 239114f5e894111f47dca785429a9180f2cb1598 (commit)
via 477b53cb86a431a7c38655db3972a554b412e700 (commit)
via 8ffbcda5bbf9729b9ab09d89531520c9f94618ee (commit)
via 77a02471ef75d226a6dbf7e962491fedfef6d6d9 (commit)
via 09b70f9b0f93da5c7034b02837987fc03a675472 (commit)
via de89048d524aef36e88ce770f3f953401e3a24a8 (commit)
via 94b5025336f509832addd712ed2f9f4fce48bfa4 (commit)
via 8578607b1c73c76e16a4eabd4ed45539260e0c74 (commit)
via 0503f4a60a6873d63bb1d9352c6b50a7a40130f9 (commit)
via 71c4e3cb8c0f6c4e51a8afd24928ee10710a49a2 (commit)
via bba7327c68c2242882dcaadbcae4b2db0aabedd3 (commit)
via 783c0a87b919e9d39ab271de6203bb4277758e2d (commit)
via f9be171869937e52f960568773c45cfda28baa3a (commit)
via 955a15527bec6ba0231f0bc377539a169fa34165 (commit)
via da6a33e379d7c8ad56087b9302d7dc5e6a6ed08d (commit)
via d0181f27a73dc4b77bc9c6756cb6583226dafacc (commit)
via cf131c0c98c346b2f075b76c2fc92a658eb58f1f (commit)
via dee286dad1ba1b47d89659572fc2ce8fd1a94af6 (commit)
via d22c96099aacc094be00c1fe51433d4b39b9656f (commit)
via fcb8add55e0b6d5be9104e59e4f47a6d4d4ae9c5 (commit)
via ecbfb7cf929d62a018dd4cdc7a841add3d5a35ae (commit)
via 6689f461849841d7c5a724471107f758535c213e (commit)
via 004e382616150f8a2362e94d3458b59bb2710182 (commit)
via 6dad3efd9d023633d973d20b9102f2f8b10f3d17 (commit)
via 1355eed8148ae3199e5c047c004bc8ad839ad5f8 (commit)
via 5dc6a761125d48557a13a6354a6c373607fb2714 (commit)
via 76a5b79fe8b601f5c9aeafd68394628ac9552f16 (commit)
via 64dad23b34538632b6b2724c5d6c17b295baf9f5 (commit)
via 3ebbda21d35170b26d7db65686583617c8f0cc26 (commit)
via e7a46851671cd942d39e74d0456435401dc15881 (commit)
via ba870bd64170a8533f1bbabcd6df36edf31674c5 (commit)
via 1b7e11468e670385d56d05b97afac96c4da05b9a (commit)
via f3e39622ac840f6322cbc76277b2104ba4e8aee4 (commit)
via f9ed88b3ab1f080f2e96219a70c7f6ba9026d547 (commit)
via 04934bb05de6689d170ff4d52c2518301df0f960 (commit)
via 09ece8cdd41c0f025e8b897b4883885d88d4ba5d (commit)
via 296d6b7b9b3805b5bc71ece7e3f947604c641ffb (commit)
via 14b12e16f91cca0cd7c9053727832111538ecc85 (commit)
via 0e2743485d50f8987b9d1fe959b215e49039a965 (commit)
via e62c547688f1e4820fa8ba200149ea16960354b9 (commit)
via 319debfb957641f311102739a15059f8453c54ce (commit)
via 80a4c6e866a3f40462b26260c6de1ef05a334e53 (commit)
via 67ff28d5017ac0cb38b591de079809bfe765ddd1 (commit)
via 7e90e3729b54ca18425c3b5a5223230aa335efff (commit)
via bd8392ffd8873367f243121cf1e33eb7981b4f4d (commit)
via f8f81b7f1512760cb72592a79d2f49999f11be2c (commit)
via d6f67da406651c7cc013ce28c513c23ee43e2efc (commit)
via e6e3ba735b384ebe4ee1ccacb39af2100bdd5f19 (commit)
via 301cadd12c9f4aec34835ffde2abdc808ab28936 (commit)
via fa007383d4b4d71c5a4176c4bc6e11154d662d8d (commit)
via 3a9752bd2611ce206fe0526257876ba99a640e6b (commit)
via b6b79e9a9f444e2ab6b1a53fc1597c77cbcefd61 (commit)
via d58cbd26658afd381cb715d0ca976d11006a0445 (commit)
via a37dace36f7322764bb01cc790c3f36d524c0456 (commit)
via 9136696612968df28a925c910b54217ffe84d206 (commit)
via 236adec49e83cc6f5ce85c07766fe5f553e00812 (commit)
via c9a06623e3e6041342046d52f502ce5e478ef29c (commit)
via 85b6fa72d68d019149b8c751d495e34bbd4246a8 (commit)
via a2a0bf66d71c5b5adba4a1e0dca48496bfee0ce1 (commit)
via 004816211d6b0f438713c1a4e167be8ac25a356f (commit)
via e5fb3bc1ed5f3c0aec6eb40a16c63f3d0fc6a7b2 (commit)
via c78659bd80e45ddb44b3cafb4937aa7b4e5f1b14 (commit)
via 05f49a93714de9a09ad1c0a9d6e2a7365e890232 (commit)
via 3c06d0d6c0d002138ab3edbd9a6833a40de3f911 (commit)
via 64c233aa9b565df653928f79e987ff0ffacf68af (commit)
via f8e2229b901ea731ac1fd7e7bac0799b855cd88a (commit)
via ed89ba2b9f20a5aad5f213191f9b34981aa6a0b9 (commit)
via 8ad3c81393273b291cbe8e97f9ab7c260d8ca94f (commit)
via 5cfa9db0c1eea204a2f6161c4929da4d896afb41 (commit)
via cab140484a93d9fabc4c3a108ce4770e22b08dc4 (commit)
via 1c3d1954d25eed486f1fa97d4ae5493693b04945 (commit)
via 0fac71e31d16f1cfe127d8d0341842aad762a642 (commit)
via 6f031a09a248e7684723c000f3e8cc981dcdb349 (commit)
via b3d03749ba27521a93188402c18600360e44c497 (commit)
via 500a785136096ec3a7c5259ec348a80256aed494 (commit)
via 9c690982f24fef19c747a72f43c4298333a58f48 (commit)
via ce7bc899e76309c63b1ad270b9474fdc1407cf5e (commit)
via 96c902f2ffb43d75fbd138a6da15dbbc0d80a71f (commit)
via aa32fd56bf7b4eb3f1ee13b502f2724af8f7ac4d (commit)
via d0a29d0aa3931ad8091c24665ceeee95b94d58eb (commit)
via 6750a2bb8306b0c335f12f6d1bd97c1b0559bdd7 (commit)
via dab32ddc42b4707968fbc056261c50d4fa08e408 (commit)
via 73b2eaec32ef4dbfa93bb5009229e9ca261c3676 (commit)
via 72c4f5046949567927410bdb2ccb7ecb663d16dd (commit)
via 8f777e093c960f76ff489f12684005eb48580323 (commit)
via cb2cf2013b616b055904e301b3d5ff4c49475525 (commit)
via cbc9f118a77f69878f4cebf383db39d984201bae (commit)
via 689503220317cf2e86dae704a8e660ed646af67b (commit)
via 130ba31d0829fa47a5e245490a9ae172d1c91b7c (commit)
via ae9a05a4c5d73b3d32303b622c6b7d0c04d061d3 (commit)
via 57736fd520bda626de430e55d9f7f0b1c13e6353 (commit)
via 9b9f126d3e4adc4ef7e6b61945245499745996df (commit)
via b6bce27baf454101b3755d46877ac84c5eef20f2 (commit)
via 8661db658ebec93ba0e2e890ea7db2b9fa20df4d (commit)
via 3d61dceb1a9093ab110920fb436c3b2061f15857 (commit)
via 967fe3d95663240940e2c5e653fc3ecac7739037 (commit)
via 6bbb42b7fa668d7a8fcc3cf3809365179705a3a2 (commit)
via 1e3a2586abe597550611cca5697916f311ffd2a9 (commit)
via cad6c0a62b3c5cace703d9863d64dbdb1e047046 (commit)
via 949f642c90ab8ad7f0f02c35e383b9eb9e65792a (commit)
via f59af8201a12342a2779440a4c7afed1b51fef7f (commit)
via d7a9547198d61bc455d41ba45f6f14874f05c1d5 (commit)
via 9cf88a2d14abccc7b3ad6ffd8d299dfa464bee1c (commit)
via 17832da870f12a8bfb6ec4e8f91fda964c1afcbf (commit)
via cf0dac64cd9e7f132ca58f0df3609f00d2cc4a07 (commit)
via a9944090a851bd3be8f459c7185058394d31fd55 (commit)
via 4864018bdb5a6f3f9ea9d7a9cc608521655233dd (commit)
via 310d15bf23ac533d70a20c0a881fc285cb7af3f7 (commit)
via c2a34db25f4b0c903a025514cdff758e7ea55e42 (commit)
via ad418dc7853679f1d79c280af5993b82c43dc51a (commit)
via 98908690535371b9128a1263c7a4b59150609526 (commit)
via a01b61f9915856af9c915beca5061867804e5a86 (commit)
via 5ba0bcb7d12da8e28ca791fef5bdb82ee2619fa8 (commit)
via 866ae82be92451173b08ff1135c2ffe9ce820271 (commit)
via 634dd02746cd7d5cc6c702b9a3ea690825282c22 (commit)
via 24afa6a4a2bc6d4fb4151a866cb12ff5728db277 (commit)
via 00b804d7100f12f5ea261b4dccb01f1de4cd94cc (commit)
via 75cd27c3b2d1bde61ffef18bb53198cc459910ed (commit)
via b099d028354adfd16fe3dd838f1f36f024c79f40 (commit)
via ccdb524e2fa0b9d2ce5570b73023a3f127756c76 (commit)
via dd59f2ff605abcdb0a1e8b284c219b8d788c0585 (commit)
via 42cd95d56e1f9c71eeeb107284c4762cf1a9a726 (commit)
via 7ddfd9eca150efa2fed15114034e5297db765a53 (commit)
via 1888b383084177cbfab6c408e15565a3bec17ee9 (commit)
via 73837f513323e69175abfcfd04ca2f7b1fe22a4c (commit)
via f0324078a088345812c5397317b66445b02f82be (commit)
via e01aeb058be1d8bd7715ab603c097230cd18df5a (commit)
via 841627853b192480a8e663870ad3a1cb39bb724e (commit)
via bbb0031f3a987b3314e1b3e8db1c7ca155f9f480 (commit)
via 26aae7d612bf0f01b22a7c4784fffb909d148970 (commit)
via 5266058997a5746c04db5a721ac60630bbbc2abd (commit)
via a30321812264615d0f64271ce6ba5e841f7977a5 (commit)
via 93b246f4689918c081d9ed889cea9140b75adc1f (commit)
via 297c145c01d18f73e2b453ef968426352815dda6 (commit)
via 0d1efe0f87c1868ff5389c731dbfa7ead9416655 (commit)
via 569afbc3c08776e04f1b755dce2ff5aa5c385647 (commit)
via 38778d44793426906ef7d0d25a70be4a36188765 (commit)
via e935dae553418e90ef4ac06d598da285e8b20bea (commit)
via 355e2efda4baba2827a9d95a648974ab3f5bcfa3 (commit)
via 9cdddf2713e4e4fe103cb3cdd6e9af44e827c5d8 (commit)
via 2cb4775feeb0be8174565e175c4f800899879c19 (commit)
via d74693d2cb99c839b5efdd7c1bc0188fe39bc86f (commit)
via e26d533eb62f553fcbae616d82e84e3784f750c6 (commit)
via d619eab67a0c2255f249dfabd7c9db0e5d14b833 (commit)
via 6fbb0f720f6e6a5d58c0dfc6710f0e26e79816c4 (commit)
via 76e1d3b208772073e664437788865a5e3d067a68 (commit)
via d9fda268d2fcecbb69f06f3480bc9dcd058c582e (commit)
via 17f874bb877356f0eb3c777282e1a21172a241c9 (commit)
via deedd6f7ff3339f822f9ed8de77a5a7164bda9a1 (commit)
via de81dbd26e42616b7c56718ffe1ffc7c6861b9e9 (commit)
via 406ff425ec228f5b99a61576d8a576fbc76b3122 (commit)
via ad91697c609b3ad79d8f2799a18ba63548a228a2 (commit)
via 2db67df75178a2bc407417540dde75e895eb619b (commit)
via 0da13ea71e97d62ee8cffeac9613a59f6dd07335 (commit)
via c95b25359f139a816f114378872bc08ab7e6aef2 (commit)
via 91a8eaa5b51c15b6d8f6cad3d75597678eeb03f1 (commit)
via 7f5705228eb95dba445d0d1d8297c6de0306360b (commit)
via 7abd3c8866212a9c29920ee82be7390ab2499c43 (commit)
via 3c66bce7b2da45b00fa54358ef0728c0ab2e0a71 (commit)
via a7cbba998123e58d89a9d0da2d77afa184ea357e (commit)
via 13a3b9f237b1e29489804ccb5a25612cbea511f4 (commit)
via 0c25e92e3d59db2012909c9bb4c9663e220a9522 (commit)
via 3cddfb8bd95782eba2fa6c5935a9298500dcdd6a (commit)
via f059f96f5c390ffe7a3835ada1e4c6be4502985b (commit)
via b786dfa77ef76b5486367a40dfcc5f8b8681db52 (commit)
via 10b0c31c6762cfde1e466039d18e159a601f867f (commit)
via 691d3b625c7299fc9b7d58cb855615b9b11fe393 (commit)
via 8a2edd0d1909bfdb0f7ddbdfb953eac95c987f2f (commit)
via 3337b581fafb8c7a747badfabb84b2ad01007ae6 (commit)
via f16f9856058ea2dca3b0be5a964fc3926ee6f395 (commit)
via 7b51465130cede5f68994d4535b86ece6cc2f11d (commit)
via 36fe3ea99b743875476fa2b229a5f60502b745a4 (commit)
via c02f78e1a0757e0590e81f6486007deed34f2d4d (commit)
via fcf3cdd41a35c9c96e95272bc5d817b0457ab8dc (commit)
via bf5f7b5f56ed649f78206fa2c3b4f9acdee1e310 (commit)
via a463f3d1b7b87d98f8c84d9d93a9fbd0285c53b9 (commit)
via 5607fdf2add21db2a5e080fdc6b146dea58e15cc (commit)
via f3d4565f0bf0839c6b5d3cfd8ae8ee48dbc20732 (commit)
via 5cd467d3209b8665c21fad038e79c5063ca95798 (commit)
via 2ebf994dfcb704b90f9b1dcccbf56a4b38c84a36 (commit)
via 2ad85af5e37a9e393903a8c0b3589b9c086c16ec (commit)
via d588ec8aafe64a586cc1bccab6be4a9fc50886d4 (commit)
via 0afb9dde6cef8abfa38935e85030ab975002cf91 (commit)
via 614ecf7cba243e94331171cc8d1761a99ebcab0f (commit)
via f7f035851da68ff926341eba4cad497ffa476115 (commit)
via 90980c5054e54aa637969ad59e2dc16b351d4488 (commit)
via 725aa66bb4eea86f29f5f851b4c188b864881e81 (commit)
via 74e4f864d436d960d5feea540e5573cb21dbe39c (commit)
via bc3d1d70a2a074f3c3360ed75ea87a7fe81a4da6 (commit)
via 709abc271e802e1a27b6f74fe54f7f5da5a7161e (commit)
via 086b420bfba5b31f13e2828ca1be842a8faad4aa (commit)
via f33c6b79fa27d93bcf9be45aa6844e1c26f35a97 (commit)
via ef67acec41e9b83d4aacff8de12e6a3e37628227 (commit)
via 184c6c7068ec90f2a85a859bfa56d779a4294382 (commit)
via 7c7c776676860ba64571154faef440093799e996 (commit)
via db105a36beb8999996f9e4853a2cceadb074775f (commit)
via 0061de28095c4ef166de784c12366adabc8a6636 (commit)
via f64a1962849e0773c33f95b541daf18a95911265 (commit)
via 25530c6ca2483cf92aab7f240c7fa70bd3c5b3a8 (commit)
via 33f0b8420f858e389d2fb0f27ddde1fa77287dc7 (commit)
via e8edbcf573f453fd1f72a3b899eaad9d195cc37c (commit)
via c31de72c76258d7444acc1f1ae1f30024b772af7 (commit)
via 14824b3a8199caabbf76a5c7b933715a0f0c4fec (commit)
via 9abd2de988dbd33bac4149e0d2cb1e4fec55413e (commit)
via cf32a344e6ed4eb7b5f2fcfb5c4d91a2d972d7d3 (commit)
via ff385d569e9a9b13c3c174b7d55f1916c75ce1df (commit)
via 7099d4df871fb6186a64157c13b92b2d8b56de0e (commit)
via 1b662b8dcab972fd07a7869b6b9108a8d128796f (commit)
via 330e485343c4f3054146046dac4b98c937c35269 (commit)
via 9851a189c6456b6ce5054cc4c9eea10a6866ce0f (commit)
via 4548257a1d70b64890433443d156d62a27fcc32a (commit)
via 06fdc8c5bff48e8cd0fa093dce018af40bdaa668 (commit)
via 359efa4b2178e6929e9226fdf1bce782fce0c002 (commit)
via 88effdc1b00be8636d40ef84f5556de60013347f (commit)
from ae170ab6674e889369bf4d97c01294222f2a4edd (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 7fa757c0318ac40d78a88c31ffbf2a3d32292c6c
Merge: 9cc7ba7d0f50343dfacfb0d2e5721ef70ae79a19 ae170ab6674e889369bf4d97c01294222f2a4edd
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Tue Mar 8 09:52:32 2011 +0900
Merge branch 'trac547' of ssh://bind10.isc.org/var/bind10/git/bind10 into trac547
Conflicts:
src/bin/bind10/bind10.py.in
src/bin/bind10/tests/bind10_test.py
src/bin/stats/Makefile.am
commit 9cc7ba7d0f50343dfacfb0d2e5721ef70ae79a19
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Mon Mar 7 21:39:38 2011 +0900
[trac547] add more tests
- stats module returns error
- "shutdown" command is invoked
commit c90a3505687965368aa9651021e6bc8881c93bb5
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Mon Mar 7 19:36:58 2011 +0900
[trac547] add more test
commit 115d5f517ec3edc5c55838bc13272a952276d2ed
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Mon Mar 7 18:03:56 2011 +0900
[trac547]
- add restoring old config data if failed restarting httpd
- add to a new methods "get_sockets" to return socket list
- add more verbose messages
- remove destructor of stats_httpd module and add catching SessionError when stats_httpd object is exiting
commit f2d89900b8c767c4753c62cd13a8c76a5b49ee04
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Mon Mar 7 12:27:31 2011 +0900
[trac547]
- change URL of XML, XSD and XSL documents
- add parameter of XSD namespace
- add default configure
- add some assertion
- rename some methods which return XML, XSD and XSL document
- implement HTTP redirection because of no found document requested
- remove catching some exceptions because it didn't be needed to be so much strict
- add error handling when received incorrect configure
- configurable of multiple IP addresses and ports for HTTP listen (it can hold multiple sockets for HTTP listen)
- add http closing message for verbose
- fix some try/except statements
- add some minor changes and minor refactoring
commit fa2449830ad1233b2b4c09a66b63d6c07e550942
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Mon Mar 7 12:03:12 2011 +0900
[trac547]
- add changes according to changes of the target source code
- change values of dummy data
- add more tests
commit fedd65092f4a821f7dfad997ae5bd6ae8895d19b
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Mon Mar 7 12:01:24 2011 +0900
[trac547]
- change values of constant parameters for testing
- add more information in error massages
commit c0f01437d2bc929ca2d5ee5b911e670f5ad72e9f
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Mon Mar 7 11:59:35 2011 +0900
[trac547] add some minor changes for testing
- add/rename some minor parameter
- remove some minor getter methods
commit 1b61922320ddd0502772850292dc7b9a7eb039aa
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Mon Mar 7 11:57:40 2011 +0900
[trac547] configurable of multiple IP addresses and ports for HTTP listen
commit 000f720401ac1438b79c4ee01533e1ec519daeb4
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Mon Mar 7 11:53:05 2011 +0900
[trac547]
- replaced with substitution strings for namespace and url
- add text decoration of CSS to XSL document
commit 78633ca5fac57b0df6878e76837914c8348c76e9
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Mar 3 21:55:00 2011 +0900
[trac547] remove string.py
commit f608f499e7c674efc744a483ce63712c6539b7c9
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Mar 3 21:42:31 2011 +0900
[trac547] add more tests for each class to improve coverage
- check HTTP status, header and body of response
- check validations of address and port of both IPv6/4
- check failure case of some methods of Session object with no socket
commit 2eb5b1d97ecda703cd507ad42c6974d6cf1283d3
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Mar 3 21:36:47 2011 +0900
[trac547] fix B10_FROM_SOURCE
commit 0125d6f9ec42ea97ce9b3fd4c0b3107588ee0440
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Mar 3 21:35:39 2011 +0900
[trac547]
- remove unnecessary StreamWriter
- add creating socket object and executing socket.bind() in creating HTTPServer object
- add some getter methods for unittest
- add dummy HTTP response class DummyHttpResponse for unittest
- add dummy writer method as seemed to write file object
commit 2974c62be639161fb6b26ecfc25335b1f87995b9
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Mar 3 21:31:12 2011 +0900
[trac547]
- add dummy SessionTimeout exception
- add raising SeesionError in creating Session object if sokect.error is raised
- remove printing for debug
- add raising SessinError in group_{un,}subscribe
commit aedbebba16f0197b05fc00a3aae37fa939f653b1
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Mar 3 21:27:54 2011 +0900
[trac547] add some assertions
commit 4311bc125b23c27f413b35958f353a96b207dba1
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Mar 3 21:27:35 2011 +0900
[trac547] fix bug (counting how many the socket is selected)
commit bcffc57fca8edde93455d5b38de184629aca94d8
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Mar 3 21:24:06 2011 +0900
[trac547]
- add dummy bind function with validation of address and port
- add status of open/closed
- add dummy address_family
commit c0f466ccc9784de00ca8fd251d2c7c0508d8abf2
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Mar 3 21:22:20 2011 +0900
[trac547] remove unnecessary module
commit 974f274c2843709b7b60b49a2a29fea84d085a23
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Mar 3 21:21:43 2011 +0900
[trac547]
- add function to close ModuleCCSession object
- remove try/except statement in creating ModuleCCSession object
- add exceptions of OverflowError and TypeError while select.select
- set http socket object and ModuleCCSession object to None after completing their closes
- move except select.error to proper position
- add some minor changes
commit 33a8c3076c4d14ea7349312cec46a9f5fe5f8bac
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Mar 2 20:46:55 2011 +0900
[trac547]
- rename spec files
- add global variables of URL
- refactor creating http socket
- add some minor changes
commit c83d8c30853f4a1dd41821acdec7147633e64a05
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Mar 2 20:44:52 2011 +0900
[trac547]
- rename spec files
- move location of spec files from build dir to source dir
commit cee80c373192fb23e8552ee309b5da88d0d5d7a8
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Mar 2 20:42:25 2011 +0900
[trac547] remove finally statement
commit ad146024dfd4ed0ef84d79431eb3d38db29584ea
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Mar 2 20:40:06 2011 +0900
[trac547] remove an unnecessary item
commit feb88922e55f03a8c0774b9be8e6cfca1769236f
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Mar 2 16:30:45 2011 +0900
[trac547] rename
commit d13e5d9b35c08a9d9b06281ebabbb97cead789b9
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Mar 2 16:30:35 2011 +0900
[trac547] rename
commit 947a781b99e1fc20745be6d7d7214dd4fc15da19
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Mar 2 16:04:59 2011 +0900
[trac547] rename
commit 3bad3036df1b8e8297e350eca468d818d8e52f1c
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Mar 2 16:04:45 2011 +0900
[trac547] change loading JSON-formatted specfile
commit 3eb010149bcca1bb30fb7e7bcd366b883f17aa78
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Mar 2 16:03:58 2011 +0900
[trac547] add dummy class, function. variables
commit 9cdeaf91cb2032cabfc4c37779ab49c4639c0cf1
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Mar 2 16:03:05 2011 +0900
[trac547] remove spec files and templates from test directory
commit 9fed238ba71bb95c9598004652dcb62b00cbbf7a
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Mar 2 16:02:21 2011 +0900
[trac547] rename
commit d20617367cff2a3a830cad059edf4039a137dfc1
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Mar 2 16:01:52 2011 +0900
[trac547] rename
commit 9881083dc71093d56643b347f34a5403bfcc72da
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Tue Mar 1 22:27:50 2011 +0900
[trac547]
- add xml implementations (XML, XSD, XSL)
- add constructing XML contents with HTTP response
- add an individual exception
- add implementation of reloading configure from CfgMgr without restarting process
- refactor handling exceptions
- add some minor changes
commit 96fafe5598fa4fb7272bc9e6524934740896101c
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Tue Mar 1 22:23:53 2011 +0900
[trac547] add new member variables (AF_INET, has_ipv6) and a new exception (gaierror) for testing
commit 134ae031b57e042c44136292d462b7c58b146ad1
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Tue Mar 1 22:22:44 2011 +0900
[trac547] add assertions
commit bbe7747b959c88eea8ae3e6e558001abd741559e
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Tue Mar 1 22:22:22 2011 +0900
[trac547] add a new dummy function to clear queues for testing
commit 7fe7b83f8f7f4a15efef41d5c1950de0e0181a1d
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Tue Mar 1 22:21:33 2011 +0900
[trac547] add a new member variable as dummy
commit 5aa235b1b4e1cb5c529b3d48c1d184f613ddf181
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Tue Mar 1 22:21:02 2011 +0900
[trac547] add more tests and refactor
commit 1453ae34f134c5cdfd089437400fb0f848c99994
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Tue Mar 1 22:20:08 2011 +0900
[trac547] fix typo
commit 0564f77ee1efb24f25c078fc69c2218428175e1f
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Tue Mar 1 22:19:35 2011 +0900
[trac547] replace messages with variable in templates
commit 1ec37962fd9cca0401a653bbed98f1da5e00ea71
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Sun Feb 27 00:42:01 2011 +0900
[trac547]
- move the xml files under build dir
- change suffixes of the xml files (do git-mv) and add their into configure.ac
- fix wrong paths: change relative to absolute
commit f8d38b2d2e2c6fd93027f414132e881fc55d4192
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 22:48:41 2011 +0900
[trac547] add make of spec files for testing
commit a34caa759a881b06443f613b7242f26f57412792
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 22:48:02 2011 +0900
[trac547] move position of B10_FROM_BUILD
commit 9badce6f07064efe0afd25f70bc650992331f30d
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 22:47:42 2011 +0900
[trac547]
- add this year of copyright
- remove __version__
- change SPECFILE_LOCATION
commit 8c10b819856a2c05e5fa49f6c2a293a51b015caf
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 22:47:25 2011 +0900
[trac547] add imp.reload in order to avoid to B10_FROM_BUILD be changeed in other test case
commit 02eba6203ce3c280a48dc70695e7f953bbd497e4
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 22:45:06 2011 +0900
[trac547] fix environment variable B10_FROM_BUILD
commit 7536f2791cf5e7f3df5f8243ce196ecb2e841bd0
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 22:44:31 2011 +0900
[trac547] fix typo
commit 061ce0be909574669959c3ba4943d8c4ef85d798
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 22:44:18 2011 +0900
[trac547]
- change SPECFILE_LOCATION
- remove unnecessary debug print
commit fa8d22bae415d17c5e2982764619d6048a34bf2a
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 22:43:47 2011 +0900
[trac547]
- add this year of copyright
- remove __version__
- change SPECFILE_LOCATION
commit b3c386d0e03b917eecbf08dab2c196634ee5a6d1
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 22:42:45 2011 +0900
[trac547] move position of B10_FROM_BUILD
commit a484448ed3ed5b754fbc68e14ed055d3c22f8dc9
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 22:42:39 2011 +0900
[trac547] move position of B10_FROM_BUILD
commit 77b533cb39350632632e27726775d25e3af81ea1
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 22:41:59 2011 +0900
[trac547]
- remove xml filenames
- refactor Makefile.am
commit e80b8485aeedf21c1d4376fd96f274b615a3a208
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 21:22:54 2011 +0900
[trac547] implement function get_value in dummy ConfigData class
commit 2085c06c7e17cedbe342eb6b5f01dd10c446f544
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 21:22:08 2011 +0900
[trac547] change name of member variable in dummuy socket class
commit 94b2fcd12bbf4ce4f62025b93b1ad4d934bed723
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 21:21:33 2011 +0900
[trac547] fix wrong variable name of dummuy socket
commit 52fa2af94be9bfb11a97e326314ea49f9a7ee1f7
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 21:20:39 2011 +0900
[trac547] add configuration of spec filename and xml filenames
commit 4b9dfed12d04f40d3c5aa9eaefb189979f46d980
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 21:20:10 2011 +0900
[trac547] improve obtaining spec filename and xml filenames from configures in the specfile instead of global variables in this script
commit e8d57bdfb45d053dd1292dafd0c17d2e7d17129d
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 11:57:38 2011 +0900
[trac547] make closed parameter hidden because original socket class doesn't have it
commit 8686101e19aa3e98a6eb8447c1c4e88ce7914487
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 11:48:15 2011 +0900
[trac547] remove function get_socket() because original module doesn't have it
commit 578d0587ae756c16333cd439406c0f2e4dc0817f
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 09:57:47 2011 +0900
[trac547]
- improve overall unittest according to change of the target module stats_httpd.py
- improve coverage percent
commit 372d7e3fca653ba5470bd6a8aef708904dfa2feb
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 09:56:11 2011 +0900
[trac547]
- fix line feed code
- add variable of template
commit 8c0c020c0578814c5632933827a30c20a1ad6441
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 09:55:53 2011 +0900
[trac547]
- remove $Id$
- add variable of template
commit 76cfbdb23966c082a37734d09789df4f958139dd
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 09:55:09 2011 +0900
[trac547] fix line feed code
commit f14d6a560d668d68f9a11b0b0ebd2ad604355191
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 09:54:13 2011 +0900
[trac547]
- improve overall structure about classes and functions
- add paths of xml templates
- change http handler according to its requests
- change having verbose variable
- add including external xml file as template with its maximum size
commit fd3b484a687235d849182ee80b6780d037f04597
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 09:45:44 2011 +0900
[trac547]
- rename dummy socket
- add dummy modules select and string
commit 94b85f892f5a550bfbbcebbf2907527746a2e6c9
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 09:44:47 2011 +0900
[trac547]
- rename dummy socket
- change condition that the session is open/closed
- add functions group_{subscribe,unsubscribe}
commit 7e8b395f849d977c16b4c10e8dfb265bd8ac6153
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 09:40:03 2011 +0900
[trac547]
- rename dummy socket
- add handler instance as a member variable
- add some dummy function
commit 4c31ef687e44726d1f986e61581fb580e133cafb
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 08:54:14 2011 +0900
[trac547] rename from dummy_socket to sockect
commit 987161dbeb59b39571b7ade56e030aceb4c729de
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 08:53:37 2011 +0900
[trac547] add new dummy standard modules
commit 606c271b43dadaa0dcf8e71df9c7c221e0b3076f
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Fri Feb 25 08:48:26 2011 +0900
[trac547]
- add called counter variable of dummy socket instance for unittest
- change type of return value of function fileno()
commit eb90b10a106ff60e99fdcd1bcd2351017ed6f3fd
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 23 15:41:40 2011 +0900
[trac547] add send_error for dummy
commit 2ff3386c34e41cdc6282fe266d98c4b1f6f8de38
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 23 15:41:00 2011 +0900
[trac547]
- fix content-type name
- fix string encoding
- fix minor problem
commit b7e8a7047affb0fc8806575a927d55433c48b0e4
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 23 15:39:29 2011 +0900
[trac547] add xml templates
commit e867ee63ed2b79bdb1a6d408214fe6d172486ce2
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 23 09:49:46 2011 +0900
[trac547] add importing shutil
commit a1130969e5d3c3756ef0198b03c7579546885071
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 23 09:23:29 2011 +0900
[trac547]
- add template files of xml, xsd and xsl
- add more implements for do_GET, do_HEAD
- add implement to gathering statistics data from remote stats module
- add minor changes
commit d86b5d60336200053663232086310815e661b09c
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 23 09:20:13 2011 +0900
[trac547] add template files of xml, xsd and xsl
commit ae58e18545c559b048400ab789e388b43b44e784
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Sun Feb 20 22:33:19 2011 +0900
[trac547] change default verbose mode
[trac547] change variable name "running"
[trac547] change minor verbose message
[trac547] fix missing function "check_command" in CCSessionListener class
[trac547] add PID with 'status' command
commit c71733afe02f9e22bb8b0f62f2a5761dc5aba07b
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Sun Feb 20 21:40:45 2011 +0900
[trac547] correct variable name
commit cfb94665b80fdaf9bd256cb24b277de506206b29
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Sun Feb 20 20:21:47 2011 +0900
[trac547] correct the example message
commit 5159a714bae31e9399a9bc82c7d8b9a7515525a0
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Sun Feb 20 20:17:11 2011 +0900
[trac547] add dummy http.server
commit 7645f0efb685c61e1571132d52aa5bbda8525519
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Sun Feb 20 20:16:44 2011 +0900
[trac547] remove dummy_socket from isc.cc.sesssion and place it current directory
commit fe583fe386f0fff4b5160a9cb9ba5375a619cbc4
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Sun Feb 20 20:13:04 2011 +0900
[trac547] add test cases for CCSessionLister, HttpListener and HttpHandler
commit 94ceca2b401b38da185c6599078add082aa17429
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Sun Feb 20 20:11:04 2011 +0900
[trac547] add new sub directory "http" and dummy scokect "dummy_socket.py"
commit ecfc195a79410e661099d7e970ebc0c33dc4e87f
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Sun Feb 20 20:09:53 2011 +0900
[trac547] implement http.server
[trac547] add some new classes , CCSessionListener, HttpListener, HttpHandler
commit 5af02c8a8a682d97eaaf4e409155d9530a7f0af8
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Sun Feb 20 20:07:50 2011 +0900
[trac547] add new Makefile for dummy http.server
commit 463fc1ba644c3fc65ede9319348a655fd77b61c1
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Sun Feb 20 12:43:34 2011 +0900
[trac547] add a test case for 'status' command
commit a7e0abbe2eba92c3f9d900865c1b0d68fe8d17f8
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Sun Feb 20 12:42:32 2011 +0900
[trac547] add 'status' and 'shutdown' commands
commit c348b858b66a08f396550d29a9aeb6ab537de4de
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Sun Feb 20 12:41:48 2011 +0900
[trac547] add status command and change some messages
commit 3689ac862f2953efaa6b88e2125d853d5625ce8f
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 16 17:23:11 2011 +0900
[trac547] correct spelling
commit 56f5aba505ec4ecea11b22f9e590223bdce2a123
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 16 16:23:09 2011 +0900
[trac547] assign the shorter process name
commit c8c8253fd8fa48cd042b80b69b617063fb3d4090
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 16 15:36:55 2011 +0900
[trac547] fix syntax of spec file
commit 5d1799a3c91e8d6536f9a2c0a0a3e1bd8752c058
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 16 15:36:11 2011 +0900
[trac547] fix calling main function
commit 4c1e71ca596a0a5ae229ab4ec86353e6bbcaf654
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 16 15:19:20 2011 +0900
[trac547] add assertion of rising 'TypeError'
commit 45d9a1b947afb473769db360a96f111f0a0f00d9
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 16 15:15:01 2011 +0900
[trac547] change type of return into string
commit 4e11df4e520e76f5956733629474ca0cd86548ee
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 16 14:15:36 2011 +0900
[trac547] - change copyright
- remove __version__
- add DummySocket class
commit 1cb949f9018f77a9cf15d7d85dfb2437752ebb13
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 16 14:14:24 2011 +0900
[trac547] remove __version__
commit fb0e5110d6cb2fdf38bced9de0e87b5372552236
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 16 14:13:54 2011 +0900
[trac547] change copyright
commit 4b9a2f8a426c1355eb96fe7ddf20ceab693b8685
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 16 14:13:04 2011 +0900
[trac547] add get_socket function to ModuleCCSession class
commit 919bb7adaee80433cf72ce784668a19975f7f04f
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Wed Feb 16 11:25:33 2011 +0900
[trac547] fixed minor mistakes
commit a50389017dec77f3a555eb7b67504cab4957a2d2
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Feb 3 20:40:51 2011 +0900
[trac547] necessary more changes for adding "b10-stats-httpd" module
[trac547] added "shutdown" command handling to "b10-stats-httpd" module
commit 403f9037b8713da7c90c8c72b7d27bcf12960a6c
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Feb 3 20:40:51 2011 +0900
[trac547] change configure.ac for module "b10-stats-httpd"
commit 86d57c374d3d7dd61a756e14c566f310a963ee30
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Feb 3 20:40:51 2011 +0900
[trac547] add mocked-up module "b10-stats-httpd" for HTTP/XML interface
commit b9406cc0d396f99f10c494cc7e70235de6f33411
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Feb 3 20:40:51 2011 +0900
[trac547] add mocked-up module "b10-stats-httpd" for HTTP/XML interface
commit cead48c8e156e111fd7d65f7eb43bf0aed5ad669
Author: Naoki Kambe <kambe at jprs.co.jp>
Date: Thu Feb 3 20:40:51 2011 +0900
[trac547] removed unnecessary module "b10-stats_stub" including related files
-----------------------------------------------------------------------
Summary of changes:
ChangeLog | 140 ++++++++-
Makefile.am | 7 +
README | 12 +-
configure.ac | 195 +++++-------
doc/Doxyfile | 2 +-
doc/guide/bind10-guide.html | 82 +++---
doc/guide/bind10-guide.xml | 51 ++--
src/bin/auth/Makefile.am | 4 +-
src/bin/auth/auth.spec.pre.in | 106 ++++---
src/bin/auth/auth_srv.cc | 19 ++
src/bin/auth/auth_srv.h | 14 +
src/bin/auth/b10-auth.8 | 50 +---
src/bin/auth/b10-auth.xml | 49 +---
src/bin/auth/benchmarks/Makefile.am | 2 +
src/bin/auth/benchmarks/query_bench.cc | 2 +-
src/bin/auth/config.cc | 61 ++++-
src/bin/auth/main.cc | 65 +----
src/bin/auth/tests/Makefile.am | 2 +
src/bin/auth/tests/auth_srv_unittest.cc | 20 +-
src/bin/auth/tests/config_unittest.cc | 22 ++-
src/bin/auth/tests/query_unittest.cc | 2 +-
src/bin/bind10/Makefile.am | 3 +-
src/bin/bind10/bind10.8 | 37 +--
src/bin/bind10/bind10.py.in | 143 ++++++---
src/bin/bind10/bind10.xml | 43 +--
src/bin/bind10/tests/bind10_test.py | 330 +++++++++++++-------
src/bin/bindctl/Makefile.am | 2 +-
src/bin/bindctl/bindcmd.py | 243 +++++++++------
src/bin/bindctl/bindctl-source.py.in | 66 +++--
src/bin/bindctl/cmdparse.py | 56 ++++-
src/bin/bindctl/moduleinfo.py | 68 ++++-
src/bin/bindctl/tests/Makefile.am | 2 +-
src/bin/bindctl/tests/bindctl_test.py | 96 ++++++-
src/bin/bindctl/tests/cmdparse_test.py | 88 ++++++
src/bin/cfgmgr/Makefile.am | 1 -
src/bin/cmdctl/Makefile.am | 3 +-
src/bin/host/host.cc | 7 +-
src/bin/msgq/Makefile.am | 1 -
src/bin/msgq/msgq.py.in | 2 +-
src/bin/resolver/Makefile.am | 5 +-
src/bin/resolver/b10-resolver.8 | 49 ++--
src/bin/resolver/b10-resolver.xml | 53 +++-
src/bin/resolver/resolver.cc | 175 ++++-------
src/bin/resolver/resolver.spec.pre.in | 36 +-
src/bin/resolver/tests/Makefile.am | 3 +
src/bin/resolver/tests/resolver_config_unittest.cc | 116 ++------
src/bin/resolver/tests/resolver_unittest.cc | 21 ++
src/bin/stats/Makefile.am | 3 +-
src/bin/usermgr/Makefile.am | 3 +-
src/bin/xfrin/Makefile.am | 3 +-
src/bin/xfrout/Makefile.am | 3 +-
src/bin/xfrout/tests/xfrout_test.py | 52 +++-
src/bin/xfrout/xfrout.py.in | 186 +++++++-----
src/bin/zonemgr/Makefile.am | 2 +-
src/cppcheck-suppress.lst | 15 +
src/lib/Makefile.am | 2 +-
src/lib/asiolink/Makefile.am | 35 ++-
src/lib/asiolink/README | 81 +++++-
src/lib/asiolink/asiolink.h | 15 +-
src/lib/asiolink/dns_server.h | 3 +
src/lib/asiolink/dns_service.cc | 18 +-
src/lib/asiolink/dns_service.h | 6 +
src/lib/asiolink/dummy_io_cb.h | 51 +++
src/lib/asiolink/internal/iofetch.h | 125 ++++++++
src/lib/asiolink/interval_timer.cc | 10 +-
src/lib/asiolink/io_address.cc | 5 +-
src/lib/asiolink/io_address.h | 6 +-
src/lib/asiolink/io_asio_socket.h | 309 ++++++++++++++++++
src/lib/asiolink/io_endpoint.cc | 3 +-
src/lib/asiolink/io_endpoint.h | 6 +-
src/lib/asiolink/io_error.h | 35 ++
src/lib/asiolink/io_fetch.cc | 193 ++++++++++++
src/lib/asiolink/io_fetch.h | 226 +++++++++++++
src/lib/asiolink/io_message.h | 7 +-
src/lib/asiolink/io_service.cc | 9 +-
src/lib/asiolink/io_socket.h | 11 +-
src/lib/asiolink/recursive_query.cc | 168 ++++++++---
src/lib/asiolink/recursive_query.h | 4 +
src/lib/asiolink/tcp_server.cc | 44 ++-
src/lib/asiolink/tcp_server.h | 4 +
src/lib/asiolink/tcp_socket.h | 257 ++++++++++++++-
src/lib/asiolink/tests/Makefile.am | 24 +-
src/lib/asiolink/tests/interval_timer_unittest.cc | 8 +-
src/lib/asiolink/tests/io_address_unittest.cc | 63 ++++
src/lib/asiolink/tests/io_endpoint_unittest.cc | 68 ++++
src/lib/asiolink/tests/io_fetch_unittest.cc | 191 +++++++++++
src/lib/asiolink/tests/io_service_unittest.cc | 3 +-
src/lib/asiolink/tests/io_socket_unittest.cc | 32 ++
src/lib/asiolink/tests/ioaddress_unittest.cc | 57 ----
src/lib/asiolink/tests/ioendpoint_unittest.cc | 67 ----
src/lib/asiolink/tests/iosocket_unittest.cc | 29 --
src/lib/asiolink/tests/recursive_query_unittest.cc | 19 +-
src/lib/asiolink/tests/udp_endpoint_unittest.cc | 55 ++++
src/lib/asiolink/tests/udp_query_unittest.cc | 145 ---------
src/lib/asiolink/tests/udp_socket_unittest.cc | 287 +++++++++++++++++
src/lib/asiolink/udp_endpoint.h | 29 ++-
src/lib/asiolink/udp_query.cc | 189 -----------
src/lib/asiolink/udp_query.h | 88 ------
src/lib/asiolink/udp_server.cc | 53 +++-
src/lib/asiolink/udp_server.h | 4 +
src/lib/asiolink/udp_socket.h | 250 ++++++++++++++-
src/lib/bench/tests/benchmark_unittest.cc | 19 +-
src/lib/bench/tests/loadquery_unittest.cc | 2 +-
src/lib/cache/TODO | 2 +
src/lib/cache/cache_entry_key.cc | 2 -
src/lib/cache/cache_entry_key.h | 2 -
src/lib/cache/local_zone_data.cc | 2 -
src/lib/cache/local_zone_data.h | 2 -
src/lib/cache/message_cache.cc | 4 +-
src/lib/cache/message_cache.h | 7 +-
src/lib/cache/message_entry.cc | 103 ++++---
src/lib/cache/message_entry.h | 13 +-
src/lib/cache/resolver_cache.cc | 12 +-
src/lib/cache/resolver_cache.h | 31 +-
src/lib/cache/rrset_cache.cc | 7 +-
src/lib/cache/rrset_cache.h | 11 +-
src/lib/cache/rrset_copy.cc | 2 -
src/lib/cache/rrset_copy.h | 2 -
src/lib/cache/rrset_entry.cc | 2 -
src/lib/cache/rrset_entry.h | 2 -
src/lib/cache/tests/Makefile.am | 11 +
src/lib/cache/tests/cache_test_messagefromfile.h | 1 -
src/lib/cache/tests/cache_test_sectioncount.h | 3 +-
src/lib/cache/tests/local_zone_data_unittest.cc | 1 -
src/lib/cache/tests/message_cache_unittest.cc | 32 ++-
src/lib/cache/tests/message_entry_unittest.cc | 68 ++++-
src/lib/cache/tests/resolver_cache_unittest.cc | 22 +-
src/lib/cache/tests/rrset_cache_unittest.cc | 1 -
src/lib/cache/tests/rrset_entry_unittest.cc | 4 +-
src/lib/cache/tests/run_unittests.cc | 1 -
src/lib/cache/tests/testdata/message_fromWire7 | 27 ++
src/lib/cache/tests/testdata/message_fromWire8 | 23 ++
src/lib/cc/tests/session_unittests.cc | 2 +-
src/lib/config/ccsession.cc | 4 +-
src/lib/config/module_spec.cc | 2 +-
src/lib/config/tests/ccsession_unittests.cc | 2 +-
src/lib/config/tests/module_spec_unittests.cc | 4 +-
src/lib/config/tests/testdata/spec22.spec | 4 +-
src/lib/datasrc/data_source.cc | 2 +-
src/lib/datasrc/memory_datasrc.cc | 118 ++++++-
src/lib/datasrc/tests/memory_datasrc_unittest.cc | 322 ++++++++++++++++++--
src/lib/datasrc/tests/rbtree_unittest.cc | 2 +-
src/lib/dns/Makefile.am | 3 +
src/lib/dns/dnssectime.cc | 153 ++++++++--
src/lib/dns/dnssectime.h | 98 ++++++-
src/lib/dns/message.cc | 4 +-
src/lib/dns/python/messagerenderer_python.cc | 45 +++-
.../python/tests/messagerenderer_python_test.py | 28 ++-
src/lib/dns/rdata/generic/detail/nsec_bitmap.cc | 78 +++++
src/lib/dns/rdata/generic/detail/nsec_bitmap.h | 51 +++
src/lib/dns/rdata/generic/nsec3_50.cc | 121 ++++---
src/lib/dns/rdata/generic/nsec3_50.h | 3 +-
src/lib/dns/rdata/generic/nsec_47.cc | 43 +---
src/lib/dns/rdata/generic/rrsig_46.cc | 11 +-
src/lib/dns/tests/Makefile.am | 1 +
src/lib/dns/tests/dnssectime_unittest.cc | 147 +++++++--
src/lib/dns/tests/name_unittest.cc | 2 +-
src/lib/dns/tests/rdata_mx_unittest.cc | 5 +-
src/lib/dns/tests/rdata_nsec3_unittest.cc | 127 ++++++--
src/lib/dns/tests/rdata_nsec_unittest.cc | 41 +---
src/lib/dns/tests/rdata_nsecbitmap_unittest.cc | 103 ++++++
src/lib/dns/tests/testdata/Makefile.am | 25 ++-
src/lib/dns/tests/testdata/gen-wiredata.py.in | 81 ++++-
src/lib/dns/tests/testdata/rdata_mx_toWire2 | 12 +
.../dns/tests/testdata/rdata_nsec3_fromWire1.spec | 7 +
.../dns/tests/testdata/rdata_nsec3_fromWire10.spec | 8 +
.../dns/tests/testdata/rdata_nsec3_fromWire11.spec | 8 +
.../dns/tests/testdata/rdata_nsec3_fromWire12.spec | 9 +
.../dns/tests/testdata/rdata_nsec3_fromWire13.spec | 9 +
.../dns/tests/testdata/rdata_nsec3_fromWire14.spec | 9 +
.../dns/tests/testdata/rdata_nsec3_fromWire15.spec | 10 +
src/lib/dns/tests/testdata/rdata_nsec3_fromWire2 | 12 -
.../dns/tests/testdata/rdata_nsec3_fromWire2.spec | 9 +
.../dns/tests/testdata/rdata_nsec3_fromWire4.spec | 9 +
.../dns/tests/testdata/rdata_nsec3_fromWire5.spec | 13 +
.../dns/tests/testdata/rdata_nsec3_fromWire6.spec | 11 +
.../dns/tests/testdata/rdata_nsec3_fromWire7.spec | 9 +
.../dns/tests/testdata/rdata_nsec3_fromWire8.spec | 9 +
.../dns/tests/testdata/rdata_nsec3_fromWire9.spec | 10 +
src/lib/log/Makefile.am | 11 +-
src/lib/log/compiler/Makefile.am | 4 +-
src/lib/log/compiler/message.cc | 270 +++++++++++-----
src/lib/log/dbglevels.h | 31 --
src/lib/log/debug_levels.h | 29 ++
src/lib/log/documentation.txt | 205 ++++++++-----
src/lib/log/filename.cc | 8 +-
src/lib/log/filename.h | 12 +-
src/lib/log/logger.cc | 316 ++++++-------------
src/lib/log/logger.h | 265 ++++++----------
src/lib/log/logger_impl.cc | 221 +++++++++++++
src/lib/log/logger_impl.h | 267 ++++++++++++++++
src/lib/log/logger_impl_log4cxx.cc | 241 ++++++++++++++
src/lib/log/logger_impl_log4cxx.h | 315 +++++++++++++++++++
src/lib/log/logger_levels.h | 42 +++
src/lib/log/logger_support.cc | 58 +++--
src/lib/log/logger_support.h | 21 +-
src/lib/log/message_dictionary.cc | 51 ++--
src/lib/log/message_dictionary.h | 70 ++++-
src/lib/log/message_exception.cc | 2 -
src/lib/log/message_exception.h | 4 +-
src/lib/log/message_initializer.cc | 20 +-
src/lib/log/message_initializer.h | 20 +-
src/lib/log/message_reader.cc | 91 ++++--
src/lib/log/message_reader.h | 43 ++-
src/lib/log/message_types.h | 13 +-
src/lib/log/messagedef.cc | 46 +++-
src/lib/log/messagedef.h | 36 ++-
src/lib/log/messagedef.mes | 61 +++-
src/lib/log/root_logger_name.cc | 26 ++-
src/lib/log/root_logger_name.h | 52 +---
src/lib/log/strutil.cc | 13 +-
src/lib/log/strutil.h | 10 +-
src/lib/log/tests/Makefile.am | 6 +-
src/lib/log/tests/filename_unittest.cc | 4 +-
src/lib/log/tests/localdef.mes | 23 --
src/lib/log/tests/logger_impl_log4cxx_unittest.cc | 91 ++++++
src/lib/log/tests/logger_support_test.cc | 45 ++--
src/lib/log/tests/logger_unittest.cc | 202 +++++--------
src/lib/log/tests/message_dictionary_unittest.cc | 58 +++-
src/lib/log/tests/message_initializer_unittest.cc | 18 +-
.../log/tests/message_initializer_unittest_2.cc | 4 +-
src/lib/log/tests/message_reader_unittest.cc | 62 +++-
src/lib/log/tests/root_logger_name_unittest.cc | 12 +-
src/lib/log/tests/run_time_init_test.sh.in | 34 ++-
src/lib/log/tests/run_unittests.cc | 4 +-
src/lib/log/tests/strutil_unittest.cc | 4 +-
src/lib/log/tests/xdebuglevel_unittest.cc | 6 +-
src/lib/log/xdebuglevel.cc | 28 +-
src/lib/log/xdebuglevel.h | 6 +-
src/lib/nsas/Makefile.am | 1 +
src/lib/nsas/asiolink.h | 2 +-
src/lib/nsas/hash_table.h | 24 +--
src/lib/nsas/locks.h | 116 +++++++
src/lib/nsas/lru_list.h | 24 +-
src/lib/nsas/nameserver_address_store.cc | 15 +-
src/lib/nsas/nameserver_entry.cc | 2 +-
src/lib/nsas/nameserver_entry.h | 24 +-
src/lib/nsas/tests/nsas_test.h | 1 +
src/lib/nsas/zone_entry.cc | 4 +-
src/lib/nsas/zone_entry.h | 16 +-
src/lib/python/isc/cc/data.py | 10 +-
src/lib/python/isc/config/ccsession.py | 22 +-
src/lib/python/isc/config/config_data.py | 181 ++++++++----
.../python/isc/config/tests/config_data_test.py | 76 ++++--
src/lib/python/isc/notify/tests/notify_out_test.py | 265 +++++++++-------
src/lib/python/isc/util/socketserver_mixin.py | 6 +-
.../isc/util/tests/socketserver_mixin_test.py | 2 +-
src/lib/python/isc/utils/Makefile.am | 5 -
src/lib/python/isc/utils/process.py | 37 ---
src/lib/python/isc/utils/tests/Makefile.am | 16 -
src/lib/python/isc/utils/tests/process_test.py | 39 ---
src/lib/resolve/resolve.cc | 20 ++
src/lib/resolve/resolve.h | 36 +++
src/lib/resolve/tests/Makefile.am | 1 +
src/lib/resolve/tests/resolve_unittest.cc | 46 +++-
src/lib/server_common/Makefile.am | 26 ++
src/lib/server_common/portconfig.cc | 119 +++++++
src/lib/server_common/portconfig.h | 121 +++++++
src/lib/server_common/tests/Makefile.am | 38 +++
src/lib/server_common/tests/portconfig_unittest.cc | 182 +++++++++++
src/lib/server_common/tests/run_unittests.cc | 26 ++
src/lib/testutils/Makefile.am | 2 +
src/lib/testutils/portconfig.h | 189 +++++++++++
src/lib/testutils/srv_test.cc | 4 +-
tools/README | 5 +-
tools/import_boost.sh | 74 -----
tools/tests_in_valgrind.sh | 75 +++++
tools/valgrind_test_cleaner.pl | 64 ++++
268 files changed, 9805 insertions(+), 3916 deletions(-)
mode change 100644 => 100755 src/bin/bind10/bind10.py.in
create mode 100644 src/bin/bindctl/tests/cmdparse_test.py
create mode 100644 src/cppcheck-suppress.lst
create mode 100644 src/lib/asiolink/dummy_io_cb.h
create mode 100644 src/lib/asiolink/internal/iofetch.h
create mode 100644 src/lib/asiolink/io_asio_socket.h
create mode 100644 src/lib/asiolink/io_error.h
create mode 100644 src/lib/asiolink/io_fetch.cc
create mode 100644 src/lib/asiolink/io_fetch.h
create mode 100644 src/lib/asiolink/tests/io_address_unittest.cc
create mode 100644 src/lib/asiolink/tests/io_endpoint_unittest.cc
create mode 100644 src/lib/asiolink/tests/io_fetch_unittest.cc
create mode 100644 src/lib/asiolink/tests/io_socket_unittest.cc
delete mode 100644 src/lib/asiolink/tests/ioaddress_unittest.cc
delete mode 100644 src/lib/asiolink/tests/ioendpoint_unittest.cc
delete mode 100644 src/lib/asiolink/tests/iosocket_unittest.cc
create mode 100644 src/lib/asiolink/tests/udp_endpoint_unittest.cc
delete mode 100644 src/lib/asiolink/tests/udp_query_unittest.cc
create mode 100644 src/lib/asiolink/tests/udp_socket_unittest.cc
delete mode 100644 src/lib/asiolink/udp_query.cc
delete mode 100644 src/lib/asiolink/udp_query.h
create mode 100644 src/lib/cache/tests/testdata/message_fromWire7
create mode 100644 src/lib/cache/tests/testdata/message_fromWire8
create mode 100644 src/lib/dns/rdata/generic/detail/nsec_bitmap.cc
create mode 100644 src/lib/dns/rdata/generic/detail/nsec_bitmap.h
create mode 100644 src/lib/dns/tests/rdata_nsecbitmap_unittest.cc
create mode 100644 src/lib/dns/tests/testdata/rdata_mx_toWire2
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire1.spec
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire10.spec
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire11.spec
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire12.spec
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire13.spec
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire14.spec
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire15.spec
delete mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire2
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire2.spec
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire4.spec
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire5.spec
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire6.spec
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire7.spec
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire8.spec
create mode 100644 src/lib/dns/tests/testdata/rdata_nsec3_fromWire9.spec
delete mode 100644 src/lib/log/dbglevels.h
create mode 100644 src/lib/log/debug_levels.h
create mode 100644 src/lib/log/logger_impl.cc
create mode 100644 src/lib/log/logger_impl.h
create mode 100644 src/lib/log/logger_impl_log4cxx.cc
create mode 100644 src/lib/log/logger_impl_log4cxx.h
create mode 100644 src/lib/log/logger_levels.h
delete mode 100644 src/lib/log/tests/localdef.mes
create mode 100644 src/lib/log/tests/logger_impl_log4cxx_unittest.cc
create mode 100644 src/lib/nsas/locks.h
delete mode 100644 src/lib/python/isc/utils/Makefile.am
delete mode 100644 src/lib/python/isc/utils/__init__.py
delete mode 100644 src/lib/python/isc/utils/process.py
delete mode 100644 src/lib/python/isc/utils/tests/Makefile.am
delete mode 100644 src/lib/python/isc/utils/tests/process_test.py
create mode 100644 src/lib/server_common/Makefile.am
create mode 100644 src/lib/server_common/portconfig.cc
create mode 100644 src/lib/server_common/portconfig.h
create mode 100644 src/lib/server_common/tests/Makefile.am
create mode 100644 src/lib/server_common/tests/portconfig_unittest.cc
create mode 100644 src/lib/server_common/tests/run_unittests.cc
create mode 100644 src/lib/testutils/portconfig.h
delete mode 100755 tools/import_boost.sh
create mode 100755 tools/tests_in_valgrind.sh
create mode 100755 tools/valgrind_test_cleaner.pl
-----------------------------------------------------------------------
diff --git a/ChangeLog b/ChangeLog
index 9cf9b3b..b7d113a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,15 +1,141 @@
+ 189. [bug] jreed
+ Do not install the log message compiler.
+ (Trac #634, git eb6441aca464980d00e3ff827cbf4195c5a7afc5)
+
+ 188. [bug] zhang likun
+ Make the rrset trust level ranking algorithm used by
+ isc::cache::MessageEntry::getRRsetTrustLevel() follow RFC2181
+ section 5.4.1.
+ (Trac #595 git 19197b5bc9f2955bd6a8ca48a2d04472ed696e81)
+
+ 187. [bug] zhang likun
+ Fix the assert error in class isc::cache::RRsetCache by adding the
+ check for empty pointer and test case for it.
+ (Trac #638, git 54e61304131965c4a1d88c9151f8697dcbb3ce12)
+
+ 186. [bug] jelte
+ b10-resolver could stop with an assertion failure on certain kinds
+ of messages (there was a problem in error message creation). This
+ fixes that.
+ (Trac #607, git 25a5f4ec755bc09b54410fcdff22691283147f32)
+
+ 185. [bug] vorner
+ Tests use port from private range (53210), lowering chance of
+ a conflict with something else (eg. running bind 10).
+ (Trac #523, git 301da7d26d41e64d87c0cf72727f3347aa61fb40)
+
+ 184. [func]* vorner
+ Listening address and port configuration of b10-auth is the same as
+ for b10-resolver now. That means, it is configured through bindctl
+ at runtime, in the Auth/listen_on list, not through command line
+ arguments.
+ (Trac #575, #576, git f06ce638877acf6f8e1994962bf2dbfbab029edf)
+
+ 183. [bug] jerry
+ src/bin/xfrout: Enable parallel sessions between xfrout server and
+ muti-Auth. The session needs to be created only on the first time
+ or if an error occur.
+ (Trac #419, git 1d60afb59e9606f312caef352ecb2fe488c4e751)
+
+ 182. [func] jinmei
+ Support cppcheck for static code check on C++ code. If cppcheck
+ is available, 'make cppcheck' on the top source directory will run
+ the checker and should cleanly complete with an exit code of 0
+ (at least with cppcheck 1.47).
+ Note: the suppression list isn't included in the final
+ distributions. It should be created by hand or retrieved from
+ the git repository.
+ (Trac #613, git b973f67520682b63ef38b1451d309be9f4f4b218)
+
+ 181. [func] feng
+ Add stop interface into dns server, so we can stop each running
+ server individually. With it, user can reconfigure her running server
+ with different ip address or port.
+ (Trac #388, git 6df94e2db856c1adc020f658cc77da5edc967555)
+
+ 180. [build] jreed
+ Fix custom DESTDIR for make install. Patch from Jan Engelhardt.
+ (Trac #629, git 5ac67ede03892a5eacf42ce3ace1e4e376164c9f)
+
+bind10-devel-20110224 released on February 24, 2011
+
+ 179. [func] vorner
+ It is possible to start and stop resolver and authoritative
+ server without restart of the whole system. Change of the
+ configuration (Boss/start_auth and Boss/start_resolver) is
+ enough.
+ (Trac #565, git 0ac0b4602fa30852b0d86cc3c0b4730deb1a58fe)
+
+ 178. [func] jelte
+ Resolver now makes (limited) use of the cache
+ (Trac #491, git 8b41f77f0099ddc7ca7d34d39ad8c39bb1a8363c)
+
+ 177. [func] stephen
+ The upstream fetch code in asiolink is now protocol agnostic to
+ allow for the addition of fallback to TCP if a fetch response
+ indicates truncation.
+ (Trac #554, git 9739cbce2eaffc7e80640db58a8513295cf684de)
+
+ 176. [func] zhang likun
+ src/lib/cache: Rename one interface: from lookupClosestRRset()
+ to lookupDeepestNS(), and remove one parameter of it.
+ (Trac #492, git ecbfb7cf929d62a018dd4cdc7a841add3d5a35ae)
+
+ 175. [bug] jerry
+ src/bin/xfrout: Xfrout use the case-sensitive mode to compress
+ names in an AXFR massage.
+ (Trac #253, git 004e382616150f8a2362e94d3458b59bb2710182)
+
+ 174. [bug]* jinmei
+ src/lib/dns: revised dnssectime functions so that they don't rely
+ on the time_t type (whose size varies on different systems, which
+ can lead to subtle bugs like some form of "year 2038 problem").
+ Also handled 32-bit wrap around issues more explicitly, with more
+ detailed tests. The function API has been changed, but the effect
+ should be minimal because these functions are mostly private.
+ (Trac #61, git 09ece8cdd41c0f025e8b897b4883885d88d4ba5d)
+
+ 173. [bug] jerry
+ python/isc/notify: A notify_out test fails without network
+ connectivity, encapsulate the socket behavior using a mock
+ socket class to fix it.
+ (Trac #346, git 319debfb957641f311102739a15059f8453c54ce)
+
+ 172. [func] jelte
+ Improved the bindctl cli in various ways, mainly concerning
+ list and map item addressing, the correct display of actual values,
+ and internal help.
+ (Trac #384, git e5fb3bc1ed5f3c0aec6eb40a16c63f3d0fc6a7b2)
+
+ 171. [func] feng, jerry, jinmei, vorner
+ b10-auth, src/lib/datasrc: in memory data source now works as a
+ complete data source for authoritative DNS servers and b10-auth
+ uses it. It still misses major features, however, including
+ DNSSEC support and zone transfer.
+ (Last trac #553, but many more,
+ git 6f031a09a248e7684723c000f3e8cc981dcdb349)
+
+ 170. [bug] jinmei
+ Tightened validity checks in the NSEC3 constructors, both "from
+ "text" and "from wire". Specifically, wire data containing
+ invalid type bitmaps or invalid lengths of salt or hash is now
+ correctly rejected.
+ (Trac #117, git 9c690982f24fef19c747a72f43c4298333a58f48)
+
169. [func] zhang likun, jelte
Added a basic implementation for a resolver cache (though not
used yet).
(Trac #449, git 8aa3b2246ae095bbe7f855fd11656ae3bdb98986)
168. [bug] vorner
- Boss no longer has the -f argument, which was undocumented and stayed as
- a relict of previous versions, currently causing only strange behaviour.
+ Boss no longer has the -f argument, which was undocumented and
+ stayed as a relict of previous versions, currently causing only
+ strange behaviour.
(Trac #572, git 17f237478961005707d649a661cc72a4a0d612d4)
167. [bug] naokikambe
- Fixed failure of termination of msgq_test.py with python3 coverage(3.3.1)
+ Fixed failure of termination of msgq_test.py with python3
+ coverage(3.3.1)
(Trac #573, git 0e6a18e12f61cc482e07078776234f32605312e5)
166. [func] jelte
@@ -30,10 +156,10 @@
(Trac #452, git c9f6acc81e24c4b8f0eb351123dc7b43f64e0914)
163. [func] vorner
- The pimpl design pattern is used in UDPServer, with a shared pointer. This
- makes it smaller to copy (which is done a lot as a sideeffect of being
- coroutine) and speeds applications of this class (notably b10-auth) up by
- around 10%.
+ The pimpl design pattern is used in UDPServer, with a shared
+ pointer. This makes it smaller to copy (which is done a lot as a
+ sideeffect of being coroutine) and speeds applications of this
+ class (notably b10-auth) up by around 10%.
(Trac #537, git 94cb95b1d508541201fc064302ba836164d3cbe6)
162. [func] stephen
diff --git a/Makefile.am b/Makefile.am
index 68a41d6..9a28f20 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -70,6 +70,13 @@ clean-coverage: clean-cpp-coverage clean-python-coverage
report-coverage: report-cpp-coverage report-python-coverage
+# for static C++ check using cppcheck (when available)
+cppcheck:
+ cppcheck --enable=all --suppressions src/cppcheck-suppress.lst \
+ --quiet --error-exitcode=1 \
+ --template '{file}:{line}: check_fail: {message} ({severity},{id})' \
+ src
+
#### include external sources in the distributed tarball:
EXTRA_DIST = ext/asio/README
EXTRA_DIST += ext/asio/asio/local/stream_protocol.hpp
diff --git a/README b/README
index 9b258bc..5bc3154 100644
--- a/README
+++ b/README
@@ -14,12 +14,12 @@ five year plan are described here:
https://bind10.isc.org/wiki/Year2Milestones
This release includes the bind10 master process, b10-msgq message
-bus, b10-auth authoritative DNS server (with SQLite3 backend),
-b10-resolver forwarding DNS server, b10-cmdctl remote control daemon,
-b10-cfgmgr configuration manager, b10-xfrin AXFR inbound service,
-b10-xfrout outgoing AXFR service, b10-zonemgr secondary manager,
-b10-stats statistics collection and reporting daemon, and a new
-libdns++ library for C++ with a python wrapper.
+bus, b10-auth authoritative DNS server (with SQLite3 and in-memory
+backends), b10-resolver forwarding DNS server, b10-cmdctl remote
+control daemon, b10-cfgmgr configuration manager, b10-xfrin AXFR
+inbound service, b10-xfrout outgoing AXFR service, b10-zonemgr
+secondary manager, b10-stats statistics collection and reporting
+daemon, and a new libdns++ library for C++ with a python wrapper.
Documentation is included and also available via the BIND 10
website at http://bind10.isc.org/
diff --git a/configure.ac b/configure.ac
index c097ac0..91cf497 100644
--- a/configure.ac
+++ b/configure.ac
@@ -2,7 +2,7 @@
# Process this file with autoconf to produce a configure script.
AC_PREREQ([2.59])
-AC_INIT(bind10-devel, 20110120, bind10-dev at isc.org)
+AC_INIT(bind10-devel, 20110224, bind10-dev at isc.org)
AC_CONFIG_SRCDIR(README)
AM_INIT_AUTOMAKE
AC_CONFIG_HEADERS([config.h])
@@ -14,18 +14,22 @@ AC_PROG_CXX
#
# On FreeBSD (and probably some others), clang++ does not meet an autoconf
# assumption in identifying libtool configuration regarding shared library:
-# the configure script will execute "$CC -shared $CFLAGS -v -o" and expect
-# the output contains -Lxxx or -Ryyy. This is the case for g++, but not for
-# clang++, and, as a result, it will cause various errors in linking programs
-# or running them with a shared object (such as some of our python scripts).
+# the configure script will execute "$CC -shared $CFLAGS/$CXXFLAGS -v" and
+# expect the output contains -Lxxx or -Ryyy. This is the case for g++, but
+# not for clang++, and, as a result, it will cause various errors in linking
+# programs or running them with a shared object (such as some of our python
+# scripts).
# To work around this problem we define a temporary variable
# "CXX_LIBTOOL_LDFLAGS". It's expected to be defined as, e.g, "-L/usr/lib"
# to temporarily fake the output so that it will be compatible with that of
# g++.
CFLAGS_SAVED=$CFLAGS
+CXXFLAGS_SAVED=$CXXFLAGS
CFLAGS="$CFLAGS $CXX_LIBTOOL_LDFLAGS"
+CXXFLAGS="$CXXFLAGS $CXX_LIBTOOL_LDFLAGS"
AC_PROG_LIBTOOL
CFLAGS=$CFLAGS_SAVED
+CXXFLAGS=$CXXFLAGS_SAVED
# Use C++ language
AC_LANG([C++])
@@ -66,6 +70,11 @@ if test $enable_shared = no; then
AC_MSG_ERROR([BIND 10 requires shared libraries to be built])
fi
+AC_ARG_ENABLE(boost-threads,
+AC_HELP_STRING([--enable-boost-threads],
+ [use boost threads. Currently this only means using its locks instead of dummy locks, in the cache and NSAS]),
+ use_boost_threads=$enableval, use_boost_threads=no)
+
# allow configuring without setproctitle.
AC_ARG_ENABLE(setproctitle-check,
AC_HELP_STRING([--disable-setproctitle-check],
@@ -193,8 +202,9 @@ if test "$setproctitle_check" = "yes" ; then
AC_MSG_RESULT(ok)
else
AC_MSG_RESULT(missing)
- AC_MSG_ERROR([Missing setproctitle module. Either install it or provide --disable-setproctitle-check.
-In that case we will continue, but naming of python processes will not work.])
+ AC_MSG_WARN([Missing setproctitle python module.
+Use --disable-setproctitle-check to skip this check.
+In this case we will continue, but naming of python processes will not work.])
fi
fi
@@ -285,6 +295,7 @@ AC_SUBST(B10_CXXFLAGS)
AC_SEARCH_LIBS(inet_pton, [nsl])
AC_SEARCH_LIBS(recvfrom, [socket])
+AC_SEARCH_LIBS(nanosleep, [rt])
# Checks for header files.
@@ -363,57 +374,6 @@ if test "$lcov" != "no"; then
fi
AC_SUBST(USE_LCOV)
-# Configure log4cxx header and library path
-#
-# If explicitly specified, use it.
-
-AC_ARG_WITH([log4cxx],
- AC_HELP_STRING([--with-log4cxx=PATH],
- [specify directory where log4cxx is installed]),
- [
- log4cxx_include_path="${withval}/include";
- log4cxx_library_path="${withval}/lib"
- ])
-
-# This is an urgent fix to avoid regression due to log4cxx on some
-# platforms. It should be cleaned up with a better fix.
-if test "X$with_log4cxx" != "Xno"; then
-
-# If not specified, try some common paths. These default to
-# /usr/include and /usr/lib if not found
-
-if test -z "$with_log4cxx"; then
- log4cxxdirs="/usr/local /usr/pkg /opt /opt/local"
- for d in $log4cxxdirs
- do
- if test -d $d/include/log4cxx; then
- log4cxx_include_path=$d/include
- log4cxx_library_path=$d/lib
- break
- fi
- done
-fi
-
-CPPFLAGS_SAVES="$CPPFLAGS"
-if test "${log4cxx_include_path}" ; then
- LOG4CXX_INCLUDES="-I${log4cxx_include_path}"
- CPPFLAGS="$CPPFLAGS $LOG4CXX_INCLUDES"
-fi
-AC_CHECK_HEADER([log4cxx/logger.h],, AC_MSG_ERROR([Missing log4cxx header files.]))
-CPPFLAGS="$CPPFLAGS_SAVES"
-AC_SUBST(LOG4CXX_INCLUDES)
-
-LOG4CXX_LDFLAGS="-llog4cxx";
-if test "${log4cxx_library_path}"; then
- LOG4CXX_LDFLAGS="-L${log4cxx_library_path} -llog4cxx"
-fi
-AC_SUBST(LOG4CXX_LDFLAGS)
-
-# The following two lines are part of the urgent fix, and should be cleaned
-# up with a better fix.
-fi
-AM_CONDITIONAL(USE_LOG4CXX, test "X${with_log4cxx}" != "Xno")
-
#
# Configure Boost header path
#
@@ -443,62 +403,69 @@ AC_CHECK_HEADERS([boost/shared_ptr.hpp boost/foreach.hpp boost/interprocess/sync
CPPFLAGS="$CPPFLAGS_SAVES"
AC_SUBST(BOOST_INCLUDES)
-# Using boost::mutex can result in requiring libboost_thread with older
-# versions of Boost. We'd like to avoid relying on a compiled Boost library
-# whenever possible, so we need to check for it step by step.
-#
-# NOTE: another fix of this problem is to simply require newer versions of
-# boost. If we choose that solution we should simplify the following tricky
-# checks accordingly and all Makefile.am's that refer to NEED_LIBBOOST_THREAD.
-AC_MSG_CHECKING(for boost::mutex)
-CPPFLAGS_SAVES="$CPPFLAGS"
-LIBS_SAVES="$LIBS"
-CPPFLAGS="$BOOST_INCLUDES $CPPFLAGS $MULTITHREADING_FLAG"
-need_libboost_thread=0
-need_sunpro_workaround=0
-AC_TRY_LINK([
-#include <boost/thread.hpp>
-],[
-boost::mutex m;
-],
- [ AC_MSG_RESULT(yes (without libboost_thread)) ],
-
- # there is one specific problem with SunStudio 5.10
- # where including boost/thread causes a compilation failure
- # There is a workaround in boost but it checks the version not being 5.10
- # This will probably be fixed in the future, in which case this
- # is only a temporary workaround
- [ AC_TRY_LINK([
-#if defined(__SUNPRO_CC) && __SUNPRO_CC == 0x5100
-#undef __SUNPRO_CC
-#define __SUNPRO_CC 0x5090
-#endif
-#include <boost/thread.hpp>
-],[
-boost::mutex m;
-],
- [ AC_MSG_RESULT(yes (with SUNOS workaround))
- need_sunpro_workaround=1 ],
- [ LIBS=" $LIBS -lboost_thread"
- AC_TRY_LINK([
-#include <boost/thread.hpp>
-],[
-boost::mutex m;
-],
- [ AC_MSG_RESULT(yes (with libboost_thread))
- need_libboost_thread=1 ],
- [ AC_MSG_RESULT(no)
- AC_MSG_ERROR([boost::mutex cannot be linked in this build environment.
-Perhaps you are using an older version of Boost that requires libboost_thread for the mutex support, which does not appear to be available.
-You may want to check the availability of the library or to upgrade Boost.])
- ])])])
-CPPFLAGS="$CPPFLAGS_SAVES"
-LIBS="$LIBS_SAVES"
-AM_CONDITIONAL(NEED_LIBBOOST_THREAD, test $need_libboost_thread = 1)
-if test $need_sunpro_workaround = 1; then
- AC_DEFINE([NEED_SUNPRO_WORKAROUND], [], [Need boost sunstudio workaround])
+
+if test "${use_boost_threads}" = "yes" ; then
+ AC_DEFINE([USE_BOOST_THREADS], [], [Use boost threads])
+
+ # Using boost::mutex can result in requiring libboost_thread with older
+ # versions of Boost. We'd like to avoid relying on a compiled Boost library
+ # whenever possible, so we need to check for it step by step.
+ #
+ # NOTE: another fix of this problem is to simply require newer versions of
+ # boost. If we choose that solution we should simplify the following tricky
+ # checks accordingly and all Makefile.am's that refer to NEED_LIBBOOST_THREAD.
+ AC_MSG_CHECKING(for boost::mutex)
+ CPPFLAGS_SAVES="$CPPFLAGS"
+ LIBS_SAVES="$LIBS"
+ CPPFLAGS="$BOOST_INCLUDES $CPPFLAGS $MULTITHREADING_FLAG"
+ need_libboost_thread=0
+ need_sunpro_workaround=0
+ AC_TRY_LINK([
+ #include <boost/thread.hpp>
+ ],[
+ boost::mutex m;
+ ],
+ [ AC_MSG_RESULT(yes (without libboost_thread)) ],
+ # there is one specific problem with SunStudio 5.10
+ # where including boost/thread causes a compilation failure
+ # There is a workaround in boost but it checks the version not being 5.10
+ # This will probably be fixed in the future, in which case this
+ # is only a temporary workaround
+ [ AC_TRY_LINK([
+ #if defined(__SUNPRO_CC) && __SUNPRO_CC == 0x5100
+ #undef __SUNPRO_CC
+ #define __SUNPRO_CC 0x5090
+ #endif
+ #include <boost/thread.hpp>
+ ],[
+ boost::mutex m;
+ ],
+ [ AC_MSG_RESULT(yes (with SUNOS workaround))
+ need_sunpro_workaround=1 ],
+ [ LIBS=" $LIBS -lboost_thread"
+ AC_TRY_LINK([
+ #include <boost/thread.hpp>
+ ],[
+ boost::mutex m;
+ ],
+ [ AC_MSG_RESULT(yes (with libboost_thread))
+ need_libboost_thread=1 ],
+ [ AC_MSG_RESULT(no)
+ AC_MSG_ERROR([boost::mutex cannot be linked in this build environment.
+ Perhaps you are using an older version of Boost that requires libboost_thread for the mutex support, which does not appear to be available.
+ You may want to check the availability of the library or to upgrade Boost.])
+ ])])])
+ CPPFLAGS="$CPPFLAGS_SAVES"
+ LIBS="$LIBS_SAVES"
+ AM_CONDITIONAL(NEED_LIBBOOST_THREAD, test $need_libboost_thread = 1)
+ if test $need_sunpro_workaround = 1; then
+ AC_DEFINE([NEED_SUNPRO_WORKAROUND], [], [Need boost sunstudio workaround])
+ fi
+else
+ AM_CONDITIONAL(NEED_LIBBOOST_THREAD, test "${use_boost_threads}" = "yes")
fi
+
#
# Check availability of gtest, which will be used for unit tests.
#
@@ -715,6 +682,8 @@ AC_CONFIG_FILES([Makefile
src/lib/nsas/tests/Makefile
src/lib/cache/Makefile
src/lib/cache/tests/Makefile
+ src/lib/server_common/Makefile
+ src/lib/server_common/tests/Makefile
])
AC_OUTPUT([doc/version.ent
src/bin/cfgmgr/b10-cfgmgr.py
@@ -826,8 +795,6 @@ dnl includes too
${PYTHON_LDFLAGS}
${PYTHON_LIB}
Boost: ${BOOST_INCLUDES}
- log4cxx: ${LOG4CXX_INCLUDES}
- ${LOG4CXX_LDFLAGS}
SQLite: $SQLITE_CFLAGS
$SQLITE_LIBS
diff --git a/doc/Doxyfile b/doc/Doxyfile
index 34ec3d8..46aa178 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -568,7 +568,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = ../src/lib/cc ../src/lib/config ../src/lib/dns ../src/lib/exceptions ../src/lib/datasrc ../src/bin/auth ../src/bin/resolver ../src/lib/bench ../src/lib/log ../src/lib/asiolink/ ../src/lib/nsas ../src/lib/testutils ../src/lib/cache
+INPUT = ../src/lib/cc ../src/lib/config ../src/lib/dns ../src/lib/exceptions ../src/lib/datasrc ../src/bin/auth ../src/bin/resolver ../src/lib/bench ../src/lib/log ../src/lib/asiolink/ ../src/lib/nsas ../src/lib/testutils ../src/lib/cache ../src/lib/server_common/
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
diff --git a/doc/guide/bind10-guide.html b/doc/guide/bind10-guide.html
index 98c7e46..fe6bd93 100644
--- a/doc/guide/bind10-guide.html
+++ b/doc/guide/bind10-guide.html
@@ -1,23 +1,24 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>BIND 10 Guide</title><link rel="stylesheet" href="./bind10-guide.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><meta name="description" content="BIND 10 is a Domain Name System (DNS) suite managed by Internet Systems Consortium (ISC). It includes DNS libraries and modular components for controlling authoritative and recursive DNS servers. This is the reference guide for BIND 10 version 20110120. The most up-to-date version of this document, along with other documents for BIND 10, can be found at ."></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="BIND 10 Guide"><div class="titlepage"><div><div><h1 class="title"><a name="id1168230298903"></a>BIND 10 Guide</h1></div><div><h2 class="subtitle">Administrator Reference for BIND 10</h2></div><div><p class="releaseinfo">This is the referenc
e guide for BIND 10 version
- 20110120.</p></div><div><p class="copyright">Copyright © 2010 Internet Systems Consortium, Inc.</p></div><div><div class="abstract" title="Abstract"><p class="title"><b>Abstract</b></p><p>BIND 10 is a Domain Name System (DNS) suite managed by
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>BIND 10 Guide</title><link rel="stylesheet" href="./bind10-guide.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><meta name="description" content="BIND 10 is a Domain Name System (DNS) suite managed by Internet Systems Consortium (ISC). It includes DNS libraries and modular components for controlling authoritative and recursive DNS servers. This is the reference guide for BIND 10 version 20110224. The most up-to-date version of this document, along with other documents for BIND 10, can be found at ."></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="BIND 10 Guide"><div class="titlepage"><div><div><h1 class="title"><a name="id1168230298903"></a>BIND 10 Guide</h1></div><div><h2 class="subtitle">Administrator Reference for BIND 10</h2></div><div><p class="releaseinfo">This is the referenc
e guide for BIND 10 version
+ 20110224.</p></div><div><p class="copyright">Copyright © 2010 Internet Systems Consortium, Inc.</p></div><div><div class="abstract" title="Abstract"><p class="title"><b>Abstract</b></p><p>BIND 10 is a Domain Name System (DNS) suite managed by
Internet Systems Consortium (ISC). It includes DNS libraries
and modular components for controlling authoritative and
recursive DNS servers.
</p><p>
- This is the reference guide for BIND 10 version 20110120.
+ This is the reference guide for BIND 10 version 20110224.
The most up-to-date version of this document, along with
- other documents for BIND 10, can be found at <a class="ulink" href="http://bind10.isc.org/docs" target="_top">http://bind10.isc.org/docs</a>. </p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#intro">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168230299042">Supported Platforms</a></span></dt><dt><span class="section"><a href="#id1168230299068">Required Software</a></span></dt><dt><span class="section"><a href="#starting_stopping">Starting and Stopping the Server</a></span></dt><dt><span class="section"><a href="#managing_once_running">Managing BIND 10</a></span></dt></dl></dd><dt><span class="chapter"><a href="#installation">2. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168230284843">Building Requirements</a></span></dt><dt><span class="section"><a href="#quickstart">Quick start</a></span></dt><dt><span class="section"><a href="#install">In
stallation from source</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168230285029">Download Tar File</a></span></dt><dt><span class="section"><a href="#id1168230285048">Retrieve from Git</a></span></dt><dt><span class="section"><a href="#id1168230285109">Configure before the build</a></span></dt><dt><span class="section"><a href="#id1168230285206">Build</a></span></dt><dt><span class="section"><a href="#id1168230285222">Install</a></span></dt><dt><span class="section"><a href="#id1168230285245">Install Hierarchy</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#bind10">3. Starting BIND10 with <span class="command"><strong>bind10</strong></span></a></span></dt><dd><dl><dt><span class="section"><a href="#start">Starting BIND 10</a></span></dt></dl></dd><dt><span class="chapter"><a href="#msgq">4. Command channel</a></span></dt><dt><span class="chapter"><a href="#cfgmgr">5. Configuration manager</a></span></dt><dt><span class="chapter"><a hr
ef="#cmdctl">6. Remote control daemon</a></span></dt><dd><dl><dt><span class="section"><a href="#cmdctl.spec">Configuration specification for b10-cmdctl</a></span></dt></dl></dd><dt><span class="chapter"><a href="#bindctl">7. Control and configure user interface</a></span></dt><dt><span class="chapter"><a href="#authserver">8. Authoritative Server</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168230285821">Server Configurations</a></span></dt><dt><span class="section"><a href="#id1168230285886">Data Source Backends</a></span></dt><dt><span class="section"><a href="#id1168230285917">Loading Master Zones Files</a></span></dt></dl></dd><dt><span class="chapter"><a href="#xfrin">9. Incoming Zone Transfers</a></span></dt><dt><span class="chapter"><a href="#xfrout">10. Outbound Zone Transfers</a></span></dt><dt><span class="chapter"><a href="#zonemgr">11. Secondary Manager</a></span></dt><dt><span class="chapter"><a href="#resolverserver">12. Recursive Name Server<
/a></span></dt><dt><span class="chapter"><a href="#statistics">13. Statistics</a></span></dt></dl></div><div class="chapter" title="Chapter 1. Introduction"><div class="titlepage"><div><div><h2 class="title"><a name="intro"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168230299042">Supported Platforms</a></span></dt><dt><span class="section"><a href="#id1168230299068">Required Software</a></span></dt><dt><span class="section"><a href="#starting_stopping">Starting and Stopping the Server</a></span></dt><dt><span class="section"><a href="#managing_once_running">Managing BIND 10</a></span></dt></dl></div><p>
+ other documents for BIND 10, can be found at <a class="ulink" href="http://bind10.isc.org/docs" target="_top">http://bind10.isc.org/docs</a>. </p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#intro">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168230299038">Supported Platforms</a></span></dt><dt><span class="section"><a href="#id1168230299065">Required Software</a></span></dt><dt><span class="section"><a href="#starting_stopping">Starting and Stopping the Server</a></span></dt><dt><span class="section"><a href="#managing_once_running">Managing BIND 10</a></span></dt></dl></dd><dt><span class="chapter"><a href="#installation">2. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168230284842">Building Requirements</a></span></dt><dt><span class="section"><a href="#quickstart">Quick start</a></span></dt><dt><span class="section"><a href="#install">In
stallation from source</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168230285028">Download Tar File</a></span></dt><dt><span class="section"><a href="#id1168230285047">Retrieve from Git</a></span></dt><dt><span class="section"><a href="#id1168230285108">Configure before the build</a></span></dt><dt><span class="section"><a href="#id1168230285205">Build</a></span></dt><dt><span class="section"><a href="#id1168230285221">Install</a></span></dt><dt><span class="section"><a href="#id1168230285244">Install Hierarchy</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#bind10">3. Starting BIND10 with <span class="command"><strong>bind10</strong></span></a></span></dt><dd><dl><dt><span class="section"><a href="#start">Starting BIND 10</a></span></dt></dl></dd><dt><span class="chapter"><a href="#msgq">4. Command channel</a></span></dt><dt><span class="chapter"><a href="#cfgmgr">5. Configuration manager</a></span></dt><dt><span class="chapter"><a hr
ef="#cmdctl">6. Remote control daemon</a></span></dt><dd><dl><dt><span class="section"><a href="#cmdctl.spec">Configuration specification for b10-cmdctl</a></span></dt></dl></dd><dt><span class="chapter"><a href="#bindctl">7. Control and configure user interface</a></span></dt><dt><span class="chapter"><a href="#authserver">8. Authoritative Server</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168230285822">Server Configurations</a></span></dt><dt><span class="section"><a href="#id1168230285888">Data Source Backends</a></span></dt><dt><span class="section"><a href="#id1168230285918">Loading Master Zones Files</a></span></dt></dl></dd><dt><span class="chapter"><a href="#xfrin">9. Incoming Zone Transfers</a></span></dt><dt><span class="chapter"><a href="#xfrout">10. Outbound Zone Transfers</a></span></dt><dt><span class="chapter"><a href="#zonemgr">11. Secondary Manager</a></span></dt><dt><span class="chapter"><a href="#resolverserver">12. Recursive Name Server<
/a></span></dt><dt><span class="chapter"><a href="#statistics">13. Statistics</a></span></dt></dl></div><div class="chapter" title="Chapter 1. Introduction"><div class="titlepage"><div><div><h2 class="title"><a name="intro"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168230299038">Supported Platforms</a></span></dt><dt><span class="section"><a href="#id1168230299065">Required Software</a></span></dt><dt><span class="section"><a href="#starting_stopping">Starting and Stopping the Server</a></span></dt><dt><span class="section"><a href="#managing_once_running">Managing BIND 10</a></span></dt></dl></div><p>
BIND is the popular implementation of a DNS server, developer
interfaces, and DNS tools.
BIND 10 is a rewrite of BIND 9. BIND 10 is written in C++ and Python
and provides a modular environment for serving and maintaining DNS.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
This guide covers the experimental prototype of
- BIND 10 version 20110120.
+ BIND 10 version 20110224.
</p></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
BIND 10 provides a EDNS0- and DNSSEC-capable
- authoritative DNS server and a forwarding DNS server.
- </p></div><div class="section" title="Supported Platforms"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168230299042"></a>Supported Platforms</h2></div></div></div><p>
+ authoritative DNS server and a caching recursive name server
+ which also provides forwarding.
+ </p></div><div class="section" title="Supported Platforms"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168230299038"></a>Supported Platforms</h2></div></div></div><p>
BIND 10 builds have been tested on Debian GNU/Linux 5,
Ubuntu 9.10, NetBSD 5, Solaris 10, FreeBSD 7 and 8, and CentOS
Linux 5.3.
@@ -27,13 +28,11 @@
It is planned for BIND 10 to build, install and run on
Windows and standard Unix-type platforms.
- </p></div><div class="section" title="Required Software"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168230299068"></a>Required Software</h2></div></div></div><p>
+ </p></div><div class="section" title="Required Software"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168230299065"></a>Required Software</h2></div></div></div><p>
BIND 10 requires Python 3.1. Later versions may work, but Python
3.1 is the minimum version which will work.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- For this development prototype release, the only supported
- data source backend is SQLite3. The authoritative server
- requires SQLite 3.3.9 or newer.
+ The authoritative server requires SQLite 3.3.9 or newer.
The <span class="command"><strong>b10-xfrin</strong></span>, <span class="command"><strong>b10-xfrout</strong></span>,
and <span class="command"><strong>b10-zonemgr</strong></span> modules require the
libpython3 library and the Python _sqlite3.so module.
@@ -133,7 +132,7 @@
and, of course, DNS. These include detailed developer
documentation and code examples.
- </p></div><div class="chapter" title="Chapter 2. Installation"><div class="titlepage"><div><div><h2 class="title"><a name="installation"></a>Chapter 2. Installation</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168230284843">Building Requirements</a></span></dt><dt><span class="section"><a href="#quickstart">Quick start</a></span></dt><dt><span class="section"><a href="#install">Installation from source</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168230285029">Download Tar File</a></span></dt><dt><span class="section"><a href="#id1168230285048">Retrieve from Git</a></span></dt><dt><span class="section"><a href="#id1168230285109">Configure before the build</a></span></dt><dt><span class="section"><a href="#id1168230285206">Build</a></span></dt><dt><span class="section"><a href="#id1168230285222">Install</a></span></dt><dt><span class="section"><a href="#id1168230285245">Install Hierarchy<
/a></span></dt></dl></dd></dl></div><div class="section" title="Building Requirements"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168230284843"></a>Building Requirements</h2></div></div></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
+ </p></div><div class="chapter" title="Chapter 2. Installation"><div class="titlepage"><div><div><h2 class="title"><a name="installation"></a>Chapter 2. Installation</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168230284842">Building Requirements</a></span></dt><dt><span class="section"><a href="#quickstart">Quick start</a></span></dt><dt><span class="section"><a href="#install">Installation from source</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168230285028">Download Tar File</a></span></dt><dt><span class="section"><a href="#id1168230285047">Retrieve from Git</a></span></dt><dt><span class="section"><a href="#id1168230285108">Configure before the build</a></span></dt><dt><span class="section"><a href="#id1168230285205">Build</a></span></dt><dt><span class="section"><a href="#id1168230285221">Install</a></span></dt><dt><span class="section"><a href="#id1168230285244">Install Hierarchy<
/a></span></dt></dl></dd></dl></div><div class="section" title="Building Requirements"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168230284842"></a>Building Requirements</h2></div></div></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
Some operating systems have split their distribution packages into
a run-time and a development package. You will need to install
the development package versions, which include header files and
@@ -193,14 +192,14 @@
the Git code revision control system or as a downloadable
tar file. It may also be available in pre-compiled ready-to-use
packages from operating system vendors.
- </p><div class="section" title="Download Tar File"><div class="titlepage"><div><div><h3 class="title"><a name="id1168230285029"></a>Download Tar File</h3></div></div></div><p>
+ </p><div class="section" title="Download Tar File"><div class="titlepage"><div><div><h3 class="title"><a name="id1168230285028"></a>Download Tar File</h3></div></div></div><p>
Downloading a release tar file is the recommended method to
obtain the source code.
</p><p>
The BIND 10 releases are available as tar file downloads from
<a class="ulink" href="ftp://ftp.isc.org/isc/bind10/" target="_top">ftp://ftp.isc.org/isc/bind10/</a>.
Periodic development snapshots may also be available.
- </p></div><div class="section" title="Retrieve from Git"><div class="titlepage"><div><div><h3 class="title"><a name="id1168230285048"></a>Retrieve from Git</h3></div></div></div><p>
+ </p></div><div class="section" title="Retrieve from Git"><div class="titlepage"><div><div><h3 class="title"><a name="id1168230285047"></a>Retrieve from Git</h3></div></div></div><p>
Downloading this "bleeding edge" code is recommended only for
developers or advanced users. Using development code in a production
environment is not recommended.
@@ -234,7 +233,7 @@
<span class="command"><strong>autoheader</strong></span>,
<span class="command"><strong>automake</strong></span>,
and related commands.
- </p></div><div class="section" title="Configure before the build"><div class="titlepage"><div><div><h3 class="title"><a name="id1168230285109"></a>Configure before the build</h3></div></div></div><p>
+ </p></div><div class="section" title="Configure before the build"><div class="titlepage"><div><div><h3 class="title"><a name="id1168230285108"></a>Configure before the build</h3></div></div></div><p>
BIND 10 uses the GNU Build System to discover build environment
details.
To generate the makefiles using the defaults, simply run:
@@ -265,16 +264,16 @@
</p><p>
If the configure fails, it may be due to missing or old
dependencies.
- </p></div><div class="section" title="Build"><div class="titlepage"><div><div><h3 class="title"><a name="id1168230285206"></a>Build</h3></div></div></div><p>
+ </p></div><div class="section" title="Build"><div class="titlepage"><div><div><h3 class="title"><a name="id1168230285205"></a>Build</h3></div></div></div><p>
After the configure step is complete, to build the executables
from the C++ code and prepare the Python scripts, run:
</p><pre class="screen">$ <strong class="userinput"><code>make</code></strong></pre><p>
- </p></div><div class="section" title="Install"><div class="titlepage"><div><div><h3 class="title"><a name="id1168230285222"></a>Install</h3></div></div></div><p>
+ </p></div><div class="section" title="Install"><div class="titlepage"><div><div><h3 class="title"><a name="id1168230285221"></a>Install</h3></div></div></div><p>
To install the BIND 10 executables, support files,
and documentation, run:
</p><pre class="screen">$ <strong class="userinput"><code>make install</code></strong></pre><p>
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The install step may require superuser privileges.</p></div></div><div class="section" title="Install Hierarchy"><div class="titlepage"><div><div><h3 class="title"><a name="id1168230285245"></a>Install Hierarchy</h3></div></div></div><p>
+ </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The install step may require superuser privileges.</p></div></div><div class="section" title="Install Hierarchy"><div class="titlepage"><div><div><h3 class="title"><a name="id1168230285244"></a>Install Hierarchy</h3></div></div></div><p>
The following is the layout of the complete BIND 10 installation:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<code class="filename">bin/</code> —
@@ -465,6 +464,8 @@ accounts_file
</p><p>
The control commands are:
print_settings
+
+
shutdown
</p></div></div><div class="chapter" title="Chapter 7. Control and configure user interface"><div class="titlepage"><div><div><h2 class="title"><a name="bindctl"></a>Chapter 7. Control and configure user interface</h2></div></div></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
For this development prototype release, <span class="command"><strong>bindctl</strong></span>
@@ -489,7 +490,7 @@ shutdown
the details and relays (over a <span class="command"><strong>b10-msgq</strong></span> command
channel) the configuration on to the specified module.
</p><p>
- </p></div><div class="chapter" title="Chapter 8. Authoritative Server"><div class="titlepage"><div><div><h2 class="title"><a name="authserver"></a>Chapter 8. Authoritative Server</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168230285821">Server Configurations</a></span></dt><dt><span class="section"><a href="#id1168230285886">Data Source Backends</a></span></dt><dt><span class="section"><a href="#id1168230285917">Loading Master Zones Files</a></span></dt></dl></div><p>
+ </p></div><div class="chapter" title="Chapter 8. Authoritative Server"><div class="titlepage"><div><div><h2 class="title"><a name="authserver"></a>Chapter 8. Authoritative Server</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168230285822">Server Configurations</a></span></dt><dt><span class="section"><a href="#id1168230285888">Data Source Backends</a></span></dt><dt><span class="section"><a href="#id1168230285918">Loading Master Zones Files</a></span></dt></dl></div><p>
The <span class="command"><strong>b10-auth</strong></span> is the authoritative DNS server.
It supports EDNS0 and DNSSEC. It supports IPv6.
Normally it is started by the <span class="command"><strong>bind10</strong></span> master
@@ -497,7 +498,7 @@ shutdown
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
This development prototype release listens on all interfaces
and the non-standard port 5300.
- </p></div><div class="section" title="Server Configurations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168230285821"></a>Server Configurations</h2></div></div></div><p>
+ </p></div><div class="section" title="Server Configurations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168230285822"></a>Server Configurations</h2></div></div></div><p>
<span class="command"><strong>b10-auth</strong></span> is configured via the
<span class="command"><strong>b10-cfgmgr</strong></span> configuration manager.
The module name is <span class="quote">“<span class="quote">Auth</span>”</span>.
@@ -517,11 +518,12 @@ This may be a temporary setting until then.
</p><div class="variablelist"><dl><dt><span class="term">shutdown</span></dt><dd>Stop the authoritative DNS server.
</dd></dl></div><p>
- </p></div><div class="section" title="Data Source Backends"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168230285886"></a>Data Source Backends</h2></div></div></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
+ </p></div><div class="section" title="Data Source Backends"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168230285888"></a>Data Source Backends</h2></div></div></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
For the development prototype release, <span class="command"><strong>b10-auth</strong></span>
- only supports the SQLite3 data source backend.
+ supports a SQLite3 data source backend and in-memory data source
+ backend.
Upcoming versions will be able to use multiple different
- data sources, such as MySQL, Berkeley DB, or in-memory DB.
+ data sources, such as MySQL and Berkeley DB.
</p></div><p>
By default, the SQLite3 backend uses the data file located at
<code class="filename">/usr/local/var/bind10-devel/zone.sqlite3</code>.
@@ -530,7 +532,7 @@ This may be a temporary setting until then.
The default is <code class="filename">/usr/local/var/</code>.)
This data file location may be changed by defining the
<span class="quote">“<span class="quote">database_file</span>”</span> configuration.
- </p></div><div class="section" title="Loading Master Zones Files"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168230285917"></a>Loading Master Zones Files</h2></div></div></div><p>
+ </p></div><div class="section" title="Loading Master Zones Files"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168230285918"></a>Loading Master Zones Files</h2></div></div></div><p>
RFC 1035 style DNS master zone files may imported
into a BIND 10 data source by using the
<span class="command"><strong>b10-loadzone</strong></span> utility.
@@ -610,11 +612,7 @@ This may be a temporary setting until then.
The <span class="command"><strong>b10-resolver</strong></span> process is started by
<span class="command"><strong>bind10</strong></span>.
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- The current version only provides a forwarding DNS server.
- It does not cache and does not iterate to find answers.
- It simply forwards the query on to another full resolver.
- </p></div><p>
+ </p><p>
The main <span class="command"><strong>bind10</strong></span> process can be configured
to select to run either the authoritative or resolver.
By default, it starts the authoritative service.
@@ -628,12 +626,20 @@ This may be a temporary setting until then.
> <strong class="userinput"><code>config commit</code></strong>
</pre><p>
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- In the current version, the master <span class="command"><strong>bind10</strong></span>
- process must be stopped and restarted to start up the resolver.
- </p></div><p>
- Then the upstream address and port must be configured to
- forward queries to, such as:
+ </p><p>
+ The master <span class="command"><strong>bind10</strong></span> will stop and start
+ the desired services.
+ </p><p>
+ The resolver also needs to be configured to listen on an address
+ and port:
+
+ </p><pre class="screen">
+> <strong class="userinput"><code>config set Resolver/listen_on [{ "address": "127.0.0.1", "port": 53 }]</code></strong>
+> <strong class="userinput"><code>config commit</code></strong>
+</pre><p>
+ </p><p>
+ To enable forwarding, the upstream address and port must be
+ configured to forward queries to, such as:
</p><pre class="screen">
> <strong class="userinput"><code>config set Resolver/forward_addresses [{ "address": "<em class="replaceable"><code>192.168.1.1</code></em>", "port": 53 }]</code></strong>
@@ -643,11 +649,11 @@ This may be a temporary setting until then.
(Replace <em class="replaceable"><code>192.168.1.1</code></em> to point to your
full resolver.)
</p><p>
- The resolver also needs to be configured to listen on an address
- and port:
+ Normal iterative name service can be re-enabled by clearing the
+ forwarding address(es); for example:
</p><pre class="screen">
-> <strong class="userinput"><code>config set Resolver/listen_on [{ "address": "127.0.0.1", "port": 53 }]</code></strong>
+> <strong class="userinput"><code>config set Resolver/forward_addresses []</code></strong>
> <strong class="userinput"><code>config commit</code></strong>
</pre><p>
</p></div><div class="chapter" title="Chapter 13. Statistics"><div class="titlepage"><div><div><h2 class="title"><a name="statistics"></a>Chapter 13. Statistics</h2></div></div></div><p>
diff --git a/doc/guide/bind10-guide.xml b/doc/guide/bind10-guide.xml
index 3670c46..0935c81 100644
--- a/doc/guide/bind10-guide.xml
+++ b/doc/guide/bind10-guide.xml
@@ -52,7 +52,8 @@
<note>
<para>
BIND 10 provides a EDNS0- and DNSSEC-capable
- authoritative DNS server and a forwarding DNS server.
+ authoritative DNS server and a caching recursive name server
+ which also provides forwarding.
</para>
</note>
@@ -79,9 +80,7 @@
</para>
<note><para>
- For this development prototype release, the only supported
- data source backend is SQLite3. The authoritative server
- requires SQLite 3.3.9 or newer.
+ The authoritative server requires SQLite 3.3.9 or newer.
The <command>b10-xfrin</command>, <command>b10-xfrout</command>,
and <command>b10-zonemgr</command> modules require the
libpython3 library and the Python _sqlite3.so module.
@@ -1108,9 +1107,10 @@ This may be a temporary setting until then.
<note><para>
For the development prototype release, <command>b10-auth</command>
- only supports the SQLite3 data source backend.
+ supports a SQLite3 data source backend and in-memory data source
+ backend.
Upcoming versions will be able to use multiple different
- data sources, such as MySQL, Berkeley DB, or in-memory DB.
+ data sources, such as MySQL and Berkeley DB.
</para></note>
@@ -1309,12 +1309,6 @@ what is XfroutClient xfr_client??
-->
</para>
- <note><simpara>
- The current version only provides a forwarding DNS server.
- It does not cache and does not iterate to find answers.
- It simply forwards the query on to another full resolver.
- </simpara></note>
-
<para>
The main <command>bind10</command> process can be configured
to select to run either the authoritative or resolver.
@@ -1331,15 +1325,26 @@ what is XfroutClient xfr_client??
</para>
-<!-- TODO: -->
- <note><simpara>
- In the current version, the master <command>bind10</command>
- process must be stopped and restarted to start up the resolver.
- </simpara></note>
+ <para>
+ The master <command>bind10</command> will stop and start
+ the desired services.
+ </para>
<para>
- Then the upstream address and port must be configured to
- forward queries to, such as:
+ The resolver also needs to be configured to listen on an address
+ and port:
+
+ <screen>
+> <userinput>config set Resolver/listen_on [{ "address": "127.0.0.1", "port": 53 }]</userinput>
+> <userinput>config commit</userinput>
+</screen>
+ </para>
+
+<!-- TODO: later the above will have some defaults -->
+
+ <para>
+ To enable forwarding, the upstream address and port must be
+ configured to forward queries to, such as:
<screen>
> <userinput>config set Resolver/forward_addresses [{ "address": "<replaceable>192.168.1.1</replaceable>", "port": 53 }]</userinput>
@@ -1351,17 +1356,15 @@ what is XfroutClient xfr_client??
</para>
<para>
- The resolver also needs to be configured to listen on an address
- and port:
+ Normal iterative name service can be re-enabled by clearing the
+ forwarding address(es); for example:
<screen>
-> <userinput>config set Resolver/listen_on [{ "address": "127.0.0.1", "port": 53 }]</userinput>
+> <userinput>config set Resolver/forward_addresses []</userinput>
> <userinput>config commit</userinput>
</screen>
</para>
-<!-- TODO: later the above will have some defaults -->
-
<!-- TODO: later try this
> config set Resolver/forward_addresses[0]/address "192.168.8.8"
diff --git a/src/bin/auth/Makefile.am b/src/bin/auth/Makefile.am
index e9097f2..cdfc55e 100644
--- a/src/bin/auth/Makefile.am
+++ b/src/bin/auth/Makefile.am
@@ -50,11 +50,13 @@ b10_auth_LDADD += $(top_builddir)/src/lib/config/libcfgclient.la
b10_auth_LDADD += $(top_builddir)/src/lib/cc/libcc.la
b10_auth_LDADD += $(top_builddir)/src/lib/exceptions/libexceptions.la
b10_auth_LDADD += $(top_builddir)/src/lib/asiolink/libasiolink.la
+b10_auth_LDADD += $(top_builddir)/src/lib/nsas/libnsas.la
b10_auth_LDADD += $(top_builddir)/src/lib/xfr/libxfr.la
+b10_auth_LDADD += $(top_builddir)/src/lib/server_common/libserver_common.la
b10_auth_LDADD += $(SQLITE_LIBS)
# TODO: config.h.in is wrong because doesn't honor pkgdatadir
# and can't use @datadir@ because doesn't expand default ${prefix}
-b10_authdir = $(DESTDIR)$(pkgdatadir)
+b10_authdir = $(pkgdatadir)
b10_auth_DATA = auth.spec
diff --git a/src/bin/auth/auth.spec.pre.in b/src/bin/auth/auth.spec.pre.in
index 8a77455..e95dabd 100644
--- a/src/bin/auth/auth.spec.pre.in
+++ b/src/bin/auth/auth.spec.pre.in
@@ -12,51 +12,85 @@
"item_type": "list",
"item_optional": true,
"item_default": [],
- "list_item_spec": {
- "item_name": "list_element",
+ "list_item_spec":
+ { "item_name": "list_element",
"item_type": "map",
"item_optional": false,
"item_default": {},
- "map_item_spec": [
- { "item_name": "type",
- "item_type": "string",
- "item_optional": false,
- "item_default": ""
- },
- { "item_name": "class",
- "item_type": "string",
- "item_optional": false,
- "item_default": "IN"
- },
- { "item_name": "zones",
- "item_type": "list",
- "item_optional": false,
- "item_default": [],
- "list_item_spec": {
- "item_name": "list_element",
- "item_type": "map",
- "item_optional": true,
- "map_item_spec": [
- { "item_name": "origin",
- "item_type": "string",
- "item_optional": false,
- "item_default": ""
- },
- { "item_name": "file",
- "item_type": "string",
- "item_optional": false,
- "item_default": ""
- }
- ]
- }
- }
- ]
+ "map_item_spec": [
+ { "item_name": "type",
+ "item_type": "string",
+ "item_optional": false,
+ "item_default": ""
+ },
+ { "item_name": "class",
+ "item_type": "string",
+ "item_optional": false,
+ "item_default": "IN"
+ },
+ { "item_name": "zones",
+ "item_type": "list",
+ "item_optional": false,
+ "item_default": [],
+ "list_item_spec":
+ { "item_name": "list_element",
+ "item_type": "map",
+ "item_optional": true,
+ "item_default": { "origin": "", "file": "" },
+ "map_item_spec": [
+ { "item_name": "origin",
+ "item_type": "string",
+ "item_optional": false,
+ "item_default": ""
+ },
+ { "item_name": "file",
+ "item_type": "string",
+ "item_optional": false,
+ "item_default": ""
+ }]
+ }
+ }]
}
},
{ "item_name": "statistics-interval",
"item_type": "integer",
"item_optional": true,
"item_default": 60
+ },
+ {
+ "item_name": "listen_on",
+ "item_type": "list",
+ "item_optional": false,
+ "item_default": [
+ {
+ "address": "::1",
+ "port": 5300
+ },
+ {
+ "address": "127.0.0.1",
+ "port": 5300
+ }
+ ],
+ "list_item_spec": {
+ "item_name": "address",
+ "item_type": "map",
+ "item_optional": false,
+ "item_default": {},
+ "map_item_spec": [
+ {
+ "item_name": "address",
+ "item_type": "string",
+ "item_optional": false,
+ "item_default": "::1"
+ },
+ {
+ "item_name": "port",
+ "item_type": "integer",
+ "item_optional": false,
+ "item_default": 5300
+ }
+ ]
+ }
}
],
"commands": [
diff --git a/src/bin/auth/auth_srv.cc b/src/bin/auth/auth_srv.cc
index 045fe7f..f46752a 100644
--- a/src/bin/auth/auth_srv.cc
+++ b/src/bin/auth/auth_srv.cc
@@ -69,6 +69,7 @@ using namespace isc::data;
using namespace isc::config;
using namespace isc::xfr;
using namespace asiolink;
+using namespace isc::server_common::portconfig;
class AuthSrvImpl {
private:
@@ -109,6 +110,9 @@ public:
/// Query counters for statistics
AuthCounters counters_;
+
+ /// Addresses we listen on
+ AddressList listen_addresses_;
private:
std::string db_file_;
@@ -750,3 +754,18 @@ uint64_t
AuthSrv::getCounter(const AuthCounters::CounterType type) const {
return (impl_->counters_.getCounter(type));
}
+
+const AddressList&
+AuthSrv::getListenAddresses() const {
+ return (impl_->listen_addresses_);
+}
+
+void
+AuthSrv::setListenAddresses(const AddressList& addresses) {
+ installListenAddresses(addresses, impl_->listen_addresses_, *dnss_);
+}
+
+void
+AuthSrv::setDNSService(asiolink::DNSService& dnss) {
+ dnss_ = &dnss;
+}
diff --git a/src/bin/auth/auth_srv.h b/src/bin/auth/auth_srv.h
index 4772a02..8253c85 100644
--- a/src/bin/auth/auth_srv.h
+++ b/src/bin/auth/auth_srv.h
@@ -25,6 +25,7 @@
#include <config/ccsession.h>
#include <asiolink/asiolink.h>
+#include <server_common/portconfig.h>
#include <auth/statistics.h>
namespace isc {
@@ -353,11 +354,24 @@ public:
/// \return the value of the counter.
uint64_t getCounter(const AuthCounters::CounterType type) const;
+ /**
+ * \brief Set and get the addresses we listen on.
+ */
+ void setListenAddresses(const isc::server_common::portconfig::AddressList&
+ addreses);
+ const isc::server_common::portconfig::AddressList& getListenAddresses()
+ const;
+
+ /// \brief Assign an ASIO DNS Service queue to this Auth object
+ void setDNSService(asiolink::DNSService& dnss);
+
+
private:
AuthSrvImpl* impl_;
asiolink::SimpleCallback* checkin_;
asiolink::DNSLookup* dns_lookup_;
asiolink::DNSAnswer* dns_answer_;
+ asiolink::DNSService* dnss_;
};
#endif // __AUTH_SRV_H
diff --git a/src/bin/auth/b10-auth.8 b/src/bin/auth/b10-auth.8
index bae8e4a..dcbe6d8 100644
--- a/src/bin/auth/b10-auth.8
+++ b/src/bin/auth/b10-auth.8
@@ -2,12 +2,12 @@
.\" Title: b10-auth
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: January 19, 2011
+.\" Date: February 22, 2011
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
-.TH "B10\-AUTH" "8" "January 19, 2011" "BIND10" "BIND10"
+.TH "B10\-AUTH" "8" "February 22, 2011" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
@@ -22,7 +22,7 @@
b10-auth \- Authoritative DNS server
.SH "SYNOPSIS"
.HP \w'\fBb10\-auth\fR\ 'u
-\fBb10\-auth\fR [\fB\-4\fR] [\fB\-6\fR] [\fB\-a\ \fR\fB\fIaddress\fR\fR] [\fB\-n\fR] [\fB\-p\ \fR\fB\fInumber\fR\fR] [\fB\-u\ \fR\fB\fIusername\fR\fR] [\fB\-v\fR]
+\fBb10\-auth\fR [\fB\-n\fR] [\fB\-u\ \fR\fB\fIusername\fR\fR] [\fB\-v\fR]
.SH "DESCRIPTION"
.PP
The
@@ -42,55 +42,11 @@ It receives its configurations from
.PP
The arguments are as follows:
.PP
-\fB\-4\fR
-.RS 4
-Enables IPv4 only mode\&. This switch may not be used with
-\fB\-6\fR
-nor
-\fB\-a\fR\&. By default, it listens on both IPv4 and IPv6 (if capable)\&.
-.RE
-.PP
-\fB\-6\fR
-.RS 4
-Enables IPv6 only mode\&. This switch may not be used with
-\fB\-4\fR
-nor
-\fB\-a\fR\&. By default, it listens on both IPv4 and IPv6 (if capable)\&.
-.RE
-.PP
-\fB\-a \fR\fB\fIaddress\fR\fR
-.RS 4
-The IPv4 or IPv6 address to listen on\&. This switch may not be used with
-\fB\-4\fR
-nor
-\fB\-6\fR\&. The default is to listen on all addresses\&. (This is a short term workaround\&. This argument may change\&.)
-.RE
-.PP
\fB\-n\fR
.RS 4
Do not cache answers in memory\&. The default is to use the cache for faster responses\&. The cache keeps the most recent 30,000 answers (positive and negative) in memory for 30 seconds (instead of querying the data source, such as SQLite3 database, each time)\&.
.RE
.PP
-\fB\-p \fR\fB\fInumber\fR\fR
-.RS 4
-The port number it listens on\&. The default is 5300\&.
-.if n \{\
-.sp
-.\}
-.RS 4
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBNote\fR
-.ps -1
-.br
-The Y1 prototype runs on all interfaces and on this nonstandard port\&.
-.sp .5v
-.RE
-.RE
-.PP
\fB\-u \fR\fB\fIusername\fR\fR
.RS 4
The user name of the
diff --git a/src/bin/auth/b10-auth.xml b/src/bin/auth/b10-auth.xml
index b22d24d..ce80689 100644
--- a/src/bin/auth/b10-auth.xml
+++ b/src/bin/auth/b10-auth.xml
@@ -20,7 +20,7 @@
<refentry>
<refentryinfo>
- <date>January 19, 2011</date>
+ <date>February 22, 2011</date>
</refentryinfo>
<refmeta>
@@ -44,11 +44,7 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>b10-auth</command>
- <arg><option>-4</option></arg>
- <arg><option>-6</option></arg>
- <arg><option>-a <replaceable>address</replaceable></option></arg>
<arg><option>-n</option></arg>
- <arg><option>-p <replaceable>number</replaceable></option></arg>
<arg><option>-u <replaceable>username</replaceable></option></arg>
<arg><option>-v</option></arg>
</cmdsynopsis>
@@ -85,39 +81,6 @@
<variablelist>
<varlistentry>
- <term><option>-4</option></term>
- <listitem><para>
- Enables IPv4 only mode.
- This switch may not be used with <option>-6</option> nor
- <option>-a</option>.
- By default, it listens on both IPv4 and IPv6 (if capable).
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-6</option></term>
- <listitem><para>
- Enables IPv6 only mode.
- This switch may not be used with <option>-4</option> nor
- <option>-a</option>.
- By default, it listens on both IPv4 and IPv6 (if capable).
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-a <replaceable>address</replaceable></option></term>
-
- <listitem>
- <para>The IPv4 or IPv6 address to listen on.
- This switch may not be used with <option>-4</option> nor
- <option>-6</option>.
- The default is to listen on all addresses.
- (This is a short term workaround. This argument may change.)
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term><option>-n</option></term>
<listitem><para>
Do not cache answers in memory.
@@ -130,16 +93,6 @@
</varlistentry>
<varlistentry>
- <term><option>-p <replaceable>number</replaceable></option></term>
- <listitem><para>
- The port number it listens on.
- The default is 5300.</para>
- <note><simpara>This prototype runs on all interfaces
- and on this nonstandard port.</simpara></note>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term><option>-u <replaceable>username</replaceable></option></term>
<listitem>
<para>
diff --git a/src/bin/auth/benchmarks/Makefile.am b/src/bin/auth/benchmarks/Makefile.am
index 05ab754..3078dd5 100644
--- a/src/bin/auth/benchmarks/Makefile.am
+++ b/src/bin/auth/benchmarks/Makefile.am
@@ -21,5 +21,7 @@ query_bench_LDADD += $(top_builddir)/src/lib/config/libcfgclient.la
query_bench_LDADD += $(top_builddir)/src/lib/cc/libcc.la
query_bench_LDADD += $(top_builddir)/src/lib/xfr/libxfr.la
query_bench_LDADD += $(top_builddir)/src/lib/log/liblog.la
+query_bench_LDADD += $(top_builddir)/src/lib/nsas/libnsas.la
query_bench_LDADD += $(top_builddir)/src/lib/asiolink/libasiolink.la
+query_bench_LDADD += $(top_builddir)/src/lib/server_common/libserver_common.la
query_bench_LDADD += $(SQLITE_LIBS)
diff --git a/src/bin/auth/benchmarks/query_bench.cc b/src/bin/auth/benchmarks/query_bench.cc
index 7f643f3..5e69134 100644
--- a/src/bin/auth/benchmarks/query_bench.cc
+++ b/src/bin/auth/benchmarks/query_bench.cc
@@ -77,7 +77,7 @@ protected:
dummy_socket(IOSocket::getDummyUDPSocket()),
dummy_endpoint(IOEndpointPtr(IOEndpoint::create(IPPROTO_UDP,
IOAddress("192.0.2.1"),
- 5300)))
+ 53210)))
{}
public:
unsigned int run() {
diff --git a/src/bin/auth/config.cc b/src/bin/auth/config.cc
index 5befc6e..f289ca0 100644
--- a/src/bin/auth/config.cc
+++ b/src/bin/auth/config.cc
@@ -32,11 +32,14 @@
#include <auth/config.h>
#include <auth/common.h>
+#include <server_common/portconfig.h>
+
using namespace std;
using boost::shared_ptr;
using namespace isc::dns;
using namespace isc::data;
using namespace isc::datasrc;
+using namespace isc::server_common::portconfig;
namespace {
// Forward declaration
@@ -210,6 +213,60 @@ public:
}
};
+/**
+ * \brief Configuration parser for listen_on.
+ *
+ * It parses and sets the listening addresses of the server.
+ *
+ * It acts in unusual way. Since actually binding (changing) the sockets
+ * is an operation that is expected to throw often, it shouldn't happen
+ * in commit. Thefere we do it in build. But if the config is not committed
+ * then, we would have it wrong. So we store the old addresses and if
+ * commit is not called before destruction of the object, we return the
+ * old addresses (which is the same kind of dangerous operation, but it is
+ * expected that if we just managed to bind some and had the old ones binded
+ * before, it should work).
+ *
+ * We might do something better in future (like open only the ports that are
+ * extra, put them in in commit and close the old ones), but that's left out
+ * for now.
+ */
+class ListenAddressConfig : public AuthConfigParser {
+public:
+ ListenAddressConfig(AuthSrv& server) :
+ server_(server)
+ { }
+ ~ ListenAddressConfig() {
+ if (rollbackAddresses_.get() != NULL) {
+ server_.setListenAddresses(*rollbackAddresses_);
+ }
+ }
+private:
+ typedef auto_ptr<AddressList> AddrListPtr;
+public:
+ virtual void build(ConstElementPtr config) {
+ AddressList newAddresses = parseAddresses(config, "listen_on");
+ AddrListPtr old(new AddressList(server_.getListenAddresses()));
+ server_.setListenAddresses(newAddresses);
+ /*
+ * Set the rollback addresses only after successful setting of the
+ * new addresses, so we don't try to rollback if the setup is
+ * unsuccessful (the above can easily throw).
+ */
+ rollbackAddresses_ = old;
+ }
+ virtual void commit() {
+ rollbackAddresses_.release();
+ }
+private:
+ AuthSrv& server_;
+ /**
+ * This is the old address list, if we expect to roll back. When we commit,
+ * this is set to NULL.
+ */
+ AddrListPtr rollbackAddresses_;
+};
+
// This is a generalized version of create function that can create
// an AuthConfigParser object for "internal" use.
AuthConfigParser*
@@ -226,6 +283,8 @@ createAuthConfigParser(AuthSrv& server, const std::string& config_id,
return (new StatisticsIntervalConfig(server));
} else if (internal && config_id == "datasources/memory") {
return (new MemoryDatasourceConfig(server));
+ } else if (config_id == "listen_on") {
+ return (new ListenAddressConfig(server));
} else if (config_id == "_commit_throw") {
// This is for testing purpose only and should not appear in the
// actual configuration syntax. While this could crash the caller
@@ -271,7 +330,7 @@ configureAuthServer(AuthSrv& server, ConstElementPtr config_set) {
parsers.push_back(parser);
}
} catch (const AuthConfigError& ex) {
- throw ex; // simply rethrowing it
+ throw; // simply rethrowing it
} catch (const isc::Exception& ex) {
isc_throw(AuthConfigError, "Server configuration failed: " <<
ex.what());
diff --git a/src/bin/auth/main.cc b/src/bin/auth/main.cc
index 10e1194..275ae7d 100644
--- a/src/bin/auth/main.cc
+++ b/src/bin/auth/main.cc
@@ -42,6 +42,7 @@
#include <auth/change_user.h>
#include <auth/auth_srv.h>
#include <asiolink/asiolink.h>
+#include <log/dummylog.h>
using namespace std;
using namespace isc::data;
@@ -55,9 +56,6 @@ namespace {
bool verbose_mode = false;
-// Default port current 5300 for testing purposes
-const char* DNSPORT = "5300";
-
/* need global var for config/command handlers.
* todo: turn this around, and put handlers in the authserver
* class itself? */
@@ -76,13 +74,8 @@ my_command_handler(const string& command, ConstElementPtr args) {
void
usage() {
- cerr << "Usage: b10-auth [-a address] [-p port] [-u user] [-4|-6] [-nv]"
- << endl;
- cerr << "\t-a: specify the address to listen on (default: all) " << endl;
- cerr << "\t-p: specify the port to listen on (default: " << DNSPORT << ")"
+ cerr << "Usage: b10-auth [-u user] [-nv]"
<< endl;
- cerr << "\t-4: listen on all IPv4 addresses (incompatible with -a)" << endl;
- cerr << "\t-6: listen on all IPv6 addresses (incompatible with -a)" << endl;
cerr << "\t-n: do not cache answers in memory" << endl;
cerr << "\t-u: change process UID to the specified user" << endl;
cerr << "\t-v: verbose output" << endl;
@@ -93,38 +86,20 @@ usage() {
int
main(int argc, char* argv[]) {
int ch;
- const char* port = DNSPORT;
- const char* address = NULL;
const char* uid = NULL;
- bool use_ipv4 = true, use_ipv6 = true, cache = true;
+ bool cache = true;
- while ((ch = getopt(argc, argv, "46a:np:u:v")) != -1) {
+ while ((ch = getopt(argc, argv, ":nu:v")) != -1) {
switch (ch) {
- case '4':
- // Note that -4 means "ipv4 only", we need to set "use_ipv6" here,
- // not "use_ipv4". We could use something like "ipv4_only", but
- // we found the negatively named variable could confuse the code
- // logic.
- use_ipv6 = false;
- break;
- case '6':
- // The same note as -4 applies.
- use_ipv4 = false;
- break;
case 'n':
cache = false;
break;
- case 'a':
- address = optarg;
- break;
- case 'p':
- port = optarg;
- break;
case 'u':
uid = optarg;
break;
case 'v':
verbose_mode = true;
+ isc::log::denabled = true;
break;
case '?':
default:
@@ -136,18 +111,6 @@ main(int argc, char* argv[]) {
usage();
}
- if (!use_ipv4 && !use_ipv6) {
- cerr << "[b10-auth] Error: Cannot specify both -4 and -6 "
- << "at the same time" << endl;
- usage();
- }
-
- if ((!use_ipv4 || !use_ipv6) && address != NULL) {
- cerr << "[b10-auth] Error: Cannot specify -4 or -6 "
- << "at the same time as -a" << endl;
- usage();
- }
-
int ret = 0;
// XXX: we should eventually pass io_service here.
@@ -182,21 +145,8 @@ main(int argc, char* argv[]) {
DNSLookup* lookup = auth_server->getDNSLookupProvider();
DNSAnswer* answer = auth_server->getDNSAnswerProvider();
- DNSService* dns_service;
- if (address != NULL) {
- // XXX: we can only specify at most one explicit address.
- // This also means the server cannot run in the dual address
- // family mode if explicit addresses need to be specified.
- // We don't bother to fix this problem, however. The -a option
- // is a short term workaround until we support dynamic listening
- // port allocation.
- dns_service = new DNSService(io_service, *port, *address,
- checkin, lookup, answer);
- } else {
- dns_service = new DNSService(io_service, *port, use_ipv4,
- use_ipv6, checkin, lookup,
- answer);
- }
+ DNSService dns_service(io_service, checkin, lookup, answer);
+ auth_server->setDNSService(dns_service);
cout << "[b10-auth] DNSServices created." << endl;
cc_session = new Session(io_service.get_io_service());
@@ -237,7 +187,6 @@ main(int argc, char* argv[]) {
cout << "[b10-auth] Server started." << endl;
io_service.run();
- delete dns_service;
} catch (const std::exception& ex) {
cerr << "[b10-auth] Server failed: " << ex.what() << endl;
ret = 1;
diff --git a/src/bin/auth/tests/Makefile.am b/src/bin/auth/tests/Makefile.am
index a1114e4..7d489a1 100644
--- a/src/bin/auth/tests/Makefile.am
+++ b/src/bin/auth/tests/Makefile.am
@@ -45,6 +45,8 @@ run_unittests_LDADD += $(top_builddir)/src/lib/cc/libcc.la
run_unittests_LDADD += $(top_builddir)/src/lib/exceptions/libexceptions.la
run_unittests_LDADD += $(top_builddir)/src/lib/xfr/libxfr.la
run_unittests_LDADD += $(top_builddir)/src/lib/log/liblog.la
+run_unittests_LDADD += $(top_builddir)/src/lib/server_common/libserver_common.la
+run_unittests_LDADD += $(top_builddir)/src/lib/nsas/libnsas.la
endif
noinst_PROGRAMS = $(TESTS)
diff --git a/src/bin/auth/tests/auth_srv_unittest.cc b/src/bin/auth/tests/auth_srv_unittest.cc
index 576799c..379342e 100644
--- a/src/bin/auth/tests/auth_srv_unittest.cc
+++ b/src/bin/auth/tests/auth_srv_unittest.cc
@@ -26,6 +26,8 @@
#include <dns/rrttl.h>
#include <dns/rdataclass.h>
+#include <server_common/portconfig.h>
+
#include <datasrc/memory_datasrc.h>
#include <auth/auth_srv.h>
#include <auth/common.h>
@@ -34,6 +36,7 @@
#include <dns/tests/unittest_util.h>
#include <testutils/dnsmessage_test.h>
#include <testutils/srv_test.h>
+#include <testutils/portconfig.h>
using namespace std;
using namespace isc::cc;
@@ -43,6 +46,7 @@ using namespace isc::data;
using namespace isc::xfr;
using namespace asiolink;
using namespace isc::testutils;
+using namespace isc::server_common::portconfig;
using isc::UnitTestUtil;
namespace {
@@ -55,7 +59,12 @@ const char* const BADCONFIG_TESTDB =
class AuthSrvTest : public SrvTestBase {
protected:
- AuthSrvTest() : server(true, xfrout), rrclass(RRClass::IN()) {
+ AuthSrvTest() :
+ dnss_(ios_, NULL, NULL, NULL),
+ server(true, xfrout),
+ rrclass(RRClass::IN())
+ {
+ server.setDNSService(dnss_);
server.setXfrinSession(¬ify_session);
server.setStatisticsSession(&statistics_session);
}
@@ -63,6 +72,8 @@ protected:
server.processMessage(*io_message, parse_message, response_obuffer,
&dnsserv);
}
+ IOService ios_;
+ DNSService dnss_;
MockSession statistics_session;
MockXfroutClient xfrout;
AuthSrv server;
@@ -633,7 +644,7 @@ TEST_F(AuthSrvTest, queryCounterUnexpected) {
// Modify the message.
delete io_message;
endpoint = IOEndpoint::create(IPPROTO_UDP,
- IOAddress(DEFAULT_REMOTE_ADDRESS), 5300);
+ IOAddress(DEFAULT_REMOTE_ADDRESS), 53210);
io_message = new IOMessage(request_renderer.getData(),
request_renderer.getLength(),
getDummyUnknownSocket(), *endpoint);
@@ -650,4 +661,9 @@ TEST_F(AuthSrvTest, stop) {
// If/when the interval timer has finer granularity we'll probably add
// our own tests here, so we keep this empty test case.
}
+
+TEST_F(AuthSrvTest, listenAddresses) {
+ isc::testutils::portconfig::listenAddresses(server);
+}
+
}
diff --git a/src/bin/auth/tests/config_unittest.cc b/src/bin/auth/tests/config_unittest.cc
index b8b379e..8cce0af 100644
--- a/src/bin/auth/tests/config_unittest.cc
+++ b/src/bin/auth/tests/config_unittest.cc
@@ -30,6 +30,7 @@
#include <auth/common.h>
#include <testutils/mockups.h>
+#include <testutils/portconfig.h>
using namespace isc::dns;
using namespace isc::data;
@@ -39,7 +40,15 @@ using namespace asiolink;
namespace {
class AuthConfigTest : public ::testing::Test {
protected:
- AuthConfigTest() : rrclass(RRClass::IN()), server(true, xfrout) {}
+ AuthConfigTest() :
+ dnss_(ios_, NULL, NULL, NULL),
+ rrclass(RRClass::IN()),
+ server(true, xfrout)
+ {
+ server.setDNSService(dnss_);
+ }
+ IOService ios_;
+ DNSService dnss_;
const RRClass rrclass;
MockXfroutClient xfrout;
AuthSrv server;
@@ -112,6 +121,17 @@ TEST_F(AuthConfigTest, exceptionFromCommit) {
FatalError);
}
+// Test invalid address configs are rejected
+TEST_F(AuthConfigTest, invalidListenAddressConfig) {
+ // This currently passes simply because the config doesn't know listen_on
+ isc::testutils::portconfig::invalidListenAddressConfig(server);
+}
+
+// Try setting addresses trough config
+TEST_F(AuthConfigTest, listenAddressConfig) {
+ isc::testutils::portconfig::listenAddressConfig(server);
+}
+
class MemoryDatasrcConfigTest : public AuthConfigTest {
protected:
MemoryDatasrcConfigTest() :
diff --git a/src/bin/auth/tests/query_unittest.cc b/src/bin/auth/tests/query_unittest.cc
index 2d3cf03..05dd748 100644
--- a/src/bin/auth/tests/query_unittest.cc
+++ b/src/bin/auth/tests/query_unittest.cc
@@ -201,7 +201,7 @@ MockZone::find(const Name& name, const RRType& type,
// If not found but we have a target, fill it with all RRsets here
if (!found_domain->second.empty() && target != NULL) {
for (found_rrset = found_domain->second.begin();
- found_rrset != found_domain->second.end(); found_rrset++) {
+ found_rrset != found_domain->second.end(); ++found_rrset) {
// Insert RRs under the domain name into target
target->addRRset(
boost::const_pointer_cast<RRset>(found_rrset->second));
diff --git a/src/bin/bind10/Makefile.am b/src/bin/bind10/Makefile.am
index 1445b95..254875f 100644
--- a/src/bin/bind10/Makefile.am
+++ b/src/bin/bind10/Makefile.am
@@ -5,7 +5,7 @@ CLEANFILES = bind10 bind10.pyc
pkglibexecdir = $(libexecdir)/@PACKAGE@
-bind10dir = $(DESTDIR)$(pkgdatadir)
+bind10dir = $(pkgdatadir)
bind10_DATA = bob.spec
EXTRA_DIST = bob.spec
@@ -19,7 +19,6 @@ bind10.8: bind10.xml
endif
-# TODO: does this need $$(DESTDIR) also?
# this is done here since configure.ac AC_OUTPUT doesn't expand exec_prefix
bind10: bind10.py
$(SED) -e "s|@@PYTHONPATH@@|@pyexecdir@|" \
diff --git a/src/bin/bind10/bind10.8 b/src/bin/bind10/bind10.8
index a3ac653..a75136b 100644
--- a/src/bin/bind10/bind10.8
+++ b/src/bin/bind10/bind10.8
@@ -2,12 +2,12 @@
.\" Title: bind10
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: July 29, 2010
+.\" Date: February 22, 2011
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
-.TH "BIND10" "8" "July 29, 2010" "BIND10" "BIND10"
+.TH "BIND10" "8" "February 22, 2011" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
@@ -22,7 +22,7 @@
bind10 \- BIND 10 boss process
.SH "SYNOPSIS"
.HP \w'\fBbind10\fR\ 'u
-\fBbind10\fR [\fB\-a\ \fR\fB\fIaddress\fR\fR] [\fB\-m\ \fR\fB\fIfile\fR\fR] [\fB\-n\fR] [\fB\-p\ \fR\fB\fInumber\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\fR] [\fB\-\-address\ \fR\fB\fIaddress\fR\fR] [\fB\-\-msgq\-socket\-file\ \fR\fB\fIfile\fR\fR] [\fB\-\-no\-cache\fR] [\fB\-\-port\ \fR\fB\fInumber\fR\fR] [\fB\-\-user\ \fR\fB\fIuser\fR\fR] [\fB\-\-pretty\-name\ \fR\fB\fIname\fR\fR] [\fB\-\-verbose\fR]
+\fBbind10\fR [\fB\-m\ \fR\fB\fIfile\fR\fR] [\fB\-n\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\fR] [\fB\-\-msgq\-socket\-file\ \fR\fB\fIfile\fR\fR] [\fB\-\-no\-cache\fR] [\fB\-\-user\ \fR\fB\fIuser\fR\fR] [\fB\-\-pretty\-name\ \fR\fB\fIname\fR\fR] [\fB\-\-verbose\fR]
.SH "DESCRIPTION"
.PP
The
@@ -32,13 +32,6 @@ daemon starts up other BIND 10 required daemons\&. It handles restarting of exit
.PP
The arguments are as follows:
.PP
-\fB\-a\fR \fIaddress\fR, \fB\-\-address\fR \fIaddress\fR
-.RS 4
-The IPv4 or IPv6 address for the
-\fBb10-auth\fR(8)
-daemon to listen on\&. The default is to listen on all addresses\&. (This is a short term workaround\&. This argument may change\&.)
-.RE
-.PP
\fB\-m\fR \fIfile\fR, \fB\-\-msgq\-socket\-file\fR \fIfile\fR
.RS 4
The UNIX domain socket file for the
@@ -54,28 +47,6 @@ Disables the hot\-spot caching used by the
daemon\&.
.RE
.PP
-\fB\-p\fR \fInumber\fR, \fB\-\-port\fR \fInumber\fR
-.RS 4
-The port number for the
-\fBb10-auth\fR(8)
-daemon to listen on\&. The default is 5300\&.
-.if n \{\
-.sp
-.\}
-.RS 4
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBNote\fR
-.ps -1
-.br
-The Y1 prototype release uses a non\-default port for domain service\&.
-.sp .5v
-.RE
-.RE
-.PP
\fB\-u\fR \fIuser\fR, \fB\-\-user\fR \fIname\fR
.RS 4
The username for
@@ -125,5 +96,5 @@ The
daemon was initially designed by Shane Kerr of ISC\&.
.SH "COPYRIGHT"
.br
-Copyright \(co 2010 Internet Systems Consortium, Inc. ("ISC")
+Copyright \(co 2011 Internet Systems Consortium, Inc. ("ISC")
.br
diff --git a/src/bin/bind10/bind10.py.in b/src/bin/bind10/bind10.py.in
old mode 100644
new mode 100755
index ddecd27..06f141e
--- a/src/bin/bind10/bind10.py.in
+++ b/src/bin/bind10/bind10.py.in
@@ -72,7 +72,7 @@ isc.util.process.rename(sys.argv[0])
# This is the version that gets displayed to the user.
# The VERSION string consists of the module name, the module version
# number, and the overall BIND 10 version number (set in configure.ac).
-VERSION = "bind10 20101129 (BIND 10 @PACKAGE_VERSION@)"
+VERSION = "bind10 20110223 (BIND 10 @PACKAGE_VERSION@)"
# This is for bind10.boottime of stats module
_BASETIME = time.gmtime()
@@ -194,8 +194,8 @@ class CChannelConnectError(Exception): pass
class BoB:
"""Boss of BIND class."""
- def __init__(self, msgq_socket_file=None, dns_port=5300, address=None,
- nocache=False, verbose=False, setuid=None, username=None):
+ def __init__(self, msgq_socket_file=None, nocache=False, verbose=False,
+ setuid=None, username=None):
"""
Initialize the Boss of BIND. This is a singleton (only one can run).
@@ -203,29 +203,72 @@ class BoB:
msgq process listens on. If verbose is True, then the boss reports
what it is doing.
"""
- self.address = address
- self.dns_port = dns_port
self.cc_session = None
self.ccs = None
self.cfg_start_auth = True
self.cfg_start_resolver = False
+ self.started_auth_family = False
+ self.started_resolver_family = False
self.curproc = None
self.dead_processes = {}
self.msgq_socket_file = msgq_socket_file
self.nocache = nocache
self.processes = {}
+ self.expected_shutdowns = {}
self.runnable = False
self.uid = setuid
self.username = username
self.verbose = verbose
def config_handler(self, new_config):
+ # If this is initial update, don't do anything now, leave it to startup
+ if not self.runnable:
+ return
+ # Now we declare few functions used only internally here. Besides the
+ # benefit of not polluting the name space, they are closures, so we
+ # don't need to pass some variables
+ def start_stop(name, started, start, stop):
+ if not'start_' + name in new_config:
+ return
+ if new_config['start_' + name]:
+ if not started:
+ if self.uid is not None:
+ sys.stderr.write("[bind10] Starting " + name + " as " +
+ "a user, not root. This might fail.\n")
+ start()
+ else:
+ stop()
+ # These four functions are passed to start_stop (smells like functional
+ # programming little bit)
+ def resolver_on():
+ self.start_resolver(self.c_channel_env)
+ self.started_resolver_family = True
+ def resolver_off():
+ self.stop_resolver()
+ self.started_resolver_family = False
+ def auth_on():
+ self.start_auth(self.c_channel_env)
+ self.start_xfrout(self.c_channel_env)
+ self.start_xfrin(self.c_channel_env)
+ self.start_zonemgr(self.c_channel_env)
+ self.started_auth_family = True
+ def auth_off():
+ self.stop_zonemgr()
+ self.stop_xfrin()
+ self.stop_xfrout()
+ self.stop_auth()
+ self.started_auth_family = False
+
+ # The real code of the config handler function follows here
if self.verbose:
sys.stdout.write("[bind10] Handling new configuration: " +
str(new_config) + "\n")
+ start_stop('resolver', self.started_resolver_family, resolver_on,
+ resolver_off)
+ start_stop('auth', self.started_auth_family, auth_on, auth_off)
+
answer = isc.config.ccsession.create_answer(0)
return answer
- # TODO
def command_handler(self, command, args):
if self.verbose:
@@ -314,8 +357,8 @@ class BoB:
sys.stdout.write("\n")
# The next few methods start the individual processes of BIND-10. They
- # are called via start_all_process(). If any fail, an exception is raised
- # which is caught by the caller of start_all_processes(); this kills
+ # are called via start_all_processes(). If any fail, an exception is
+ # raised which is caught by the caller of start_all_processes(); this kills
# processes started up to that point before terminating the program.
def start_msgq(self, c_channel_env):
@@ -417,9 +460,6 @@ class BoB:
Start the Authoritative server
"""
authargs = ['b10-auth']
- authargs += ['-p', str(self.dns_port)]
- if self.address:
- authargs += ['-a', str(self.address)]
if self.nocache:
authargs += ['-n']
if self.uid:
@@ -428,8 +468,7 @@ class BoB:
authargs += ['-v']
# ... and start
- self.start_process("b10-auth", authargs, c_channel_env,
- self.dns_port, self.address)
+ self.start_process("b10-auth", authargs, c_channel_env)
def start_resolver(self, c_channel_env):
"""
@@ -467,11 +506,12 @@ class BoB:
# XXX: we hardcode port 8080
self.start_simple("b10-cmdctl", c_channel_env, 8080)
- def start_all_processes(self, c_channel_env):
+ def start_all_processes(self):
"""
Starts up all the processes. Any exception generated during the
starting of the processes is handled by the caller.
"""
+ c_channel_env = self.c_channel_env
self.start_msgq(c_channel_env)
self.start_cfgmgr(c_channel_env)
self.start_ccsession(c_channel_env)
@@ -488,6 +528,7 @@ class BoB:
# ... and resolver (if selected):
if self.cfg_start_resolver:
self.start_resolver(c_channel_env)
+ self.started_resolver_family = True
# Everything after the main components can run as non-root.
# TODO: this is only temporary - once the privileged socket creator is
@@ -501,6 +542,7 @@ class BoB:
self.start_xfrout(c_channel_env)
self.start_xfrin(c_channel_env)
self.start_zonemgr(c_channel_env)
+ self.started_auth_family = True
# ... and finally start the remaining processes
self.start_stats(c_channel_env)
@@ -532,7 +574,8 @@ class BoB:
# Start all processes. If any one fails to start, kill all started
# processes and exit with an error indication.
try:
- self.start_all_processes(c_channel_env)
+ self.c_channel_env = c_channel_env
+ self.start_all_processes()
except Exception as e:
self.kill_started_processes()
return "Unable to start " + self.curproc + ": " + str(e)
@@ -555,10 +598,35 @@ class BoB:
self.cc_session.group_sendmsg(cmd, "Stats", "Stats")
self.cc_session.group_sendmsg(cmd, "StatsHttpd", "StatsHttpd")
- def stop_process(self, process):
- """Stop the given process, friendly-like."""
- # XXX nothing yet
- pass
+ def stop_process(self, process, recipient):
+ """
+ Stop the given process, friendly-like. The process is the name it has
+ (in logs, etc), the recipient is the address on msgq.
+ """
+ if self.verbose:
+ sys.stdout.write("[bind10] Asking %s to terminate\n" % process)
+ # TODO: Some timeout to solve processes that don't want to die would
+ # help. We can even store it in the dict, it is used only as a set
+ self.expected_shutdowns[process] = 1
+ # Ask the process to die willingly
+ self.cc_session.group_sendmsg({'command': ['shutdown']}, recipient,
+ recipient)
+
+ # Series of stop_process wrappers
+ def stop_resolver(self):
+ self.stop_process('b10-resolver', 'Resolver')
+
+ def stop_auth(self):
+ self.stop_process('b10-auth', 'Auth')
+
+ def stop_xfrout(self):
+ self.stop_process('b10-xfrout', 'Xfrout')
+
+ def stop_xfrin(self):
+ self.stop_process('b10-xfrin', 'Xfrin')
+
+ def stop_zonemgr(self):
+ self.stop_process('b10-zonemgr', 'Zonemgr')
def shutdown(self):
"""Stop the BoB instance."""
@@ -664,6 +732,10 @@ class BoB:
still_dead = {}
now = time.time()
for proc_info in self.dead_processes.values():
+ if proc_info.name in self.expected_shutdowns:
+ # We don't restart, we wanted it to die
+ del self.expected_shutdowns[proc_info.name]
+ continue
restart_time = proc_info.restart_schedule.get_restart_time(now)
if restart_time > now:
if (next_restart is None) or (next_restart > restart_time):
@@ -714,28 +786,6 @@ def fatal_signal(signal_number, stack_frame):
signal.signal(signal.SIGCHLD, signal.SIG_DFL)
boss_of_bind.runnable = False
-def check_port(option, opt_str, value, parser):
- """Function to insure that the port we are passed is actually
- a valid port number. Used by OptionParser() on startup."""
- try:
- if opt_str in ['-p', '--port']:
- parser.values.dns_port = isc.net.parse.port_parse(value)
- else:
- raise OptionValueError("Unknown option " + opt_str)
- except ValueError as e:
- raise OptionValueError(str(e))
-
-def check_addr(option, opt_str, value, parser):
- """Function to insure that the address we are passed is actually
- a valid address. Used by OptionParser() on startup."""
- try:
- if opt_str in ['-a', '--address']:
- parser.values.address = isc.net.parse.addr_parse(value)
- else:
- raise OptionValueError("Unknown option " + opt_str)
- except ValueError:
- raise OptionValueError("%s requires a valid IPv4 or IPv6 address" % opt_str)
-
def process_rename(option, opt_str, value, parser):
"""Function that renames the process if it is requested by a option."""
isc.util.process.rename(value)
@@ -748,17 +798,11 @@ def main():
# Parse any command-line options.
parser = OptionParser(version=VERSION)
- parser.add_option("-a", "--address", dest="address", type="string",
- action="callback", callback=check_addr, default=None,
- help="address the DNS server will use (default: listen on all addresses)")
parser.add_option("-m", "--msgq-socket-file", dest="msgq_socket_file",
type="string", default=None,
help="UNIX domain socket file the b10-msgq daemon will use")
parser.add_option("-n", "--no-cache", action="store_true", dest="nocache",
default=False, help="disable hot-spot cache in authoritative DNS server")
- parser.add_option("-p", "--port", dest="dns_port", type="int",
- action="callback", callback=check_port, default=5300,
- help="port the DNS server will use (default 5300)")
parser.add_option("-u", "--user", dest="user", type="string", default=None,
help="Change user after startup (must run as root)")
parser.add_option("-v", "--verbose", dest="verbose", action="store_true",
@@ -819,9 +863,8 @@ def main():
signal.signal(signal.SIGPIPE, signal.SIG_IGN)
# Go bob!
- boss_of_bind = BoB(options.msgq_socket_file, options.dns_port,
- options.address, options.nocache, options.verbose,
- setuid, username)
+ boss_of_bind = BoB(options.msgq_socket_file, options.nocache,
+ options.verbose, setuid, username)
startup_result = boss_of_bind.startup()
if startup_result:
sys.stderr.write("[bind10] Error on startup: %s\n" % startup_result)
diff --git a/src/bin/bind10/bind10.xml b/src/bin/bind10/bind10.xml
index dfc8acf..f3964a6 100644
--- a/src/bin/bind10/bind10.xml
+++ b/src/bin/bind10/bind10.xml
@@ -20,7 +20,7 @@
<refentry>
<refentryinfo>
- <date>July 29, 2010</date>
+ <date>February 22, 2011</date>
</refentryinfo>
<refmeta>
@@ -36,24 +36,20 @@
<docinfo>
<copyright>
- <year>2010</year>
+ <year>2011</year>
<holder>Internet Systems Consortium, Inc. ("ISC")</holder>
</copyright>
</docinfo>
<refsynopsisdiv>
<cmdsynopsis>
- <command>bind10</command>
- <arg><option>-a <replaceable>address</replaceable></option></arg>
+ <command>bind10</command>
<arg><option>-m <replaceable>file</replaceable></option></arg>
<arg><option>-n</option></arg>
- <arg><option>-p <replaceable>number</replaceable></option></arg>
<arg><option>-u <replaceable>user</replaceable></option></arg>
<arg><option>-v</option></arg>
- <arg><option>--address <replaceable>address</replaceable></option></arg>
<arg><option>--msgq-socket-file <replaceable>file</replaceable></option></arg>
<arg><option>--no-cache</option></arg>
- <arg><option>--port <replaceable>number</replaceable></option></arg>
<arg><option>--user <replaceable>user</replaceable></option></arg>
<arg><option>--pretty-name <replaceable>name</replaceable></option></arg>
<arg><option>--verbose</option></arg>
@@ -86,19 +82,6 @@
<variablelist>
<varlistentry>
- <term><option>-a</option> <replaceable>address</replaceable>, <option>--address</option> <replaceable>address</replaceable></term>
-
- <listitem>
- <para>The IPv4 or IPv6 address for the
- <citerefentry><refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
- daemon to listen on.
- The default is to listen on all addresses.
- (This is a short term workaround. This argument may change.)
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term><option>-m</option> <replaceable>file</replaceable>,
<option>--msgq-socket-file</option> <replaceable>file</replaceable></term>
@@ -123,20 +106,6 @@
</varlistentry>
<varlistentry>
- <term><option>-p</option> <replaceable>number</replaceable>, <option>--port</option> <replaceable>number</replaceable></term>
-
- <listitem>
- <para>The port number for the
- <citerefentry><refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
- daemon to listen on.
- The default is 5300.</para>
-<!-- TODO: -->
- <note><simpara>This prototype release uses a non-default
- port for domain service.</simpara></note>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term><option>-u</option> <replaceable>user</replaceable>, <option>--user</option> <replaceable>name</replaceable></term>
<listitem>
@@ -155,7 +124,11 @@
<para>The name this process should have in tools like
<command>ps</command> or <command>top</command>. This
is handy if you have multiple versions/installations
- of <command>bind10</command>.</para>
+ of <command>bind10</command>.
+<!-- TODO: only supported with setproctitle feature
+The default is the basename of ARG 0.
+-->
+</para>
</listitem>
</varlistentry>
diff --git a/src/bin/bind10/tests/bind10_test.py b/src/bin/bind10/tests/bind10_test.py
index 9a1066a..c241d33 100644
--- a/src/bin/bind10/tests/bind10_test.py
+++ b/src/bin/bind10/tests/bind10_test.py
@@ -78,8 +78,6 @@ class TestBoB(unittest.TestCase):
bob = BoB()
self.assertEqual(bob.verbose, False)
self.assertEqual(bob.msgq_socket_file, None)
- self.assertEqual(bob.dns_port, 5300)
- self.assertEqual(bob.address, None)
self.assertEqual(bob.cc_session, None)
self.assertEqual(bob.ccs, None)
self.assertEqual(bob.processes, {})
@@ -95,8 +93,6 @@ class TestBoB(unittest.TestCase):
bob = BoB("alt_socket_file")
self.assertEqual(bob.verbose, False)
self.assertEqual(bob.msgq_socket_file, "alt_socket_file")
- self.assertEqual(bob.address, None)
- self.assertEqual(bob.dns_port, 5300)
self.assertEqual(bob.cc_session, None)
self.assertEqual(bob.ccs, None)
self.assertEqual(bob.processes, {})
@@ -108,47 +104,13 @@ class TestBoB(unittest.TestCase):
self.assertEqual(bob.cfg_start_auth, True)
self.assertEqual(bob.cfg_start_resolver, False)
- def test_init_alternate_dns_port(self):
- bob = BoB(None, 9999)
- self.assertEqual(bob.verbose, False)
- self.assertEqual(bob.msgq_socket_file, None)
- self.assertEqual(bob.dns_port, 9999)
- self.assertEqual(bob.address, None)
- self.assertEqual(bob.cc_session, None)
- self.assertEqual(bob.ccs, None)
- self.assertEqual(bob.processes, {})
- self.assertEqual(bob.dead_processes, {})
- self.assertEqual(bob.runnable, False)
- self.assertEqual(bob.uid, None)
- self.assertEqual(bob.username, None)
- self.assertEqual(bob.nocache, False)
- self.assertEqual(bob.cfg_start_auth, True)
- self.assertEqual(bob.cfg_start_resolver, False)
-
- def test_init_alternate_address(self):
- bob = BoB(None, 1234, IPAddr('127.127.127.127'))
- self.assertEqual(bob.verbose, False)
- self.assertEqual(bob.msgq_socket_file, None)
- self.assertEqual(bob.dns_port, 1234)
- self.assertEqual(bob.address.addr, socket.inet_aton('127.127.127.127'))
- self.assertEqual(bob.cc_session, None)
- self.assertEqual(bob.ccs, None)
- self.assertEqual(bob.processes, {})
- self.assertEqual(bob.dead_processes, {})
- self.assertEqual(bob.runnable, False)
- self.assertEqual(bob.uid, None)
- self.assertEqual(bob.username, None)
- self.assertEqual(bob.nocache, False)
- self.assertEqual(bob.cfg_start_auth, True)
- self.assertEqual(bob.cfg_start_resolver, False)
-
-# Class for testing the Bob.start_all_processes() method call.
+# Class for testing the BoB start/stop components routines.
#
# Although testing that external processes start is outside the scope
# of the unit test, by overriding the process start methods we can check
# that the right processes are started depending on the configuration
# options.
-class StartAllProcessesBob(BoB):
+class StartStopCheckBob(BoB):
def __init__(self):
BoB.__init__(self)
@@ -164,6 +126,7 @@ class StartAllProcessesBob(BoB):
self.stats = False
self.stats_httpd = False
self.cmdctl = False
+ self.c_channel_env = {}
def read_bind10_config(self):
# Configuration options are set directly
@@ -202,123 +165,260 @@ class StartAllProcessesBob(BoB):
def start_cmdctl(self, c_channel_env):
self.cmdctl = True
-# Check that the start_all_processes method starts the right combination
-# of processes.
-class TestStartAllProcessesBob(unittest.TestCase):
+ # We don't really use all of these stop_ methods. But it might turn out
+ # someone would add some stop_ method to BoB and we want that one overriden
+ # in case he forgets to update the tests.
+ def stop_msgq(self):
+ self.msgq = False
+
+ def stop_cfgmgr(self):
+ self.cfgmgr = False
+
+ def stop_ccsession(self):
+ self.ccsession = False
+
+ def stop_auth(self):
+ self.auth = False
+
+ def stop_resolver(self):
+ self.resolver = False
+
+ def stop_xfrout(self):
+ self.xfrout = False
+
+ def stop_xfrin(self):
+ self.xfrin = False
+
+ def stop_zonemgr(self):
+ self.zonemgr = False
+
+ def stop_stats(self):
+ self.stats = False
+
+ def stop_stats_httpd(self):
+ self.stats_httpd = False
+
+ def stop_cmdctl(self):
+ self.cmdctl = False
+
+class TestStartStopProcessesBob(unittest.TestCase):
+ """
+ Check that the start_all_processes method starts the right combination
+ of processes and that the right processes are started and stopped
+ according to changes in configuration.
+ """
+ def check_started(self, bob, core, auth, resolver):
+ """
+ Check that the right sets of services are started. The ones that
+ should be running are specified by the core, auth and resolver parameters
+ (they are groups of processes, eg. auth means b10-auth, -xfrout, -xfrin
+ and -zonemgr).
+ """
+ self.assertEqual(bob.msgq, core)
+ self.assertEqual(bob.cfgmgr, core)
+ self.assertEqual(bob.ccsession, core)
+ self.assertEqual(bob.auth, auth)
+ self.assertEqual(bob.resolver, resolver)
+ self.assertEqual(bob.xfrout, auth)
+ self.assertEqual(bob.xfrin, auth)
+ self.assertEqual(bob.zonemgr, auth)
+ self.assertEqual(bob.stats, core)
+ self.assertEqual(bob.stats_httpd, core)
+ self.assertEqual(bob.cmdctl, core)
+
def check_preconditions(self, bob):
- self.assertEqual(bob.msgq, False)
- self.assertEqual(bob.cfgmgr, False)
- self.assertEqual(bob.ccsession, False)
- self.assertEqual(bob.auth, False)
- self.assertEqual(bob.resolver, False)
- self.assertEqual(bob.xfrout, False)
- self.assertEqual(bob.xfrin, False)
- self.assertEqual(bob.zonemgr, False)
- self.assertEqual(bob.stats, False)
- self.assertEqual(bob.stats_httpd, False)
- self.assertEqual(bob.cmdctl, False)
+ self.check_started(bob, False, False, False)
+
+ def check_started_none(self, bob):
+ """
+ Check that the situation is according to configuration where no servers
+ should be started. Some processes still need to be running.
+ """
+ self.check_started(bob, True, False, False)
+
+ def check_started_both(self, bob):
+ """
+ Check the situation is according to configuration where both servers
+ (auth and resolver) are enabled.
+ """
+ self.check_started(bob, True, True, True)
+
+ def check_started_auth(self, bob):
+ """
+ Check the set of processes needed to run auth only is started.
+ """
+ self.check_started(bob, True, True, False)
+
+ def check_started_resolver(self, bob):
+ """
+ Check the set of processes needed to run resolver only is started.
+ """
+ self.check_started(bob, True, False, True)
# Checks the processes started when starting neither auth nor resolver
# is specified.
def test_start_none(self):
- # Created Bob and ensure initialization correct
- bob = StartAllProcessesBob()
+ # Create BoB and ensure correct initialization
+ bob = StartStopCheckBob()
self.check_preconditions(bob)
# Start processes and check what was started
- c_channel_env = {}
bob.cfg_start_auth = False
bob.cfg_start_resolver = False
- bob.start_all_processes(c_channel_env)
-
- self.assertEqual(bob.msgq, True)
- self.assertEqual(bob.cfgmgr, True)
- self.assertEqual(bob.ccsession, True)
- self.assertEqual(bob.auth, False)
- self.assertEqual(bob.resolver, False)
- self.assertEqual(bob.xfrout, False)
- self.assertEqual(bob.xfrin, False)
- self.assertEqual(bob.zonemgr, False)
- self.assertEqual(bob.stats, True)
- self.assertEqual(bob.stats_httpd, True)
- self.assertEqual(bob.cmdctl, True)
+ bob.start_all_processes()
+ self.check_started_none(bob)
# Checks the processes started when starting only the auth process
def test_start_auth(self):
- # Created Bob and ensure initialization correct
- bob = StartAllProcessesBob()
+ # Create BoB and ensure correct initialization
+ bob = StartStopCheckBob()
self.check_preconditions(bob)
# Start processes and check what was started
- c_channel_env = {}
bob.cfg_start_auth = True
bob.cfg_start_resolver = False
- bob.start_all_processes(c_channel_env)
+ bob.start_all_processes()
- self.assertEqual(bob.msgq, True)
- self.assertEqual(bob.cfgmgr, True)
- self.assertEqual(bob.ccsession, True)
- self.assertEqual(bob.auth, True)
- self.assertEqual(bob.resolver, False)
- self.assertEqual(bob.xfrout, True)
- self.assertEqual(bob.xfrin, True)
- self.assertEqual(bob.zonemgr, True)
- self.assertEqual(bob.stats, True)
- self.assertEqual(bob.stats_httpd, True)
- self.assertEqual(bob.cmdctl, True)
+ self.check_started_auth(bob)
# Checks the processes started when starting only the resolver process
def test_start_resolver(self):
- # Created Bob and ensure initialization correct
- bob = StartAllProcessesBob()
+ # Create BoB and ensure correct initialization
+ bob = StartStopCheckBob()
self.check_preconditions(bob)
# Start processes and check what was started
- c_channel_env = {}
bob.cfg_start_auth = False
bob.cfg_start_resolver = True
- bob.start_all_processes(c_channel_env)
+ bob.start_all_processes()
- self.assertEqual(bob.msgq, True)
- self.assertEqual(bob.cfgmgr, True)
- self.assertEqual(bob.ccsession, True)
- self.assertEqual(bob.auth, False)
- self.assertEqual(bob.resolver, True)
- self.assertEqual(bob.xfrout, False)
- self.assertEqual(bob.xfrin, False)
- self.assertEqual(bob.zonemgr, False)
- self.assertEqual(bob.stats, True)
- self.assertEqual(bob.stats_httpd, True)
- self.assertEqual(bob.cmdctl, True)
+ self.check_started_resolver(bob)
# Checks the processes started when starting both auth and resolver process
def test_start_both(self):
- # Created Bob and ensure initialization correct
- bob = StartAllProcessesBob()
+ # Create BoB and ensure correct initialization
+ bob = StartStopCheckBob()
self.check_preconditions(bob)
# Start processes and check what was started
- c_channel_env = {}
bob.cfg_start_auth = True
bob.cfg_start_resolver = True
- bob.start_all_processes(c_channel_env)
+ bob.start_all_processes()
+
+ self.check_started_both(bob)
+
+ def test_config_start(self):
+ """
+ Test that the configuration starts and stops processes according
+ to configuration changes.
+ """
+
+ # Create BoB and ensure correct initialization
+ bob = StartStopCheckBob()
+ self.check_preconditions(bob)
+
+ # Start processes (nothing much should be started, as in
+ # test_start_none)
+ bob.cfg_start_auth = False
+ bob.cfg_start_resolver = False
+
+ bob.start_all_processes()
+ bob.runnable = True
+ self.check_started_none(bob)
+
+ # Enable both at once
+ bob.config_handler({'start_auth': True, 'start_resolver': True})
+ self.check_started_both(bob)
+
+ # Not touched by empty change
+ bob.config_handler({})
+ self.check_started_both(bob)
+
+ # Not touched by change to the same configuration
+ bob.config_handler({'start_auth': True, 'start_resolver': True})
+ self.check_started_both(bob)
+
+ # Turn them both off again
+ bob.config_handler({'start_auth': False, 'start_resolver': False})
+ self.check_started_none(bob)
+
+ # Not touched by empty change
+ bob.config_handler({})
+ self.check_started_none(bob)
+
+ # Not touched by change to the same configuration
+ bob.config_handler({'start_auth': False, 'start_resolver': False})
+ self.check_started_none(bob)
+
+ # Start and stop auth separately
+ bob.config_handler({'start_auth': True})
+ self.check_started_auth(bob)
+
+ bob.config_handler({'start_auth': False})
+ self.check_started_none(bob)
+
+ # Start and stop resolver separately
+ bob.config_handler({'start_resolver': True})
+ self.check_started_resolver(bob)
+
+ bob.config_handler({'start_resolver': False})
+ self.check_started_none(bob)
+
+ # Alternate
+ bob.config_handler({'start_auth': True})
+ self.check_started_auth(bob)
+
+ bob.config_handler({'start_auth': False, 'start_resolver': True})
+ self.check_started_resolver(bob)
+
+ bob.config_handler({'start_auth': True, 'start_resolver': False})
+ self.check_started_auth(bob)
+
+ def test_config_start_once(self):
+ """
+ Tests that a process is started only once.
+ """
+ # Create BoB and ensure correct initialization
+ bob = StartStopCheckBob()
+ self.check_preconditions(bob)
+
+ # Start processes (both)
+ bob.cfg_start_auth = True
+ bob.cfg_start_resolver = True
+
+ bob.start_all_processes()
+ bob.runnable = True
+ self.check_started_both(bob)
+
+ bob.start_auth = lambda: self.fail("Started auth again")
+ bob.start_xfrout = lambda: self.fail("Started xfrout again")
+ bob.start_xfrin = lambda: self.fail("Started xfrin again")
+ bob.start_zonemgr = lambda: self.fail("Started zonemgr again")
+ bob.start_resolver = lambda: self.fail("Started resolver again")
+
+ # Send again we want to start them. Should not do it, as they are.
+ bob.config_handler({'start_auth': True})
+ bob.config_handler({'start_resolver': True})
+
+ def test_config_not_started_early(self):
+ """
+ Test that processes are not started by the config handler before
+ startup.
+ """
+ bob = StartStopCheckBob()
+ self.check_preconditions(bob)
- self.assertEqual(bob.msgq, True)
- self.assertEqual(bob.cfgmgr, True)
- self.assertEqual(bob.ccsession, True)
- self.assertEqual(bob.auth, True)
- self.assertEqual(bob.resolver, True)
- self.assertEqual(bob.xfrout, True)
- self.assertEqual(bob.xfrin, True)
- self.assertEqual(bob.zonemgr, True)
- self.assertEqual(bob.stats, True)
- self.assertEqual(bob.stats_httpd, True)
- self.assertEqual(bob.cmdctl, True)
+ bob.start_auth = lambda: self.fail("Started auth again")
+ bob.start_xfrout = lambda: self.fail("Started xfrout again")
+ bob.start_xfrin = lambda: self.fail("Started xfrin again")
+ bob.start_zonemgr = lambda: self.fail("Started zonemgr again")
+ bob.start_resolver = lambda: self.fail("Started resolver again")
+ bob.config_handler({'start_auth': True, 'start_resolver': True})
if __name__ == '__main__':
unittest.main()
diff --git a/src/bin/bindctl/Makefile.am b/src/bin/bindctl/Makefile.am
index da9b63d..e95af78 100644
--- a/src/bin/bindctl/Makefile.am
+++ b/src/bin/bindctl/Makefile.am
@@ -8,7 +8,7 @@ EXTRA_DIST = $(man_MANS) bindctl.xml
python_PYTHON = __init__.py bindcmd.py cmdparse.py exception.py moduleinfo.py mycollections.py
pythondir = $(pyexecdir)/bindctl
-bindctldir = $(DESTDIR)$(pkgdatadir)
+bindctldir = $(pkgdatadir)
CLEANFILES = bindctl
diff --git a/src/bin/bindctl/bindcmd.py b/src/bin/bindctl/bindcmd.py
index fb6a892..683dda9 100644
--- a/src/bin/bindctl/bindcmd.py
+++ b/src/bin/bindctl/bindcmd.py
@@ -51,7 +51,6 @@ except ImportError:
my_readline = sys.stdin.readline
CSV_FILE_NAME = 'default_user.csv'
-FAIL_TO_CONNECT_WITH_CMDCTL = "Fail to connect with b10-cmdctl module, is it running?"
CONFIG_MODULE_NAME = 'config'
CONST_BINDCTL_HELP = """
usage: <module name> <command name> [param1 = value1 [, param2 = value2]]
@@ -92,10 +91,13 @@ class BindCmdInterpreter(Cmd):
Cmd.__init__(self)
self.location = ""
self.prompt_end = '> '
- self.prompt = self.prompt_end
+ if sys.stdin.isatty():
+ self.prompt = self.prompt_end
+ else:
+ self.prompt = ""
self.ruler = '-'
self.modules = OrderedDict()
- self.add_module_info(ModuleInfo("help", desc = "Get help for bindctl"))
+ self.add_module_info(ModuleInfo("help", desc = "Get help for bindctl."))
self.server_port = server_port
self.conn = ValidatedHTTPSConnection(self.server_port,
ca_certs=pem_file)
@@ -119,8 +121,8 @@ class BindCmdInterpreter(Cmd):
self.cmdloop()
except FailToLogin as err:
- print(err)
- print(FAIL_TO_CONNECT_WITH_CMDCTL)
+ # error already printed when this was raised, ignoring
+ pass
except KeyboardInterrupt:
print('\nExit from bindctl')
@@ -270,8 +272,10 @@ class BindCmdInterpreter(Cmd):
return line
def postcmd(self, stop, line):
- '''Update the prompt after every command'''
- self.prompt = self.location + self.prompt_end
+ '''Update the prompt after every command, but only if we
+ have a tty as output'''
+ if sys.stdin.isatty():
+ self.prompt = self.location + self.prompt_end
return stop
def _prepare_module_commands(self, module_spec):
@@ -375,7 +379,14 @@ class BindCmdInterpreter(Cmd):
if cmd.command == "help" or ("help" in cmd.params.keys()):
self._handle_help(cmd)
elif cmd.module == CONFIG_MODULE_NAME:
- self.apply_config_cmd(cmd)
+ try:
+ self.apply_config_cmd(cmd)
+ except isc.cc.data.DataTypeError as dte:
+ print("Error: " + str(dte))
+ except isc.cc.data.DataNotFoundError as dnfe:
+ print("Error: " + str(dnfe))
+ except KeyError as ke:
+ print("Error: missing " + str(ke))
else:
self.apply_cmd(cmd)
@@ -396,9 +407,24 @@ class BindCmdInterpreter(Cmd):
def do_help(self, name):
print(CONST_BINDCTL_HELP)
- for k in self.modules.keys():
- print("\t", self.modules[k])
-
+ for k in self.modules.values():
+ n = k.get_name()
+ if len(n) >= CONST_BINDCTL_HELP_INDENT_WIDTH:
+ print(" %s" % n)
+ print(textwrap.fill(k.get_desc(),
+ initial_indent=" ",
+ subsequent_indent=" " +
+ " " * CONST_BINDCTL_HELP_INDENT_WIDTH,
+ width=70))
+ else:
+ print(textwrap.fill("%s%s%s" %
+ (k.get_name(),
+ " "*(CONST_BINDCTL_HELP_INDENT_WIDTH - len(k.get_name())),
+ k.get_desc()),
+ initial_indent=" ",
+ subsequent_indent=" " +
+ " " * CONST_BINDCTL_HELP_INDENT_WIDTH,
+ width=70))
def onecmd(self, line):
if line == 'EOF' or line.lower() == "quit":
@@ -411,7 +437,19 @@ class BindCmdInterpreter(Cmd):
Cmd.onecmd(self, line)
def remove_prefix(self, list, prefix):
- return [(val[len(prefix):]) for val in list]
+ """Removes the prefix already entered, and all elements from the
+ list that don't match it"""
+ if prefix.startswith('/'):
+ prefix = prefix[1:]
+
+ new_list = []
+ for val in list:
+ if val.startswith(prefix):
+ new_val = val[len(prefix):]
+ if new_val.startswith("/"):
+ new_val = new_val[1:]
+ new_list.append(new_val)
+ return new_list
def complete(self, text, state):
if 0 == state:
@@ -502,8 +540,7 @@ class BindCmdInterpreter(Cmd):
self._validate_cmd(cmd)
self._handle_cmd(cmd)
except (IOError, http.client.HTTPException) as err:
- print('Error!', err)
- print(FAIL_TO_CONNECT_WITH_CMDCTL)
+ print('Error: ', err)
except BindCtlException as err:
print("Error! ", err)
self._print_correct_usage(err)
@@ -541,87 +578,115 @@ class BindCmdInterpreter(Cmd):
Raises a KeyError if the command was not complete
'''
identifier = self.location
- try:
- if 'identifier' in cmd.params:
- if not identifier.endswith("/"):
- identifier += "/"
- if cmd.params['identifier'].startswith("/"):
- identifier = cmd.params['identifier']
- else:
- identifier += cmd.params['identifier']
-
- # Check if the module is known; for unknown modules
- # we currently deny setting preferences, as we have
- # no way yet to determine if they are ok.
- module_name = identifier.split('/')[1]
- if self.config_data is None or \
- not self.config_data.have_specification(module_name):
- print("Error: Module '" + module_name + "' unknown or not running")
- return
+ if 'identifier' in cmd.params:
+ if not identifier.endswith("/"):
+ identifier += "/"
+ if cmd.params['identifier'].startswith("/"):
+ identifier = cmd.params['identifier']
+ else:
+ if cmd.params['identifier'].startswith('['):
+ identifier = identifier[:-1]
+ identifier += cmd.params['identifier']
+
+ # Check if the module is known; for unknown modules
+ # we currently deny setting preferences, as we have
+ # no way yet to determine if they are ok.
+ module_name = identifier.split('/')[1]
+ if module_name != "" and (self.config_data is None or \
+ not self.config_data.have_specification(module_name)):
+ print("Error: Module '" + module_name + "' unknown or not running")
+ return
- if cmd.command == "show":
- values = self.config_data.get_value_maps(identifier)
- for value_map in values:
- line = value_map['name']
- if value_map['type'] in [ 'module', 'map', 'list' ]:
- line += "/"
- else:
- line += ":\t" + json.dumps(value_map['value'])
- line += "\t" + value_map['type']
- line += "\t"
- if value_map['default']:
- line += "(default)"
- if value_map['modified']:
- line += "(modified)"
- print(line)
- elif cmd.command == "add":
- self.config_data.add_value(identifier, cmd.params['value'])
- elif cmd.command == "remove":
- if 'value' in cmd.params:
- self.config_data.remove_value(identifier, cmd.params['value'])
+ if cmd.command == "show":
+ # check if we have the 'all' argument
+ show_all = False
+ if 'argument' in cmd.params:
+ if cmd.params['argument'] == 'all':
+ show_all = True
+ elif 'identifier' not in cmd.params:
+ # no 'all', no identifier, assume this is the
+ #identifier
+ identifier += cmd.params['argument']
else:
- self.config_data.remove_value(identifier, None)
- elif cmd.command == "set":
- if 'identifier' not in cmd.params:
- print("Error: missing identifier or value")
+ print("Error: unknown argument " + cmd.params['argument'] + ", or multiple identifiers given")
+ return
+ values = self.config_data.get_value_maps(identifier, show_all)
+ for value_map in values:
+ line = value_map['name']
+ if value_map['type'] in [ 'module', 'map' ]:
+ line += "/"
+ elif value_map['type'] == 'list' \
+ and value_map['value'] != []:
+ # do not print content of non-empty lists if
+ # we have more data to show
+ line += "/"
else:
- parsed_value = None
- try:
- parsed_value = json.loads(cmd.params['value'])
- except Exception as exc:
- # ok could be an unquoted string, interpret as such
- parsed_value = cmd.params['value']
- self.config_data.set_value(identifier, parsed_value)
- elif cmd.command == "unset":
- self.config_data.unset(identifier)
- elif cmd.command == "revert":
- self.config_data.clear_local_changes()
- elif cmd.command == "commit":
- self.config_data.commit()
- elif cmd.command == "diff":
- print(self.config_data.get_local_changes());
- elif cmd.command == "go":
- self.go(identifier)
- except isc.cc.data.DataTypeError as dte:
- print("Error: " + str(dte))
- except isc.cc.data.DataNotFoundError as dnfe:
- print("Error: " + identifier + " not found")
- except KeyError as ke:
- print("Error: missing " + str(ke))
- raise ke
+ line += "\t" + json.dumps(value_map['value'])
+ line += "\t" + value_map['type']
+ line += "\t"
+ if value_map['default']:
+ line += "(default)"
+ if value_map['modified']:
+ line += "(modified)"
+ print(line)
+ elif cmd.command == "show_json":
+ if identifier == "":
+ print("Need at least the module to show the configuration in JSON format")
+ else:
+ data, default = self.config_data.get_value(identifier)
+ print(json.dumps(data))
+ elif cmd.command == "add":
+ if 'value' in cmd.params:
+ self.config_data.add_value(identifier, cmd.params['value'])
+ else:
+ self.config_data.add_value(identifier)
+ elif cmd.command == "remove":
+ if 'value' in cmd.params:
+ self.config_data.remove_value(identifier, cmd.params['value'])
+ else:
+ self.config_data.remove_value(identifier, None)
+ elif cmd.command == "set":
+ if 'identifier' not in cmd.params:
+ print("Error: missing identifier or value")
+ else:
+ parsed_value = None
+ try:
+ parsed_value = json.loads(cmd.params['value'])
+ except Exception as exc:
+ # ok could be an unquoted string, interpret as such
+ parsed_value = cmd.params['value']
+ self.config_data.set_value(identifier, parsed_value)
+ elif cmd.command == "unset":
+ self.config_data.unset(identifier)
+ elif cmd.command == "revert":
+ self.config_data.clear_local_changes()
+ elif cmd.command == "commit":
+ self.config_data.commit()
+ elif cmd.command == "diff":
+ print(self.config_data.get_local_changes());
+ elif cmd.command == "go":
+ self.go(identifier)
def go(self, identifier):
'''Handles the config go command, change the 'current' location
- within the configuration tree'''
- # this is just to see if it exists
- self.config_data.get_value(identifier)
- # some sanitizing
- identifier = identifier.replace("//", "/")
- if not identifier.startswith("/"):
- identifier = "/" + identifier
- if identifier.endswith("/"):
- identifier = identifier[:-1]
- self.location = identifier
+ within the configuration tree. '..' will be interpreted as
+ 'up one level'.'''
+ id_parts = isc.cc.data.split_identifier(identifier)
+
+ new_location = ""
+ for id_part in id_parts:
+ if (id_part == ".."):
+ # go 'up' one level
+ new_location, a, b = new_location.rpartition("/")
+ else:
+ new_location += "/" + id_part
+ # check if exists, if not, revert and error
+ v,d = self.config_data.get_value(new_location)
+ if v is None:
+ print("Error: " + identifier + " not found")
+ return
+
+ self.location = new_location
def apply_cmd(self, cmd):
'''Handles a general module command'''
diff --git a/src/bin/bindctl/bindctl-source.py.in b/src/bin/bindctl/bindctl-source.py.in
index 83059d2..080c3bc 100644
--- a/src/bin/bindctl/bindctl-source.py.in
+++ b/src/bin/bindctl/bindctl-source.py.in
@@ -31,53 +31,62 @@ isc.util.process.rename()
# This is the version that gets displayed to the user.
# The VERSION string consists of the module name, the module version
# number, and the overall BIND 10 version number (set in configure.ac).
-VERSION = "bindctl 20101201 (BIND 10 @PACKAGE_VERSION@)"
+VERSION = "bindctl 20110217 (BIND 10 @PACKAGE_VERSION@)"
+
+DEFAULT_IDENTIFIER_DESC = "The identifier specifies the config item. Child elements are separated with the '/' character. List indices can be specified with '[i]', where i is an integer specifying the index, starting with 0. Examples: 'Boss/start_auth', 'Recurse/listen_on[0]/address'. If no identifier is given, shows the item at the current location."
def prepare_config_commands(tool):
'''Prepare fixed commands for local configuration editing'''
- module = ModuleInfo(name = CONFIG_MODULE_NAME, desc = "Configuration commands")
- cmd = CommandInfo(name = "show", desc = "Show configuration")
- param = ParamInfo(name = "identifier", type = "string", optional=True)
+ module = ModuleInfo(name = CONFIG_MODULE_NAME, desc = "Configuration commands.")
+ cmd = CommandInfo(name = "show", desc = "Show configuration.")
+ param = ParamInfo(name = "argument", type = "string", optional=True, desc = "If you specify the argument 'all' (before the identifier), recursively show all child elements for the given identifier.")
+ cmd.add_param(param)
+ param = ParamInfo(name = "identifier", type = "string", optional=True, desc = DEFAULT_IDENTIFIER_DESC)
+ cmd.add_param(param)
+ module.add_command(cmd)
+
+ cmd = CommandInfo(name = "show_json", desc = "Show full configuration in JSON format.")
+ param = ParamInfo(name = "identifier", type = "string", optional=True, desc = DEFAULT_IDENTIFIER_DESC)
cmd.add_param(param)
module.add_command(cmd)
- cmd = CommandInfo(name = "add", desc = "Add entry to configuration list")
- param = ParamInfo(name = "identifier", type = "string", optional=True)
+ cmd = CommandInfo(name = "add", desc = "Add an entry to configuration list. If no value is given, a default value is added.")
+ param = ParamInfo(name = "identifier", type = "string", optional=True, desc = DEFAULT_IDENTIFIER_DESC)
cmd.add_param(param)
- param = ParamInfo(name = "value", type = "string", optional=False)
+ param = ParamInfo(name = "value", type = "string", optional=True, desc = "Specifies a value to add to the list. It must be in correct JSON format and complete.")
cmd.add_param(param)
module.add_command(cmd)
- cmd = CommandInfo(name = "remove", desc = "Remove entry from configuration list")
- param = ParamInfo(name = "identifier", type = "string", optional=True)
+ cmd = CommandInfo(name = "remove", desc = "Remove entry from configuration list.")
+ param = ParamInfo(name = "identifier", type = "string", optional=True, desc = DEFAULT_IDENTIFIER_DESC)
cmd.add_param(param)
- param = ParamInfo(name = "value", type = "string", optional=True)
+ param = ParamInfo(name = "value", type = "string", optional=True, desc = "Specifies a value to remove from the list. It must be in correct JSON format and complete.")
cmd.add_param(param)
module.add_command(cmd)
- cmd = CommandInfo(name = "set", desc = "Set a configuration value")
- param = ParamInfo(name = "identifier", type = "string", optional=True)
+ cmd = CommandInfo(name = "set", desc = "Set a configuration value.")
+ param = ParamInfo(name = "identifier", type = "string", optional=True, desc = DEFAULT_IDENTIFIER_DESC)
cmd.add_param(param)
- param = ParamInfo(name = "value", type = "string", optional=False)
+ param = ParamInfo(name = "value", type = "string", optional=False, desc = "Specifies a value to set. It must be in correct JSON format and complete.")
cmd.add_param(param)
module.add_command(cmd)
- cmd = CommandInfo(name = "unset", desc = "Unset a configuration value")
- param = ParamInfo(name = "identifier", type = "string", optional=False)
+ cmd = CommandInfo(name = "unset", desc = "Unset a configuration value (i.e. revert to the default, if any).")
+ param = ParamInfo(name = "identifier", type = "string", optional=False, desc = DEFAULT_IDENTIFIER_DESC)
cmd.add_param(param)
module.add_command(cmd)
- cmd = CommandInfo(name = "diff", desc = "Show all local changes")
+ cmd = CommandInfo(name = "diff", desc = "Show all local changes that have not been committed.")
module.add_command(cmd)
- cmd = CommandInfo(name = "revert", desc = "Revert all local changes")
+ cmd = CommandInfo(name = "revert", desc = "Revert all local changes.")
module.add_command(cmd)
- cmd = CommandInfo(name = "commit", desc = "Commit all local changes")
+ cmd = CommandInfo(name = "commit", desc = "Commit all local changes.")
module.add_command(cmd)
- cmd = CommandInfo(name = "go", desc = "Go to a specific configuration part")
- param = ParamInfo(name = "identifier", type="string", optional=False)
+ cmd = CommandInfo(name = "go", desc = "Go to a specific configuration part.")
+ param = ParamInfo(name = "identifier", type="string", optional=False, desc = DEFAULT_IDENTIFIER_DESC)
cmd.add_param(param)
module.add_command(cmd)
@@ -115,15 +124,12 @@ def set_bindctl_options(parser):
help = 'PEM formatted server certificate validation chain file')
if __name__ == '__main__':
- try:
- parser = OptionParser(version = VERSION)
- set_bindctl_options(parser)
- (options, args) = parser.parse_args()
- server_addr = options.addr + ':' + str(options.port)
- tool = BindCmdInterpreter(server_addr, pem_file=options.cert_chain)
- prepare_config_commands(tool)
- tool.run()
- except Exception as e:
- print(e, "\nFailed to connect with b10-cmdctl module, is it running?")
+ parser = OptionParser(version = VERSION)
+ set_bindctl_options(parser)
+ (options, args) = parser.parse_args()
+ server_addr = options.addr + ':' + str(options.port)
+ tool = BindCmdInterpreter(server_addr, pem_file=options.cert_chain)
+ prepare_config_commands(tool)
+ tool.run()
diff --git a/src/bin/bindctl/cmdparse.py b/src/bin/bindctl/cmdparse.py
index ab891d7..c624cba 100644
--- a/src/bin/bindctl/cmdparse.py
+++ b/src/bin/bindctl/cmdparse.py
@@ -33,6 +33,7 @@ param_value_str = "(?P<param_value>[^\'\" ][^, ]+)"
param_value_with_quota_str = "[\"\'](?P<param_value>.+?)(?<!\\\)[\"\']"
next_params_str = "(?P<blank>\s*)(?P<comma>,?)(?P<next_params>.*)$"
+
PARAM_WITH_QUOTA_PATTERN = re.compile(param_name_str +
param_value_with_quota_str +
next_params_str)
@@ -40,8 +41,58 @@ PARAM_PATTERN = re.compile(param_name_str + param_value_str + next_params_str)
# Used for module and command name
NAME_PATTERN = re.compile("^\s*(?P<name>[\w]+)(?P<blank>\s*)(?P<others>.*)$")
+# this removes all whitespace in the given string, except when
+# between " quotes
+_remove_unquoted_whitespace = \
+ lambda text:'"'.join( it if i%2 else ''.join(it.split())
+ for i,it in enumerate(text.split('"')) )
+
+
+def _remove_list_and_map_whitespace(text):
+ """Returns a string where the whitespace between matching [ and ]
+ is removed, unless quoted"""
+ # regular expression aren't really the right tool, since we may have
+ # nested structures
+ result = []
+ start_pos = 0
+ pos = 0
+ list_count = 0
+ map_count = 0
+ cur_start_list_pos = None
+ cur_start_map_pos = None
+ for i in text:
+ if i == '[' and map_count == 0:
+ if list_count == 0:
+ result.append(text[start_pos:pos + 1])
+ cur_start_list_pos = pos + 1
+ list_count = list_count + 1
+ elif i == ']' and map_count == 0:
+ if list_count > 0:
+ list_count = list_count - 1
+ if list_count == 0:
+ result.append(_remove_unquoted_whitespace(text[cur_start_list_pos:pos + 1]))
+ start_pos = pos + 1
+ if i == '{' and list_count == 0:
+ if map_count == 0:
+ result.append(text[start_pos:pos + 1])
+ cur_start_map_pos = pos + 1
+ map_count = map_count + 1
+ elif i == '}' and list_count == 0:
+ if map_count > 0:
+ map_count = map_count - 1
+ if map_count == 0:
+ result.append(_remove_unquoted_whitespace(text[cur_start_map_pos:pos + 1]))
+ start_pos = pos + 1
+
+
+ pos = pos + 1
+ if start_pos <= len(text):
+ result.append(text[start_pos:len(text)])
+ return "".join(result)
+
+
class BindCmdParse:
- """ This class will parse the command line usr input into three part
+ """ This class will parse the command line user input into three parts:
module name, command, parameters
the first two parts are strings and parameter is one hash,
parameters part is optional
@@ -86,9 +137,12 @@ class BindCmdParse:
self._parse_params(param_str)
+ def _remove_list_whitespace(self, text):
+ return ""
def _parse_params(self, param_text):
"""convert a=b,c=d into one hash """
+ param_text = _remove_list_and_map_whitespace(param_text)
# Check parameter name "help"
param = NAME_PATTERN.match(param_text)
diff --git a/src/bin/bindctl/moduleinfo.py b/src/bin/bindctl/moduleinfo.py
index 015ef16..6e41dce 100644
--- a/src/bin/bindctl/moduleinfo.py
+++ b/src/bin/bindctl/moduleinfo.py
@@ -16,6 +16,8 @@
"""This module holds classes representing modules, commands and
parameters for use in bindctl"""
+import textwrap
+
try:
from collections import OrderedDict
except ImportError:
@@ -30,6 +32,9 @@ MODULE_NODE_NAME = 'module'
COMMAND_NODE_NAME = 'command'
PARAM_NODE_NAME = 'param'
+# this is used to align the descriptions in help output
+CONST_BINDCTL_HELP_INDENT_WIDTH=12
+
class ParamInfo:
"""One parameter of one command.
@@ -52,6 +57,12 @@ class ParamInfo:
def __str__(self):
return str("\t%s <type: %s> \t(%s)" % (self.name, self.type, self.desc))
+ def get_name(self):
+ return "%s <type: %s>" % (self.name, self.type)
+
+ def get_desc(self):
+ return self.desc
+
class CommandInfo:
"""One command which is provided by one bind10 module, it has zero
or more parameters
@@ -63,13 +74,18 @@ class CommandInfo:
self.params = OrderedDict()
# Set default parameter "help"
self.add_param(ParamInfo("help",
- desc = "Get help for command",
+ desc = "Get help for command.",
optional = True))
def __str__(self):
return str("%s \t(%s)" % (self.name, self.desc))
-
+ def get_name(self):
+ return self.name
+
+ def get_desc(self):
+ return self.desc;
+
def add_param(self, paraminfo):
"""Add a ParamInfo object to this CommandInfo"""
self.params[paraminfo.name] = paraminfo
@@ -144,22 +160,30 @@ class CommandInfo:
del params["help"]
if len(params) == 0:
- print("\tNo parameters for the command")
+ print("No parameters for the command")
return
- print("\n\tMandatory parameters:")
+ print("\nMandatory parameters:")
mandatory_infos = []
for info in params.values():
if not info.is_optional:
- print("\t", info)
+ print(" %s" % info.get_name())
+ print(textwrap.fill(info.get_desc(),
+ initial_indent=" ",
+ subsequent_indent=" ",
+ width=70))
mandatory_infos.append(info)
optional_infos = [info for info in params.values()
if info not in mandatory_infos]
if len(optional_infos) > 0:
- print("\n\tOptional parameters:")
+ print("\nOptional parameters:")
for info in optional_infos:
- print("\t", info)
+ print(" %s" % info.get_name())
+ print(textwrap.fill(info.get_desc(),
+ initial_indent=" ",
+ subsequent_indent=" ",
+ width=70))
class ModuleInfo:
@@ -172,11 +196,17 @@ class ModuleInfo:
self.desc = desc
self.commands = OrderedDict()
self.add_command(CommandInfo(name = "help",
- desc = "Get help for module"))
+ desc = "Get help for module."))
def __str__(self):
return str("%s \t%s" % (self.name, self.desc))
-
+
+ def get_name(self):
+ return self.name
+
+ def get_desc(self):
+ return self.desc
+
def add_command(self, command_info):
"""Add a CommandInfo to this ModuleInfo."""
self.commands[command_info.name] = command_info
@@ -201,8 +231,24 @@ class ModuleInfo:
def module_help(self):
"""Prints the help info for this module to stdout"""
print("Module ", self, "\nAvailable commands:")
- for k in self.commands.keys():
- print("\t", self.commands[k])
+ for k in self.commands.values():
+ n = k.get_name()
+ if len(n) >= CONST_BINDCTL_HELP_INDENT_WIDTH:
+ print(" %s" % n)
+ print(textwrap.fill(k.get_desc(),
+ initial_indent=" ",
+ subsequent_indent=" " +
+ " " * CONST_BINDCTL_HELP_INDENT_WIDTH,
+ width=70))
+ else:
+ print(textwrap.fill("%s%s%s" %
+ (k.get_name(),
+ " "*(CONST_BINDCTL_HELP_INDENT_WIDTH - len(k.get_name())),
+ k.get_desc()),
+ initial_indent=" ",
+ subsequent_indent=" " +
+ " " * CONST_BINDCTL_HELP_INDENT_WIDTH,
+ width=70))
def command_help(self, command):
"""Prints the help info for the command with the given name.
diff --git a/src/bin/bindctl/tests/Makefile.am b/src/bin/bindctl/tests/Makefile.am
index 5f93644..8a7a623 100644
--- a/src/bin/bindctl/tests/Makefile.am
+++ b/src/bin/bindctl/tests/Makefile.am
@@ -1,5 +1,5 @@
PYCOVERAGE_RUN = @PYCOVERAGE_RUN@
-PYTESTS = bindctl_test.py
+PYTESTS = bindctl_test.py cmdparse_test.py
EXTRA_DIST = $(PYTESTS)
# test using command-line arguments, so use check-local target instead of TESTS
diff --git a/src/bin/bindctl/tests/bindctl_test.py b/src/bin/bindctl/tests/bindctl_test.py
index 653c908..490dd7a 100644
--- a/src/bin/bindctl/tests/bindctl_test.py
+++ b/src/bin/bindctl/tests/bindctl_test.py
@@ -17,6 +17,8 @@
import unittest
import isc.cc.data
import os
+from isc.config.config_data import ConfigData, MultiConfigData
+from isc.config.module_spec import ModuleSpec
from bindctl import cmdparse
from bindctl import bindcmd
from bindctl.moduleinfo import *
@@ -238,11 +240,101 @@ class TestNameSequence(unittest.TestCase):
assert self.random_names[i] == module_names[i+1]
i = i + 1
- def test_apply_cfg_command(self):
+# tine class to fake a UIModuleCCSession, but only the config data
+# parts for the next set of tests
+class FakeCCSession(MultiConfigData):
+ def __init__(self):
+ self._local_changes = {}
+ self._current_config = {}
+ self._specifications = {}
+ self.add_foo_spec()
+
+ def add_foo_spec(self):
+ spec = { "module_name": "foo",
+ "config_data": [
+ { "item_name": "an_int",
+ "item_type": "integer",
+ "item_optional": False,
+ "item_default": 1
+ },
+ { "item_name": "a_list",
+ "item_type": "list",
+ "item_optional": False,
+ "item_default": [],
+ "list_item_spec":
+ { "item_name": "a_string",
+ "item_type": "string",
+ "item_optional": False,
+ "item_default": "bar"
+ }
+ }
+ ]
+ }
+ self.set_specification(ModuleSpec(spec))
+
+
+class TestConfigCommands(unittest.TestCase):
+ def setUp(self):
+ self.tool = bindcmd.BindCmdInterpreter()
+ mod_info = ModuleInfo(name = "foo")
+ self.tool.add_module_info(mod_info)
+ self.tool.config_data = FakeCCSession()
+
+ def test_apply_cfg_command_int(self):
self.tool.location = '/'
- cmd = cmdparse.BindCmdParse("config set identifier=\"foo/bar\" value=\"5\"")
+
+ self.assertEqual((1, MultiConfigData.DEFAULT),
+ self.tool.config_data.get_value("/foo/an_int"))
+
+ cmd = cmdparse.BindCmdParse("config set identifier=\"foo/an_int\" value=\"5\"")
self.tool.apply_config_cmd(cmd)
+ self.assertEqual((5, MultiConfigData.LOCAL),
+ self.tool.config_data.get_value("/foo/an_int"))
+
+ # this should raise a NotFoundError
+ cmd = cmdparse.BindCmdParse("config set identifier=\"foo/bar\" value=\"[]\"")
+ self.assertRaises(isc.cc.data.DataNotFoundError, self.tool.apply_config_cmd, cmd)
+
+ # this should raise a TypeError
+ cmd = cmdparse.BindCmdParse("config set identifier=\"foo/an_int\" value=\"[]\"")
+ self.assertRaises(isc.cc.data.DataTypeError, self.tool.apply_config_cmd, cmd)
+
+ # this is a very specific one for use with a set of list tests
+ # to try out the flexibility of the parser (only in the next test)
+ def clt(self, full_cmd_string, item_value):
+ cmd = cmdparse.BindCmdParse(full_cmd_string)
+ self.tool.apply_config_cmd(cmd)
+ self.assertEqual(([item_value], MultiConfigData.LOCAL),
+ self.tool.config_data.get_value("/foo/a_list"))
+
+ def test_apply_cfg_command_list(self):
+ self.tool.location = '/'
+
+ self.assertEqual(([], MultiConfigData.DEFAULT),
+ self.tool.config_data.get_value("/foo/a_list"))
+
+ self.clt("config set identifier=\"foo/a_list\" value=[\"a\"]", "a")
+ self.clt("config set identifier=\"foo/a_list\" value =[\"b\"]", "b")
+ self.clt("config set identifier=\"foo/a_list\" value= [\"c\"]", "c")
+ self.clt("config set identifier=\"foo/a_list\" value = [\"d\"]", "d")
+ self.clt("config set identifier =\"foo/a_list\" value=[\"e\"]", "e")
+ self.clt("config set identifier= \"foo/a_list\" value=[\"f\"]", "f")
+ self.clt("config set identifier = \"foo/a_list\" value=[\"g\"]", "g")
+ self.clt("config set identifier = \"foo/a_list\" value = [\"h\"]", "h")
+ self.clt("config set identifier = \"foo/a_list\" value=[\"i\" ]", "i")
+ self.clt("config set identifier = \"foo/a_list\" value=[ \"j\"]", "j")
+ self.clt("config set identifier = \"foo/a_list\" value=[ \"k\" ]", "k")
+
+ # this should raise a TypeError
+ cmd = cmdparse.BindCmdParse("config set identifier=\"foo/a_list\" value=\"a\"")
+ self.assertRaises(isc.cc.data.DataTypeError, self.tool.apply_config_cmd, cmd)
+
+ cmd = cmdparse.BindCmdParse("config set identifier=\"foo/a_list\" value=[1]")
+ self.assertRaises(isc.cc.data.DataTypeError, self.tool.apply_config_cmd, cmd)
+
+
+
class FakeBindCmdInterpreter(bindcmd.BindCmdInterpreter):
def __init__(self):
pass
diff --git a/src/bin/bindctl/tests/cmdparse_test.py b/src/bin/bindctl/tests/cmdparse_test.py
new file mode 100644
index 0000000..9150ed3
--- /dev/null
+++ b/src/bin/bindctl/tests/cmdparse_test.py
@@ -0,0 +1,88 @@
+# Copyright (C) 2009 Internet Systems Consortium.
+#
+# Permission to use, copy, modify, and distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SYSTEMS CONSORTIUM
+# DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
+# INTERNET SYSTEMS CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
+# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
+# FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
+# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+import unittest
+from bindctl import cmdparse
+
+class TestCmdParse(unittest.TestCase):
+
+ def test_remove_unquoted_whitespace(self):
+ self.assertEqual(cmdparse._remove_unquoted_whitespace("a"), "a")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace(" a"), "a")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace("a "), "a")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace(" a "), "a")
+ self.assertNotEqual(cmdparse._remove_unquoted_whitespace("a"), "a ")
+ self.assertNotEqual(cmdparse._remove_unquoted_whitespace(" a"), " a")
+ self.assertNotEqual(cmdparse._remove_unquoted_whitespace("a "), "a ")
+ self.assertNotEqual(cmdparse._remove_unquoted_whitespace(" a "), " a ")
+ self.assertNotEqual(cmdparse._remove_unquoted_whitespace(" a "), "b")
+
+ self.assertEqual(cmdparse._remove_unquoted_whitespace("\"abc\""), "\"abc\"")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace(" \"abc\""), "\"abc\"")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace("\"abc\" "), "\"abc\"")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace(" \"abc\" "), "\"abc\"")
+
+ self.assertEqual(cmdparse._remove_unquoted_whitespace("\" abc\""), "\" abc\"")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace(" \"a bc\""), "\"a bc\"")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace("\"ab c\" "), "\"ab c\"")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace(" \"abc \" "), "\"abc \"")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace(" \" a b c \" "), "\" a b c \"")
+
+ self.assertEqual(cmdparse._remove_unquoted_whitespace("a\" abc\"a"), "a\" abc\"a")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace("a \"a bc\"a"), "a\"a bc\"a")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace("a\"ab c\" a"), "a\"ab c\"a")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace("a \"abc \" a"), "a\"abc \"a")
+ self.assertEqual(cmdparse._remove_unquoted_whitespace("a \" a b c \" a"), "a\" a b c \"a")
+
+ # short-hand function to make the set of tests more readable
+ def rws(self, a, b):
+ self.assertEqual(cmdparse._remove_list_and_map_whitespace(a), b)
+
+ def test_remove_list_whitespace(self):
+ self.rws("a", "a")
+ self.rws(" a ", " a ")
+ self.rws(" [a] ", " [a] ")
+ self.rws(" [ a] ", " [a] ")
+ self.rws(" [ a ] ", " [a] ")
+ self.rws(" [ a b c ] ", " [abc] ")
+ self.rws(" [ a \"b c\" ] ", " [a\"b c\"] ")
+ self.rws("a [ a \"b c\" ] a", "a [a\"b c\"] a")
+ self.rws("a] [ a \"b c\" ] a", "a] [a\"b c\"] a")
+ self.rws(" [ a [b c] ] ", " [a[bc]] ")
+ self.rws(" [ a b][ c d ] ", " [ab][cd] ")
+ self.rws(" [ a b] [ c d ] ", " [ab] [cd] ")
+
+ self.rws("a", "a")
+ self.rws(" a ", " a ")
+ self.rws(" {a} ", " {a} ")
+ self.rws(" { a} ", " {a} ")
+ self.rws(" { a } ", " {a} ")
+ self.rws(" { a b c } ", " {abc} ")
+ self.rws(" { a \"b c\" } ", " {a\"b c\"} ")
+ self.rws("a { a \"b c\" } a", "a {a\"b c\"} a")
+ self.rws("a} { a \"b c\" } a", "a} {a\"b c\"} a")
+ self.rws(" { a {b c} } ", " {a{bc}} ")
+ self.rws(" { a b}{ c d } ", " {ab}{cd} ")
+ self.rws(" { a b} { c d } ", " {ab} {cd} ")
+
+ self.rws(" [ a b]{ c d } ", " [ab]{cd} ")
+ self.rws(" [ a b{ c d }] ", " [ab{cd}] ")
+ self.rws(" [ a b{ \"c d\" }] ", " [ab{\"c d\"}] ")
+
+
+if __name__== "__main__":
+ unittest.main()
+
diff --git a/src/bin/cfgmgr/Makefile.am b/src/bin/cfgmgr/Makefile.am
index e092070..a41448b 100644
--- a/src/bin/cfgmgr/Makefile.am
+++ b/src/bin/cfgmgr/Makefile.am
@@ -19,7 +19,6 @@ b10-cfgmgr.8: b10-cfgmgr.xml
endif
-# TODO: does this need $$(DESTDIR) also?
# this is done here since configure.ac AC_OUTPUT doesn't expand exec_prefix
b10-cfgmgr: b10-cfgmgr.py
$(SED) "s|@@PYTHONPATH@@|@pyexecdir@|" b10-cfgmgr.py >$@
diff --git a/src/bin/cmdctl/Makefile.am b/src/bin/cmdctl/Makefile.am
index 76572ab..04cf5e2 100644
--- a/src/bin/cmdctl/Makefile.am
+++ b/src/bin/cmdctl/Makefile.am
@@ -4,7 +4,7 @@ pkglibexecdir = $(libexecdir)/@PACKAGE@
pkglibexec_SCRIPTS = b10-cmdctl
-b10_cmdctldir = $(DESTDIR)$(pkgdatadir)
+b10_cmdctldir = $(pkgdatadir)
# NOTE: this will overwrite on install
# So these generic copies are placed in share/bind10 instead of to etc
@@ -33,7 +33,6 @@ endif
cmdctl.spec: cmdctl.spec.pre
$(SED) -e "s|@@SYSCONFDIR@@|$(sysconfdir)|" cmdctl.spec.pre >$@
-# TODO: does this need $$(DESTDIR) also?
# this is done here since configure.ac AC_OUTPUT doesn't expand exec_prefix
b10-cmdctl: cmdctl.py
$(SED) "s|@@PYTHONPATH@@|@pyexecdir@|" cmdctl.py >$@
diff --git a/src/bin/host/host.cc b/src/bin/host/host.cc
index 477586d..c513b5a 100644
--- a/src/bin/host/host.cc
+++ b/src/bin/host/host.cc
@@ -70,12 +70,15 @@ host_lookup(const char* const name, const char* const type) {
msg.toWire(renderer);
struct addrinfo hints, *res;
- int e;
memset(&hints, 0, sizeof(hints));
hints.ai_family = AF_UNSPEC;
hints.ai_socktype = SOCK_DGRAM;
hints.ai_flags = 0; // not using AI_NUMERICHOST in case to bootstrap
- e = getaddrinfo(server, server_port, &hints, &res);
+ if (getaddrinfo(server, server_port, &hints, &res) != 0) {
+ cerr << "address/port conversion for " << server << ":"
+ << server_port << " failed" << endl;
+ return (1);
+ }
if (verbose) {
cout << "Trying \"" << name << "\"\n";
diff --git a/src/bin/msgq/Makefile.am b/src/bin/msgq/Makefile.am
index 9ed4717..61d4f23 100644
--- a/src/bin/msgq/Makefile.am
+++ b/src/bin/msgq/Makefile.am
@@ -16,7 +16,6 @@ b10-msgq.8: msgq.xml
endif
-# TODO: does this need $$(DESTDIR) also?
# this is done here since configure.ac AC_OUTPUT doesn't expand exec_prefix
b10-msgq: msgq.py
$(SED) "s|@@PYTHONPATH@@|@pyexecdir@|" msgq.py >$@
diff --git a/src/bin/msgq/msgq.py.in b/src/bin/msgq/msgq.py.in
index 8a8362a..06fe840 100755
--- a/src/bin/msgq/msgq.py.in
+++ b/src/bin/msgq/msgq.py.in
@@ -40,7 +40,7 @@ isc.util.process.rename()
# This is the version that gets displayed to the user.
# The VERSION string consists of the module name, the module version
# number, and the overall BIND 10 version number (set in configure.ac).
-VERSION = "b10-msgq 20100818 (BIND 10 @PACKAGE_VERSION@)"
+VERSION = "b10-msgq 20110127 (BIND 10 @PACKAGE_VERSION@)"
class MsgQReceiveError(Exception): pass
diff --git a/src/bin/resolver/Makefile.am b/src/bin/resolver/Makefile.am
index 9e86ddd..36b8551 100644
--- a/src/bin/resolver/Makefile.am
+++ b/src/bin/resolver/Makefile.am
@@ -48,11 +48,14 @@ b10_resolver_LDADD += $(top_builddir)/src/lib/exceptions/libexceptions.la
b10_resolver_LDADD += $(top_builddir)/src/lib/asiolink/libasiolink.la
b10_resolver_LDADD += $(top_builddir)/src/lib/xfr/libxfr.la
b10_resolver_LDADD += $(top_builddir)/src/lib/log/liblog.la
+b10_resolver_LDADD += $(top_builddir)/src/lib/server_common/libserver_common.la
+b10_resolver_LDADD += $(top_builddir)/src/lib/cache/libcache.la
+b10_resolver_LDADD += $(top_builddir)/src/lib/nsas/libnsas.la
b10_resolver_LDADD += $(top_builddir)/src/bin/auth/change_user.o
b10_resolver_LDFLAGS = -pthread
# TODO: config.h.in is wrong because doesn't honor pkgdatadir
# and can't use @datadir@ because doesn't expand default ${prefix}
-b10_resolverdir = $(DESTDIR)$(pkgdatadir)
+b10_resolverdir = $(pkgdatadir)
b10_resolver_DATA = resolver.spec
diff --git a/src/bin/resolver/b10-resolver.8 b/src/bin/resolver/b10-resolver.8
index 493538b..3125e32 100644
--- a/src/bin/resolver/b10-resolver.8
+++ b/src/bin/resolver/b10-resolver.8
@@ -2,12 +2,12 @@
.\" Title: b10-resolver
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: January 19, 2011
+.\" Date: February 17, 2011
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
-.TH "B10\-RESOLVER" "8" "January 19, 2011" "BIND10" "BIND10"
+.TH "B10\-RESOLVER" "8" "February 17, 2011" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
@@ -39,23 +39,6 @@ will exit\&.
.PP
It also receives its configurations from
\fBb10-cfgmgr\fR(8)\&.
-.if n \{\
-.sp
-.\}
-.RS 4
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBNote\fR
-.ps -1
-.br
-.PP
-This prototype version only supports forwarding\&. Future versions will introduce full recursion, cache, lookup of local authoritative data (as in
-\fBb10\-auth\fR), and DNSSEC validation\&.
-.sp .5v
-.RE
.SH "OPTIONS"
.PP
The arguments are as follows:
@@ -95,11 +78,30 @@ number\&. The defaults are address ::1 port 5300 and address 127\&.0\&.0\&.1 por
.PP
\fIretries\fR
-is the number of times to retry (resend query) after a timeout\&. The default is 0 (do not retry)\&.
+is the number of times to retry (resend query) after a query timeout (\fItimeout_query\fR)\&. The default is 3\&.
+.PP
+
+\fIroot_addresses\fR
+is a list of addresses and ports for
+\fBb10\-resolver\fR
+to use directly as root servers to start resolving\&. The list items are the
+\fIaddress\fR
+string and
+\fIport\fR
+number\&. If empty, a hardcoded address for F\-root (192\&.5\&.5\&.241) is used\&.
+.PP
+
+\fItimeout_client\fR
+is the number of milliseconds to wait before timing out the incoming client query\&. If set to \-1, this timeout is disabled\&. The default is 4000\&. After this timeout, a SERVFAIL is sent back to the client asking the question\&. (The lookup may continue after the timeout, but a later answer is not returned for the now\-past query\&.)
.PP
-\fItimeout\fR
-is the number of milliseconds to wait for answer\&. If set to \-1, the timeout is disabled\&. The default is 2000\&.
+\fItimeout_lookup\fR
+is the number of milliseconds before it stops trying the query\&. If set to \-1, this timeout is disabled\&. The default is 30000\&.
+.PP
+
+
+\fItimeout_query\fR
+is the number of milliseconds to wait before it retries a query\&. If set to \-1, this timeout is disabled\&. The default is 2000\&.
.PP
The configuration command is:
.PP
@@ -119,8 +121,7 @@ BIND 10 Guide\&.
.PP
The
\fBb10\-resolver\fR
-daemon was first coded in September 2010\&. The initial implementation only provided forwarding\&.
-
+daemon was first coded in September 2010\&. The initial implementation only provided forwarding\&. Iteration was introduced in January 2011\&.
.SH "COPYRIGHT"
.br
diff --git a/src/bin/resolver/b10-resolver.xml b/src/bin/resolver/b10-resolver.xml
index dc2b724..0d395a7 100644
--- a/src/bin/resolver/b10-resolver.xml
+++ b/src/bin/resolver/b10-resolver.xml
@@ -20,7 +20,7 @@
<refentry>
<refentryinfo>
- <date>January 19, 2011</date>
+ <date>February 17, 2011</date>
</refentryinfo>
<refmeta>
@@ -69,11 +69,13 @@
<citerefentry><refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
+<!--
<note><para>
- This prototype version only supports forwarding. Future versions
- will introduce full recursion, cache, lookup of local authoritative
- data (as in <command>b10-auth</command>), and DNSSEC validation.
+ Future versions will introduce lookup of local authoritative
+ data (as in <command>b10-auth</command>) and DNSSEC validation.
</para></note>
+-->
+
</refsect1>
<refsect1>
@@ -128,7 +130,7 @@ port
-->
</para>
-<!-- trac386:
+<!-- trac384:
once that is merged you can for instance do 'config add Resolver/forward_addresses { "port": 123 } and it will fill in the rest (in this case ::1 for the address)
@@ -145,13 +147,43 @@ once that is merged you can for instance do 'config add Resolver/forward_address
<para>
<varname>retries</varname> is the number of times to retry
- (resend query) after a timeout.
- The default is 0 (do not retry).
+ (resend query) after a query timeout
+ (<varname>timeout_query</varname>).
+ The default is 3.
+ </para>
+
+ <para>
+ <varname>root_addresses</varname> is a list of addresses and ports
+ for <command>b10-resolver</command> to use directly as
+ root servers to start resolving.
+ The list items are the <varname>address</varname> string
+ and <varname>port</varname> number.
+ If empty, a hardcoded address for F-root (192.5.5.241) is used.
+ </para>
+
+ <para>
+ <varname>timeout_client</varname> is the number of milliseconds
+ to wait before timing out the incoming client query.
+ If set to -1, this timeout is disabled.
+ The default is 4000.
+ After this timeout, a SERVFAIL is sent back to the client asking
+ the question.
+ (The lookup may continue after the timeout, but a later answer
+ is not returned for the now-past query.)
+ </para>
+
+ <para>
+ <varname>timeout_lookup</varname> is the number of milliseconds
+ before it stops trying the query.
+ If set to -1, this timeout is disabled.
+ The default is 30000.
</para>
<para>
- <varname>timeout</varname> is the number of milliseconds to
- wait for answer. If set to -1, the timeout is disabled.
+<!-- previous timeout was renamed to timeout_query -->
+ <varname>timeout_query</varname> is the number of milliseconds to
+ wait before it retries a query.
+ If set to -1, this timeout is disabled.
The default is 2000.
</para>
@@ -200,9 +232,8 @@ once that is merged you can for instance do 'config add Resolver/forward_address
<para>
The <command>b10-resolver</command> daemon was first coded in
September 2010. The initial implementation only provided
- forwarding.
+ forwarding. Iteration was introduced in January 2011.
<!-- TODO: document when caching was added -->
-<!-- TODO: document when iteration was added -->
<!-- TODO: document when validation was added -->
</para>
</refsect1>
diff --git a/src/bin/resolver/resolver.cc b/src/bin/resolver/resolver.cc
index dfd84a6..84df9d2 100644
--- a/src/bin/resolver/resolver.cc
+++ b/src/bin/resolver/resolver.cc
@@ -39,6 +39,7 @@
#include <dns/rrttl.h>
#include <dns/message.h>
#include <dns/messagerenderer.h>
+#include <server_common/portconfig.h>
#include <log/dummylog.h>
@@ -52,8 +53,7 @@ using namespace isc::data;
using namespace isc::config;
using isc::log::dlog;
using namespace asiolink;
-
-typedef pair<string, uint16_t> addr_t;
+using namespace isc::server_common::portconfig;
class ResolverImpl {
private:
@@ -96,14 +96,14 @@ public:
}
}
- void setForwardAddresses(const vector<addr_t>& upstream,
+ void setForwardAddresses(const AddressList& upstream,
DNSService *dnss)
{
upstream_ = upstream;
if (dnss) {
if (!upstream_.empty()) {
dlog("Setting forward addresses:");
- BOOST_FOREACH(const addr_t& address, upstream) {
+ BOOST_FOREACH(const AddressPair& address, upstream) {
dlog(" " + address.first + ":" +
boost::lexical_cast<string>(address.second));
}
@@ -113,14 +113,14 @@ public:
}
}
- void setRootAddresses(const vector<addr_t>& upstream_root,
+ void setRootAddresses(const AddressList& upstream_root,
DNSService *dnss)
{
upstream_root_ = upstream_root;
if (dnss) {
if (!upstream_root_.empty()) {
dlog("Setting root addresses:");
- BOOST_FOREACH(const addr_t& address, upstream_root) {
+ BOOST_FOREACH(const AddressPair& address, upstream_root) {
dlog(" " + address.first + ":" +
boost::lexical_cast<string>(address.second));
}
@@ -144,11 +144,11 @@ public:
/// These members are public because Resolver accesses them directly.
ModuleCCSession* config_session_;
/// Addresses of the root nameserver(s)
- vector<addr_t> upstream_root_;
+ AddressList upstream_root_;
/// Addresses of the forward nameserver
- vector<addr_t> upstream_;
+ AddressList upstream_;
/// Addresses we listen on
- vector<addr_t> listen_;
+ AddressList listen_;
/// Timeout for outgoing queries in milliseconds
int query_timeout_;
@@ -182,9 +182,11 @@ public:
MessagePtr message_;
};
+
+// TODO: REMOVE, USE isc::resolve::MakeErrorMessage?
void
-makeErrorMessage(MessagePtr message, OutputBufferPtr buffer,
- const Rcode& rcode)
+makeErrorMessage(MessagePtr message, MessagePtr answer_message,
+ OutputBufferPtr buffer, const Rcode& rcode)
{
// extract the parameters that should be kept.
// XXX: with the current implementation, it's not easy to set EDNS0
@@ -195,6 +197,12 @@ makeErrorMessage(MessagePtr message, OutputBufferPtr buffer,
const Opcode& opcode = message->getOpcode();
vector<QuestionPtr> questions;
+ // answer_message is actually ignored right now,
+ // see the comment in #607
+ answer_message->setRcode(rcode);
+ answer_message->setOpcode(opcode);
+ answer_message->setQid(qid);
+
// If this is an error to a query or notify, we should also copy the
// question section.
if (opcode == Opcode::QUERY() || opcode == Opcode::NOTIFY()) {
@@ -256,25 +264,16 @@ public:
const qid_t qid = query_message->getQid();
const bool rd = query_message->getHeaderFlag(Message::HEADERFLAG_RD);
const bool cd = query_message->getHeaderFlag(Message::HEADERFLAG_CD);
- const Opcode& opcode = query_message->getOpcode();
-
- // Fill in the final details of the answer message
+
+ // The opcode and question section should have already been set,
+ // fill in the final details of the answer message
answer_message->setQid(qid);
- answer_message->setOpcode(opcode);
answer_message->setHeaderFlag(Message::HEADERFLAG_QR);
answer_message->setHeaderFlag(Message::HEADERFLAG_RA);
- if (rd) {
- answer_message->setHeaderFlag(Message::HEADERFLAG_RD);
- }
- if (cd) {
- answer_message->setHeaderFlag(Message::HEADERFLAG_CD);
- }
+ answer_message->setHeaderFlag(Message::HEADERFLAG_RD, rd);
+ answer_message->setHeaderFlag(Message::HEADERFLAG_CD, cd);
- vector<QuestionPtr> questions;
- questions.assign(query_message->beginQuestion(), query_message->endQuestion());
- for_each(questions.begin(), questions.end(), QuestionInserter(answer_message));
-
// Now we can clear the buffer and render the new message into it
buffer->clear();
MessageRenderer renderer(*buffer);
@@ -392,12 +391,14 @@ Resolver::processMessage(const IOMessage& io_message,
} catch (const DNSProtocolError& error) {
dlog(string("returning ") + error.getRcode().toText() + ": " +
error.what());
- makeErrorMessage(query_message, buffer, error.getRcode());
+ makeErrorMessage(query_message, answer_message,
+ buffer, error.getRcode());
server->resume(true);
return;
} catch (const Exception& ex) {
dlog(string("returning SERVFAIL: ") + ex.what());
- makeErrorMessage(query_message, buffer, Rcode::SERVFAIL());
+ makeErrorMessage(query_message, answer_message,
+ buffer, Rcode::SERVFAIL());
server->resume(true);
return;
} // other exceptions will be handled at a higher layer.
@@ -407,28 +408,34 @@ Resolver::processMessage(const IOMessage& io_message,
// Perform further protocol-level validation.
bool sendAnswer = true;
if (query_message->getOpcode() == Opcode::NOTIFY()) {
- makeErrorMessage(query_message, buffer, Rcode::NOTAUTH());
+ makeErrorMessage(query_message, answer_message,
+ buffer, Rcode::NOTAUTH());
dlog("Notify arrived, but we are not authoritative");
} else if (query_message->getOpcode() != Opcode::QUERY()) {
dlog("Unsupported opcode (got: " + query_message->getOpcode().toText() +
", expected: " + Opcode::QUERY().toText());
- makeErrorMessage(query_message, buffer, Rcode::NOTIMP());
+ makeErrorMessage(query_message, answer_message,
+ buffer, Rcode::NOTIMP());
} else if (query_message->getRRCount(Message::SECTION_QUESTION) != 1) {
dlog("The query contained " +
boost::lexical_cast<string>(query_message->getRRCount(
Message::SECTION_QUESTION) + " questions, exactly one expected"));
- makeErrorMessage(query_message, buffer, Rcode::FORMERR());
+ makeErrorMessage(query_message, answer_message,
+ buffer, Rcode::FORMERR());
} else {
ConstQuestionPtr question = *query_message->beginQuestion();
const RRType &qtype = question->getType();
if (qtype == RRType::AXFR()) {
if (io_message.getSocket().getProtocol() == IPPROTO_UDP) {
- makeErrorMessage(query_message, buffer, Rcode::FORMERR());
+ makeErrorMessage(query_message, answer_message,
+ buffer, Rcode::FORMERR());
} else {
- makeErrorMessage(query_message, buffer, Rcode::NOTIMP());
+ makeErrorMessage(query_message, answer_message,
+ buffer, Rcode::NOTIMP());
}
} else if (qtype == RRType::IXFR()) {
- makeErrorMessage(query_message, buffer, Rcode::NOTIMP());
+ makeErrorMessage(query_message, answer_message,
+ buffer, Rcode::NOTIMP());
} else {
// The RecursiveQuery object will post the "resume" event to the
// DNSServer when an answer arrives, so we don't have to do it now.
@@ -460,46 +467,6 @@ ResolverImpl::processNormalQuery(const Question& question,
rec_query_->resolve(question, answer_message, buffer, server);
}
-namespace {
-
-vector<addr_t>
-parseAddresses(ConstElementPtr addresses) {
- vector<addr_t> result;
- if (addresses) {
- if (addresses->getType() == Element::list) {
- for (size_t i(0); i < addresses->size(); ++ i) {
- ConstElementPtr addrPair(addresses->get(i));
- ConstElementPtr addr(addrPair->get("address"));
- ConstElementPtr port(addrPair->get("port"));
- if (!addr || ! port) {
- isc_throw(BadValue, "Address must contain both the IP"
- "address and port");
- }
- try {
- IOAddress(addr->stringValue());
- if (port->intValue() < 0 ||
- port->intValue() > 0xffff) {
- isc_throw(BadValue, "Bad port value (" <<
- port->intValue() << ")");
- }
- result.push_back(addr_t(addr->stringValue(),
- port->intValue()));
- }
- catch (const TypeError &e) { // Better error message
- isc_throw(TypeError,
- "Address must be a string and port an integer");
- }
- }
- } else if (addresses->getType() != Element::null) {
- isc_throw(TypeError,
- "root_addresses, forward_addresses, and listen_on config element must be a list");
- }
- }
- return (result);
-}
-
-}
-
ConstElementPtr
Resolver::updateConfig(ConstElementPtr config) {
dlog("New config comes: " + config->toWire());
@@ -507,11 +474,14 @@ Resolver::updateConfig(ConstElementPtr config) {
try {
// Parse forward_addresses
ConstElementPtr rootAddressesE(config->get("root_addresses"));
- vector<addr_t> rootAddresses(parseAddresses(rootAddressesE));
+ AddressList rootAddresses(parseAddresses(rootAddressesE,
+ "root_addresses"));
ConstElementPtr forwardAddressesE(config->get("forward_addresses"));
- vector<addr_t> forwardAddresses(parseAddresses(forwardAddressesE));
+ AddressList forwardAddresses(parseAddresses(forwardAddressesE,
+ "forward_addresses"));
ConstElementPtr listenAddressesE(config->get("listen_on"));
- vector<addr_t> listenAddresses(parseAddresses(listenAddressesE));
+ AddressList listenAddresses(parseAddresses(listenAddressesE,
+ "listen_on"));
bool set_timeouts(false);
int qtimeout = impl_->query_timeout_;
int ctimeout = impl_->client_timeout_;
@@ -584,13 +554,13 @@ Resolver::updateConfig(ConstElementPtr config) {
}
void
-Resolver::setForwardAddresses(const vector<addr_t>& addresses)
+Resolver::setForwardAddresses(const AddressList& addresses)
{
impl_->setForwardAddresses(addresses, dnss_);
}
void
-Resolver::setRootAddresses(const vector<addr_t>& addresses)
+Resolver::setRootAddresses(const AddressList& addresses)
{
impl_->setRootAddresses(addresses, dnss_);
}
@@ -600,58 +570,19 @@ Resolver::isForwarding() const {
return (!impl_->upstream_.empty());
}
-vector<addr_t>
+AddressList
Resolver::getForwardAddresses() const {
return (impl_->upstream_);
}
-vector<addr_t>
+AddressList
Resolver::getRootAddresses() const {
return (impl_->upstream_root_);
}
-namespace {
-
void
-setAddresses(DNSService *service, const vector<addr_t>& addresses) {
- service->clearServers();
- BOOST_FOREACH(const addr_t &address, addresses) {
- service->addServer(address.second, address.first);
- }
-}
-
-}
-
-void
-Resolver::setListenAddresses(const vector<addr_t>& addresses) {
- try {
- dlog("Setting listen addresses:");
- BOOST_FOREACH(const addr_t& addr, addresses) {
- dlog(" " + addr.first + ":" +
- boost::lexical_cast<string>(addr.second));
- }
- setAddresses(dnss_, addresses);
- impl_->listen_ = addresses;
- }
- catch (const exception& e) {
- /*
- * We couldn't set it. So return it back. If that fails as well,
- * we have a problem.
- *
- * If that fails, bad luck, but we are useless anyway, so just die
- * and let boss start us again.
- */
- dlog(string("Unable to set new address: ") + e.what(),true);
- try {
- setAddresses(dnss_, impl_->listen_);
- }
- catch (const exception& e2) {
- dlog(string("Unable to recover from error;"),true);
- dlog(string("Rollback failed with: ") + e2.what(),true);
- abort();
- }
- throw e; // Let it fly a little bit further
- }
+Resolver::setListenAddresses(const AddressList& addresses) {
+ installListenAddresses(addresses, impl_->listen_, *dnss_);
}
void
@@ -687,7 +618,7 @@ Resolver::getRetries() const {
return impl_->retries_;
}
-vector<addr_t>
+AddressList
Resolver::getListenAddresses() const {
return (impl_->listen_);
}
diff --git a/src/bin/resolver/resolver.spec.pre.in b/src/bin/resolver/resolver.spec.pre.in
index a249009..bc598b0 100644
--- a/src/bin/resolver/resolver.spec.pre.in
+++ b/src/bin/resolver/resolver.spec.pre.in
@@ -6,48 +6,48 @@
{
"item_name": "timeout_query",
"item_type": "integer",
- "item_optional": False,
+ "item_optional": false,
"item_default": 2000
},
{
"item_name": "timeout_client",
"item_type": "integer",
- "item_optional": False,
+ "item_optional": false,
"item_default": 4000
},
{
"item_name": "timeout_lookup",
"item_type": "integer",
- "item_optional": False,
+ "item_optional": false,
"item_default": 30000
},
{
"item_name": "retries",
"item_type": "integer",
- "item_optional": False,
- "item_default": 0
+ "item_optional": false,
+ "item_default": 3
},
{
"item_name": "forward_addresses",
"item_type": "list",
- "item_optional": True,
+ "item_optional": true,
"item_default": [],
"list_item_spec" : {
"item_name": "address",
"item_type": "map",
- "item_optional": False,
+ "item_optional": false,
"item_default": {},
"map_item_spec": [
{
"item_name": "address",
"item_type": "string",
- "item_optional": False,
+ "item_optional": false,
"item_default": "::1"
},
{
"item_name": "port",
"item_type": "integer",
- "item_optional": False,
+ "item_optional": false,
"item_default": 53
}
]
@@ -56,24 +56,24 @@
{
"item_name": "root_addresses",
"item_type": "list",
- "item_optional": True,
+ "item_optional": true,
"item_default": [],
"list_item_spec" : {
"item_name": "address",
"item_type": "map",
- "item_optional": False,
+ "item_optional": false,
"item_default": {},
"map_item_spec": [
{
"item_name": "address",
"item_type": "string",
- "item_optional": False,
+ "item_optional": false,
"item_default": "::1"
},
{
"item_name": "port",
"item_type": "integer",
- "item_optional": False,
+ "item_optional": false,
"item_default": 53
}
]
@@ -82,7 +82,7 @@
{
"item_name": "listen_on",
"item_type": "list",
- "item_optional": False,
+ "item_optional": false,
"item_default": [
{
"address": "::1",
@@ -91,24 +91,24 @@
{
"address": "127.0.0.1",
"port": 5300
- },
+ }
],
"list_item_spec": {
"item_name": "address",
"item_type": "map",
- "item_optional": False,
+ "item_optional": false,
"item_default": {},
"map_item_spec": [
{
"item_name": "address",
"item_type": "string",
- "item_optional": False,
+ "item_optional": false,
"item_default": "::1"
},
{
"item_name": "port",
"item_type": "integer",
- "item_optional": False,
+ "item_optional": false,
"item_default": 5300
}
]
diff --git a/src/bin/resolver/tests/Makefile.am b/src/bin/resolver/tests/Makefile.am
index a03439c..eb7e3e1 100644
--- a/src/bin/resolver/tests/Makefile.am
+++ b/src/bin/resolver/tests/Makefile.am
@@ -37,6 +37,9 @@ run_unittests_LDADD += $(top_builddir)/src/lib/cc/libcc.la
run_unittests_LDADD += $(top_builddir)/src/lib/exceptions/libexceptions.la
run_unittests_LDADD += $(top_builddir)/src/lib/xfr/libxfr.la
run_unittests_LDADD += $(top_builddir)/src/lib/log/liblog.la
+run_unittests_LDADD += $(top_builddir)/src/lib/server_common/libserver_common.la
+run_unittests_LDADD += $(top_builddir)/src/lib/cache/libcache.la
+run_unittests_LDADD += $(top_builddir)/src/lib/nsas/libnsas.la
# Note the ordering matters: -Wno-... must follow -Wextra (defined in
# B10_CXXFLAGS
diff --git a/src/bin/resolver/tests/resolver_config_unittest.cc b/src/bin/resolver/tests/resolver_config_unittest.cc
index 916396a..1d6415b 100644
--- a/src/bin/resolver/tests/resolver_config_unittest.cc
+++ b/src/bin/resolver/tests/resolver_config_unittest.cc
@@ -24,6 +24,7 @@
#include <dns/tests/unittest_util.h>
#include <testutils/srv_test.h>
+#include <testutils/portconfig.h>
using namespace std;
using namespace isc::data;
@@ -42,7 +43,7 @@ class ResolverConfig : public ::testing::Test {
{
server.setDNSService(dnss);
}
- void invalidTest(const string &JOSN);
+ void invalidTest(const string &JSON, const string& name);
};
TEST_F(ResolverConfig, forwardAddresses) {
@@ -122,117 +123,48 @@ TEST_F(ResolverConfig, rootAddressConfig) {
}
void
-ResolverConfig::invalidTest(const string &JOSN) {
- ElementPtr config(Element::fromJSON(JOSN));
- EXPECT_FALSE(server.updateConfig(config)->equals(
- *isc::config::createAnswer())) << "Accepted config " << JOSN << endl;
+ResolverConfig::invalidTest(const string &JSON, const string& name) {
+ isc::testutils::portconfig::configRejected(server, JSON, name);
}
TEST_F(ResolverConfig, invalidForwardAddresses) {
// Try torturing it with some invalid inputs
invalidTest("{"
"\"forward_addresses\": \"error\""
- "}");
+ "}", "Invalid type");
invalidTest("{"
"\"forward_addresses\": [{}]"
- "}");
+ "}", "Empty element");
invalidTest("{"
"\"forward_addresses\": [{"
" \"port\": 1.5,"
" \"address\": \"192.0.2.1\""
- "}]}");
+ "}]}", "Float port");
invalidTest("{"
"\"forward_addresses\": [{"
" \"port\": -5,"
" \"address\": \"192.0.2.1\""
- "}]}");
+ "}]}", "Negative port");
invalidTest("{"
"\"forward_addresses\": [{"
" \"port\": 53,"
" \"address\": \"bad_address\""
- "}]}");
+ "}]}", "Bad address");
}
+// Try setting the addresses directly
TEST_F(ResolverConfig, listenAddresses) {
- // Default value should be fully recursive
- EXPECT_TRUE(server.getListenAddresses().empty());
-
- // Try putting there some addresses
- vector<pair<string, uint16_t> > addresses;
- addresses.push_back(pair<string, uint16_t>("127.0.0.1", 5321));
- addresses.push_back(pair<string, uint16_t>("::1", 5321));
- server.setListenAddresses(addresses);
- EXPECT_EQ(2, server.getListenAddresses().size());
- EXPECT_EQ("::1", server.getListenAddresses()[1].first);
-
- // Is it independent from what we do with the vector later?
- addresses.clear();
- EXPECT_EQ(2, server.getListenAddresses().size());
-
- // Did it return to fully recursive?
- server.setListenAddresses(addresses);
- EXPECT_TRUE(server.getListenAddresses().empty());
+ isc::testutils::portconfig::listenAddresses(server);
}
-TEST_F(ResolverConfig, DISABLED_listenAddressConfig) {
- // Try putting there some address
- ElementPtr config(Element::fromJSON("{"
- "\"listen_on\": ["
- " {"
- " \"address\": \"127.0.0.1\","
- " \"port\": 5321"
- " }"
- "]"
- "}"));
- ConstElementPtr result(server.updateConfig(config));
- EXPECT_EQ(result->toWire(), isc::config::createAnswer()->toWire());
- ASSERT_EQ(1, server.getListenAddresses().size());
- EXPECT_EQ("127.0.0.1", server.getListenAddresses()[0].first);
- EXPECT_EQ(5321, server.getListenAddresses()[0].second);
-
- // As this is example address, the machine should not have it on
- // any interface
- // FIXME: This test aborts, because it tries to rollback and
- // it is impossible, since the sockets are not closed.
- // Once #388 is solved, enable this test.
- config = Element::fromJSON("{"
- "\"listen_on\": ["
- " {"
- " \"address\": \"192.0.2.0\","
- " \"port\": 5321"
- " }"
- "]"
- "}");
- result = server.updateConfig(config);
- EXPECT_FALSE(result->equals(*isc::config::createAnswer()));
- ASSERT_EQ(1, server.getListenAddresses().size());
- EXPECT_EQ("127.0.0.1", server.getListenAddresses()[0].first);
- EXPECT_EQ(5321, server.getListenAddresses()[0].second);
+// Try setting some addresses and a rollback
+TEST_F(ResolverConfig, listenAddressConfig) {
+ isc::testutils::portconfig::listenAddressConfig(server);
}
+// Try some invalid configs are rejected
TEST_F(ResolverConfig, invalidListenAddresses) {
- // Try torturing it with some invalid inputs
- invalidTest("{"
- "\"listen_on\": \"error\""
- "}");
- invalidTest("{"
- "\"listen_on\": [{}]"
- "}");
- invalidTest("{"
- "\"listen_on\": [{"
- " \"port\": 1.5,"
- " \"address\": \"192.0.2.1\""
- "}]}");
- invalidTest("{"
- "\"listen_on\": [{"
- " \"port\": -5,"
- " \"address\": \"192.0.2.1\""
- "}]}");
- invalidTest("{"
- "\"listen_on\": [{"
- " \"port\": 53,"
- " \"address\": \"bad_address\""
- "}]}");
+ isc::testutils::portconfig::invalidListenAddressConfig(server);
}
// Just test it sets and gets the values correctly
@@ -267,28 +199,28 @@ TEST_F(ResolverConfig, timeoutsConfig) {
TEST_F(ResolverConfig, invalidTimeoutsConfig) {
invalidTest("{"
"\"timeout_query\": \"error\""
- "}");
+ "}", "Wrong query element type");
invalidTest("{"
"\"timeout_query\": -2"
- "}");
+ "}", "Negative query timeout");
invalidTest("{"
"\"timeout_client\": \"error\""
- "}");
+ "}", "Wrong client element type");
invalidTest("{"
"\"timeout_client\": -2"
- "}");
+ "}", "Negative client timeout");
invalidTest("{"
"\"timeout_lookup\": \"error\""
- "}");
+ "}", "Wrong lookup element type");
invalidTest("{"
"\"timeout_lookup\": -2"
- "}");
+ "}", "Negative lookup timeout");
invalidTest("{"
"\"retries\": \"error\""
- "}");
+ "}", "Wrong retries element type");
invalidTest("{"
"\"retries\": -1"
- "}");
+ "}", "Negative number of retries");
}
}
diff --git a/src/bin/resolver/tests/resolver_unittest.cc b/src/bin/resolver/tests/resolver_unittest.cc
index a4f11f5..97edf12 100644
--- a/src/bin/resolver/tests/resolver_unittest.cc
+++ b/src/bin/resolver/tests/resolver_unittest.cc
@@ -96,6 +96,27 @@ TEST_F(ResolverTest, AXFRFail) {
QR_FLAG, 1, 0, 0, 0);
}
+TEST_F(ResolverTest, IXFRFail) {
+ UnitTestUtil::createRequestMessage(request_message, opcode, default_qid,
+ Name("example.com"), RRClass::IN(),
+ RRType::IXFR());
+ createRequestPacket(request_message, IPPROTO_TCP);
+ // IXFR is not implemented and should always send NOTIMP.
+ server.processMessage(*io_message,
+ parse_message,
+ response_message,
+ response_obuffer,
+ &dnsserv);
+ EXPECT_TRUE(dnsserv.hasAnswer());
+ // the second check is what we'll need in the end (with the values
+ // from the first one), but right now the first one is for what
+ // will actually be returned to the client
+ headerCheck(*parse_message, default_qid, Rcode::NOTIMP(), opcode.getCode(),
+ QR_FLAG, 1, 0, 0, 0);
+ headerCheck(*response_message, default_qid, Rcode::NOTIMP(), opcode.getCode(),
+ 0, 0, 0, 0, 0);
+}
+
TEST_F(ResolverTest, notifyFail) {
// Notify should always return NOTAUTH
request_message.clear(Message::RENDER);
diff --git a/src/bin/stats/Makefile.am b/src/bin/stats/Makefile.am
index f76503e..dedbb62 100644
--- a/src/bin/stats/Makefile.am
+++ b/src/bin/stats/Makefile.am
@@ -4,7 +4,7 @@ pkglibexecdir = $(libexecdir)/@PACKAGE@
pkglibexec_SCRIPTS = b10-stats b10-stats-httpd
-b10_statsdir = $(DESTDIR)$(pkgdatadir)
+b10_statsdir = $(pkgdatadir)
b10_stats_DATA = stats.spec stats-httpd.spec
b10_stats_DATA += stats-httpd-xml.tpl stats-httpd-xsd.tpl stats-httpd-xsl.tpl
@@ -27,7 +27,6 @@ b10-stats-httpd.8: b10-stats-httpd.xml
endif
-# TODO: does this need $$(DESTDIR) also?
# this is done here since configure.ac AC_OUTPUT doesn't expand exec_prefix
b10-stats: stats.py
$(SED) -e "s|@@PYTHONPATH@@|@pyexecdir@|" \
diff --git a/src/bin/usermgr/Makefile.am b/src/bin/usermgr/Makefile.am
index f830aad..7ebb1cd 100644
--- a/src/bin/usermgr/Makefile.am
+++ b/src/bin/usermgr/Makefile.am
@@ -1,6 +1,6 @@
sbin_SCRIPTS = b10-cmdctl-usermgr
-b10_cmdctl_usermgrdir = $(DESTDIR)$(pkgdatadir)
+b10_cmdctl_usermgrdir = $(pkgdatadir)
CLEANFILES= b10-cmdctl-usermgr
@@ -14,7 +14,6 @@ b10-cmdctl-usermgr.8: b10-cmdctl-usermgr.xml
endif
-# TODO: does this need $$(DESTDIR) also?
# this is done here since configure.ac AC_OUTPUT doesn't expand exec_prefix
b10-cmdctl-usermgr: b10-cmdctl-usermgr.py
$(SED) "s|@@PYTHONPATH@@|@pyexecdir@|" b10-cmdctl-usermgr.py >$@
diff --git a/src/bin/xfrin/Makefile.am b/src/bin/xfrin/Makefile.am
index 7ed41e2..ee8505e 100644
--- a/src/bin/xfrin/Makefile.am
+++ b/src/bin/xfrin/Makefile.am
@@ -4,7 +4,7 @@ pkglibexecdir = $(libexecdir)/@PACKAGE@
pkglibexec_SCRIPTS = b10-xfrin
-b10_xfrindir = $(DESTDIR)$(pkgdatadir)
+b10_xfrindir = $(pkgdatadir)
b10_xfrin_DATA = xfrin.spec
CLEANFILES = b10-xfrin xfrin.pyc
@@ -20,7 +20,6 @@ b10-xfrin.8: b10-xfrin.xml
endif
-# TODO: does this need $$(DESTDIR) also?
# this is done here since configure.ac AC_OUTPUT doesn't expand exec_prefix
b10-xfrin: xfrin.py
$(SED) -e "s|@@PYTHONPATH@@|@pyexecdir@|" \
diff --git a/src/bin/xfrout/Makefile.am b/src/bin/xfrout/Makefile.am
index 4955b7a..d4f021e 100644
--- a/src/bin/xfrout/Makefile.am
+++ b/src/bin/xfrout/Makefile.am
@@ -4,7 +4,7 @@ pkglibexecdir = $(libexecdir)/@PACKAGE@
pkglibexec_SCRIPTS = b10-xfrout
-b10_xfroutdir = $(DESTDIR)$(pkgdatadir)
+b10_xfroutdir = $(pkgdatadir)
b10_xfrout_DATA = xfrout.spec
CLEANFILES= b10-xfrout xfrout.pyc xfrout.spec
@@ -23,7 +23,6 @@ endif
xfrout.spec: xfrout.spec.pre
$(SED) -e "s|@@LOCALSTATEDIR@@|$(localstatedir)|" xfrout.spec.pre >$@
-# TODO: does this need $$(DESTDIR) also?
# this is done here since configure.ac AC_OUTPUT doesn't expand exec_prefix
b10-xfrout: xfrout.py
$(SED) -e "s|@@PYTHONPATH@@|@pyexecdir@|" \
diff --git a/src/bin/xfrout/tests/xfrout_test.py b/src/bin/xfrout/tests/xfrout_test.py
index 2fb4463..5aec072 100644
--- a/src/bin/xfrout/tests/xfrout_test.py
+++ b/src/bin/xfrout/tests/xfrout_test.py
@@ -85,23 +85,12 @@ class TestXfroutSession(unittest.TestCase):
return msg
def setUp(self):
- request = MySocket(socket.AF_INET,socket.SOCK_STREAM)
+ self.sock = MySocket(socket.AF_INET,socket.SOCK_STREAM)
self.log = isc.log.NSLogger('xfrout', '', severity = 'critical', log_to_console = False )
- (self.write_sock, self.read_sock) = socket.socketpair()
- self.xfrsess = MyXfroutSession(request, None, None, self.log, self.read_sock)
- self.xfrsess.server = Dbserver()
+ self.xfrsess = MyXfroutSession(self.sock, None, Dbserver(), self.log)
self.mdata = bytes(b'\xd6=\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x07example\x03com\x00\x00\xfc\x00\x01')
- self.sock = MySocket(socket.AF_INET,socket.SOCK_STREAM)
self.soa_record = (4, 3, 'example.com.', 'com.example.', 3600, 'SOA', None, 'master.example.com. admin.example.com. 1234 3600 1800 2419200 7200')
- def test_receive_query_message(self):
- send_msg = b"\xd6=\x00\x00\x00\x01\x00"
- msg_len = struct.pack('H', socket.htons(len(send_msg)))
- self.write_sock.send(msg_len)
- self.write_sock.send(send_msg)
- recv_msg = self.xfrsess._receive_query_message(self.read_sock)
- self.assertEqual(recv_msg, send_msg)
-
def test_parse_query_message(self):
[get_rcode, get_msg] = self.xfrsess._parse_query_message(self.mdata)
self.assertEqual(get_rcode.to_text(), "NOERROR")
@@ -121,6 +110,29 @@ class TestXfroutSession(unittest.TestCase):
get_msg = self.sock.read_msg()
self.assertEqual(get_msg.get_rcode().to_text(), "NXDOMAIN")
+ def test_send_message(self):
+ msg = self.getmsg()
+ msg.make_response()
+ # soa record data with different cases
+ soa_record = (4, 3, 'Example.com.', 'com.Example.', 3600, 'SOA', None, 'master.Example.com. admin.exAmple.com. 1234 3600 1800 2419200 7200')
+ rrset_soa = self.xfrsess._create_rrset_from_db_record(soa_record)
+ msg.add_rrset(Message.SECTION_ANSWER, rrset_soa)
+ self.xfrsess._send_message(self.sock, msg)
+ send_out_data = self.sock.readsent()[2:]
+
+ # CASE_INSENSITIVE compression mode
+ render = MessageRenderer();
+ render.set_length_limit(XFROUT_MAX_MESSAGE_SIZE)
+ msg.to_wire(render)
+ self.assertNotEqual(render.get_data(), send_out_data)
+
+ # CASE_SENSITIVE compression mode
+ render.clear()
+ render.set_compress_mode(MessageRenderer.CASE_SENSITIVE)
+ render.set_length_limit(XFROUT_MAX_MESSAGE_SIZE)
+ msg.to_wire(render)
+ self.assertEqual(render.get_data(), send_out_data)
+
def test_clear_message(self):
msg = self.getmsg()
qid = msg.get_qid()
@@ -134,7 +146,6 @@ class TestXfroutSession(unittest.TestCase):
self.assertTrue(msg.get_header_flag(Message.HEADERFLAG_AA))
def test_reply_query_with_format_error(self):
-
msg = self.getmsg()
self.xfrsess._reply_query_with_format_error(msg, self.sock)
get_msg = self.sock.read_msg()
@@ -249,11 +260,11 @@ class TestXfroutSession(unittest.TestCase):
self.xfrsess._zone_has_soa = zone_empty
def false_func():
return False
- self.xfrsess.server.increase_transfers_counter = false_func
+ self.xfrsess._server.increase_transfers_counter = false_func
self.assertEqual(self.xfrsess._check_xfrout_available(True).to_text(), "REFUSED")
def true_func():
return True
- self.xfrsess.server.increase_transfers_counter = true_func
+ self.xfrsess._server.increase_transfers_counter = true_func
self.assertEqual(self.xfrsess._check_xfrout_available(True).to_text(), "NOERROR")
def test_dns_xfrout_start_formerror(self):
@@ -323,8 +334,17 @@ class MyUnixSockServer(UnixSockServer):
class TestUnixSockServer(unittest.TestCase):
def setUp(self):
+ self.write_sock, self.read_sock = socket.socketpair()
self.unix = MyUnixSockServer()
+ def test_receive_query_message(self):
+ send_msg = b"\xd6=\x00\x00\x00\x01\x00"
+ msg_len = struct.pack('H', socket.htons(len(send_msg)))
+ self.write_sock.send(msg_len)
+ self.write_sock.send(send_msg)
+ recv_msg = self.unix._receive_query_message(self.read_sock)
+ self.assertEqual(recv_msg, send_msg)
+
def test_updata_config_data(self):
self.unix.update_config_data({'transfers_out':10 })
self.assertEqual(self.unix._max_transfers_out, 10)
diff --git a/src/bin/xfrout/xfrout.py.in b/src/bin/xfrout/xfrout.py.in
index eb96b94..fd1288d 100755
--- a/src/bin/xfrout/xfrout.py.in
+++ b/src/bin/xfrout/xfrout.py.in
@@ -73,75 +73,25 @@ def get_rrset_len(rrset):
return len(bytes)
-class XfroutSession(BaseRequestHandler):
- def __init__(self, request, client_address, server, log, sock):
+class XfroutSession():
+ def __init__(self, sock_fd, request_data, server, log):
# The initializer for the superclass may call functions
# that need _log to be set, so we set it first
+ self._sock_fd = sock_fd
+ self._request_data = request_data
+ self._server = server
self._log = log
- self._shutdown_sock = sock
- BaseRequestHandler.__init__(self, request, client_address, server)
+ self.handle()
def handle(self):
- '''Handle a request until shutdown or xfrout client is closed.'''
- # check self.server._shutdown_event to ensure the real shutdown comes.
- # Linux could trigger a spurious readable event on the _shutdown_sock
- # due to a bug, so we need perform a double check.
- while not self.server._shutdown_event.is_set(): # Check if xfrout is shutdown
- try:
- (rlist, wlist, xlist) = select.select([self._shutdown_sock, self.request], [], [])
- except select.error as e:
- if e.args[0] == errno.EINTR:
- (rlist, wlist, xlist) = ([], [], [])
- continue
- else:
- self._log.log_message("error", "Error with select(): %s" %e)
- break
- # self.server._shutdown_evnet will be set by now, if it is not a false
- # alarm
- if self._shutdown_sock in rlist:
- continue
-
- sock_fd = recv_fd(self.request.fileno())
-
- if sock_fd < 0:
- # This may happen when one xfrout process try to connect to
- # xfrout unix socket server, to check whether there is another
- # xfrout running.
- if sock_fd == XFR_FD_RECEIVE_FAIL:
- self._log.log_message("error", "Failed to receive the file descriptor for XFR connection")
- break
-
- # receive query msg
- msgdata = self._receive_query_message(self.request)
- if not msgdata:
- break
-
- try:
- self.dns_xfrout_start(sock_fd, msgdata)
- #TODO, avoid catching all exceptions
- except Exception as e:
- self._log.log_message("error", str(e))
-
- os.close(sock_fd)
-
- def _receive_query_message(self, sock):
- ''' receive query message from sock'''
- # receive data length
- data_len = sock.recv(2)
- if not data_len:
- return None
- msg_len = struct.unpack('!H', data_len)[0]
- # receive data
- recv_size = 0
- msgdata = b''
- while recv_size < msg_len:
- data = sock.recv(msg_len - recv_size)
- if not data:
- return None
- recv_size += len(data)
- msgdata += data
+ ''' Handle a xfrout query, send xfrout response '''
+ try:
+ self.dns_xfrout_start(self._sock_fd, self._request_data)
+ #TODO, avoid catching all exceptions
+ except Exception as e:
+ self._log.log_message("error", str(e))
- return msgdata
+ os.close(self._sock_fd)
def _parse_query_message(self, mdata):
''' parse query message to [socket,message]'''
@@ -170,6 +120,9 @@ class XfroutSession(BaseRequestHandler):
def _send_message(self, sock_fd, msg):
render = MessageRenderer()
+ # As defined in RFC5936 section3.4, perform case-preserving name
+ # compression for AXFR message.
+ render.set_compress_mode(MessageRenderer.CASE_SENSITIVE)
render.set_length_limit(XFROUT_MAX_MESSAGE_SIZE)
msg.to_wire(render)
header_len = struct.pack('H', socket.htons(render.get_length()))
@@ -192,7 +145,6 @@ class XfroutSession(BaseRequestHandler):
msg.set_rcode(Rcode.FORMERR())
self._send_message(sock_fd, msg)
-
def _zone_has_soa(self, zone):
'''Judge if the zone has an SOA record.'''
# In some sense, the SOA defines a zone.
@@ -200,7 +152,7 @@ class XfroutSession(BaseRequestHandler):
# specific zone, we need to judge if the zone has an SOA record;
# if not, we consider the zone has incomplete data, so xfrout can't
# serve for it.
- if sqlite3_ds.get_zone_soa(zone, self.server.get_db_file()):
+ if sqlite3_ds.get_zone_soa(zone, self._server.get_db_file()):
return True
return False
@@ -212,7 +164,7 @@ class XfroutSession(BaseRequestHandler):
# authority for the specific zone.
# TODO: should get zone's configuration from cfgmgr or other place
# in future.
- return sqlite3_ds.zone_exist(zonename, self.server.get_db_file())
+ return sqlite3_ds.zone_exist(zonename, self._server.get_db_file())
def _check_xfrout_available(self, zone_name):
'''Check if xfr request can be responsed.
@@ -231,7 +183,7 @@ class XfroutSession(BaseRequestHandler):
return Rcode.SERVFAIL()
#TODO, check allow_transfer
- if not self.server.increase_transfers_counter():
+ if not self._server.increase_transfers_counter():
return Rcode.REFUSED()
return Rcode.NOERROR()
@@ -257,7 +209,7 @@ class XfroutSession(BaseRequestHandler):
except Exception as err:
self._log.log_message("error", str(err))
- self.server.decrease_transfers_counter()
+ self._server.decrease_transfers_counter()
return
@@ -304,14 +256,14 @@ class XfroutSession(BaseRequestHandler):
#TODO, there should be a better way to insert rrset.
msg.make_response()
msg.set_header_flag(Message.HEADERFLAG_AA)
- soa_record = sqlite3_ds.get_zone_soa(zone_name, self.server.get_db_file())
+ soa_record = sqlite3_ds.get_zone_soa(zone_name, self._server.get_db_file())
rrset_soa = self._create_rrset_from_db_record(soa_record)
msg.add_rrset(Message.SECTION_ANSWER, rrset_soa)
message_upper_len = get_rrset_len(rrset_soa)
- for rr_data in sqlite3_ds.get_zone_datas(zone_name, self.server.get_db_file()):
- if self.server._shutdown_event.is_set(): # Check if xfrout is shutdown
+ for rr_data in sqlite3_ds.get_zone_datas(zone_name, self._server.get_db_file()):
+ if self._server._shutdown_event.is_set(): # Check if xfrout is shutdown
self._log.log_message("info", "xfrout process is being shutdown")
return
@@ -353,9 +305,93 @@ class UnixSockServer(socketserver_mixin.NoPollMixIn, ThreadingUnixStreamServer):
self.update_config_data(config_data)
self._cc = cc
- def finish_request(self, request, client_address):
+ def _receive_query_message(self, sock):
+ ''' receive request message from sock'''
+ # receive data length
+ data_len = sock.recv(2)
+ if not data_len:
+ return None
+ msg_len = struct.unpack('!H', data_len)[0]
+ # receive data
+ recv_size = 0
+ msgdata = b''
+ while recv_size < msg_len:
+ data = sock.recv(msg_len - recv_size)
+ if not data:
+ return None
+ recv_size += len(data)
+ msgdata += data
+
+ return msgdata
+
+ def handle_request(self):
+ ''' Enable server handle a request until shutdown or auth is closed.'''
+ try:
+ request, client_address = self.get_request()
+ except socket.error:
+ self._log.log_message("error", "Failed to fetch request")
+ return
+
+ # Check self._shutdown_event to ensure the real shutdown comes.
+ # Linux could trigger a spurious readable event on the _read_sock
+ # due to a bug, so we need perform a double check.
+ while not self._shutdown_event.is_set(): # Check if xfrout is shutdown
+ try:
+ (rlist, wlist, xlist) = select.select([self._read_sock, request], [], [])
+ except select.error as e:
+ if e.args[0] == errno.EINTR:
+ (rlist, wlist, xlist) = ([], [], [])
+ continue
+ else:
+ self._log.log_message("error", "Error with select(): %s" %e)
+ break
+
+ # self.server._shutdown_event will be set by now, if it is not a false
+ # alarm
+ if self._read_sock in rlist:
+ continue
+
+ try:
+ self.process_request(request)
+ except:
+ self._log.log_message("error", "Exception happened during processing of %s"
+ % str(client_address))
+ break
+
+ def _handle_request_noblock(self):
+ """Override the function _handle_request_noblock(), it creates a new
+ thread to handle requests for each auth"""
+ td = threading.Thread(target=self.handle_request)
+ td.setDaemon(True)
+ td.start()
+
+ def process_request(self, request):
+ """Receive socket fd and query message from auth, then
+ start a new thread to process the request."""
+ sock_fd = recv_fd(request.fileno())
+ if sock_fd < 0:
+ # This may happen when one xfrout process try to connect to
+ # xfrout unix socket server, to check whether there is another
+ # xfrout running.
+ if sock_fd == XFR_FD_RECEIVE_FAIL:
+ self._log.log_message("error", "Failed to receive the file descriptor for XFR connection")
+ return
+
+ # receive request msg
+ request_data = self._receive_query_message(request)
+ if not request_data:
+ return
+
+ t = threading.Thread(target = self.finish_request,
+ args = (sock_fd, request_data))
+ if self.daemon_threads:
+ t.daemon = True
+ t.start()
+
+
+ def finish_request(self, sock_fd, request_data):
'''Finish one request by instantiating RequestHandlerClass.'''
- self.RequestHandlerClass(request, client_address, self, self._log, self._read_sock)
+ self.RequestHandlerClass(sock_fd, request_data, self, self._log)
def _remove_unused_sock_file(self, sock_file):
'''Try to remove the socket file. If the file is being used
@@ -373,7 +409,7 @@ class UnixSockServer(socketserver_mixin.NoPollMixIn, ThreadingUnixStreamServer):
try:
os.unlink(sock_file)
except OSError as err:
- self._log.log_message("error", '[b10-xfrout] Fail to remove file %s: %s\n' % (sock_file, err))
+ self._log.log_message("error", "[b10-xfrout] Fail to remove file %s: %s\n" % (sock_file, err))
sys.exit(0)
def _sock_file_in_use(self, sock_file):
@@ -394,7 +430,7 @@ class UnixSockServer(socketserver_mixin.NoPollMixIn, ThreadingUnixStreamServer):
try:
os.unlink(self._sock_file)
except Exception as e:
- self._log.log_message("error", str(e))
+ self._log.log_message('error', str(e))
def update_config_data(self, new_config):
'''Apply the new config setting of xfrout module. '''
diff --git a/src/bin/zonemgr/Makefile.am b/src/bin/zonemgr/Makefile.am
index dd3e67a..410279a 100644
--- a/src/bin/zonemgr/Makefile.am
+++ b/src/bin/zonemgr/Makefile.am
@@ -4,7 +4,7 @@ pkglibexecdir = $(libexecdir)/@PACKAGE@
pkglibexec_SCRIPTS = b10-zonemgr
-b10_zonemgrdir = $(DESTDIR)$(pkgdatadir)
+b10_zonemgrdir = $(pkgdatadir)
b10_zonemgr_DATA = zonemgr.spec
CLEANFILES = b10-zonemgr zonemgr.pyc zonemgr.spec
diff --git a/src/cppcheck-suppress.lst b/src/cppcheck-suppress.lst
new file mode 100644
index 0000000..3e4dcd6
--- /dev/null
+++ b/src/cppcheck-suppress.lst
@@ -0,0 +1,15 @@
+// On some systems cppcheck produces false alarms about 'missing includes'.
+// the following two will suppress, depending on the cppcheck version
+debug
+missingInclude
+// This is a template, and should be excluded from the check
+unreadVariable:src/lib/dns/rdata/template.cc:59
+// These three trigger warnings due to the incomplete implementation. This is
+// our problem, but we need to suppress the warnings for now.
+functionConst:src/lib/cache/resolver_cache.h
+functionConst:src/lib/cache/message_cache.h
+functionConst:src/lib/cache/rrset_cache.h
+// Intentional self assignment tests. Suppress warning about them.
+selfAssignment:src/lib/dns/tests/name_unittest.cc:292
+selfAssignment:src/lib/dns/tests/rdata_unittest.cc:227
+selfAssignment:src/lib/dns/tests/tsigkey_unittest.cc:104
diff --git a/src/lib/Makefile.am b/src/lib/Makefile.am
index 8ab93ba..27d9b8b 100644
--- a/src/lib/Makefile.am
+++ b/src/lib/Makefile.am
@@ -1,2 +1,2 @@
SUBDIRS = exceptions dns cc config datasrc python xfr bench log \
- resolve asiolink testutils nsas cache
+ resolve nsas cache asiolink testutils server_common
diff --git a/src/lib/asiolink/Makefile.am b/src/lib/asiolink/Makefile.am
index 868fde5..b3968f0 100644
--- a/src/lib/asiolink/Makefile.am
+++ b/src/lib/asiolink/Makefile.am
@@ -12,24 +12,29 @@ CLEANFILES = *.gcno *.gcda
# have some code fragments that would hit gcc's unused-parameter warning,
# which would make the build fail with -Werror (our default setting).
lib_LTLIBRARIES = libasiolink.la
-libasiolink_la_SOURCES = asiolink.h
-libasiolink_la_SOURCES += io_service.cc io_service.h
-libasiolink_la_SOURCES += dns_service.cc dns_service.h
-libasiolink_la_SOURCES += dns_server.h
-libasiolink_la_SOURCES += dns_lookup.h
+libasiolink_la_SOURCES = asiolink.h
libasiolink_la_SOURCES += dns_answer.h
-libasiolink_la_SOURCES += simple_callback.h
+libasiolink_la_SOURCES += dns_lookup.h
+libasiolink_la_SOURCES += dns_server.h
+libasiolink_la_SOURCES += dns_service.h dns_service.cc
+libasiolink_la_SOURCES += dummy_io_cb.h
libasiolink_la_SOURCES += interval_timer.h interval_timer.cc
-libasiolink_la_SOURCES += recursive_query.h recursive_query.cc
-libasiolink_la_SOURCES += io_socket.cc io_socket.h
+libasiolink_la_SOURCES += io_address.h io_address.cc
+libasiolink_la_SOURCES += io_asio_socket.h
+libasiolink_la_SOURCES += io_endpoint.h io_endpoint.cc
+libasiolink_la_SOURCES += io_error.h
+libasiolink_la_SOURCES += io_fetch.h io_fetch.cc
libasiolink_la_SOURCES += io_message.h
-libasiolink_la_SOURCES += io_address.cc io_address.h
-libasiolink_la_SOURCES += io_endpoint.cc io_endpoint.h
-libasiolink_la_SOURCES += udp_endpoint.h udp_socket.h
-libasiolink_la_SOURCES += udp_server.h udp_server.cc
-libasiolink_la_SOURCES += udp_query.h udp_query.cc
-libasiolink_la_SOURCES += tcp_endpoint.h tcp_socket.h
+libasiolink_la_SOURCES += io_service.h io_service.cc
+libasiolink_la_SOURCES += io_socket.h io_socket.cc
+libasiolink_la_SOURCES += recursive_query.h recursive_query.cc
+libasiolink_la_SOURCES += simple_callback.h
+libasiolink_la_SOURCES += tcp_endpoint.h
libasiolink_la_SOURCES += tcp_server.h tcp_server.cc
+libasiolink_la_SOURCES += tcp_socket.h
+libasiolink_la_SOURCES += udp_endpoint.h
+libasiolink_la_SOURCES += udp_server.h udp_server.cc
+libasiolink_la_SOURCES += udp_socket.h
# Note: the ordering matters: -Wno-... must follow -Wextra (defined in
# B10_CXXFLAGS)
libasiolink_la_CXXFLAGS = $(AM_CXXFLAGS)
@@ -43,3 +48,5 @@ endif
libasiolink_la_CPPFLAGS = $(AM_CPPFLAGS)
libasiolink_la_LIBADD = $(top_builddir)/src/lib/log/liblog.la
libasiolink_la_LIBADD += $(top_builddir)/src/lib/resolve/libresolve.la
+libasiolink_la_LIBADD += $(top_builddir)/src/lib/cache/libcache.la
+libasiolink_la_LIBADD += $(top_builddir)/src/lib/nsas/libnsas.la
diff --git a/src/lib/asiolink/README b/src/lib/asiolink/README
index b0f6a7d..6bd1a73 100644
--- a/src/lib/asiolink/README
+++ b/src/lib/asiolink/README
@@ -33,7 +33,7 @@ This is intended to simplify development a bit, since it allows the
routines to be written in a straightfowrard step-step-step fashion rather
than as a complex chain of separate handler functions.
-Coroutine objects (i.e., UDPServer, TCPServer and UDPQuery) are objects
+Coroutine objects (i.e., UDPServer, TCPServer and IOFetch) are objects
with reenterable operator() members. When an instance of one of these
classes is called as a function, it resumes at the position where it left
off. Thus, a UDPServer can issue an asynchronous I/O call and specify
@@ -101,3 +101,82 @@ when the answer has arrived. In simplified form, the DNSQuery routine is:
Currently, DNSQuery is only implemented for UDP queries. In future work
it will be necessary to write code to fall back to TCP when circumstances
require it.
+
+
+Upstream Fetches
+================
+Upstream fetches (queries by the resolver on behalf of a client) are made
+using a slightly-modified version of the pattern described above.
+
+Sockets
+-------
+First, it will be useful to understand the class hierarchy used in the
+fetch logic:
+
+ IOSocket
+ |
+ IOAsioSocket
+ |
+ +-----+-----+
+ | |
+UDPSocket TCPSocket
+
+IOSocket is a wrapper class for a socket and is used by the authoritative
+server code. It is an abstract base class, providing little more that the ability to hold the socket and to return the protocol in use.
+
+Built on this is IOAsioSocket, which adds the open, close, asyncSend and
+asyncReceive methods. This is a template class, which takes as template
+argument the class of the object that will be used as the callback when the
+asynchronous operation completes. This object can be of any type, but must
+include an operator() method with the signature:
+
+ operator()(asio::error_code ec, size_t length)
+
+... the two arguments being the status of the completed I/O operation and
+the number of bytes transferred. (In the case of the open method, the second
+argument will be zero.)
+
+Finally, the TCPSocket and UDPSocket classes provide the body of the
+asynchronous operations.
+
+Fetch Sequence
+--------------
+The fetch is implemented by the IOFetch class, which takes as argument the
+protocol to use. The sequence is:
+
+ REENTER:
+ render the question into a wire-format query packet
+ open() // Open socket and optionally connect
+ if (! synchronous) {
+ YIELD;
+ }
+ YIELD asyncSend(query) // Send query
+ do {
+ YIELD asyncReceive(response) // Read response
+ } while (! complete(response))
+ close() // Drop connection and close socket
+ server->resume
+
+The open() method opens a socket for use. On TCP, it also makes a
+connection to the remote end. So under UDP the operation will complete
+immediately, but under TCP it could take a long time. One solution would be
+for the open operation to post an event to the I/O queue; then both cases
+could be regarded as being equivalent, with the completion being signalled
+by the posting of the completion event. However UDP is the most common case
+and that would involve extra overhead. So the open() returns a status
+indicating whether the operation completed asynchronously. If it did, the
+code yields back to the coroutine; if not the yield is bypassed.
+
+The asynchronous send is straightforward, invoking the underlying ASIO
+function. (Note that the address/port is supplied to both the open() and
+asyncSend() methods - it is used by the TCPSocket in open() and by the
+UDPSocket in asyncSend().)
+
+The asyncReceive() method issues an asynchronous read and waits for completion.
+The fetch object keeps track of the amount of data received so far and when
+the receive completes it calls a method on the socket to determine if the
+entire message has been received. (This will always be the case for UDP. On
+TCP though, the message is preceded by a count field as several reads may be
+required to read all the data.) The fetch loops until all the data is read.
+
+Finally, the socket is closed and the server called to resume operation.
diff --git a/src/lib/asiolink/asiolink.h b/src/lib/asiolink/asiolink.h
index 43a1244..03951ae 100644
--- a/src/lib/asiolink/asiolink.h
+++ b/src/lib/asiolink/asiolink.h
@@ -32,6 +32,7 @@
#include <asiolink/io_endpoint.h>
#include <asiolink/io_message.h>
#include <asiolink/io_socket.h>
+#include <asiolink/io_error.h>
/// \namespace asiolink
/// \brief A wrapper interface for the ASIO library.
@@ -83,20 +84,6 @@
/// the placeholder of callback handlers:
/// http://think-async.com/Asio/asio-1.3.1/doc/asio/reference/asio_handler_allocate.html
-namespace asiolink {
-
-
-/// \brief An exception that is thrown if an error occurs within the IO
-/// module. This is mainly intended to be a wrapper exception class for
-/// ASIO specific exceptions.
-class IOError : public isc::Exception {
-public:
- IOError(const char* file, size_t line, const char* what) :
- isc::Exception(file, line, what) {}
-};
-
-
-} // asiolink
#endif // __ASIOLINK_H
// Local Variables:
diff --git a/src/lib/asiolink/dns_server.h b/src/lib/asiolink/dns_server.h
index 6545275..352ea8e 100644
--- a/src/lib/asiolink/dns_server.h
+++ b/src/lib/asiolink/dns_server.h
@@ -75,6 +75,9 @@ public:
(*self_)(ec, length);
}
+ /// \brief Stop current running server
+ virtual void stop() { self_->stop();}
+
/// \brief Resume processing of the server coroutine after an
/// asynchronous call (e.g., to the DNS Lookup provider) has completed.
///
diff --git a/src/lib/asiolink/dns_service.cc b/src/lib/asiolink/dns_service.cc
index 98ca032..f17bb44 100644
--- a/src/lib/asiolink/dns_service.cc
+++ b/src/lib/asiolink/dns_service.cc
@@ -12,13 +12,19 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
+#include <netinet/in.h>
+#include <sys/socket.h>
+#include <unistd.h> // for some IPC/network system calls
+
+#include <boost/lexical_cast.hpp>
+
#include <config.h>
-// unistd is needed for asio.hpp with SunStudio
-#include <unistd.h>
+#include <log/dummylog.h>
#include <asio.hpp>
-
+#include <asiolink/dns_service.h>
+#include <asiolink/io_service.h>
#include <asiolink/io_service.h>
#include <asiolink/tcp_server.h>
#include <asiolink/udp_server.h>
@@ -26,6 +32,7 @@
#include <log/dummylog.h>
#include <boost/lexical_cast.hpp>
+#include <boost/foreach.hpp>
using isc::log::dlog;
@@ -182,8 +189,9 @@ DNSService::addServer(uint16_t port, const std::string& address) {
void
DNSService::clearServers() {
- // FIXME: This does not work, it does not close the socket.
- // How is it done?
+ BOOST_FOREACH(const DNSServiceImpl::DNSServerPtr& s, impl_->servers_) {
+ s->stop();
+ }
impl_->servers_.clear();
}
diff --git a/src/lib/asiolink/dns_service.h b/src/lib/asiolink/dns_service.h
index 6b14345..84aa5fb 100644
--- a/src/lib/asiolink/dns_service.h
+++ b/src/lib/asiolink/dns_service.h
@@ -97,6 +97,12 @@ public:
/// It will eventually be removed once the wrapper interface is
/// generalized.
asio::io_service& get_io_service() { return io_service_.get_io_service(); }
+
+ /// \brief Return the IO Service Object
+ ///
+ /// \return IOService object for this DNS service.
+ asiolink::IOService& getIOService() { return (io_service_);}
+
private:
DNSServiceImpl* impl_;
IOService& io_service_;
diff --git a/src/lib/asiolink/dummy_io_cb.h b/src/lib/asiolink/dummy_io_cb.h
new file mode 100644
index 0000000..bde656c
--- /dev/null
+++ b/src/lib/asiolink/dummy_io_cb.h
@@ -0,0 +1,51 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#ifndef __DUMMY_IO_CB_H
+#define __DUMMY_IO_CB_H
+
+#include <iostream>
+
+#include <asio/error.hpp>
+#include <asio/error_code.hpp>
+
+namespace asiolink {
+
+/// \brief Asynchronous I/O Completion Callback
+///
+/// The two socket classes (UDPSocket and TCPSocket) require that the I/O
+/// completion callback function have an operator() method with the appropriate
+/// signature. The classes are templates, any class with that method and
+/// signature can be passed as the callback object - there is no need for a
+/// base class defining the interface. However, some users of the socket
+/// classes do not use the asynchronous I/O operations, yet have to supply a
+/// template parameter. This is the reason for this class - it is the dummy
+/// template parameter.
+
+class DummyIOCallback {
+public:
+
+ /// \brief Asynchronous I/O callback method
+ ///
+ /// \param error Unused
+ /// \param length Unused
+ void operator()(asio::error_code, size_t)
+ {
+ // TODO: log an error if this method ever gets called.
+ }
+};
+
+} // namespace asiolink
+
+#endif // __DUMMY_IO_CB_H
diff --git a/src/lib/asiolink/internal/iofetch.h b/src/lib/asiolink/internal/iofetch.h
new file mode 100644
index 0000000..d066c92
--- /dev/null
+++ b/src/lib/asiolink/internal/iofetch.h
@@ -0,0 +1,125 @@
+// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#ifndef __IOFETCH_H
+#define __IOFETCH_H 1
+
+#include <config.h>
+
+#include <asio.hpp>
+#include <boost/shared_array.hpp>
+#include <boost/shared_ptr.hpp>
+
+#include <dns/buffer.h>
+#include <dns/message.h>
+#include <dns/messagerenderer.h>
+
+#include <asiolink/asiolink.h>
+#include <asiolink/internal/coroutine.h>
+
+// This file contains TCP/UDP-specific implementations of generic classes
+// defined in asiolink.h. It is *not* intended to be part of the public
+// API.
+
+namespace asiolink {
+//
+// Asynchronous UDP/TCP coroutine for upstream fetches
+//
+//class IOFetch : public coroutine, public UdpFetch, public TcpFetch {
+class IOFetch : public coroutine {
+public:
+ // TODO Maybe this should be more generic than just for IOFetch?
+ ///
+ /// \brief Result of the query
+ ///
+ /// This is related only to contacting the remote server. If the answer
+ ///indicates error, it is still counted as SUCCESS here, if it comes back.
+ ///
+ enum Result {
+ SUCCESS,
+ TIME_OUT,
+ STOPPED
+ };
+ /// Abstract callback for the IOFetch.
+ class Callback {
+ public:
+ virtual ~Callback() {}
+
+ /// This will be called when the IOFetch is completed
+ virtual void operator()(Result result) = 0;
+ };
+ ///
+ /// \brief Constructor.
+ ///
+ /// It creates the query.
+ /// @param callback will be called when we terminate. It is your task to
+ /// delete it if allocated on heap.
+ ///@param timeout in ms.
+ ///
+ IOFetch(asio::io_service& io_service,
+ const isc::dns::Question& q,
+ const IOAddress& addr, uint16_t port,
+ isc::dns::OutputBufferPtr buffer,
+ Callback* callback, int timeout = -1,
+ int protocol = IPPROTO_UDP);
+ void operator()(asio::error_code ec = asio::error_code(),
+ size_t length = 0);
+ /// Terminate the query.
+ void stop(Result reason = STOPPED);
+private:
+ enum { MAX_LENGTH = 4096 };
+
+ ///
+ /// \short Private data
+ ///
+ /// They are not private because of stability of the
+ /// interface (this is private class anyway), but because this class
+ /// will be copyed often (it is used as a coroutine and passed as callback
+ /// to many async_*() functions) and we want keep the same data. Some of
+ /// the data is not copyable too.
+ ///
+ //struct IOFetchProtocol;
+ //boost::shared_ptr<IOFetchProtocol> data_;
+ //struct UdpData;
+ //struct TcpData;
+ boost::shared_ptr<UdpFetch> data_;
+ boost::shared_ptr<TcpFetch> tcp_data_;
+};
+class UdpFetch : public IOFetch {
+ public:
+ struct UdpData;
+ explicit UdpFetch(asio::io_service& io_service,
+ const isc::dns::Question& q,
+ const IOAddress& addr,
+ uint16_t port,
+ isc::dns::OutputBufferPtr buffer,
+ IOFetch::Callback *callback,
+ int timeout);
+};
+class TcpFetch : public IOFetch {
+ public:
+ struct TcpData;
+ explicit TcpFetch(io_service& io_service, const Question& q,
+ const IOAddress& addr, uint16_t port,
+ OutputBufferPtr buffer, Callback *callback, int timeout);
+};
+
+}
+
+
+#endif // __IOFETCH_H
+
+// Local Variables:
+// mode: c++
+// End:
diff --git a/src/lib/asiolink/interval_timer.cc b/src/lib/asiolink/interval_timer.cc
index 6b0cd09..8efb102 100644
--- a/src/lib/asiolink/interval_timer.cc
+++ b/src/lib/asiolink/interval_timer.cc
@@ -14,18 +14,18 @@
#include <config.h>
-// unistd is needed for asio.hpp with SunStudio
-#include <unistd.h>
+#include <unistd.h> // for some IPC/network system calls
+#include <sys/socket.h>
+#include <netinet/in.h>
-#include <asio.hpp>
+#include <boost/bind.hpp>
#include <exceptions/exceptions.h>
+#include <asio.hpp>
#include <asiolink/interval_timer.h>
#include <asiolink/io_service.h>
-#include <boost/bind.hpp>
-
namespace asiolink {
class IntervalTimerImpl {
diff --git a/src/lib/asiolink/io_address.cc b/src/lib/asiolink/io_address.cc
index 990524a..70e8374 100644
--- a/src/lib/asiolink/io_address.cc
+++ b/src/lib/asiolink/io_address.cc
@@ -20,7 +20,10 @@
#include <asio.hpp>
-#include <asiolink/asiolink.h>
+#include <exceptions/exceptions.h>
+#include <asiolink/io_address.h>
+#include <asiolink/io_error.h>
+
using namespace asio;
using asio::ip::udp;
diff --git a/src/lib/asiolink/io_address.h b/src/lib/asiolink/io_address.h
index 98e6fe8..0d2787f 100644
--- a/src/lib/asiolink/io_address.h
+++ b/src/lib/asiolink/io_address.h
@@ -12,8 +12,8 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-#ifndef __IOADDRESS_H
-#define __IOADDRESS_H 1
+#ifndef __IO_ADDRESS_H
+#define __IO_ADDRESS_H 1
// IMPORTANT NOTE: only very few ASIO headers files can be included in
// this file. In particular, asio.hpp should never be included here.
@@ -120,7 +120,7 @@ private:
};
} // asiolink
-#endif // __IOADDRESS_H
+#endif // __IO_ADDRESS_H
// Local Variables:
// mode: c++
diff --git a/src/lib/asiolink/io_asio_socket.h b/src/lib/asiolink/io_asio_socket.h
new file mode 100644
index 0000000..eae9b32
--- /dev/null
+++ b/src/lib/asiolink/io_asio_socket.h
@@ -0,0 +1,309 @@
+// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#ifndef __IO_ASIO_SOCKET_H
+#define __IO_ASIO_SOCKET_H 1
+
+// IMPORTANT NOTE: only very few ASIO headers files can be included in
+// this file. In particular, asio.hpp should never be included here.
+// See the description of the namespace below.
+#include <unistd.h> // for some network system calls
+
+#include <functional>
+#include <string>
+
+#include <exceptions/exceptions.h>
+#include <coroutine.h>
+
+#include <asiolink/io_error.h>
+#include <asiolink/io_socket.h>
+
+
+namespace asiolink {
+
+/// \brief Socket not open
+///
+/// Thrown on an attempt to do read/write to a socket that is not open.
+class SocketNotOpen : public IOError {
+public:
+ SocketNotOpen(const char* file, size_t line, const char* what) :
+ IOError(file, line, what) {}
+};
+
+
+
+/// Forward declaration of an IOEndpoint
+class IOEndpoint;
+
+
+/// \brief I/O Socket with asynchronous operations
+///
+/// This class is a wrapper for the ASIO socket classes such as
+/// \c ip::tcp::socket and \c ip::udp::socket.
+///
+/// This is the basic IOSocket with additional operations - open, send, receive
+/// and close. Depending on how the asiolink code develops, it may be a
+/// temporary class: its main use is to add the template parameter needed for
+/// the derived classes UDPSocket and TCPSocket but without changing the
+/// signature of the more basic IOSocket class.
+///
+/// We may revisit this decision when we generalize the wrapper and more
+/// modules use it. Also, at that point we may define a separate (visible)
+/// derived class for testing purposes rather than providing factory methods
+/// (i.e., getDummy variants below).
+///
+/// TODO: Check if IOAsioSocket class is still needed
+///
+/// \param C Template parameter identifying type of the callback object.
+
+template <typename C>
+class IOAsioSocket : public IOSocket {
+ ///
+ /// \name Constructors and Destructor
+ ///
+ /// Note: The copy constructor and the assignment operator are
+ /// intentionally defined as private, making this class non-copyable.
+ //@{
+private:
+ IOAsioSocket(const IOAsioSocket<C>& source);
+ IOAsioSocket& operator=(const IOAsioSocket<C>& source);
+protected:
+ /// \brief The default constructor.
+ ///
+ /// This is intentionally defined as \c protected as this base class
+ /// should never be instantiated (except as part of a derived class).
+ IOAsioSocket() {}
+public:
+ /// The destructor.
+ virtual ~IOAsioSocket() {}
+ //@}
+
+ /// \brief Return the "native" representation of the socket.
+ ///
+ /// In practice, this is the file descriptor of the socket for
+ /// UNIX-like systems so the current implementation simply uses
+ /// \c int as the type of the return value.
+ /// We may have to need revisit this decision later.
+ ///
+ /// In general, the application should avoid using this method;
+ /// it essentially discloses an implementation specific "handle" that
+ /// can change the internal state of the socket (consider the
+ /// application closes it, for example).
+ /// But we sometimes need to perform very low-level operations that
+ /// requires the native representation. Passing the file descriptor
+ /// to a different process is one example.
+ /// This method is provided as a necessary evil for such limited purposes.
+ ///
+ /// This method never throws an exception.
+ ///
+ /// \return The native representation of the socket. This is the socket
+ /// file descriptor for UNIX-like systems.
+ virtual int getNative() const = 0;
+
+ /// \brief Return the transport protocol of the socket.
+ ///
+ /// Currently, it returns \c IPPROTO_UDP for UDP sockets, and
+ /// \c IPPROTO_TCP for TCP sockets.
+ ///
+ /// This method never throws an exception.
+ ///
+ /// \return IPPROTO_UDP for UDP sockets
+ /// \return IPPROTO_TCP for TCP sockets
+ virtual int getProtocol() const = 0;
+
+ /// \brief Open AsioSocket
+ ///
+ /// Opens the socket for asynchronous I/O. On a UDP socket, this is merely
+ /// an "open()" on the underlying socket (so completes immediately), but on
+ /// a TCP socket it also connects to the remote end (which is done as an
+ /// asynchronous operation).
+ ///
+ /// For TCP, signalling of the completion of the operation is done by
+ /// by calling the callback function in the normal way. This could be done
+ /// for UDP (by posting en event on the event queue); however, that will
+ /// incur additional overhead in the most common case. Instead, the return
+ /// value indicates whether the operation was asynchronous or not. If yes,
+ /// (i.e. TCP) the callback has been posted to the event queue: if no (UDP),
+ /// no callback has been posted (in which case it is up to the caller as to
+ /// whether they want to manually post the callback themself.)
+ ///
+ /// \param endpoint Pointer to the endpoint object. This is ignored for
+ /// a UDP socket (the target is specified in the send call), but should
+ /// be of type TCPEndpoint for a TCP connection.
+ /// \param callback I/O Completion callback, called when the operation has
+ /// completed, but only if the operation was asynchronous.
+ ///
+ /// \return true if an asynchronous operation was started and the caller
+ /// should yield and wait for completion, false if the operation was
+ /// completed synchronously and no callback was queued.
+ virtual bool open(const IOEndpoint* endpoint, C& callback) = 0;
+
+ /// \brief Send Asynchronously
+ ///
+ /// This corresponds to async_send_to() for UDP sockets and async_send()
+ /// for TCP. In both cases an endpoint argument is supplied indicating the
+ /// target of the send - this is ignored for TCP.
+ ///
+ /// \param data Data to send
+ /// \param length Length of data to send
+ /// \param endpoint Target of the send
+ /// \param callback Callback object.
+ virtual void asyncSend(const void* data, size_t length,
+ const IOEndpoint* endpoint, C& callback) = 0;
+
+ /// \brief Receive Asynchronously
+ ///
+ /// This correstponds to async_receive_from() for UDP sockets and
+ /// async_receive() for TCP. In both cases, an endpoint argument is
+ /// supplied to receive the source of the communication. For TCP it will
+ /// be filled in with details of the connection.
+ ///
+ /// \param data Buffer to receive incoming message
+ /// \param length Length of the data buffer
+ /// \param cumulative Amount of data that should already be in the buffer.
+ /// \param endpoint Source of the communication
+ /// \param callback Callback object
+ virtual void asyncReceive(void* data, size_t length, size_t cumulative,
+ IOEndpoint* endpoint, C& callback) = 0;
+
+ /// \brief Checks if the data received is complete.
+ ///
+ /// This applies to TCP receives, where the data is a byte stream and a
+ /// receive is not guaranteed to receive the entire message. DNS messages
+ /// over TCP are prefixed by a two-byte count field. This method takes the
+ /// amount received so far and the amount received in this I/O and checks
+ /// if the message is complete, returning the appropriate indication. As
+ /// a side-effect, it also updates the amount received.
+ ///
+ /// For a UDP receive, all the data is received in one I/O, so this is
+ /// effectively a no-op (although it does update the amount received).
+ ///
+ /// \param data Data buffer containing data to date
+ /// \param length Amount of data received in last asynchronous I/O
+ /// \param cumulative On input, amount of data received before the last
+ /// I/O. On output, the total amount of data received to date.
+ ///
+ /// \return true if the receive is complete, false if another receive is
+ /// needed.
+ virtual bool receiveComplete(void* data, size_t length,
+ size_t& cumulative) = 0;
+
+ /// \brief Cancel I/O On AsioSocket
+ virtual void cancel() = 0;
+
+ /// \brief Close socket
+ virtual void close() = 0;
+};
+
+
+#include "io_socket.h"
+
+/// \brief The \c DummyAsioSocket class is a concrete derived class of
+/// \c IOAsioSocket that is not associated with any real socket.
+///
+/// This main purpose of this class is tests, where it may be desirable to
+/// instantiate an \c IOAsioSocket object without involving system resource
+/// allocation such as real network sockets.
+///
+/// \param C Template parameter identifying type of the callback object.
+
+template <typename C>
+class DummyAsioSocket : public IOAsioSocket<C> {
+private:
+ DummyAsioSocket(const DummyAsioSocket<C>& source);
+ DummyAsioSocket& operator=(const DummyAsioSocket<C>& source);
+public:
+ /// \brief Constructor from the protocol number.
+ ///
+ /// The protocol must validly identify a standard network protocol.
+ /// For example, to specify TCP \c protocol must be \c IPPROTO_TCP.
+ ///
+ /// \param protocol The network protocol number for the socket.
+ DummyAsioSocket(const int protocol) : protocol_(protocol) {}
+
+ /// \brief A dummy derived method of \c IOAsioSocket::getNative().
+ ///
+ /// \return Always returns -1 as the object is not associated with a real
+ /// (native) socket.
+ virtual int getNative() const { return (-1); }
+
+ /// \brief A dummy derived method of \c IOAsioSocket::getProtocol().
+ ///
+ /// \return Protocol socket was created with
+ virtual int getProtocol() const { return (protocol_); }
+
+
+ /// \brief Open AsioSocket
+ ///
+ /// A call that is a no-op on UDP sockets, this opens a connection to the
+ /// system identified by the given endpoint.
+ ///
+ /// \param endpoint Unused
+ /// \param callback Unused.
+ ///false indicating that the operation completed synchronously.
+ virtual bool open(const IOEndpoint*, C&) {
+ return (false);
+ }
+
+ /// \brief Send Asynchronously
+ ///
+ /// Must be supplied as it is abstract in the base class.
+ ///
+ /// \param data Unused
+ /// \param length Unused
+ /// \param endpoint Unused
+ /// \param callback Unused
+ virtual void asyncSend(const void*, size_t, const IOEndpoint*, C&) {
+ }
+
+ /// \brief Receive Asynchronously
+ ///
+ /// Must be supplied as it is abstract in the base class.
+ ///
+ /// \param data Unused
+ /// \param length Unused
+ /// \param cumulative Unused
+ /// \param endpoint Unused
+ /// \param callback Unused
+ virtual void asyncReceive(void* data, size_t, size_t, IOEndpoint*, C&) { }
+ /// \brief Checks if the data received is complete.
+ ///
+ /// \param data Unused
+ /// \param length Unused
+ /// \param cumulative Unused
+ ///
+ /// \return Always true
+ virtual bool receiveComplete(void*, size_t, size_t&) {
+ return (true);
+ }
+
+ /// \brief Cancel I/O On AsioSocket
+ ///
+ /// Must be supplied as it is abstract in the base class.
+ virtual void cancel() {
+ }
+
+ /// \brief Close socket
+ ///
+ /// Must be supplied as it is abstract in the base class.
+ virtual void close() {
+ }
+
+private:
+ const int protocol_;
+};
+
+} // namespace asiolink
+
+#endif // __IO_ASIO_SOCKET_H
diff --git a/src/lib/asiolink/io_endpoint.cc b/src/lib/asiolink/io_endpoint.cc
index 86e0607..bf79f61 100644
--- a/src/lib/asiolink/io_endpoint.cc
+++ b/src/lib/asiolink/io_endpoint.cc
@@ -20,7 +20,8 @@
#include <asio.hpp>
-#include <asiolink/asiolink.h>
+#include <asiolink/io_address.h>
+#include <asiolink/io_error.h>
#include <asiolink/tcp_endpoint.h>
#include <asiolink/udp_endpoint.h>
diff --git a/src/lib/asiolink/io_endpoint.h b/src/lib/asiolink/io_endpoint.h
index 37f9087..62b9e47 100644
--- a/src/lib/asiolink/io_endpoint.h
+++ b/src/lib/asiolink/io_endpoint.h
@@ -12,8 +12,8 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-#ifndef __IOENDPOINT_H
-#define __IOENDPOINT_H 1
+#ifndef __IO_ENDPOINT_H
+#define __IO_ENDPOINT_H 1
// IMPORTANT NOTE: only very few ASIO headers files can be included in
// this file. In particular, asio.hpp should never be included here.
@@ -115,7 +115,7 @@ public:
};
} // asiolink
-#endif // __IOENDPOINT_H
+#endif // __IO_ENDPOINT_H
// Local Variables:
// mode: c++
diff --git a/src/lib/asiolink/io_error.h b/src/lib/asiolink/io_error.h
new file mode 100644
index 0000000..2869e0b
--- /dev/null
+++ b/src/lib/asiolink/io_error.h
@@ -0,0 +1,35 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+
+#ifndef __IO_ERROR_H
+#define __IO_ERROR_H
+
+#include <exceptions/exceptions.h>
+
+namespace asiolink {
+
+/// \brief An exception that is thrown if an error occurs within the IO
+/// module. This is mainly intended to be a wrapper exception class for
+/// ASIO specific exceptions.
+class IOError : public isc::Exception {
+public:
+ IOError(const char* file, size_t line, const char* what) :
+ isc::Exception(file, line, what) {}
+};
+
+
+} // asiolink
+
+#endif // __IO_ERROR_H
diff --git a/src/lib/asiolink/io_fetch.cc b/src/lib/asiolink/io_fetch.cc
new file mode 100644
index 0000000..d1f722c
--- /dev/null
+++ b/src/lib/asiolink/io_fetch.cc
@@ -0,0 +1,193 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#include <config.h>
+
+#include <unistd.h> // for some IPC/network system calls
+#include <sys/socket.h>
+#include <netinet/in.h>
+
+#include <boost/bind.hpp>
+
+#include <dns/message.h>
+#include <dns/messagerenderer.h>
+#include <dns/opcode.h>
+#include <dns/rcode.h>
+#include <log/dummylog.h>
+
+#include <asio.hpp>
+#include <asiolink/io_fetch.h>
+
+using namespace asio;
+using namespace isc::dns;
+using namespace isc::log;
+using namespace std;
+
+namespace asiolink {
+
+/// IOFetch Constructor - just initialize the private data
+
+IOFetch::IOFetch(int protocol, IOService& service,
+ const isc::dns::Question& question, const IOAddress& address, uint16_t port,
+ isc::dns::OutputBufferPtr& buff, Callback* cb, int wait)
+ :
+ data_(new IOFetch::IOFetchData(protocol, service, question, address,
+ port, buff, cb, wait))
+{
+}
+
+/// The function operator is implemented with the "stackless coroutine"
+/// pattern; see internal/coroutine.h for details.
+
+void
+IOFetch::operator()(error_code ec, size_t length) {
+ if (ec || data_->stopped) {
+ return;
+ }
+
+ CORO_REENTER (this) {
+
+ /// Generate the upstream query and render it to wire format
+ /// This is done in a different scope to allow inline variable
+ /// declarations.
+ {
+ Message msg(Message::RENDER);
+
+ // TODO: replace with boost::random or some other suitable PRNG
+ msg.setQid(0);
+ msg.setOpcode(Opcode::QUERY());
+ msg.setRcode(Rcode::NOERROR());
+ msg.setHeaderFlag(Message::HEADERFLAG_RD);
+ msg.addQuestion(data_->question);
+ MessageRenderer renderer(*data_->msgbuf);
+ msg.toWire(renderer);
+
+ // As this is a new fetch, clear the amount of data received
+ data_->cumulative = 0;
+
+ dlog("Sending " + msg.toText() + " to " +
+ data_->remote->getAddress().toText());
+ }
+
+
+ // If we timeout, we stop, which will shutdown everything and
+ // cancel all other attempts to run inside the coroutine
+ if (data_->timeout != -1) {
+ data_->timer.expires_from_now(boost::posix_time::milliseconds(
+ data_->timeout));
+ data_->timer.async_wait(boost::bind(&IOFetch::stop, *this,
+ TIME_OUT));
+ }
+
+ // Open a connection to the target system. For speed, if the operation
+ // was completed synchronously (i.e. UDP operation) we bypass the yield.
+ if (data_->socket->open(data_->remote.get(), *this)) {
+ CORO_YIELD;
+ }
+
+ // Begin an asynchronous send, and then yield. When the send completes
+ // send completes, we will resume immediately after this point.
+ CORO_YIELD data_->socket->asyncSend(data_->msgbuf->getData(),
+ data_->msgbuf->getLength(), data_->remote.get(), *this);
+
+ // Now receive the response. Since TCP may not receive the entire
+ // message in one operation, we need to loop until we have received
+ // it. (This can't be done within the asyncReceive() method because
+ // each I/O operation will be done asynchronously and between each one
+ // we need to yield ... and we *really* don't want to set up another
+ // coroutine within that method.) So after each receive (and yield),
+ // we check if the operation is complete and if not, loop to read again.
+ do {
+ CORO_YIELD data_->socket->asyncReceive(data_->data.get(),
+ static_cast<size_t>(MAX_LENGTH), data_->cumulative,
+ data_->remote.get(), *this);
+ } while (!data_->socket->receiveComplete(data_->data.get(), length,
+ data_->cumulative));
+
+ // The message is not rendered yet, so we can't print it easily
+ dlog("Received response from " + data_->remote->getAddress().toText());
+
+ /// Copy the answer into the response buffer. (TODO: If the
+ /// OutputBuffer object were made to meet the requirements of
+ /// a MutableBufferSequence, then it could be written to directly
+ /// by async_receive_from() and this additional copy step would
+ /// be unnecessary.)
+ data_->buffer->writeData(data_->data.get(), length);
+
+ // Finished with this socket, so close it.
+ data_->socket->close();
+
+ /// We are done
+ stop(SUCCESS);
+ }
+}
+
+// Function that stops the coroutine sequence. It is called either when the
+// query finishes or when the timer times out. Either way, it sets the
+// "stopped_" flag and cancels anything that is in progress.
+//
+// As the function may be entered multiple times as things wind down, the
+// stopped_ flag checks if stop() has already been called. If it has,
+// subsequent calls are no-ops.
+
+void
+IOFetch::stop(Result result) {
+
+ if (!data_->stopped) {
+
+ // Mark the fetch as stopped to prevent other completion callbacks
+ // (invoked because of the calls to cancel()) from executing the
+ // cancel calls again.
+ //
+ // In a single threaded environment, the callbacks won't be invoked
+ // until this one completes. In a multi-threaded environment, they may
+ // well be, in which case the testing (and setting) of the stopped_
+ // variable should be done inside a mutex (and the stopped_ variable
+ // declared as "volatile").
+ //
+ // TODO: Update testing of stopped_ if threads are used.
+ data_->stopped = true;
+
+ switch (result) {
+ case TIME_OUT:
+ dlog("Query timed out");
+ break;
+
+ case STOPPED:
+ dlog("Query stopped");
+ break;
+
+ default:
+ ;
+ }
+
+ // Stop requested, cancel and I/O's on the socket and shut it down,
+ // and cancel the timer.
+ data_->socket->cancel();
+ data_->socket->close();
+
+ data_->timer.cancel();
+
+ // Execute the I/O completion callback (if present).
+ if (data_->callback) {
+ (*(data_->callback))(result);
+ }
+
+ // Mark that stop() has now been called.
+
+ }
+}
+
+} // namespace asiolink
+
diff --git a/src/lib/asiolink/io_fetch.h b/src/lib/asiolink/io_fetch.h
new file mode 100644
index 0000000..8158c6c
--- /dev/null
+++ b/src/lib/asiolink/io_fetch.h
@@ -0,0 +1,226 @@
+// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#ifndef __IO_FETCH_H
+#define __IO_FETCH_H 1
+
+#include <config.h>
+
+#include <netinet/in.h>
+#include <sys/socket.h>
+#include <unistd.h> // for some IPC/network system calls
+
+#include <boost/shared_array.hpp>
+#include <boost/shared_ptr.hpp>
+#include <boost/date_time/posix_time/posix_time_types.hpp>
+#include <asio/deadline_timer.hpp>
+
+#include <coroutine.h>
+
+#include <dns/buffer.h>
+#include <dns/question.h>
+
+#include <asiolink/io_asio_socket.h>
+#include <asiolink/io_endpoint.h>
+#include <asiolink/io_service.h>
+#include <asiolink/tcp_socket.h>
+#include <asiolink/tcp_endpoint.h>
+#include <asiolink/udp_socket.h>
+#include <asiolink/udp_endpoint.h>
+
+
+namespace asiolink {
+
+
+/// \brief Upstream Fetch Processing
+///
+/// IOFetch is the class used to send upstream fetches and to handle responses.
+///
+/// \param E Endpoint type to use.
+
+class IOFetch : public coroutine {
+public:
+
+ /// \brief Result of Upstream Fetch
+ ///
+ /// Note that this applies to the status of I/Os in the fetch - a fetch
+ /// that resulted in a packet being received from the server is a SUCCESS,
+ /// even if the contents of the packet indicate that some error occurred.
+ enum Result {
+ SUCCESS = 0, ///< Success, fetch completed
+ TIME_OUT, ///< Failure, fetch timed out
+ STOPPED, ///< Control code, fetch has been stopped
+ NOTSET ///< For testing, indicates value not set
+ };
+
+ // The next enum is a "trick" to allow constants to be defined in a class
+ // declaration.
+
+ /// \brief Integer Constants
+ enum {
+ MAX_LENGTH = 4096 ///< Maximum size of receive buffer
+ };
+
+ /// \brief I/O Fetch Callback
+ ///
+ /// Class of callback object for when the fetch itself has completed - an
+ /// object of this class is passed to the IOFetch constructor and its
+ /// operator() method called when the fetch completes.
+ ///
+ /// Note the difference between the two operator() methods:
+ /// - IOFetch::operator() callback is called when an asynchronous I/O has
+ /// completed.
+ /// - IOFetch::Callback::operator() is called when an upstream fetch - which
+ /// may have involved several asynchronous I/O operations - has completed.
+ ///
+ /// This is an abstract class.
+ class Callback {
+ public:
+ /// \brief Default Constructor
+ Callback()
+ {}
+
+ /// \brief Virtual Destructor
+ virtual ~Callback()
+ {}
+
+ /// \brief Callback method called when the fetch completes
+ ///
+ /// \brief result Result of the fetch
+ virtual void operator()(Result result) = 0;
+ };
+
+ /// \brief IOFetch Data
+ ///
+ /// The data for IOFetch is held in a separate struct pointed to by a
+ /// shared_ptr object. This is because the IOFetch object will be copied
+ /// often (it is used as a coroutine and passed as callback to many
+ /// async_*() functions) and we want keep the same data). Organising the
+ /// data in this way keeps copying to a minimum.
+ struct IOFetchData {
+
+ // The next two members are shared pointers to a base class because what
+ // is actually instantiated depends on whether the fetch is over UDP or
+ // TCP, which is not known until construction of the IOFetch. Use of
+ // a shared pointer here is merely to ensure deletion when the data
+ // object is deleted.
+ boost::shared_ptr<IOAsioSocket<IOFetch> > socket;
+ ///< Socket to use for I/O
+ boost::shared_ptr<IOEndpoint> remote; ///< Where the fetch was sent
+ isc::dns::Question question; ///< Question to be asked
+ isc::dns::OutputBufferPtr msgbuf; ///< Wire buffer for question
+ isc::dns::OutputBufferPtr buffer; ///< Received data held here
+ boost::shared_array<char> data; ///< Temporary array for data
+ IOFetch::Callback* callback; ///< Called on I/O Completion
+ size_t cumulative; ///< Cumulative received amount
+ bool stopped; ///< Have we stopped running?
+ asio::deadline_timer timer; ///< Timer to measure timeouts
+ int timeout; ///< Timeout in ms
+
+ /// \brief Constructor
+ ///
+ /// Just fills in the data members of the IOFetchData structure
+ ///
+ /// \param protocol either IPPROTO_UDP or IPPROTO_TCP
+ /// \param service I/O Service object to handle the asynchronous
+ /// operations.
+ /// \param query DNS question to send to the upstream server.
+ /// \param address IP address of upstream server
+ /// \param port Port to use for the query
+ /// \param buff Output buffer into which the response (in wire format)
+ /// is written (if a response is received).
+ /// \param cb Callback object containing the callback to be called
+ /// when we terminate. The caller is responsible for managing this
+ /// object and deleting it if necessary.
+ /// \param wait Timeout for the fetch (in ms).
+ ///
+ /// TODO: May need to alter constructor (see comment 4 in Trac ticket #554)
+ IOFetchData(int protocol, IOService& service,
+ const isc::dns::Question& query, const IOAddress& address,
+ uint16_t port, isc::dns::OutputBufferPtr& buff, Callback* cb,
+ int wait)
+ :
+ socket((protocol == IPPROTO_UDP) ?
+ static_cast<IOAsioSocket<IOFetch>*>(
+ new UDPSocket<IOFetch>(service)) :
+ static_cast<IOAsioSocket<IOFetch>*>(
+ new TCPSocket<IOFetch>(service))
+ ),
+ remote((protocol == IPPROTO_UDP) ?
+ static_cast<IOEndpoint*>(new UDPEndpoint(address, port)) :
+ static_cast<IOEndpoint*>(new TCPEndpoint(address, port))
+ ),
+ question(query),
+ msgbuf(new isc::dns::OutputBuffer(512)),
+ buffer(buff),
+ data(new char[IOFetch::MAX_LENGTH]),
+ callback(cb),
+ cumulative(0),
+ stopped(false),
+ timer(service.get_io_service()),
+ timeout(wait)
+ {}
+ };
+
+ /// \brief Constructor.
+ ///
+ /// Creates the object that will handle the upstream fetch.
+ ///
+ /// TODO: Need to randomise the source port
+ ///
+ /// \param protocol Fetch protocol, either IPPROTO_UDP or IPPROTO_TCP
+ /// \param service I/O Service object to handle the asynchronous
+ /// operations.
+ /// \param question DNS question to send to the upstream server.
+ /// \param buff Output buffer into which the response (in wire format)
+ /// is written (if a response is received).
+ /// \param cb Callback object containing the callback to be called
+ /// when we terminate. The caller is responsible for managing this
+ /// object and deleting it if necessary.
+ /// \param address IP address of upstream server
+ /// \param port Port to which to connect on the upstream server
+ /// (default = 53)
+ /// \param wait Timeout for the fetch (in ms). The default value of
+ /// -1 indicates no timeout.
+ IOFetch(int protocol, IOService& service,
+ const isc::dns::Question& question, const IOAddress& address,
+ uint16_t port, isc::dns::OutputBufferPtr& buff, Callback* cb,
+ int wait = -1);
+
+ /// \brief Coroutine entry point
+ ///
+ /// The operator() method is the method in which the coroutine code enters
+ /// this object when an operation has been completed.
+ ///
+ /// \param ec Error code, the result of the last asynchronous I/O operation.
+ /// \param length Amount of data received on the last asynchronous read
+ void operator()(asio::error_code ec = asio::error_code(),
+ size_t length = 0);
+
+ /// \brief Terminate query
+ ///
+ /// This method can be called at any point. It terminates the current
+ /// query with the specified reason.
+ ///
+ /// \param reason Reason for terminating the query
+ void stop(Result reason = STOPPED);
+
+private:
+ boost::shared_ptr<IOFetchData> data_; ///< Private data
+
+};
+
+} // namespace asiolink
+
+#endif // __IO_FETCH_H
diff --git a/src/lib/asiolink/io_message.h b/src/lib/asiolink/io_message.h
index 7d7d56c..532f449 100644
--- a/src/lib/asiolink/io_message.h
+++ b/src/lib/asiolink/io_message.h
@@ -12,8 +12,8 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-#ifndef __IOMESSAGE_H
-#define __IOMESSAGE_H 1
+#ifndef __IO_MESSAGE_H
+#define __IO_MESSAGE_H 1
// IMPORTANT NOTE: only very few ASIO headers files can be included in
// this file. In particular, asio.hpp should never be included here.
@@ -46,6 +46,7 @@ class IOMessage {
///
/// \name Constructors and Destructor
///
+
/// Note: The copy constructor and the assignment operator are
/// intentionally defined as private, making this class non-copyable.
//@{
@@ -96,7 +97,7 @@ private:
} // asiolink
-#endif // __IOMESSAGE_H
+#endif // __IO_MESSAGE_H
// Local Variables:
// mode: c++
diff --git a/src/lib/asiolink/io_service.cc b/src/lib/asiolink/io_service.cc
index 8d96da9..55fc4b3 100644
--- a/src/lib/asiolink/io_service.cc
+++ b/src/lib/asiolink/io_service.cc
@@ -11,13 +11,14 @@
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-#include <config.h>
-// unistd is needed for asio.hpp with SunStudio
-#include <unistd.h>
+#include <netinet/in.h>
+#include <sys/socket.h>
+#include <unistd.h> // for some IPC/network system calls
-#include <asio.hpp>
+#include <config.h>
+#include <asio.hpp>
#include <asiolink/io_service.h>
namespace asiolink {
diff --git a/src/lib/asiolink/io_socket.h b/src/lib/asiolink/io_socket.h
index df37d71..bebc8b6 100644
--- a/src/lib/asiolink/io_socket.h
+++ b/src/lib/asiolink/io_socket.h
@@ -12,8 +12,8 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-#ifndef __IOSOCKET_H
-#define __IOSOCKET_H 1
+#ifndef __IO_SOCKET_H
+#define __IO_SOCKET_H 1
// IMPORTANT NOTE: only very few ASIO headers files can be included in
// this file. In particular, asio.hpp should never be included here.
@@ -119,9 +119,6 @@ public:
static IOSocket& getDummyTCPSocket();
};
-} // asiolink
-#endif // __IOSOCKET_H
+} // namespace asiolink
-// Local Variables:
-// mode: c++
-// End:
+#endif // __IO_SOCKET_H
diff --git a/src/lib/asiolink/recursive_query.cc b/src/lib/asiolink/recursive_query.cc
index 9f814b0..0bdf24e 100644
--- a/src/lib/asiolink/recursive_query.cc
+++ b/src/lib/asiolink/recursive_query.cc
@@ -12,28 +12,30 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-#include <config.h>
-
+#include <netinet/in.h>
#include <stdlib.h>
+#include <sys/socket.h>
+#include <unistd.h> // for some IPC/network system calls
-// unistd is needed for asio.hpp with SunStudio
-#include <unistd.h>
-
-#include <asio.hpp>
+#include <boost/lexical_cast.hpp>
+#include <boost/bind.hpp>
-#include <asiolink/recursive_query.h>
-#include <asiolink/dns_service.h>
-#include <asiolink/udp_query.h>
+#include <config.h>
#include <log/dummylog.h>
-#include <boost/lexical_cast.hpp>
-#include <boost/bind.hpp>
-
#include <dns/question.h>
#include <dns/message.h>
+#include <dns/opcode.h>
#include <resolve/resolve.h>
+#include <cache/resolver_cache.h>
+
+#include <asio.hpp>
+#include <asiolink/dns_service.h>
+#include <asiolink/io_fetch.h>
+#include <asiolink/io_service.h>
+#include <asiolink/recursive_query.h>
using isc::log::dlog;
using namespace isc::dns;
@@ -68,10 +70,10 @@ typedef std::pair<std::string, uint16_t> addr_t;
*
* Used by RecursiveQuery::sendQuery.
*/
-class RunningQuery : public UDPQuery::Callback {
+class RunningQuery : public IOFetch::Callback {
private:
// The io service to handle async calls
- asio::io_service& io_;
+ IOService& io_;
// Info for (re)sending the query (the question and destination)
Question question_;
@@ -123,7 +125,7 @@ private:
asio::deadline_timer lookup_timer;
size_t queries_out_;
-
+
// If we timed out ourselves (lookup timeout), stop issuing queries
bool done_;
@@ -132,6 +134,26 @@ private:
// answer if we do find one later (or if we have a lookup_timeout)
bool answer_sent_;
+ // Reference to our cache
+ isc::cache::ResolverCache& cache_;
+
+ // perform a single lookup; first we check the cache to see
+ // if we have a response for our query stored already. if
+ // so, call handlerecursiveresponse(), if not, we call send()
+ void doLookup() {
+ dlog("doLookup: try cache");
+ Message cached_message(Message::RENDER);
+ isc::resolve::initResponseMessage(question_, cached_message);
+ if (cache_.lookup(question_.getName(), question_.getType(),
+ question_.getClass(), cached_message)) {
+ dlog("Message found in cache, returning that");
+ handleRecursiveAnswer(cached_message);
+ } else {
+ send();
+ }
+
+ }
+
// (re)send the query to the server.
void send() {
const int uc = upstream_->size();
@@ -141,22 +163,22 @@ private:
int serverIndex = rand() % uc;
dlog("Sending upstream query (" + question_.toText() +
") to " + upstream_->at(serverIndex).first);
- UDPQuery query(io_, question_,
+ IOFetch query(IPPROTO_UDP, io_, question_,
upstream_->at(serverIndex).first,
upstream_->at(serverIndex).second, buffer_, this,
query_timeout_);
++queries_out_;
- io_.post(query);
+ io_.get_io_service().post(query);
} else if (zs > 0) {
int serverIndex = rand() % zs;
dlog("Sending query to zone server (" + question_.toText() +
") to " + zone_servers_.at(serverIndex).first);
- UDPQuery query(io_, question_,
+ IOFetch query(IPPROTO_UDP, io_, question_,
zone_servers_.at(serverIndex).first,
zone_servers_.at(serverIndex).second, buffer_, this,
query_timeout_);
++queries_out_;
- io_.post(query);
+ io_.get_io_service().post(query);
} else {
dlog("Error, no upstream servers to send to.");
}
@@ -184,6 +206,11 @@ private:
question_, incoming, cname_target, cname_count_, true);
bool found_ns_address = false;
+
+ // If the packet is OK, store it in the cache
+ if (!isc::resolve::ResponseClassifier::error(category)) {
+ cache_.update(incoming);
+ }
switch (category) {
case isc::resolve::ResponseClassifier::ANSWER:
@@ -213,7 +240,7 @@ private:
question_.getType());
dlog("Following CNAME chain to " + question_.toText());
- send();
+ doLookup();
return false;
break;
case isc::resolve::ResponseClassifier::NXDOMAIN:
@@ -245,11 +272,16 @@ private:
// TODO should use NSAS
zone_servers_.push_back(addr_t(addr_str, 53));
found_ns_address = true;
+ break;
}
}
}
if (found_ns_address) {
// next resolver round
+ // we do NOT use doLookup() here, but send() (i.e. we
+ // skip the cache), since if we had the final answer
+ // instead of a delegation cached, we would have been
+ // there by now.
send();
return false;
} else {
@@ -283,7 +315,7 @@ private:
}
public:
- RunningQuery(asio::io_service& io,
+ RunningQuery(IOService& io,
const Question &question,
MessagePtr answer_message,
boost::shared_ptr<AddressVector> upstream,
@@ -291,7 +323,8 @@ public:
OutputBufferPtr buffer,
isc::resolve::ResolverInterface::CallbackPtr cb,
int query_timeout, int client_timeout, int lookup_timeout,
- unsigned retries) :
+ unsigned retries,
+ isc::cache::ResolverCache& cache) :
io_(io),
question_(question),
answer_message_(answer_message),
@@ -302,11 +335,12 @@ public:
cname_count_(0),
query_timeout_(query_timeout),
retries_(retries),
- client_timer(io),
- lookup_timer(io),
+ client_timer(io.get_io_service()),
+ lookup_timer(io.get_io_service()),
queries_out_(0),
done_(false),
- answer_sent_(false)
+ answer_sent_(false),
+ cache_(cache)
{
// Setup the timer to stop trying (lookup_timeout)
if (lookup_timeout >= 0) {
@@ -328,7 +362,7 @@ public:
setZoneServersToRoot();
}
- send();
+ doLookup();
}
void setZoneServersToRoot() {
@@ -352,8 +386,10 @@ public:
// we have an answer or timeout ourselves
isc::resolve::makeErrorMessage(answer_message_,
Rcode::SERVFAIL());
- resolvercallback_->success(answer_message_);
- answer_sent_ = true;
+ if (!answer_sent_) {
+ answer_sent_ = true;
+ resolvercallback_->success(answer_message_);
+ }
}
virtual void stop(bool resume) {
@@ -366,6 +402,27 @@ public:
// until that one comes back to us)
done_ = true;
if (resume && !answer_sent_) {
+ answer_sent_ = true;
+
+ // There are two types of messages we could store in the
+ // cache;
+ // 1. answers to our fetches from authoritative servers,
+ // exactly as we receive them, and
+ // 2. answers to queries we received from clients, which
+ // have received additional processing (following CNAME
+ // chains, for instance)
+ //
+ // Doing only the first would mean we would have to re-do
+ // processing when we get data from our cache, and doing
+ // only the second would miss out on the side-effect of
+ // having nameserver data in our cache.
+ //
+ // So right now we do both. Since the cache (currently)
+ // stores Messages on their question section only, this
+ // does mean that we overwrite the messages we stored in
+ // the previous iteration if we are following a delegation.
+ cache_.update(*answer_message_);
+
resolvercallback_->success(answer_message_);
} else {
resolvercallback_->failure();
@@ -383,10 +440,10 @@ public:
}
// This function is used as callback from DNSQuery.
- virtual void operator()(UDPQuery::Result result) {
+ virtual void operator()(IOFetch::Result result) {
// XXX is this the place for TCP retry?
--queries_out_;
- if (!done_ && result != UDPQuery::TIME_OUT) {
+ if (!done_ && result != IOFetch::TIME_OUT) {
// we got an answer
Message incoming(Message::PARSE);
InputBuffer ibuf(buffer_->getData(), buffer_->getLength());
@@ -420,15 +477,29 @@ void
RecursiveQuery::resolve(const QuestionPtr& question,
const isc::resolve::ResolverInterface::CallbackPtr callback)
{
- asio::io_service& io = dns_service_.get_io_service();
+ IOService& io = dns_service_.getIOService();
MessagePtr answer_message(new Message(Message::RENDER));
+ isc::resolve::initResponseMessage(*question, *answer_message);
+
OutputBufferPtr buffer(new OutputBuffer(0));
-
- // It will delete itself when it is done
- new RunningQuery(io, *question, answer_message, upstream_,
- upstream_root_, buffer, callback, query_timeout_,
- client_timeout_, lookup_timeout_, retries_);
+
+ dlog("Try out cache first (direct call to resolve)");
+ // First try to see if we have something cached in the messagecache
+ if (cache_.lookup(question->getName(), question->getType(),
+ question->getClass(), *answer_message)) {
+ dlog("Message found in cache, returning that");
+ // TODO: err, should cache set rcode as well?
+ answer_message->setRcode(Rcode::NOERROR());
+ callback->success(answer_message);
+ } else {
+ dlog("Message not found in cache, starting recursive query");
+ // It will delete itself when it is done
+ new RunningQuery(io, *question, answer_message, upstream_,
+ upstream_root_, buffer, callback, query_timeout_,
+ client_timeout_, lookup_timeout_, retries_,
+ cache_);
+ }
}
void
@@ -441,15 +512,30 @@ RecursiveQuery::resolve(const Question& question,
// the message should be sent via TCP or UDP, or sent initially via
// UDP and then fall back to TCP on failure, but for the moment
// we're only going to handle UDP.
- asio::io_service& io = dns_service_.get_io_service();
+ IOService& io = dns_service_.getIOService();
isc::resolve::ResolverInterface::CallbackPtr crs(
new isc::resolve::ResolverCallbackServer(server));
+
+ // TODO: general 'prepareinitialanswer'
+ answer_message->setOpcode(isc::dns::Opcode::QUERY());
+ answer_message->addQuestion(question);
- // It will delete itself when it is done
- new RunningQuery(io, question, answer_message, upstream_, upstream_root_,
- buffer, crs, query_timeout_, client_timeout_,
- lookup_timeout_, retries_);
+ // First try to see if we have something cached in the messagecache
+ dlog("Try out cache first (started by incoming event)");
+ if (cache_.lookup(question.getName(), question.getType(),
+ question.getClass(), *answer_message)) {
+ dlog("Message found in cache, returning that");
+ // TODO: err, should cache set rcode as well?
+ answer_message->setRcode(Rcode::NOERROR());
+ crs->success(answer_message);
+ } else {
+ dlog("Message not found in cache, starting recursive query");
+ // It will delete itself when it is done
+ new RunningQuery(io, question, answer_message, upstream_, upstream_root_,
+ buffer, crs, query_timeout_, client_timeout_,
+ lookup_timeout_, retries_, cache_);
+ }
}
diff --git a/src/lib/asiolink/recursive_query.h b/src/lib/asiolink/recursive_query.h
index 0660c09..6ef0069 100644
--- a/src/lib/asiolink/recursive_query.h
+++ b/src/lib/asiolink/recursive_query.h
@@ -18,6 +18,7 @@
#include <asiolink/dns_service.h>
#include <asiolink/dns_server.h>
#include <dns/buffer.h>
+#include <cache/resolver_cache.h>
namespace asiolink {
/// \brief The \c RecursiveQuery class provides a layer of abstraction around
@@ -107,6 +108,9 @@ private:
int client_timeout_;
int lookup_timeout_;
unsigned retries_;
+ // Cache. TODO: I think we want this initialized in Resolver class,
+ // not here
+ isc::cache::ResolverCache cache_;
};
} // namespace asiolink
diff --git a/src/lib/asiolink/tcp_server.cc b/src/lib/asiolink/tcp_server.cc
index 2bdfc60..df19b00 100644
--- a/src/lib/asiolink/tcp_server.cc
+++ b/src/lib/asiolink/tcp_server.cc
@@ -14,18 +14,18 @@
#include <config.h>
-#include <boost/shared_array.hpp>
-
-// unistd is needed for asio.hpp with SunStudio
-#include <unistd.h>
+#include <netinet/in.h>
+#include <sys/socket.h>
+#include <unistd.h> // for some IPC/network system calls
-#include <asio.hpp>
+#include <boost/shared_array.hpp>
#include <log/dummylog.h>
+#include <asio.hpp>
+#include <asiolink/dummy_io_cb.h>
#include <asiolink/tcp_endpoint.h>
#include <asiolink/tcp_socket.h>
-
#include <asiolink/tcp_server.h>
@@ -46,7 +46,7 @@ TCPServer::TCPServer(io_service& io_service,
const SimpleCallback* checkin,
const DNSLookup* lookup,
const DNSAnswer* answer) :
- io_(io_service), done_(false),
+ io_(io_service), done_(false), stopped_by_hand_(false),
checkin_callback_(checkin), lookup_callback_(lookup),
answer_callback_(answer)
{
@@ -65,9 +65,16 @@ TCPServer::TCPServer(io_service& io_service,
void
TCPServer::operator()(error_code ec, size_t length) {
- /// Because the coroutine reeentry block is implemented as
+ /// Because the coroutine reentry block is implemented as
/// a switch statement, inline variable declarations are not
/// permitted. Certain variables used below can be declared here.
+
+ /// If user has stopped the server, we won't enter the
+ /// coroutine body, just return
+ if (stopped_by_hand_) {
+ return;
+ }
+
boost::array<const_buffer,2> bufs;
OutputBuffer lenbuf(TCP_MESSAGE_LENGTHSIZE);
@@ -103,7 +110,7 @@ TCPServer::operator()(error_code ec, size_t length) {
/// Now read the message itself. (This is done in a different scope
/// to allow inline variable declarations.)
CORO_YIELD {
- InputBuffer dnsbuffer((const void *) data_.get(), length);
+ InputBuffer dnsbuffer(data_.get(), length);
uint16_t msglen = dnsbuffer.readUint16();
async_read(*socket_, asio::buffer(data_.get(), msglen), *this);
}
@@ -118,7 +125,14 @@ TCPServer::operator()(error_code ec, size_t length) {
// that would quickly generate an IOMessage object without
// all these calls to "new".)
peer_.reset(new TCPEndpoint(socket_->remote_endpoint()));
- iosock_.reset(new TCPSocket(*socket_));
+
+ // The TCP socket class has been extended with asynchronous functions
+ // and takes as a template parameter a completion callback class. As
+ // TCPServer does not use these extended functions (only those defined
+ // in the IOSocket base class) - but needs a TCPSocket to get hold of
+ // the underlying Boost TCP socket - DummyIOCallback is used. This
+ // provides the appropriate operator() but is otherwise functionless.
+ iosock_.reset(new TCPSocket<DummyIOCallback>(*socket_));
io_message_.reset(new IOMessage(data_.get(), length, *iosock_, *peer_));
bytes_ = length;
@@ -181,6 +195,16 @@ TCPServer::asyncLookup() {
answer_message_, respbuf_, this);
}
+void TCPServer::stop() {
+ // server should not be stopped twice
+ if (stopped_by_hand_) {
+ return;
+ }
+
+ stopped_by_hand_ = true;
+ acceptor_->close();
+ socket_->close();
+}
/// Post this coroutine on the ASIO service queue so that it will
/// resume processing where it left off. The 'done' parameter indicates
/// whether there is an answer to return to the client.
diff --git a/src/lib/asiolink/tcp_server.h b/src/lib/asiolink/tcp_server.h
index 9b985ce..9df335d 100644
--- a/src/lib/asiolink/tcp_server.h
+++ b/src/lib/asiolink/tcp_server.h
@@ -43,6 +43,7 @@ public:
void operator()(asio::error_code ec = asio::error_code(),
size_t length = 0);
void asyncLookup();
+ void stop();
void resume(const bool done);
bool hasAnswer() { return (done_); }
int value() { return (get_value()); }
@@ -106,6 +107,9 @@ private:
size_t bytes_;
bool done_;
+ // whether user has stopped the server
+ bool stopped_by_hand_;
+
// Callback functions provided by the caller
const SimpleCallback* checkin_callback_;
const DNSLookup* lookup_callback_;
diff --git a/src/lib/asiolink/tcp_socket.h b/src/lib/asiolink/tcp_socket.h
index 03713a5..5a85aaa 100644
--- a/src/lib/asiolink/tcp_socket.h
+++ b/src/lib/asiolink/tcp_socket.h
@@ -19,34 +19,259 @@
#error "asio.hpp must be included before including this, see asiolink.h as to why"
#endif
-#include <asiolink/io_socket.h>
+#include <log/dummylog.h>
+#include <netinet/in.h>
+#include <sys/socket.h>
+#include <unistd.h> // for some IPC/network system calls
+
+#include <iostream>
+#include <cstddef>
+
+#include <config.h>
+
+#include <asiolink/io_asio_socket.h>
+#include <asiolink/io_endpoint.h>
+#include <asiolink/io_service.h>
+#include <asiolink/tcp_endpoint.h>
namespace asiolink {
-/// \brief The \c TCPSocket class is a concrete derived class of
-/// \c IOSocket that represents a TCP socket.
+/// \brief The \c TCPSocket class is a concrete derived class of \c IOAsioSocket
+/// that represents a TCP socket.
///
-/// In the current implementation, an object of this class is always
-/// instantiated within the wrapper routines. Applications are expected to
-/// get access to the object via the abstract base class, \c IOSocket.
-/// This design may be changed when we generalize the wrapper interface.
-class TCPSocket : public IOSocket {
+/// \param C Callback type
+template <typename C>
+class TCPSocket : public IOAsioSocket<C> {
private:
- TCPSocket(const TCPSocket& source);
- TCPSocket& operator=(const TCPSocket& source);
+ /// \brief Class is non-copyable
+ TCPSocket(const TCPSocket&);
+ TCPSocket& operator=(const TCPSocket&);
+
public:
+
/// \brief Constructor from an ASIO TCP socket.
///
- /// \param socket The ASIO representation of the TCP socket.
- TCPSocket(asio::ip::tcp::socket& socket) : socket_(socket) {}
+ /// \param socket The ASIO representation of the TCP socket. It
+ /// is assumed that the caller will open and close the socket, so
+ /// these operations are a no-op for that socket.
+ TCPSocket(asio::ip::tcp::socket& socket);
+
+ /// \brief Constructor
+ ///
+ /// Used when the TCPSocket is being asked to manage its own internal
+ /// socket. It is assumed that open() and close() will not be used.
+ ///
+ /// \param service I/O Service object used to manage the socket.
+ TCPSocket(IOService& service);
+
+ /// \brief Destructor
+ virtual ~TCPSocket();
+
+ virtual int getNative() const { return (socket_.native()); }
+ virtual int getProtocol() const { return (IPPROTO_TCP); }
+
+ /// \brief Open Socket
+ ///
+ /// Opens the TCP socket. In the model for transport-layer agnostic I/O,
+ /// an "open" operation includes a connection to the remote end (which
+ /// may take time). This does not happen for TCP, so the method returns
+ /// "false" to indicate that the operation completed synchronously.
+ ///
+ /// \param endpoint Endpoint to which the socket will connect to.
+ /// \param callback Unused.
+ ///
+ /// \return false to indicate that the "operation" completed synchronously.
+ virtual bool open(const IOEndpoint* endpoint, C&);
+
+ /// \brief Send Asynchronously
+ ///
+ /// This corresponds to async_send_to() for TCP sockets and async_send()
+ /// for TCP. In both cases an endpoint argument is supplied indicating the
+ /// target of the send - this is ignored for TCP.
+ ///
+ /// \param data Data to send
+ /// \param length Length of data to send
+ /// \param endpoint Target of the send
+ /// \param callback Callback object.
+ virtual void asyncSend(const void* data, size_t length,
+ const IOEndpoint* endpoint, C& callback);
+
+ /// \brief Receive Asynchronously
+ ///
+ /// This correstponds to async_receive_from() for TCP sockets and
+ /// async_receive() for TCP. In both cases, an endpoint argument is
+ /// supplied to receive the source of the communication. For TCP it will
+ /// be filled in with details of the connection.
+ ///
+ /// \param data Buffer to receive incoming message
+ /// \param length Length of the data buffer
+ /// \param cumulative Amount of data that should already be in the buffer.
+ /// (This is ignored - every UPD receive fills the buffer from the start.)
+ /// \param endpoint Source of the communication
+ /// \param callback Callback object
+ virtual void asyncReceive(void* data, size_t length, size_t cumulative,
+ IOEndpoint* endpoint, C& callback);
+
+ /// \brief Checks if the data received is complete.
+ ///
+ /// As all the data is received in one I/O, so this is, this is effectively
+ /// a no-op (although it does update the amount of data received).
+ ///
+ /// \param data Data buffer containing data to date. (This is ignored
+ /// for TCP receives.)
+ /// \param length Amount of data received in last asynchronous I/O
+ /// \param cumulative On input, amount of data received before the last
+ /// I/O. On output, the total amount of data received to date.
+ ///
+ /// \return true if the receive is complete, false if another receive is
+ /// needed.
+ virtual bool receiveComplete(void*, size_t length, size_t& cumulative) {
+ cumulative = length;
+ return (true);
+ }
+
+ /// \brief Cancel I/O On Socket
+ virtual void cancel();
+
+ /// \brief Close socket
+ virtual void close();
- int getNative() const { return (socket_.native()); }
- int getProtocol() const { return (IPPROTO_TCP); }
private:
- asio::ip::tcp::socket& socket_;
+ // Two variables to hold the socket - a socket and a pointer to it. This
+ // handles the case where a socket is passed to the TCPSocket on
+ // construction, or where it is asked to manage its own socket.
+ asio::ip::tcp::socket* socket_ptr_; ///< Pointer to own socket
+ asio::ip::tcp::socket& socket_; ///< Socket
+ bool isopen_; ///< true when socket is open
};
+// Constructor - caller manages socket
+
+template <typename C>
+TCPSocket<C>::TCPSocket(asio::ip::tcp::socket& socket) :
+ socket_ptr_(NULL), socket_(socket), isopen_(true)
+{
+}
+
+// Constructor - create socket on the fly
+
+template <typename C>
+TCPSocket<C>::TCPSocket(IOService& service) :
+ socket_ptr_(new asio::ip::tcp::socket(service.get_io_service())),
+ socket_(*socket_ptr_), isopen_(false)
+{
+}
+
+// Destructor. Only delete the socket if we are managing it.
+
+template <typename C>
+TCPSocket<C>::~TCPSocket()
+{
+ delete socket_ptr_;
+}
+
+// Open the socket. Throws an error on failure
+// TODO: Make the open more resilient
+
+template <typename C> bool
+TCPSocket<C>::open(const IOEndpoint* endpoint, C&) {
+
+ // Ignore opens on already-open socket. Don't throw a failure because
+ // of uncertainties as to what precedes whan when using asynchronous I/O.
+ // At also allows us a treat a passed-in socket as a self-managed socket.
+
+ if (!isopen_) {
+ if (endpoint->getFamily() == AF_INET) {
+ socket_.open(asio::ip::tcp::v4());
+ }
+ else {
+ socket_.open(asio::ip::tcp::v6());
+ }
+ isopen_ = true;
+
+ // TODO: Complete TCPSocket::open()
+
+ }
+ return (false);
+}
+
+// Send a message. Should never do this if the socket is not open, so throw
+// an exception if this is the case.
+
+template <typename C> void
+TCPSocket<C>::asyncSend(const void* data, size_t length,
+ const IOEndpoint* endpoint, C& callback)
+{
+ if (isopen_) {
+
+ // Upconvert to a TCPEndpoint. We need to do this because although
+ // IOEndpoint is the base class of TCPEndpoint and TCPEndpoint, it
+ // doing cont contain a method for getting at the underlying endpoint
+ // type - those are in the derived class and the two classes differ on
+ // return type.
+
+ assert(endpoint->getProtocol() == IPPROTO_TCP);
+ const TCPEndpoint* tcp_endpoint =
+ static_cast<const TCPEndpoint*>(endpoint);
+ std::cerr << "TCPSocket::asyncSend(): sending to " <<
+ tcp_endpoint->getAddress().toText() <<
+ ", port " << tcp_endpoint->getPort() << "\n";
+
+ // TODO: Complete TCPSocket::asyncSend()
+
+ } else {
+ isc_throw(SocketNotOpen,
+ "attempt to send on a TCP socket that is not open");
+ }
+}
+
+// Receive a message. Note that the "cumulative" argument is ignored - every TCP
+// receive is put into the buffer beginning at the start - there is no concept
+// receiving a subsequent part of a message. Same critera as before concerning
+// the need for the socket to be open.
+
+template <typename C> void
+TCPSocket<C>::asyncReceive(void* data, size_t length, size_t,
+ IOEndpoint* endpoint, C& callback)
+{
+ if (isopen_) {
+
+ // Upconvert the endpoint again.
+ assert(endpoint->getProtocol() == IPPROTO_TCP);
+ const TCPEndpoint* tcp_endpoint =
+ static_cast<const TCPEndpoint*>(endpoint);
+ std::cerr << "TCPSocket::asyncReceive(): receiving from " <<
+ tcp_endpoint->getAddress().toText() <<
+ ", port " << tcp_endpoint->getPort() << "\n";
+
+ // TODO: Complete TCPSocket::asyncReceive()
+
+ } else {
+ isc_throw(SocketNotOpen,
+ "attempt to receive from a TCP socket that is not open");
+ }
+}
+
+// Cancel I/O on the socket. No-op if the socket is not open.
+template <typename C> void
+TCPSocket<C>::cancel() {
+ if (isopen_) {
+ socket_.cancel();
+ }
+}
+
+// Close the socket down. Can only do this if the socket is open and we are
+// managing it ourself.
+
+template <typename C> void
+TCPSocket<C>::close() {
+ if (isopen_ && socket_ptr_) {
+ socket_.close();
+ isopen_ = false;
+ }
+}
+
+} // namespace asiolink
-} // namespace asiolink
#endif // __TCP_SOCKET_H
diff --git a/src/lib/asiolink/tests/Makefile.am b/src/lib/asiolink/tests/Makefile.am
index 7fe268e..b4f0a87 100644
--- a/src/lib/asiolink/tests/Makefile.am
+++ b/src/lib/asiolink/tests/Makefile.am
@@ -15,24 +15,32 @@ CLEANFILES = *.gcno *.gcda
TESTS =
if HAVE_GTEST
TESTS += run_unittests
-run_unittests_SOURCES = $(top_srcdir)/src/lib/dns/tests/unittest_util.h
+run_unittests_SOURCES = run_unittests.cc
+run_unittests_SOURCES += $(top_srcdir)/src/lib/dns/tests/unittest_util.h
run_unittests_SOURCES += $(top_srcdir)/src/lib/dns/tests/unittest_util.cc
-run_unittests_SOURCES += udp_query_unittest.cc
-run_unittests_SOURCES += ioaddress_unittest.cc
-run_unittests_SOURCES += ioendpoint_unittest.cc
-run_unittests_SOURCES += iosocket_unittest.cc
+run_unittests_SOURCES += io_address_unittest.cc
+run_unittests_SOURCES += io_endpoint_unittest.cc
+run_unittests_SOURCES += io_fetch_unittest.cc
+run_unittests_SOURCES += io_socket_unittest.cc
run_unittests_SOURCES += io_service_unittest.cc
run_unittests_SOURCES += interval_timer_unittest.cc
run_unittests_SOURCES += recursive_query_unittest.cc
-run_unittests_SOURCES += run_unittests.cc
+run_unittests_SOURCES += udp_endpoint_unittest.cc
+run_unittests_SOURCES += udp_socket_unittest.cc
+
run_unittests_CPPFLAGS = $(AM_CPPFLAGS) $(GTEST_INCLUDES)
-run_unittests_LDFLAGS = $(AM_LDFLAGS) $(GTEST_LDFLAGS) $(LOG4CXX_LDFLAGS)
-run_unittests_LDADD = $(GTEST_LDADD)
+
+run_unittests_LDADD = $(GTEST_LDADD)
run_unittests_LDADD += $(SQLITE_LIBS)
run_unittests_LDADD += $(top_builddir)/src/lib/dns/libdns++.la
run_unittests_LDADD += $(top_builddir)/src/lib/exceptions/libexceptions.la
run_unittests_LDADD += $(top_builddir)/src/lib/asiolink/libasiolink.la
run_unittests_LDADD += $(top_builddir)/src/lib/log/liblog.la
+run_unittests_LDADD += $(top_builddir)/src/lib/cache/libcache.la
+run_unittests_LDADD += $(top_builddir)/src/lib/nsas/libnsas.la
+
+run_unittests_LDFLAGS = $(AM_LDFLAGS) $(GTEST_LDFLAGS)
+
# Note: the ordering matters: -Wno-... must follow -Wextra (defined in
# B10_CXXFLAGS)
run_unittests_CXXFLAGS = $(AM_CXXFLAGS)
diff --git a/src/lib/asiolink/tests/interval_timer_unittest.cc b/src/lib/asiolink/tests/interval_timer_unittest.cc
index 9a7b0f4..7e0e7bc 100644
--- a/src/lib/asiolink/tests/interval_timer_unittest.cc
+++ b/src/lib/asiolink/tests/interval_timer_unittest.cc
@@ -15,6 +15,7 @@
#include <config.h>
#include <gtest/gtest.h>
+#include <asio.hpp>
#include <asiolink/asiolink.h>
#include <boost/date_time/posix_time/posix_time_types.hpp>
@@ -32,7 +33,9 @@ using namespace asiolink;
// or not.
class IntervalTimerTest : public ::testing::Test {
protected:
- IntervalTimerTest() : io_service_() {}
+ IntervalTimerTest() :
+ io_service_(), timer_called_(false), timer_cancel_success_(false)
+ {}
~IntervalTimerTest() {}
class TimerCallBack : public std::unary_function<void, void> {
public:
@@ -63,7 +66,8 @@ protected:
TimerCallBackCancelDeleter(IntervalTimerTest* test_obj,
IntervalTimer* timer,
TimerCallBackCounter& counter)
- : test_obj_(test_obj), timer_(timer), counter_(counter), count_(0)
+ : test_obj_(test_obj), timer_(timer), counter_(counter), count_(0),
+ prev_counter_(-1)
{}
void operator()() {
++count_;
diff --git a/src/lib/asiolink/tests/io_address_unittest.cc b/src/lib/asiolink/tests/io_address_unittest.cc
new file mode 100644
index 0000000..894f143
--- /dev/null
+++ b/src/lib/asiolink/tests/io_address_unittest.cc
@@ -0,0 +1,63 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#include <config.h>
+#include <gtest/gtest.h>
+
+#include <asiolink/io_error.h>
+#include <asiolink/io_address.h>
+
+using namespace asiolink;
+
+TEST(IOAddressTest, fromText) {
+ IOAddress io_address_v4("192.0.2.1");
+ EXPECT_EQ("192.0.2.1", io_address_v4.toText());
+
+ IOAddress io_address_v6("2001:db8::1234");
+ EXPECT_EQ("2001:db8::1234", io_address_v6.toText());
+
+ // bogus IPv4 address-like input
+ EXPECT_THROW(IOAddress("192.0.2.2.1"), IOError);
+
+ // bogus IPv4 address-like input: out-of-range octet
+ EXPECT_THROW(IOAddress("192.0.2.300"), IOError);
+
+ // bogus IPv6 address-like input
+ EXPECT_THROW(IOAddress("2001:db8:::1234"), IOError);
+
+ // bogus IPv6 address-like input
+ EXPECT_THROW(IOAddress("2001:db8::efgh"), IOError);
+}
+
+TEST(IOAddressTest, Equality) {
+ EXPECT_TRUE(IOAddress("192.0.2.1") == IOAddress("192.0.2.1"));
+ EXPECT_FALSE(IOAddress("192.0.2.1") != IOAddress("192.0.2.1"));
+
+ EXPECT_TRUE(IOAddress("192.0.2.1") != IOAddress("192.0.2.2"));
+ EXPECT_FALSE(IOAddress("192.0.2.1") == IOAddress("192.0.2.2"));
+
+ EXPECT_TRUE(IOAddress("2001:db8::12") == IOAddress("2001:0DB8:0:0::0012"));
+ EXPECT_FALSE(IOAddress("2001:db8::12") != IOAddress("2001:0DB8:0:0::0012"));
+
+ EXPECT_TRUE(IOAddress("2001:db8::1234") != IOAddress("2001:db8::1235"));
+ EXPECT_FALSE(IOAddress("2001:db8::1234") == IOAddress("2001:db8::1235"));
+
+ EXPECT_TRUE(IOAddress("2001:db8::1234") != IOAddress("192.0.2.3"));
+ EXPECT_FALSE(IOAddress("2001:db8::1234") == IOAddress("192.0.2.3"));
+}
+
+TEST(IOAddressTest, Family) {
+ EXPECT_EQ(AF_INET, IOAddress("192.0.2.1").getFamily());
+ EXPECT_EQ(AF_INET6, IOAddress("2001:0DB8:0:0::0012").getFamily());
+}
diff --git a/src/lib/asiolink/tests/io_endpoint_unittest.cc b/src/lib/asiolink/tests/io_endpoint_unittest.cc
new file mode 100644
index 0000000..6101473
--- /dev/null
+++ b/src/lib/asiolink/tests/io_endpoint_unittest.cc
@@ -0,0 +1,68 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#include <config.h>
+#include <gtest/gtest.h>
+
+#include <asiolink/io_endpoint.h>
+#include <asiolink/io_error.h>
+
+using namespace asiolink;
+
+TEST(IOEndpointTest, createUDPv4) {
+ const IOEndpoint* ep;
+ ep = IOEndpoint::create(IPPROTO_UDP, IOAddress("192.0.2.1"), 53210);
+ EXPECT_EQ("192.0.2.1", ep->getAddress().toText());
+ EXPECT_EQ(53210, ep->getPort());
+ EXPECT_EQ(AF_INET, ep->getFamily());
+ EXPECT_EQ(AF_INET, ep->getAddress().getFamily());
+ EXPECT_EQ(IPPROTO_UDP, ep->getProtocol());
+}
+
+TEST(IOEndpointTest, createTCPv4) {
+ const IOEndpoint* ep;
+ ep = IOEndpoint::create(IPPROTO_TCP, IOAddress("192.0.2.1"), 5301);
+ EXPECT_EQ("192.0.2.1", ep->getAddress().toText());
+ EXPECT_EQ(5301, ep->getPort());
+ EXPECT_EQ(AF_INET, ep->getFamily());
+ EXPECT_EQ(AF_INET, ep->getAddress().getFamily());
+ EXPECT_EQ(IPPROTO_TCP, ep->getProtocol());
+}
+
+TEST(IOEndpointTest, createUDPv6) {
+ const IOEndpoint* ep;
+ ep = IOEndpoint::create(IPPROTO_UDP, IOAddress("2001:db8::1234"), 5302);
+ EXPECT_EQ("2001:db8::1234", ep->getAddress().toText());
+ EXPECT_EQ(5302, ep->getPort());
+ EXPECT_EQ(AF_INET6, ep->getFamily());
+ EXPECT_EQ(AF_INET6, ep->getAddress().getFamily());
+ EXPECT_EQ(IPPROTO_UDP, ep->getProtocol());
+}
+
+TEST(IOEndpointTest, createTCPv6) {
+ const IOEndpoint* ep;
+ ep = IOEndpoint::create(IPPROTO_TCP, IOAddress("2001:db8::1234"), 5303);
+ EXPECT_EQ("2001:db8::1234", ep->getAddress().toText());
+ EXPECT_EQ(5303, ep->getPort());
+ EXPECT_EQ(AF_INET6, ep->getFamily());
+ EXPECT_EQ(AF_INET6, ep->getAddress().getFamily());
+ EXPECT_EQ(IPPROTO_TCP, ep->getProtocol());
+}
+
+TEST(IOEndpointTest, createIPProto) {
+ EXPECT_THROW(IOEndpoint::create(IPPROTO_IP, IOAddress("192.0.2.1"),
+ 53210)->getAddress().toText(),
+ IOError);
+}
+
diff --git a/src/lib/asiolink/tests/io_fetch_unittest.cc b/src/lib/asiolink/tests/io_fetch_unittest.cc
new file mode 100644
index 0000000..9b74ee0
--- /dev/null
+++ b/src/lib/asiolink/tests/io_fetch_unittest.cc
@@ -0,0 +1,191 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#include <gtest/gtest.h>
+#include <boost/bind.hpp>
+#include <cstdlib>
+#include <string>
+#include <vector>
+
+#include <string.h>
+
+#include <asio.hpp>
+
+#include <dns/buffer.h>
+#include <dns/question.h>
+#include <dns/message.h>
+#include <dns/messagerenderer.h>
+#include <dns/opcode.h>
+#include <dns/name.h>
+#include <dns/rcode.h>
+
+#include <asiolink/io_fetch.h>
+#include <asiolink/io_service.h>
+
+using namespace asio;
+using namespace isc::dns;
+using asio::ip::udp;
+
+namespace asiolink {
+
+const asio::ip::address TEST_HOST(asio::ip::address::from_string("127.0.0.1"));
+const uint16_t TEST_PORT(5301);
+// FIXME Shouldn't we send something that is real message?
+const char TEST_DATA[] = "TEST DATA";
+
+/// \brief Test fixture for the asiolink::IOFetch.
+class IOFetchTest : public virtual ::testing::Test, public virtual IOFetch::Callback
+{
+public:
+ IOService service_; ///< Service to run the query
+ IOFetch::Result expected_; ///< Expected result of the callback
+ bool run_; ///< Did the callback run already?
+ Question question_; ///< What to ask
+ OutputBufferPtr buff_; ///< Buffer to hold result
+ IOFetch udp_fetch_; ///< For UDP query test
+ //IOFetch tcp_fetch_; ///< For TCP query test
+
+ // The next member is the buffer iin which the "server" (implemented by the
+ // response handler method) receives the question sent by the fetch object.
+ std::vector<char> server_buff_; ///< Server buffer
+
+ /// \brief Constructor
+ IOFetchTest() :
+ service_(),
+ expected_(IOFetch::NOTSET),
+ run_(false),
+ question_(Name("example.net"), RRClass::IN(), RRType::A()),
+ buff_(new OutputBuffer(512)),
+ udp_fetch_(IPPROTO_UDP, service_, question_, IOAddress(TEST_HOST),
+ TEST_PORT, buff_, this, 100),
+ server_buff_(512)
+ // tcp_fetch_(service_, question_, IOAddress(TEST_HOST), TEST_PORT,
+ // buff_, this, 100, IPPROTO_UDP)
+ { }
+
+ /// \brief Fetch completion callback
+ ///
+ /// This is the callback's operator() method which is called when the fetch
+ /// is complete. Check that the data received is the wire format of the
+ /// question, then send back an arbitrary response.
+ void operator()(IOFetch::Result result) {
+ EXPECT_EQ(expected_, result); // Check correct result returned
+ EXPECT_FALSE(run_); // Check it is run only once
+ run_ = true; // Note success
+ service_.stop(); // ... and exit run loop
+ }
+
+ /// \brief Response handler, pretending to be remote DNS server
+ ///
+ /// This checks that the data sent is what we expected to receive, and
+ /// sends back a test answer.
+ void respond(udp::endpoint* remote, udp::socket* socket,
+ asio::error_code ec = asio::error_code(), size_t length = 0) {
+
+ // Construct the data buffer for question we expect to receive.
+ OutputBuffer msgbuf(512);
+ Message msg(Message::RENDER);
+ msg.setQid(0);
+ msg.setOpcode(Opcode::QUERY());
+ msg.setRcode(Rcode::NOERROR());
+ msg.setHeaderFlag(Message::HEADERFLAG_RD);
+ msg.addQuestion(question_);
+ MessageRenderer renderer(msgbuf);
+ msg.toWire(renderer);
+
+ // The QID in the incoming data is random so set it to 0 for the
+ // data comparison check. (It was set to 0 when the buffer containing
+ // the expected data was constructed above.)
+ server_buff_[0] = 0;
+ server_buff_[1] = 0;
+
+ // Check that lengths are identical.
+ EXPECT_EQ(msgbuf.getLength(), length);
+ EXPECT_TRUE(memcmp(msgbuf.getData(), &server_buff_[0], length) == 0);
+
+ // ... and return a message back.
+ socket->send_to(asio::buffer(TEST_DATA, sizeof TEST_DATA), *remote);
+ }
+};
+
+
+/// Test that when we run the query and stop it after it was run,
+/// it returns "stopped" correctly.
+///
+/// That is why stop() is posted to the service_ as well instead
+/// of calling it.
+TEST_F(IOFetchTest, UdpStop) {
+ expected_ = IOFetch::STOPPED;
+
+ // Post the query
+ service_.get_io_service().post(udp_fetch_);
+
+ // Post query_.stop() (yes, the boost::bind thing is just
+ // query_.stop()).
+ service_.get_io_service().post(
+ boost::bind(&IOFetch::stop, udp_fetch_, IOFetch::STOPPED));
+
+ // Run both of them. run() returns when everything in the I/O service
+ // queue has completed.
+ service_.run();
+ EXPECT_TRUE(run_);
+}
+
+// Test that when we queue the query to service_ and call stop() before it gets
+// executed, it acts sanely as well (eg. has the same result as running stop()
+// after - calls the callback).
+TEST_F(IOFetchTest, UdpPrematureStop) {
+ expected_ = IOFetch::STOPPED;
+
+ // Stop before it is started
+ udp_fetch_.stop();
+ service_.get_io_service().post(udp_fetch_);
+
+ service_.run();
+ EXPECT_TRUE(run_);
+}
+
+// Test that it will timeout when no answer arrives.
+TEST_F(IOFetchTest, UdpTimeout) {
+ expected_ = IOFetch::TIME_OUT;
+
+ service_.get_io_service().post(udp_fetch_);
+ service_.run();
+ EXPECT_TRUE(run_);
+}
+
+// Test that it will succeed when we fake an answer and stores the same data we
+// send. This is done through a real socket on the loopback address.
+TEST_F(IOFetchTest, UdpReceive) {
+ expected_ = IOFetch::SUCCESS;
+
+ udp::socket socket(service_.get_io_service(), udp::v4());
+ socket.set_option(socket_base::reuse_address(true));
+ socket.bind(udp::endpoint(TEST_HOST, TEST_PORT));
+
+ udp::endpoint remote;
+ socket.async_receive_from(asio::buffer(server_buff_),
+ remote,
+ boost::bind(&IOFetchTest::respond, this, &remote, &socket, _1, _2));
+ service_.get_io_service().post(udp_fetch_);
+ service_.run();
+
+ socket.close();
+
+ EXPECT_TRUE(run_);
+ ASSERT_EQ(sizeof TEST_DATA, buff_->getLength());
+ EXPECT_EQ(0, memcmp(TEST_DATA, buff_->getData(), sizeof TEST_DATA));
+}
+
+} // namespace asiolink
diff --git a/src/lib/asiolink/tests/io_service_unittest.cc b/src/lib/asiolink/tests/io_service_unittest.cc
index 49aa67e..779d03e 100644
--- a/src/lib/asiolink/tests/io_service_unittest.cc
+++ b/src/lib/asiolink/tests/io_service_unittest.cc
@@ -15,6 +15,7 @@
#include <config.h>
#include <gtest/gtest.h>
+#include <asio.hpp>
#include <asiolink/asiolink.h>
using namespace asiolink;
@@ -27,7 +28,7 @@ const char* const TEST_IPV4_ADDR = "127.0.0.1";
TEST(IOServiceTest, badPort) {
IOService io_service;
EXPECT_THROW(DNSService(io_service, *"65536", true, false, NULL, NULL, NULL), IOError);
- EXPECT_THROW(DNSService(io_service, *"5300.0", true, false, NULL, NULL, NULL), IOError);
+ EXPECT_THROW(DNSService(io_service, *"53210.0", true, false, NULL, NULL, NULL), IOError);
EXPECT_THROW(DNSService(io_service, *"-1", true, false, NULL, NULL, NULL), IOError);
EXPECT_THROW(DNSService(io_service, *"domain", true, false, NULL, NULL, NULL), IOError);
}
diff --git a/src/lib/asiolink/tests/io_socket_unittest.cc b/src/lib/asiolink/tests/io_socket_unittest.cc
new file mode 100644
index 0000000..6538550
--- /dev/null
+++ b/src/lib/asiolink/tests/io_socket_unittest.cc
@@ -0,0 +1,32 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#include <config.h>
+#include <gtest/gtest.h>
+
+#include <netinet/in.h>
+
+#include <asio.hpp>
+#include <asiolink/io_socket.h>
+
+using namespace asiolink;
+
+TEST(IOSocketTest, dummySockets) {
+ EXPECT_EQ(IPPROTO_UDP, IOSocket::getDummyUDPSocket().getProtocol());
+ EXPECT_EQ(IPPROTO_TCP, IOSocket::getDummyTCPSocket().getProtocol());
+ EXPECT_EQ(-1, IOSocket::getDummyUDPSocket().getNative());
+ EXPECT_EQ(-1, IOSocket::getDummyTCPSocket().getNative());
+}
+
+
diff --git a/src/lib/asiolink/tests/ioaddress_unittest.cc b/src/lib/asiolink/tests/ioaddress_unittest.cc
deleted file mode 100644
index 57c9496..0000000
--- a/src/lib/asiolink/tests/ioaddress_unittest.cc
+++ /dev/null
@@ -1,57 +0,0 @@
-// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
-//
-// Permission to use, copy, modify, and/or distribute this software for any
-// purpose with or without fee is hereby granted, provided that the above
-// copyright notice and this permission notice appear in all copies.
-//
-// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
-// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
-// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
-// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-// PERFORMANCE OF THIS SOFTWARE.
-
-#include <config.h>
-#include <gtest/gtest.h>
-
-#include <asiolink/asiolink.h>
-
-using namespace asiolink;
-
-TEST(IOAddressTest, fromText) {
- IOAddress io_address_v4("192.0.2.1");
- EXPECT_EQ("192.0.2.1", io_address_v4.toText());
-
- IOAddress io_address_v6("2001:db8::1234");
- EXPECT_EQ("2001:db8::1234", io_address_v6.toText());
-
- // bogus IPv4 address-like input
- EXPECT_THROW(IOAddress("192.0.2.2.1"), IOError);
-
- // bogus IPv4 address-like input: out-of-range octet
- EXPECT_THROW(IOAddress("192.0.2.300"), IOError);
-
- // bogus IPv6 address-like input
- EXPECT_THROW(IOAddress("2001:db8:::1234"), IOError);
-
- // bogus IPv6 address-like input
- EXPECT_THROW(IOAddress("2001:db8::efgh"), IOError);
-}
-
-TEST(IOAddressTest, Equality) {
- EXPECT_TRUE(IOAddress("192.0.2.1") == IOAddress("192.0.2.1"));
- EXPECT_FALSE(IOAddress("192.0.2.1") != IOAddress("192.0.2.1"));
-
- EXPECT_TRUE(IOAddress("192.0.2.1") != IOAddress("192.0.2.2"));
- EXPECT_FALSE(IOAddress("192.0.2.1") == IOAddress("192.0.2.2"));
-
- EXPECT_TRUE(IOAddress("2001:db8::12") == IOAddress("2001:0DB8:0:0::0012"));
- EXPECT_FALSE(IOAddress("2001:db8::12") != IOAddress("2001:0DB8:0:0::0012"));
-
- EXPECT_TRUE(IOAddress("2001:db8::1234") != IOAddress("2001:db8::1235"));
- EXPECT_FALSE(IOAddress("2001:db8::1234") == IOAddress("2001:db8::1235"));
-
- EXPECT_TRUE(IOAddress("2001:db8::1234") != IOAddress("192.0.2.3"));
- EXPECT_FALSE(IOAddress("2001:db8::1234") == IOAddress("192.0.2.3"));
-}
diff --git a/src/lib/asiolink/tests/ioendpoint_unittest.cc b/src/lib/asiolink/tests/ioendpoint_unittest.cc
deleted file mode 100644
index a5b5cd2..0000000
--- a/src/lib/asiolink/tests/ioendpoint_unittest.cc
+++ /dev/null
@@ -1,67 +0,0 @@
-// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
-//
-// Permission to use, copy, modify, and/or distribute this software for any
-// purpose with or without fee is hereby granted, provided that the above
-// copyright notice and this permission notice appear in all copies.
-//
-// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
-// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
-// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
-// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-// PERFORMANCE OF THIS SOFTWARE.
-
-#include <config.h>
-#include <gtest/gtest.h>
-
-#include <asiolink/asiolink.h>
-
-using namespace asiolink;
-
-TEST(IOEndpointTest, createUDPv4) {
- const IOEndpoint* ep;
- ep = IOEndpoint::create(IPPROTO_UDP, IOAddress("192.0.2.1"), 5300);
- EXPECT_EQ("192.0.2.1", ep->getAddress().toText());
- EXPECT_EQ(5300, ep->getPort());
- EXPECT_EQ(AF_INET, ep->getFamily());
- EXPECT_EQ(AF_INET, ep->getAddress().getFamily());
- EXPECT_EQ(IPPROTO_UDP, ep->getProtocol());
-}
-
-TEST(IOEndpointTest, createTCPv4) {
- const IOEndpoint* ep;
- ep = IOEndpoint::create(IPPROTO_TCP, IOAddress("192.0.2.1"), 5301);
- EXPECT_EQ("192.0.2.1", ep->getAddress().toText());
- EXPECT_EQ(5301, ep->getPort());
- EXPECT_EQ(AF_INET, ep->getFamily());
- EXPECT_EQ(AF_INET, ep->getAddress().getFamily());
- EXPECT_EQ(IPPROTO_TCP, ep->getProtocol());
-}
-
-TEST(IOEndpointTest, createUDPv6) {
- const IOEndpoint* ep;
- ep = IOEndpoint::create(IPPROTO_UDP, IOAddress("2001:db8::1234"), 5302);
- EXPECT_EQ("2001:db8::1234", ep->getAddress().toText());
- EXPECT_EQ(5302, ep->getPort());
- EXPECT_EQ(AF_INET6, ep->getFamily());
- EXPECT_EQ(AF_INET6, ep->getAddress().getFamily());
- EXPECT_EQ(IPPROTO_UDP, ep->getProtocol());
-}
-
-TEST(IOEndpointTest, createTCPv6) {
- const IOEndpoint* ep;
- ep = IOEndpoint::create(IPPROTO_TCP, IOAddress("2001:db8::1234"), 5303);
- EXPECT_EQ("2001:db8::1234", ep->getAddress().toText());
- EXPECT_EQ(5303, ep->getPort());
- EXPECT_EQ(AF_INET6, ep->getFamily());
- EXPECT_EQ(AF_INET6, ep->getAddress().getFamily());
- EXPECT_EQ(IPPROTO_TCP, ep->getProtocol());
-}
-
-TEST(IOEndpointTest, createIPProto) {
- EXPECT_THROW(IOEndpoint::create(IPPROTO_IP, IOAddress("192.0.2.1"),
- 5300)->getAddress().toText(),
- IOError);
-}
-
diff --git a/src/lib/asiolink/tests/iosocket_unittest.cc b/src/lib/asiolink/tests/iosocket_unittest.cc
deleted file mode 100644
index 06ae861..0000000
--- a/src/lib/asiolink/tests/iosocket_unittest.cc
+++ /dev/null
@@ -1,29 +0,0 @@
-// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
-//
-// Permission to use, copy, modify, and/or distribute this software for any
-// purpose with or without fee is hereby granted, provided that the above
-// copyright notice and this permission notice appear in all copies.
-//
-// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
-// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
-// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
-// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-// PERFORMANCE OF THIS SOFTWARE.
-
-#include <config.h>
-#include <gtest/gtest.h>
-
-#include <asiolink/asiolink.h>
-
-using namespace asiolink;
-
-TEST(IOSocketTest, dummySockets) {
- EXPECT_EQ(IPPROTO_UDP, IOSocket::getDummyUDPSocket().getProtocol());
- EXPECT_EQ(IPPROTO_TCP, IOSocket::getDummyTCPSocket().getProtocol());
- EXPECT_EQ(-1, IOSocket::getDummyUDPSocket().getNative());
- EXPECT_EQ(-1, IOSocket::getDummyTCPSocket().getNative());
-}
-
-
diff --git a/src/lib/asiolink/tests/recursive_query_unittest.cc b/src/lib/asiolink/tests/recursive_query_unittest.cc
index ad4e5b4..f4fc2ac 100644
--- a/src/lib/asiolink/tests/recursive_query_unittest.cc
+++ b/src/lib/asiolink/tests/recursive_query_unittest.cc
@@ -41,8 +41,13 @@
// if we include asio.hpp unless we specify a special compiler option.
// If we need to test something at the level of underlying ASIO and need
// their definition, that test should go to asiolink/internal/tests.
-#include <asiolink/asiolink.h>
+#include <asiolink/recursive_query.h>
#include <asiolink/io_socket.h>
+#include <asiolink/io_service.h>
+#include <asiolink/io_message.h>
+#include <asiolink/io_error.h>
+#include <asiolink/dns_lookup.h>
+#include <asiolink/simple_callback.h>
using isc::UnitTestUtil;
using namespace std;
@@ -274,6 +279,7 @@ protected:
DNSLookup* lookup = NULL,
DNSAnswer* answer = NULL) :
io_(io_service),
+ done_(false),
message_(new Message(Message::PARSE)),
answer_message_(new Message(Message::RENDER)),
respbuf_(new OutputBuffer(0)),
@@ -407,7 +413,8 @@ protected:
};
RecursiveQueryTest::RecursiveQueryTest() :
- dns_service_(NULL), callback_(NULL), sock_(-1), res_(NULL)
+ dns_service_(NULL), callback_(NULL), callback_protocol_(0),
+ callback_native_(-1), sock_(-1), res_(NULL)
{
io_service_ = new IOService();
setDNSService(true, true);
@@ -480,9 +487,7 @@ TEST_F(RecursiveQueryTest, v4AddServer) {
EXPECT_THROW(sendTCP(AF_INET6), IOError);
}
-TEST_F(RecursiveQueryTest, DISABLED_clearServers) {
- // FIXME: Enable when clearServers actually close the sockets
- // See #388
+TEST_F(RecursiveQueryTest, clearServers) {
setDNSService();
dns_service_->clearServers();
@@ -674,7 +679,7 @@ TEST_F(RecursiveQueryTest, forwardClientTimeout) {
RecursiveQuery query(*dns_service_,
singleAddress(TEST_IPV4_ADDR, port),
singleAddress(TEST_IPV4_ADDR, port),
- 50, 120, 1000, 4);
+ 200, 480, 4000, 4);
Question question(Name("example.net"), RRClass::IN(), RRType::A());
OutputBufferPtr buffer(new OutputBuffer(0));
query.resolve(question, answer, buffer, &server);
@@ -718,7 +723,7 @@ TEST_F(RecursiveQueryTest, forwardLookupTimeout) {
RecursiveQuery query(*dns_service_,
singleAddress(TEST_IPV4_ADDR, port),
singleAddress(TEST_IPV4_ADDR, port),
- 50, 4000, 120, 5);
+ 200, 4000, 480, 5);
Question question(Name("example.net"), RRClass::IN(), RRType::A());
OutputBufferPtr buffer(new OutputBuffer(0));
query.resolve(question, answer, buffer, &server);
diff --git a/src/lib/asiolink/tests/udp_endpoint_unittest.cc b/src/lib/asiolink/tests/udp_endpoint_unittest.cc
new file mode 100644
index 0000000..18135ec
--- /dev/null
+++ b/src/lib/asiolink/tests/udp_endpoint_unittest.cc
@@ -0,0 +1,55 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#include <config.h>
+
+#include <string>
+
+#include <gtest/gtest.h>
+
+#include <asio.hpp>
+#include <asiolink/io_address.h>
+#include <asiolink/udp_endpoint.h>
+
+using namespace asiolink;
+using namespace std;
+
+// This test checks that the endpoint can manage its own internal
+// asio::ip::udp::endpoint object.
+
+TEST(UDPEndpointTest, v4Address) {
+ const string test_address("192.0.2.1");
+ const unsigned short test_port = 5301;
+
+ IOAddress address(test_address);
+ UDPEndpoint endpoint(address, test_port);
+
+ EXPECT_TRUE(address == endpoint.getAddress());
+ EXPECT_EQ(test_port, endpoint.getPort());
+ EXPECT_EQ(IPPROTO_UDP, endpoint.getProtocol());
+ EXPECT_EQ(AF_INET, endpoint.getFamily());
+}
+
+TEST(UDPEndpointTest, v6Address) {
+ const string test_address("2001:db8::1235");
+ const unsigned short test_port = 5302;
+
+ IOAddress address(test_address);
+ UDPEndpoint endpoint(address, test_port);
+
+ EXPECT_TRUE(address == endpoint.getAddress());
+ EXPECT_EQ(test_port, endpoint.getPort());
+ EXPECT_EQ(IPPROTO_UDP, endpoint.getProtocol());
+ EXPECT_EQ(AF_INET6, endpoint.getFamily());
+}
diff --git a/src/lib/asiolink/tests/udp_query_unittest.cc b/src/lib/asiolink/tests/udp_query_unittest.cc
deleted file mode 100644
index 9eb1aba..0000000
--- a/src/lib/asiolink/tests/udp_query_unittest.cc
+++ /dev/null
@@ -1,145 +0,0 @@
-// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
-//
-// Permission to use, copy, modify, and/or distribute this software for any
-// purpose with or without fee is hereby granted, provided that the above
-// copyright notice and this permission notice appear in all copies.
-//
-// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
-// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
-// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
-// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-// PERFORMANCE OF THIS SOFTWARE.
-
-#include <gtest/gtest.h>
-#include <asio.hpp>
-#include <boost/bind.hpp>
-#include <cstdlib>
-
-#include <dns/question.h>
-
-#include <asiolink/udp_query.h>
-
-using namespace asio;
-using namespace isc::dns;
-using asio::ip::udp;
-
-namespace {
-
-const asio::ip::address TEST_HOST(asio::ip::address::from_string("127.0.0.1"));
-const uint16_t TEST_PORT(5301);
-// FIXME Shouldn't we send something that is real message?
-const char TEST_DATA[] = "TEST DATA";
-
-// Test fixture for the asiolink::UDPQuery.
-class UDPQueryTest : public ::testing::Test,
- public asiolink::UDPQuery::Callback
-{
- public:
- // Expected result of the callback
- asiolink::UDPQuery::Result expected_;
- // Did the callback run already?
- bool run_;
- // We use an io_service to run the query
- io_service service_;
- // Something to ask
- Question question_;
- // Buffer where the UDPQuery will store response
- OutputBufferPtr buffer_;
- // The query we are testing
- asiolink::UDPQuery query_;
-
- UDPQueryTest() :
- run_(false),
- question_(Name("example.net"), RRClass::IN(), RRType::A()),
- buffer_(new OutputBuffer(512)),
- query_(service_, question_, asiolink::IOAddress(TEST_HOST),
- TEST_PORT, buffer_, this, 100)
- { }
-
- // This is the callback's (), so it can be called.
- void operator()(asiolink::UDPQuery::Result result) {
- // We check the query returns the correct result
- EXPECT_EQ(expected_, result);
- // Check it is called only once
- EXPECT_FALSE(run_);
- // And mark the callback was called
- run_ = true;
- }
- // A response handler, pretending to be remote DNS server
- void respond(udp::endpoint* remote, udp::socket* socket) {
- // Some data came, just send something back.
- socket->send_to(asio::buffer(TEST_DATA, sizeof TEST_DATA),
- *remote);
- socket->close();
- }
-};
-
-/*
- * Test that when we run the query and stop it after it was run,
- * it returns "stopped" correctly.
- *
- * That is why stop() is posted to the service_ as well instead
- * of calling it.
- */
-TEST_F(UDPQueryTest, stop) {
- expected_ = asiolink::UDPQuery::STOPPED;
- // Post the query
- service_.post(query_);
- // Post query_.stop() (yes, the boost::bind thing is just
- // query_.stop()).
- service_.post(boost::bind(&asiolink::UDPQuery::stop, query_,
- asiolink::UDPQuery::STOPPED));
- // Run both of them
- service_.run();
- EXPECT_TRUE(run_);
-}
-
-/*
- * Test that when we queue the query to service_ and call stop()
- * before it gets executed, it acts sanely as well (eg. has the
- * same result as running stop() after - calls the callback).
- */
-TEST_F(UDPQueryTest, prematureStop) {
- expected_ = asiolink::UDPQuery::STOPPED;
- // Stop before it is started
- query_.stop();
- service_.post(query_);
- service_.run();
- EXPECT_TRUE(run_);
-}
-
-/*
- * Test that it will timeout when no answer will arrive.
- */
-TEST_F(UDPQueryTest, timeout) {
- expected_ = asiolink::UDPQuery::TIME_OUT;
- service_.post(query_);
- service_.run();
- EXPECT_TRUE(run_);
-}
-
-/*
- * Test that it will succeed when we fake an answer and
- * stores the same data we send.
- *
- * This is done through a real socket on loopback address.
- */
-TEST_F(UDPQueryTest, receive) {
- expected_ = asiolink::UDPQuery::SUCCESS;
- udp::socket socket(service_, udp::v4());
- socket.set_option(socket_base::reuse_address(true));
- socket.bind(udp::endpoint(TEST_HOST, TEST_PORT));
- char inbuff[512];
- udp::endpoint remote;
- socket.async_receive_from(asio::buffer(inbuff, 512), remote, boost::bind(
- &UDPQueryTest::respond, this, &remote, &socket));
- service_.post(query_);
- service_.run();
- EXPECT_TRUE(run_);
- ASSERT_EQ(sizeof TEST_DATA, buffer_->getLength());
- EXPECT_EQ(0, memcmp(TEST_DATA, buffer_->getData(), sizeof TEST_DATA));
-}
-
-}
diff --git a/src/lib/asiolink/tests/udp_socket_unittest.cc b/src/lib/asiolink/tests/udp_socket_unittest.cc
new file mode 100644
index 0000000..bb79b88
--- /dev/null
+++ b/src/lib/asiolink/tests/udp_socket_unittest.cc
@@ -0,0 +1,287 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+
+/// \brief Test of UDPSocket
+///
+/// Tests the fuctionality of a UDPSocket by working through an open-send-
+/// receive-close sequence and checking that the asynchronous notifications
+/// work.
+
+#include <string>
+
+#include <arpa/inet.h>
+#include <netinet/in.h>
+#include <sys/types.h>
+#include <sys/socket.h>
+
+#include <algorithm>
+#include <cstdlib>
+#include <cstddef>
+#include <vector>
+
+#include <gtest/gtest.h>
+
+#include <boost/bind.hpp>
+#include <boost/shared_ptr.hpp>
+
+#include <asio.hpp>
+
+#include <asiolink/io_service.h>
+#include <asiolink/udp_endpoint.h>
+#include <asiolink/udp_socket.h>
+
+using namespace asio;
+using namespace asiolink;
+using namespace std;
+
+namespace {
+
+const char SERVER_ADDRESS[] = "127.0.0.1";
+const unsigned short SERVER_PORT = 5301;
+
+// TODO: Shouldn't we send something that is real message?
+const char OUTBOUND_DATA[] = "Data sent from client to server";
+const char INBOUND_DATA[] = "Returned data from server to client";
+}
+
+///
+/// An instance of this object is passed to the asynchronous I/O functions
+/// and the operator() method is called when when an asynchronous I/O
+/// completes. The arguments to the completion callback are stored for later
+/// retrieval.
+class UDPCallback {
+public:
+
+ struct PrivateData {
+ PrivateData() :
+ error_code_(), length_(0), called_(false), name_("")
+ {}
+
+ asio::error_code error_code_; ///< Completion error code
+ size_t length_; ///< Number of bytes transferred
+ bool called_; ///< Set true when callback called
+ std::string name_; ///< Which of the objects this is
+ };
+
+ /// \brief Constructor
+ ///
+ /// Constructs the object. It also creates the data member pointed to by
+ /// a shared pointer. When used as a callback object, this is copied as it
+ /// is passed into the asynchronous function. This means that there are two
+ /// objects and inspecting the one we passed in does not tell us anything.
+ ///
+ /// Therefore we use a boost::shared_ptr. When the object is copied, the
+ /// shared pointer is copied, which leaves both objects pointing to the same
+ /// data.
+ ///
+ /// \param which Which of the two callback objects this is
+ UDPCallback(std::string which) : ptr_(new PrivateData())
+ {
+ setName(which);
+ }
+
+ /// \brief Destructor
+ ///
+ /// No code needed, destroying the shared pointer destroys the private data.
+ virtual ~UDPCallback()
+ {}
+
+ /// \brief Callback Function
+ ///
+ /// Called when an asynchronous I/O completes, this stores the
+ /// completion error code and the number of bytes transferred.
+ ///
+ /// \param ec I/O completion error code passed to callback function.
+ /// \param length Number of bytes transferred
+ virtual void operator()(asio::error_code ec, size_t length = 0) {
+ ptr_->error_code_ = ec;
+ setLength(length);
+ setCalled(true);
+ }
+
+ /// \brief Get I/O completion error code
+ int getCode() {
+ return (ptr_->error_code_.value());
+ }
+
+ /// \brief Set I/O completion code
+ ///
+ /// \param code New value of completion code
+ void setCode(int code) {
+ ptr_->error_code_ = asio::error_code(code, asio::error_code().category());
+ }
+
+ /// \brief Get number of bytes transferred in I/O
+ size_t getLength() const {
+ return (ptr_->length_);
+ }
+
+ /// \brief Set number of bytes transferred in I/O
+ ///
+ /// \param length New value of length parameter
+ void setLength(size_t length) {
+ ptr_->length_ = length;
+ }
+
+ /// \brief Get flag to say when callback was called
+ bool getCalled() const {
+ return (ptr_->called_);
+ }
+
+ /// \brief Set flag to say when callback was called
+ ///
+ /// \param called New value of called parameter
+ void setCalled(bool called) {
+ ptr_->called_ = called;
+ }
+
+ /// \brief Return instance of callback name
+ std::string getName() const {
+ return (ptr_->name_);
+ }
+
+ /// \brief Set callback name
+ ///
+ /// \param name New value of the callback name
+ void setName(const std::string& name) {
+ ptr_->name_ = name;
+ }
+
+private:
+ boost::shared_ptr<PrivateData> ptr_; ///< Pointer to private data
+};
+
+// TODO: Need to add a test to check the cancel() method
+
+// Tests the operation of a UDPSocket by opening it, sending an asynchronous
+// message to a server, receiving an asynchronous message from the server and
+// closing.
+TEST(UDPSocket, SequenceTest) {
+
+ // Common objects.
+ IOService service; // Service object for async control
+
+ // Server
+ IOAddress server_address(SERVER_ADDRESS); // Address of target server
+ UDPCallback server_cb("Server"); // Server callback
+ UDPEndpoint server_endpoint( // Endpoint describing server
+ server_address, SERVER_PORT);
+ UDPEndpoint server_remote_endpoint; // Address where server received message from
+
+ // The client - the UDPSocket being tested
+ UDPSocket<UDPCallback> client(service);// Socket under test
+ UDPCallback client_cb("Client"); // Async I/O callback function
+ UDPEndpoint client_remote_endpoint; // Where client receives message from
+ size_t client_cumulative = 0; // Cumulative data received
+
+ // The server - with which the client communicates. For convenience, we
+ // use the same io_service, and use the endpoint object created for
+ // the client to send to as the endpoint object in the constructor.
+ asio::ip::udp::socket server(service.get_io_service(),
+ server_endpoint.getASIOEndpoint());
+ server.set_option(socket_base::reuse_address(true));
+
+ // Assertion to ensure that the server buffer is large enough
+ char data[UDPSocket<UDPCallback>::MAX_SIZE];
+ ASSERT_GT(sizeof(data), sizeof(OUTBOUND_DATA));
+
+ // Open the client socket - the operation should be synchronous
+ EXPECT_FALSE(client.open(&server_endpoint, client_cb));
+
+ // Issue read on the server. Completion callback should not have run.
+ server_cb.setCalled(false);
+ server_cb.setCode(42); // Answer to Life, the Universe and Everything!
+ server.async_receive_from(buffer(data, sizeof(data)),
+ server_remote_endpoint.getASIOEndpoint(), server_cb);
+ EXPECT_FALSE(server_cb.getCalled());
+
+ // Write something to the server using the client - the callback should not
+ // be called until we call the io_service.run() method.
+ client_cb.setCalled(false);
+ client_cb.setCode(7); // Arbitrary number
+ client.asyncSend(OUTBOUND_DATA, sizeof(OUTBOUND_DATA), &server_endpoint, client_cb);
+ EXPECT_FALSE(client_cb.getCalled());
+
+ // Execute the two callbacks.
+ service.run_one();
+ service.run_one();
+
+ EXPECT_TRUE(client_cb.getCalled());
+ EXPECT_EQ(0, client_cb.getCode());
+ EXPECT_EQ(sizeof(OUTBOUND_DATA), client_cb.getLength());
+
+ EXPECT_TRUE(server_cb.getCalled());
+ EXPECT_EQ(0, server_cb.getCode());
+ EXPECT_EQ(sizeof(OUTBOUND_DATA), server_cb.getLength());
+
+ EXPECT_TRUE(equal(&data[0], &data[server_cb.getLength() - 1], OUTBOUND_DATA));
+
+ // Now return data from the server to the client. Issue the read on the
+ // client.
+ client_cb.setLength(12345); // Arbitrary number
+ client_cb.setCalled(false);
+ client_cb.setCode(32); // Arbitrary number
+ client.asyncReceive(data, sizeof(data), client_cumulative,
+ &client_remote_endpoint, client_cb);
+
+ // Issue the write on the server side to the source of the data it received.
+ server_cb.setLength(22345); // Arbitrary number
+ server_cb.setCalled(false);
+ server_cb.setCode(232); // Arbitrary number
+ server.async_send_to(buffer(INBOUND_DATA, sizeof(INBOUND_DATA)),
+ server_remote_endpoint.getASIOEndpoint(), server_cb);
+
+ // Expect the two callbacks to run
+ service.run_one();
+ service.run_one();
+
+ EXPECT_TRUE(client_cb.getCalled());
+ EXPECT_EQ(0, client_cb.getCode());
+ EXPECT_EQ(sizeof(INBOUND_DATA), client_cb.getLength());
+
+ EXPECT_TRUE(server_cb.getCalled());
+ EXPECT_EQ(0, server_cb.getCode());
+ EXPECT_EQ(sizeof(INBOUND_DATA), server_cb.getLength());
+
+ EXPECT_TRUE(equal(&data[0], &data[server_cb.getLength() - 1], INBOUND_DATA));
+
+ // Check that the address/port received by the client corresponds to the
+ // address and port the server is listening on.
+ EXPECT_TRUE(server_address == client_remote_endpoint.getAddress());
+ EXPECT_EQ(SERVER_PORT, client_remote_endpoint.getPort());
+
+ // Finally, check that the receive received a complete buffer's worth of data.
+ EXPECT_TRUE(client.receiveComplete(&data[0], client_cb.getLength(),
+ client_cumulative));
+ EXPECT_EQ(client_cb.getLength(), client_cumulative);
+
+ // Close client and server.
+ EXPECT_NO_THROW(client.close());
+ EXPECT_NO_THROW(server.close());
+}
diff --git a/src/lib/asiolink/udp_endpoint.h b/src/lib/asiolink/udp_endpoint.h
index 27541e0..0958af6 100644
--- a/src/lib/asiolink/udp_endpoint.h
+++ b/src/lib/asiolink/udp_endpoint.h
@@ -33,6 +33,16 @@ public:
/// \name Constructors and Destructor.
///
//@{
+
+ /// \brief Default Constructor
+ ///
+ /// Creates an internal endpoint. This is expected to be set by some
+ /// external call.
+ UDPEndpoint() :
+ asio_endpoint_placeholder_(new asio::ip::udp::endpoint()),
+ asio_endpoint_(*asio_endpoint_placeholder_)
+ {}
+
/// \brief Constructor from a pair of address and port.
///
/// \param address The IP address of the endpoint.
@@ -50,27 +60,27 @@ public:
/// corresponding ASIO class, \c udp::endpoint.
///
/// \param asio_endpoint The ASIO representation of the UDP endpoint.
- UDPEndpoint(const asio::ip::udp::endpoint& asio_endpoint) :
+ UDPEndpoint(asio::ip::udp::endpoint& asio_endpoint) :
asio_endpoint_placeholder_(NULL), asio_endpoint_(asio_endpoint)
{}
/// \brief The destructor.
- ~UDPEndpoint() { delete asio_endpoint_placeholder_; }
+ virtual ~UDPEndpoint() { delete asio_endpoint_placeholder_; }
//@}
- inline IOAddress getAddress() const {
+ virtual IOAddress getAddress() const {
return (asio_endpoint_.address());
}
- inline uint16_t getPort() const {
+ virtual uint16_t getPort() const {
return (asio_endpoint_.port());
}
- inline short getProtocol() const {
+ virtual short getProtocol() const {
return (asio_endpoint_.protocol().protocol());
}
- inline short getFamily() const {
+ virtual short getFamily() const {
return (asio_endpoint_.protocol().family());
}
@@ -79,10 +89,13 @@ public:
inline const asio::ip::udp::endpoint& getASIOEndpoint() const {
return (asio_endpoint_);
}
+ inline asio::ip::udp::endpoint& getASIOEndpoint() {
+ return (asio_endpoint_);
+ }
private:
- const asio::ip::udp::endpoint* asio_endpoint_placeholder_;
- const asio::ip::udp::endpoint& asio_endpoint_;
+ asio::ip::udp::endpoint* asio_endpoint_placeholder_;
+ asio::ip::udp::endpoint& asio_endpoint_;
};
} // namespace asiolink
diff --git a/src/lib/asiolink/udp_query.cc b/src/lib/asiolink/udp_query.cc
deleted file mode 100644
index a793814..0000000
--- a/src/lib/asiolink/udp_query.cc
+++ /dev/null
@@ -1,189 +0,0 @@
-// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
-//
-// Permission to use, copy, modify, and/or distribute this software for any
-// purpose with or without fee is hereby granted, provided that the above
-// copyright notice and this permission notice appear in all copies.
-//
-// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
-// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
-// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
-// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-// PERFORMANCE OF THIS SOFTWARE.
-
-#include <config.h>
-
-// unistd is needed for asio.hpp with SunStudio
-#include <unistd.h>
-
-#include <asio.hpp>
-
-#include <boost/bind.hpp>
-#include <boost/shared_array.hpp>
-
-#include <dns/messagerenderer.h>
-#include <dns/opcode.h>
-#include <dns/rcode.h>
-
-#include <log/dummylog.h>
-
-#include <asio.hpp>
-
-#include <asiolink.h>
-
-#include <coroutine.h>
-#include <asiolink/udp_endpoint.h>
-
-#include <asiolink/udp_query.h>
-
-using namespace asio;
-using asio::ip::udp;
-using asio::ip::tcp;
-using isc::log::dlog;
-
-using namespace std;
-using namespace isc::dns;
-
-namespace asiolink {
-
-
-// Private UDPQuery data (see internal/udpdns.h for reasons)
-struct UDPQuery::PrivateData {
- // Socket we send query to and expect reply from there
- udp::socket socket;
- // Where was the query sent
- udp::endpoint remote;
- // What we ask the server
- Question question;
- // We will store the answer here
- OutputBufferPtr buffer;
- OutputBufferPtr msgbuf;
- // Temporary buffer for answer
- boost::shared_array<char> data;
- // This will be called when the data arrive or timeouts
- Callback* callback;
- // Did we already stop operating (data arrived, we timed out, someone
- // called stop). This can be so when we are cleaning up/there are
- // still pointers to us.
- bool stopped;
- // Timer to measure timeouts.
- deadline_timer timer;
- // How many milliseconds are we willing to wait for answer?
- int timeout;
-
- PrivateData(io_service& service,
- const udp::socket::protocol_type& protocol, const Question &q,
- OutputBufferPtr b, Callback *c) :
- socket(service, protocol),
- question(q),
- buffer(b),
- msgbuf(new OutputBuffer(512)),
- callback(c),
- stopped(false),
- timer(service)
- { }
-};
-
-/// The following functions implement the \c UDPQuery class.
-///
-/// The constructor
-UDPQuery::UDPQuery(io_service& io_service,
- const Question& q, const IOAddress& addr, uint16_t port,
- OutputBufferPtr buffer, Callback *callback, int timeout) :
- data_(new PrivateData(io_service,
- addr.getFamily() == AF_INET ? udp::v4() : udp::v6(), q, buffer,
- callback))
-{
- data_->remote = UDPEndpoint(addr, port).getASIOEndpoint();
- data_->timeout = timeout;
-}
-
-/// The function operator is implemented with the "stackless coroutine"
-/// pattern; see internal/coroutine.h for details.
-void
-UDPQuery::operator()(error_code ec, size_t length) {
- if (ec || data_->stopped) {
- return;
- }
-
- CORO_REENTER (this) {
- /// Generate the upstream query and render it to wire format
- /// This is done in a different scope to allow inline variable
- /// declarations.
- {
- Message msg(Message::RENDER);
-
- // XXX: replace with boost::random or some other suitable PRNG
- msg.setQid(0);
- msg.setOpcode(Opcode::QUERY());
- msg.setRcode(Rcode::NOERROR());
- msg.setHeaderFlag(Message::HEADERFLAG_RD);
- msg.addQuestion(data_->question);
- MessageRenderer renderer(*data_->msgbuf);
- msg.toWire(renderer);
- dlog("Sending " + msg.toText() + " to " +
- data_->remote.address().to_string());
- }
-
-
- // If we timeout, we stop, which will shutdown everything and
- // cancel all other attempts to run inside the coroutine
- if (data_->timeout != -1) {
- data_->timer.expires_from_now(boost::posix_time::milliseconds(
- data_->timeout));
- data_->timer.async_wait(boost::bind(&UDPQuery::stop, *this,
- TIME_OUT));
- }
-
- // Begin an asynchronous send, and then yield. When the
- // send completes, we will resume immediately after this point.
- CORO_YIELD data_->socket.async_send_to(buffer(data_->msgbuf->getData(),
- data_->msgbuf->getLength()), data_->remote, *this);
-
- /// Allocate space for the response. (XXX: This should be
- /// optimized by maintaining a free list of pre-allocated blocks)
- data_->data.reset(new char[MAX_LENGTH]);
-
- /// Begin an asynchronous receive, and yield. When the receive
- /// completes, we will resume immediately after this point.
- CORO_YIELD data_->socket.async_receive_from(buffer(data_->data.get(),
- MAX_LENGTH), data_->remote, *this);
- // The message is not rendered yet, so we can't print it easilly
- dlog("Received response from " + data_->remote.address().to_string());
-
- /// Copy the answer into the response buffer. (XXX: If the
- /// OutputBuffer object were made to meet the requirements of
- /// a MutableBufferSequence, then it could be written to directly
- /// by async_recieve_from() and this additional copy step would
- /// be unnecessary.)
- data_->buffer->writeData(data_->data.get(), length);
-
- /// We are done
- stop(SUCCESS);
- }
-}
-
-void
-UDPQuery::stop(Result result) {
- if (!data_->stopped) {
- switch (result) {
- case TIME_OUT:
- dlog("Query timed out");
- break;
- case STOPPED:
- dlog("Query stopped");
- break;
- default:;
- }
- data_->stopped = true;
- data_->socket.cancel();
- data_->socket.close();
- data_->timer.cancel();
- if (data_->callback) {
- (*data_->callback)(result);
- }
- }
-}
-
-} // namespace asiolink
diff --git a/src/lib/asiolink/udp_query.h b/src/lib/asiolink/udp_query.h
deleted file mode 100644
index 3ed44ad..0000000
--- a/src/lib/asiolink/udp_query.h
+++ /dev/null
@@ -1,88 +0,0 @@
-// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
-//
-// Permission to use, copy, modify, and/or distribute this software for any
-// purpose with or without fee is hereby granted, provided that the above
-// copyright notice and this permission notice appear in all copies.
-//
-// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
-// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
-// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
-// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-// PERFORMANCE OF THIS SOFTWARE.
-
-#ifndef __UDP_QUERY_H
-#define __UDP_QUERY_H 1
-
-#ifndef ASIO_HPP
-#error "asio.hpp must be included before including this, see asiolink.h as to why"
-#endif
-
-#include <dns/buffer.h>
-
-#include <asiolink/io_address.h>
-#include <coroutine.h>
-
-namespace asiolink {
-
-//
-// Asynchronous UDP coroutine for upstream queries
-//
-class UDPQuery : public coroutine {
-public:
- // TODO Maybe this should be more generic than just for UDPQuery?
- ///
- /// \brief Result of the query
- ///
- /// This is related only to contacting the remote server. If the answer
- ///indicates error, it is still counted as SUCCESS here, if it comes back.
- ///
- enum Result {
- SUCCESS,
- TIME_OUT,
- STOPPED
- };
- /// Abstract callback for the UDPQuery.
- class Callback {
- public:
- virtual ~Callback() {}
-
- /// This will be called when the UDPQuery is completed
- virtual void operator()(Result result) = 0;
- };
- ///
- /// \brief Constructor.
- ///
- /// It creates the query.
- /// @param callback will be called when we terminate. It is your task to
- /// delete it if allocated on heap.
- ///@param timeout in ms.
- ///
- explicit UDPQuery(asio::io_service& io_service,
- const isc::dns::Question& q,
- const IOAddress& addr, uint16_t port,
- isc::dns::OutputBufferPtr buffer,
- Callback* callback, int timeout = -1);
- void operator()(asio::error_code ec = asio::error_code(),
- size_t length = 0);
- /// Terminate the query.
- void stop(Result reason = STOPPED);
-private:
- enum { MAX_LENGTH = 4096 };
-
- ///
- /// \short Private data
- ///
- /// They are not private because of stability of the
- /// interface (this is private class anyway), but because this class
- /// will be copyed often (it is used as a coroutine and passed as callback
- /// to many async_*() functions) and we want keep the same data. Some of
- /// the data is not copyable too.
- ///
- struct PrivateData;
- boost::shared_ptr<PrivateData> data_;
-};
-
-} // namespace asiolink
-#endif // __UDP_QUERY_H
diff --git a/src/lib/asiolink/udp_server.cc b/src/lib/asiolink/udp_server.cc
index 9a18d76..98a47c4 100644
--- a/src/lib/asiolink/udp_server.cc
+++ b/src/lib/asiolink/udp_server.cc
@@ -12,25 +12,26 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-#include <config.h>
+#include <netinet/in.h>
+#include <sys/socket.h>
+#include <unistd.h> // for some IPC/network system calls
#include <boost/shared_array.hpp>
-// unistd is needed for asio.hpp with SunStudio
-#include <unistd.h>
-
-#include <asio.hpp>
+#include <config.h>
#include <log/dummylog.h>
+#include <asio.hpp>
+#include <asiolink/dummy_io_cb.h>
#include <asiolink/udp_endpoint.h>
+#include <asiolink/udp_server.h>
#include <asiolink/udp_socket.h>
-#include <asiolink/udp_server.h>
+#include <dns/opcode.h>
using namespace asio;
using asio::ip::udp;
-using asio::ip::tcp;
using isc::log::dlog;
using namespace std;
@@ -54,8 +55,9 @@ struct UDPServer::Data {
*/
Data(io_service& io_service, const ip::address& addr, const uint16_t port,
SimpleCallback* checkin, DNSLookup* lookup, DNSAnswer* answer) :
- io_(io_service), done_(false), checkin_callback_(checkin),
- lookup_callback_(lookup), answer_callback_(answer)
+ io_(io_service), done_(false), stopped_by_hand_(false),
+ checkin_callback_(checkin),lookup_callback_(lookup),
+ answer_callback_(answer)
{
// We must use different instantiations for v4 and v6;
// otherwise ASIO will bind to both
@@ -77,6 +79,7 @@ struct UDPServer::Data {
*/
Data(const Data& other) :
io_(other.io_), socket_(other.socket_), done_(false),
+ stopped_by_hand_(false),
checkin_callback_(other.checkin_callback_),
lookup_callback_(other.lookup_callback_),
answer_callback_(other.answer_callback_)
@@ -140,6 +143,9 @@ struct UDPServer::Data {
size_t bytes_;
bool done_;
+ //whether user explicitly stop the server
+ bool stopped_by_hand_;
+
// Callback functions provided by the caller
const SimpleCallback* checkin_callback_;
const DNSLookup* lookup_callback_;
@@ -163,10 +169,16 @@ UDPServer::UDPServer(io_service& io_service, const ip::address& addr,
/// pattern; see internal/coroutine.h for details.
void
UDPServer::operator()(error_code ec, size_t length) {
- /// Because the coroutine reeentry block is implemented as
+ /// Because the coroutine reentry block is implemented as
/// a switch statement, inline variable declarations are not
/// permitted. Certain variables used below can be declared here.
+ /// if user stopped the server, we won't enter the coroutine body
+ /// just return
+ if (data_->stopped_by_hand_) {
+ return;
+ }
+
CORO_REENTER (this) {
do {
/*
@@ -206,7 +218,16 @@ UDPServer::operator()(error_code ec, size_t length) {
// that would quickly generate an IOMessage object without
// all these calls to "new".)
data_->peer_.reset(new UDPEndpoint(*data_->sender_));
- data_->iosock_.reset(new UDPSocket(*data_->socket_));
+
+ // The UDP socket class has been extended with asynchronous functions
+ // and takes as a template parameter a completion callback class. As
+ // UDPServer does not use these extended functions (only those defined
+ // in the IOSocket base class) - but needs a UDPSocket to get hold of
+ // the underlying Boost UDP socket - DummyIOCallback is used. This
+ // provides the appropriate operator() but is otherwise functionless.
+ data_->iosock_.reset(
+ new UDPSocket<DummyIOCallback>(*data_->socket_));
+
data_->io_message_.reset(new IOMessage(data_->data_.get(),
data_->bytes_, *data_->iosock_, *data_->peer_));
@@ -267,6 +288,16 @@ UDPServer::asyncLookup() {
data_->query_message_, data_->answer_message_, data_->respbuf_, this);
}
+/// Stop the UDPServer
+void
+UDPServer::stop() {
+ //server should not be stopped twice
+ if (data_->stopped_by_hand_)
+ return;
+ data_->stopped_by_hand_ = true;
+ data_->socket_->close();
+}
+
/// Post this coroutine on the ASIO service queue so that it will
/// resume processing where it left off. The 'done' parameter indicates
/// whether there is an answer to return to the client.
diff --git a/src/lib/asiolink/udp_server.h b/src/lib/asiolink/udp_server.h
index 16a03dd..1d37471 100644
--- a/src/lib/asiolink/udp_server.h
+++ b/src/lib/asiolink/udp_server.h
@@ -58,6 +58,10 @@ public:
/// \brief Calls the lookup callback
void asyncLookup();
+ /// \brief Stop the running server
+ /// \note once the server stopped, it can't restart
+ void stop();
+
/// \brief Resume operation
///
/// \param done Set this to true if the lookup action is done and
diff --git a/src/lib/asiolink/udp_socket.h b/src/lib/asiolink/udp_socket.h
index 5c641ff..bb94ad5 100644
--- a/src/lib/asiolink/udp_socket.h
+++ b/src/lib/asiolink/udp_socket.h
@@ -19,30 +19,258 @@
#error "asio.hpp must be included before including this, see asiolink.h as to why"
#endif
-#include <asiolink/io_socket.h>
+#include <log/dummylog.h>
+#include <netinet/in.h>
+#include <sys/socket.h>
+#include <unistd.h> // for some IPC/network system calls
+
+#include <cstddef>
+
+#include <config.h>
+
+
+#include <asiolink/io_asio_socket.h>
+#include <asiolink/io_endpoint.h>
+#include <asiolink/io_service.h>
+#include <asiolink/udp_endpoint.h>
namespace asiolink {
-/// \brief The \c UDPSocket class is a concrete derived class of
-/// \c IOSocket that represents a UDP socket.
+/// \brief The \c UDPSocket class is a concrete derived class of \c IOAsioSocket
+/// that represents a UDP socket.
///
-/// Other notes about \c TCPSocket applies to this class, too.
-class UDPSocket : public IOSocket {
+/// \param C Callback type
+template <typename C>
+class UDPSocket : public IOAsioSocket<C> {
private:
- UDPSocket(const UDPSocket& source);
- UDPSocket& operator=(const UDPSocket& source);
+ /// \brief Class is non-copyable
+ UDPSocket(const UDPSocket&);
+ UDPSocket& operator=(const UDPSocket&);
+
public:
+ enum {
+ MAX_SIZE = 4096 // Send and receive size
+ };
+
/// \brief Constructor from an ASIO UDP socket.
///
- /// \param socket The ASIO representation of the UDP socket.
- UDPSocket(asio::ip::udp::socket& socket) : socket_(socket) {}
+ /// \param socket The ASIO representation of the UDP socket. It
+ /// is assumed that the caller will open and close the socket, so
+ /// these operations are a no-op for that socket.
+ UDPSocket(asio::ip::udp::socket& socket);
+
+ /// \brief Constructor
+ ///
+ /// Used when the UDPSocket is being asked to manage its own internal
+ /// socket. It is assumed that open() and close() will not be used.
+ ///
+ /// \param service I/O Service object used to manage the socket.
+ UDPSocket(IOService& service);
+
+ /// \brief Destructor
+ virtual ~UDPSocket();
virtual int getNative() const { return (socket_.native()); }
virtual int getProtocol() const { return (IPPROTO_UDP); }
+ /// \brief Open Socket
+ ///
+ /// Opens the UDP socket. In the model for transport-layer agnostic I/O,
+ /// an "open" operation includes a connection to the remote end (which
+ /// may take time). This does not happen for UDP, so the method returns
+ /// "false" to indicate that the operation completed synchronously.
+ ///
+ /// \param endpoint Endpoint to which the socket will connect to.
+ /// \param callback Unused.
+ ///
+ /// \return false to indicate that the "operation" completed synchronously.
+ virtual bool open(const IOEndpoint* endpoint, C&);
+
+ /// \brief Send Asynchronously
+ ///
+ /// This corresponds to async_send_to() for UDP sockets and async_send()
+ /// for TCP. In both cases an endpoint argument is supplied indicating the
+ /// target of the send - this is ignored for TCP.
+ ///
+ /// \param data Data to send
+ /// \param length Length of data to send
+ /// \param endpoint Target of the send
+ /// \param callback Callback object.
+ virtual void asyncSend(const void* data, size_t length,
+ const IOEndpoint* endpoint, C& callback);
+
+ /// \brief Receive Asynchronously
+ ///
+ /// This correstponds to async_receive_from() for UDP sockets and
+ /// async_receive() for TCP. In both cases, an endpoint argument is
+ /// supplied to receive the source of the communication. For TCP it will
+ /// be filled in with details of the connection.
+ ///
+ /// \param data Buffer to receive incoming message
+ /// \param length Length of the data buffer
+ /// \param cumulative Amount of data that should already be in the buffer.
+ /// (This is ignored - every UPD receive fills the buffer from the start.)
+ /// \param endpoint Source of the communication
+ /// \param callback Callback object
+ virtual void asyncReceive(void* data, size_t length, size_t cumulative,
+ IOEndpoint* endpoint, C& callback);
+
+ /// \brief Checks if the data received is complete.
+ ///
+ /// As all the data is received in one I/O, so this is, this is effectively
+ /// a no-op (although it does update the amount of data received).
+ ///
+ /// \param data Data buffer containing data to date. (This is ignored
+ /// for UDP receives.)
+ /// \param length Amount of data received in last asynchronous I/O
+ /// \param cumulative On input, amount of data received before the last
+ /// I/O. On output, the total amount of data received to date.
+ ///
+ /// \return true if the receive is complete, false if another receive is
+ /// needed.
+ virtual bool receiveComplete(void*, size_t length, size_t& cumulative) {
+ cumulative = length;
+ return (true);
+ }
+
+ /// \brief Cancel I/O On Socket
+ virtual void cancel();
+
+ /// \brief Close socket
+ virtual void close();
+
+
private:
- asio::ip::udp::socket& socket_;
+ // Two variables to hold the socket - a socket and a pointer to it. This
+ // handles the case where a socket is passed to the UDPSocket on
+ // construction, or where it is asked to manage its own socket.
+ asio::ip::udp::socket* socket_ptr_; ///< Pointer to own socket
+ asio::ip::udp::socket& socket_; ///< Socket
+ bool isopen_; ///< true when socket is open
};
-} // namespace asiolink
+// Constructor - caller manages socket
+
+template <typename C>
+UDPSocket<C>::UDPSocket(asio::ip::udp::socket& socket) :
+ socket_ptr_(NULL), socket_(socket), isopen_(true)
+{
+}
+
+// Constructor - create socket on the fly
+
+template <typename C>
+UDPSocket<C>::UDPSocket(IOService& service) :
+ socket_ptr_(new asio::ip::udp::socket(service.get_io_service())),
+ socket_(*socket_ptr_), isopen_(false)
+{
+}
+
+// Destructor. Only delete the socket if we are managing it.
+
+template <typename C>
+UDPSocket<C>::~UDPSocket()
+{
+ delete socket_ptr_;
+}
+
+// Open the socket. Throws an error on failure
+// TODO: Make the open more resilient
+
+template <typename C> bool
+UDPSocket<C>::open(const IOEndpoint* endpoint, C&) {
+
+ // Ignore opens on already-open socket. Don't throw a failure because
+ // of uncertainties as to what precedes whan when using asynchronous I/O.
+ // At also allows us a treat a passed-in socket as a self-managed socket.
+
+ if (!isopen_) {
+ if (endpoint->getFamily() == AF_INET) {
+ socket_.open(asio::ip::udp::v4());
+ }
+ else {
+ socket_.open(asio::ip::udp::v6());
+ }
+ isopen_ = true;
+
+ // Ensure it can send and receive 4K buffers.
+ socket_.set_option(asio::socket_base::send_buffer_size(MAX_SIZE));
+ socket_.set_option(asio::socket_base::receive_buffer_size(MAX_SIZE));
+ ;
+ // Allow reuse of an existing port/address
+ socket_.set_option(asio::socket_base::reuse_address(true));
+ }
+ return (false);
+}
+
+// Send a message. Should never do this if the socket is not open, so throw
+// an exception if this is the case.
+
+template <typename C> void
+UDPSocket<C>::asyncSend(const void* data, size_t length,
+ const IOEndpoint* endpoint, C& callback)
+{
+ if (isopen_) {
+
+ // Upconvert to a UDPEndpoint. We need to do this because although
+ // IOEndpoint is the base class of UDPEndpoint and TCPEndpoint, it
+ // doing cont contain a method for getting at the underlying endpoint
+ // type - those are in the derived class and the two classes differ on
+ // return type.
+
+ assert(endpoint->getProtocol() == IPPROTO_UDP);
+ const UDPEndpoint* udp_endpoint =
+ static_cast<const UDPEndpoint*>(endpoint);
+ socket_.async_send_to(asio::buffer(data, length),
+ udp_endpoint->getASIOEndpoint(), callback);
+ } else {
+ isc_throw(SocketNotOpen,
+ "attempt to send on a UDP socket that is not open");
+ }
+}
+
+// Receive a message. Note that the "cumulative" argument is ignored - every UDP
+// receive is put into the buffer beginning at the start - there is no concept
+// receiving a subsequent part of a message. Same critera as before concerning
+// the need for the socket to be open.
+
+template <typename C> void
+UDPSocket<C>::asyncReceive(void* data, size_t length, size_t,
+ IOEndpoint* endpoint, C& callback)
+{
+ if (isopen_) {
+
+ // Upconvert the endpoint again.
+ assert(endpoint->getProtocol() == IPPROTO_UDP);
+ UDPEndpoint* udp_endpoint = static_cast<UDPEndpoint*>(endpoint);
+
+ socket_.async_receive_from(asio::buffer(data, length),
+ udp_endpoint->getASIOEndpoint(), callback);
+ } else {
+ isc_throw(SocketNotOpen,
+ "attempt to receive from a UDP socket that is not open");
+ }
+}
+
+// Cancel I/O on the socket. No-op if the socket is not open.
+template <typename C> void
+UDPSocket<C>::cancel() {
+ if (isopen_) {
+ socket_.cancel();
+ }
+}
+
+// Close the socket down. Can only do this if the socket is open and we are
+// managing it ourself.
+
+template <typename C> void
+UDPSocket<C>::close() {
+ if (isopen_ && socket_ptr_) {
+ socket_.close();
+ isopen_ = false;
+ }
+}
+
+} // namespace asiolink
+
#endif // __UDP_SOCKET_H
diff --git a/src/lib/bench/tests/benchmark_unittest.cc b/src/lib/bench/tests/benchmark_unittest.cc
index f16b47d..7bb8a60 100644
--- a/src/lib/bench/tests/benchmark_unittest.cc
+++ b/src/lib/bench/tests/benchmark_unittest.cc
@@ -12,7 +12,7 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-#include <unistd.h> // for usleep
+#include <time.h> // for nanosleep
#include <bench/benchmark.h>
@@ -26,16 +26,17 @@ namespace {
// number of iterations.
class TestBenchMark {
public:
- TestBenchMark(const int sub_iterations, const int sleep_time) :
+ TestBenchMark(const int sub_iterations,
+ const struct timespec& sleep_time) :
sub_iterations_(sub_iterations), sleep_time_(sleep_time),
setup_completed_(false), teardown_completed_(false)
{}
unsigned int run() {
- usleep(sleep_time_);
+ nanosleep(&sleep_time_, NULL);
return (sub_iterations_);
}
const int sub_iterations_;
- const int sleep_time_;
+ const struct timespec sleep_time_;
bool setup_completed_;
bool teardown_completed_;
};
@@ -67,6 +68,7 @@ TEST(BenchMarkTest, run) {
// use some uncommon iterations for testing purpose:
const int sub_iterations = 23;
const int sleep_time = 50000; // will sleep for 50ms
+ const struct timespec sleep_timespec = { 0, sleep_time * 1000 };
// we cannot expect particular accuracy on the measured duration, so
// we'll include some conservative margin (25%) and perform range
// comparison below.
@@ -75,12 +77,12 @@ TEST(BenchMarkTest, run) {
// Prerequisite check: since the tests in this case may depend on subtle
// timing, it may result in false positives. There are reportedly systems
- // where usleep() doesn't work as this test expects. So we check the
+ // where sleeping doesn't work as this test expects. So we check the
// conditions before the tests, and if it fails skip the tests at the
// risk of overlooking possible bugs.
struct timeval check_begin, check_end;
gettimeofday(&check_begin, NULL);
- usleep(sleep_time);
+ nanosleep(&sleep_timespec, 0);
gettimeofday(&check_end, NULL);
check_end.tv_sec -= check_begin.tv_sec;
if (check_end.tv_usec >= check_begin.tv_usec) {
@@ -97,7 +99,7 @@ TEST(BenchMarkTest, run) {
return;
}
- TestBenchMark test_bench(sub_iterations, sleep_time);
+ TestBenchMark test_bench(sub_iterations, sleep_timespec);
BenchMark<TestBenchMark> bench(1, test_bench, false);
// Check pre-test conditions.
EXPECT_FALSE(test_bench.setup_completed_);
@@ -130,7 +132,8 @@ TEST(BenchMarkTest, run) {
TEST(BenchMarkTest, runWithNoIteration) {
// we'll lie on the number of iteration (0). it will result in
// meaningless result, but at least it shouldn't crash.
- TestBenchMark test_bench(0, 0);
+ const struct timespec null_timespec = { 0, 0 };
+ TestBenchMark test_bench(0, null_timespec);
BenchMark<TestBenchMark> bench(1, test_bench, false);
bench.run();
EXPECT_EQ(0, bench.getIteration());
diff --git a/src/lib/bench/tests/loadquery_unittest.cc b/src/lib/bench/tests/loadquery_unittest.cc
index 3ac352a..a53e191 100644
--- a/src/lib/bench/tests/loadquery_unittest.cc
+++ b/src/lib/bench/tests/loadquery_unittest.cc
@@ -55,7 +55,7 @@ const char* const LoadQueryTest::DATA_DIR = TEST_DATA_DIR;
class QueryInserter {
public:
QueryInserter(stringstream& stream) : stream_(stream) {}
- void operator()(const QueryParam& query) {
+ void operator()(const QueryParam& query) const {
stream_ << query.first << " " << query.second << endl;
}
private:
diff --git a/src/lib/cache/TODO b/src/lib/cache/TODO
index 0743ee4..a7d2458 100644
--- a/src/lib/cache/TODO
+++ b/src/lib/cache/TODO
@@ -9,4 +9,6 @@
can removed first.
* Make resolver cache be smart to refetch the messages that are about
to expire.
+* When the rrset beging updated is an NS rrset, NSAS should be updated
+ together.
diff --git a/src/lib/cache/cache_entry_key.cc b/src/lib/cache/cache_entry_key.cc
index 35917a0..85c03a0 100644
--- a/src/lib/cache/cache_entry_key.cc
+++ b/src/lib/cache/cache_entry_key.cc
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <sstream>
#include "cache_entry_key.h"
diff --git a/src/lib/cache/cache_entry_key.h b/src/lib/cache/cache_entry_key.h
index 002f958..674deb0 100644
--- a/src/lib/cache/cache_entry_key.h
+++ b/src/lib/cache/cache_entry_key.h
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __CACHE_ENTRY_KEY_H
#define __CACHE_ENTRY_KEY_H
diff --git a/src/lib/cache/local_zone_data.cc b/src/lib/cache/local_zone_data.cc
index 2dcc113..61ce35a 100644
--- a/src/lib/cache/local_zone_data.cc
+++ b/src/lib/cache/local_zone_data.cc
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <dns/rrset.h>
#include "local_zone_data.h"
#include "cache_entry_key.h"
diff --git a/src/lib/cache/local_zone_data.h b/src/lib/cache/local_zone_data.h
index bcf5a94..3015847 100644
--- a/src/lib/cache/local_zone_data.h
+++ b/src/lib/cache/local_zone_data.h
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef _LOCAL_ZONE_DATA
#define _LOCAL_ZONE_DATA
diff --git a/src/lib/cache/message_cache.cc b/src/lib/cache/message_cache.cc
index 6582199..f1334a2 100644
--- a/src/lib/cache/message_cache.cc
+++ b/src/lib/cache/message_cache.cc
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <config.h>
#include <nsas/nsas_entry_compare.h>
@@ -76,6 +74,7 @@ MessageCache::update(const Message& msg) {
return (message_table_.add(msg_entry, entry_key, true));
}
+#if 0
void
MessageCache::dump(const std::string&) {
//TODO
@@ -91,6 +90,7 @@ MessageCache::resize(uint32_t) {
//TODO
return (true);
}
+#endif
} // namespace cache
} // namespace isc
diff --git a/src/lib/cache/message_cache.h b/src/lib/cache/message_cache.h
index 0131b30..65c7381 100644
--- a/src/lib/cache/message_cache.h
+++ b/src/lib/cache/message_cache.h
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __MESSAGE_CACHE_H
#define __MESSAGE_CACHE_H
@@ -43,6 +41,9 @@ public:
MessageCache(boost::shared_ptr<RRsetCache> rrset_cache_,
uint32_t cache_size, uint16_t message_class);
+ /// \brief Destructor function
+ virtual ~MessageCache() {}
+
/// \brief Look up message in cache.
/// \param message generated response message if the message entry
/// can be found.
@@ -59,6 +60,7 @@ public:
/// directly.
bool update(const isc::dns::Message& msg);
+#if 0
/// \brief Dump the message cache to specified file.
/// \todo It should can be dumped to one configured database.
void dump(const std::string& file_name);
@@ -69,6 +71,7 @@ public:
/// \brief Resize the size of message cache in runtime.
bool resize(uint32_t size);
+#endif
protected:
/// \brief Get the hash key for the message entry in the cache.
diff --git a/src/lib/cache/message_entry.cc b/src/lib/cache/message_entry.cc
index fe21ce9..6396167 100644
--- a/src/lib/cache/message_entry.cc
+++ b/src/lib/cache/message_entry.cc
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <config.h>
#include <limits>
@@ -25,6 +23,34 @@
using namespace isc::dns;
using namespace std;
+// Put file scope functions in unnamed namespace.
+namespace {
+
+// Get the shortest existing ancestor which is the owner name of
+// one DNAME record for the given query name.
+// Note: there may be multiple DNAME records(DNAME chain) in answer
+// section. In most cases they are in order, but the code can't depend
+// on that, it has to find the starter by iterating the DNAME chain.
+Name
+getDNAMEChainStarter(const Message& message, const Name& query_name) {
+ Name dname = query_name;
+ RRsetIterator rrset_iter = message.beginSection(Message::SECTION_ANSWER);
+ while(rrset_iter != message.endSection(Message::SECTION_ANSWER)) {
+ if ((*rrset_iter)->getType() == RRType::DNAME()) {
+ const Name& rrname = (*rrset_iter)->getName();
+ if (NameComparisonResult::SUBDOMAIN ==
+ dname.compare(rrname).getRelation()) {
+ dname = rrname;
+ }
+ }
+ ++rrset_iter;
+ }
+
+ return (dname);
+}
+
+} // End of unnamed namespace
+
namespace isc {
namespace cache {
@@ -50,7 +76,7 @@ MessageEntry::getRRsetEntries(vector<RRsetEntryPtr>& rrset_entry_vec,
for (int index = 0; index < entry_count; ++index) {
RRsetEntryPtr rrset_entry = rrset_cache_->lookup(rrsets_[index].name_,
rrsets_[index].type_);
- if (time_now < rrset_entry->getExpireTime()) {
+ if (rrset_entry && time_now < rrset_entry->getExpireTime()) {
rrset_entry_vec.push_back(rrset_entry);
} else {
return (false);
@@ -122,48 +148,45 @@ MessageEntry::getRRsetTrustLevel(const Message& message,
switch(section) {
case Message::SECTION_ANSWER: {
if (aa) {
- RRsetIterator rrset_iter = message.beginSection(section);
-
- // Make sure we are inspecting the right RRset
- while((*rrset_iter)->getName() != rrset->getName() &&
- (*rrset_iter)->getType() != rrset->getType() &&
- rrset_iter != message.endSection(section)) {
- ++rrset_iter;
- }
- assert(rrset_iter != message.endSection(section));
-
// According RFC2181 section 5.4.1, only the record
// describing that ailas is necessarily authoritative.
- // If there is one or more CNAME records in answer section.
- // CNAME records is assumed as the first rrset.
- if ((*rrset_iter)->getType() == RRType::CNAME()) {
- // TODO: real equals for RRsets?
- if ((*rrset_iter).get() == rrset.get()) {
- return (RRSET_TRUST_ANSWER_AA);
- } else {
- return (RRSET_TRUST_ANSWER_NONAA);
+ // If there are CNAME(Not synchronized from DNAME)
+ // records in answer section, only the CNAME record
+ // whose owner name is same with qname is assumed as
+ // authoritative, all the left records are not authoritative.
+ //
+ // If there are DNAME records in answer section,
+ // Only the start DNAME and the synchronized CNAME record
+ // from it are authoritative, any other records in answer
+ // section are non-authoritative.
+ QuestionIterator quest_iter = message.beginQuestion();
+ // Make sure question section is not empty.
+ assert( quest_iter != message.endQuestion());
+
+ const Name& query_name = (*quest_iter)->getName();
+ const RRType& type = rrset->getType();
+ const Name& name = rrset->getName();
+ if ((type == RRType::CNAME() && name == query_name) ||
+ (type == RRType::DNAME() &&
+ name == getDNAMEChainStarter(message, query_name))) {
+ return (RRSET_TRUST_ANSWER_AA);
+ } else {
+ // If there is a CNAME record whose ower name is the same as
+ // the query name in answer section, the other records in answer
+ // section are non-authoritative, except the starter of DNAME
+ // chain (only checking CNAME is enough, because if the CNAME
+ // record is synthesized from a DNAME record, that DNAME
+ // record must be the starter of the DNAME chain).
+ RRsetIterator iter = message.beginSection(Message::SECTION_ANSWER);
+ while(iter != message.endSection(Message::SECTION_ANSWER)) {
+ if ((*iter)->getType() == RRType::CNAME() &&
+ (*iter)->getName() == query_name) {
+ return (RRSET_TRUST_ANSWER_NONAA);
+ }
+ ++iter;
}
}
-
- // Here, if the first rrset is DNAME, then assume the
- // second rrset is synchronized CNAME record, except
- // these two records, any other records in answer section
- // should be treated as non-authoritative.
- // TODO, this part logic should be revisited later,
- // since it's not mentioned by RFC2181.
- if ((*rrset_iter)->getType() == RRType::DNAME()) {
- // TODO: real equals for RRsets?
- if ((*rrset_iter).get() == rrset.get() ||
- ((++rrset_iter) != message.endSection(section) &&
- (*rrset_iter).get() == rrset.get())) {
- return (RRSET_TRUST_ANSWER_AA);
- } else {
- return (RRSET_TRUST_ANSWER_NONAA);
- }
- }
-
return (RRSET_TRUST_ANSWER_AA);
-
} else {
return (RRSET_TRUST_ANSWER_NONAA);
}
diff --git a/src/lib/cache/message_entry.h b/src/lib/cache/message_entry.h
index 0ed00f0..682c171 100644
--- a/src/lib/cache/message_entry.h
+++ b/src/lib/cache/message_entry.h
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __MESSAGE_ENTRY_H
#define __MESSAGE_ENTRY_H
@@ -89,16 +87,14 @@ public:
return (*hash_key_ptr_);
}
+ /// \short Protected memebers, so they can be accessed by tests.
+ //@{
protected:
/// \brief Initialize the message entry with dns message.
///
/// \param message The Message to initialize the entry with
void initMessageEntry(const isc::dns::Message& message);
- /// \brief These two functions should be static functions
- /// placed in cc file. Put them here just for easy unit
- /// tests.
- //@{
/// \brief Parse the rrsets in specified section.
///
/// \param msg The message to parse the RRsets from
@@ -148,10 +144,9 @@ protected:
/// otherwise.
bool getRRsetEntries(std::vector<RRsetEntryPtr>& rrset_entry_vec,
const time_t time_now);
- //@}
-protected:
- /// \note Make the variable be protected for easy test.
+
time_t expire_time_; // Expiration time of the message.
+ //@}
private:
std::string entry_name_; // The name for this entry(name + type)
diff --git a/src/lib/cache/resolver_cache.cc b/src/lib/cache/resolver_cache.cc
index aa681cc..0734da8 100644
--- a/src/lib/cache/resolver_cache.cc
+++ b/src/lib/cache/resolver_cache.cc
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <config.h>
#include "resolver_cache.h"
@@ -177,10 +175,10 @@ ResolverCache::lookup(const isc::dns::Name& qname,
}
isc::dns::RRsetPtr
-ResolverCache::lookupClosestRRset(const isc::dns::Name& qname,
- const isc::dns::RRType& qtype,
- const isc::dns::RRClass& qclass) const
+ResolverCache::lookupDeepestNS(const isc::dns::Name& qname,
+ const isc::dns::RRClass& qclass) const
{
+ isc::dns::RRType qtype = RRType::NS();
ResolverClassCache* cc = getClassCache(qclass);
if (cc) {
unsigned int count = qname.getLabelCount();
@@ -201,7 +199,6 @@ ResolverCache::lookupClosestRRset(const isc::dns::Name& qname,
bool
ResolverCache::update(const isc::dns::Message& msg) {
-
QuestionIterator iter = msg.beginQuestion();
ResolverClassCache* cc = getClassCache((*iter)->getClass());
if (cc) {
@@ -241,9 +238,6 @@ ResolverCache::getClassCache(const isc::dns::RRClass& cache_class) const {
return NULL;
}
-
-
-
} // namespace cache
} // namespace isc
diff --git a/src/lib/cache/resolver_cache.h b/src/lib/cache/resolver_cache.h
index 7a0fdab..a8149e4 100644
--- a/src/lib/cache/resolver_cache.h
+++ b/src/lib/cache/resolver_cache.h
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __RESOLVER_CACHE_H
#define __RESOLVER_CACHE_H
@@ -243,28 +241,27 @@ public:
const isc::dns::RRType& qtype,
const isc::dns::RRClass& qclass) const;
- /// \brief Look up closest rrset in cache.
+ /// \brief Look up closest enclosing NS rrset in cache.
///
/// \param qname The query name to look up
- /// \param qtype The query type to look up
/// \param qclass The query class to look up
///
- /// \return return the shared_ptr of rrset if it can be found in
- /// cache, or else return NULL.
+ /// \return return the shared_ptr of closest enclosing ns rrset
+ /// if it can be found in cache, or else return NULL.
///
- /// Currently the implementation is: search exact rrset
- /// label by lable, If the rrset can't be found, remove the last
+ /// Currently the implementation is: search exact ns rrset
+ /// label by lable, If the ns rrset can't be found, remove the last
/// label, then search again. The efficiency may be very low when
- /// the name of rrset is very long but it's closest rrset's name
- /// is very short.
- /// If a good perfermance is needed when looking up the closest rrset,
- /// rrset cache structure(HashTable) should be redesigned. By using
- /// HashTable, it can only garantee the performance for looking
- /// up exact rrset.
+ /// the name is very long but it's closest rrset's name is very short.
+ ///
+ /// If a good perfermance is needed when looking up the closest
+ /// enclosing ns rrset, cache structure(HashTable) should be
+ /// redesigned. By using HashTable, it can only garantee the
+ /// performance for looking up exact rrset.
+ ///
/// So here there is another question, which rrset looking up interface
- /// is used frequently? Exact or closest looking up.
- isc::dns::RRsetPtr lookupClosestRRset(const isc::dns::Name& qname,
- const isc::dns::RRType& qtype,
+ /// is used frequently? Exact or closest enclosing ns looking up.
+ isc::dns::RRsetPtr lookupDeepestNS(const isc::dns::Name& qname,
const isc::dns::RRClass& qclass) const;
//@}
diff --git a/src/lib/cache/rrset_cache.cc b/src/lib/cache/rrset_cache.cc
index 02a6a45..7dab3b5 100644
--- a/src/lib/cache/rrset_cache.cc
+++ b/src/lib/cache/rrset_cache.cc
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <config.h>
#include <string>
@@ -76,16 +74,16 @@ RRsetCache::update(const isc::dns::RRset& rrset, const RRsetTrustLevel& level) {
return (entry_ptr);
} else {
HashKey key = entry_ptr->hashKey();
- rrset_table_.remove(key);
entry_ptr.reset(new RRsetEntry(rrset, level));
//TODO, lru list touch.
// Replace the expired rrset entry if it exists.
- rrset_table_.add(entry_ptr, key, true);
+ rrset_table_.add(entry_ptr, entry_ptr->hashKey(), true);
return (entry_ptr);
}
}
}
+#if 0
void
RRsetCache::dump(const std::string&) {
//TODO
@@ -101,6 +99,7 @@ RRsetCache::resize(uint32_t) {
//TODO
return (true);
}
+#endif
} // namespace cache
} // namespace isc
diff --git a/src/lib/cache/rrset_cache.h b/src/lib/cache/rrset_cache.h
index d082b3c..5bf2730 100644
--- a/src/lib/cache/rrset_cache.h
+++ b/src/lib/cache/rrset_cache.h
@@ -12,12 +12,10 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __RRSET_CACHE_H
#define __RRSET_CACHE_H
-#include <rrset_entry.h>
+#include <cache/rrset_entry.h>
#include <nsas/hash_table.h>
#include <nsas/lru_list.h>
@@ -47,7 +45,7 @@ public:
/// \param cache_size the size of rrset cache.
/// \param rrset_class the class of rrset cache.
RRsetCache(uint32_t cache_size, uint16_t rrset_class);
- ~RRsetCache() {}
+ virtual ~RRsetCache() {}
//@}
/// \brief Look up rrset in cache.
@@ -72,6 +70,7 @@ public:
RRsetEntryPtr update(const isc::dns::RRset& rrset,
const RRsetTrustLevel& level);
+#if 0
/// \brief Dump the rrset cache to specified file.
///
/// \param file_name The file to write to
@@ -91,8 +90,10 @@ public:
/// \param The size to resize to
/// \return true
bool resize(uint32_t size);
+#endif
-private:
+ /// \short Protected memebers, so they can be accessed by tests.
+protected:
uint16_t class_; // The class of the rrset cache.
isc::nsas::HashTable<RRsetEntry> rrset_table_;
isc::nsas::LruList<RRsetEntry> rrset_lru_;
diff --git a/src/lib/cache/rrset_copy.cc b/src/lib/cache/rrset_copy.cc
index 85ba153..05b139a 100644
--- a/src/lib/cache/rrset_copy.cc
+++ b/src/lib/cache/rrset_copy.cc
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include "rrset_copy.h"
using namespace isc::dns;
diff --git a/src/lib/cache/rrset_copy.h b/src/lib/cache/rrset_copy.h
index f6bee55..b6af8d6 100644
--- a/src/lib/cache/rrset_copy.h
+++ b/src/lib/cache/rrset_copy.h
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __RRSET_COPY_
#define __RRSET_COPY_
diff --git a/src/lib/cache/rrset_entry.cc b/src/lib/cache/rrset_entry.cc
index 9407e97..c829956 100644
--- a/src/lib/cache/rrset_entry.cc
+++ b/src/lib/cache/rrset_entry.cc
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <config.h>
#include <dns/message.h>
diff --git a/src/lib/cache/rrset_entry.h b/src/lib/cache/rrset_entry.h
index f0149a4..5fa8f2c 100644
--- a/src/lib/cache/rrset_entry.h
+++ b/src/lib/cache/rrset_entry.h
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __RRSET_ENTRY_H
#define __RRSET_ENTRY_H
diff --git a/src/lib/cache/tests/Makefile.am b/src/lib/cache/tests/Makefile.am
index 9bc3e3a..6f05f74 100644
--- a/src/lib/cache/tests/Makefile.am
+++ b/src/lib/cache/tests/Makefile.am
@@ -38,6 +38,8 @@ run_unittests_SOURCES += message_cache_unittest.cc
run_unittests_SOURCES += message_entry_unittest.cc
run_unittests_SOURCES += local_zone_data_unittest.cc
run_unittests_SOURCES += resolver_cache_unittest.cc
+run_unittests_SOURCES += cache_test_messagefromfile.h
+run_unittests_SOURCES += cache_test_sectioncount.h
run_unittests_CPPFLAGS = $(AM_CPPFLAGS) $(GTEST_INCLUDES)
run_unittests_LDFLAGS = $(AM_LDFLAGS) $(GTEST_LDFLAGS)
@@ -55,3 +57,12 @@ run_unittests_LDADD += $(top_builddir)/src/lib/exceptions/libexceptions.la
endif
noinst_PROGRAMS = $(TESTS)
+
+EXTRA_DIST = testdata/message_fromWire1
+EXTRA_DIST += testdata/message_fromWire2
+EXTRA_DIST += testdata/message_fromWire3
+EXTRA_DIST += testdata/message_fromWire4
+EXTRA_DIST += testdata/message_fromWire5
+EXTRA_DIST += testdata/message_fromWire6
+EXTRA_DIST += testdata/message_fromWire7
+EXTRA_DIST += testdata/message_fromWire8
diff --git a/src/lib/cache/tests/cache_test_messagefromfile.h b/src/lib/cache/tests/cache_test_messagefromfile.h
index 820d822..62e237c 100644
--- a/src/lib/cache/tests/cache_test_messagefromfile.h
+++ b/src/lib/cache/tests/cache_test_messagefromfile.h
@@ -12,7 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
#include <vector>
#include <dns/tests/unittest_util.h>
#include <dns/buffer.h>
diff --git a/src/lib/cache/tests/cache_test_sectioncount.h b/src/lib/cache/tests/cache_test_sectioncount.h
index 9583805..537ca81 100644
--- a/src/lib/cache/tests/cache_test_sectioncount.h
+++ b/src/lib/cache/tests/cache_test_sectioncount.h
@@ -12,7 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
#include <vector>
#include <dns/tests/unittest_util.h>
#include <dns/buffer.h>
@@ -33,7 +32,7 @@ int
sectionRRsetCount(Message& msg, Message::Section section) {
int count = 0;
for (RRsetIterator rrset_iter = msg.beginSection(section);
- rrset_iter != msg.endSection(section);
+ rrset_iter != msg.endSection(section);
++rrset_iter) {
++count;
}
diff --git a/src/lib/cache/tests/local_zone_data_unittest.cc b/src/lib/cache/tests/local_zone_data_unittest.cc
index 28de4be..6877eae 100644
--- a/src/lib/cache/tests/local_zone_data_unittest.cc
+++ b/src/lib/cache/tests/local_zone_data_unittest.cc
@@ -12,7 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
#include <config.h>
#include <string>
#include <gtest/gtest.h>
diff --git a/src/lib/cache/tests/message_cache_unittest.cc b/src/lib/cache/tests/message_cache_unittest.cc
index f984312..b2c0cd3 100644
--- a/src/lib/cache/tests/message_cache_unittest.cc
+++ b/src/lib/cache/tests/message_cache_unittest.cc
@@ -12,7 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
#include <config.h>
#include <string>
#include <gtest/gtest.h>
@@ -44,20 +43,40 @@ public:
}
};
+/// \brief Derived from base class to make it easy to test
+/// its internals.
+class DerivedRRsetCache: public RRsetCache {
+public:
+ DerivedRRsetCache(uint32_t cache_size, uint16_t rrset_class):
+ RRsetCache(cache_size, rrset_class)
+ {}
+
+ /// \brief Remove one rrset entry from rrset cache.
+ void removeRRsetEntry(Name& name, const RRType& type) {
+ const string entry_name = genCacheEntryName(name, type);
+ HashKey entry_key = HashKey(entry_name, RRClass(class_));
+ RRsetEntryPtr rrset_entry = rrset_table_.get(entry_key);
+ if (rrset_entry) {
+ rrset_lru_.remove(rrset_entry);
+ rrset_table_.remove(entry_key);
+ }
+ }
+};
+
class MessageCacheTest: public testing::Test {
public:
MessageCacheTest(): message_parse(Message::PARSE),
message_render(Message::RENDER)
{
uint16_t class_ = RRClass::IN().getCode();
- rrset_cache_.reset(new RRsetCache(RRSET_CACHE_DEFAULT_SIZE, class_));
- message_cache_.reset(new DerivedMessageCache(rrset_cache_,
+ rrset_cache_.reset(new DerivedRRsetCache(RRSET_CACHE_DEFAULT_SIZE, class_));
+ message_cache_.reset(new DerivedMessageCache(rrset_cache_,
MESSAGE_CACHE_DEFAULT_SIZE, class_ ));
}
protected:
boost::shared_ptr<DerivedMessageCache> message_cache_;
- RRsetCachePtr rrset_cache_;
+ boost::shared_ptr<DerivedRRsetCache> rrset_cache_;
Message message_parse;
Message message_render;
};
@@ -76,6 +95,11 @@ TEST_F(MessageCacheTest, testLookup) {
Name qname1("test.example.net.");
EXPECT_TRUE(message_cache_->lookup(qname1, RRType::A(), message_render));
+
+ // Test looking up message which has expired rrsets.
+ // Remove one
+ rrset_cache_->removeRRsetEntry(qname1, RRType::A());
+ EXPECT_FALSE(message_cache_->lookup(qname1, RRType::A(), message_render));
}
TEST_F(MessageCacheTest, testUpdate) {
diff --git a/src/lib/cache/tests/message_entry_unittest.cc b/src/lib/cache/tests/message_entry_unittest.cc
index f0fc777..a96c441 100644
--- a/src/lib/cache/tests/message_entry_unittest.cc
+++ b/src/lib/cache/tests/message_entry_unittest.cc
@@ -12,7 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
#include <config.h>
#include <string>
#include <gtest/gtest.h>
@@ -30,7 +29,7 @@ using namespace isc;
using namespace isc::dns;
using namespace std;
-static uint32_t MAX_UINT32 = numeric_limits<uint32_t>::max();
+static uint32_t MAX_UINT32 = numeric_limits<uint32_t>::max();
namespace {
@@ -75,7 +74,6 @@ public:
message_parse(Message::PARSE),
message_render(Message::RENDER)
{
-
rrset_cache_.reset(new RRsetCache(RRSET_CACHE_DEFAULT_SIZE, class_));
}
@@ -109,7 +107,6 @@ TEST_F(MessageEntryTest, testParseRRset) {
TEST_F(MessageEntryTest, testGetRRsetTrustLevel_AA) {
messageFromFile(message_parse, "message_fromWire3");
DerivedMessageEntry message_entry(message_parse, rrset_cache_);
-
RRsetIterator rrset_iter = message_parse.beginSection(Message::SECTION_ANSWER);
RRsetTrustLevel level = message_entry.getRRsetTrustLevelForTest(message_parse,
@@ -165,7 +162,54 @@ TEST_F(MessageEntryTest, testGetRRsetTrustLevel_CNAME) {
level = message_entry.getRRsetTrustLevelForTest(message_parse,
*rrset_iter,
Message::SECTION_ANSWER);
+ EXPECT_EQ(level, RRSET_TRUST_ANSWER_NONAA);
+}
+
+TEST_F(MessageEntryTest, testGetRRsetTrustLevel_CNAME_and_DNAME) {
+ messageFromFile(message_parse, "message_fromWire7");
+ DerivedMessageEntry message_entry(message_parse, rrset_cache_);
+ RRsetIterator rrset_iter = message_parse.beginSection(Message::SECTION_ANSWER);
+ RRsetTrustLevel level = message_entry.getRRsetTrustLevelForTest(message_parse,
+ *rrset_iter,
+ Message::SECTION_ANSWER);
+ EXPECT_EQ(level, RRSET_TRUST_ANSWER_AA);
+ // All the left rrset are non-authoritative
+ ++rrset_iter;
+ while (rrset_iter != message_parse.endSection(Message::SECTION_ANSWER)) {
+ level = message_entry.getRRsetTrustLevelForTest(message_parse,
+ *rrset_iter,
+ Message::SECTION_ANSWER);
+ ++rrset_iter;
+ EXPECT_EQ(level, RRSET_TRUST_ANSWER_NONAA);
+ }
+}
+
+TEST_F(MessageEntryTest, testGetRRsetTrustLevel_DNAME_and_CNAME) {
+ messageFromFile(message_parse, "message_fromWire8");
+ DerivedMessageEntry message_entry(message_parse, rrset_cache_);
+ RRsetIterator rrset_iter = message_parse.beginSection(Message::SECTION_ANSWER);
+ RRsetTrustLevel level = message_entry.getRRsetTrustLevelForTest(message_parse,
+ *rrset_iter,
+ Message::SECTION_ANSWER);
+ // Test the deepest DNAME
EXPECT_EQ(level, RRSET_TRUST_ANSWER_AA);
+ ++rrset_iter;
+ // Test the synchronized CNAME
+ level = message_entry.getRRsetTrustLevelForTest(message_parse,
+ *rrset_iter,
+ Message::SECTION_ANSWER);
+ ++rrset_iter;
+ EXPECT_EQ(level, RRSET_TRUST_ANSWER_AA);
+
+ ++rrset_iter;
+ // All the left rrset are non-authoritative
+ while (rrset_iter != message_parse.endSection(Message::SECTION_ANSWER)) {
+ level = message_entry.getRRsetTrustLevelForTest(message_parse,
+ *rrset_iter,
+ Message::SECTION_ANSWER);
+ ++rrset_iter;
+ EXPECT_EQ(level, RRSET_TRUST_ANSWER_NONAA);
+ }
}
TEST_F(MessageEntryTest, testGetRRsetTrustLevel_DNAME) {
@@ -187,7 +231,7 @@ TEST_F(MessageEntryTest, testGetRRsetTrustLevel_DNAME) {
level = message_entry.getRRsetTrustLevelForTest(message_parse,
*rrset_iter,
Message::SECTION_ANSWER);
- EXPECT_EQ(level, RRSET_TRUST_ANSWER_AA);
+ EXPECT_EQ(level, RRSET_TRUST_ANSWER_NONAA);
}
// We only test the expire_time of the message entry.
@@ -205,8 +249,8 @@ TEST_F(MessageEntryTest, testGetRRsetEntries) {
messageFromFile(message_parse, "message_fromWire3");
DerivedMessageEntry message_entry(message_parse, rrset_cache_);
vector<RRsetEntryPtr> vec;
-
- // the time is bigger than the smallest expire time of
+
+ // the time is bigger than the smallest expire time of
// the rrset in message.
time_t expire_time = time(NULL) + 10802;
EXPECT_FALSE(message_entry.getRRsetEntriesForTest(vec, expire_time));
@@ -216,17 +260,17 @@ TEST_F(MessageEntryTest, testGenMessage) {
messageFromFile(message_parse, "message_fromWire3");
DerivedMessageEntry message_entry(message_parse, rrset_cache_);
time_t expire_time = message_entry.getExpireTime();
-
+
Message msg(Message::RENDER);
EXPECT_FALSE(message_entry.genMessage(expire_time + 2, msg));
message_entry.genMessage(time(NULL), msg);
// Check whether the generated message is same with cached one.
-
+
EXPECT_TRUE(msg.getHeaderFlag(Message::HEADERFLAG_AA));
EXPECT_FALSE(msg.getHeaderFlag(Message::HEADERFLAG_TC));
- EXPECT_EQ(1, sectionRRsetCount(msg, Message::SECTION_ANSWER));
- EXPECT_EQ(1, sectionRRsetCount(msg, Message::SECTION_AUTHORITY));
- EXPECT_EQ(5, sectionRRsetCount(msg, Message::SECTION_ADDITIONAL));
+ EXPECT_EQ(1, sectionRRsetCount(msg, Message::SECTION_ANSWER));
+ EXPECT_EQ(1, sectionRRsetCount(msg, Message::SECTION_AUTHORITY));
+ EXPECT_EQ(5, sectionRRsetCount(msg, Message::SECTION_ADDITIONAL));
// Check the rrset in answer section.
EXPECT_EQ(1, msg.getRRCount(Message::SECTION_ANSWER));
diff --git a/src/lib/cache/tests/resolver_cache_unittest.cc b/src/lib/cache/tests/resolver_cache_unittest.cc
index a3cf728..20dcec9 100644
--- a/src/lib/cache/tests/resolver_cache_unittest.cc
+++ b/src/lib/cache/tests/resolver_cache_unittest.cc
@@ -12,13 +12,13 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
#include <config.h>
#include <string>
#include <gtest/gtest.h>
#include <dns/rrset.h>
#include "resolver_cache.h"
#include "cache_test_messagefromfile.h"
+#include "cache_test_sectioncount.h"
using namespace isc::cache;
using namespace isc::dns;
@@ -64,7 +64,7 @@ TEST_F(ResolverCacheTest, testUpdateMessage) {
EXPECT_TRUE(cache->lookup(qname, RRType::SOA(), RRClass::IN(), new_msg));
EXPECT_FALSE(new_msg.getHeaderFlag(Message::HEADERFLAG_AA));
}
-#if 0
+
TEST_F(ResolverCacheTest, testUpdateRRset) {
Message msg(Message::PARSE);
messageFromFile(msg, "message_fromWire3");
@@ -87,7 +87,7 @@ TEST_F(ResolverCacheTest, testUpdateRRset) {
cache->update(rrset_ptr);
Message new_msg(Message::RENDER);
- Question question(qname, klass, RRType::NS());
+ Question question(qname, RRClass::IN(), RRType::NS());
new_msg.addQuestion(question);
EXPECT_TRUE(cache->lookup(qname, RRType::NS(), RRClass::IN(), new_msg));
EXPECT_EQ(0, sectionRRsetCount(new_msg, Message::SECTION_AUTHORITY));
@@ -113,26 +113,16 @@ TEST_F(ResolverCacheTest, testLookupClosestRRset) {
Name qname("www.test.example.com.");
- RRsetPtr rrset_ptr = cache->lookupClosestRRset(qname, RRType::NS(),
- RRClass::IN());
+ RRsetPtr rrset_ptr = cache->lookupDeepestNS(qname, RRClass::IN());
EXPECT_TRUE(rrset_ptr);
EXPECT_EQ(rrset_ptr->getName(), Name("example.com."));
- rrset_ptr = cache->lookupClosestRRset(Name("example.com."),
- RRType::NS(), RRClass::IN());
+ rrset_ptr = cache->lookupDeepestNS(Name("example.com."), RRClass::IN());
EXPECT_TRUE(rrset_ptr);
EXPECT_EQ(rrset_ptr->getName(), Name("example.com."));
- rrset_ptr = cache->lookupClosestRRset(Name("com."),
- RRType::NS(), RRClass::IN());
+ rrset_ptr = cache->lookupDeepestNS(Name("com."), RRClass::IN());
EXPECT_FALSE(rrset_ptr);
}
-TEST_F(ResolverCacheTest, testHasClass) {
- EXPECT_TRUE(cache->getClassCache(RRClass::IN()));
- EXPECT_TRUE(cache->getClassCache(RRClass::CH()));
- EXPECT_FALSE(cache->getClassCache(RRClass::ANY()));
-}
-#endif
-
}
diff --git a/src/lib/cache/tests/rrset_cache_unittest.cc b/src/lib/cache/tests/rrset_cache_unittest.cc
index 1263406..afb7eaa 100644
--- a/src/lib/cache/tests/rrset_cache_unittest.cc
+++ b/src/lib/cache/tests/rrset_cache_unittest.cc
@@ -12,7 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
#include <config.h>
#include <string>
#include <gtest/gtest.h>
diff --git a/src/lib/cache/tests/rrset_entry_unittest.cc b/src/lib/cache/tests/rrset_entry_unittest.cc
index ce6238f..c7c3c6e 100644
--- a/src/lib/cache/tests/rrset_entry_unittest.cc
+++ b/src/lib/cache/tests/rrset_entry_unittest.cc
@@ -12,7 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
#include <config.h>
#include <string>
#include <gtest/gtest.h>
@@ -49,9 +48,10 @@ TEST_F(GenCacheKeyTest, genCacheEntryKey2) {
class DerivedRRsetEntry: public RRsetEntry {
public:
+ DerivedRRsetEntry(const isc::dns::RRset& rrset, const RRsetTrustLevel& level) : RRsetEntry(rrset, level) {};
void updateTTLForTest() {
-
+
}
};
diff --git a/src/lib/cache/tests/run_unittests.cc b/src/lib/cache/tests/run_unittests.cc
index b34b3dd..2c86581 100644
--- a/src/lib/cache/tests/run_unittests.cc
+++ b/src/lib/cache/tests/run_unittests.cc
@@ -12,7 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id: run_unittests.cc 3020 2010-09-26 03:47:26Z jinmei $
#include <config.h>
#include <gtest/gtest.h>
diff --git a/src/lib/cache/tests/testdata/message_fromWire7 b/src/lib/cache/tests/testdata/message_fromWire7
new file mode 100644
index 0000000..7b10b5d
--- /dev/null
+++ b/src/lib/cache/tests/testdata/message_fromWire7
@@ -0,0 +1,27 @@
+#
+# ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 1155
+# ;; flags: qr aa rd; QUERY: 1, ANSWER: 5, AUTHORITY: 0, ADDITIONAL: 0
+# ;; WARNING: recursion requested but not available
+#
+# ;; QUESTION SECTION:
+# ;test.example.com. IN A
+#
+# ;; ANSWER SECTION:
+# test.example.com. 21600 IN CNAME cname.a.dname.example.com.
+# dname.example.com. 21600 IN DNAME dname.example.org.
+# cname.a.dname.example.com. 21600 IN CNAME cname.a.dname.example.org.
+# dname.example.org. 21600 IN DNAME dname.example.org.
+# cname.a.dname.example.org. 21600 IN CNAME cname.a.dname.example.org.
+
+0424 8500
+ 00 01 00 05 00 00 00 00 04 74 65 73
+ 74 07 65 78 61 6d 70 6c 65 03 63 6f 6d 00 00 01
+ 00 01 c0 0c 00 05 00 01 00 00 54 60 00 10 05 63
+ 6e 61 6d 65 01 61 05 64 6e 61 6d 65 c0 11 c0 36
+ 00 27 00 01 00 00 54 60 00 13 05 64 6e 61 6d 65
+ 07 65 78 61 6d 70 6c 65 03 6f 72 67 00 c0 2e 00
+ 05 00 01 00 00 54 60 00 0a 05 63 6e 61 6d 65 01
+ 61 c0 4a c0 4a 00 27 00 01 00 00 54 60 00 13 05
+ 64 6e 61 6d 65 07 65 78 61 6d 70 6c 65 03 6f 72
+ 67 00 c0 69 00 05 00 01 00 00 54 60 00 02 c0 69
+
diff --git a/src/lib/cache/tests/testdata/message_fromWire8 b/src/lib/cache/tests/testdata/message_fromWire8
new file mode 100644
index 0000000..bc9e144
--- /dev/null
+++ b/src/lib/cache/tests/testdata/message_fromWire8
@@ -0,0 +1,23 @@
+# A response includes multiple DNAME and synchronized CNAME records
+# ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 900
+# ;; flags: qr aa rd; QUERY: 1, ANSWER: 4, AUTHORITY: 0, ADDITIONAL: 0
+# ;; WARNING: recursion requested but not available
+#
+# ;; QUESTION SECTION:
+# ;a.dname.example.com. IN NS
+#
+# ;; ANSWER SECTION:
+# dname.example.com. 21600 IN DNAME dname.example.org.
+# a.dname.example.com. 21600 IN CNAME a.dname.example.org.
+# dname.example.org. 21600 IN DNAME dname.example.org.
+# a.dname.example.org. 21600 IN CNAME a.dname.example.org.
+0384 8500
+ 00 01 00 04 00 00 00 00 01 61 05 64
+ 6e 61 6d 65 07 65 78 61 6d 70 6c 65 03 63 6f 6d
+ 00 00 02 00 01 c0 0e 00 27 00 01 00 00 54 60 00
+ 13 05 64 6e 61 6d 65 07 65 78 61 6d 70 6c 65 03
+ 6f 72 67 00 c0 0c 00 05 00 01 00 00 54 60 00 04
+ 01 61 c0 31 c0 31 00 27 00 01 00 00 54 60 00 13
+ 05 64 6e 61 6d 65 07 65 78 61 6d 70 6c 65 03 6f
+ 72 67 00 c0 50 00 05 00 01 00 00 54 60 00 02 c0
+ 50
diff --git a/src/lib/cc/tests/session_unittests.cc b/src/lib/cc/tests/session_unittests.cc
index d61cbd3..5f6e595 100644
--- a/src/lib/cc/tests/session_unittests.cc
+++ b/src/lib/cc/tests/session_unittests.cc
@@ -74,7 +74,7 @@ public:
}
void
- acceptHandler(const asio::error_code&) {
+ acceptHandler(const asio::error_code&) const {
}
void
diff --git a/src/lib/config/ccsession.cc b/src/lib/config/ccsession.cc
index 7049565..69621a4 100644
--- a/src/lib/config/ccsession.cc
+++ b/src/lib/config/ccsession.cc
@@ -170,10 +170,10 @@ ModuleCCSession::readModuleSpecification(const std::string& filename) {
try {
module_spec = moduleSpecFromFile(file, true);
- } catch (JSONError pe) {
+ } catch (const JSONError& pe) {
cout << "Error parsing module specification file: " << pe.what() << endl;
exit(1);
- } catch (ModuleSpecError dde) {
+ } catch (const ModuleSpecError& dde) {
cout << "Error reading module specification file: " << dde.what() << endl;
exit(1);
}
diff --git a/src/lib/config/module_spec.cc b/src/lib/config/module_spec.cc
index ad40689..fd07dde 100644
--- a/src/lib/config/module_spec.cc
+++ b/src/lib/config/module_spec.cc
@@ -121,7 +121,7 @@ void
check_module_specification(ConstElementPtr def) {
try {
check_data_specification(def);
- } catch (TypeError te) {
+ } catch (const TypeError& te) {
throw ModuleSpecError(te.what());
}
}
diff --git a/src/lib/config/tests/ccsession_unittests.cc b/src/lib/config/tests/ccsession_unittests.cc
index 4ed3ce2..43663bd 100644
--- a/src/lib/config/tests/ccsession_unittests.cc
+++ b/src/lib/config/tests/ccsession_unittests.cc
@@ -31,7 +31,7 @@ using namespace std;
namespace {
std::string
-ccspecfile(const std::string name) {
+ccspecfile(const std::string& name) {
return (std::string(TEST_DATA_PATH) + "/" + name);
}
diff --git a/src/lib/config/tests/module_spec_unittests.cc b/src/lib/config/tests/module_spec_unittests.cc
index 8490aa0..59f5459 100644
--- a/src/lib/config/tests/module_spec_unittests.cc
+++ b/src/lib/config/tests/module_spec_unittests.cc
@@ -23,7 +23,7 @@
using namespace isc::data;
using namespace isc::config;
-std::string specfile(const std::string name) {
+std::string specfile(const std::string& name) {
return (std::string(TEST_DATA_PATH) + "/" + name);
}
@@ -36,7 +36,7 @@ moduleSpecError(const std::string& file,
EXPECT_THROW(moduleSpecFromFile(specfile(file)), ModuleSpecError);
try {
ModuleSpec dd = moduleSpecFromFile(specfile(file));
- } catch (ModuleSpecError dde) {
+ } catch (const ModuleSpecError& dde) {
std::string ddew = dde.what();
EXPECT_EQ(error1 + error2 + error3, ddew);
}
diff --git a/src/lib/config/tests/testdata/spec22.spec b/src/lib/config/tests/testdata/spec22.spec
index be6d51f..cccd77b 100644
--- a/src/lib/config/tests/testdata/spec22.spec
+++ b/src/lib/config/tests/testdata/spec22.spec
@@ -1,6 +1,6 @@
{
"module_spec": {
- "module_name": "Spec2",
+ "module_name": "Spec22",
"config_data": [
{ "item_name": "value1",
"item_type": "integer",
@@ -81,7 +81,7 @@
{ "item_name": "value9",
"item_type": "map",
"item_optional": false,
- "item_default": {},
+ "item_default": { "v91": "def", "v92": {} },
"map_item_spec": [
{ "item_name": "v91",
"item_type": "string",
diff --git a/src/lib/datasrc/data_source.cc b/src/lib/datasrc/data_source.cc
index 8b2b47e..829d1fc 100644
--- a/src/lib/datasrc/data_source.cc
+++ b/src/lib/datasrc/data_source.cc
@@ -1157,7 +1157,7 @@ MetaDataSrc::addDataSrc(ConstDataSrcPtr data_src) {
void
MetaDataSrc::removeDataSrc(ConstDataSrcPtr data_src) {
std::vector<ConstDataSrcPtr>::iterator it, itr;
- for (it = data_sources.begin(); it != data_sources.end(); it++) {
+ for (it = data_sources.begin(); it != data_sources.end(); ++it) {
if (*it == data_src) {
itr = it;
}
diff --git a/src/lib/datasrc/memory_datasrc.cc b/src/lib/datasrc/memory_datasrc.cc
index fdef888..5230ced 100644
--- a/src/lib/datasrc/memory_datasrc.cc
+++ b/src/lib/datasrc/memory_datasrc.cc
@@ -94,22 +94,22 @@ struct MemoryZone::MemoryZoneImpl {
l > origin_labels;
--l, wname = wname.split(1)) {
if (wname.isWildcard()) {
- // Ensure a separate level exists for the wildcard name.
- // Note: for 'name' itself we do this later anyway, but the
- // overhead should be marginal because wildcard names should
- // be rare.
+ // Ensure a separate level exists for the "wildcarding" name,
+ // and mark the node as "wild".
DomainNode* node;
DomainTree::Result result(domains.insert(wname.split(1),
&node));
assert(result == DomainTree::SUCCESS ||
result == DomainTree::ALREADYEXISTS);
+ node->setFlag(DOMAINFLAG_WILD);
- // Ensure a separate level exists for the "wildcarding" name,
- // and mark the node as "wild".
+ // Ensure a separate level exists for the wildcard name.
+ // Note: for 'name' itself we do this later anyway, but the
+ // overhead should be marginal because wildcard names should
+ // be rare.
result = domains.insert(wname, &node);
assert(result == DomainTree::SUCCESS ||
result == DomainTree::ALREADYEXISTS);
- node->setFlag(DOMAINFLAG_WILD);
}
}
}
@@ -351,6 +351,35 @@ struct MemoryZone::MemoryZoneImpl {
return (false);
}
+ /*
+ * Prepares a rrset to be return as a result.
+ *
+ * If rename is false, it returns the one provided. If it is true, it
+ * creates a new rrset with the same data but with provided name.
+ * It is designed for wildcard case, where we create the rrsets
+ * dynamically.
+ */
+ static ConstRRsetPtr prepareRRset(const Name& name, const ConstRRsetPtr&
+ rrset, bool rename)
+ {
+ if (rename) {
+ /*
+ * We lose a signature here. But it would be wrong anyway, because
+ * the name changed. This might turn out to be unimportant in
+ * future, because wildcards will probably be handled somehow
+ * by DNSSEC.
+ */
+ RRsetPtr result(new RRset(name, rrset->getClass(),
+ rrset->getType(), rrset->getTTL()));
+ for (RdataIteratorPtr i(rrset->getRdataIterator()); !i->isLast();
+ i->next()) {
+ result->addRdata(i->getCurrent());
+ }
+ return (result);
+ } else {
+ return (rrset);
+ }
+ }
// Implementation of MemoryZone::find
FindResult find(const Name& name, RRType type,
@@ -360,6 +389,7 @@ struct MemoryZone::MemoryZoneImpl {
DomainNode* node(NULL);
FindState state(options);
RBTreeNodeChain<Domain> node_path;
+ bool rename(false);
switch (domains_.find(name, &node, node_path, cutCallback, &state)) {
case DomainTree::PARTIALMATCH:
/*
@@ -383,10 +413,12 @@ struct MemoryZone::MemoryZoneImpl {
if (state.dname_node_ != NULL) {
// We were traversing a DNAME node (and wanted to go
// lower below it), so return the DNAME
- return (FindResult(DNAME, state.rrset_));
+ return (FindResult(DNAME, prepareRRset(name, state.rrset_,
+ rename)));
}
if (state.zonecut_node_ != NULL) {
- return (FindResult(DELEGATION, state.rrset_));
+ return (FindResult(DELEGATION, prepareRRset(name,
+ state.rrset_, rename)));
}
// If the RBTree search stopped at a node for a super domain
@@ -397,6 +429,60 @@ struct MemoryZone::MemoryZoneImpl {
return (FindResult(NXRRSET, ConstRRsetPtr()));
}
+ /*
+ * No redirection anywhere. Let's try if it is a wildcard.
+ *
+ * The wildcard is checked after the empty non-terminal domain
+ * case above, because if that one triggers, it means we should
+ * not match according to 4.3.3 of RFC 1034 (the query name
+ * is known to exist).
+ */
+ if (node->getFlag(DOMAINFLAG_WILD)) {
+ /* Should we cancel this match?
+ *
+ * If we compare with some node and get a common ancestor,
+ * it might mean we are comparing with a non-wildcard node.
+ * In that case, we check which part is common. If we have
+ * something in common that lives below the node we got
+ * (the one above *), then we should cancel the match
+ * according to section 4.3.3 of RFC 1034 (as the name
+ * between the wildcard domain and the query name is known
+ * to exist).
+ *
+ * Because the way the tree stores relative names, we will
+ * have exactly one common label (the ".") in case we have
+ * nothing common under the node we got and we will get
+ * more common labels otherwise (yes, this relies on the
+ * internal RBTree structure, which leaks out through this
+ * little bit).
+ *
+ * If the empty non-terminal node actually exists in the
+ * tree, then this cancellation is not needed, because we
+ * will not get here at all.
+ */
+ if (node_path.getLastComparisonResult().getRelation() ==
+ NameComparisonResult::COMMONANCESTOR && node_path.
+ getLastComparisonResult().getCommonLabels() > 1) {
+ return (FindResult(NXDOMAIN, ConstRRsetPtr()));
+ }
+ Name wildcard(Name("*").concatenate(
+ node_path.getAbsoluteName()));
+ DomainTree::Result result(domains_.find(wildcard, &node));
+ /*
+ * Otherwise, why would the DOMAINFLAG_WILD be there if
+ * there was no wildcard under it?
+ */
+ assert(result == DomainTree::EXACTMATCH);
+ /*
+ * We have the wildcard node now. Jump below the switch,
+ * where handling of the common (exact-match) case is.
+ *
+ * However, rename it to the searched name.
+ */
+ rename = true;
+ break;
+ }
+
// fall through
case DomainTree::NOTFOUND:
return (FindResult(NXDOMAIN, ConstRRsetPtr()));
@@ -420,7 +506,8 @@ struct MemoryZone::MemoryZoneImpl {
if (node->getFlag(DomainNode::FLAG_CALLBACK) && node != origin_data_) {
found = node->getData()->find(RRType::NS());
if (found != node->getData()->end()) {
- return (FindResult(DELEGATION, found->second));
+ return (FindResult(DELEGATION, prepareRRset(name,
+ found->second, rename)));
}
}
@@ -428,10 +515,11 @@ struct MemoryZone::MemoryZoneImpl {
if (target != NULL && !node->getData()->empty()) {
// Empty domain will be handled as NXRRSET by normal processing
for (found = node->getData()->begin();
- found != node->getData()->end(); found++)
+ found != node->getData()->end(); ++found)
{
target->addRRset(
- boost::const_pointer_cast<RRset>(found->second));
+ boost::const_pointer_cast<RRset>(prepareRRset(name,
+ found->second, rename)));
}
return (FindResult(SUCCESS, ConstRRsetPtr()));
}
@@ -439,12 +527,14 @@ struct MemoryZone::MemoryZoneImpl {
found = node->getData()->find(type);
if (found != node->getData()->end()) {
// Good, it is here
- return (FindResult(SUCCESS, found->second));
+ return (FindResult(SUCCESS, prepareRRset(name, found->second,
+ rename)));
} else {
// Next, try CNAME.
found = node->getData()->find(RRType::CNAME());
if (found != node->getData()->end()) {
- return (FindResult(CNAME, found->second));
+ return (FindResult(CNAME, prepareRRset(name, found->second,
+ rename)));
}
}
// No exact match or CNAME. Return NXRRSET.
diff --git a/src/lib/datasrc/tests/memory_datasrc_unittest.cc b/src/lib/datasrc/tests/memory_datasrc_unittest.cc
index 15b06b4..16d749c 100644
--- a/src/lib/datasrc/tests/memory_datasrc_unittest.cc
+++ b/src/lib/datasrc/tests/memory_datasrc_unittest.cc
@@ -197,12 +197,17 @@ public:
&rr_child_dname_},
{"example.com. 300 IN A 192.0.2.10", &rr_out_},
{"*.wild.example.org. 300 IN A 192.0.2.1", &rr_wild_},
+ {"foo.wild.example.org. 300 IN A 192.0.2.3", &rr_under_wild_},
{"wild.*.foo.example.org. 300 IN A 192.0.2.1", &rr_emptywild_},
{"wild.*.foo.*.bar.example.org. 300 IN A 192.0.2.1",
&rr_nested_emptywild_},
{"*.nswild.example.org. 300 IN NS nswild.example.", &rr_nswild_},
{"*.dnamewild.example.org. 300 IN DNAME dnamewild.example.",
&rr_dnamewild_},
+ {"*.child.example.org. 300 IN A 192.0.2.1", &rr_child_wild_},
+ {"bar.foo.wild.example.org. 300 IN A 192.0.2.2", &rr_not_wild_},
+ {"baz.foo.wild.example.org. 300 IN A 192.0.2.3",
+ &rr_not_wild_another_},
{NULL, NULL}
};
@@ -252,6 +257,10 @@ public:
RRsetPtr rr_emptywild_;
RRsetPtr rr_nested_emptywild_;
RRsetPtr rr_nswild_, rr_dnamewild_;
+ RRsetPtr rr_child_wild_;
+ RRsetPtr rr_under_wild_;
+ RRsetPtr rr_not_wild_;
+ RRsetPtr rr_not_wild_another_;
/**
* \brief Test one find query to the zone.
@@ -268,13 +277,18 @@ public:
* \param answer The expected rrset, if any should be returned.
* \param zone Check different MemoryZone object than zone_ (if NULL,
* uses zone_)
+ * \param check_wild_answer Checks that the answer has the same RRs, type
+ * class and TTL as the eqxpected answer and that the name corresponds
+ * to the one searched. It is meant for checking answers for wildcard
+ * queries.
*/
void findTest(const Name& name, const RRType& rrtype, Zone::Result result,
bool check_answer = true,
const ConstRRsetPtr& answer = ConstRRsetPtr(),
RRsetList* target = NULL,
MemoryZone* zone = NULL,
- Zone::FindOptions options = Zone::FIND_DEFAULT)
+ Zone::FindOptions options = Zone::FIND_DEFAULT,
+ bool check_wild_answer = false)
{
if (!zone) {
zone = &zone_;
@@ -288,9 +302,39 @@ public:
EXPECT_EQ(result, find_result.code);
if (check_answer) {
EXPECT_EQ(answer, find_result.rrset);
+ } else if (check_wild_answer) {
+ ASSERT_NE(ConstRRsetPtr(), answer) <<
+ "Wrong test, don't check for wild names if you expect "
+ "empty answer";
+ ASSERT_NE(ConstRRsetPtr(), find_result.rrset) <<
+ "No answer found";
+ RdataIteratorPtr expectedIt(answer->getRdataIterator());
+ RdataIteratorPtr actualIt(
+ find_result.rrset->getRdataIterator());
+ while (!expectedIt->isLast() && !actualIt->isLast()) {
+ EXPECT_EQ(0, expectedIt->getCurrent().compare(
+ actualIt->getCurrent())) << "The RRs differ ('" <<
+ expectedIt->getCurrent().toText() << "', '" <<
+ actualIt->getCurrent().toText() << "')";
+ expectedIt->next();
+ actualIt->next();
+ }
+ EXPECT_TRUE(expectedIt->isLast()) <<
+ "Result has less RRs than expected";
+ EXPECT_TRUE(actualIt->isLast()) <<
+ "Result has more RRs than expected";
+ EXPECT_EQ(answer->getClass(),
+ find_result.rrset->getClass());
+ EXPECT_EQ(answer->getType(),
+ find_result.rrset->getType());
+ EXPECT_EQ(answer->getTTL(),
+ find_result.rrset->getTTL());
+ EXPECT_EQ(name, find_result.rrset->getName());
}
});
}
+ // Internal part of the cancelWildcard test that is multiple times
+ void doCancelWildcardTest();
};
/**
@@ -542,11 +586,6 @@ TEST_F(MemoryZoneTest, glue) {
findTest(Name("www.child.example.org"), RRType::A(), Zone::DELEGATION,
true, rr_child_ns_, NULL, NULL, Zone::FIND_GLUE_OK);
- // TODO:
- // glue name would match a wildcard under a zone cut: wildcard match
- // shouldn't happen under a cut and result must be PARTIALMATCH
- // (This case cannot be tested yet)
-
// nested cut case. The glue should be found.
findTest(rr_grandchild_glue_->getName(), RRType::AAAA(),
Zone::SUCCESS,
@@ -656,11 +695,11 @@ TEST_F(MemoryZoneTest, load) {
MasterLoadError);
}
-// Note: once #507 is merged, findTest() would succeed whether or not
-// we load the wildcard correctly, so the test will become meaningless.
-// The plan is to clean them up when we complete #551 (then the effect of
-// load will be indirectly tested via find() tests).
-TEST_F(MemoryZoneTest, loadWildcard) {
+/*
+ * Test that puts a (simple) wildcard into the zone and checks we can
+ * correctly find the data.
+ */
+TEST_F(MemoryZoneTest, wildcard) {
/*
* example.org.
* |
@@ -669,11 +708,96 @@ TEST_F(MemoryZoneTest, loadWildcard) {
* *
*/
EXPECT_EQ(SUCCESS, zone_.add(rr_wild_));
- findTest(Name("wild.example.org"), RRType::A(), Zone::NXRRSET);
+
+ // Search at the parent. The parent will not have the A, but it will
+ // be in the wildcard (so check the wildcard isn't matched at the parent)
+ {
+ SCOPED_TRACE("Search at parrent");
+ findTest(Name("wild.example.org"), RRType::A(), Zone::NXRRSET);
+ }
+
+ // Search the original name of wildcard
+ {
+ SCOPED_TRACE("Search directly at *");
+ findTest(Name("*.wild.example.org"), RRType::A(), Zone::SUCCESS, true,
+ rr_wild_);
+ }
+ // Search "created" name.
+ {
+ SCOPED_TRACE("Search at created child");
+ findTest(Name("a.wild.example.org"), RRType::A(), Zone::SUCCESS, false,
+ rr_wild_, NULL, NULL, Zone::FIND_DEFAULT, true);
+ }
+
+ // Search another created name, this time little bit lower
+ {
+ SCOPED_TRACE("Search at created grand-child");
+ findTest(Name("a.b.wild.example.org"), RRType::A(), Zone::SUCCESS,
+ false, rr_wild_, NULL, NULL, Zone::FIND_DEFAULT, true);
+ }
+
+ EXPECT_EQ(SUCCESS, zone_.add(rr_under_wild_));
+ {
+ SCOPED_TRACE("Search under non-wildcard");
+ findTest(Name("bar.foo.wild.example.org"), RRType::A(),
+ Zone::NXDOMAIN);
+ }
+}
+
+/*
+ * Test that we don't match a wildcard if we get under delegation.
+ * By 4.3.3 of RFC1034:
+ * "Wildcard RRs do not apply:
+ * - When the query is in another zone. That is, delegation cancels
+ * the wildcard defaults."
+ */
+TEST_F(MemoryZoneTest, delegatedWildcard) {
+ EXPECT_EQ(SUCCESS, zone_.add(rr_child_wild_));
+ EXPECT_EQ(SUCCESS, zone_.add(rr_child_ns_));
+
+ {
+ SCOPED_TRACE("Looking under delegation point");
+ findTest(Name("a.child.example.org"), RRType::A(), Zone::DELEGATION,
+ true, rr_child_ns_);
+ }
+
+ {
+ SCOPED_TRACE("Looking under delegation point in GLUE_OK mode");
+ findTest(Name("a.child.example.org"), RRType::A(), Zone::DELEGATION,
+ true, rr_child_ns_, NULL, NULL, Zone::FIND_GLUE_OK);
+ }
+}
+
+// Tests combination of wildcard and ANY.
+TEST_F(MemoryZoneTest, anyWildcard) {
+ EXPECT_EQ(SUCCESS, zone_.add(rr_wild_));
+
+ // First try directly the name (normal match)
+ {
+ SCOPED_TRACE("Asking direcly for *");
+ RRsetList target;
+ findTest(Name("*.wild.example.org"), RRType::ANY(), Zone::SUCCESS,
+ true, ConstRRsetPtr(), &target);
+ ASSERT_EQ(1, target.size());
+ EXPECT_EQ(RRType::A(), (*target.begin())->getType());
+ EXPECT_EQ(Name("*.wild.example.org"), (*target.begin())->getName());
+ }
+
+ // Then a wildcard match
+ {
+ SCOPED_TRACE("Asking in the wild way");
+ RRsetList target;
+ findTest(Name("a.wild.example.org"), RRType::ANY(), Zone::SUCCESS,
+ true, ConstRRsetPtr(), &target);
+ ASSERT_EQ(1, target.size());
+ EXPECT_EQ(RRType::A(), (*target.begin())->getType());
+ EXPECT_EQ(Name("a.wild.example.org"), (*target.begin())->getName());
+ }
}
-// same note as loadWildcard applies.
-TEST_F(MemoryZoneTest, loadEmptyWildcard) {
+// Test there's nothing in the wildcard in the middle if we load
+// wild.*.foo.example.org.
+TEST_F(MemoryZoneTest, emptyWildcard) {
/*
* example.org.
* foo
@@ -681,17 +805,171 @@ TEST_F(MemoryZoneTest, loadEmptyWildcard) {
* wild
*/
EXPECT_EQ(SUCCESS, zone_.add(rr_emptywild_));
- findTest(Name("*.foo.example.org"), RRType::A(), Zone::NXRRSET);
- findTest(Name("foo.example.org"), RRType::A(), Zone::NXRRSET);
+
+ {
+ SCOPED_TRACE("Asking for the original record under wildcard");
+ findTest(Name("wild.*.foo.example.org"), RRType::A(), Zone::SUCCESS,
+ true, rr_emptywild_);
+ }
+
+ {
+ SCOPED_TRACE("Asking for A record");
+ findTest(Name("a.foo.example.org"), RRType::A(), Zone::NXRRSET);
+ findTest(Name("*.foo.example.org"), RRType::A(), Zone::NXRRSET);
+ findTest(Name("foo.example.org"), RRType::A(), Zone::NXRRSET);
+ }
+
+ {
+ SCOPED_TRACE("Asking for ANY record");
+ RRsetList normalTarget;
+ findTest(Name("*.foo.example.org"), RRType::ANY(), Zone::NXRRSET, true,
+ ConstRRsetPtr(), &normalTarget);
+ EXPECT_EQ(0, normalTarget.size());
+
+ RRsetList wildTarget;
+ findTest(Name("a.foo.example.org"), RRType::ANY(), Zone::NXRRSET, true,
+ ConstRRsetPtr(), &wildTarget);
+ EXPECT_EQ(0, wildTarget.size());
+ }
+
+ {
+ SCOPED_TRACE("Asking on the non-terminal");
+ findTest(Name("wild.bar.foo.example.org"), RRType::A(),
+ Zone::NXRRSET);
+ }
}
-// same note as loadWildcard applies.
-TEST_F(MemoryZoneTest, loadNestedEmptyWildcard) {
+// Same as emptyWildcard, but with multiple * in the path.
+TEST_F(MemoryZoneTest, nestedEmptyWildcard) {
EXPECT_EQ(SUCCESS, zone_.add(rr_nested_emptywild_));
- findTest(Name("*.foo.*.bar.example.org"), RRType::A(), Zone::NXRRSET);
- findTest(Name("foo.*.bar.example.org"), RRType::A(), Zone::NXRRSET);
- findTest(Name("*.bar.example.org"), RRType::A(), Zone::NXRRSET);
- findTest(Name("bar.example.org"), RRType::A(), Zone::NXRRSET);
+
+ {
+ SCOPED_TRACE("Asking for the original record under wildcards");
+ findTest(Name("wild.*.foo.*.bar.example.org"), RRType::A(),
+ Zone::SUCCESS, true, rr_nested_emptywild_);
+ }
+
+ {
+ SCOPED_TRACE("Matching wildcard against empty nonterminal");
+
+ const char* names[] = {
+ "baz.foo.*.bar.example.org",
+ "baz.foo.baz.bar.example.org",
+ "*.foo.baz.bar.example.org",
+ NULL
+ };
+
+ for (const char** name(names); *name != NULL; ++ name) {
+ SCOPED_TRACE(string("Node ") + *name);
+ findTest(Name(*name), RRType::A(), Zone::NXRRSET);
+ }
+ }
+
+ // Domains to test
+ const char* names[] = {
+ "*.foo.*.bar.example.org",
+ "foo.*.bar.example.org",
+ "*.bar.example.org",
+ "bar.example.org",
+ NULL
+ };
+
+ {
+ SCOPED_TRACE("Asking directly for A on parent nodes");
+
+ for (const char** name(names); *name != NULL; ++ name) {
+ SCOPED_TRACE(string("Node ") + *name);
+ findTest(Name(*name), RRType::A(), Zone::NXRRSET);
+ }
+ }
+
+ {
+ SCOPED_TRACE("Asking for ANY on parent nodes");
+
+ for (const char** name(names); *name != NULL; ++ name) {
+ SCOPED_TRACE(string("Node ") + *name);
+
+ RRsetList target;
+ findTest(Name(*name), RRType::ANY(), Zone::NXRRSET, true,
+ ConstRRsetPtr(), &target);
+ EXPECT_EQ(0, target.size());
+ }
+ }
+}
+
+// We run this part twice from the below test, in two slightly different
+// situations
+void
+MemoryZoneTest::doCancelWildcardTest() {
+ // These should be canceled
+ {
+ SCOPED_TRACE("Canceled under foo.wild.example.org");
+ findTest(Name("aaa.foo.wild.example.org"), RRType::A(),
+ Zone::NXDOMAIN);
+ findTest(Name("zzz.foo.wild.example.org"), RRType::A(),
+ Zone::NXDOMAIN);
+ }
+
+ // This is existing, non-wildcard domain, shouldn't wildcard at all
+ {
+ SCOPED_TRACE("Existing domain under foo.wild.example.org");
+ findTest(Name("bar.foo.wild.example.org"), RRType::A(), Zone::SUCCESS,
+ true, rr_not_wild_);
+ }
+
+ // These should be caught by the wildcard
+ {
+ SCOPED_TRACE("Neighbor wildcards to foo.wild.example.org");
+
+ const char* names[] = {
+ "aaa.bbb.wild.example.org",
+ "aaa.zzz.wild.example.org",
+ "zzz.wild.example.org",
+ NULL
+ };
+
+ for (const char** name(names); *name != NULL; ++ name) {
+ SCOPED_TRACE(string("Node ") + *name);
+
+ findTest(Name(*name), RRType::A(), Zone::SUCCESS, false, rr_wild_,
+ NULL, NULL, Zone::FIND_DEFAULT, true);
+ }
+ }
+
+ // This shouldn't be wildcarded, it's an existing domain
+ {
+ SCOPED_TRACE("The foo.wild.example.org itself");
+ findTest(Name("foo.wild.example.org"), RRType::A(), Zone::NXRRSET);
+ }
+}
+
+/*
+ * This tests that if there's a name between the wildcard domain and the
+ * searched one, it will not trigger wildcard, for example, if we have
+ * *.wild.example.org and bar.foo.wild.example.org, then we know
+ * foo.wild.example.org exists and is not wildcard. Therefore, search for
+ * aaa.foo.wild.example.org should return NXDOMAIN.
+ *
+ * Tests few cases "around" the canceled wildcard match, to see something that
+ * shouldn't be canceled isn't.
+ */
+TEST_F(MemoryZoneTest, cancelWildcard) {
+ EXPECT_EQ(SUCCESS, zone_.add(rr_wild_));
+ EXPECT_EQ(SUCCESS, zone_.add(rr_not_wild_));
+
+ {
+ SCOPED_TRACE("Runnig with single entry under foo.wild.example.org");
+ doCancelWildcardTest();
+ }
+
+ // Try putting another one under foo.wild....
+ // The result should be the same but it will be done in another way in the
+ // code, because the foo.wild.example.org will exist in the tree.
+ EXPECT_EQ(SUCCESS, zone_.add(rr_not_wild_another_));
+ {
+ SCOPED_TRACE("Runnig with two entries under foo.wild.example.org");
+ doCancelWildcardTest();
+ }
}
TEST_F(MemoryZoneTest, loadBadWildcard) {
diff --git a/src/lib/datasrc/tests/rbtree_unittest.cc b/src/lib/datasrc/tests/rbtree_unittest.cc
index 82eed63..23b25f4 100644
--- a/src/lib/datasrc/tests/rbtree_unittest.cc
+++ b/src/lib/datasrc/tests/rbtree_unittest.cc
@@ -56,7 +56,7 @@ const size_t Name::MAX_LABELS;
namespace {
class RBTreeTest : public::testing::Test {
protected:
- RBTreeTest() : rbtree_expose_empty_node(true) {
+ RBTreeTest() : rbtree_expose_empty_node(true), crbtnode(NULL) {
const char* const domain_names[] = {
"c", "b", "a", "x.d.e.f", "z.d.e.f", "g.h", "i.g.h", "o.w.y.d.e.f",
"j.z.d.e.f", "p.w.y.d.e.f", "q.w.y.d.e.f"};
diff --git a/src/lib/dns/Makefile.am b/src/lib/dns/Makefile.am
index 4b1a64b..c5c5cd1 100644
--- a/src/lib/dns/Makefile.am
+++ b/src/lib/dns/Makefile.am
@@ -85,6 +85,8 @@ libdns___la_SOURCES += rrtype.cc
libdns___la_SOURCES += question.h question.cc
libdns___la_SOURCES += util/sha1.h util/sha1.cc
libdns___la_SOURCES += tsigkey.h tsigkey.cc
+libdns___la_SOURCES += rdata/generic/detail/nsec_bitmap.h
+libdns___la_SOURCES += rdata/generic/detail/nsec_bitmap.cc
nodist_libdns___la_SOURCES = rdataclass.cc rrclass.h rrtype.h
nodist_libdns___la_SOURCES += rrparamregistry.cc
@@ -117,5 +119,6 @@ libdns___include_HEADERS = \
tsigkey.h
# Purposely not installing these headers:
# util/*.h: used only internally, and not actually DNS specific
+# rdata/*/detail/*.h: these are internal use only
# rrclass-placeholder.h
# rrtype-placeholder.h
diff --git a/src/lib/dns/dnssectime.cc b/src/lib/dns/dnssectime.cc
index 04643e2..c889178 100644
--- a/src/lib/dns/dnssectime.cc
+++ b/src/lib/dns/dnssectime.cc
@@ -12,6 +12,10 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
+#include <stdint.h>
+
+#include <sys/time.h>
+
#include <string>
#include <iomanip>
#include <iostream>
@@ -26,30 +30,121 @@
using namespace std;
+namespace {
+int days[12] = { 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 };
+
+inline bool
+isLeap(const int y) {
+ return ((((y) % 4) == 0 && ((y) % 100) != 0) || ((y) % 400) == 0);
+}
+
+unsigned int
+yearSecs(const int year) {
+ return ((isLeap(year) ? 366 : 365 ) * 86400);
+}
+
+unsigned int
+monthSecs(const int month, const int year) {
+ return ((days[month] + ((month == 1 && isLeap(year)) ? 1 : 0 )) * 86400);
+}
+}
+
namespace isc {
namespace dns {
string
-timeToText(const time_t timeval) {
- struct tm* const t = gmtime(&timeval);
-
- // gmtime() will keep most values within range, but it can
- // produce a five-digit year; check for this.
- if ((t->tm_year + 1900) > 9999) {
- isc_throw(InvalidTime, "Time value out of range: year > 9999");
+timeToText64(uint64_t value) {
+ struct tm tm;
+ unsigned int secs;
+
+ // We cannot rely on gmtime() because time_t may not be of 64 bit
+ // integer. The following conversion logic is borrowed from BIND 9.
+ tm.tm_year = 70;
+ while ((secs = yearSecs(tm.tm_year + 1900)) <= value) {
+ value -= secs;
+ ++tm.tm_year;
+ if (tm.tm_year + 1900 > 9999) {
+ isc_throw(InvalidTime,
+ "Time value out of range (year > 9999): " <<
+ tm.tm_year + 1900);
+ }
+ }
+ tm.tm_mon = 0;
+ while ((secs = monthSecs(tm.tm_mon, tm.tm_year + 1900)) <= value) {
+ value -= secs;
+ tm.tm_mon++;
}
+ tm.tm_mday = 1;
+ while (86400 <= value) {
+ value -= 86400;
+ ++tm.tm_mday;
+ }
+ tm.tm_hour = 0;
+ while (3600 <= value) {
+ value -= 3600;
+ ++tm.tm_hour;
+ }
+ tm.tm_min = 0;
+ while (60 <= value) {
+ value -= 60;
+ ++tm.tm_min;
+ }
+ tm.tm_sec = value; // now t < 60, so this substitution is safe.
ostringstream oss;
oss << setfill('0')
- << setw(4) << t->tm_year + 1900
- << setw(2) << t->tm_mon + 1
- << setw(2) << t->tm_mday
- << setw(2) << t->tm_hour
- << setw(2) << t->tm_min
- << setw(2) << t->tm_sec;
+ << setw(4) << tm.tm_year + 1900
+ << setw(2) << tm.tm_mon + 1
+ << setw(2) << tm.tm_mday
+ << setw(2) << tm.tm_hour
+ << setw(2) << tm.tm_min
+ << setw(2) << tm.tm_sec;
return (oss.str());
}
+// timeToText32() below uses the current system time. To test it with
+// unusual current time values we introduce the following function pointer;
+// when it's non NULL, we call it to get the (normally faked) current time.
+// Otherwise we use the standard gettimeofday(2). This hook is specifically
+// intended for testing purposes, so, even if it's visible outside of this
+// library, it's not even declared in a header file.
+namespace dnssectime {
+namespace detail {
+int64_t (*gettimeFunction)() = NULL;
+}
+}
+
+namespace {
+int64_t
+gettimeofdayWrapper() {
+ using namespace dnssectime::detail;
+ if (gettimeFunction != NULL) {
+ return (gettimeFunction());
+ }
+
+ struct timeval now;
+ gettimeofday(&now, NULL);
+
+ return (static_cast<int64_t>(now.tv_sec));
+}
+}
+
+string
+timeToText32(const uint32_t value) {
+ // We first adjust the time to the closest epoch based on the current time.
+ // Note that the following variables must be signed in order to handle
+ // time until year 2038 correctly.
+ const int64_t start = gettimeofdayWrapper() - 0x7fffffff;
+ int64_t base = 0;
+ int64_t t;
+ while ((t = (base + value)) < start) {
+ base += 0x100000000LL;
+ }
+
+ // Then convert it to text.
+ return (timeToText64(t));
+}
+
namespace {
const size_t DATE_LEN = 14; // YYYYMMDDHHmmSS
@@ -62,27 +157,20 @@ checkRange(const int min, const int max, const int value,
}
isc_throw(InvalidTime, "Invalid " << valname << "value: " << value);
}
-
-int days[12] = { 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 };
-
-inline bool
-isLeap(const int y) {
- return ((((y) % 4) == 0 && ((y) % 100) != 0) || ((y) % 400) == 0);
-}
}
-time_t
-timeFromText(const string& time_txt) {
- // first try reading YYYYMMDDHHmmSS format
- int year, month, day, hour, minute, second;
-
+uint64_t
+timeFromText64(const string& time_txt) {
+ // Confirm the source only consists digits. sscanf() allows some
+ // minor exceptions.
for (int i = 0; i < time_txt.length(); ++i) {
if (!isdigit(time_txt.at(i))) {
- isc_throw(InvalidTime,
- "Couldn't convert non-numeric time value: " << time_txt);
+ isc_throw(InvalidTime, "Couldn't convert non-numeric time value: "
+ << time_txt);
}
}
+ int year, month, day, hour, minute, second;
if (time_txt.length() != DATE_LEN ||
sscanf(time_txt.c_str(), "%4d%2d%2d%2d%2d%2d",
&year, &month, &day, &hour, &minute, &second) != 6)
@@ -98,9 +186,9 @@ timeFromText(const string& time_txt) {
checkRange(0, 59, minute, "minute");
checkRange(0, 60, second, "second"); // 60 == leap second.
- time_t timeval = second + (60 * minute) + (3600 * hour) +
+ uint64_t timeval = second + (60 * minute) + (3600 * hour) +
((day - 1) * 86400);
- for (int m = 0; m < (month - 1); m++) {
+ for (int m = 0; m < (month - 1); ++m) {
timeval += days[m] * 86400;
}
if (isLeap(year) && month > 2) {
@@ -112,5 +200,12 @@ timeFromText(const string& time_txt) {
return (timeval);
}
+
+uint32_t
+timeFromText32(const string& time_txt) {
+ // The implicit conversion from uint64_t to uint32_t should just work here,
+ // because we only need to drop higher 32 bits.
+ return (timeFromText64(time_txt));
+}
}
}
diff --git a/src/lib/dns/dnssectime.h b/src/lib/dns/dnssectime.h
index 5069650..baf866f 100644
--- a/src/lib/dns/dnssectime.h
+++ b/src/lib/dns/dnssectime.h
@@ -17,7 +17,6 @@
#include <sys/types.h>
#include <stdint.h>
-#include <time.h>
#include <exceptions/exceptions.h>
@@ -40,11 +39,102 @@ public:
isc::Exception(file, line, what) {}
};
-time_t
-timeFromText(const std::string& time_txt);
+///
+/// \name DNSSEC time conversion functions.
+///
+/// These functions convert between times represented in seconds (in integer)
+/// since epoch and those in the textual form used in the RRSIG records.
+/// For integers we provide both 32-bit and 64-bit versions.
+/// The RRSIG expiration and inception fields are both 32-bit unsigned
+/// integers, so 32-bit versions would be more useful for protocol operations.
+/// However, with 32-bit integers we need to take into account wrap-around
+/// points and compare values using the serial number arithmetic as specified
+/// in RFC4034, which would be more error prone. We therefore provide 64-bit
+/// versions, too.
+///
+/// The timezone is always UTC for these functions.
+//@{
+/// Convert textual DNSSEC time to integer, 64-bit version.
+///
+/// The textual form must only consist of digits and be in the form of
+/// YYYYMMDDHHmmSS, where:
+/// - YYYY must be between 1970 and 9999
+/// - MM must be between 01 and 12
+/// - DD must be between 01 and 31 and must be a valid day for the month
+/// represented in 'MM'. For example, if MM is 04, DD cannot be 31.
+/// DD can be 29 when MM is 02 only when YYYY is a leap year.
+/// - HH must be between 00 and 23
+/// - mm must be between 00 and 59
+/// - SS must be between 00 and 60
+///
+/// For all fields the range includes the begin and end values. Note that
+/// 60 is allowed for 'SS', intending a leap second, although in real operation
+/// it's unlikely to be specified.
+///
+/// If the given text is valid, this function converts it to an unsigned
+/// 64-bit number of seconds since epoch (1 January 1970 00:00:00) and returns
+/// the converted value. 64 bits are sufficient to represent all possible
+/// values for the valid format uniquely, so there is no overflow.
+///
+/// \note RFC4034 also defines the textual form of an unsigned decimal integer
+/// for the corresponding time in seconds. This function doesn't support
+/// this form, and if given it throws an exception of class \c InvalidTime.
+///
+/// \exception InvalidTime The given textual representation is invalid.
+///
+/// \param time_txt Textual time in the form of YYYYMMDDHHmmSS
+/// \return Seconds since epoch corresponding to \c time_txt
+uint64_t
+timeFromText64(const std::string& time_txt);
+/// Convert textual DNSSEC time to integer, 32-bit version.
+///
+/// This version is the same as \c timeFromText64() except that the return
+/// value is wrapped around to an unsigned 32-bit integer, simply dropping
+/// the upper 32 bits.
+uint32_t
+timeFromText32(const std::string& time_txt);
+
+/// Convert integral DNSSEC time to textual form, 64-bit version.
+///
+/// This function takes an integer that would be seconds since epoch and
+/// converts it in the form of YYYYMMDDHHmmSS. For example, if \c value is
+/// 0, it returns "19700101000000". If the value corresponds to a point
+/// of time on and after year 10,000, which cannot be represented in the
+/// YYYY... form, an exception of class \c InvalidTime will be thrown.
+///
+/// \exception InvalidTime The given time specifies on or after year 10,000.
+/// \exception Other A standard exception, if resource allocation for the
+/// returned text fails.
+///
+/// \param value Seconds since epoch to be converted.
+/// \return Textual representation of \c value in the form of YYYYMMDDHHmmSS.
std::string
-timeToText(const time_t timeval);
+timeToText64(uint64_t value);
+
+/// Convert integral DNSSEC time to textual form, 32-bit version.
+///
+/// This version is the same as \c timeToText64(), but the time value
+/// is expected to be the lower 32 bits of the full 64-bit value.
+/// These two will be different on and after a certain point of time
+/// in year 2106, so this function internally resolves the ambiguity
+/// using the current system time at the time of function call;
+/// it first identifies the range of [N*2^32 - 2^31, N*2^32 + 2^31)
+/// that contains the current time, and interprets \c value in the context
+/// of that range. It then applies the same process as \c timeToText64().
+///
+/// There is one important exception in this processing, however.
+/// Until 19 Jan 2038 03:14:08 (2^31 seconds since epoch), this range
+/// would contain time before epoch. In order to ensure the returned
+/// value is also a valid input to \c timeFromText, this function uses
+/// a special range [0, 2^32) until that time. As a result, all upper
+/// half of the 32-bit values are treated as a future time. For example,
+/// 2^32-1 (the highest value in 32-bit unsigned integers) will be converted
+/// to "21060207062815", instead of "19691231235959".
+std::string
+timeToText32(const uint32_t value);
+
+//@}
}
}
diff --git a/src/lib/dns/message.cc b/src/lib/dns/message.cc
index c966116..9eae605 100644
--- a/src/lib/dns/message.cc
+++ b/src/lib/dns/message.cc
@@ -113,10 +113,8 @@ public:
vector<RRsetPtr> rrsets_[NUM_SECTIONS];
ConstEDNSPtr edns_;
-#ifdef notyet
// tsig/sig0: TODO
- RRsetsSorter* sorter_;
-#endif
+ // RRsetsSorter* sorter_; : TODO
void init();
void setOpcode(const Opcode& opcode);
diff --git a/src/lib/dns/python/messagerenderer_python.cc b/src/lib/dns/python/messagerenderer_python.cc
index 91ab0c5..a00d8d4 100644
--- a/src/lib/dns/python/messagerenderer_python.cc
+++ b/src/lib/dns/python/messagerenderer_python.cc
@@ -37,9 +37,10 @@ static PyObject* MessageRenderer_getData(s_MessageRenderer* self);
static PyObject* MessageRenderer_getLength(s_MessageRenderer* self);
static PyObject* MessageRenderer_isTruncated(s_MessageRenderer* self);
static PyObject* MessageRenderer_getLengthLimit(s_MessageRenderer* self);
-// TODO: set/get compressmode
+static PyObject* MessageRenderer_getCompressMode(s_MessageRenderer* self);
static PyObject* MessageRenderer_setTruncated(s_MessageRenderer* self);
static PyObject* MessageRenderer_setLengthLimit(s_MessageRenderer* self, PyObject* args);
+static PyObject* MessageRenderer_setCompressMode(s_MessageRenderer* self, PyObject* args);
static PyObject* MessageRenderer_clear(s_MessageRenderer* self);
static PyMethodDef MessageRenderer_methods[] = {
@@ -51,10 +52,14 @@ static PyMethodDef MessageRenderer_methods[] = {
"Returns True if the data is truncated" },
{ "get_length_limit", reinterpret_cast<PyCFunction>(MessageRenderer_getLengthLimit), METH_NOARGS,
"Returns the length limit of the data" },
+ { "get_compress_mode", reinterpret_cast<PyCFunction>(MessageRenderer_getCompressMode), METH_NOARGS,
+ "Returns the current compression mode" },
{ "set_truncated", reinterpret_cast<PyCFunction>(MessageRenderer_setTruncated), METH_NOARGS,
"Sets truncated to true" },
{ "set_length_limit", reinterpret_cast<PyCFunction>(MessageRenderer_setLengthLimit), METH_VARARGS,
"Sets the length limit of the data to the given number" },
+ { "set_compress_mode", reinterpret_cast<PyCFunction>(MessageRenderer_setCompressMode), METH_VARARGS,
+ "Sets the compression mode of the MessageRenderer" },
{ "clear", reinterpret_cast<PyCFunction>(MessageRenderer_clear),
METH_NOARGS,
"Clear the internal buffer and other internal resources." },
@@ -159,6 +164,11 @@ MessageRenderer_getLengthLimit(s_MessageRenderer* self) {
}
static PyObject*
+MessageRenderer_getCompressMode(s_MessageRenderer* self) {
+ return (Py_BuildValue("I", self->messagerenderer->getCompressMode()));
+}
+
+static PyObject*
MessageRenderer_setTruncated(s_MessageRenderer* self) {
self->messagerenderer->setTruncated();
Py_RETURN_NONE;
@@ -177,6 +187,31 @@ MessageRenderer_setLengthLimit(s_MessageRenderer* self,
}
static PyObject*
+MessageRenderer_setCompressMode(s_MessageRenderer* self,
+ PyObject* args)
+{
+ unsigned int mode;
+ if (!PyArg_ParseTuple(args, "I", &mode)) {
+ return (NULL);
+ }
+
+ if (mode == MessageRenderer::CASE_INSENSITIVE) {
+ self->messagerenderer->setCompressMode(MessageRenderer::CASE_INSENSITIVE);
+ // If we return NULL it is seen as an error, so use this for
+ // None returns, it also applies to CASE_SENSITIVE.
+ Py_RETURN_NONE;
+ } else if (mode == MessageRenderer::CASE_SENSITIVE) {
+ self->messagerenderer->setCompressMode(MessageRenderer::CASE_SENSITIVE);
+ Py_RETURN_NONE;
+ } else {
+ PyErr_SetString(PyExc_TypeError,
+ "MessageRenderer compress mode must be MessageRenderer.CASE_INSENSITIVE"
+ "or MessageRenderer.CASE_SENSITIVE");
+ return (NULL);
+ }
+}
+
+static PyObject*
MessageRenderer_clear(s_MessageRenderer* self) {
self->messagerenderer->clear();
Py_RETURN_NONE;
@@ -203,6 +238,14 @@ initModulePart_MessageRenderer(PyObject* mod) {
return (false);
}
Py_INCREF(&messagerenderer_type);
+
+ // Class variables
+ // These are added to the tp_dict of the type object
+ addClassVariable(messagerenderer_type, "CASE_INSENSITIVE",
+ Py_BuildValue("I", MessageRenderer::CASE_INSENSITIVE));
+ addClassVariable(messagerenderer_type, "CASE_SENSITIVE",
+ Py_BuildValue("I", MessageRenderer::CASE_SENSITIVE));
+
PyModule_AddObject(mod, "MessageRenderer",
reinterpret_cast<PyObject*>(&messagerenderer_type));
diff --git a/src/lib/dns/python/tests/messagerenderer_python_test.py b/src/lib/dns/python/tests/messagerenderer_python_test.py
index 62e2d51..544ad23 100644
--- a/src/lib/dns/python/tests/messagerenderer_python_test.py
+++ b/src/lib/dns/python/tests/messagerenderer_python_test.py
@@ -28,7 +28,7 @@ class MessageRendererTest(unittest.TestCase):
c = RRClass("IN")
t = RRType("A")
ttl = RRTTL("3600")
-
+
message = Message(Message.RENDER)
message.set_qid(123)
message.set_opcode(Opcode.QUERY())
@@ -56,14 +56,14 @@ class MessageRendererTest(unittest.TestCase):
self.message1.to_wire(self.renderer1)
self.message2.to_wire(self.renderer2)
self.message2.to_wire(self.renderer3)
-
-
+
+
def test_messagerenderer_get_data(self):
data1 = b'\x00{\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x07example\x03com\x00\x00\x01\x00\x01'
self.assertEqual(data1, self.renderer1.get_data())
data2 = b'\x00{\x84\x00\x00\x01\x00\x00\x00\x02\x00\x00\x07example\x03com\x00\x00\x01\x00\x01\xc0\x0c\x00\x01\x00\x01\x00\x00\x0e\x10\x00\x04\xc0\x00\x02b\xc0\x0c\x00\x01\x00\x01\x00\x00\x0e\x10\x00\x04\xc0\x00\x02c'
self.assertEqual(data2, self.renderer2.get_data())
-
+
def test_messagerenderer_get_length(self):
self.assertEqual(29, self.renderer1.get_length())
self.assertEqual(61, self.renderer2.get_length())
@@ -79,6 +79,14 @@ class MessageRendererTest(unittest.TestCase):
self.assertEqual(512, self.renderer2.get_length_limit())
self.assertEqual(50, self.renderer3.get_length_limit())
+ def test_messagerenderer_get_compress_mode(self):
+ self.assertEqual(MessageRenderer.CASE_INSENSITIVE,
+ self.renderer1.get_compress_mode())
+ self.assertEqual(MessageRenderer.CASE_INSENSITIVE,
+ self.renderer2.get_compress_mode())
+ self.assertEqual(MessageRenderer.CASE_INSENSITIVE,
+ self.renderer3.get_compress_mode())
+
def test_messagerenderer_set_truncated(self):
self.assertFalse(self.renderer1.is_truncated())
self.renderer1.set_truncated()
@@ -91,5 +99,17 @@ class MessageRendererTest(unittest.TestCase):
self.assertEqual(1024, renderer.get_length_limit())
self.assertRaises(TypeError, renderer.set_length_limit, "wrong")
+ def test_messagerenderer_set_compress_mode(self):
+ renderer = MessageRenderer()
+ self.assertEqual(MessageRenderer.CASE_INSENSITIVE,
+ renderer.get_compress_mode())
+ renderer.set_compress_mode(MessageRenderer.CASE_SENSITIVE)
+ self.assertEqual(MessageRenderer.CASE_SENSITIVE,
+ renderer.get_compress_mode())
+ renderer.set_compress_mode(MessageRenderer.CASE_INSENSITIVE)
+ self.assertEqual(MessageRenderer.CASE_INSENSITIVE,
+ renderer.get_compress_mode())
+ self.assertRaises(TypeError, renderer.set_compress_mode, "wrong")
+
if __name__ == '__main__':
unittest.main()
diff --git a/src/lib/dns/rdata/generic/detail/nsec_bitmap.cc b/src/lib/dns/rdata/generic/detail/nsec_bitmap.cc
new file mode 100644
index 0000000..a72058f
--- /dev/null
+++ b/src/lib/dns/rdata/generic/detail/nsec_bitmap.cc
@@ -0,0 +1,78 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#include <stdint.h>
+
+#include <vector>
+
+#include <dns/exceptions.h>
+
+using namespace std;
+
+namespace isc {
+namespace dns {
+namespace rdata {
+namespace generic {
+namespace detail {
+namespace nsec {
+void
+checkRRTypeBitmaps(const char* const rrtype_name,
+ const vector<uint8_t>& typebits)
+{
+ bool first = true;
+ unsigned int lastblock = 0;
+ const size_t total_len = typebits.size();
+ size_t i = 0;
+
+ while (i < total_len) {
+ if (i + 2 > total_len) {
+ isc_throw(DNSMessageFORMERR, rrtype_name <<
+ " RDATA from wire: incomplete bit map field");
+ }
+ const unsigned int block = typebits[i];
+ const size_t len = typebits[i + 1];
+ // Check that bitmap window blocks are in the correct order.
+ if (!first && block <= lastblock) {
+ isc_throw(DNSMessageFORMERR, rrtype_name <<
+ " RDATA from wire: Disordered window blocks found: "
+ << lastblock << " then " << block);
+ }
+ // Check for legal length
+ if (len < 1 || len > 32) {
+ isc_throw(DNSMessageFORMERR, rrtype_name <<
+ " RDATA from wire: Invalid bitmap length: " << len);
+ }
+ // Check for overflow.
+ i += 2;
+ if (i + len > total_len) {
+ isc_throw(DNSMessageFORMERR, rrtype_name <<
+ " RDATA from wire: bitmap length too large: " << len);
+ }
+ // The last octet of the bitmap must be non zero.
+ if (typebits[i + len - 1] == 0) {
+ isc_throw(DNSMessageFORMERR, rrtype_name <<
+ " RDATA from wire: bitmap ending an all-zero byte");
+ }
+
+ i += len;
+ lastblock = block;
+ first = false;
+ }
+}
+}
+}
+}
+}
+}
+}
diff --git a/src/lib/dns/rdata/generic/detail/nsec_bitmap.h b/src/lib/dns/rdata/generic/detail/nsec_bitmap.h
new file mode 100644
index 0000000..6431e10
--- /dev/null
+++ b/src/lib/dns/rdata/generic/detail/nsec_bitmap.h
@@ -0,0 +1,51 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#include <stdint.h>
+
+#include <vector>
+
+namespace isc {
+namespace dns {
+namespace rdata {
+namespace generic {
+namespace detail {
+namespace nsec {
+/// Check if a given "type bitmap" for NSEC/NSEC3 is valid.
+///
+/// This helper function checks given wire format data (stored in a
+/// \c std::vector) is a valid type bitmaps used for the NSEC and NSEC3 RRs
+/// according to RFC4034 and RFC5155. The validation logic is the same
+/// for these two RRs, so a unified check function is provided.
+/// This function is essentially private and is only expected to be called
+/// from the \c NSEC and \c NSEC3 class implementations.
+///
+/// \exception DNSMessageFORMERR The bitmap is not valid.
+///
+/// \param rrtype_name Either "NSEC" or "NSEC3"; used as part of exception
+/// messages.
+/// \param typebits The type bitmaps in wire format. The size of vector
+/// is the total length of the bitmaps.
+void checkRRTypeBitmaps(const char* const rrtype_name,
+ const std::vector<uint8_t>& typebits);
+}
+}
+}
+}
+}
+}
+
+// Local Variables:
+// mode: c++
+// End:
diff --git a/src/lib/dns/rdata/generic/nsec3_50.cc b/src/lib/dns/rdata/generic/nsec3_50.cc
index c20fda2..fbe6612 100644
--- a/src/lib/dns/rdata/generic/nsec3_50.cc
+++ b/src/lib/dns/rdata/generic/nsec3_50.cc
@@ -30,11 +30,13 @@
#include <dns/rrttl.h>
#include <dns/rdata.h>
#include <dns/rdataclass.h>
+#include <dns/rdata/generic/detail/nsec_bitmap.h>
#include <stdio.h>
#include <time.h>
using namespace std;
+using namespace isc::dns::rdata::generic::detail::nsec;
// BEGIN_ISC_NAMESPACE
// BEGIN_RDATA_NAMESPACE
@@ -61,50 +63,70 @@ NSEC3::NSEC3(const string& nsec3_str) :
{
istringstream iss(nsec3_str);
unsigned int hashalg, flags, iterations;
- string salthex;
+ string iterations_str, salthex, nexthash;
- iss >> hashalg >> flags >> iterations >> salthex;
+ iss >> hashalg >> flags >> iterations_str >> salthex >> nexthash;
if (iss.bad() || iss.fail()) {
- isc_throw(InvalidRdataText, "Invalid NSEC3 text");
+ isc_throw(InvalidRdataText, "Invalid NSEC3 text: " << nsec3_str);
}
- if (hashalg > 0xf) {
- isc_throw(InvalidRdataText, "NSEC3 hash algorithm out of range");
+ if (hashalg > 0xff) {
+ isc_throw(InvalidRdataText,
+ "NSEC3 hash algorithm out of range: " << hashalg);
}
if (flags > 0xff) {
- isc_throw(InvalidRdataText, "NSEC3 flags out of range");
+ isc_throw(InvalidRdataText, "NSEC3 flags out of range: " << flags);
+ }
+ // Convert iteration. To reject an invalid case where there's no space
+ // between iteration and salt, we extract this field as string and convert
+ // to integer.
+ try {
+ iterations = boost::lexical_cast<unsigned int>(iterations_str);
+ } catch (const boost::bad_lexical_cast&) {
+ isc_throw(InvalidRdataText, "Bad NSEC3 iteration: " << iterations_str);
}
if (iterations > 0xffff) {
- isc_throw(InvalidRdataText, "NSEC3 iterations out of range");
+ isc_throw(InvalidRdataText, "NSEC3 iterations out of range: " <<
+ iterations);
}
vector<uint8_t> salt;
- decodeHex(salthex, salt);
+ if (salthex != "-") { // "-" means a 0-length salt
+ decodeHex(salthex, salt);
+ }
+ if (salt.size() > 255) {
+ isc_throw(InvalidRdataText, "NSEC3 salt is too long: "
+ << salt.size() << " bytes");
+ }
- string nextstr;
- iss >> setw(32) >> nextstr;
vector<uint8_t> next;
- if (iss.bad() || iss.fail()) {
- isc_throw(InvalidRdataText, "Invalid NSEC3 hash algorithm");
+ decodeBase32Hex(nexthash, next);
+ if (next.size() > 255) {
+ isc_throw(InvalidRdataText, "NSEC3 hash is too long: "
+ << next.size() << " bytes");
}
- decodeBase32Hex(nextstr, next);
- uint8_t bitmap[8 * 1024]; // 64k bits
- vector<uint8_t> typebits;
+ // For NSEC3 empty bitmap is possible and allowed.
+ if (iss.eof()) {
+ impl_ = new NSEC3Impl(hashalg, flags, iterations, salt, next,
+ vector<uint8_t>());
+ return;
+ }
+ vector<uint8_t> typebits;
+ uint8_t bitmap[8 * 1024]; // 64k bits
memset(bitmap, 0, sizeof(bitmap));
do {
string type;
- int code;
iss >> type;
if (type.length() != 0) {
try {
- code = RRType(type).getCode();
+ const int code = RRType(type).getCode();
bitmap[code / 8] |= (0x80 >> (code % 8));
} catch (...) {
isc_throw(InvalidRdataText, "Invalid RRtype in NSEC3");
}
}
- } while(!iss.eof());
+ } while (!iss.eof());
for (int window = 0; window < 256; window++) {
int octet;
@@ -126,56 +148,46 @@ NSEC3::NSEC3(const string& nsec3_str) :
}
NSEC3::NSEC3(InputBuffer& buffer, size_t rdata_len) {
+ // NSEC3 RR must have at least 5 octets:
+ // hash algorithm(1), flags(1), iteration(2), saltlen(1)
if (rdata_len < 5) {
- isc_throw(InvalidRdataLength, "NSEC3 too short");
+ isc_throw(DNSMessageFORMERR, "NSEC3 too short, length: " << rdata_len);
}
- uint8_t hashalg = buffer.readUint8();
- uint8_t flags = buffer.readUint8();
- uint16_t iterations = buffer.readUint16();
- rdata_len -= 4;
-
- uint8_t saltlen = buffer.readUint8();
- --rdata_len;
+ const uint8_t hashalg = buffer.readUint8();
+ const uint8_t flags = buffer.readUint8();
+ const uint16_t iterations = buffer.readUint16();
+ const uint8_t saltlen = buffer.readUint8();
+ rdata_len -= 5;
if (rdata_len < saltlen) {
- isc_throw(InvalidRdataLength, "NSEC3 salt too short");
+ isc_throw(DNSMessageFORMERR, "NSEC3 salt length is too large: " <<
+ static_cast<unsigned int>(saltlen));
}
vector<uint8_t> salt(saltlen);
- buffer.readData(&salt[0], saltlen);
- rdata_len -= saltlen;
+ if (saltlen > 0) {
+ buffer.readData(&salt[0], saltlen);
+ rdata_len -= saltlen;
+ }
- uint8_t nextlen = buffer.readUint8();
+ const uint8_t nextlen = buffer.readUint8();
--rdata_len;
-
- if (rdata_len < nextlen) {
- isc_throw(InvalidRdataLength, "NSEC3 next hash too short");
+ if (nextlen == 0 || rdata_len < nextlen) {
+ isc_throw(DNSMessageFORMERR, "NSEC3 invalid hash length: " <<
+ static_cast<unsigned int>(nextlen));
}
vector<uint8_t> next(nextlen);
buffer.readData(&next[0], nextlen);
rdata_len -= nextlen;
- if (rdata_len == 0) {
- isc_throw(InvalidRdataLength, "NSEC3 type bitmap too short");
- }
-
vector<uint8_t> typebits(rdata_len);
- buffer.readData(&typebits[0], rdata_len);
-
- int len = 0;
- for (int i = 0; i < typebits.size(); i += len) {
- if (i + 2 > typebits.size()) {
- isc_throw(DNSMessageFORMERR, "Invalid rdata: "
- "bad NSEC3 type bitmap");
- }
- len = typebits[i + 1];
- if (len > 31) {
- isc_throw(DNSMessageFORMERR, "Invalid rdata: "
- "bad NSEC3 type bitmap");
- }
- i += 2;
+ if (rdata_len > 0) {
+ // Read and parse the bitmaps only when they exist; empty bitmap
+ // is possible for NSEC3.
+ buffer.readData(&typebits[0], rdata_len);
+ checkRRTypeBitmaps("NSEC3", typebits);
}
impl_ = new NSEC3Impl(hashalg, flags, iterations, salt, next, typebits);
@@ -327,10 +339,15 @@ NSEC3::getIterations() const {
return (impl_->iterations_);
}
-vector<uint8_t>&
+const vector<uint8_t>&
NSEC3::getSalt() const {
return (impl_->salt_);
}
+const vector<uint8_t>&
+NSEC3::getNext() const {
+ return (impl_->next_);
+}
+
// END_RDATA_NAMESPACE
// END_ISC_NAMESPACE
diff --git a/src/lib/dns/rdata/generic/nsec3_50.h b/src/lib/dns/rdata/generic/nsec3_50.h
index 5532071..c766ade 100644
--- a/src/lib/dns/rdata/generic/nsec3_50.h
+++ b/src/lib/dns/rdata/generic/nsec3_50.h
@@ -43,7 +43,8 @@ public:
uint8_t getHashalg() const;
uint8_t getFlags() const;
uint16_t getIterations() const;
- std::vector<uint8_t>& getSalt() const;
+ const std::vector<uint8_t>& getSalt() const;
+ const std::vector<uint8_t>& getNext() const;
private:
NSEC3Impl* impl_;
diff --git a/src/lib/dns/rdata/generic/nsec_47.cc b/src/lib/dns/rdata/generic/nsec_47.cc
index 0859edd..72eb946 100644
--- a/src/lib/dns/rdata/generic/nsec_47.cc
+++ b/src/lib/dns/rdata/generic/nsec_47.cc
@@ -26,11 +26,13 @@
#include <dns/rrttl.h>
#include <dns/rdata.h>
#include <dns/rdataclass.h>
+#include <dns/rdata/generic/detail/nsec_bitmap.h>
#include <stdio.h>
#include <time.h>
using namespace std;
+using namespace isc::dns::rdata::generic::detail::nsec;
// BEGIN_ISC_NAMESPACE
// BEGIN_RDATA_NAMESPACE
@@ -61,10 +63,9 @@ NSEC::NSEC(const string& nsec_str) :
memset(bitmap, 0, sizeof(bitmap));
do {
string type;
- int code;
iss >> type;
try {
- code = RRType(type).getCode();
+ const int code = RRType(type).getCode();
bitmap[code / 8] |= (0x80 >> (code % 8));
} catch (...) {
isc_throw(InvalidRdataText, "Invalid RRtype in NSEC");
@@ -103,43 +104,7 @@ NSEC::NSEC(InputBuffer& buffer, size_t rdata_len) {
vector<uint8_t> typebits(rdata_len);
buffer.readData(&typebits[0], rdata_len);
-
- int len = 0;
- bool first = true;
- unsigned int block, lastblock = 0;
- for (int i = 0; i < rdata_len; i += len) {
- if (i + 2 > rdata_len) {
- isc_throw(DNSMessageFORMERR, "NSEC RDATA from wire: "
- "incomplete bit map field");
- }
- block = typebits[i];
- len = typebits[i + 1];
- // Check that bitmap window blocks are in the correct order.
- if (!first && block <= lastblock) {
- isc_throw(DNSMessageFORMERR, "NSEC RDATA from wire: Disordered "
- "window blocks found: " << lastblock <<
- " then " << block);
- }
- // Check for legal length
- if (len < 1 || len > 32) {
- isc_throw(DNSMessageFORMERR, "NSEC RDATA from wire: Invalid bitmap "
- "length: " << len);
- }
- // Check for overflow.
- i += 2;
- if (i + len > rdata_len) {
- isc_throw(DNSMessageFORMERR, "NSEC RDATA from wire: bitmap length "
- "too large: " << len);
- }
- // The last octet of the bitmap must be non zero.
- if (typebits[i + len - 1] == 0) {
- isc_throw(DNSMessageFORMERR, "NSEC RDATA from wire: bitmap ending "
- "an all-zero byte");
- }
-
- lastblock = block;
- first = false;
- }
+ checkRRTypeBitmaps("NSEC", typebits);
impl_ = new NSECImpl(nextname, typebits);
}
diff --git a/src/lib/dns/rdata/generic/rrsig_46.cc b/src/lib/dns/rdata/generic/rrsig_46.cc
index 6e6c5fb..c9d1e52 100644
--- a/src/lib/dns/rdata/generic/rrsig_46.cc
+++ b/src/lib/dns/rdata/generic/rrsig_46.cc
@@ -93,8 +93,8 @@ RRSIG::RRSIG(const string& rrsig_str) :
isc_throw(InvalidRdataText, "RRSIG labels out of range");
}
- uint32_t timeexpire = timeFromText(expire_txt);
- uint32_t timeinception = timeFromText(inception_txt);
+ const uint32_t timeexpire = timeFromText32(expire_txt);
+ const uint32_t timeinception = timeFromText32(inception_txt);
vector<uint8_t> signature;
decodeBase64(signaturebuf.str(), signature);
@@ -157,15 +157,12 @@ RRSIG::~RRSIG() {
string
RRSIG::toText() const {
- string expire = timeToText(impl_->timeexpire_);
- string inception = timeToText(impl_->timeinception_);
-
return (impl_->covered_.toText() +
" " + boost::lexical_cast<string>(static_cast<int>(impl_->algorithm_))
+ " " + boost::lexical_cast<string>(static_cast<int>(impl_->labels_))
+ " " + boost::lexical_cast<string>(impl_->originalttl_)
- + " " + expire
- + " " + inception
+ + " " + timeToText32(impl_->timeexpire_)
+ + " " + timeToText32(impl_->timeinception_)
+ " " + boost::lexical_cast<string>(impl_->tag_)
+ " " + impl_->signer_.toText()
+ " " + encodeBase64(impl_->signature_));
diff --git a/src/lib/dns/tests/Makefile.am b/src/lib/dns/tests/Makefile.am
index 48e4650..246adb7 100644
--- a/src/lib/dns/tests/Makefile.am
+++ b/src/lib/dns/tests/Makefile.am
@@ -36,6 +36,7 @@ run_unittests_SOURCES += rdata_dnskey_unittest.cc
run_unittests_SOURCES += rdata_ds_unittest.cc
run_unittests_SOURCES += rdata_nsec_unittest.cc
run_unittests_SOURCES += rdata_nsec3_unittest.cc
+run_unittests_SOURCES += rdata_nsecbitmap_unittest.cc
run_unittests_SOURCES += rdata_nsec3param_unittest.cc
run_unittests_SOURCES += rdata_rrsig_unittest.cc
run_unittests_SOURCES += rdata_tsig_unittest.cc
diff --git a/src/lib/dns/tests/dnssectime_unittest.cc b/src/lib/dns/tests/dnssectime_unittest.cc
index 2479a29..b2708cc 100644
--- a/src/lib/dns/tests/dnssectime_unittest.cc
+++ b/src/lib/dns/tests/dnssectime_unittest.cc
@@ -23,48 +23,141 @@
using namespace std;
using namespace isc::dns;
+// See dnssectime.cc
+namespace isc {
+namespace dns {
+namespace dnssectime {
+namespace detail {
+extern int64_t (*gettimeFunction)();
+}
+}
+}
+}
+
namespace {
-TEST(DNSSECTimeTest, fromText) {
+class DNSSECTimeTest : public ::testing::Test {
+protected:
+ ~DNSSECTimeTest() {
+ dnssectime::detail::gettimeFunction = NULL;
+ }
+};
+
+TEST_F(DNSSECTimeTest, fromText) {
+ // In most cases (in practice) the 32-bit and 64-bit versions should
+ // behave identically, so we'll mainly test the 32-bit version, which
+ // will be more commonly used in actual code (because many of the wire
+ // format time field are 32-bit). The subtle cases where these two
+ // return different values will be tested at the end of this test case.
+
// These are bogus and should be rejected
- EXPECT_THROW(timeFromText("2011 101120000"), InvalidTime);
- EXPECT_THROW(timeFromText("201101011200-0"), InvalidTime);
+ EXPECT_THROW(timeFromText32("2011 101120000"), InvalidTime);
+ EXPECT_THROW(timeFromText32("201101011200-0"), InvalidTime);
- // Short length
- EXPECT_THROW(timeFromText("20100223"), InvalidTime);
+ // Short length (or "decimal integer" version of representation;
+ // it's valid per RFC4034, but is not supported in this implementation)
+ EXPECT_THROW(timeFromText32("20100223"), InvalidTime);
// Leap year checks
- EXPECT_THROW(timeFromText("20110229120000"), InvalidTime);
- EXPECT_THROW(timeFromText("21000229120000"), InvalidTime);
- EXPECT_NO_THROW(timeFromText("20000229120000"));
- EXPECT_NO_THROW(timeFromText("20120229120000"));
+ EXPECT_THROW(timeFromText32("20110229120000"), InvalidTime);
+ EXPECT_THROW(timeFromText32("21000229120000"), InvalidTime);
+ EXPECT_NO_THROW(timeFromText32("20000229120000"));
+ EXPECT_NO_THROW(timeFromText32("20120229120000"));
// unusual case: this implementation allows SS=60 for "leap seconds"
- EXPECT_NO_THROW(timeFromText("20110101120060"));
+ EXPECT_NO_THROW(timeFromText32("20110101120060"));
// Out of range parameters
- EXPECT_THROW(timeFromText("19100223214617"), InvalidTime); // YY<1970
- EXPECT_THROW(timeFromText("20110001120000"), InvalidTime); // MM=00
- EXPECT_THROW(timeFromText("20111301120000"), InvalidTime); // MM=13
- EXPECT_THROW(timeFromText("20110100120000"), InvalidTime); // DD=00
- EXPECT_THROW(timeFromText("20110132120000"), InvalidTime); // DD=32
- EXPECT_THROW(timeFromText("20110431120000"), InvalidTime); // 'Apr31'
- EXPECT_THROW(timeFromText("20110101250000"), InvalidTime); // HH=25
- EXPECT_THROW(timeFromText("20110101126000"), InvalidTime); // mm=60
- EXPECT_THROW(timeFromText("20110101120061"), InvalidTime); // SS=61
+ EXPECT_THROW(timeFromText32("19100223214617"), InvalidTime); // YY<1970
+ EXPECT_THROW(timeFromText32("20110001120000"), InvalidTime); // MM=00
+ EXPECT_THROW(timeFromText32("20111301120000"), InvalidTime); // MM=13
+ EXPECT_THROW(timeFromText32("20110100120000"), InvalidTime); // DD=00
+ EXPECT_THROW(timeFromText32("20110132120000"), InvalidTime); // DD=32
+ EXPECT_THROW(timeFromText32("20110431120000"), InvalidTime); // 'Apr31'
+ EXPECT_THROW(timeFromText32("20110101250000"), InvalidTime); // HH=25
+ EXPECT_THROW(timeFromText32("20110101126000"), InvalidTime); // mm=60
+ EXPECT_THROW(timeFromText32("20110101120061"), InvalidTime); // SS=61
+
+ // Feb 7, 06:28:15 UTC 2106 is the possible maximum time that can be
+ // represented as an unsigned 32bit integer without overflow.
+ EXPECT_EQ(4294967295LU, timeFromText32("21060207062815"));
+
+ // After that, timeFromText32() should start returning the second count
+ // modulo 2^32.
+ EXPECT_EQ(0, timeFromText32("21060207062816"));
+ EXPECT_EQ(10, timeFromText32("21060207062826"));
+
+ // On the other hand, the 64-bit version should return monotonically
+ // increasing counters.
+ EXPECT_EQ(4294967296LL, timeFromText64("21060207062816"));
+ EXPECT_EQ(4294967306LL, timeFromText64("21060207062826"));
}
-TEST(DNSSECTimeTest, toText) {
- EXPECT_EQ("19700101000000", timeToText(0));
- EXPECT_EQ("20100311233000", timeToText(1268350200));
+// This helper templated function tells timeToText32 a faked current time.
+// The template parameter is that faked time in the form of int64_t seconds
+// since epoch.
+template <int64_t NOW>
+int64_t
+testGetTime() {
+ return (NOW);
}
-TEST(DNSSECTimeTest, overflow) {
+// Seconds since epoch for the year 10K eve. Commonly used in some tests
+// below.
+const uint64_t YEAR10K_EVE = 253402300799LL;
+
+TEST_F(DNSSECTimeTest, toText) {
+ // Check a basic case with the default (normal) gettimeFunction
+ // based on the "real current time".
+ // Note: this will fail after year 2078, but at that point we won't use
+ // this program anyway:-)
+ EXPECT_EQ("20100311233000", timeToText32(1268350200));
+
+ // Set the current time to: Feb 18 09:04:14 UTC 2012 (an arbitrary choice
+ // in the range of the first half of uint32 since epoch).
+ dnssectime::detail::gettimeFunction = testGetTime<1329555854LL>;
+
+ // Test the "year 2038" problem.
+ // Check the result of toText() for "INT_MIN" in int32_t. It's in the
+ // 68-year range from the faked current time, so the result should be
+ // in year 2038, instead of 1901.
+ EXPECT_EQ("20380119031408", timeToText64(0x80000000L));
+ EXPECT_EQ("20380119031408", timeToText32(0x80000000L));
+
+ // A controversial case: what should we do with "-1"? It's out of range
+ // in future, but according to RFC time before epoch doesn't seem to be
+ // considered "in-range" either. Our toText() implementation handles
+ // this range as a special case and always treats them as future time
+ // until year 2038. This won't be a real issue in practice, though,
+ // since such too large values won't be used in actual deployment by then.
+ EXPECT_EQ("21060207062815", timeToText32(0xffffffffL));
+
+ // After the singular point of year 2038, the first half of uint32 can
+ // point to a future time.
+ // Set the current time to: Apr 1 00:00:00 UTC 2038:
+ dnssectime::detail::gettimeFunction = testGetTime<2153692800LL>;
+ // then time "10" is Feb 7 06:28:26 UTC 2106
+ EXPECT_EQ("21060207062826", timeToText32(10));
+ // in 64-bit, it's 2^32 + 10
+ EXPECT_EQ("21060207062826", timeToText64(0x10000000aLL));
+
+ // After year 2106, the upper half of uint32 can point to past time
+ // (as it should).
+ dnssectime::detail::gettimeFunction = testGetTime<0x10000000aLL>;
+ EXPECT_EQ("21060207062815", timeToText32(0xffffffffL));
+
+ // Try very large time value. Actually it's the possible farthest time
+ // that can be represented in the form of YYYYMMDDHHmmSS.
+ EXPECT_EQ("99991231235959", timeToText64(YEAR10K_EVE));
+ dnssectime::detail::gettimeFunction = testGetTime<YEAR10K_EVE - 10>;
+ EXPECT_EQ("99991231235959", timeToText32(4294197631LU));
+}
+
+TEST_F(DNSSECTimeTest, overflow) {
// Jan 1, Year 10,000.
- if (sizeof(time_t) > 4) {
- EXPECT_THROW(timeToText(static_cast<time_t>(253402300800LL)),
- InvalidTime);
- }
+ EXPECT_THROW(timeToText64(253402300800LL), InvalidTime);
+ dnssectime::detail::gettimeFunction = testGetTime<YEAR10K_EVE - 10>;
+ EXPECT_THROW(timeToText32(4294197632LU), InvalidTime);
}
}
diff --git a/src/lib/dns/tests/name_unittest.cc b/src/lib/dns/tests/name_unittest.cc
index b79fd74..5daba9c 100644
--- a/src/lib/dns/tests/name_unittest.cc
+++ b/src/lib/dns/tests/name_unittest.cc
@@ -290,7 +290,7 @@ TEST_F(NameTest, assignment) {
// Self assignment
copy = copy;
- EXPECT_EQ(copy, example_name);
+ EXPECT_EQ(example_name, copy);
}
TEST_F(NameTest, toText) {
diff --git a/src/lib/dns/tests/rdata_mx_unittest.cc b/src/lib/dns/tests/rdata_mx_unittest.cc
index 4491f86..dd7677d 100644
--- a/src/lib/dns/tests/rdata_mx_unittest.cc
+++ b/src/lib/dns/tests/rdata_mx_unittest.cc
@@ -74,12 +74,9 @@ TEST_F(Rdata_MX_Test, toWireRenderer) {
TEST_F(Rdata_MX_Test, toWireBuffer) {
renderer.writeName(Name("example.com"));
rdata_mx.toWire(obuffer);
-}
-TEST_F(Rdata_MX_Test, DISABLED_toWireBuffer) {
-// XXX: does not pass
vector<unsigned char> data;
- UnitTestUtil::readWireData("rdata_mx_toWire1", data);
+ UnitTestUtil::readWireData("rdata_mx_toWire2", data);
EXPECT_PRED_FORMAT4(UnitTestUtil::matchWireData, obuffer.getData(),
obuffer.getLength(), &data[0], data.size());
}
diff --git a/src/lib/dns/tests/rdata_nsec3_unittest.cc b/src/lib/dns/tests/rdata_nsec3_unittest.cc
index 6b3a0b5..749e262 100644
--- a/src/lib/dns/tests/rdata_nsec3_unittest.cc
+++ b/src/lib/dns/tests/rdata_nsec3_unittest.cc
@@ -46,59 +46,136 @@ public:
string nsec3_txt;
};
+TEST_F(Rdata_NSEC3_Test, fromText) {
+ // A normal case: the test constructor should successfully parse the
+ // text and construct nsec3_txt. It will be tested against the wire format
+ // representation in the createFromWire test.
+
+ // Numeric parameters have possible maximum values. Unusual, but must
+ // be accepted.
+ EXPECT_NO_THROW(generic::NSEC3("255 255 65535 D399EAAB "
+ "H9RSFB7FPF2L8HG35CMPC765TDK23RP6 "
+ "NS SOA RRSIG DNSKEY NSEC3PARAM"));
+
+ // 0-length salt
+ EXPECT_EQ(0, generic::NSEC3("1 1 1 - H9RSFB7FPF2L8HG35CMPC765TDK23RP6 "
+ "A").getSalt().size());
+
+ // salt that has the possible max length
+ EXPECT_EQ(255, generic::NSEC3("1 1 1 " + string(255 * 2, '0') +
+ " H9RSFB7FPF2L8HG35CMPC765TDK23RP6 "
+ "NS").getSalt().size());
+
+ // hash that has the possible max length (see badText about the magic
+ // numbers)
+ EXPECT_EQ(255, generic::NSEC3("1 1 1 D399EAAB " +
+ string((255 * 8) / 5, '0') +
+ " NS").getNext().size());
+
+ // type bitmap is empty. it's possible and allowed for NSEC3.
+ EXPECT_NO_THROW(generic::NSEC3(
+ "1 1 1 D399EAAB H9RSFB7FPF2L8HG35CMPC765TDK23RP6"));
+}
+
TEST_F(Rdata_NSEC3_Test, toText) {
const generic::NSEC3 rdata_nsec3(nsec3_txt);
EXPECT_EQ(nsec3_txt, rdata_nsec3.toText());
}
TEST_F(Rdata_NSEC3_Test, badText) {
- EXPECT_THROW(generic::NSEC3 rdata_nsec3("1 1 1 ADDAFEEE "
- "0123456789ABCDEFGHIJKLMNOPQRSTUV "
- "BIFF POW SPOON"),
+ EXPECT_THROW(generic::NSEC3("1 1 1 ADDAFEEE "
+ "0123456789ABCDEFGHIJKLMNOPQRSTUV "
+ "BIFF POW SPOON"),
InvalidRdataText);
- EXPECT_THROW(generic::NSEC3 rdata_nsec3("1 1 1 ADDAFEE "
- "WXYZWXYZWXYZ=WXYZWXYZ==WXYZWXYZW "
- "A NS SOA"),
+ EXPECT_THROW(generic::NSEC3("1 1 1 ADDAFEE "
+ "WXYZWXYZWXYZ=WXYZWXYZ==WXYZWXYZW A NS SOA"),
BadValue); // bad hex
- EXPECT_THROW(generic::NSEC3 rdata_nsec3("1 1 1 ADDAFEEE "
- "WXYZWXYZWXYZ=WXYZWXYZ==WXYZWXYZW "
- "A NS SOA"),
+ EXPECT_THROW(generic::NSEC3("1 1 1 -- H9RSFB7FPF2L8HG35CMPC765TDK23RP6 "
+ "A"),
+ BadValue); // this shouldn't be confused a valid empty salt
+ EXPECT_THROW(generic::NSEC3("1 1 1 ADDAFEEE "
+ "WXYZWXYZWXYZ=WXYZWXYZ==WXYZWXYZW A NS SOA"),
BadValue); // bad base32hex
- EXPECT_THROW(generic::NSEC3 rdata_nsec3("1000000 1 1 ADDAFEEE "
- "0123456789ABCDEFGHIJKLMNOPQRSTUV "
- "A NS SOA"),
+ EXPECT_THROW(generic::NSEC3("1000000 1 1 ADDAFEEE "
+ "0123456789ABCDEFGHIJKLMNOPQRSTUV A NS SOA"),
InvalidRdataText);
- EXPECT_THROW(generic::NSEC3 rdata_nsec3("1 1000000 1 ADDAFEEE "
- "0123456789ABCDEFGHIJKLMNOPQRSTUV "
- "A NS SOA"),
+ EXPECT_THROW(generic::NSEC3("1 1000000 1 ADDAFEEE "
+ "0123456789ABCDEFGHIJKLMNOPQRSTUV A NS SOA"),
InvalidRdataText);
- EXPECT_THROW(generic::NSEC3 rdata_nsec3("1 1 1000000 ADDAFEEE "
- "0123456789ABCDEFGHIJKLMNOPQRSTUV "
- "A NS SOA"),
+ EXPECT_THROW(generic::NSEC3("1 1 1000000 ADDAFEEE "
+ "0123456789ABCDEFGHIJKLMNOPQRSTUV A NS SOA"),
InvalidRdataText);
-}
-TEST_F(Rdata_NSEC3_Test, DISABLED_badText) { // this currently fails
+ // There should be a space between "1" and "D399EAAB" (salt)
EXPECT_THROW(generic::NSEC3(
"1 1 1D399EAAB H9RSFB7FPF2L8HG35CMPC765TDK23RP6 "
"NS SOA RRSIG DNSKEY NSEC3PARAM"), InvalidRdataText);
+
+ // Salt is too long (possible max + 1 bytes)
+ EXPECT_THROW(generic::NSEC3("1 1 1 " + string(256 * 2, '0') +
+ " H9RSFB7FPF2L8HG35CMPC765TDK23RP6 NS"),
+ InvalidRdataText);
+
+ // Hash is too long. Max = 255 bytes, base32-hex converts each 5 bytes
+ // of the original to 8 characters, so 260 * 8 / 5 is the smallest length
+ // of the encoded string that exceeds the max and doesn't require padding.
+ EXPECT_THROW(generic::NSEC3("1 1 1 D399EAAB " + string((260 * 8) / 5, '0') +
+ " NS"),
+ InvalidRdataText);
}
TEST_F(Rdata_NSEC3_Test, createFromWire) {
+ // Normal case
const generic::NSEC3 rdata_nsec3(nsec3_txt);
EXPECT_EQ(0, rdata_nsec3.compare(
*rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
"rdata_nsec3_fromWire1")));
- // Too short RDLENGTH
+ // A valid NSEC3 RR with empty type bitmap.
+ EXPECT_NO_THROW(rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
+ "rdata_nsec3_fromWire15.wire"));
+
+ // Too short RDLENGTH: it doesn't even contain the first 5 octets.
EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
- "rdata_nsec3_fromWire2"),
- InvalidRdataLength);
+ "rdata_nsec3_fromWire2.wire"),
+ DNSMessageFORMERR);
+
+ // Invalid bitmap cases are tested in Rdata_NSECBITMAP_Test.
- // Invalid type bits
+ // salt length is too large
EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
- "rdata_nsec3_fromWire3"),
+ "rdata_nsec3_fromWire11.wire"),
DNSMessageFORMERR);
+
+ // empty salt. unusual, but valid.
+ ConstRdataPtr rdata =
+ rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
+ "rdata_nsec3_fromWire13.wire");
+ EXPECT_EQ(0, dynamic_cast<const generic::NSEC3&>(*rdata).getSalt().size());
+
+ // hash length is too large
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
+ "rdata_nsec3_fromWire12.wire"),
+ DNSMessageFORMERR);
+
+ // empty hash. invalid.
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
+ "rdata_nsec3_fromWire14.wire"),
+ DNSMessageFORMERR);
+
+ //
+ // Short buffer cases. The data is valid NSEC3 RDATA, but the buffer
+ // is trimmed at the end. All cases should result in an exception from
+ // the buffer class.
+ vector<uint8_t> data;
+ UnitTestUtil::readWireData("rdata_nsec3_fromWire1", data);
+ const uint16_t rdlen = (data.at(0) << 8) + data.at(1);
+ for (int i = 0; i < rdlen; ++i) {
+ // intentionally construct a short buffer
+ InputBuffer b(&data[0] + 2, i);
+ EXPECT_THROW(createRdata(RRType::NSEC3(), RRClass::IN(), b, 39),
+ InvalidBufferPosition);
+ }
}
TEST_F(Rdata_NSEC3_Test, toWireRenderer) {
diff --git a/src/lib/dns/tests/rdata_nsec_unittest.cc b/src/lib/dns/tests/rdata_nsec_unittest.cc
index f9ad027..8286dee 100644
--- a/src/lib/dns/tests/rdata_nsec_unittest.cc
+++ b/src/lib/dns/tests/rdata_nsec_unittest.cc
@@ -62,46 +62,7 @@ TEST_F(Rdata_NSEC_Test, createFromWire_NSEC) {
"rdata_nsec_fromWire2"),
DNSMessageFORMERR);
- EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
- "rdata_nsec_fromWire3"),
- DNSMessageFORMERR);
-
- // A malformed NSEC bitmap length field that could cause overflow.
- EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
- "rdata_nsec_fromWire4.wire"),
- DNSMessageFORMERR);
-
- // The bitmap field is incomplete (only the first byte is included)
- EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
- "rdata_nsec_fromWire5.wire"),
- DNSMessageFORMERR);
-
- // Bitmap length is 0, which is invalid.
- EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
- "rdata_nsec_fromWire6.wire"),
- DNSMessageFORMERR);
-
- // A boundary case: longest possible bitmaps (32 maps). This should be
- // accepted.
- EXPECT_NO_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
- "rdata_nsec_fromWire7.wire"));
-
- // Another boundary condition: 33 bitmaps, which should be rejected.
- EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
- "rdata_nsec_fromWire8.wire"),
- DNSMessageFORMERR);
-
- // Disordered bitmap window blocks.
- EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
- "rdata_nsec_fromWire9.wire"),
- DNSMessageFORMERR);
-
- // Bitmap ending with all-zero bytes. Not necessarily harmful except
- // the additional overhead of parsing, but invalid according to the
- // spec anyway.
- EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
- "rdata_nsec_fromWire10.wire"),
- DNSMessageFORMERR);
+ // Invalid bitmap cases are tested in Rdata_NSECBITMAP_Test.
}
TEST_F(Rdata_NSEC_Test, toWireRenderer_NSEC) {
diff --git a/src/lib/dns/tests/rdata_nsecbitmap_unittest.cc b/src/lib/dns/tests/rdata_nsecbitmap_unittest.cc
new file mode 100644
index 0000000..8a90878
--- /dev/null
+++ b/src/lib/dns/tests/rdata_nsecbitmap_unittest.cc
@@ -0,0 +1,103 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#include <dns/exceptions.h>
+#include <dns/rdata.h>
+#include <dns/rdataclass.h>
+#include <dns/rrclass.h>
+#include <dns/rrtype.h>
+
+#include <gtest/gtest.h>
+
+#include <dns/tests/rdata_unittest.h>
+
+using namespace isc::dns;
+using namespace isc::dns::rdata;
+
+namespace {
+class Rdata_NSECBITMAP_Test : public RdataTest {
+ // there's nothing to specialize
+};
+
+// Tests against various types of bogus NSEC/NSEC3 type bitmaps.
+// The syntax and semantics are common for both RR types, and our
+// implementation of that part is shared, so in theory it should be sufficient
+// to test for only one RR type. But we check for both just in case.
+TEST_F(Rdata_NSECBITMAP_Test, createFromWire_NSEC) {
+ // A malformed NSEC bitmap length field that could cause overflow.
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
+ "rdata_nsec_fromWire4.wire"),
+ DNSMessageFORMERR);
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
+ "rdata_nsec3_fromWire4.wire"),
+ DNSMessageFORMERR);
+
+ // The bitmap field is incomplete (only the first byte is included)
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
+ "rdata_nsec_fromWire5.wire"),
+ DNSMessageFORMERR);
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
+ "rdata_nsec3_fromWire5.wire"),
+ DNSMessageFORMERR);
+
+ // Bitmap length is 0, which is invalid.
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
+ "rdata_nsec_fromWire6.wire"),
+ DNSMessageFORMERR);
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
+ "rdata_nsec3_fromWire6.wire"),
+ DNSMessageFORMERR);
+
+ // Too large bitmap length with a short buffer.
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
+ "rdata_nsec_fromWire3"),
+ DNSMessageFORMERR);
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
+ "rdata_nsec3_fromWire3"),
+ DNSMessageFORMERR);
+
+ // A boundary case: longest possible bitmaps (32 maps). This should be
+ // accepted.
+ EXPECT_NO_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
+ "rdata_nsec_fromWire7.wire"));
+ EXPECT_NO_THROW(rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
+ "rdata_nsec3_fromWire7.wire"));
+
+ // Another boundary condition: 33 bitmaps, which should be rejected.
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
+ "rdata_nsec_fromWire8.wire"),
+ DNSMessageFORMERR);
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
+ "rdata_nsec3_fromWire8.wire"),
+ DNSMessageFORMERR);
+
+ // Disordered bitmap window blocks.
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
+ "rdata_nsec_fromWire9.wire"),
+ DNSMessageFORMERR);
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
+ "rdata_nsec3_fromWire9.wire"),
+ DNSMessageFORMERR);
+
+ // Bitmap ending with all-zero bytes. Not necessarily harmful except
+ // the additional overhead of parsing, but invalid according to the
+ // spec anyway.
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC(), RRClass::IN(),
+ "rdata_nsec_fromWire10.wire"),
+ DNSMessageFORMERR);
+ EXPECT_THROW(rdataFactoryFromFile(RRType::NSEC3(), RRClass::IN(),
+ "rdata_nsec3_fromWire10.wire"),
+ DNSMessageFORMERR);
+}
+}
diff --git a/src/lib/dns/tests/testdata/Makefile.am b/src/lib/dns/tests/testdata/Makefile.am
index f6eb90b..1aaddb6 100644
--- a/src/lib/dns/tests/testdata/Makefile.am
+++ b/src/lib/dns/tests/testdata/Makefile.am
@@ -8,9 +8,16 @@ BUILT_SOURCES += rdata_nsec_fromWire4.wire rdata_nsec_fromWire5.wire
BUILT_SOURCES += rdata_nsec_fromWire6.wire rdata_nsec_fromWire7.wire
BUILT_SOURCES += rdata_nsec_fromWire8.wire rdata_nsec_fromWire9.wire
BUILT_SOURCES += rdata_nsec_fromWire10.wire
+BUILT_SOURCES += rdata_nsec3_fromWire2.wire
+BUILT_SOURCES += rdata_nsec3_fromWire4.wire rdata_nsec3_fromWire5.wire
+BUILT_SOURCES += rdata_nsec3_fromWire6.wire rdata_nsec3_fromWire7.wire
+BUILT_SOURCES += rdata_nsec3_fromWire8.wire rdata_nsec3_fromWire9.wire
+BUILT_SOURCES += rdata_nsec3_fromWire10.wire rdata_nsec3_fromWire11.wire
+BUILT_SOURCES += rdata_nsec3_fromWire12.wire rdata_nsec3_fromWire13.wire
+BUILT_SOURCES += rdata_nsec3_fromWire14.wire rdata_nsec3_fromWire15.wire
BUILT_SOURCES += rdata_rrsig_fromWire2.wire
BUILT_SOURCES += rdata_soa_toWireUncompressed.wire
-BUILT_SOURCES += rdata_txt_fromWire2.wire rdata_txt_fromWire3.wire
+BUILT_SOURCES += rdata_txt_fromWire2.wire rdata_txt_fromWire3.wire
BUILT_SOURCES += rdata_txt_fromWire4.wire rdata_txt_fromWire5.wire
BUILT_SOURCES += rdata_tsig_fromWire1.wire rdata_tsig_fromWire2.wire
BUILT_SOURCES += rdata_tsig_fromWire3.wire rdata_tsig_fromWire4.wire
@@ -43,14 +50,21 @@ EXTRA_DIST += name_toWire5.spec name_toWire6.spec
EXTRA_DIST += question_fromWire question_toWire1 question_toWire2
EXTRA_DIST += rdata_cname_fromWire rdata_dname_fromWire rdata_dnskey_fromWire
EXTRA_DIST += rdata_ds_fromWire rdata_in_a_fromWire rdata_in_aaaa_fromWire
-EXTRA_DIST += rdata_mx_fromWire rdata_mx_toWire1 rdata_ns_fromWire
-EXTRA_DIST += rdata_nsec3_fromWire1 rdata_nsec3_fromWire2 rdata_nsec3_fromWire3
-EXTRA_DIST += rdata_nsec3param_fromWire1 rdata_nsec_fromWire1
-EXTRA_DIST += rdata_nsec_fromWire2 rdata_nsec_fromWire3
+EXTRA_DIST += rdata_mx_fromWire rdata_mx_toWire1 rdata_mx_toWire2
+EXTRA_DIST += rdata_ns_fromWire
+EXTRA_DIST += rdata_nsec_fromWire1 rdata_nsec_fromWire2 rdata_nsec_fromWire3
EXTRA_DIST += rdata_nsec_fromWire4.spec rdata_nsec_fromWire5.spec
EXTRA_DIST += rdata_nsec_fromWire6.spec rdata_nsec_fromWire7.spec
EXTRA_DIST += rdata_nsec_fromWire8.spec rdata_nsec_fromWire9.spec
EXTRA_DIST += rdata_nsec_fromWire10.spec
+EXTRA_DIST += rdata_nsec3param_fromWire1
+EXTRA_DIST += rdata_nsec3_fromWire1 rdata_nsec3_fromWire3
+EXTRA_DIST += rdata_nsec3_fromWire4.spec rdata_nsec3_fromWire5.spec
+EXTRA_DIST += rdata_nsec3_fromWire6.spec rdata_nsec3_fromWire7.spec
+EXTRA_DIST += rdata_nsec3_fromWire8.spec rdata_nsec3_fromWire9.spec
+EXTRA_DIST += rdata_nsec3_fromWire10.spec rdata_nsec3_fromWire11.spec
+EXTRA_DIST += rdata_nsec3_fromWire12.spec rdata_nsec3_fromWire13.spec
+EXTRA_DIST += rdata_nsec3_fromWire14.spec rdata_nsec3_fromWire15.spec
EXTRA_DIST += rdata_opt_fromWire rdata_rrsig_fromWire1
EXTRA_DIST += rdata_rrsig_fromWire2.spec
EXTRA_DIST += rdata_soa_fromWire rdata_soa_toWireUncompressed.spec
@@ -68,6 +82,7 @@ EXTRA_DIST += rdata_tsig_fromWire9.spec
EXTRA_DIST += rdata_tsig_toWire1.spec rdata_tsig_toWire2.spec
EXTRA_DIST += rdata_tsig_toWire3.spec rdata_tsig_toWire4.spec
EXTRA_DIST += rdata_tsig_toWire5.spec
+EXTRA_DIST += rdata_nsec3_fromWire2.spec
.spec.wire:
./gen-wiredata.py -o $@ $<
diff --git a/src/lib/dns/tests/testdata/gen-wiredata.py.in b/src/lib/dns/tests/testdata/gen-wiredata.py.in
index e59063f..645430c 100755
--- a/src/lib/dns/tests/testdata/gen-wiredata.py.in
+++ b/src/lib/dns/tests/testdata/gen-wiredata.py.in
@@ -52,8 +52,11 @@ rdict_rrclass = dict([(dict_rrclass[k], k.upper()) for k in \
dict_rrclass.keys()])
dict_algorithm = { 'rsamd5' : 1, 'dh' : 2, 'dsa' : 3, 'ecc' : 4,
'rsasha1' : 5 }
+dict_nsec3_algorithm = { 'reserved' : 0, 'sha1' : 1 }
rdict_algorithm = dict([(dict_algorithm[k], k.upper()) for k in \
dict_algorithm.keys()])
+rdict_nsec3_algorithm = dict([(dict_nsec3_algorithm[k], k.upper()) for k in \
+ dict_nsec3_algorithm.keys()])
header_xtables = { 'qr' : dict_qr, 'opcode' : dict_opcode,
'rcode' : dict_rcode }
@@ -274,14 +277,16 @@ class TXT:
' ' if len(wirestring_list[i]) > 0 else '',
wirestring_list[i]))
-class NSEC:
- rdlen = -1 # auto-calculate
- nextname = 'next.example.com'
+class NSECBASE:
+ '''Implements rendering NSEC/NSEC3 type bitmaps commonly used for
+ these RRs. The NSEC and NSEC3 classes will be inherited from this
+ class.'''
nbitmap = 1 # number of bitmaps
block = 0
- maplen = -1 # default bitmap length, auto-calculate
+ maplen = None # default bitmap length, auto-calculate
bitmap = '040000000003' # an arbtrarily chosen bitmap sample
def dump(self, f):
+ # first, construct the bitmpa data
block_list = []
maplen_list = []
bitmap_list = []
@@ -296,30 +301,72 @@ class NSEC:
maplen_list.append(self.__dict__[key_maplen])
else:
maplen_list.append(self.maplen)
- if maplen_list[-1] < 0:
+ if maplen_list[-1] is None: # calculate it if not specified
maplen_list[-1] = int(len(bitmap_list[-1]) / 2)
key_block = 'block' + str(i)
if key_block in self.__dict__:
block_list.append(self.__dict__[key_block])
else:
block_list.append(self.block)
+
+ # dump RR-type specific part (NSEC or NSEC3)
+ self.dump_fixedpart(f, 2 * self.nbitmap + \
+ int(len(''.join(bitmap_list)) / 2))
+
+ # dump the bitmap
+ for i in range(0, self.nbitmap):
+ f.write('# Bitmap: Block=%d, Length=%d\n' %
+ (block_list[i], maplen_list[i]))
+ f.write('%02x %02x %s\n' %
+ (block_list[i], maplen_list[i], bitmap_list[i]))
+
+class NSEC(NSECBASE):
+ rdlen = None # auto-calculate
+ nextname = 'next.example.com'
+ def dump_fixedpart(self, f, bitmap_totallen):
name_wire = encode_name(self.nextname)
- rdlen = self.rdlen
- if rdlen < 0:
+ if self.rdlen is None:
# if rdlen needs to be calculated, it must be based on the bitmap
# length, because the configured maplen can be fake.
- rdlen = int(len(name_wire) / 2) + 2 * self.nbitmap
- rdlen = rdlen + int(len(''.join(bitmap_list)) / 2)
- f.write('\n# NSEC RDATA (RDLEN=%d)\n' % rdlen)
- f.write('%04x\n' % rdlen);
+ self.rdlen = int(len(name_wire) / 2) + bitmap_totallen
+ f.write('\n# NSEC RDATA (RDLEN=%d)\n' % self.rdlen)
+ f.write('%04x\n' % self.rdlen);
f.write('# Next Name=%s (%d bytes)\n' % (self.nextname,
int(len(name_wire) / 2)))
f.write('%s\n' % name_wire)
- for i in range(0, self.nbitmap):
- f.write('# Bitmap: Block=%d, Length=%d\n' %
- (block_list[i], maplen_list[i]))
- f.write('%02x %02x %s\n' %
- (block_list[i], maplen_list[i], bitmap_list[i]))
+
+class NSEC3(NSECBASE):
+ rdlen = None # auto-calculate
+ hashalg = 1 # SHA-1
+ optout = False # opt-out flag
+ mbz = 0 # other flag fields (none defined yet)
+ iterations = 1
+ saltlen = 5
+ salt = 's' * saltlen
+ hashlen = 20
+ hash = 'h' * hashlen
+ def dump_fixedpart(self, f, bitmap_totallen):
+ if self.rdlen is None:
+ # if rdlen needs to be calculated, it must be based on the bitmap
+ # length, because the configured maplen can be fake.
+ self.rdlen = 4 + 1 + len(self.salt) + 1 + len(self.hash) \
+ + bitmap_totallen
+ f.write('\n# NSEC3 RDATA (RDLEN=%d)\n' % self.rdlen)
+ f.write('%04x\n' % self.rdlen)
+ optout_val = 1 if self.optout else 0
+ f.write('# Hash Alg=%s, Opt-Out=%d, Other Flags=%0x, Iterations=%d\n' %
+ (code_totext(self.hashalg, rdict_nsec3_algorithm),
+ optout_val, self.mbz, self.iterations))
+ f.write('%02x %02x %04x\n' %
+ (self.hashalg, (self.mbz << 1) | optout_val, self.iterations))
+ f.write("# Salt Len=%d, Salt='%s'\n" % (self.saltlen, self.salt))
+ f.write('%02x%s%s\n' % (self.saltlen,
+ ' ' if len(self.salt) > 0 else '',
+ encode_string(self.salt)))
+ f.write("# Hash Len=%d, Hash='%s'\n" % (self.hashlen, self.hash))
+ f.write('%02x%s%s\n' % (self.hashlen,
+ ' ' if len(self.hash) > 0 else '',
+ encode_string(self.hash)))
class RRSIG:
rdlen = -1 # auto-calculate
@@ -415,7 +462,7 @@ def get_config_param(section):
'question' : (DNSQuestion, question_xtables),
'edns' : (EDNS, {}), 'soa' : (SOA, {}), 'txt' : (TXT, {}),
'rrsig' : (RRSIG, {}), 'nsec' : (NSEC, {}),
- 'tsig' : (TSIG, {}) }
+ 'nsec3' : (NSEC3, {}), 'tsig' : (TSIG, {}) }
s = section
m = re.match('^([^:]+)/\d+$', section)
if m:
diff --git a/src/lib/dns/tests/testdata/rdata_mx_toWire2 b/src/lib/dns/tests/testdata/rdata_mx_toWire2
new file mode 100644
index 0000000..ebd2f27
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_mx_toWire2
@@ -0,0 +1,12 @@
+#
+# compressed MX RDATA stored in an output buffer
+#
+# sentinel name: example.com.
+# 0 1 2 3 4 5 6 7 8 9 10 1 2 (bytes)
+#(7) e x a m p l e (3) c o m .
+ 07 65 78 61 6d 70 6c 65 03 63 6f 6d 00
+# PREFERENCE: 10
+ 00 0a
+# EXCHANGE: not compressed
+#(4) m x ptr=0
+ 02 6d 78 07 65 78 61 6d 70 6c 65 03 63 6f 6d 00
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire1.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire1.spec
new file mode 100644
index 0000000..39a78d7
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire1.spec
@@ -0,0 +1,7 @@
+#
+# A malformed NSEC3 RDATA: bit map length is too large, causing overflow
+#
+
+[custom]
+sections: nsec3
+[nsec3]
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire10.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire10.spec
new file mode 100644
index 0000000..30417f5
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire10.spec
@@ -0,0 +1,8 @@
+#
+# An invalid NSEC3 RDATA: a bitmap block containing empty bytes
+#
+
+[custom]
+sections: nsec3
+[nsec3]
+bitmap: '01000000'
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire11.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire11.spec
new file mode 100644
index 0000000..80ec59f
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire11.spec
@@ -0,0 +1,8 @@
+#
+# An invalid NSEC3 RDATA: Saltlen is too large
+#
+
+[custom]
+sections: nsec3
+[nsec3]
+rdlen: 7
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire12.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire12.spec
new file mode 100644
index 0000000..1e01655
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire12.spec
@@ -0,0 +1,9 @@
+#
+# An invalid NSEC3 RDATA: Hash length is too large
+#
+
+[custom]
+sections: nsec3
+[nsec3]
+# only contains the first byte of hash
+rdlen: 12
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire13.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire13.spec
new file mode 100644
index 0000000..fcc9d53
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire13.spec
@@ -0,0 +1,9 @@
+#
+# A valid (but unusual) NSEC3 RDATA: salt is empty.
+#
+
+[custom]
+sections: nsec3
+[nsec3]
+saltlen: 0
+salt: ''
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire14.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire14.spec
new file mode 100644
index 0000000..a0550d5
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire14.spec
@@ -0,0 +1,9 @@
+#
+# An invalid NSEC3 RDATA: empty hash
+#
+
+[custom]
+sections: nsec3
+[nsec3]
+hashlen: 0
+hash: ''
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire15.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire15.spec
new file mode 100644
index 0000000..4993e03
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire15.spec
@@ -0,0 +1,10 @@
+#
+# NSEC3 RDATA with empty type bitmap. It's okay.
+# The test data includes bytes for a bitmap field, but RDLEN indicates
+# it's not part of the RDATA and so it will be ignored.
+#
+
+[custom]
+sections: nsec3
+[nsec3]
+rdlen: 31
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire2 b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire2
deleted file mode 100644
index 0965a27..0000000
--- a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire2
+++ /dev/null
@@ -1,12 +0,0 @@
-#
-# NSEC3 RDATA with a bogus RDLEN (too short)
-#
-
-# RDLENGTH, 29 bytes (should be 39)
-00 1e
-
-# NSEC3 record:
-# 1 1 1 D399EAAB H9RSFB7FPF2L8HG35CMPC765TDK23RP6 NS SOA RRSIG DNSKEY NSEC3PARAM
-01 01 00 01 04 d3 99 ea ab 14 8a 77 c7 ac ef cb
-c5 54 46 03 2b 2d 96 1c c5 eb 68 21 ef 26 00 07
-22 00 00 00 00 02 90
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire2.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire2.spec
new file mode 100644
index 0000000..0b6a5af
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire2.spec
@@ -0,0 +1,9 @@
+#
+# A malformed NSEC3 RDATA: RDLEN indicates it doesn't even contain the fixed
+# 5 octects
+#
+
+[custom]
+sections: nsec3
+[nsec3]
+rdlen: 4
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire4.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire4.spec
new file mode 100644
index 0000000..06d6eb4
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire4.spec
@@ -0,0 +1,9 @@
+#
+# A malformed NSEC3 RDATA: bit map length is too large, causing overflow
+#
+
+[custom]
+sections: nsec3
+[nsec3]
+maplen: 31
+bitmap: '01'
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire5.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire5.spec
new file mode 100644
index 0000000..2d5713c
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire5.spec
@@ -0,0 +1,13 @@
+#
+# A malformed NSEC3 RDATA: incomplete bit map field
+#
+
+[custom]
+sections: nsec3
+[nsec3]
+# only containing the block field of the bitmap
+rdlen: 32
+#dummy data
+maplen: 31
+#dummy data
+bitmap: '00'
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire6.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire6.spec
new file mode 100644
index 0000000..36e9e59
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire6.spec
@@ -0,0 +1,11 @@
+#
+# A malformed NSEC3 RDATA: bit map length being 0
+#
+
+[custom]
+sections: nsec3
+[nsec3]
+rdlen: 33
+maplen: 0
+# dummy data:
+bitmap: '01'
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire7.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire7.spec
new file mode 100644
index 0000000..338c0c9
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire7.spec
@@ -0,0 +1,9 @@
+#
+# NSEC3 RDATA with a longest bitmap field (32 bitmap bytes)
+#
+
+[custom]
+sections: nsec3
+[nsec3]
+maplen: 32
+bitmap: '0101010101010101010101010101010101010101010101010101010101010101'
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire8.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire8.spec
new file mode 100644
index 0000000..041714e
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire8.spec
@@ -0,0 +1,9 @@
+#
+# An invalid NSEC3 RDATA with an oversized bitmap field (33 bitmap bytes)
+#
+
+[custom]
+sections: nsec3
+[nsec3]
+maplen: 33
+bitmap: '010101010101010101010101010101010101010101010101010101010101010101'
diff --git a/src/lib/dns/tests/testdata/rdata_nsec3_fromWire9.spec b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire9.spec
new file mode 100644
index 0000000..b04c84f
--- /dev/null
+++ b/src/lib/dns/tests/testdata/rdata_nsec3_fromWire9.spec
@@ -0,0 +1,10 @@
+#
+# An invalid NSEC3 RDATA: disordered bitmap blocks
+#
+
+[custom]
+sections: nsec3
+[nsec3]
+nbitmap: 2
+block0: 2
+block1: 1
diff --git a/src/lib/log/Makefile.am b/src/lib/log/Makefile.am
index 900f11b..5bcafa8 100644
--- a/src/lib/log/Makefile.am
+++ b/src/lib/log/Makefile.am
@@ -1,21 +1,18 @@
-if USE_LOG4CXX
SUBDIRS = . compiler tests
-endif
AM_CPPFLAGS = -I$(top_builddir)/src/lib -I$(top_srcdir)/src/lib
AM_CPPFLAGS += $(BOOST_INCLUDES)
-AM_CPPFLAGS += $(LOG4CXX_INCLUDES)
AM_CPPFLAGS += -I$(top_srcdir)/src/lib/log -I$(top_builddir)/src/lib/log
CLEANFILES = *.gcno *.gcda
lib_LTLIBRARIES = liblog.la
liblog_la_SOURCES =
-liblog_la_SOURCES += dbglevels.h
+liblog_la_SOURCES += debug_levels.h logger_levels.h
liblog_la_SOURCES += dummylog.h dummylog.cc
-if USE_LOG4CXX
liblog_la_SOURCES += filename.h filename.cc
liblog_la_SOURCES += logger.cc logger.h
+liblog_la_SOURCES += logger_impl.cc logger_impl.h
liblog_la_SOURCES += logger_support.cc logger_support.h
liblog_la_SOURCES += messagedef.cc messagedef.h
liblog_la_SOURCES += message_dictionary.cc message_dictionary.h
@@ -25,10 +22,6 @@ liblog_la_SOURCES += message_reader.cc message_reader.h
liblog_la_SOURCES += message_types.h
liblog_la_SOURCES += root_logger_name.cc root_logger_name.h
liblog_la_SOURCES += strutil.h strutil.cc
-liblog_la_SOURCES += xdebuglevel.cc xdebuglevel.h
-
-liblog_la_LDFLAGS = $(LOG4CXX_LDFLAGS)
-endif
# Note: the ordering matters: -Wno-... must follow -Wextra (defined in
# B10_CXXFLAGS)
diff --git a/src/lib/log/compiler/Makefile.am b/src/lib/log/compiler/Makefile.am
index 2475036..9343793 100644
--- a/src/lib/log/compiler/Makefile.am
+++ b/src/lib/log/compiler/Makefile.am
@@ -10,11 +10,9 @@ if USE_STATIC_LINK
AM_LDFLAGS = -static
endif
-pkglibexecdir = $(libexecdir)/@PACKAGE@
-
CLEANFILES = *.gcno *.gcda
-pkglibexec_PROGRAMS = message
+noinst_PROGRAMS = message
message_SOURCES = message.cc
message_LDADD = $(top_builddir)/src/lib/log/liblog.la
diff --git a/src/lib/log/compiler/message.cc b/src/lib/log/compiler/message.cc
index 50e33a6..6f9c4e0 100644
--- a/src/lib/log/compiler/message.cc
+++ b/src/lib/log/compiler/message.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,9 +12,8 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <cctype>
+#include <cstddef>
#include <fstream>
#include <iostream>
#include <string>
@@ -47,7 +46,7 @@ static const char* VERSION = "1.0-0";
///
/// \li A .h file containing message definition
/// \li A .cc file containing code that adds the messages to the program's
-/// message disctionary at start-up time.
+/// message dictionary at start-up time.
///
/// Alternatively, the program can produce a .py file that contains the
/// message definitions.
@@ -56,20 +55,21 @@ static const char* VERSION = "1.0-0";
/// \b Invocation<BR>
/// The program is invoked with the command:
///
-/// <tt>message [-p] \<message-file\></tt>
+/// <tt>message [-v | -h | \<message-file\>]</tt>
///
/// It reads the message file and writes out two files of the same name but with
/// extensions of .h and .cc.
///
-/// If \c -p is specified, the C++ files are not written; instead a Python file
-/// of the same name (but with the file extension .py) is written.
+/// \-v causes it to print the version number and exit. \-h prints a help
+/// message (and exits).
/// \brief Print Version
///
/// Prints the program's version number.
-static void version() {
+void
+version() {
cout << VERSION << "\n";
}
@@ -77,16 +77,12 @@ static void version() {
///
/// Prints program usage to stdout.
-static void usage() {
+void
+usage() {
cout <<
- "Usage: message [-h] [-p] [-v] <message-file>\n" <<
+ "Usage: message [-h] [-v] <message-file>\n" <<
"\n" <<
"-h Print this message and exit\n" <<
- "-p Output a Python module holding the message definitions.\n" <<
- " By default a C++ header file and implementation file are\n" <<
-
-
- " written.\n" <<
"-v Print the program version and exit\n" <<
"\n" <<
"<message-file> is the name of the input message file.\n";
@@ -99,15 +95,13 @@ static void usage() {
///
/// \return Current time
-static string currentTime() {
+string
+currentTime() {
- // Get the current time.
+ // Get a text representation of the current time.
time_t curtime;
time(&curtime);
-
- // Format it
- char buffer[32];
- ctime_r(&curtime, buffer);
+ char* buffer = ctime(&curtime);
// Convert to string and strip out the trailing newline
string current_time = buffer;
@@ -115,8 +109,6 @@ static string currentTime() {
}
-
-
/// \brief Create Header Sentinel
///
/// Given the name of a file, create an #ifdef sentinel name. The name is
@@ -127,7 +119,8 @@ static string currentTime() {
///
/// \return Sentinel name
-static string sentinel(Filename& file) {
+string
+sentinel(Filename& file) {
string name = file.name();
string ext = file.extension();
@@ -143,11 +136,12 @@ static string sentinel(Filename& file) {
/// characters. This is used to handle the fact that the input file does not
/// contain quotes, yet the string will be included in a C++ literal string.
-string quoteString(const string& instring) {
+string
+quoteString(const string& instring) {
// Create the output string and reserve the space needed to hold the input
// string. (Most input strings will not contain quotes, so this single
- // reservation should be all that is needed.)
+ // reservation should be all that is needed.)
string outstring;
outstring.reserve(instring.size());
@@ -172,11 +166,12 @@ string quoteString(const string& instring) {
///
/// \return Sorted list of message IDs
-vector<MessageID> sortedIdentifiers(MessageDictionary* dictionary) {
- vector<MessageID> ident;
+vector<string>
+sortedIdentifiers(MessageDictionary& dictionary) {
+ vector<string> ident;
- for (MessageDictionary::const_iterator i = dictionary->begin();
- i != dictionary->end(); ++i) {
+ for (MessageDictionary::const_iterator i = dictionary.begin();
+ i != dictionary.end(); ++i) {
ident.push_back(i->first);
}
sort(ident.begin(), ident.end());
@@ -185,17 +180,83 @@ vector<MessageID> sortedIdentifiers(MessageDictionary* dictionary) {
}
+/// \brief Split Namespace
+///
+/// The $NAMESPACE directive may well specify a namespace in the form a::b.
+/// Unfortunately, the C++ "namespace" statement can only accept a single
+/// string - to set up the namespace of "a::b" requires two statements, one
+/// for "namspace a" and the other for "namespace b".
+///
+/// This function returns the set of namespace components as a vector of
+/// strings. A vector of one element, containing the empty string, is returned
+/// if the anonymous namespace is specified.
+///
+/// \param ns Argument to $NAMESPACE (passed by value, as we will be modifying
+/// it.)
+
+vector<string>
+splitNamespace(string ns) {
+
+ // Namespaces components are separated by double colon characters -
+ // convert to single colons.
+ size_t dcolon;
+ while ((dcolon = ns.find("::")) != string::npos) {
+ ns.replace(dcolon, 2, ":");
+ }
+
+ // ... and return the vector of namespace components split on the single
+ // colon.
+ return isc::strutil::tokens(ns, ":");
+}
+
+
+/// \brief Write Opening Namespace(s)
+///
+/// Writes the lines listing the namespaces in use.
+void
+writeOpeningNamespace(ostream& output, const vector<string>& ns) {
+ if (!ns.empty()) {
+
+ // Output namespaces in correct order
+ for (int i = 0; i < ns.size(); ++i) {
+ output << "namespace " << ns[i] << " {\n";
+ }
+ output << "\n";
+ }
+}
+
+
+/// \brief Write Closing Namespace(s)
+///
+/// Writes the lines listing the namespaces in use.
+void
+writeClosingNamespace(ostream& output, const vector<string>& ns) {
+ if (!ns.empty()) {
+ for (int i = ns.size() - 1; i >= 0; --i) {
+ output << "} // namespace " << ns[i] << "\n";
+ }
+ output << "\n";
+ }
+}
+
+
/// \brief Write Header File
///
-/// Writes the C++ header file containing the symbol definitions.
+/// Writes the C++ header file containing the symbol definitions. These are
+/// "extern" references to definitions in the .cc file. As such, they should
+/// take up no space in the module in which they are included, and redundant
+/// references should be removed by the compiler.
///
/// \param file Name of the message file. The header file is written to a
/// file of the same name but with a .h suffix.
/// \param prefix Prefix string to use in symbols
+/// \param ns Namespace in which the definitions are to be placed. An empty
+/// string indicates no namespace.
/// \param dictionary Dictionary holding the message definitions.
-void writeHeaderFile(const string& file, const string& prefix,
- MessageDictionary* dictionary)
+void
+writeHeaderFile(const string& file, const string& prefix,
+ const vector<string>& ns_components, MessageDictionary& dictionary)
{
Filename message_file(file);
Filename header_file(message_file.useAsDefault(".h"));
@@ -208,7 +269,7 @@ void writeHeaderFile(const string& file, const string& prefix,
try {
if (hfile.fail()) {
- throw MessageException(MSG_OPENOUT, header_file.fullName(),
+ throw MessageException(MSG_OPNMSGOUT, header_file.fullName(),
strerror(errno));
}
@@ -223,27 +284,26 @@ void writeHeaderFile(const string& file, const string& prefix,
"#define " << sentinel_text << "\n" <<
"\n" <<
"#include <log/message_types.h>\n" <<
- "\n" <<
- "namespace {\n" <<
"\n";
- vector<MessageID> idents = sortedIdentifiers(dictionary);
- for (vector<MessageID>::const_iterator j = idents.begin();
+ // Write the message identifiers, bounded by a namespace declaration
+ writeOpeningNamespace(hfile, ns_components);
+
+ vector<string> idents = sortedIdentifiers(dictionary);
+ for (vector<string>::const_iterator j = idents.begin();
j != idents.end(); ++j) {
- hfile << "isc::log::MessageID " << prefix << *j <<
- " = \"" << *j << "\";\n";
+ hfile << "extern const isc::log::MessageID " << prefix << *j << ";\n";
}
+ hfile << "\n";
+
+ writeClosingNamespace(hfile, ns_components);
// ... and finally the postamble
- hfile <<
- "\n" <<
- "} // Anonymous namespace\n" <<
- "\n" <<
- "#endif // " << sentinel_text << "\n";
+ hfile << "#endif // " << sentinel_text << "\n";
// Report errors (if any) and exit
if (hfile.fail()) {
- throw MessageException(MSG_WRITERR, header_file.fullName(),
+ throw MessageException(MSG_MSGWRTERR, header_file.fullName(),
strerror(errno));
}
@@ -260,18 +320,40 @@ void writeHeaderFile(const string& file, const string& prefix,
///
/// Simple function for use in a call to transform
-char replaceNonAlphaNum(char c) {
+char
+replaceNonAlphaNum(char c) {
return (isalnum(c) ? c : '_');
}
/// \brief Write Program File
///
-/// Writes the C++ source code file. This defines an external objects whose
-/// constructor is run at initialization time. The constructor adds the message
-/// definitions to the main global dictionary.
-
-void writeProgramFile(const string& file, MessageDictionary* dictionary)
+/// Writes the C++ source code file. This defines the text of the message
+/// symbols, as well as the initializer object that sets the entries in the
+/// global dictionary.
+///
+/// The construction of the initializer object loads the dictionary with the
+/// message text. However, nothing actually references it. If the initializer
+/// were in a file by itself, the lack of things referencing it would cause the
+/// linker to ignore it when pulling modules out of the logging library in a
+/// static link. By including it in the file with the symbol definitions, the
+/// module will get included in the link process to resolve the symbol
+/// definitions, and so the initializer object will be included in the final
+/// image. (Note that there are no such problems when the logging library is
+/// built as a dynamically-linked library: the whole library - including the
+/// initializer module - gets mapped into address space when the library is
+/// loaded, after which all the initializing code (including the constructors
+/// of objects declared outside functions) gets run.)
+///
+/// There _may_ be a problem when we come to port this to Windows. Microsoft
+/// Visual Studio contains a "Whole Program Optimisation" option, where the
+/// optimisation is done at link-time, not compiler-time. In this it _may_
+/// decide to remove the initializer object because of a lack of references
+/// to it. But until BIND-10 is ported to Windows, we won't know.
+
+void
+writeProgramFile(const string& file, const string& prefix,
+ const vector<string>& ns_components, MessageDictionary& dictionary)
{
Filename message_file(file);
Filename program_file(message_file.useAsDefault(".cc"));
@@ -280,7 +362,7 @@ void writeProgramFile(const string& file, MessageDictionary* dictionary)
ofstream ccfile(program_file.fullName().c_str());
try {
if (ccfile.fail()) {
- throw MessageException(MSG_OPENOUT, program_file.fullName(),
+ throw MessageException(MSG_OPNMSGOUT, program_file.fullName(),
strerror(errno));
}
@@ -292,45 +374,53 @@ void writeProgramFile(const string& file, MessageDictionary* dictionary)
currentTime() << "\n" <<
"\n" <<
"#include <cstddef>\n" <<
+ "#include <log/message_types.h>\n" <<
"#include <log/message_initializer.h>\n" <<
- "\n" <<
- "using namespace isc::log;\n" <<
- "\n" <<
+ "\n";
+
+ // Declare the message symbols themselves.
+
+ writeOpeningNamespace(ccfile, ns_components);
+
+ vector<string> idents = sortedIdentifiers(dictionary);
+ for (vector<string>::const_iterator j = idents.begin();
+ j != idents.end(); ++j) {
+ ccfile << "extern const isc::log::MessageID " << prefix << *j <<
+ " = \"" << *j << "\";\n";
+ }
+ ccfile << "\n";
+
+ writeClosingNamespace(ccfile, ns_components);
+
+ // Now the code for the message initialization.
+
+ ccfile <<
"namespace {\n" <<
"\n" <<
"const char* values[] = {\n";
// Output the identifiers and the associated text.
- vector<MessageID> idents = sortedIdentifiers(dictionary);
- for (vector<MessageID>::const_iterator i = idents.begin();
+ idents = sortedIdentifiers(dictionary);
+ for (vector<string>::const_iterator i = idents.begin();
i != idents.end(); ++i) {
ccfile << " \"" << *i << "\", \"" <<
- quoteString(dictionary->getText(*i)) << "\",\n";
+ quoteString(dictionary.getText(*i)) << "\",\n";
}
+
// ... and the postamble
ccfile <<
" NULL\n" <<
"};\n" <<
"\n" <<
+ "const isc::log::MessageInitializer initializer(values);\n" <<
+ "\n" <<
"} // Anonymous namespace\n" <<
"\n";
- // Now construct a unique name. We don't put the message initializer as
- // a static variable or in an anonymous namespace lest the C++
- // compiler's optimizer decides it can optimise it away.
- string unique_name = program_file.name() + program_file.extension() +
- "_" + currentTime();
- transform(unique_name.begin(), unique_name.end(), unique_name.begin(),
- replaceNonAlphaNum);
-
- // ... and write the initialization code
- ccfile <<
- "MessageInitializer " << unique_name << "(values);\n";
-
// Report errors (if any) and exit
if (ccfile.fail()) {
- throw MessageException(MSG_WRITERR, program_file.fullName(),
+ throw MessageException(MSG_MSGWRTERR, program_file.fullName(),
strerror(errno));
}
@@ -350,7 +440,8 @@ void writeProgramFile(const string& file, MessageDictionary* dictionary)
///
/// \param reader Message Reader used to read the file
-static void warnDuplicates(MessageReader& reader) {
+void
+warnDuplicates(MessageReader& reader) {
// Get the duplicates (the overflow) and, if present, sort them into some
// order and remove those which occur more than once (which mean that they
@@ -375,19 +466,15 @@ static void warnDuplicates(MessageReader& reader) {
/// Parses the options then dispatches to the appropriate function. See the
/// main file header for the invocation.
-int main(int argc, char** argv) {
-
- const struct option loptions[] = { // Long options
- {"help", no_argument, NULL, 'h'},
- {"version", no_argument, NULL, 'v'},
- {NULL, 0, NULL, 0 }
- };
+int
+main(int argc, char* argv[]) {
+
const char* soptions = "hv"; // Short options
optind = 1; // Ensure we start a new scan
int opt; // Value of the option
- while ((opt = getopt_long(argc, argv, soptions, loptions, NULL)) != -1) {
+ while ((opt = getopt(argc, argv, soptions)) != -1) {
switch (opt) {
case 'h':
usage();
@@ -424,19 +511,28 @@ int main(int argc, char** argv) {
MessageReader reader(&dictionary);
reader.readFile(message_file);
- // Now write the header file.
- writeHeaderFile(message_file, reader.getPrefix(), &dictionary);
+ // Get the namespace into which the message definitions will be put and
+ // split it into components.
+ vector<string> ns_components = splitNamespace(reader.getNamespace());
+
+ // Write the header file.
+ writeHeaderFile(message_file, reader.getPrefix(), ns_components,
+ dictionary);
+
+ // Write the file that defines the message symbols and text
+ writeProgramFile(message_file, reader.getPrefix(), ns_components,
+ dictionary);
- // ... and the message text file.
- writeProgramFile(message_file, &dictionary);
// Finally, warn of any duplicates encountered.
warnDuplicates(reader);
}
catch (MessageException& e) {
// Create an error message from the ID and the text
- MessageDictionary* global = MessageDictionary::globalDictionary();
- string text = e.id() + ", " + global->getText(e.id());
+ MessageDictionary& global = MessageDictionary::globalDictionary();
+ string text = e.id();
+ text += ", ";
+ text += global.getText(e.id());
// Format with arguments
text = isc::strutil::format(text, e.arguments());
diff --git a/src/lib/log/dbglevels.h b/src/lib/log/dbglevels.h
deleted file mode 100644
index 35c6878..0000000
--- a/src/lib/log/dbglevels.h
+++ /dev/null
@@ -1,31 +0,0 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
-//
-// Permission to use, copy, modify, and/or distribute this software for any
-// purpose with or without fee is hereby granted, provided that the above
-// copyright notice and this permission notice appear in all copies.
-//
-// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
-// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
-// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
-// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-// PERFORMANCE OF THIS SOFTWARE.
-
-// $Id$
-
-#ifndef __DBGLEVELS_H
-#define __DBGLEVELS_H
-
-/// \brief Defines Debug Levels
-///
-/// Defines the maximum and minimum debug levels and the number of levels.
-/// These are defined using #define as they are referenced in the construction
-/// of variables declared outside execution units. (In this way we avoid the
-/// "static initialization fiasco" problem.)
-
-#define MIN_DEBUG_LEVEL (0)
-#define MAX_DEBUG_LEVEL (99)
-#define NUM_DEBUG_LEVEL (MAX_DEBUG_LEVEL - MIN_DEBUG_LEVEL + 1)
-
-#endif // __DBGLEVELS_H
diff --git a/src/lib/log/debug_levels.h b/src/lib/log/debug_levels.h
new file mode 100644
index 0000000..bb2b524
--- /dev/null
+++ b/src/lib/log/debug_levels.h
@@ -0,0 +1,29 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#ifndef __DEBUG_LEVELS_H
+#define __DEBUG_LEVELS_H
+
+/// \brief Defines Debug Levels
+///
+/// Defines the maximum and minimum debug levels and the number of levels.
+/// These are defined using #define as they are referenced in the construction
+/// of variables declared outside execution units. (In this way we avoid the
+/// "static initialization fiasco" problem.)
+
+#define MIN_DEBUG_LEVEL (0)
+#define MAX_DEBUG_LEVEL (99)
+#define NUM_DEBUG_LEVEL (MAX_DEBUG_LEVEL - MIN_DEBUG_LEVEL + 1)
+
+#endif // __DEBUG_LEVELS_H
diff --git a/src/lib/log/documentation.txt b/src/lib/log/documentation.txt
index 1439ad5..0501587 100644
--- a/src/lib/log/documentation.txt
+++ b/src/lib/log/documentation.txt
@@ -13,19 +13,19 @@ Hierarchical Logging System
When a program writes a message to the logging system, it does so using an
instance of the Logger class. As well as performing the write of the message,
the logger identifies the source of the message: different sources can write
-to different destinations and can log different severities of messages. For
-example, the "cache" logger could write messages of DEBUG severity or above
-to a file while all other components write messages of "INFO" severity or above
-to the Syslog file.
+to different destinations and can log different severities of messages.
+For example, the "cache" logger could write messages of DEBUG severity or
+above to a file while all other components write messages of "INFO" severity
+or above to the Syslog file.
-The loggers are hierarchical in that each logger is the child of another logger.
-The top of the hierarchy is the root logger, which does not have a parent. The
-point of the hierarchy is that unless a logger is explicitly assigned an
-attribute (such as severity of message being logger), it picks it up from the
-parent. (In BIND-10, there is the root logger (named after the program) and
-every other logger is a child of that.) So in the example above, the
-INFO/Syslog attributes could be associated with the root logger while the
-DEBUG/file attributes are associated with the "cache" logger.
+The loggers are hierarchical in that each logger is the child of another
+logger. The top of the hierarchy is the root logger, which does not have
+a parent. The point of the hierarchy is that unless a logger is explicitly
+assigned an attribute (such as severity of message being logger), it picks
+it up from the parent. (In BIND-10, there is the root logger (named after
+the program) and every other logger is a child of that.) So in the example
+above, the INFO/Syslog attributes could be associated with the root logger
+while the DEBUG/file attributes are associated with the "cache" logger.
Separation of Messages Definitions And Text
@@ -38,10 +38,11 @@ retrieve the message associated with it (e.g. "unable to open %s for input").
substitutes any message parameters (in this example, the string that is an
invalid filename) and logs it to the destination.
-In the BIND-10 system, a set of default messages are linked into the program.
-At run-time. each program reads a message file, updating the stored definitions;
-this updated text is logged. However, to aid support, the message identifier
-so in the example above, the message finally logged would be something like:
+In the BIND-10 system, a set of default messages are linked into the
+program. At run-time. each program reads a message file, updating the
+stored definitions; this updated text is logged. However, to aid support,
+the message identifier so in the example above, the message finally logged
+would be something like:
OPENIN, unable to open a.txt for input
@@ -57,11 +58,11 @@ The steps in using the system are:
Ideally the file should have a file type of ".msg".
2. Run it through the message compiler to produce the .h and .cc files. It
- is intended that this step be included in the build process. However, for
- not run the compiler (found in the "compiler" subdirectory) manually. The
- only argument is the name of the message file: it will produce as output
- two files, having the same name as the input file but with file types of
- ".h" and ".cc".
+ is intended that this step be included in the build process. However,
+ for not run the compiler (found in the "compiler" subdirectory) manually.
+ The only argument is the name of the message file: it will produce as
+ output two files, having the same name as the input file but with file
+ types of ".h" and ".cc".
The compiler is built in the "compiler" subdirectory of the "src/lib/log"
directory.
@@ -70,13 +71,13 @@ The steps in using the system are:
make sure that the .cc file is compiled and linked into your program -
static initialization will add the symbols to the global dictionary.
-4. Declare loggers in your code and use them to log messages. This is described
- in more detail below.
+4. Declare loggers in your code and use them to log messages. This is
+ described in more detail below.
5. To set the debug level and run-time message file, call runTimeInit (declared
in logger_support.h) in the main program unit. This is a temporary solution
- for Year 2, and will be replaced at a later date, the information coming from
- the configuration database.
+ for Year 2, and will be replaced at a later date, the information coming
+ from the configuration database.
Message Files
@@ -84,9 +85,9 @@ Message Files
File Contents and Format
------------------------
-A message file is a file containing message definitions. Typically there will
-be one message file for each component that declares message symbols. An
-example file could be:
+A message file is a file containing message definitions. Typically there
+will be one message file for each component that declares message symbols.
+An example file could be:
-- BEGIN --
@@ -94,6 +95,7 @@ example file could be:
# $ID:$
$PREFIX TEST_
+$NAMESPACE isc::log
TEST1 message %s is much too large
+ This message is a test for the general message code
@@ -104,8 +106,8 @@ UNKNOWN unknown message
Points to note:
* Leading and trailing space are trimmed from the line. Although the above
- exampl,e has every line starting at column 1, the lines could be indented if
- desired.
+ exampl,e has every line starting at column 1, the lines could be indented
+ if desired.
* Blank lines are ignored.
@@ -113,16 +115,22 @@ Points to note:
a line by themselves - inline comments will be interpreted as part of the
text of the line.
-* Lines starting $ are directives. At present, the only directive recognised
- is $PREFIX, which has one argument: the string used to prefix symbols. If
- there is no facility directive, there is no prefix to the symbols. (Prefixes
- are explained below.)
+* Lines starting $ are directives. At present, two directives are recognised:
+
+ * $PREFIX, which has one argument: the string used to prefix symbols. If
+ absent, there is no prefix to the symbols. (Prefixes are explained below.)
+ * $NAMESPACE, which has one argument: the namespace in which the symbols are
+ created. (Specifying the argument as a double colon - i.e. "$NAMESPACE
+ ::" puts the symbol definitions in the unnamed namespace. And not
+ including a $NAMESPACE directive will result in the symbols note being
+ put in any namespace.
* Lines starting + indicate an explanation for the preceding message. These
- are intended to be processed by a separate program and used to generate an
- error messages manual. However they are treated like comments by the message
- compiler. As with comments, these must be on a line by themselves; if inline,
- the text (including the leading "+") will be interpreted as part of the line.
+ are intended to be processed by a separate program and used to generate
+ an error messages manual. However they are treated like comments by the
+ message compiler. As with comments, these must be on a line by themselves;
+ if inline, the text (including the leading "+") will be interpreted as
+ part of the line.
* Message lines. These comprise a symbol name and a message, which may
include zero or more printf-style tokens. Symbol names will be upper-cased
@@ -132,12 +140,17 @@ Points to note:
Message Compiler
----------------
The message compiler is a program built in the src/log/compiler directory.
-It processes the message file to produce two files:
+It is invoked by the command:
+
+ message [-h] [-v] <message-file>
+
+("-v" prints the version number and exits; "-h" prints brief help text.)
+The message compiler processes the message file to produce two files:
1) A C++ header file (called <message-file-name>.h) that holds lines of
the form:
- namespace {
+ namespace <namespace> {
isc::log::MessageID PREFIX_IDENTIFIER = "IDENTIFIER";
:
}
@@ -146,12 +159,17 @@ The symbols define the keys in the global message dictionary. At present
they are defined as std::strings, but a future implementation could redefine
them as numeric values.
+The namespace enclosing the symbols is set by the $NAMESPACE directive.
+
The "PREFIX_" part of the symbol name is the string defined in the $PREFIX
the argument to the directive. So "$PREFIX MSG_" would prefix the identifer
ABC with "MSG_" to give the symbol MSG_ABC. Similarly "$PREFIX E" would
prefix it with "E" to give the symbol EABC. If no $PREFIX is given, no
prefix appears (so the symbol in this example would be ABC).
+The header file also includes a couple of lines to ensure that the message
+text is included in the final program image.
+
2) A C++ source file (called <message-file-name>.cc) that holds the code to
insert the symbols and messages into the map.
@@ -201,8 +219,7 @@ To use the current version of the logging:
isc::log::RootLoggerName("b10-auth");
- It should be declared outside an execution unit to allow other statically-
- declared loggers to pick it up.
+ This can be declared inside or outside an execution unit.
2. In the code that needs to do logging, declare a logger with a given name,
e.g.
@@ -216,18 +233,8 @@ To use the current version of the logging:
isc::log::Logger logger("myname", true);
- This is due to an apparent bug in the underlying log4cxx, where the deletion
- of a statically-declared object at program termination can cause a segment
- fault. (The destruction of internal memory structures can sometimes happen
- out of order.) By default the Logger class creates the structures in its
- constructor but does not delete them in the destruction. The default
- behavious works because instead of reclaiming memory at program run-down,
- the operating system reclaims it when the process is deleted.
-
- Setting the second argument "true" causes the Logger's destructor to delete
- the log4cxx structures. This does not cause a problem if the program is
- not terminating. So use the second form when declaring an automatic
- instance of isc::log::Logger on the stack.
+ The argument is ignored for underlying implementations other than log4cxx.
+ See below for the use of this argument.
3. The main program unit should include a call to isc::log::runTimeInit()
(defined in logger_support.h) to set the logging severity, debug log level,
@@ -235,12 +242,12 @@ To use the current version of the logging:
a) The logging severity is one of the enum defined in logger.h, i.e.
- isc::log::Logger::DEBUG
- isc::log::Logger::INFO
- isc::log::Logger::WARN
- isc::log::Logger::ERROR
- isc::log::Logger::FATAL
- isc::log::Logger::NONE
+ isc::log::DEBUG
+ isc::log::INFO
+ isc::log::WARN
+ isc::log::ERROR
+ isc::log::FATAL
+ isc::log::NONE
b) The debug log level is only interpreted when the severity is DEBUG and
is an integer raning from 0 to 99. 0 should be used for the highest-level
@@ -291,7 +298,7 @@ the program started but attempts to open one or more network interfaces failed.
WARN
----
An unusual event happened. Although the program will continue working
-normally, the event was sufficiently out of the ordinary to warrant drawings
+normally, the event was sufficiently out of the ordinary to warrant drawing
attention to it. For example, at program start-up a zone was loaded that
contained no resource records,
@@ -348,16 +355,8 @@ DEBUG is specifically chosen.
b) Record system-related and packet-related messages via different loggers
(e.g. in the example given, sever events could be logged using the logger
"auth" and packet-related events at that level logged using the logger
-"pkt-auth".)
-As the loggers are independent and the severity levels independent, fine-tuning
-of what and what is not recorded can be achieved.
-
-
-Outstanding Issues
-==================
-* Ability to configure system according to configuration database.
-* Update the build procedure to create .cc and .h files from the .msg file
- during the build process. (Requires that the message compiler is built first.)
+"pkt-auth".) As the loggers are independent and the severity levels
+independent, fine-tuning of what and what is not recorded can be achieved.
Notes
@@ -369,3 +368,67 @@ the server starts up (or when triggered by a command) to read in a message
file to overwrite the internal dictionary. Writing it in C++ means there
is only one piece of code that does this functionality.
+
+Outstanding Issues
+==================
+* Ability to configure system according to configuration database.
+* Update the build procedure to create .cc and .h files from the .msg file
+ during the build process. (Requires that the message compiler is built
+ first.)
+
+
+log4cxx Issues
+==============
+
+Second Argument in Logger Constructor
+-------------------------------------
+As noted above, when using log4cxx as the underlying implementation, the
+argument to the logger's constructor should be set true if declaring the
+logger within a method and set false (or omitted) if declaring the logger
+external to an execution unit.
+
+This is due to an apparent bug in the underlying log4cxx, where the deletion
+of a statically-declared object at program termination can cause a segment
+fault. (The destruction of internal memory structures can sometimes happen
+out of order.) By default the Logger class creates the structures in
+its constructor but does not delete them in the destruction. The default
+behavious works because instead of reclaiming memory at program run-down,
+the operating system reclaims it when the process is deleted.
+
+Setting the second argument "true" causes the Logger's destructor to delete
+the log4cxx structures. This does not cause a problem if the program is
+not terminating. So use the second form when declaring an automatic instance
+of isc::log::Logger on the stack.
+
+Building with log4cxx
+---------------------
+Owing to issues with versions of log4cxx on different systems, log4cxx was
+temporarily disabled. To use log4cxx on your system:
+
+* Uncomment the log4cxx lines in configure.ac
+* In src/lib/log, replace the logger_impl.{cc,h} files with their log4cxx
+ equivalents, i.e.
+
+ cp logger_impl_log4cxx.h logger_impl.h
+ cp logger_impl_log4cxx.cc logger_impl.cc
+
+* In src/lib/log/Makefile.am, uncomment the lines:
+
+ # AM_CPPFLAGS += $(LOG4CXX_INCLUDES)
+
+ # liblog_la_SOURCES += xdebuglevel.cc xdebuglevel.h
+
+ # liblog_la_LDFLAGS = $(LOG4CXX_LDFLAGS)
+
+* In src/lib/log/test, re-enable testing of the log4cxx implementation
+ class, i.e.
+
+ cp logger_impl_log4cxx_unittest.cc logger_impl_unittest.cc
+
+ ... and uncomment the following lines in Makefile.am:
+
+ # run_unittests_SOURCES += logger_impl_unittest.cc
+
+ # run_unittests_SOURCES += xdebuglevel_unittest.cc
+
+Then rebuild the system from scratch.
diff --git a/src/lib/log/filename.cc b/src/lib/log/filename.cc
index 949ed9f..91835af 100644
--- a/src/lib/log/filename.cc
+++ b/src/lib/log/filename.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <iostream>
#include <algorithm>
#include <string>
@@ -106,7 +104,7 @@ Filename::expandWithDefault(const string& defname) const {
(directory_.empty() ? def_directory : directory_) +
(name_.empty() ? def_name : name_) +
(extension_.empty() ? def_extension : extension_);
- return retstring;
+ return (retstring);
}
// Use the stored name as default for a given name
@@ -132,7 +130,7 @@ Filename::useAsDefault(const string& name) const {
(name_directory.empty() ? directory_ : name_directory) +
(name_name.empty() ? name_ : name_name) +
(name_extension.empty() ? extension_ : name_extension);
- return retstring;
+ return (retstring);
}
diff --git a/src/lib/log/filename.h b/src/lib/log/filename.h
index 29a9cc8..da9e560 100644
--- a/src/lib/log/filename.h
+++ b/src/lib/log/filename.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __FILENAME_H
#define __FILENAME_H
@@ -80,22 +78,22 @@ public:
/// \return Stored Filename
std::string fullName() const {
- return full_name_;
+ return (full_name_);
}
/// \return Directory of Given File Name
std::string directory() const {
- return directory_;
+ return (directory_);
}
/// \return Name of Given File Name
std::string name() const {
- return name_;
+ return (name_);
}
/// \return Extension of Given File Name
std::string extension() const {
- return extension_;
+ return (extension_);
}
/// \brief Expand Name with Default
diff --git a/src/lib/log/logger.cc b/src/lib/log/logger.cc
index 494e7bc..a2465de 100644
--- a/src/lib/log/logger.cc
+++ b/src/lib/log/logger.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,296 +12,164 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE
-// $Id$
-
-#include <iostream>
-
#include <stdarg.h>
#include <stdio.h>
-#include <log4cxx/appender.h>
-#include <log4cxx/basicconfigurator.h>
-#include <log4cxx/patternlayout.h>
-#include <log4cxx/consoleappender.h>
-
-#include <log/root_logger_name.h>
#include <log/logger.h>
+#include <log/logger_impl.h>
#include <log/message_dictionary.h>
#include <log/message_types.h>
+#include <log/root_logger_name.h>
#include <log/strutil.h>
-#include <log/xdebuglevel.h>
using namespace std;
namespace isc {
namespace log {
-// Static initializations
-
-bool Logger::init_ = false;
+// Initialize Logger implementation. Does not check whether the implementation
+// has already been initialized - that was done by the caller (getLoggerPtr()).
+void Logger::initLoggerImpl() {
+ loggerptr_ = new LoggerImpl(name_, infunc_);
+}
-// Destructor. Delete log4cxx stuff if "don't delete" is clear.
+// Destructor.
Logger::~Logger() {
- if (exit_delete_) {
- delete loggerptr_;
- }
+ delete loggerptr_;
}
-// Initialize logger - create a logger as a child of the root logger. With
-// log4cxx this is assured by naming the logger <parent>.<child>.
-
-void
-Logger::initLogger() {
-
- // Initialize basic logging if not already done. This is a one-off for
- // all loggers.
- if (!init_) {
-
- // TEMPORARY
- // Add a suitable console logger to the log4cxx root logger. (This
- // is the logger at the root of the log4cxx tree, not the BIND-10 root
- // logger, which is one level down.) The chosen format is:
- //
- // YYYY-MM-DD hh:mm:ss.sss [logger] SEVERITY: text
- //
- // As noted, this is a temporary hack: it is done here to ensure that
- // a suitable output and output pattern is set. Future versions of the
- // software will set this based on configuration data.
-
- log4cxx::LayoutPtr layout(
- new log4cxx::PatternLayout(
- "%d{yyyy-MM-DD HH:mm:ss.SSS} %-5p [%c] %m\n"));
- log4cxx::AppenderPtr console(
- new log4cxx::ConsoleAppender(layout));
- log4cxx::LoggerPtr sys_root_logger = log4cxx::Logger::getRootLogger();
- sys_root_logger->addAppender(console);
-
- // Set the default logging to INFO
- sys_root_logger->setLevel(log4cxx::Level::getInfo());
-
- // All static stuff initialized
- init_ = true;
- }
+// Get Name of Logger
- // Initialize this logger. Name this as to whether the BIND-10 root logger
- // name has been set. (If not, this mucks up the hierarchy :-( ).
- string root_name = RootLoggerName::getName();
- if (root_name.empty() || (name_ == root_name)) {
- loggerptr_ = new log4cxx::LoggerPtr(log4cxx::Logger::getLogger(name_));
- }
- else {
- loggerptr_ = new log4cxx::LoggerPtr(
- log4cxx::Logger::getLogger(root_name + "." + name_)
- );
- }
+std::string
+Logger::getName() {
+ return (getLoggerPtr()->getName());
}
-
-// Set the severity for logging. There is a 1:1 mapping between the logging
-// severity and the log4cxx logging levels, apart from DEBUG.
-//
-// In log4cxx, each of the logging levels (DEBUG, INFO, WARN etc.) has a numeric
-// value. The level is set to one of these and any numeric level equal to or
-// above it that is reported. For example INFO has a value of 20000 and ERROR
-// a value of 40000. So if a message of WARN severity (= 30000) is logged, it is
-// not logged when the logger's severity level is ERROR (as 30000 !>= 40000).
-// It is reported if the logger's severity level is set to WARN (as 30000 >=
-/// 30000) or INFO (30000 >= 20000).
-//
-// This gives a simple system for handling different debug levels. The debug
-// level is a number between 0 and 99, with 0 being least verbose and 99 the
-// most. To implement this seamlessly, when DEBUG is set, the numeric value
-// of the logging level is actually set to (DEBUG - debug-level). Similarly
-// messages of level "n" are logged at a logging level of (DEBUG - n). Thus if
-// the logging level is set to DEBUG and the debug level set to 25, the actual
-// level set is 10000 - 25 = 99975.
-//
-// Attempting to log a debug message of level 26 is an attempt to log a message
-// of level 10000 - 26 = 9974. As 9974 !>= 9975, it is not logged. A
-// message of level 25 is, because 9975 >= 9975.
-//
-// The extended set of logging levels is implemented by the XDebugLevel class.
+// Set the severity for logging.
void
-Logger::setSeverity(Severity severity, int dbglevel) {
- switch (severity) {
- case NONE:
- getLogger()->setLevel(log4cxx::Level::getOff());
- break;
-
- case FATAL:
- getLogger()->setLevel(log4cxx::Level::getFatal());
- break;
-
- case ERROR:
- getLogger()->setLevel(log4cxx::Level::getError());
- break;
-
- case WARN:
- getLogger()->setLevel(log4cxx::Level::getWarn());
- break;
-
- case INFO:
- getLogger()->setLevel(log4cxx::Level::getInfo());
- break;
-
- case DEBUG:
- getLogger()->setLevel(
- log4cxx::XDebugLevel::getExtendedDebug(dbglevel));
- break;
-
- // Will get here for DEFAULT or any other value. This disables the
- // logger's own severity and it defaults to the severity of the parent
- // logger.
- default:
- getLogger()->setLevel(0);
- }
+Logger::setSeverity(isc::log::Severity severity, int dbglevel) {
+ getLoggerPtr()->setSeverity(severity, dbglevel);
}
-// Convert between numeric log4cxx logging level and BIND-10 logging severity.
-
-Logger::Severity
-Logger::convertLevel(int value) const {
-
- // The order is optimised. This is only likely to be called when testing
- // for writing debug messages, so the check for DEBUG_INT is first.
- if (value <= log4cxx::Level::DEBUG_INT) {
- return (DEBUG);
- } else if (value <= log4cxx::Level::INFO_INT) {
- return (INFO);
- } else if (value <= log4cxx::Level::WARN_INT) {
- return (WARN);
- } else if (value <= log4cxx::Level::ERROR_INT) {
- return (ERROR);
- } else if (value <= log4cxx::Level::FATAL_INT) {
- return (FATAL);
- } else {
- return (NONE);
- }
-}
+// Return the severity of the logger.
+isc::log::Severity
+Logger::getSeverity() {
+ return (getLoggerPtr()->getSeverity());
+}
-// Return the logging severity associated with this logger.
+// Get Effective Severity Level for Logger
-Logger::Severity
-Logger::getSeverityCommon(const log4cxx::LoggerPtr& ptrlogger,
- bool check_parent) const {
+isc::log::Severity
+Logger::getEffectiveSeverity() {
+ return (getLoggerPtr()->getEffectiveSeverity());
+}
- log4cxx::LevelPtr level = ptrlogger->getLevel();
- if (level == log4cxx::LevelPtr()) {
+// Debug level (only relevant if messages of severity DEBUG are being logged).
- // Null level returned, logging should be that of the parent.
+int
+Logger::getDebugLevel() {
+ return (getLoggerPtr()->getDebugLevel());
+}
- if (check_parent) {
- log4cxx::LoggerPtr parent = ptrlogger->getParent();
- if (parent == log4cxx::LoggerPtr()) {
+// Check on the current severity settings
- // No parent, so reached the end of the chain. Return INFO
- // severity.
- return (INFO);
- }
- else {
- return getSeverityCommon(parent, check_parent);
- }
- }
- else {
- return (DEFAULT);
- }
- } else {
- return convertLevel(level->toInt());
- }
+bool
+Logger::isDebugEnabled(int dbglevel) {
+ return (getLoggerPtr()->isDebugEnabled(dbglevel));
}
+bool
+Logger::isInfoEnabled() {
+ return (getLoggerPtr()->isInfoEnabled());
+}
-// Get the debug level. This returns 0 unless the severity is DEBUG.
+bool
+Logger::isWarnEnabled() {
+ return (getLoggerPtr()->isWarnEnabled());
+}
-int
-Logger::getDebugLevel() {
+bool
+Logger::isErrorEnabled() {
+ return (getLoggerPtr()->isErrorEnabled());
+}
- log4cxx::LevelPtr level = getLogger()->getLevel();
- if (level == log4cxx::LevelPtr()) {
-
- // Null pointer returned, logging should be that of the parent.
- return (0);
-
- } else {
- int severity = level->toInt();
- if (severity <= log4cxx::Level::DEBUG_INT) {
- return (log4cxx::Level::DEBUG_INT - severity);
- }
- else {
- return (0);
- }
- }
+bool
+Logger::isFatalEnabled() {
+ return (getLoggerPtr()->isFatalEnabled());
}
-// Log an error message:
-// Common code. Owing to the use of variable arguments, this must be inline
-// (hence the definition of the macro). Also note that it expects that the
-// message buffer "message" is declared in the compilation unit.
-
-#define MESSAGE_SIZE (256)
-
-#define FORMAT_MESSAGE(message) \
- { \
- MessageDictionary* global = MessageDictionary::globalDictionary(); \
- string format = global->getText(ident); \
- va_list ap; \
- va_start(ap, ident); \
- vsnprintf(message, sizeof(message), format.c_str(), ap); \
- message[sizeof(message) - 1] = '\0'; \
- va_end(ap); \
- }
-
+// Format a message: looks up the message text in the dictionary and formats
+// it, replacing tokens with arguments.
+//
+// Owing to the use of variable arguments, this must be inline (hence the
+// definition of the macro). Also note that it expects that the message buffer
+// "message" is declared in the compilation unit.
// Output methods
void
-Logger::debug(int dbglevel, isc::log::MessageID ident, ...) {
+Logger::debug(int dbglevel, const isc::log::MessageID& ident, ...) {
if (isDebugEnabled(dbglevel)) {
- char message[MESSAGE_SIZE];
- FORMAT_MESSAGE(message);
- LOG4CXX_DEBUG(getLogger(), ident << ", " << message);
+ va_list ap;
+ va_start(ap, ident);
+ getLoggerPtr()->debug(ident, ap);
+ va_end(ap);
}
}
void
-Logger::info(isc::log::MessageID ident, ...) {
+Logger::info(const isc::log::MessageID& ident, ...) {
if (isInfoEnabled()) {
- char message[MESSAGE_SIZE];
- FORMAT_MESSAGE(message);
- LOG4CXX_INFO(getLogger(), ident << ", " << message);
+ va_list ap;
+ va_start(ap, ident);
+ getLoggerPtr()->info(ident, ap);
+ va_end(ap);
}
}
void
-Logger::warn(isc::log::MessageID ident, ...) {
+Logger::warn(const isc::log::MessageID& ident, ...) {
if (isWarnEnabled()) {
- char message[MESSAGE_SIZE];
- FORMAT_MESSAGE(message);
- LOG4CXX_WARN(getLogger(), ident << ", " << message);
+ va_list ap;
+ va_start(ap, ident);
+ getLoggerPtr()->warn(ident, ap);
+ va_end(ap);
}
}
void
-Logger::error(isc::log::MessageID ident, ...) {
+Logger::error(const isc::log::MessageID& ident, ...) {
if (isErrorEnabled()) {
- char message[MESSAGE_SIZE];
- FORMAT_MESSAGE(message);
- LOG4CXX_ERROR(getLogger(), ident << ", " << message);
+ va_list ap;
+ va_start(ap, ident);
+ getLoggerPtr()->error(ident, ap);
+ va_end(ap);
}
}
void
-Logger::fatal(isc::log::MessageID ident, ...) {
+Logger::fatal(const isc::log::MessageID& ident, ...) {
if (isFatalEnabled()) {
- char message[MESSAGE_SIZE];
- FORMAT_MESSAGE(message);
- LOG4CXX_FATAL(getLogger(), ident << ", " << message);
+ va_list ap;
+ va_start(ap, ident);
+ getLoggerPtr()->fatal(ident, ap);
+ va_end(ap);
}
}
+bool Logger::operator==(Logger& other) {
+ return (*getLoggerPtr() == *other.getLoggerPtr());
+}
+
+// Protected methods (used for testing)
+
+void
+Logger::reset() {
+ LoggerImpl::reset();
+}
} // namespace log
} // namespace isc
diff --git a/src/lib/log/logger.h b/src/lib/log/logger.h
index f26f6d1..691eb73 100644
--- a/src/lib/log/logger.h
+++ b/src/lib/log/logger.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,36 +12,42 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __LOGGER_H
#define __LOGGER_H
#include <cstdlib>
#include <string>
-#include <boost/lexical_cast.hpp>
-#include <log4cxx/logger.h>
-#include <log/dbglevels.h>
+#include <log/debug_levels.h>
+#include <log/logger_levels.h>
#include <log/message_types.h>
namespace isc {
namespace log {
+/// \brief Logging API
+///
+/// This module forms the interface into the logging subsystem. Features of the
+/// system and its implementation are:
+///
+/// # Multiple logging objects can be created, each given a name; those with the
+/// same name share characteristics (like destination, level being logged
+/// etc.)
+/// # Messages can be logged at severity levels of FATAL, ERROR, WARN, INFO or
+/// DEBUG. The DEBUG level has further sub-levels numbered 0 (least
+/// informative) to 99 (most informative).
+/// # Each logger has a severity level set associated with it. When a message
+/// is logged, it is output only if it is logged at a level equal to the
+/// logger severity level or greater, e.g. if the logger's severity is WARN,
+/// only messages logged at WARN, ERROR or FATAL will be output.
+/// # Messages are identified by message identifiers, which are keys into a
+/// message dictionary.
+
+class LoggerImpl; // Forward declaration of the implementation class
+
class Logger {
public:
- /// \brief Severity Levels
- typedef enum {
- DEFAULT, // Default to logging level of parent
- DEBUG,
- INFO,
- WARN,
- ERROR,
- FATAL,
- NONE // Disable logging
- } Severity;
-
/// \brief Constructor
///
/// Creates/attaches to a logger of a specific name.
@@ -50,35 +56,31 @@ public:
/// this creates an instance of the root logger; otherwise it creates a
/// child of the root logger.
///
- /// \param exit_delete This argument is present to get round a bug in
- /// log4cxx. If a log4cxx logger is declared outside an execution unit, it
- /// is not deleted until the program runs down. At that point all such
- /// objects - including internal log4cxx objects - are deleted. However,
- /// there seems to be a bug in log4cxx where the way that such objects are
- /// destroyed causes a MutexException to be thrown (this is described in
+ /// \param infunc This argument is present to get round a bug in some
+ /// implementations of the logging system. If the logger is declared in
+ /// a function (such that it will be deleted when the function exits,
+ /// before the program ends), set this true. If declared outside a
+ /// function (such that it gets deleted during program rundown), set false
+ /// (the default).\n
+ /// \n
+ /// The problems encountered was that during program rundown, one logging
+ /// implementation (log4cxx) threw a MutexException (this is described in
/// https://issues.apache.org/jira/browse/LOGCXX-322). As this only occurs
/// during program rundown, the issue is not serious - it just looks bad to
/// have the program crash instead of shut down cleanly.\n
/// \n
- /// The original implementation of the isc::log::Logger had as a member a
- /// log4cxx logger (actually a LoggerPtr). If the isc:: Logger was declared
- /// statically, when it was destroyed at the end of the program the internal
- /// LoggerPtr was destroyed, which triggered the problem. The problem did
- /// not occur if the isc::log::Logger was created on the stack. To get
- /// round this, the internal LoggerPtr is now created dynamically. The
- /// exit_delete argument controls its destruction: if true, it is destroyed
- /// in the ISC Logger destructor. If false, it is not.\n
+ /// If log4cxx is chosen as the implementation, this flag controls the
+ /// deletion of the underlying log4cxx data structures when the logger is
+ /// deleted. Setting it false for externally-declared loggers inhibits
+ /// their deletion; so at program exit the memory is not reclaimed during
+ /// program rundown, only when the process is delected. Setting it true
+ /// for loggers that will be deleted in the normal running of the program
+ /// enables their deletion - which causes no issues as the problem only
+ /// manifests itself during program rundown.
/// \n
- /// When creating an isc::log::Logger on the stack, the argument should be
- /// false (the default); when the Logger is destroyed, all the internal
- /// log4cxx objects are destroyed. As only the logger (and not the internal
- /// log4cxx data structures are being destroyed), all is well. However,
- /// when creating the logger statically, the argument should be false. This
- /// means that the log4cxx objects are not destroyed at program rundown;
- /// instead memory is reclaimed and files are closed when the process is
- /// destroyed, something that does not trigger the bug.
- Logger(const std::string& name, bool exit_delete = false) :
- loggerptr_(), name_(name), exit_delete_(exit_delete)
+ /// The flag has no effect on non-log4cxx implementations.
+ Logger(const std::string& name, bool infunc = false) :
+ loggerptr_(NULL), name_(name), infunc_(infunc)
{}
@@ -86,28 +88,10 @@ public:
virtual ~Logger();
- /// \brief Configure Options
- ///
- /// TEMPORARY: Pass in the command-line options to set the logging severity
- /// for the root logger. Future versions of the logger will get this
- /// information from the configuration database.
- ///
- /// \param severity Severity level to log
- /// \param dbglevel If the severity is DEBUG, this is the debug level.
- /// This can be in the range 1 to 100 and controls the verbosity. A value
- /// outside these limits is silently coerced to the nearest boundary.
- /// \param local_file If provided, the name of a message file to read in and
- /// supersede one or more of the current messages.
- static void runTimeInit(Severity severity = INFO, int dbglevel = 1,
- const char* local_file = NULL);
-
-
/// \brief Get Name of Logger
///
/// \return The full name of the logger (including the root name)
- virtual std::string getName() {
- return getLogger()->getName();
- }
+ virtual std::string getName();
/// \brief Set Severity Level for Logger
@@ -119,31 +103,28 @@ public:
/// \param dbglevel If the severity is DEBUG, this is the debug level.
/// This can be in the range 1 to 100 and controls the verbosity. A value
/// outside these limits is silently coerced to the nearest boundary.
- virtual void setSeverity(Severity severity, int dbglevel = 1);
+ virtual void setSeverity(isc::log::Severity severity, int dbglevel = 1);
/// \brief Get Severity Level for Logger
///
/// \return The current logging level of this logger. In most cases though,
/// the effective logging level is what is required.
- virtual Severity getSeverity() {
- return getSeverityCommon(getLogger(), false);
- }
+ virtual isc::log::Severity getSeverity();
+
/// \brief Get Effective Severity Level for Logger
///
/// \return The effective severity level of the logger. This is the same
/// as getSeverity() if the logger has a severity level set, but otherwise
/// is the severity of the parent.
- virtual Severity getEffectiveSeverity() {
- return getSeverityCommon(getLogger(), true);
- }
+ virtual isc::log::Severity getEffectiveSeverity();
/// \brief Return DEBUG Level
///
/// \return Current setting of debug level. This is returned regardless of
- /// whether the
+ /// whether the severity is set to debug.
virtual int getDebugLevel();
@@ -152,35 +133,23 @@ public:
/// \param dbglevel Level for which debugging is checked. Debugging is
/// enabled only if the logger has DEBUG enabled and if the dbglevel
/// checked is less than or equal to the debug level set for the logger.
- virtual bool
- isDebugEnabled(int dbglevel = MIN_DEBUG_LEVEL) {
- return (getLogger()->getEffectiveLevel()->toInt() <=
- (log4cxx::Level::DEBUG_INT - dbglevel));
- }
+ virtual bool isDebugEnabled(int dbglevel = MIN_DEBUG_LEVEL);
/// \brief Is INFO Enabled?
- virtual bool isInfoEnabled() {
- return (getLogger()->isInfoEnabled());
- }
+ virtual bool isInfoEnabled();
/// \brief Is WARNING Enabled?
- virtual bool isWarnEnabled() {
- return (getLogger()->isWarnEnabled());
- }
+ virtual bool isWarnEnabled();
/// \brief Is ERROR Enabled?
- virtual bool isErrorEnabled() {
- return (getLogger()->isErrorEnabled());
- }
+ virtual bool isErrorEnabled();
/// \brief Is FATAL Enabled?
- virtual bool isFatalEnabled() {
- return (getLogger()->isFatalEnabled());
- }
+ virtual bool isFatalEnabled();
/// \brief Output Debug Message
@@ -189,38 +158,35 @@ public:
/// are used for more verbose output.
/// \param ident Message identification.
/// \param ... Optional arguments for the message.
- void debug(int dbglevel, MessageID ident, ...);
+ void debug(int dbglevel, const MessageID& ident, ...);
/// \brief Output Informational Message
///
/// \param ident Message identification.
/// \param ... Optional arguments for the message.
- void info(MessageID ident, ...);
+ void info(const MessageID& ident, ...);
/// \brief Output Warning Message
///
/// \param ident Message identification.
/// \param ... Optional arguments for the message.
- void warn(MessageID ident, ...);
+ void warn(const MessageID& ident, ...);
/// \brief Output Error Message
///
/// \param ident Message identification.
/// \param ... Optional arguments for the message.
- void error(MessageID ident, ...);
+ void error(const MessageID& ident, ...);
/// \brief Output Fatal Message
///
/// \param ident Message identification.
/// \param ... Optional arguments for the message.
- void fatal(MessageID ident, ...);
-
-
-protected:
+ void fatal(const MessageID& ident, ...);
/// \brief Equality
///
@@ -228,96 +194,55 @@ protected:
/// (This method is principally for testing.)
///
/// \return true if the logger objects are instances of the same logger.
- bool operator==(const Logger& other) const {
- return (*loggerptr_ == *other.loggerptr_);
- }
-
-
- /// \brief Logger Initialized
- ///
- /// Check that the logger has been properly initialized. (This method
- /// is principally for testing.)
- ///
- /// \return true if this logger object has been initialized.
- bool isInitialized() const {
- return (loggerptr_ != NULL);
- }
+ bool operator==(Logger& other);
+protected:
- /// \brief Get Severity Level for Logger
- ///
- /// This is common code for getSeverity() and getEffectiveSeverity() -
- /// it returns the severity of the logger; if not set (and the check_parent)
- /// flag is set, it searches up the parent-child tree until a severity
- /// level is found and uses that.
+ /// \brief Reset Global Data
///
- /// \param ptrlogger Pointer to the log4cxx logger to check.
- /// \param check_parent true to search up the tree, false to return the
- /// current level.
- ///
- /// \return The effective severity level of the logger. This is the same
- /// as getSeverity() if the logger has a severity level set, but otherwise
- /// is the severity of the parent.
- Logger::Severity getSeverityCommon(const log4cxx::LoggerPtr& ptrlogger,
- bool check_parent) const;
-
+ /// Used for testing, this calls upon the underlying logger implementation
+ /// to clear any global data.
+ static void reset();
- /// \brief Convert Between BIND-10 and log4cxx Logging Levels
- ///
- /// Converts between the numeric value of the log4cxx logging level
- /// and the BIND-10 severity level.
- ///
- /// \param value log4cxx numeric logging level
+private:
+ /// \brief Copy Constructor
///
- /// \return BIND-10 logging severity
- Severity convertLevel(int value) const;
-
+ /// Disabled (marked private) as it makes no sense to copy the logger -
+ /// just create another one of the same name.
+ Logger(const Logger&);
- /// \brief Initialize log4cxx Logger
+ /// \brief Assignment Operator
///
- /// Creates the log4cxx logger used internally. A function is provided for
- /// this so that the creation does not take place when this Logger object
- /// is created but when it is used. As the latter occurs in executable
- /// code but the former can occur during initialization, this order
- /// guarantees that anything that is statically initialized has completed
- /// its initialization by the time the logger is used.
- void initLogger();
+ /// Disabled (marked private) as it makes no sense to copy the logger -
+ /// just create another one of the same name.
+ Logger& operator=(const Logger&);
-
- /// \brief Return log4cxx Logger
- ///
- /// Returns the log4cxx logger, initializing it if not already initialized.
+ /// \brief Initialize Implementation
///
- /// \return Loggerptr object
- log4cxx::LoggerPtr& getLogger() {
- if (loggerptr_ == NULL) {
- initLogger();
+ /// Returns the logger pointer. If not yet set, the underlying
+ /// implementation class is initialized.\n
+ /// \n
+ /// The reason for this indirection is to avoid the "static initialization
+ /// fiacso", whereby we cannot rely on the order of static initializations.
+ /// The main problem is the root logger name - declared statically - which
+ /// is referenced by various loggers. By deferring a reference to it until
+ /// after the program starts executing - by which time the root name object
+ /// will be initialized - we avoid this problem.
+ ///
+ /// \return Returns pointer to implementation
+ LoggerImpl* getLoggerPtr() {
+ if (!loggerptr_) {
+ initLoggerImpl();
}
- return *loggerptr_;
+ return (loggerptr_);
}
+ /// \brief Initialize Underlying Implementation and Set loggerptr_
+ void initLoggerImpl();
- /// \brief Read Local Message File
- ///
- /// Reads a local message file into the global dictionary, replacing any
- /// definitions there. Any messages found in the local file that do not
- /// replace ones in the global dictionary are listed.
- ///
- /// \param file Local message file to be read.
- static void readLocalMessageFile(const char* file);
-
-private:
- // Note that loggerptr_ is a pointer to a LoggerPtr, which is itself a
- // pointer to the underlying log4cxx logger. This is due to the problems
- // with memory deletion on program exit, explained in the comments for
- // the "exit_delete" parameter in this class's constructor.
-
- log4cxx::LoggerPtr* loggerptr_; ///< Pointer to the underlying logger
- std::string name_; ///< Name of this logger]
- bool exit_delete_; ///< Delete loggerptr_ on exit?
-
- // NOTE - THIS IS A PLACE HOLDER
- static bool init_; ///< Set true when initialized
+ LoggerImpl* loggerptr_; ///< Pointer to the underlying logger
+ std::string name_; ///< Copy of the logger name
+ bool infunc_; ///< Copy of the infunc argument
};
} // namespace log
diff --git a/src/lib/log/logger_impl.cc b/src/lib/log/logger_impl.cc
new file mode 100644
index 0000000..4b19360
--- /dev/null
+++ b/src/lib/log/logger_impl.cc
@@ -0,0 +1,221 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE
+
+#include <iostream>
+#include <algorithm>
+
+#include <stdarg.h>
+#include <stdio.h>
+#include <boost/lexical_cast.hpp>
+
+#include <log/debug_levels.h>
+#include <log/root_logger_name.h>
+#include <log/logger.h>
+#include <log/logger_impl.h>
+#include <log/message_dictionary.h>
+#include <log/message_types.h>
+#include <log/root_logger_name.h>
+#include <log/strutil.h>
+
+using namespace std;
+
+namespace isc {
+namespace log {
+
+// Static initializations
+
+LoggerImpl::LoggerInfoMap LoggerImpl::logger_info_;
+LoggerImpl::LoggerInfo LoggerImpl::root_logger_info_(isc::log::INFO, 0);
+
+// Constructor
+LoggerImpl::LoggerImpl(const std::string& name, bool)
+{
+ // Are we the root logger?
+ if (name == getRootLoggerName()) {
+ is_root_ = true;
+ name_ = name;
+ } else {
+ is_root_ = false;
+ name_ = getRootLoggerName() + "." + name;
+ }
+}
+
+// Destructor. (Here because of virtual declaration.)
+
+LoggerImpl::~LoggerImpl() {
+}
+
+// Set the severity for logging.
+
+void
+LoggerImpl::setSeverity(isc::log::Severity severity, int dbglevel) {
+
+ // Silently coerce the debug level into the valid range of 0 to 99
+
+ int debug_level = max(MIN_DEBUG_LEVEL, min(MAX_DEBUG_LEVEL, dbglevel));
+ if (is_root_) {
+
+ // Can only set severity for the root logger, you can't disable it.
+ // Any attempt to do so is silently ignored.
+ if (severity != isc::log::DEFAULT) {
+ root_logger_info_ = LoggerInfo(severity, debug_level);
+ }
+
+ } else if (severity == isc::log::DEFAULT) {
+
+ // Want to set to default; this means removing the information
+ // about this logger from the logger_info_ if it is set.
+ LoggerInfoMap::iterator i = logger_info_.find(name_);
+ if (i != logger_info_.end()) {
+ logger_info_.erase(i);
+ }
+
+ } else {
+
+ // Want to set this information
+ logger_info_[name_] = LoggerInfo(severity, debug_level);
+ }
+}
+
+// Return severity level
+
+isc::log::Severity
+LoggerImpl::getSeverity() {
+
+ if (is_root_) {
+ return (root_logger_info_.severity);
+ }
+ else {
+ LoggerInfoMap::iterator i = logger_info_.find(name_);
+ if (i != logger_info_.end()) {
+ return ((i->second).severity);
+ }
+ else {
+ return (isc::log::DEFAULT);
+ }
+ }
+}
+
+// Get effective severity. Either the current severity or, if not set, the
+// severity of the root level.
+
+isc::log::Severity
+LoggerImpl::getEffectiveSeverity() {
+
+ if (!is_root_ && !logger_info_.empty()) {
+
+ // Not root logger and there is at least one item in the info map for a
+ // logger.
+ LoggerInfoMap::iterator i = logger_info_.find(name_);
+ if (i != logger_info_.end()) {
+
+ // Found, so return the severity.
+ return ((i->second).severity);
+ }
+ }
+
+ // Must be the root logger, or this logger is defaulting to the root logger
+ // settings.
+ return (root_logger_info_.severity);
+}
+
+// Get the debug level. This returns 0 unless the severity is DEBUG.
+
+int
+LoggerImpl::getDebugLevel() {
+
+ if (!is_root_ && !logger_info_.empty()) {
+
+ // Not root logger and there is something in the map, check if there
+ // is a setting for this one.
+ LoggerInfoMap::iterator i = logger_info_.find(name_);
+ if (i != logger_info_.end()) {
+
+ // Found, so return the debug level.
+ if ((i->second).severity == isc::log::DEBUG) {
+ return ((i->second).dbglevel);
+ } else {
+ return (0);
+ }
+ }
+ }
+
+ // Must be the root logger, or this logger is defaulting to the root logger
+ // settings.
+ if (root_logger_info_.severity == isc::log::DEBUG) {
+ return (root_logger_info_.dbglevel);
+ } else {
+ return (0);
+ }
+}
+
+// The code for isXxxEnabled is quite simple and is in the header. The only
+// exception is isDebugEnabled() where we have the complication of the debug
+// levels.
+
+bool
+LoggerImpl::isDebugEnabled(int dbglevel) {
+
+ if (!is_root_ && !logger_info_.empty()) {
+
+ // Not root logger and there is something in the map, check if there
+ // is a setting for this one.
+ LoggerInfoMap::iterator i = logger_info_.find(name_);
+ if (i != logger_info_.end()) {
+
+ // Found, so return the debug level.
+ if ((i->second).severity <= isc::log::DEBUG) {
+ return ((i->second).dbglevel >= dbglevel);
+ } else {
+ return (false); // Nothing lower than debug
+ }
+ }
+ }
+
+ // Must be the root logger, or this logger is defaulting to the root logger
+ // settings.
+ if (root_logger_info_.severity <= isc::log::DEBUG) {
+ return (root_logger_info_.dbglevel >= dbglevel);
+ } else {
+ return (false);
+ }
+}
+
+// Output a general message
+
+void
+LoggerImpl::output(const char* sev_text, const MessageID& ident,
+ va_list ap)
+{
+ char message[512]; // Should be large enough for any message
+
+ // Obtain text of the message and substitute arguments.
+ const string format = MessageDictionary::globalDictionary().getText(ident);
+ vsnprintf(message, sizeof(message), format.c_str(), ap);
+
+ // Get the time in a struct tm format, and convert to text
+ time_t t_time;
+ time(&t_time);
+ struct tm* tm_time = localtime(&t_time);
+
+ char chr_time[32];
+ (void) strftime(chr_time, sizeof(chr_time), "%Y-%m-%d %H:%M:%S", tm_time);
+
+ // Now output.
+ std::cout << chr_time << " " << sev_text << " [" << getName() << "] " <<
+ ident << ", " << message << "\n";
+}
+
+} // namespace log
+} // namespace isc
diff --git a/src/lib/log/logger_impl.h b/src/lib/log/logger_impl.h
new file mode 100644
index 0000000..9fc9cf9
--- /dev/null
+++ b/src/lib/log/logger_impl.h
@@ -0,0 +1,267 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#ifndef __LOGGER_IMPL_H
+#define __LOGGER_IMPL_H
+
+#include <stdarg.h>
+#include <time.h>
+
+#include <cstdlib>
+#include <string>
+#include <map>
+#include <utility>
+
+#include <log/debug_levels.h>
+#include <log/logger.h>
+#include <log/message_types.h>
+#include <log/root_logger_name.h>
+
+namespace isc {
+namespace log {
+
+/// \brief Console Logger Implementation
+///
+/// The logger uses a "pimpl" idiom for implementation, where the base logger
+/// class contains little more than a pointer to the implementation class, and
+/// all actions are carried out by the latter. This class is an implementation
+/// class that just outputs to stdout.
+
+class LoggerImpl {
+public:
+
+ /// \brief Information About Logger
+ ///
+ /// Holds a information about a logger, namely its severity and its debug
+ /// level. This could be a std::pair, except that it gets confusing when
+ /// accessing the LoggerInfoMap: that returns a pair, so we to reference
+ /// elements we would use constructs like ((i->first).second);
+ struct LoggerInfo {
+ isc::log::Severity severity;
+ int dbglevel;
+
+ LoggerInfo(isc::log::Severity sev = isc::log::INFO,
+ int dbg = MIN_DEBUG_LEVEL) : severity(sev), dbglevel(dbg)
+ {}
+ };
+
+
+ /// \brief Information About All Loggers
+ ///
+ /// Information about all loggers in the system - except the root logger -
+ /// is held in a map, linking name of the logger (excluding the root
+ /// name component) and its set severity and debug levels. The root
+ /// logger information is held separately.
+ typedef std::map<std::string, LoggerInfo> LoggerInfoMap;
+
+
+ /// \brief Constructor
+ ///
+ /// Creates a logger of the specific name.
+ ///
+ /// \param name Name of the logger.
+ ///
+ /// \param exit_delete This argument is present to get round a bug in
+ /// the log4cxx implementation. It is unused here.
+ LoggerImpl(const std::string& name, bool);
+
+
+ /// \brief Destructor
+ virtual ~LoggerImpl();
+
+
+ /// \brief Get the full name of the logger (including the root name)
+ virtual std::string getName() {
+ return (name_);
+ }
+
+
+ /// \brief Set Severity Level for Logger
+ ///
+ /// Sets the level at which this logger will log messages. If none is set,
+ /// the level is inherited from the parent.
+ ///
+ /// \param severity Severity level to log
+ /// \param dbglevel If the severity is DEBUG, this is the debug level.
+ /// This can be in the range 1 to 100 and controls the verbosity. A value
+ /// outside these limits is silently coerced to the nearest boundary.
+ virtual void setSeverity(isc::log::Severity severity, int dbglevel = 1);
+
+
+ /// \brief Get Severity Level for Logger
+ ///
+ /// \return The current logging level of this logger. In most cases though,
+ /// the effective logging level is what is required.
+ virtual isc::log::Severity getSeverity();
+
+
+ /// \brief Get Effective Severity Level for Logger
+ ///
+ /// \return The effective severity level of the logger. This is the same
+ /// as getSeverity() if the logger has a severity level set, but otherwise
+ /// is the severity of the parent.
+ virtual isc::log::Severity getEffectiveSeverity();
+
+
+ /// \brief Return DEBUG Level
+ ///
+ /// \return Current setting of debug level. This is returned regardless of
+ /// whether the
+ virtual int getDebugLevel();
+
+
+ /// \brief Returns if Debug Message Should Be Output
+ ///
+ /// \param dbglevel Level for which debugging is checked. Debugging is
+ /// enabled only if the logger has DEBUG enabled and if the dbglevel
+ /// checked is less than or equal to the debug level set for the logger.
+ virtual bool
+ isDebugEnabled(int dbglevel = MIN_DEBUG_LEVEL);
+
+ /// \brief Is INFO Enabled?
+ virtual bool isInfoEnabled() {
+ return (isEnabled(isc::log::INFO));
+ }
+
+ /// \brief Is WARNING Enabled?
+ virtual bool isWarnEnabled() {
+ return (isEnabled(isc::log::WARN));
+ }
+
+ /// \brief Is ERROR Enabled?
+ virtual bool isErrorEnabled() {
+ return (isEnabled(isc::log::ERROR));
+ }
+
+ /// \brief Is FATAL Enabled?
+ virtual bool isFatalEnabled() {
+ return (isEnabled(isc::log::FATAL));
+ }
+
+
+ /// \brief Common Severity check
+ ///
+ /// Implements the common severity check. As an optimisation, this checks
+ /// to see if any logger-specific levels have been set (a quick check as it
+ /// just involves seeing if the collection of logger information is empty).
+ /// if not, it returns the information for the root level; if so, it has
+ /// to take longer and look up the information in the map holding the
+ /// logging details.
+ virtual bool isEnabled(isc::log::Severity severity) {
+ if (logger_info_.empty()) {
+ return (root_logger_info_.severity <= severity);
+ }
+ else {
+ return (getSeverity() <= severity);
+ }
+ }
+
+
+ /// \brief Output General Message
+ ///
+ /// The message is formatted to include the date and time, the severity
+ /// and the logger generating the message.
+ ///
+ /// \param sev_text Severity level as a text string
+ /// \param ident Message identification
+ /// \param ap Variable argument list holding message arguments
+ void output(const char* sev_text, const MessageID& ident,
+ va_list ap);
+
+
+ /// \brief Output Debug Message
+ ///
+ /// \param ident Message identification.
+ /// \param text Text to log
+ /// \param ap Variable argument list holding message arguments
+ void debug(const MessageID& ident, va_list ap) {
+ output("DEBUG", ident, ap);
+ }
+
+
+ /// \brief Output Informational Message
+ ///
+ /// \param ident Message identification.
+ /// \param text Text to log
+ /// \param ap Variable argument list holding message arguments
+ void info(const MessageID& ident, va_list ap) {
+ output("INFO ", ident, ap);
+ }
+
+ /// \brief Output Warning Message
+ ///
+ /// \param ident Message identification.
+ /// \param text Text to log
+ /// \param ap Variable argument list holding message arguments
+ void warn(const MessageID& ident, va_list ap) {
+ output("WARN ", ident, ap);
+ }
+
+ /// \brief Output Error Message
+ ///
+ /// \param ident Message identification.
+ /// \param text Text to log
+ /// \param ap Variable argument list holding message arguments
+ void error(const MessageID& ident, va_list ap) {
+ output("ERROR", ident, ap);
+ }
+
+ /// \brief Output Fatal Message
+ ///
+ /// \param ident Message identification.
+ /// \param text Text to log
+ /// \param ap Variable argument list holding message arguments
+ void fatal(const MessageID& ident, va_list ap) {
+ output("FATAL", ident, ap);
+ }
+
+ /// \brief Equality
+ ///
+ /// Check if two instances of this logger refer to the same stream.
+ /// (This method is principally for testing.)
+ ///
+ /// \return true if the logger objects are instances of the same logger.
+ bool operator==(const LoggerImpl& other) {
+ return (name_ == other.name_);
+ }
+
+
+ /// \brief Reset Global Data
+ ///
+ /// Only used for testing, this clears all the logger information and
+ /// resets it back to default values.
+ static void reset() {
+ root_logger_info_ = LoggerInfo(isc::log::INFO, MIN_DEBUG_LEVEL);
+ logger_info_.clear();
+ }
+
+
+private:
+ bool is_root_; ///< true if a root logger
+ std::string name_; ///< Name of this logger
+
+ // Split the status of the root logger from this logger. If - is will
+ // probably be the usual case - no per-logger setting is enabled, a
+ // quick check of logger_info_.empty() will return true and we can quickly
+ // return the root logger status without a length lookup in the map.
+
+ static LoggerInfo root_logger_info_; ///< Status of root logger
+ static LoggerInfoMap logger_info_; ///< Store of debug levels etc.
+};
+
+} // namespace log
+} // namespace isc
+
+
+#endif // __LOGGER_IMPL_H
diff --git a/src/lib/log/logger_impl_log4cxx.cc b/src/lib/log/logger_impl_log4cxx.cc
new file mode 100644
index 0000000..404fd03
--- /dev/null
+++ b/src/lib/log/logger_impl_log4cxx.cc
@@ -0,0 +1,241 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE
+
+#include <iostream>
+
+#include <stdarg.h>
+#include <stdio.h>
+
+#include <log4cxx/appender.h>
+#include <log4cxx/basicconfigurator.h>
+#include <log4cxx/patternlayout.h>
+#include <log4cxx/consoleappender.h>
+
+#include <log/root_logger_name.h>
+#include <log/logger.h>
+#include <log/logger_impl.h>
+#include <log/message_dictionary.h>
+#include <log/message_types.h>
+#include <log/strutil.h>
+#include <log/xdebuglevel.h>
+
+using namespace std;
+
+namespace isc {
+namespace log {
+
+// Static initializations
+
+bool LoggerImpl::init_ = false;
+
+// Destructor. Delete log4cxx stuff if "don't delete" is clear.
+
+LoggerImpl::~LoggerImpl() {
+ if (exit_delete_) {
+ delete loggerptr_;
+ }
+}
+
+// Initialize logger - create a logger as a child of the root logger. With
+// log4cxx this is assured by naming the logger <parent>.<child>.
+
+void
+LoggerImpl::initLogger() {
+
+ // Initialize basic logging if not already done. This is a one-off for
+ // all loggers.
+ if (!init_) {
+
+ // TEMPORARY
+ // Add a suitable console logger to the log4cxx root logger. (This
+ // is the logger at the root of the log4cxx tree, not the BIND-10 root
+ // logger, which is one level down.) The chosen format is:
+ //
+ // YYYY-MM-DD hh:mm:ss.sss [logger] SEVERITY: text
+ //
+ // As noted, this is a temporary hack: it is done here to ensure that
+ // a suitable output and output pattern is set. Future versions of the
+ // software will set this based on configuration data.
+
+ log4cxx::LayoutPtr layout(
+ new log4cxx::PatternLayout(
+ "%d{yyyy-MM-DD HH:mm:ss.SSS} %-5p [%c] %m\n"));
+ log4cxx::AppenderPtr console(
+ new log4cxx::ConsoleAppender(layout));
+ log4cxx::LoggerPtr sys_root_logger = log4cxx::Logger::getRootLogger();
+ sys_root_logger->addAppender(console);
+
+ // Set the default logging to INFO
+ sys_root_logger->setLevel(log4cxx::Level::getInfo());
+
+ // All static stuff initialized
+ init_ = true;
+ }
+
+ // Initialize this logger. Name this as to whether the BIND-10 root logger
+ // name has been set. (If not, this mucks up the hierarchy :-( ).
+ string root_name = RootLoggerName::getName();
+ if (root_name.empty() || (name_ == root_name)) {
+ loggerptr_ = new log4cxx::LoggerPtr(log4cxx::Logger::getLogger(name_));
+ }
+ else {
+ loggerptr_ = new log4cxx::LoggerPtr(
+ log4cxx::Logger::getLogger(root_name + "." + name_)
+ );
+ }
+}
+
+
+// Set the severity for logging. There is a 1:1 mapping between the logging
+// severity and the log4cxx logging levels, apart from DEBUG.
+//
+// In log4cxx, each of the logging levels (DEBUG, INFO, WARN etc.) has a numeric
+// value. The level is set to one of these and any numeric level equal to or
+// above it that is reported. For example INFO has a value of 20000 and ERROR
+// a value of 40000. So if a message of WARN severity (= 30000) is logged, it is
+// not logged when the logger's severity level is ERROR (as 30000 !>= 40000).
+// It is reported if the logger's severity level is set to WARN (as 30000 >=
+/// 30000) or INFO (30000 >= 20000).
+//
+// This gives a simple system for handling different debug levels. The debug
+// level is a number between 0 and 99, with 0 being least verbose and 99 the
+// most. To implement this seamlessly, when DEBUG is set, the numeric value
+// of the logging level is actually set to (DEBUG - debug-level). Similarly
+// messages of level "n" are logged at a logging level of (DEBUG - n). Thus if
+// the logging level is set to DEBUG and the debug level set to 25, the actual
+// level set is 10000 - 25 = 99975.
+//
+// Attempting to log a debug message of level 26 is an attempt to log a message
+// of level 10000 - 26 = 9974. As 9974 !>= 9975, it is not logged. A
+// message of level 25 is, because 9975 >= 9975.
+//
+// The extended set of logging levels is implemented by the XDebugLevel class.
+
+void
+LoggerImpl::setSeverity(isc::log::Severity severity, int dbglevel) {
+ switch (severity) {
+ case NONE:
+ getLogger()->setLevel(log4cxx::Level::getOff());
+ break;
+
+ case FATAL:
+ getLogger()->setLevel(log4cxx::Level::getFatal());
+ break;
+
+ case ERROR:
+ getLogger()->setLevel(log4cxx::Level::getError());
+ break;
+
+ case WARN:
+ getLogger()->setLevel(log4cxx::Level::getWarn());
+ break;
+
+ case INFO:
+ getLogger()->setLevel(log4cxx::Level::getInfo());
+ break;
+
+ case DEBUG:
+ getLogger()->setLevel(
+ log4cxx::XDebugLevel::getExtendedDebug(dbglevel));
+ break;
+
+ // Will get here for DEFAULT or any other value. This disables the
+ // logger's own severity and it defaults to the severity of the parent
+ // logger.
+ default:
+ getLogger()->setLevel(0);
+ }
+}
+
+// Convert between numeric log4cxx logging level and BIND-10 logging severity.
+
+isc::log::Severity
+LoggerImpl::convertLevel(int value) {
+
+ // The order is optimised. This is only likely to be called when testing
+ // for writing debug messages, so the check for DEBUG_INT is first.
+ if (value <= log4cxx::Level::DEBUG_INT) {
+ return (DEBUG);
+ } else if (value <= log4cxx::Level::INFO_INT) {
+ return (INFO);
+ } else if (value <= log4cxx::Level::WARN_INT) {
+ return (WARN);
+ } else if (value <= log4cxx::Level::ERROR_INT) {
+ return (ERROR);
+ } else if (value <= log4cxx::Level::FATAL_INT) {
+ return (FATAL);
+ } else {
+ return (NONE);
+ }
+}
+
+
+// Return the logging severity associated with this logger.
+
+isc::log::Severity
+LoggerImpl::getSeverityCommon(const log4cxx::LoggerPtr& ptrlogger,
+ bool check_parent) {
+
+ log4cxx::LevelPtr level = ptrlogger->getLevel();
+ if (level == log4cxx::LevelPtr()) {
+
+ // Null level returned, logging should be that of the parent.
+
+ if (check_parent) {
+ log4cxx::LoggerPtr parent = ptrlogger->getParent();
+ if (parent == log4cxx::LoggerPtr()) {
+
+ // No parent, so reached the end of the chain. Return INFO
+ // severity.
+ return (INFO);
+ }
+ else {
+ return (getSeverityCommon(parent, check_parent));
+ }
+ }
+ else {
+ return (DEFAULT);
+ }
+ } else {
+ return (convertLevel(level->toInt()));
+ }
+}
+
+
+// Get the debug level. This returns 0 unless the severity is DEBUG.
+
+int
+LoggerImpl::getDebugLevel() {
+
+ log4cxx::LevelPtr level = getLogger()->getLevel();
+ if (level == log4cxx::LevelPtr()) {
+
+ // Null pointer returned, logging should be that of the parent.
+ return (0);
+
+ } else {
+ int severity = level->toInt();
+ if (severity <= log4cxx::Level::DEBUG_INT) {
+ return (log4cxx::Level::DEBUG_INT - severity);
+ }
+ else {
+ return (0);
+ }
+ }
+}
+
+
+
+} // namespace log
+} // namespace isc
diff --git a/src/lib/log/logger_impl_log4cxx.h b/src/lib/log/logger_impl_log4cxx.h
new file mode 100644
index 0000000..3101347
--- /dev/null
+++ b/src/lib/log/logger_impl_log4cxx.h
@@ -0,0 +1,315 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#ifndef __LOGGER_IMPL_LOG4CXX_H
+#define __LOGGER_IMPL_LOG4CXX_H
+
+#include <cstdlib>
+#include <string>
+#include <boost/lexical_cast.hpp>
+#include <log4cxx/logger.h>
+#include <log4cxx/logger.h>
+
+#include <log/debug_levels.h>
+#include <log/logger.h>
+#include <log/message_types.h>
+
+namespace isc {
+namespace log {
+
+/// \brief Log4cxx Logger Implementation
+///
+/// The logger uses a "pimpl" idiom for implementation, where the base logger
+/// class contains little more than a pointer to the implementation class, and
+/// all actions are carried out by the latter. This class is an implementation
+/// class interfacing to the log4cxx logging system.
+
+class LoggerImpl {
+public:
+
+ /// \brief Constructor
+ ///
+ /// Creates/attaches to a logger of a specific name.
+ ///
+ /// \param name Name of the logger. If the name is that of the root name,
+ /// this creates an instance of the root logger; otherwise it creates a
+ /// child of the root logger.
+ ///
+ /// \param exit_delete This argument is present to get round a bug in
+ /// log4cxx. If a log4cxx logger is declared outside an execution unit, it
+ /// is not deleted until the program runs down. At that point all such
+ /// objects - including internal log4cxx objects - are deleted. However,
+ /// there seems to be a bug in log4cxx where the way that such objects are
+ /// destroyed causes a MutexException to be thrown (this is described in
+ /// https://issues.apache.org/jira/browse/LOGCXX-322). As this only occurs
+ /// during program rundown, the issue is not serious - it just looks bad to
+ /// have the program crash instead of shut down cleanly.\n
+ /// \n
+ /// The original implementation of the isc::log::Logger had as a member a
+ /// log4cxx logger (actually a LoggerPtr). If the isc:: Logger was declared
+ /// statically, when it was destroyed at the end of the program the internal
+ /// LoggerPtr was destroyed, which triggered the problem. The problem did
+ /// not occur if the isc::log::Logger was created on the stack. To get
+ /// round this, the internal LoggerPtr is now created dynamically. The
+ /// exit_delete argument controls its destruction: if true, it is destroyed
+ /// in the ISC Logger destructor. If false, it is not.\n
+ /// \n
+ /// When creating an isc::log::Logger on the stack, the argument should be
+ /// false (the default); when the Logger is destroyed, all the internal
+ /// log4cxx objects are destroyed. As only the logger (and not the internal
+ /// log4cxx data structures are being destroyed), all is well. However,
+ /// when creating the logger statically, the argument should be false. This
+ /// means that the log4cxx objects are not destroyed at program rundown;
+ /// instead memory is reclaimed and files are closed when the process is
+ /// destroyed, something that does not trigger the bug.
+ LoggerImpl(const std::string& name, bool exit_delete = false) :
+ loggerptr_(NULL), name_(name), exit_delete_(exit_delete)
+ {}
+
+
+ /// \brief Destructor
+ virtual ~LoggerImpl();
+
+
+ /// \brief Get the full name of the logger (including the root name)
+ virtual std::string getName() {
+ return (getLogger()->getName());
+ }
+
+
+ /// \brief Set Severity Level for Logger
+ ///
+ /// Sets the level at which this logger will log messages. If none is set,
+ /// the level is inherited from the parent.
+ ///
+ /// \param severity Severity level to log
+ /// \param dbglevel If the severity is DEBUG, this is the debug level.
+ /// This can be in the range 1 to 100 and controls the verbosity. A value
+ /// outside these limits is silently coerced to the nearest boundary.
+ virtual void setSeverity(isc::log::Severity severity, int dbglevel = 1);
+
+
+ /// \brief Get Severity Level for Logger
+ ///
+ /// \return The current logging level of this logger. In most cases though,
+ /// the effective logging level is what is required.
+ virtual isc::log::Severity getSeverity() {
+ return (getSeverityCommon(getLogger(), false));
+ }
+
+
+ /// \brief Get Effective Severity Level for Logger
+ ///
+ /// \return The effective severity level of the logger. This is the same
+ /// as getSeverity() if the logger has a severity level set, but otherwise
+ /// is the severity of the parent.
+ virtual isc::log::Severity getEffectiveSeverity() {
+ return (getSeverityCommon(getLogger(), true));
+ }
+
+
+ /// \brief Return DEBUG Level
+ ///
+ /// \return Current setting of debug level. This is returned regardless of
+ /// whether the
+ virtual int getDebugLevel();
+
+
+ /// \brief Returns if Debug Message Should Be Output
+ ///
+ /// \param dbglevel Level for which debugging is checked. Debugging is
+ /// enabled only if the logger has DEBUG enabled and if the dbglevel
+ /// checked is less than or equal to the debug level set for the logger.
+ virtual bool
+ isDebugEnabled(int dbglevel = MIN_DEBUG_LEVEL) {
+ return (getLogger()->getEffectiveLevel()->toInt() <=
+ (log4cxx::Level::DEBUG_INT - dbglevel));
+ }
+
+
+ /// \brief Is INFO Enabled?
+ virtual bool isInfoEnabled() {
+ return (getLogger()->isInfoEnabled());
+ }
+
+
+ /// \brief Is WARNING Enabled?
+ virtual bool isWarnEnabled() {
+ return (getLogger()->isWarnEnabled());
+ }
+
+
+ /// \brief Is ERROR Enabled?
+ virtual bool isErrorEnabled() {
+ return (getLogger()->isErrorEnabled());
+ }
+
+
+ /// \brief Is FATAL Enabled?
+ virtual bool isFatalEnabled() {
+ return (getLogger()->isFatalEnabled());
+ }
+
+
+ /// \brief Output Debug Message
+ ///
+ /// \param ident Message identification.
+ /// \param text Text to log
+ void debug(const MessageID& ident, const char* text) {
+ LOG4CXX_DEBUG(getLogger(), ident << ", " << text);
+ }
+
+
+ /// \brief Output Informational Message
+ ///
+ /// \param ident Message identification.
+ /// \param text Text to log
+ void info(const MessageID& ident, const char* text) {
+ LOG4CXX_INFO(getLogger(), ident << ", " << text);
+ }
+
+
+ /// \brief Output Warning Message
+ ///
+ /// \param ident Message identification.
+ /// \param text Text to log
+ void warn(const MessageID& ident, const char* text) {
+ LOG4CXX_WARN(getLogger(), ident << ", " << text);
+ }
+
+
+ /// \brief Output Error Message
+ ///
+ /// \param ident Message identification.
+ /// \param text Text to log
+ void error(const MessageID& ident, const char* text) {
+ LOG4CXX_ERROR(getLogger(), ident << ", " << text);
+ }
+
+
+ /// \brief Output Fatal Message
+ ///
+ /// \param ident Message identification.
+ /// \param text Text to log
+ void fatal(const MessageID& ident, const char* text) {
+ LOG4CXX_FATAL(getLogger(), ident << ", " << text);
+ }
+
+ //@{
+ /// \brief Testing Methods
+ ///
+ /// The next set of methods are used in testing. As they are accessed from
+ /// the main logger class, they must be public.
+
+ /// \brief Equality
+ ///
+ /// Check if two instances of this logger refer to the same stream.
+ /// (This method is principally for testing.)
+ ///
+ /// \return true if the logger objects are instances of the same logger.
+ bool operator==(LoggerImpl& other) {
+ return (*loggerptr_ == *other.loggerptr_);
+ }
+
+
+ /// \brief Logger Initialized
+ ///
+ /// Check that the logger has been properly initialized. (This method
+ /// is principally for testing.)
+ ///
+ /// \return true if this logger object has been initialized.
+ bool isInitialized() {
+ return (loggerptr_ != NULL);
+ }
+
+ /// \brief Reset Global Data
+ ///
+ /// Only used for testing, this clears all the logger information and
+ /// resets it back to default values. This is a no-op for log4cxx.
+ static void reset() {
+ }
+
+ //@}
+
+protected:
+
+ /// \brief Convert Between BIND-10 and log4cxx Logging Levels
+ ///
+ /// This method is marked protected to allow for unit testing.
+ ///
+ /// \param value log4cxx numeric logging level
+ ///
+ /// \return BIND-10 logging severity
+ isc::log::Severity convertLevel(int value);
+
+private:
+
+ /// \brief Get Severity Level for Logger
+ ///
+ /// This is common code for getSeverity() and getEffectiveSeverity() -
+ /// it returns the severity of the logger; if not set (and the check_parent)
+ /// flag is set, it searches up the parent-child tree until a severity
+ /// level is found and uses that.
+ ///
+ /// \param ptrlogger Pointer to the log4cxx logger to check.
+ /// \param check_parent true to search up the tree, false to return the
+ /// current level.
+ ///
+ /// \return The effective severity level of the logger. This is the same
+ /// as getSeverity() if the logger has a severity level set, but otherwise
+ /// is the severity of the parent.
+ isc::log::Severity getSeverityCommon(const log4cxx::LoggerPtr& ptrlogger,
+ bool check_parent);
+
+
+
+ /// \brief Initialize log4cxx Logger
+ ///
+ /// Creates the log4cxx logger used internally. A function is provided for
+ /// this so that the creation does not take place when this Logger object
+ /// is created but when it is used. As the latter occurs in executable
+ /// code but the former can occur during initialization, this order
+ /// guarantees that anything that is statically initialized has completed
+ /// its initialization by the time the logger is used.
+ void initLogger();
+
+
+ /// \brief Return underlying log4cxx logger, initializing it if necessary
+ ///
+ /// \return Loggerptr object
+ log4cxx::LoggerPtr& getLogger() {
+ if (loggerptr_ == NULL) {
+ initLogger();
+ }
+ return (*loggerptr_);
+ }
+
+ // Members. Note that loggerptr_ is a pointer to a LoggerPtr, which is
+ // itself a pointer to the underlying log4cxx logger. This is due to the
+ // problems with memory deletion on program exit, explained in the comments
+ // for the "exit_delete" parameter in this class's constructor.
+
+ log4cxx::LoggerPtr* loggerptr_; ///< Pointer to the underlying logger
+ std::string name_; ///< Name of this logger]
+ bool exit_delete_; ///< Delete loggerptr_ on exit?
+
+ // NOTE - THIS IS A PLACE HOLDER
+ static bool init_; ///< Set true when initialized
+};
+
+} // namespace log
+} // namespace isc
+
+
+#endif // __LOGGER_IMPL_LOG4CXX_H
diff --git a/src/lib/log/logger_levels.h b/src/lib/log/logger_levels.h
new file mode 100644
index 0000000..2f123e8
--- /dev/null
+++ b/src/lib/log/logger_levels.h
@@ -0,0 +1,42 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#ifndef __LOGGER_LEVELS_H
+#define __LOGGER_LEVELS_H
+
+namespace isc {
+namespace log {
+
+/// \brief Severity Levels
+///
+/// Defines the severity levels for logging. This is shared between the logger
+/// and the implementations classes.
+///
+/// N.B. The order of the levels - DEBUG less than INFO less that WARN etc. is
+/// implicitly assumed in several implementations. They must not be changed.
+
+typedef enum {
+ DEFAULT = 0, // Default to logging level of the parent
+ DEBUG = 1,
+ INFO = 2,
+ WARN = 3,
+ ERROR = 4,
+ FATAL = 5,
+ NONE = 6 // Disable logging
+} Severity;
+
+} // namespace log
+} // namespace isc
+
+#endif // __LOGGER_LEVELS_H
diff --git a/src/lib/log/logger_support.cc b/src/lib/log/logger_support.cc
index c9ba858..1ac4481 100644
--- a/src/lib/log/logger_support.cc
+++ b/src/lib/log/logger_support.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,10 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE
-// $Id$
-
-
-
/// \brief Temporary Logger Support
///
/// Performs run-time initialization of the logger system. In particular, it
@@ -28,13 +24,17 @@
/// These functions will be replaced once the code has bneen written to obtain
/// the logging parameters from the configuration database.
+#include <algorithm>
+#include <string>
#include <vector>
+#include <boost/lexical_cast.hpp>
#include <log/logger.h>
#include <log/logger_support.h>
#include <log/messagedef.h>
#include <log/message_dictionary.h>
#include <log/message_exception.h>
+#include <log/message_initializer.h>
#include <log/message_reader.h>
#include <log/message_types.h>
#include <log/root_logger_name.h>
@@ -44,7 +44,8 @@ namespace log {
using namespace std;
-// Declare a logger for the logging subsystem
+// Declare a logger for the logging subsystem. This is a sub-logger of the
+// root logger and is used in all functions in this file.
Logger logger("log");
@@ -57,22 +58,24 @@ Logger logger("log");
/// \param file Name of the local message file
static void
readLocalMessageFile(const char* file) {
-
- MessageDictionary* dictionary = MessageDictionary::globalDictionary();
- MessageReader reader(dictionary);
+
+ MessageDictionary& dictionary = MessageDictionary::globalDictionary();
+ MessageReader reader(&dictionary);
try {
+ logger.info(MSG_RDLOCMES, file);
reader.readFile(file, MessageReader::REPLACE);
// File successfully read, list the duplicates
MessageReader::MessageIDCollection unknown = reader.getNotAdded();
for (MessageReader::MessageIDCollection::const_iterator
i = unknown.begin(); i != unknown.end(); ++i) {
- logger.warn(MSG_IDNOTFND, (*i).c_str());
+ string message_id = boost::lexical_cast<string>(*i);
+ logger.warn(MSG_IDNOTFND, message_id.c_str());
}
}
catch (MessageException& e) {
MessageID ident = e.id();
- vector<MessageID> args = e.arguments();
+ vector<string> args = e.arguments();
switch (args.size()) {
case 0:
logger.error(ident);
@@ -91,20 +94,33 @@ readLocalMessageFile(const char* file) {
/// Logger Run-Time Initialization
void
-runTimeInit(Logger::Severity severity, int dbglevel, const char* file) {
+initLogger(const string& root, isc::log::Severity severity, int dbglevel,
+ const char* file) {
- // Create the application root logger. This is the logger that has the
- // name of the application (and is one level down from the log4cxx root
- // logger). All other loggers created in this application will be its
- // child.
- //
- // The main purpose of the application root logger is to provide the root
- // name in output message for all other loggers.
- Logger logger(RootLoggerName::getName());
+ // Create the application root logger and set the default severity and
+ // debug level. This is the logger that has the name of the application.
+ // All other loggers created in this application will be its children.
+ setRootLoggerName(root);
+ Logger root_logger(isc::log::getRootLoggerName(), true);
// Set the severity associated with it. If no other logger has a severity,
// this will be the default.
- logger.setSeverity(severity, dbglevel);
+ root_logger.setSeverity(severity, dbglevel);
+
+ // Check if there were any duplicate message IDs in the default dictionary
+ // and if so, log them. Log using the logging facility root logger.
+ vector<string>& duplicates = MessageInitializer::getDuplicates();
+ if (!duplicates.empty()) {
+
+ // There are - sort and remove any duplicates.
+ sort(duplicates.begin(), duplicates.end());
+ vector<string>::iterator new_end =
+ unique(duplicates.begin(), duplicates.end());
+ for (vector<string>::iterator i = duplicates.begin(); i != new_end; ++i) {
+ logger.warn(MSG_DUPMSGID, i->c_str());
+ }
+
+ }
// Replace any messages with local ones (if given)
if (file) {
diff --git a/src/lib/log/logger_support.h b/src/lib/log/logger_support.h
index 85f838f..57d8383 100644
--- a/src/lib/log/logger_support.h
+++ b/src/lib/log/logger_support.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,11 +12,10 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __LOGGER_SUPPORT_H
#define __LOGGER_SUPPORT_H
+#include <string>
#include <log/logger.h>
namespace isc {
@@ -24,17 +23,21 @@ namespace log {
/// \brief Run-Time Initialization
///
-/// This code will be used until the logger is fully integrated into the BIND-10
-/// configuration database. It performs run-time initialization of th logger,
-/// in particular supplying run-time choices to it:
+/// Performs run-time initialization of the logger in particular supplying:
+///
+/// - Name of the root logger
+/// - The severity (and if applicable, debug level) for the root logger.
+/// - Name of a local message file, containing localisation of message text.
///
-/// * The severity (and if applicable, debug level) at which to log
-/// * Name of a local message file, containing localisation of message text.
+/// This function is likely to change over time as more debugging options are
+/// held in the configuration database.
///
+/// \param root Name of the root logger
/// \param severity Severity at which to log
/// \param dbglevel Debug severiy (ignored if "severity" is not "DEBUG")
/// \param file Name of the local message file.
-void runTimeInit(Logger::Severity severity, int dbglevel, const char* file);
+void initLogger(const std::string& root, isc::log::Severity severity,
+ int dbglevel, const char* file);
} // namespace log
} // namespace isc
diff --git a/src/lib/log/message_dictionary.cc b/src/lib/log/message_dictionary.cc
index 05c79f8..c091369 100644
--- a/src/lib/log/message_dictionary.cc
+++ b/src/lib/log/message_dictionary.cc
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <cstddef>
#include <log/message_dictionary.h>
#include <log/message_types.h>
@@ -31,82 +29,81 @@ MessageDictionary::~MessageDictionary() {
// Add message and note if ID already exists
bool
-MessageDictionary::add(const MessageID& ident, const std::string& text) {
- map<MessageID, string>::iterator i = dictionary_.find(ident);
+MessageDictionary::add(const string& ident, const string& text) {
+ Dictionary::iterator i = dictionary_.find(ident);
bool not_found = (i == dictionary_.end());
if (not_found) {
// Message not already in the dictionary, so add it.
dictionary_[ident] = text;
}
-
+
return (not_found);
}
// Add message and note if ID does not already exist
bool
-MessageDictionary::replace(const MessageID& ident, const std::string& text) {
- map<MessageID, string>::iterator i = dictionary_.find(ident);
+MessageDictionary::replace(const string& ident, const string& text) {
+ Dictionary::iterator i = dictionary_.find(ident);
bool found = (i != dictionary_.end());
if (found) {
// Exists, so replace it.
dictionary_[ident] = text;
}
-
+
return (found);
}
// Load a set of messages
-vector<MessageID>
+vector<std::string>
MessageDictionary::load(const char* messages[]) {
- vector<MessageID> duplicates;
+ vector<std::string> duplicates;
int i = 0;
while (messages[i]) {
// ID present, so note it and point to text.
- MessageID ident(messages[i++]);
+ const MessageID ident(messages[i++]);
if (messages[i]) {
- // Text not null, note it and point to next ident.
+ // Text not null, note it and point to next ident.
string text(messages[i++]);
// Add ID and text to message dictionary, noting if the ID was
// already present.
bool added = add(ident, text);
if (!added) {
- duplicates.push_back(ident);
+ duplicates.push_back(boost::lexical_cast<string>(ident));
}
}
}
- return duplicates;
+ return (duplicates);
}
-// Return message text or blank string
+// Return message text or blank string. A reference is returned to a string
+// in the dictionary - this is fine, as the string is immediately used for
+// output.
-string
-MessageDictionary::getText(const MessageID& ident) const {
- map<MessageID, string>::const_iterator i = dictionary_.find(ident);
+const string&
+MessageDictionary::getText(const string& ident) const {
+ static const string empty("");
+ Dictionary::const_iterator i = dictionary_.find(ident);
if (i == dictionary_.end()) {
- return string("");
+ return (empty);
}
else {
- return i->second;
+ return (i->second);
}
}
// Return global dictionary
-MessageDictionary*
+MessageDictionary&
MessageDictionary::globalDictionary() {
- static MessageDictionary* global = NULL;
-
- if (global == NULL) {
- global = new MessageDictionary();
- }
- return global;
+ static MessageDictionary global;
+ return (global);
}
diff --git a/src/lib/log/message_dictionary.h b/src/lib/log/message_dictionary.h
index 0b2e704..0caa3ea 100644
--- a/src/lib/log/message_dictionary.h
+++ b/src/lib/log/message_dictionary.h
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __MESSAGE_DICTIONARY_H
#define __MESSAGE_DICTIONARY_H
@@ -22,6 +20,8 @@
#include <map>
#include <vector>
+#include <boost/lexical_cast.hpp>
+
#include <log/message_types.h>
namespace isc {
@@ -48,6 +48,9 @@ namespace log {
class MessageDictionary {
public:
+ typedef std::map<std::string, std::string> Dictionary;
+ typedef Dictionary::const_iterator const_iterator;
+
// Default constructor and assignment operator are OK for this class
/// \brief Virtual Destructor
@@ -63,7 +66,20 @@ public:
///
/// \return true if the message was added to the dictionary, false if the
/// message existed and it was not added.
- virtual bool add(const MessageID& ident, const std::string& text);
+ virtual bool add(const MessageID& ident, const std::string& text) {
+ return (add(boost::lexical_cast<std::string>(ident), text));
+ }
+
+ /// \brief Add Message
+ ///
+ /// Alternate signature.
+ ///
+ /// \param ident Identification of the message to add
+ /// \param text Message text
+ ///
+ /// \return true if the message was added to the dictionary, false if the
+ /// message existed and it was not added.
+ virtual bool add (const std::string& ident, const std::string& test);
/// \brief Replace Message
@@ -76,7 +92,21 @@ public:
///
/// \return true if the message was added to the dictionary, false if the
/// message did not exist and it was not added.
- virtual bool replace(const MessageID& ident, const std::string& text);
+ virtual bool replace(const MessageID& ident, const std::string& text) {
+ return (replace(boost::lexical_cast<std::string>(ident), text));
+ }
+
+
+ /// \brief Replace Message
+ ///
+ /// Alternate signature.
+ ///
+ /// \param ident Identification of the message to replace
+ /// \param text Message text
+ ///
+ /// \return true if the message was added to the dictionary, false if the
+ /// message did not exist and it was not added.
+ virtual bool replace(const std::string& ident, const std::string& text);
/// \brief Load Dictionary
@@ -94,7 +124,7 @@ public:
/// \return Vector of message IDs that were not loaded because an ID of the
/// same name already existing in the dictionary. This vector may be
/// empty.
- virtual std::vector<MessageID> load(const char* elements[]);
+ virtual std::vector<std::string> load(const char* elements[]);
/// \brief Get Message Text
@@ -106,30 +136,40 @@ public:
/// \return Text associated with message or empty string if the ID is not
/// recognised. (Note: this precludes an ID being associated with an empty
/// string.)
- virtual std::string getText(const MessageID& ident) const;
+ virtual const std::string& getText(const MessageID& ident) const {
+ return(getText(boost::lexical_cast<std::string>(ident)));
+ }
+
+
+ /// \brief Get Message Text
+ ///
+ /// Alternate signature.
+ ///
+ /// \param ident Message identification
+ ///
+ /// \return Text associated with message or empty string if the ID is not
+ /// recognised. (Note: this precludes an ID being associated with an empty
+ /// string.)
+ virtual const std::string& getText(const std::string& ident) const;
/// \brief Number of Items in Dictionary
///
/// \return Number of items in the dictionary
virtual size_t size() const {
- return dictionary_.size();
+ return (dictionary_.size());
}
- // Allow access to the internal map structure, but don't allow alteration.
- typedef std::map<MessageID, std::string>::const_iterator const_iterator;
-
-
/// \brief Return begin() iterator of internal map
const_iterator begin() const {
- return dictionary_.begin();
+ return (dictionary_.begin());
}
/// \brief Return end() iterator of internal map
const_iterator end() const {
- return dictionary_.end();
+ return (dictionary_.end());
}
@@ -138,10 +178,10 @@ public:
/// Returns a pointer to the singleton global dictionary.
///
/// \return Pointer to global dictionary.
- static MessageDictionary* globalDictionary();
+ static MessageDictionary& globalDictionary();
private:
- std::map<MessageID, std::string> dictionary_;
+ Dictionary dictionary_; ///< Holds the ID to text lookups
};
} // namespace log
diff --git a/src/lib/log/message_exception.cc b/src/lib/log/message_exception.cc
index 562c381..1a69ca5 100644
--- a/src/lib/log/message_exception.cc
+++ b/src/lib/log/message_exception.cc
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
/// \brief Body of Virtual Destructor
#include <log/message_exception.h>
diff --git a/src/lib/log/message_exception.h b/src/lib/log/message_exception.h
index 537392d..30c6618 100644
--- a/src/lib/log/message_exception.h
+++ b/src/lib/log/message_exception.h
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __MESSAGE_EXCEPTION_H
#define __MESSAGE_EXCEPTION_H
@@ -76,7 +74,7 @@ public:
///
/// \return Exception Arguments
std::vector<std::string> arguments() const {
- return args_;
+ return (args_);
}
private:
diff --git a/src/lib/log/message_initializer.cc b/src/lib/log/message_initializer.cc
index 914ed17..0113497 100644
--- a/src/lib/log/message_initializer.cc
+++ b/src/lib/log/message_initializer.cc
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <log/message_dictionary.h>
#include <log/message_initializer.h>
@@ -24,8 +22,22 @@ namespace log {
// associated text into it.
MessageInitializer::MessageInitializer(const char* values[]) {
- MessageDictionary* global = MessageDictionary::globalDictionary();
- global->load(values);
+ MessageDictionary& global = MessageDictionary::globalDictionary();
+ std::vector<std::string> repeats = global.load(values);
+
+ // Append the IDs in the list just loaded (the "repeats") to the global list
+ // of duplicate IDs.
+ if (!repeats.empty()) {
+ std::vector<std::string>& duplicates = getDuplicates();
+ duplicates.insert(duplicates.end(), repeats.begin(), repeats.end());
+ }
+}
+
+// Return reference to duplicate array
+
+std::vector<std::string>& MessageInitializer::getDuplicates() {
+ static std::vector<std::string> duplicates;
+ return (duplicates);
}
} // namespace log
diff --git a/src/lib/log/message_initializer.h b/src/lib/log/message_initializer.h
index a776a02..7516823 100644
--- a/src/lib/log/message_initializer.h
+++ b/src/lib/log/message_initializer.h
@@ -12,11 +12,11 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __MESSAGEINITIALIZER_H
#define __MESSAGEINITIALIZER_H
+#include <string>
+#include <vector>
#include <log/message_dictionary.h>
namespace isc {
@@ -52,9 +52,21 @@ public:
/// \brief Constructor
///
- /// The only method in the class, this adds the array of values to the
- /// global dictionary.
+ /// Adds the array of values to the global dictionary, and notes any
+ /// duplicates.
+ ///
+ /// \param values NULL-terminated array of alternating identifier strings
+ /// and associated message text.
MessageInitializer(const char* values[]);
+
+ /// \brief Return Duplicates
+ ///
+ /// When messages are added to the global dictionary, any duplicates are
+ /// recorded. They can later be output through the logging system.
+ ///
+ /// \return List of duplicate message IDs when the global dictionary was
+ /// loaded. Note that the duplicates list itself may contain duplicates.
+ static std::vector<std::string>& getDuplicates();
};
} // namespace log
diff --git a/src/lib/log/message_reader.cc b/src/lib/log/message_reader.cc
index 203b836..7ae7ae0 100644
--- a/src/lib/log/message_reader.cc
+++ b/src/lib/log/message_reader.cc
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <errno.h>
#include <string.h>
@@ -47,7 +45,7 @@ MessageReader::readFile(const string& file, MessageReader::Mode mode) {
// Open the file
ifstream infile(file.c_str());
if (infile.fail()) {
- throw MessageException(MSG_OPENIN, file, strerror(errno));
+ throw MessageException(MSG_OPNMSGIN, file, strerror(errno));
}
// Loop round reading it.
@@ -60,7 +58,7 @@ MessageReader::readFile(const string& file, MessageReader::Mode mode) {
// Why did the loop terminate?
if (!infile.eof()) {
- throw MessageException(MSG_READERR, file, strerror(errno));
+ throw MessageException(MSG_MSGRDERR, file, strerror(errno));
}
infile.close();
}
@@ -93,32 +91,45 @@ MessageReader::processLine(const string& line, MessageReader::Mode mode) {
void
MessageReader::parseDirective(const std::string& text) {
- static string valid = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_";
- // Regardless of what happens, all prefixes will be uppercase (as will
- // all symbols).
- string line = text;
- isc::strutil::uppercase(line);
- vector<string> tokens = isc::strutil::tokens(line);
+ // Break into tokens
+ vector<string> tokens = isc::strutil::tokens(text);
- // Only $PREFIX is recognised so far, so we'll handle it here.
- if (tokens[0] != string("$PREFIX")) {
+ // Uppercase directive and branch on valid ones
+ isc::strutil::uppercase(tokens[0]);
+ if (tokens[0] == string("$PREFIX")) {
+ parsePrefix(tokens);
+ } else if (tokens[0] == string("$NAMESPACE")) {
+ parseNamespace(tokens);
+ } else {
throw MessageException(MSG_UNRECDIR, tokens[0]);
+ }
+}
- } else if (tokens.size() < 2) {
- throw MessageException(MSG_PRFNOARG);
+// Process $PREFIX
+
+void
+MessageReader::parsePrefix(const vector<string>& tokens) {
+
+ // Check argument count
+ static string valid = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_";
+ if (tokens.size() < 2) {
+ throw MessageException(MSG_PRFNOARG);
} else if (tokens.size() > 2) {
throw MessageException(MSG_PRFEXTRARG);
}
+ // As a style, we are going to have the symbols in uppercase
+ string prefix = tokens[1];
+ isc::strutil::uppercase(prefix);
+
// Token is potentially valid providing it only contains alphabetic
// and numeric characters (and underscores) and does not start with a
// digit.
-
- if ((tokens[1].find_first_not_of(valid) != string::npos) ||
- (std::isdigit(tokens[1][0]))) {
+ if ((prefix.find_first_not_of(valid) != string::npos) ||
+ (std::isdigit(prefix[0]))) {
// Invalid character in string or it starts with a digit.
throw MessageException(MSG_PRFINVARG, tokens[1]);
@@ -132,7 +143,45 @@ MessageReader::parseDirective(const std::string& text) {
// Prefix has not been set, so set it and return success.
- prefix_ = tokens[1];
+ prefix_ = prefix;
+}
+
+// Process $NAMESPACE. A lot of the processing is similar to that of $PREFIX,
+// except that only limited checks will be done on the namespace (to avoid a
+// lot of parsing and separating out of the namespace components.)
+
+void
+MessageReader::parseNamespace(const vector<string>& tokens) {
+
+ // Check argument count
+
+ static string valid = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_:"
+ "abcdefghijklmnopqrstuvwxyz";
+
+ if (tokens.size() < 2) {
+ throw MessageException(MSG_NSNOARG);
+
+ } else if (tokens.size() > 2) {
+ throw MessageException(MSG_NSEXTRARG);
+
+ }
+
+ // Token is potentially valid providing it only contains alphabetic
+ // and numeric characters (and underscores and colons).
+ if (tokens[1].find_first_not_of(valid) != string::npos) {
+
+ // Invalid character in string or it starts with a digit.
+ throw MessageException(MSG_NSINVARG, tokens[1]);
+ }
+
+ // All OK - unless the namespace has already been set.
+ if (ns_.size() != 0) {
+ throw MessageException(MSG_DUPLNS);
+ }
+
+ // Prefix has not been set, so set it and return success.
+
+ ns_ = tokens[1];
}
// Process message. By the time this method is called, the line has been
@@ -150,11 +199,11 @@ MessageReader::parseMessage(const std::string& text, MessageReader::Mode mode) {
if (first_delim == string::npos) {
// Just a single token in the line - this is not valid
- throw MessageException(MSG_ONETOKEN, text);
+ throw MessageException(MSG_NOMSGTXT, text);
}
// Extract the first token into the message ID
- MessageID ident = text.substr(0, first_delim);
+ string ident = text.substr(0, first_delim);
// Locate the start of the message text
size_t first_text = text.find_first_not_of(delimiters, first_delim);
@@ -163,7 +212,7 @@ MessageReader::parseMessage(const std::string& text, MessageReader::Mode mode) {
// ?? This happens if there are trailing delimiters, which should not
// occur as we have stripped trailing spaces off the line. Just treat
// this as a single-token error for simplicity's sake.
- throw MessageException(MSG_ONETOKEN, text);
+ throw MessageException(MSG_NOMSGTXT, text);
}
// Add the result to the dictionary and to the non-added list if the add to
diff --git a/src/lib/log/message_reader.h b/src/lib/log/message_reader.h
index 84ffce9..d07c7f2 100644
--- a/src/lib/log/message_reader.h
+++ b/src/lib/log/message_reader.h
@@ -12,12 +12,9 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __MESSAGE_READER_H
#define __MESSAGE_READER_H
-#include <iostream>
#include <map>
#include <string>
#include <vector>
@@ -50,7 +47,7 @@ public:
} Mode;
/// \brief Visible collection types
- typedef std::vector<MessageID> MessageIDCollection;
+ typedef std::vector<std::string> MessageIDCollection;
/// \brief Constructor
///
@@ -79,7 +76,7 @@ public:
///
/// \return Pointer to current dictionary object
MessageDictionary* getDictionary() const {
- return dictionary_;
+ return (dictionary_);
}
@@ -116,11 +113,27 @@ public:
virtual void processLine(const std::string& line, Mode mode = ADD);
+ /// \brief Get Namespace
+ ///
+ /// \return Argument to the $NAMESPACE directive (if present)
+ virtual std::string getNamespace() const {
+ return (ns_);
+ }
+
+
+ /// \brief Clear Namespace
+ ///
+ /// Clears the current namespace.
+ virtual void clearNamespace() {
+ ns_ = "";
+ }
+
+
/// \brief Get Prefix
///
/// \return Argument to the $PREFIX directive (if present)
virtual std::string getPrefix() const {
- return prefix_;
+ return (prefix_);
}
@@ -139,7 +152,7 @@ public:
///
/// \return Collection of messages not added
MessageIDCollection getNotAdded() const {
- return not_added_;
+ return (not_added_);
}
private:
@@ -163,10 +176,24 @@ private:
/// \param line Line of text that starts with "$",
void parseDirective(const std::string& line);
+
+ /// \brief Parse $PREFIX line
+ ///
+ /// \param tokens $PREFIX line split into tokens
+ void parsePrefix(const std::vector<std::string>& tokens);
+
+
+ /// \brief Parse $NAMESPACE line
+ ///
+ /// \param tokens $NAMESPACE line split into tokens
+ void parseNamespace(const std::vector<std::string>& tokens);
+
+
/// Attributes
MessageDictionary* dictionary_; ///< Dictionary to add messages to
MessageIDCollection not_added_; ///< List of IDs not added
- std::string prefix_; ///< Input of $PREFIX statement
+ std::string prefix_; ///< Argument of $PREFIX statement
+ std::string ns_; ///< Argument of $NAMESPACE statement
};
} // namespace log
diff --git a/src/lib/log/message_types.h b/src/lib/log/message_types.h
index b101401..9f625a9 100644
--- a/src/lib/log/message_types.h
+++ b/src/lib/log/message_types.h
@@ -12,17 +12,22 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __MESSAGE_TYPES_H
#define __MESSAGE_TYPES_H
-#include <string>
+#include <string.h>
namespace isc {
namespace log {
-typedef std::string MessageID;
+typedef const char* MessageID;
+
+/// \brief Compare MessageID for Equality
+///
+/// \param m1 First message ID
+/// \param m2 Second message ID
+/// \return true if they are equal, false if not
+bool equalMessageID(const MessageID& m1, const MessageID& m2);
} // namespace log
} // namespace isc
diff --git a/src/lib/log/messagedef.cc b/src/lib/log/messagedef.cc
index 7dfa4f6..f680a74 100644
--- a/src/lib/log/messagedef.cc
+++ b/src/lib/log/messagedef.cc
@@ -1,27 +1,57 @@
-// File created from messagedef.mes on Mon Jan 17 15:25:32 2011
+// File created from messagedef.mes on Mon Feb 14 11:07:45 2011
#include <cstddef>
+#include <log/message_types.h>
#include <log/message_initializer.h>
-using namespace isc::log;
+namespace isc {
+namespace log {
+
+extern const isc::log::MessageID MSG_DUPLNS = "DUPLNS";
+extern const isc::log::MessageID MSG_DUPLPRFX = "DUPLPRFX";
+extern const isc::log::MessageID MSG_DUPMSGID = "DUPMSGID";
+extern const isc::log::MessageID MSG_IDNOTFND = "IDNOTFND";
+extern const isc::log::MessageID MSG_MSGRDERR = "MSGRDERR";
+extern const isc::log::MessageID MSG_MSGWRTERR = "MSGWRTERR";
+extern const isc::log::MessageID MSG_NOMSGTXT = "NOMSGTXT";
+extern const isc::log::MessageID MSG_NSEXTRARG = "NSEXTRARG";
+extern const isc::log::MessageID MSG_NSINVARG = "NSINVARG";
+extern const isc::log::MessageID MSG_NSNOARG = "NSNOARG";
+extern const isc::log::MessageID MSG_OPNMSGIN = "OPNMSGIN";
+extern const isc::log::MessageID MSG_OPNMSGOUT = "OPNMSGOUT";
+extern const isc::log::MessageID MSG_PRFEXTRARG = "PRFEXTRARG";
+extern const isc::log::MessageID MSG_PRFINVARG = "PRFINVARG";
+extern const isc::log::MessageID MSG_PRFNOARG = "PRFNOARG";
+extern const isc::log::MessageID MSG_RDLOCMES = "RDLOCMES";
+extern const isc::log::MessageID MSG_UNRECDIR = "UNRECDIR";
+
+} // namespace log
+} // namespace isc
namespace {
const char* values[] = {
+ "DUPLNS", "duplicate $NAMESPACE directive found",
"DUPLPRFX", "duplicate $PREFIX directive found",
+ "DUPMSGID", "duplicate message ID (%s) in compiled code",
"IDNOTFND", "could not replace message for '%s': no such message identification",
- "ONETOKEN", "a line containing a message ID ('%s') and nothing else was found",
- "OPENIN", "unable to open message file %s for input: %s",
- "OPENOUT", "unable to open %s for output: %s",
+ "MSGRDERR", "error reading from message file %s: %s",
+ "MSGWRTERR", "error writing to %s: %s",
+ "NOMSGTXT", "a line containing a message ID ('%s') and nothing else was found",
+ "NSEXTRARG", "$NAMESPACE directive has too many arguments",
+ "NSINVARG", "$NAMESPACE directive has an invalid argument ('%s')",
+ "NSNOARG", "no arguments were given to the $NAMESPACE directive",
+ "OPNMSGIN", "unable to open message file %s for input: %s",
+ "OPNMSGOUT", "unable to open %s for output: %s",
"PRFEXTRARG", "$PREFIX directive has too many arguments",
"PRFINVARG", "$PREFIX directive has an invalid argument ('%s')",
"PRFNOARG", "no arguments were given to the $PREFIX directive",
- "READERR", "error reading from %s: %s",
+ "RDLOCMES", "reading local message file %s",
"UNRECDIR", "unrecognised directive '%s'",
- "WRITERR", "error writing to %s: %s",
NULL
};
+const isc::log::MessageInitializer initializer(values);
+
} // Anonymous namespace
-MessageInitializer messagedef_cc_Mon_Jan_17_15_25_32_2011(values);
diff --git a/src/lib/log/messagedef.h b/src/lib/log/messagedef.h
index ae0a99d..eb8f4ea 100644
--- a/src/lib/log/messagedef.h
+++ b/src/lib/log/messagedef.h
@@ -1,24 +1,32 @@
-// File created from messagedef.mes on Mon Jan 17 15:25:32 2011
+// File created from messagedef.mes on Mon Feb 14 11:07:45 2011
#ifndef __MESSAGEDEF_H
#define __MESSAGEDEF_H
#include <log/message_types.h>
-namespace {
+namespace isc {
+namespace log {
-isc::log::MessageID MSG_DUPLPRFX = "DUPLPRFX";
-isc::log::MessageID MSG_IDNOTFND = "IDNOTFND";
-isc::log::MessageID MSG_ONETOKEN = "ONETOKEN";
-isc::log::MessageID MSG_OPENIN = "OPENIN";
-isc::log::MessageID MSG_OPENOUT = "OPENOUT";
-isc::log::MessageID MSG_PRFEXTRARG = "PRFEXTRARG";
-isc::log::MessageID MSG_PRFINVARG = "PRFINVARG";
-isc::log::MessageID MSG_PRFNOARG = "PRFNOARG";
-isc::log::MessageID MSG_READERR = "READERR";
-isc::log::MessageID MSG_UNRECDIR = "UNRECDIR";
-isc::log::MessageID MSG_WRITERR = "WRITERR";
+extern const isc::log::MessageID MSG_DUPLNS;
+extern const isc::log::MessageID MSG_DUPLPRFX;
+extern const isc::log::MessageID MSG_DUPMSGID;
+extern const isc::log::MessageID MSG_IDNOTFND;
+extern const isc::log::MessageID MSG_MSGRDERR;
+extern const isc::log::MessageID MSG_MSGWRTERR;
+extern const isc::log::MessageID MSG_NOMSGTXT;
+extern const isc::log::MessageID MSG_NSEXTRARG;
+extern const isc::log::MessageID MSG_NSINVARG;
+extern const isc::log::MessageID MSG_NSNOARG;
+extern const isc::log::MessageID MSG_OPNMSGIN;
+extern const isc::log::MessageID MSG_OPNMSGOUT;
+extern const isc::log::MessageID MSG_PRFEXTRARG;
+extern const isc::log::MessageID MSG_PRFINVARG;
+extern const isc::log::MessageID MSG_PRFNOARG;
+extern const isc::log::MessageID MSG_RDLOCMES;
+extern const isc::log::MessageID MSG_UNRECDIR;
-} // Anonymous namespace
+} // namespace log
+} // namespace isc
#endif // __MESSAGEDEF_H
diff --git a/src/lib/log/messagedef.mes b/src/lib/log/messagedef.mes
index 1535fc6..55b3e7c 100644
--- a/src/lib/log/messagedef.mes
+++ b/src/lib/log/messagedef.mes
@@ -12,9 +12,8 @@
# OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
# PERFORMANCE OF THIS SOFTWARE.
-# $Id$
-
$PREFIX MSG_
+$NAMESPACE isc::log
# \brief Message Utility Message File
#
@@ -24,6 +23,22 @@ $PREFIX MSG_
# chicken-and-egg situation where we need the files to build the message
# compiler, yet we need the compiler to build the files.
+DUPMSGID duplicate message ID (%s) in compiled code
++ Indicative of a programming error, when it started up, BIND10 detected that
++ the given message ID had been registered by one or more modules. (All message
++ IDs should be unique throughout BIND10.) This has no impact on the operation
++ of the server other that erroneous messages may be logged. (When BIND10 loads
++ the message IDs (and their associated text), if a duplicate ID is found it is
++ discarded. However, when the module that supplied the duplicate ID logs that
++ particular message, the text supplied by the module that added the original
++ ID will be output - something that may bear no relation to the condition being
++ logged.
+
+DUPLNS duplicate $NAMESPACE directive found
++ When reading a message file, more than one $NAMESPACE directive was found. In
++ this version of the code, such a condition is regarded as an error and the
++ read will be abandonded.
+
DUPLPRFX duplicate $PREFIX directive found
+ When reading a message file, more than one $PREFIX directive was found. In
+ this version of the code, such a condition is regarded as an error and the
@@ -40,17 +55,40 @@ IDNOTFND could not replace message for '%s': no such message identification
+ This message may appear a number of times in the file, once for every such
+ unknown mnessage identification.
-ONETOKEN a line containing a message ID ('%s') and nothing else was found
+MSGRDERR error reading from message file %s: %s
++ The specified error was encountered reading from the named message file.
+
+MSGWRTERR error writing to %s: %s
++ The specified error was encountered by the message compiler when writing to
++ the named output file.
+
+NSEXTRARG $NAMESPACE directive has too many arguments
++ The $NAMESPACE directive takes a single argument, a namespace in which all the
++ generated symbol names are placed. This error is generated when the
++ compiler finds a $NAMESPACE directive with more than one argument.
+
+NSINVARG $NAMESPACE directive has an invalid argument ('%s')
++ The $NAMESPACE argument should be a valid C++ namespace. The reader does a
++ cursory check on its validity, checking that the characters in the namspace
++ are correct. The error is generated when the reader finds an invalid
++ character. (Valid are alphanumeric characters, underscroes and colons.)
+
+NOMSGTXT a line containing a message ID ('%s') and nothing else was found
+ Message definitions comprise lines starting with a message identification (a
+ symbolic name for the message) and followed by the text of the message. This
+ error is generated when a line is found in the message file that contains just
-+ the message identification.
++ the message identification and no text.
-OPENIN unable to open message file %s for input: %s
+NSNOARG no arguments were given to the $NAMESPACE directive
++ The $NAMESPACE directive takes a single argument, a namespace in which all the
++ generated symbol names are placed. This error is generated when the
++ compiler finds a $NAMESPACE directive with no arguments.
+
+OPNMSGIN unable to open message file %s for input: %s
+ The program was not able to open the specified input message file for the
+ reason given.
-OPENOUT unable to open %s for output: %s
+OPNMSGOUT unable to open %s for output: %s
+ The program was not able to open the specified output file for the reason
+ given.
@@ -69,14 +107,13 @@ PRFINVARG $PREFIX directive has an invalid argument ('%s')
PRFNOARG no arguments were given to the $PREFIX directive
+ The $PREFIX directive takes a single argument, a prefix to be added to the
+ symbol names when a C++ .h file is created. This error is generated when the
-+ compiler finds a $PREFIX directive with noa rguments.
++ compiler finds a $PREFIX directive with no arguments.
-READERR error reading from %s: %s
-+ The specified error was encountered reading from the named input file.
+RDLOCMES reading local message file %s
++ This is an informational message output by BIND10 when it starts to read a
++ local message file. (A local message file may replace the text of one of more
++ messages; the ID of the message will not be changed though.)
UNRECDIR unrecognised directive '%s'
+ A line starting with a dollar symbol was found, but the first word on the line
+ (shown in the message) was not a recognised message compiler directive.
-
-WRITERR error writing to %s: %s
-+ The specified error was encountered writing to the named output file.
diff --git a/src/lib/log/root_logger_name.cc b/src/lib/log/root_logger_name.cc
index 9378857..58d9407 100644
--- a/src/lib/log/root_logger_name.cc
+++ b/src/lib/log/root_logger_name.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,15 +12,33 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <string>
#include <root_logger_name.h>
namespace isc {
namespace log {
-std::string RootLoggerName::name_("");
+namespace {
+
+// Obtain the root logger name in a way that is safe for statically-initialized
+// objects.
+std::string&
+getRootLoggerNameInternal() {
+ static std::string root_name;
+ return (root_name);
}
+
+} // Anonymous namespace
+
+void
+setRootLoggerName(const std::string& name) {
+ getRootLoggerNameInternal() = name;
}
+
+const std::string& getRootLoggerName() {
+ return (getRootLoggerNameInternal());
+}
+
+} // namespace log
+} // namespace isc
diff --git a/src/lib/log/root_logger_name.h b/src/lib/log/root_logger_name.h
index 80691d1..9d50332 100644
--- a/src/lib/log/root_logger_name.h
+++ b/src/lib/log/root_logger_name.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __ROOT_LOGGER_NAME_H
#define __ROOT_LOGGER_NAME_H
@@ -21,44 +19,26 @@
/// \brief Define Name of Root Logger
///
-/// In the log4cxx system, the root logger is ".". The definition for the
-/// BIND-10 system is that the root logger of a program has the name of the
-/// program. This (trivial) class stores the name of the program in a
-/// location accessible to the logger classes.
+/// In BIND-10, the name root logger of a program is the name of the program
+/// itself (in contrast to packages such as log4cxx where the root logger name
+// is something like "."). These trivial functions allow the setting and
+// getting of that name by the logger classes.
namespace isc {
namespace log {
-class RootLoggerName {
-public:
-
- /// \brief Constructor
- ///
- /// Sets the root logger name. Although the name is static, setting the
- /// name in the constructor allows static initialization of the name by
- /// declaring an external instance of the class in the main execution unit.
- RootLoggerName(const std::string& name) {
- setName(name);
- }
-
- /// \brief Set Root Logger Name
- ///
- /// \param name Name of the root logger. This should be the program
- /// name.
- static void setName(const std::string& name) {
- name_ = name;
- }
+/// \brief Set Root Logger Name
+///
+/// This function should be called by the program's initialization code before
+/// any logging functions are called.
+///
+/// \param name Name of the root logger. This should be the program name.
+void setRootLoggerName(const std::string& name);
- /// \brief Get Root Logger Name
- ///
- /// \return Name of the root logger.
- static std::string getName() {
- return name_;
- }
-
-private:
- static std::string name_; ///< Name of the root logger
-};
+/// \brief Get Root Logger Name
+///
+/// \return Name of the root logger.
+const std::string& getRootLoggerName();
}
}
diff --git a/src/lib/log/strutil.cc b/src/lib/log/strutil.cc
index 4b96601..65fb0cd 100644
--- a/src/lib/log/strutil.cc
+++ b/src/lib/log/strutil.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,10 +12,7 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <numeric>
-#include <iostream>
#include <string.h>
#include <strutil.h>
@@ -58,14 +55,14 @@ trim(const string& instring) {
}
}
- return retstring;
+ return (retstring);
}
// Tokenise string. As noted in the header, this is locally written to avoid
// another dependency on a Boost library.
vector<string>
-tokens(const std::string text, const std::string& delim) {
+tokens(const std::string& text, const std::string& delim) {
vector<string> result;
// Search for the first non-delimiter character
@@ -89,7 +86,7 @@ tokens(const std::string text, const std::string& delim) {
}
}
- return result;
+ return (result);
}
// Local function to pass to accumulate() for summing up string lengths.
@@ -131,7 +128,7 @@ format(const std::string& format, const std::vector<std::string>& args) {
}
}
- return result;
+ return (result);
}
} // namespace log
diff --git a/src/lib/log/strutil.h b/src/lib/log/strutil.h
index cb0b793..f44b0d0 100644
--- a/src/lib/log/strutil.h
+++ b/src/lib/log/strutil.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __STRUTIL_H
#define __STRUTIL_H
@@ -73,7 +71,7 @@ std::string trim(const std::string& instring);
/// \param delim Delimiter characters
///
/// \return Vector of tokens.
-std::vector<std::string> tokens(const std::string text,
+std::vector<std::string> tokens(const std::string& text,
const std::string& delim = std::string(" \t\n"));
@@ -88,7 +86,7 @@ std::vector<std::string> tokens(const std::string text,
///
/// \return Uppercase version of the argument
inline char toUpper(char chr) {
- return static_cast<char>(std::toupper(static_cast<int>(chr)));
+ return (static_cast<char>(std::toupper(static_cast<int>(chr))));
}
@@ -113,7 +111,7 @@ inline void uppercase(std::string& text) {
///
/// \return Lowercase version of the argument
inline char toLower(char chr) {
- return static_cast<char>(std::tolower(static_cast<int>(chr)));
+ return (static_cast<char>(std::tolower(static_cast<int>(chr))));
}
/// \brief Lowercase String
diff --git a/src/lib/log/tests/Makefile.am b/src/lib/log/tests/Makefile.am
index e3a023a..1845706 100644
--- a/src/lib/log/tests/Makefile.am
+++ b/src/lib/log/tests/Makefile.am
@@ -11,8 +11,6 @@ endif
CLEANFILES = *.gcno *.gcda
-EXTRA_DIST = localdef.mes
-
TESTS =
if HAVE_GTEST
TESTS += run_unittests
@@ -24,13 +22,13 @@ run_unittests_SOURCES += message_reader_unittest.cc
run_unittests_SOURCES += message_initializer_unittest.cc
run_unittests_SOURCES += message_initializer_unittest_2.cc
run_unittests_SOURCES += strutil_unittest.cc
-run_unittests_SOURCES += xdebuglevel_unittest.cc
run_unittests_SOURCES += run_unittests.cc
+
run_unittests_CPPFLAGS = $(AM_CPPFLAGS) $(GTEST_INCLUDES)
run_unittests_LDFLAGS = $(AM_LDFLAGS) $(GTEST_LDFLAGS)
+
run_unittests_LDADD = $(GTEST_LDADD)
run_unittests_LDADD += $(top_builddir)/src/lib/log/liblog.la
-run_unittests_LDADD += -llog4cxx
endif
TESTS += logger_support_test
diff --git a/src/lib/log/tests/filename_unittest.cc b/src/lib/log/tests/filename_unittest.cc
index c33be9f..f3032eb 100644
--- a/src/lib/log/tests/filename_unittest.cc
+++ b/src/lib/log/tests/filename_unittest.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id: base64_unittest.cc 2549 2010-07-20 19:09:37Z jinmei $
-
#include <string>
#include <gtest/gtest.h>
diff --git a/src/lib/log/tests/localdef.mes b/src/lib/log/tests/localdef.mes
deleted file mode 100644
index 98e197d..0000000
--- a/src/lib/log/tests/localdef.mes
+++ /dev/null
@@ -1,23 +0,0 @@
-# Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
-#
-# Permission to use, copy, modify, and/or distribute this software for any
-# purpose with or without fee is hereby granted, provided that the above
-# copyright notice and this permission notice appear in all copies.
-#
-# THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
-# REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-# AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
-# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
-# OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-# PERFORMANCE OF THIS SOFTWARE.
-
-# \brief Local Definitions
-#
-# Holds local definitions of some of the messages produced by the program
-# logger_support_test, and is used as input to check that run-time message
-# replacement works.
-
-NOTHERE this message is not in the global dictionary
-READERR replacement read error, parameters: '%s' and '%s'
-UNRECDIR replacement unrecognised directive message, parameter is '%s'
diff --git a/src/lib/log/tests/logger_impl_log4cxx_unittest.cc b/src/lib/log/tests/logger_impl_log4cxx_unittest.cc
new file mode 100644
index 0000000..cab2678
--- /dev/null
+++ b/src/lib/log/tests/logger_impl_log4cxx_unittest.cc
@@ -0,0 +1,91 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#include <iostream>
+#include <string>
+
+#include <gtest/gtest.h>
+
+#include <log/root_logger_name.h>
+#include <log/logger.h>
+#include <log/logger_impl.h>
+#include <log/messagedef.h>
+
+using namespace isc;
+using namespace isc::log;
+using namespace std;
+
+/// \brief Log4cxx Implementation Tests
+///
+/// Some tests of methods that are not directly tested by the logger unit tests
+/// (when the logger is configured to use log4cxx)
+
+namespace isc {
+namespace log {
+
+/// \brief Test Logger
+///
+/// This logger is a subclass of the logger implementation class under test, but
+/// makes protected methods public (for testing)
+
+class TestLoggerImpl : public LoggerImpl {
+public:
+ /// \brief constructor
+ TestLoggerImpl(const string& name) : LoggerImpl(name, true)
+ {}
+
+
+ /// \brief Conversion Between log4cxx Number and BIND-10 Severity
+ Severity convertLevel(int value) {
+ return (LoggerImpl::convertLevel(value));
+ }
+};
+
+} // namespace log
+} // namespace isc
+
+
+class LoggerImplTest : public ::testing::Test {
+protected:
+ LoggerImplTest()
+ {
+ }
+};
+
+// Test the number to severity conversion function
+
+TEST_F(LoggerImplTest, ConvertLevel) {
+
+ // Create a logger
+ RootLoggerName::setName("test3");
+ TestLoggerImpl logger("alpha");
+
+ // Basic 1:1
+ EXPECT_EQ(isc::log::DEBUG, logger.convertLevel(log4cxx::Level::DEBUG_INT));
+ EXPECT_EQ(isc::log::INFO, logger.convertLevel(log4cxx::Level::INFO_INT));
+ EXPECT_EQ(isc::log::WARN, logger.convertLevel(log4cxx::Level::WARN_INT));
+ EXPECT_EQ(isc::log::WARN, logger.convertLevel(log4cxx::Level::WARN_INT));
+ EXPECT_EQ(isc::log::ERROR, logger.convertLevel(log4cxx::Level::ERROR_INT));
+ EXPECT_EQ(isc::log::FATAL, logger.convertLevel(log4cxx::Level::FATAL_INT));
+ EXPECT_EQ(isc::log::FATAL, logger.convertLevel(log4cxx::Level::FATAL_INT));
+ EXPECT_EQ(isc::log::NONE, logger.convertLevel(log4cxx::Level::OFF_INT));
+
+ // Now some debug levels
+ EXPECT_EQ(isc::log::DEBUG,
+ logger.convertLevel(log4cxx::Level::DEBUG_INT - 1));
+ EXPECT_EQ(isc::log::DEBUG,
+ logger.convertLevel(log4cxx::Level::DEBUG_INT - MAX_DEBUG_LEVEL));
+ EXPECT_EQ(isc::log::DEBUG,
+ logger.convertLevel(log4cxx::Level::DEBUG_INT - 2 * MAX_DEBUG_LEVEL));
+}
diff --git a/src/lib/log/tests/logger_support_test.cc b/src/lib/log/tests/logger_support_test.cc
index acca4f6..4d8863e 100644
--- a/src/lib/log/tests/logger_support_test.cc
+++ b/src/lib/log/tests/logger_support_test.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,12 +12,11 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id: $
-
/// \brief Example Program
///
/// Simple example program showing how to use the logger.
+#include <stdlib.h>
#include <unistd.h>
#include <string.h>
@@ -32,12 +31,8 @@
using namespace isc::log;
-// Declare root logger and a logger to use an example.
-//RootLoggerName root_name("testing");
-
-RootLoggerName root("alpha");
+// Declare logger to use an example.
Logger logger_ex("example");
-Logger logger_dlm("dlm");
// The program is invoked:
//
@@ -47,31 +42,31 @@ Logger logger_dlm("dlm");
// "level" is the debug level, a number between 0 and 99
// "local_file" is the name of a local file.
//
-// The program sets the attributes on the root logger. Looking
-// at the output determines whether the program worked.e root logger. Looking
-// at the output determines whether the
+// The program sets the attributes on the root logger and logs a set of
+// messages. Looking at the output determines whether the program worked.
int main(int argc, char** argv) {
- Logger::Severity severity = Logger::INFO;
- int dbglevel = -1;
- const char* localfile = NULL;
- int option;
+ isc::log::Severity severity = isc::log::INFO; // Default logger severity
+ int dbglevel = -1; // Logger debug level
+ const char* localfile = NULL; // Local message file
+ int option; // For getopt() processing
+ Logger logger_dlm("dlm", true); // Another example logger
// Parse options
while ((option = getopt(argc, argv, "s:d:")) != -1) {
switch (option) {
case 's':
if (strcmp(optarg, "debug") == 0) {
- severity = Logger::DEBUG;
+ severity = isc::log::DEBUG;
} else if (strcmp(optarg, "info") == 0) {
- severity = Logger::INFO;
+ severity = isc::log::INFO;
} else if (strcmp(optarg, "warn") == 0) {
- severity = Logger::WARN;
+ severity = isc::log::WARN;
} else if (strcmp(optarg, "error") == 0) {
- severity = Logger::ERROR;
+ severity = isc::log::ERROR;
} else if (strcmp(optarg, "fatal") == 0) {
- severity = Logger::FATAL;
+ severity = isc::log::FATAL;
} else {
std::cout << "Unrecognised severity option: " <<
optarg << "\n";
@@ -94,16 +89,16 @@ int main(int argc, char** argv) {
}
// Update the logging parameters
- runTimeInit(severity, dbglevel, localfile);
+ initLogger("alpha", severity, dbglevel, localfile);
// Log a few messages
- logger_ex.fatal(MSG_WRITERR, "test1", "42");
+ logger_ex.fatal(MSG_MSGWRTERR, "test1", "42");
logger_ex.error(MSG_UNRECDIR, "false");
- logger_dlm.warn(MSG_READERR, "a.txt", "dummy test");
- logger_dlm.info(MSG_OPENIN, "example.msg", "dummy test");
+ logger_dlm.warn(MSG_MSGRDERR, "a.txt", "dummy test");
+ logger_dlm.info(MSG_OPNMSGIN, "example.msg", "dummy test");
logger_ex.debug(0, MSG_UNRECDIR, "[abc]");
logger_ex.debug(24, MSG_UNRECDIR, "[24]");
logger_ex.debug(25, MSG_UNRECDIR, "[25]");
logger_ex.debug(26, MSG_UNRECDIR, "[26]");
- return 0;
+ return (0);
}
diff --git a/src/lib/log/tests/logger_unittest.cc b/src/lib/log/tests/logger_unittest.cc
index e15ec42..4eff622 100644
--- a/src/lib/log/tests/logger_unittest.cc
+++ b/src/lib/log/tests/logger_unittest.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id: $
-
#include <iostream>
#include <string>
@@ -41,19 +39,8 @@ public:
TestLogger(const string& name) : Logger(name, true)
{}
- /// \brief Logger Equality
- bool operator==(const TestLogger& other) {
- return Logger::operator==(other);
- }
-
- /// \brief Logger is Null
- bool isInitialized() const {
- return Logger::isInitialized();
- }
-
- /// \brief Conversion Between log4cxx Number and BIND-10 Severity
- Severity convertLevel(int value) {
- return Logger::convertLevel(value);
+ static void reset() {
+ Logger::reset();
}
};
@@ -66,6 +53,10 @@ protected:
LoggerTest()
{
}
+
+ ~LoggerTest() {
+ TestLogger::reset();
+ }
};
@@ -74,7 +65,7 @@ protected:
TEST_F(LoggerTest, Name) {
// Create a logger
- RootLoggerName::setName("test1");
+ setRootLoggerName("test1");
Logger logger("alpha");
// ... and check the name
@@ -88,7 +79,7 @@ TEST_F(LoggerTest, GetLogger) {
// Set the root logger name (not strictly needed, but this will be the
// case in the program(.
- RootLoggerName::setName("test2");
+ setRootLoggerName("test2");
const string name1 = "alpha";
const string name2 = "beta";
@@ -96,85 +87,44 @@ TEST_F(LoggerTest, GetLogger) {
// Instantiate two loggers that should be the same
TestLogger logger1(name1);
TestLogger logger2(name1);
-
- // And check they are null at this point.
- EXPECT_FALSE(logger1.isInitialized());
- EXPECT_FALSE(logger2.isInitialized());
-
- // Do some random operation
- EXPECT_TRUE(logger1.isFatalEnabled());
- EXPECT_TRUE(logger2.isFatalEnabled());
-
- // And check they initialized and equal
- EXPECT_TRUE(logger1.isInitialized());
- EXPECT_TRUE(logger2.isInitialized());
+ // And check they equal
EXPECT_TRUE(logger1 == logger2);
// Instantiate another logger with another name and check that it
// is different to the previously instantiated ones.
TestLogger logger3(name2);
- EXPECT_FALSE(logger3.isInitialized());
- EXPECT_TRUE(logger3.isFatalEnabled());
- EXPECT_TRUE(logger3.isInitialized());
EXPECT_FALSE(logger1 == logger3);
}
-// Test the number to severity conversion function
-
-TEST_F(LoggerTest, ConvertLevel) {
-
- // Create a logger
- RootLoggerName::setName("test3");
- TestLogger logger("alpha");
-
- // Basic 1:1
- EXPECT_EQ(Logger::DEBUG, logger.convertLevel(log4cxx::Level::DEBUG_INT));
- EXPECT_EQ(Logger::INFO, logger.convertLevel(log4cxx::Level::INFO_INT));
- EXPECT_EQ(Logger::WARN, logger.convertLevel(log4cxx::Level::WARN_INT));
- EXPECT_EQ(Logger::WARN, logger.convertLevel(log4cxx::Level::WARN_INT));
- EXPECT_EQ(Logger::ERROR, logger.convertLevel(log4cxx::Level::ERROR_INT));
- EXPECT_EQ(Logger::FATAL, logger.convertLevel(log4cxx::Level::FATAL_INT));
- EXPECT_EQ(Logger::FATAL, logger.convertLevel(log4cxx::Level::FATAL_INT));
- EXPECT_EQ(Logger::NONE, logger.convertLevel(log4cxx::Level::OFF_INT));
-
- // Now some debug levels
- EXPECT_EQ(Logger::DEBUG,
- logger.convertLevel(log4cxx::Level::DEBUG_INT - 1));
- EXPECT_EQ(Logger::DEBUG,
- logger.convertLevel(log4cxx::Level::DEBUG_INT - MAX_DEBUG_LEVEL));
- EXPECT_EQ(Logger::DEBUG,
- logger.convertLevel(log4cxx::Level::DEBUG_INT - 2 * MAX_DEBUG_LEVEL));
-}
-
// Check that the logger levels are get set properly.
TEST_F(LoggerTest, Severity) {
// Create a logger
- RootLoggerName::setName("test3");
+ setRootLoggerName("test3");
TestLogger logger("alpha");
// Now check the levels
- logger.setSeverity(Logger::NONE);
- EXPECT_EQ(Logger::NONE, logger.getSeverity());
+ logger.setSeverity(isc::log::NONE);
+ EXPECT_EQ(isc::log::NONE, logger.getSeverity());
- logger.setSeverity(Logger::FATAL);
- EXPECT_EQ(Logger::FATAL, logger.getSeverity());
+ logger.setSeverity(isc::log::FATAL);
+ EXPECT_EQ(isc::log::FATAL, logger.getSeverity());
- logger.setSeverity(Logger::ERROR);
- EXPECT_EQ(Logger::ERROR, logger.getSeverity());
+ logger.setSeverity(isc::log::ERROR);
+ EXPECT_EQ(isc::log::ERROR, logger.getSeverity());
- logger.setSeverity(Logger::WARN);
- EXPECT_EQ(Logger::WARN, logger.getSeverity());
+ logger.setSeverity(isc::log::WARN);
+ EXPECT_EQ(isc::log::WARN, logger.getSeverity());
- logger.setSeverity(Logger::INFO);
- EXPECT_EQ(Logger::INFO, logger.getSeverity());
+ logger.setSeverity(isc::log::INFO);
+ EXPECT_EQ(isc::log::INFO, logger.getSeverity());
- logger.setSeverity(Logger::DEBUG);
- EXPECT_EQ(Logger::DEBUG, logger.getSeverity());
+ logger.setSeverity(isc::log::DEBUG);
+ EXPECT_EQ(isc::log::DEBUG, logger.getSeverity());
- logger.setSeverity(Logger::DEFAULT);
- EXPECT_EQ(Logger::DEFAULT, logger.getSeverity());
+ logger.setSeverity(isc::log::DEFAULT);
+ EXPECT_EQ(isc::log::DEFAULT, logger.getSeverity());
}
// Check that the debug level is set correctly.
@@ -182,40 +132,40 @@ TEST_F(LoggerTest, Severity) {
TEST_F(LoggerTest, DebugLevels) {
// Create a logger
- RootLoggerName::setName("test4");
+ setRootLoggerName("test4");
TestLogger logger("alpha");
// Debug level should be 0 if not at debug severity
- logger.setSeverity(Logger::NONE, 20);
+ logger.setSeverity(isc::log::NONE, 20);
EXPECT_EQ(0, logger.getDebugLevel());
- logger.setSeverity(Logger::INFO, 42);
+ logger.setSeverity(isc::log::INFO, 42);
EXPECT_EQ(0, logger.getDebugLevel());
// Should be the value set if the severity is set to DEBUG though.
- logger.setSeverity(Logger::DEBUG, 32);
+ logger.setSeverity(isc::log::DEBUG, 32);
EXPECT_EQ(32, logger.getDebugLevel());
- logger.setSeverity(Logger::DEBUG, 97);
+ logger.setSeverity(isc::log::DEBUG, 97);
EXPECT_EQ(97, logger.getDebugLevel());
// Try the limits
- logger.setSeverity(Logger::DEBUG, -1);
+ logger.setSeverity(isc::log::DEBUG, -1);
EXPECT_EQ(0, logger.getDebugLevel());
- logger.setSeverity(Logger::DEBUG, 0);
+ logger.setSeverity(isc::log::DEBUG, 0);
EXPECT_EQ(0, logger.getDebugLevel());
- logger.setSeverity(Logger::DEBUG, 1);
+ logger.setSeverity(isc::log::DEBUG, 1);
EXPECT_EQ(1, logger.getDebugLevel());
- logger.setSeverity(Logger::DEBUG, 98);
+ logger.setSeverity(isc::log::DEBUG, 98);
EXPECT_EQ(98, logger.getDebugLevel());
- logger.setSeverity(Logger::DEBUG, 99);
+ logger.setSeverity(isc::log::DEBUG, 99);
EXPECT_EQ(99, logger.getDebugLevel());
- logger.setSeverity(Logger::DEBUG, 100);
+ logger.setSeverity(isc::log::DEBUG, 100);
EXPECT_EQ(99, logger.getDebugLevel());
}
@@ -228,28 +178,28 @@ TEST_F(LoggerTest, SeverityInheritance) {
// implementation (in this case log4cxx) will set a parent-child
// relationship if the loggers are named <parent> and <parent>.<child>.
- RootLoggerName::setName("test5");
+ setRootLoggerName("test5");
TestLogger parent("alpha");
TestLogger child("alpha.beta");
// By default, newly created loggers should have a level of DEFAULT
// (i.e. default to parent)
- EXPECT_EQ(Logger::DEFAULT, parent.getSeverity());
- EXPECT_EQ(Logger::DEFAULT, child.getSeverity());
+ EXPECT_EQ(isc::log::DEFAULT, parent.getSeverity());
+ EXPECT_EQ(isc::log::DEFAULT, child.getSeverity());
// Set the severity of the child to something other than the default -
// check it changes and that of the parent does not.
- child.setSeverity(Logger::INFO);
- EXPECT_EQ(Logger::DEFAULT, parent.getSeverity());
- EXPECT_EQ(Logger::INFO, child.getSeverity());
+ child.setSeverity(isc::log::INFO);
+ EXPECT_EQ(isc::log::DEFAULT, parent.getSeverity());
+ EXPECT_EQ(isc::log::INFO, child.getSeverity());
// Reset the child severity and set that of the parent
- child.setSeverity(Logger::DEFAULT);
- EXPECT_EQ(Logger::DEFAULT, parent.getSeverity());
- EXPECT_EQ(Logger::DEFAULT, child.getSeverity());
- parent.setSeverity(Logger::WARN);
- EXPECT_EQ(Logger::WARN, parent.getSeverity());
- EXPECT_EQ(Logger::DEFAULT, child.getSeverity());
+ child.setSeverity(isc::log::DEFAULT);
+ EXPECT_EQ(isc::log::DEFAULT, parent.getSeverity());
+ EXPECT_EQ(isc::log::DEFAULT, child.getSeverity());
+ parent.setSeverity(isc::log::WARN);
+ EXPECT_EQ(isc::log::WARN, parent.getSeverity());
+ EXPECT_EQ(isc::log::DEFAULT, child.getSeverity());
}
// Check that severity is inherited.
@@ -260,7 +210,7 @@ TEST_F(LoggerTest, EffectiveSeverityInheritance) {
// implementation (in this case log4cxx) will set a parent-child
// relationship if the loggers are named <parent> and <parent>.<child>.
- RootLoggerName::setName("test6");
+ setRootLoggerName("test6");
Logger parent("test6");
Logger child("test6.beta");
@@ -268,58 +218,58 @@ TEST_F(LoggerTest, EffectiveSeverityInheritance) {
// (i.e. default to parent) and the root should have a default severity
// of INFO. However, the latter is only enforced when created by the
// RootLogger class, so explicitly set it for the parent for now.
- parent.setSeverity(Logger::INFO);
- EXPECT_EQ(Logger::INFO, parent.getEffectiveSeverity());
+ parent.setSeverity(isc::log::INFO);
+ EXPECT_EQ(isc::log::INFO, parent.getEffectiveSeverity());
- EXPECT_EQ(Logger::DEFAULT, child.getSeverity());
- EXPECT_EQ(Logger::INFO, child.getEffectiveSeverity());
+ EXPECT_EQ(isc::log::DEFAULT, child.getSeverity());
+ EXPECT_EQ(isc::log::INFO, child.getEffectiveSeverity());
// Set the severity of the child to something other than the default -
// check it changes and that of the parent does not.
- child.setSeverity(Logger::FATAL);
- EXPECT_EQ(Logger::INFO, parent.getEffectiveSeverity());
- EXPECT_EQ(Logger::FATAL, child.getEffectiveSeverity());
+ child.setSeverity(isc::log::FATAL);
+ EXPECT_EQ(isc::log::INFO, parent.getEffectiveSeverity());
+ EXPECT_EQ(isc::log::FATAL, child.getEffectiveSeverity());
// Reset the child severity and check again.
- child.setSeverity(Logger::DEFAULT);
- EXPECT_EQ(Logger::INFO, parent.getEffectiveSeverity());
- EXPECT_EQ(Logger::INFO, child.getEffectiveSeverity());
+ child.setSeverity(isc::log::DEFAULT);
+ EXPECT_EQ(isc::log::INFO, parent.getEffectiveSeverity());
+ EXPECT_EQ(isc::log::INFO, child.getEffectiveSeverity());
// Change the parwnt's severity and check it is reflects in the child.
- parent.setSeverity(Logger::WARN);
- EXPECT_EQ(Logger::WARN, parent.getEffectiveSeverity());
- EXPECT_EQ(Logger::WARN, child.getEffectiveSeverity());
+ parent.setSeverity(isc::log::WARN);
+ EXPECT_EQ(isc::log::WARN, parent.getEffectiveSeverity());
+ EXPECT_EQ(isc::log::WARN, child.getEffectiveSeverity());
}
// Test the isXxxxEnabled methods.
TEST_F(LoggerTest, IsXxxEnabled) {
- RootLoggerName::setName("test7");
+ setRootLoggerName("test7");
Logger logger("test7");
- logger.setSeverity(Logger::INFO);
+ logger.setSeverity(isc::log::INFO);
EXPECT_FALSE(logger.isDebugEnabled());
EXPECT_TRUE(logger.isInfoEnabled());
EXPECT_TRUE(logger.isWarnEnabled());
EXPECT_TRUE(logger.isErrorEnabled());
EXPECT_TRUE(logger.isFatalEnabled());
- logger.setSeverity(Logger::WARN);
+ logger.setSeverity(isc::log::WARN);
EXPECT_FALSE(logger.isDebugEnabled());
EXPECT_FALSE(logger.isInfoEnabled());
EXPECT_TRUE(logger.isWarnEnabled());
EXPECT_TRUE(logger.isErrorEnabled());
EXPECT_TRUE(logger.isFatalEnabled());
- logger.setSeverity(Logger::ERROR);
+ logger.setSeverity(isc::log::ERROR);
EXPECT_FALSE(logger.isDebugEnabled());
EXPECT_FALSE(logger.isInfoEnabled());
EXPECT_FALSE(logger.isWarnEnabled());
EXPECT_TRUE(logger.isErrorEnabled());
EXPECT_TRUE(logger.isFatalEnabled());
- logger.setSeverity(Logger::FATAL);
+ logger.setSeverity(isc::log::FATAL);
EXPECT_FALSE(logger.isDebugEnabled());
EXPECT_FALSE(logger.isInfoEnabled());
EXPECT_FALSE(logger.isWarnEnabled());
@@ -328,14 +278,14 @@ TEST_F(LoggerTest, IsXxxEnabled) {
// Check various debug levels
- logger.setSeverity(Logger::DEBUG);
+ logger.setSeverity(isc::log::DEBUG);
EXPECT_TRUE(logger.isDebugEnabled());
EXPECT_TRUE(logger.isInfoEnabled());
EXPECT_TRUE(logger.isWarnEnabled());
EXPECT_TRUE(logger.isErrorEnabled());
EXPECT_TRUE(logger.isFatalEnabled());
- logger.setSeverity(Logger::DEBUG, 45);
+ logger.setSeverity(isc::log::DEBUG, 45);
EXPECT_TRUE(logger.isDebugEnabled());
EXPECT_TRUE(logger.isInfoEnabled());
EXPECT_TRUE(logger.isWarnEnabled());
@@ -346,14 +296,14 @@ TEST_F(LoggerTest, IsXxxEnabled) {
// the severity of the parent logger.
Logger child("test7.child");
- logger.setSeverity(Logger::FATAL);
+ logger.setSeverity(isc::log::FATAL);
EXPECT_FALSE(child.isDebugEnabled());
EXPECT_FALSE(child.isInfoEnabled());
EXPECT_FALSE(child.isWarnEnabled());
EXPECT_FALSE(child.isErrorEnabled());
EXPECT_TRUE(child.isFatalEnabled());
- logger.setSeverity(Logger::INFO);
+ logger.setSeverity(isc::log::INFO);
EXPECT_FALSE(child.isDebugEnabled());
EXPECT_TRUE(child.isInfoEnabled());
EXPECT_TRUE(child.isWarnEnabled());
@@ -366,29 +316,29 @@ TEST_F(LoggerTest, IsXxxEnabled) {
TEST_F(LoggerTest, IsDebugEnabledLevel) {
- RootLoggerName::setName("test8");
+ setRootLoggerName("test8");
Logger logger("test8");
int MID_LEVEL = (MIN_DEBUG_LEVEL + MAX_DEBUG_LEVEL) / 2;
- logger.setSeverity(Logger::DEBUG);
+ logger.setSeverity(isc::log::DEBUG);
EXPECT_TRUE(logger.isDebugEnabled(MIN_DEBUG_LEVEL));
EXPECT_FALSE(logger.isDebugEnabled(MID_LEVEL));
EXPECT_FALSE(logger.isDebugEnabled(MAX_DEBUG_LEVEL));
- logger.setSeverity(Logger::DEBUG, MIN_DEBUG_LEVEL);
+ logger.setSeverity(isc::log::DEBUG, MIN_DEBUG_LEVEL);
EXPECT_TRUE(logger.isDebugEnabled(MIN_DEBUG_LEVEL));
EXPECT_FALSE(logger.isDebugEnabled(MID_LEVEL));
EXPECT_FALSE(logger.isDebugEnabled(MAX_DEBUG_LEVEL));
- logger.setSeverity(Logger::DEBUG, MID_LEVEL);
+ logger.setSeverity(isc::log::DEBUG, MID_LEVEL);
EXPECT_TRUE(logger.isDebugEnabled(MIN_DEBUG_LEVEL));
EXPECT_TRUE(logger.isDebugEnabled(MID_LEVEL - 1));
EXPECT_TRUE(logger.isDebugEnabled(MID_LEVEL));
EXPECT_FALSE(logger.isDebugEnabled(MID_LEVEL + 1));
EXPECT_FALSE(logger.isDebugEnabled(MAX_DEBUG_LEVEL));
- logger.setSeverity(Logger::DEBUG, MAX_DEBUG_LEVEL);
+ logger.setSeverity(isc::log::DEBUG, MAX_DEBUG_LEVEL);
EXPECT_TRUE(logger.isDebugEnabled(MIN_DEBUG_LEVEL));
EXPECT_TRUE(logger.isDebugEnabled(MID_LEVEL));
EXPECT_TRUE(logger.isDebugEnabled(MAX_DEBUG_LEVEL));
diff --git a/src/lib/log/tests/message_dictionary_unittest.cc b/src/lib/log/tests/message_dictionary_unittest.cc
index 78aa851..a92585c 100644
--- a/src/lib/log/tests/message_dictionary_unittest.cc
+++ b/src/lib/log/tests/message_dictionary_unittest.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,21 +12,36 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id: base64_unittest.cc 2549 2010-07-20 19:09:37Z jinmei $
-
#include <cstddef>
#include <string>
#include <gtest/gtest.h>
#include <log/message_dictionary.h>
+#include <log/message_initializer.h>
#include <log/message_types.h>
using namespace isc;
using namespace isc::log;
using namespace std;
+// set up another message initializer. This will add a symbol found in the
+// logging library and a symbol not found in the logging library. When the
+// global dictionary is loaded, the former should be marked as a duplicate
+// and the latter should be present.
+
+static const char* values[] = {
+ "DUPLNS", "duplicate $NAMESPACE directive found",
+ "NEWSYM", "new symbol added",
+ NULL
+};
+
+MessageInitializer init(values);
+
+
+
+
class MessageDictionaryTest : public ::testing::Test {
protected:
- MessageDictionaryTest() :
+ MessageDictionaryTest() :
alpha_id("ALPHA"), alpha_text("This is alpha"),
beta_id("BETA"), beta_text("This is beta"),
gamma_id("GAMMA"), gamma_text("This is gamma")
@@ -42,17 +57,6 @@ protected:
};
-
-// Check that the global dictionary is a singleton.
-
-TEST_F(MessageDictionaryTest, GlobalTest) {
- MessageDictionary* global = MessageDictionary::globalDictionary();
- EXPECT_FALSE(NULL == global);
-
- MessageDictionary* global2 = MessageDictionary::globalDictionary();
- EXPECT_EQ(global2, global);
-}
-
// Check that adding messages works
TEST_F(MessageDictionaryTest, Add) {
@@ -122,7 +126,7 @@ TEST_F(MessageDictionaryTest, LoadTest) {
EXPECT_EQ(0, dictionary1.size());
// Load a dictionary1.
- vector<MessageID> duplicates = dictionary1.load(data1);
+ vector<string> duplicates = dictionary1.load(data1);
EXPECT_EQ(3, dictionary1.size());
EXPECT_EQ(string(data1[1]), dictionary1.getText(data1[0]));
EXPECT_EQ(string(data1[3]), dictionary1.getText(data1[2]));
@@ -157,7 +161,7 @@ TEST_F(MessageDictionaryTest, Lookups) {
};
MessageDictionary dictionary;
- vector<MessageID> duplicates = dictionary.load(data);
+ vector<string> duplicates = dictionary.load(data);
EXPECT_EQ(3, dictionary.size());
EXPECT_EQ(0, duplicates.size());
@@ -171,3 +175,23 @@ TEST_F(MessageDictionaryTest, Lookups) {
EXPECT_EQ(string(""), dictionary.getText(""));
EXPECT_EQ(string(""), dictionary.getText("\n\n\n"));
}
+
+// Check that the global dictionary is a singleton.
+
+TEST_F(MessageDictionaryTest, GlobalTest) {
+ MessageDictionary& global = MessageDictionary::globalDictionary();
+ MessageDictionary& global2 = MessageDictionary::globalDictionary();
+ EXPECT_TRUE(&global2 == &global);
+}
+
+// Check that the global dictionary has detected the duplicate and the
+// new symbol.
+
+TEST_F(MessageDictionaryTest, GlobalLoadTest) {
+ vector<string>& duplicates = MessageInitializer::getDuplicates();
+ ASSERT_EQ(1, duplicates.size());
+ EXPECT_EQ(string("DUPLNS"), duplicates[0]);
+
+ string text = MessageDictionary::globalDictionary().getText("NEWSYM");
+ EXPECT_EQ(string("new symbol added"), text);
+}
diff --git a/src/lib/log/tests/message_initializer_unittest.cc b/src/lib/log/tests/message_initializer_unittest.cc
index 6a1019f..0cd1879 100644
--- a/src/lib/log/tests/message_initializer_unittest.cc
+++ b/src/lib/log/tests/message_initializer_unittest.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id: base64_unittest.cc 2549 2010-07-20 19:09:37Z jinmei $
-
#include <cstddef>
#include <string>
#include <gtest/gtest.h>
@@ -61,12 +59,12 @@ protected:
// messages.
TEST_F(MessageInitializerTest, MessageTest) {
- MessageDictionary* global = MessageDictionary::globalDictionary();
+ MessageDictionary& global = MessageDictionary::globalDictionary();
- EXPECT_EQ(string("global message one"), global->getText("GLOBAL1"));
- EXPECT_EQ(string("global message two"), global->getText("GLOBAL2"));
- EXPECT_EQ(string("global message three"), global->getText("GLOBAL3"));
- EXPECT_EQ(string("global message four"), global->getText("GLOBAL4"));
- EXPECT_EQ(string("global message five"), global->getText("GLOBAL5"));
- EXPECT_EQ(string("global message six"), global->getText("GLOBAL6"));
+ EXPECT_EQ(string("global message one"), global.getText("GLOBAL1"));
+ EXPECT_EQ(string("global message two"), global.getText("GLOBAL2"));
+ EXPECT_EQ(string("global message three"), global.getText("GLOBAL3"));
+ EXPECT_EQ(string("global message four"), global.getText("GLOBAL4"));
+ EXPECT_EQ(string("global message five"), global.getText("GLOBAL5"));
+ EXPECT_EQ(string("global message six"), global.getText("GLOBAL6"));
}
diff --git a/src/lib/log/tests/message_initializer_unittest_2.cc b/src/lib/log/tests/message_initializer_unittest_2.cc
index c005033..94abb08 100644
--- a/src/lib/log/tests/message_initializer_unittest_2.cc
+++ b/src/lib/log/tests/message_initializer_unittest_2.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id: base64_unittest.cc 2549 2010-07-20 19:09:37Z jinmei $
-
// The sole purpose of this file is to provide a set of message definitions
// in a separate compilation unit from the one in which their presence is
// checked. This tests that merely declaring the MessageInitializer object
diff --git a/src/lib/log/tests/message_reader_unittest.cc b/src/lib/log/tests/message_reader_unittest.cc
index 2891805..36288f2 100644
--- a/src/lib/log/tests/message_reader_unittest.cc
+++ b/src/lib/log/tests/message_reader_unittest.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id: base64_unittest.cc 2549 2010-07-20 19:09:37Z jinmei $
-
#include <algorithm>
#include <string>
#include <gtest/gtest.h>
@@ -76,7 +74,7 @@ TEST_F(MessageReaderTest, BlanksAndComments) {
// ... and (b) nothing gets added to either the map or the not-added section.
EXPECT_EQ(0, dictionary_->size());
- vector<MessageID> not_added = reader_.getNotAdded();
+ vector<string> not_added = reader_.getNotAdded();
EXPECT_EQ(0, not_added.size());
}
@@ -85,14 +83,15 @@ TEST_F(MessageReaderTest, BlanksAndComments) {
void
processLineException(MessageReader& reader, const char* what,
- MessageID& expected) {
+ const MessageID& expected) {
try {
reader.processLine(what);
FAIL() << "MessageReader::processLine() should throw an exception " <<
" with message ID " << expected << " for '" << what << "'\n";
} catch (MessageException& e) {
- EXPECT_EQ(expected, e.id());
+ EXPECT_EQ(boost::lexical_cast<string>(expected),
+ boost::lexical_cast<string>(e.id()));
} catch (...) {
FAIL() << "Unknown exception thrown by MessageReader::processLine()\n";
}
@@ -102,13 +101,13 @@ processLineException(MessageReader& reader, const char* what,
TEST_F(MessageReaderTest, Prefix) {
- // Check that no prefix is present
+ // Check that no $PREFIX is present
EXPECT_EQ(string(""), reader_.getPrefix());
- // Check that a prefix directive with no argument generates an error.
+ // Check that a $PREFIX directive with no argument generates an error.
processLineException(reader_, "$PREFIX", MSG_PRFNOARG);
- // Check a prefix with multiple arguments is invalid
+ // Check a $PREFIX with multiple arguments is invalid
processLineException(reader_, "$prefix A B", MSG_PRFEXTRARG);
// Prefixes should be alphanumeric (with underscores) and not start
@@ -132,6 +131,43 @@ TEST_F(MessageReaderTest, Prefix) {
EXPECT_EQ(string(""), reader_.getPrefix());
}
+// Check that it can parse a namespace
+
+TEST_F(MessageReaderTest, Namespace) {
+
+ // Check that no $NAMESPACE is present
+ EXPECT_EQ(string(""), reader_.getNamespace());
+
+ // Check that a $NAMESPACE directive with no argument generates an error.
+ processLineException(reader_, "$NAMESPACE", MSG_NSNOARG);
+
+ // Check a $NAMESPACE with multiple arguments is invalid
+ processLineException(reader_, "$namespace A B", MSG_NSEXTRARG);
+
+ // Namespaces should be alphanumeric (with underscores and colons)
+ processLineException(reader_, "$namespace ab[cd", MSG_NSINVARG);
+
+ // A valid $NAMESPACE should be accepted
+ EXPECT_NO_THROW(reader_.processLine("$NAMESPACE isc"));
+ EXPECT_EQ(string("isc"), reader_.getNamespace());
+
+ // (Check that we can clear the namespace)
+ reader_.clearNamespace();
+ EXPECT_EQ(string(""), reader_.getNamespace());
+
+ // Check that a valid namespace can include colons
+ EXPECT_NO_THROW(reader_.processLine("$NAMESPACE isc::log"));
+ EXPECT_EQ(string("isc::log"), reader_.getNamespace());
+
+ // Check that the indication of the anonymous namespace will be recognised.
+ reader_.clearNamespace();
+ EXPECT_NO_THROW(reader_.processLine("$NAMESPACE ::"));
+ EXPECT_EQ(string("::"), reader_.getNamespace());
+
+ // ... and that another $NAMESPACE is rejected
+ processLineException(reader_, "$NAMESPACE ABC", MSG_DUPLNS);
+}
+
// Check that it can parse a line
TEST_F(MessageReaderTest, ValidMessageAddDefault) {
@@ -148,7 +184,7 @@ TEST_F(MessageReaderTest, ValidMessageAddDefault) {
EXPECT_EQ(2, dictionary_->size());
// ... and ensure no messages were not added
- vector<MessageID> not_added = reader_.getNotAdded();
+ vector<string> not_added = reader_.getNotAdded();
EXPECT_EQ(0, not_added.size());
}
@@ -168,7 +204,7 @@ TEST_F(MessageReaderTest, ValidMessageAdd) {
EXPECT_EQ(2, dictionary_->size());
// ... and ensure no messages were not added
- vector<MessageID> not_added = reader_.getNotAdded();
+ vector<string> not_added = reader_.getNotAdded();
EXPECT_EQ(0, not_added.size());
}
@@ -191,7 +227,7 @@ TEST_F(MessageReaderTest, ValidMessageReplace) {
EXPECT_EQ(2, dictionary_->size());
// ... and ensure no messages were not added
- vector<MessageID> not_added = reader_.getNotAdded();
+ vector<string> not_added = reader_.getNotAdded();
EXPECT_EQ(0, not_added.size());
}
@@ -219,7 +255,7 @@ TEST_F(MessageReaderTest, Overflows) {
EXPECT_EQ(2, dictionary_->size());
// ... and ensure no overflows
- vector<MessageID> not_added = reader_.getNotAdded();
+ vector<string> not_added = reader_.getNotAdded();
ASSERT_EQ(2, not_added.size());
sort(not_added.begin(), not_added.end());
diff --git a/src/lib/log/tests/root_logger_name_unittest.cc b/src/lib/log/tests/root_logger_name_unittest.cc
index 6994dc6..8665794 100644
--- a/src/lib/log/tests/root_logger_name_unittest.cc
+++ b/src/lib/log/tests/root_logger_name_unittest.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id: base64_unittest.cc 2549 2010-07-20 19:09:37Z jinmei $
-
#include <string>
#include <gtest/gtest.h>
@@ -37,8 +35,8 @@ TEST_F(RootLoggerNameTest, SetGet) {
const std::string name2 = "test2";
// Check that Set/Get works
- RootLoggerName::setName(name1);
- EXPECT_EQ(name1, RootLoggerName::getName());
+ setRootLoggerName(name1);
+ EXPECT_EQ(name1, getRootLoggerName());
// We could not test that the root logger name is initialised
// correctly (as there is one instance of it and we don't know
@@ -47,6 +45,6 @@ TEST_F(RootLoggerNameTest, SetGet) {
//
// (There was always the outside chance that the root logger name
// was initialised with name1 and that setName() has no effect.)
- RootLoggerName::setName(name2);
- EXPECT_EQ(name2, RootLoggerName::getName());
+ setRootLoggerName(name2);
+ EXPECT_EQ(name2, getRootLoggerName());
}
diff --git a/src/lib/log/tests/run_time_init_test.sh.in b/src/lib/log/tests/run_time_init_test.sh.in
index be52ded..e2bdf6f 100755
--- a/src/lib/log/tests/run_time_init_test.sh.in
+++ b/src/lib/log/tests/run_time_init_test.sh.in
@@ -14,7 +14,7 @@
# PERFORMANCE OF THIS SOFTWARE.
failcount=0
-localmes=@abs_srcdir@/localdef.mes
+localmes=@abs_builddir@/localdef_mes_$$
tempfile=@abs_builddir@/run_time_init_test_tempfile_$$
passfail() {
@@ -25,20 +25,28 @@ passfail() {
fi
failcount=`expr $failcount + $1`
}
-
+
+# Create the local message file for testing
+
+cat > $localmes << .
+NOTHERE this message is not in the global dictionary
+MSGRDERR replacement read error, parameters: '%s' and '%s'
+UNRECDIR replacement unrecognised directive message, parameter is '%s'
+.
+
echo -n "1. runInitTest default parameters: "
cat > $tempfile << .
-FATAL [alpha.example] WRITERR, error writing to test1: 42
+FATAL [alpha.example] MSGWRTERR, error writing to test1: 42
ERROR [alpha.example] UNRECDIR, unrecognised directive 'false'
-WARN [alpha.dlm] READERR, error reading from a.txt: dummy test
-INFO [alpha.dlm] OPENIN, unable to open message file example.msg for input: dummy test
+WARN [alpha.dlm] MSGRDERR, error reading from message file a.txt: dummy test
+INFO [alpha.dlm] OPNMSGIN, unable to open message file example.msg for input: dummy test
.
./logger_support_test | cut -d' ' -f3- | diff $tempfile -
passfail $?
echo -n "2. Severity filter: "
cat > $tempfile << .
-FATAL [alpha.example] WRITERR, error writing to test1: 42
+FATAL [alpha.example] MSGWRTERR, error writing to test1: 42
ERROR [alpha.example] UNRECDIR, unrecognised directive 'false'
.
./logger_support_test -s error | cut -d' ' -f3- | diff $tempfile -
@@ -46,10 +54,10 @@ passfail $?
echo -n "3. Debug level: "
cat > $tempfile << .
-FATAL [alpha.example] WRITERR, error writing to test1: 42
+FATAL [alpha.example] MSGWRTERR, error writing to test1: 42
ERROR [alpha.example] UNRECDIR, unrecognised directive 'false'
-WARN [alpha.dlm] READERR, error reading from a.txt: dummy test
-INFO [alpha.dlm] OPENIN, unable to open message file example.msg for input: dummy test
+WARN [alpha.dlm] MSGRDERR, error reading from message file a.txt: dummy test
+INFO [alpha.dlm] OPNMSGIN, unable to open message file example.msg for input: dummy test
DEBUG [alpha.example] UNRECDIR, unrecognised directive '[abc]'
DEBUG [alpha.example] UNRECDIR, unrecognised directive '[24]'
DEBUG [alpha.example] UNRECDIR, unrecognised directive '[25]'
@@ -60,14 +68,14 @@ passfail $?
echo -n "4. Local message replacement: "
cat > $tempfile << .
WARN [alpha.log] IDNOTFND, could not replace message for 'NOTHERE': no such message identification
-FATAL [alpha.example] WRITERR, error writing to test1: 42
+FATAL [alpha.example] MSGWRTERR, error writing to test1: 42
ERROR [alpha.example] UNRECDIR, replacement unrecognised directive message, parameter is 'false'
-WARN [alpha.dlm] READERR, replacement read error, parameters: 'a.txt' and 'dummy test'
-INFO [alpha.dlm] OPENIN, unable to open message file example.msg for input: dummy test
+WARN [alpha.dlm] MSGRDERR, replacement read error, parameters: 'a.txt' and 'dummy test'
.
-./logger_support_test $localmes | cut -d' ' -f3- | diff $tempfile -
+./logger_support_test -s warn $localmes | cut -d' ' -f3- | diff $tempfile -
passfail $?
+rm -f $localmes
rm -f $tempfile
if [ $failcount -eq 0 ]; then
diff --git a/src/lib/log/tests/run_unittests.cc b/src/lib/log/tests/run_unittests.cc
index b91ce24..bd3c4c9 100644
--- a/src/lib/log/tests/run_unittests.cc
+++ b/src/lib/log/tests/run_unittests.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id: run_unittests.cc 3020 2010-09-26 03:47:26Z jinmei $
-
#include <gtest/gtest.h>
int
diff --git a/src/lib/log/tests/strutil_unittest.cc b/src/lib/log/tests/strutil_unittest.cc
index 6e657f3..b3fceef 100644
--- a/src/lib/log/tests/strutil_unittest.cc
+++ b/src/lib/log/tests/strutil_unittest.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id: base64_unittest.cc 2549 2010-07-20 19:09:37Z jinmei $
-
#include <string>
#include <gtest/gtest.h>
diff --git a/src/lib/log/tests/xdebuglevel_unittest.cc b/src/lib/log/tests/xdebuglevel_unittest.cc
index 2cb0952..ca80e5a 100644
--- a/src/lib/log/tests/xdebuglevel_unittest.cc
+++ b/src/lib/log/tests/xdebuglevel_unittest.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id: $
-
#include <iostream>
#include <string>
@@ -21,7 +19,7 @@
#include <log4cxx/level.h>
#include <log/xdebuglevel.h>
-#include <log/dbglevels.h>
+#include <log/debug_levels.h>
/// \brief XDebugLevel (Debug Extension to Level Class)
///
diff --git a/src/lib/log/xdebuglevel.cc b/src/lib/log/xdebuglevel.cc
index 7dddcff..c17a515 100644
--- a/src/lib/log/xdebuglevel.cc
+++ b/src/lib/log/xdebuglevel.cc
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,8 +12,6 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#include <cassert>
#include <algorithm>
#include <syslog.h>
@@ -21,7 +19,7 @@
#include <boost/lexical_cast.hpp>
#include <xdebuglevel.h>
-#include <dbglevels.h>
+#include <debug_levels.h>
#include <log4cxx/helpers/stringhelper.h>
using namespace log4cxx;
@@ -71,7 +69,7 @@ XDebugLevel::getExtendedDebug(int level) {
int actual = std::max(MIN_DEBUG_LEVEL, std::min(MAX_DEBUG_LEVEL, level));
// ... and return a pointer to the appropriate logging level object
- return dbglevels_[actual - MIN_DEBUG_LEVEL];
+ return (dbglevels_[actual - MIN_DEBUG_LEVEL]);
}
// Convert an integer (an absolute logging level number, not a debug level) to a
@@ -80,7 +78,7 @@ XDebugLevel::getExtendedDebug(int level) {
LevelPtr
XDebugLevel::toLevel(int val) {
- return toLevel(val, getExtendedDebug(MIN_DEBUG_LEVEL));
+ return (toLevel(val, getExtendedDebug(MIN_DEBUG_LEVEL)));
}
LevelPtr
@@ -89,10 +87,10 @@ XDebugLevel::toLevel(int val, const LevelPtr& defaultLevel) {
// Note the reversal of the notion of MIN and MAX - see the header file for
// details.
if ((val >= XDEBUG_MAX_LEVEL_INT) && (val <= XDEBUG_MIN_LEVEL_INT)) {
- return getExtendedDebug(XDEBUG_MIN_LEVEL_INT - val);
+ return (getExtendedDebug(XDEBUG_MIN_LEVEL_INT - val));
}
else {
- return defaultLevel;
+ return (defaultLevel);
}
}
@@ -100,7 +98,7 @@ XDebugLevel::toLevel(int val, const LevelPtr& defaultLevel) {
LevelPtr
XDebugLevel::toLevelLS(const LogString& sArg) {
- return toLevelLS(sArg, getExtendedDebug(0));
+ return (toLevelLS(sArg, getExtendedDebug(0)));
}
LevelPtr
@@ -111,7 +109,7 @@ XDebugLevel::toLevelLS(const LogString& sArg, const LevelPtr& defaultLevel) {
if (length < 5) {
// String can't possibly start DEBUG so we don't know what it is.
- return defaultLevel;
+ return (defaultLevel);
}
else {
if (strncasecmp(name.c_str(), "DEBUG", 5) == 0) {
@@ -121,7 +119,7 @@ XDebugLevel::toLevelLS(const LogString& sArg, const LevelPtr& defaultLevel) {
if (length == 5) {
// It is plain "DEBUG". Take this as level 0.
- return getExtendedDebug(0);
+ return (getExtendedDebug(0));
}
else {
@@ -132,17 +130,17 @@ XDebugLevel::toLevelLS(const LogString& sArg, const LevelPtr& defaultLevel) {
// if DEBUG99 has been specified.
try {
int level = boost::lexical_cast<int>(name.substr(5));
- return getExtendedDebug(level);
+ return (getExtendedDebug(level));
}
- catch (boost::bad_lexical_cast&) {
- return defaultLevel;
+ catch ((boost::bad_lexical_cast&) ){
+ return (defaultLevel);
}
}
}
else {
// Unknown string - return default.
- return defaultLevel;
+ return (defaultLevel);
}
}
}
diff --git a/src/lib/log/xdebuglevel.h b/src/lib/log/xdebuglevel.h
index 4d28ead..fce3de4 100644
--- a/src/lib/log/xdebuglevel.h
+++ b/src/lib/log/xdebuglevel.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
@@ -12,15 +12,13 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
-// $Id$
-
#ifndef __XDEBUGLEVEL_H
#define __XDEBUGLEVEL_H
#include <syslog.h>
#include <log4cxx/level.h>
-#include <dbglevels.h>
+#include <debug_levels.h>
namespace log4cxx {
diff --git a/src/lib/nsas/Makefile.am b/src/lib/nsas/Makefile.am
index a88bd22..04a765b 100644
--- a/src/lib/nsas/Makefile.am
+++ b/src/lib/nsas/Makefile.am
@@ -25,6 +25,7 @@ libnsas_la_SOURCES += asiolink.h
libnsas_la_SOURCES += hash.cc hash.h
libnsas_la_SOURCES += hash_deleter.h
libnsas_la_SOURCES += hash_key.cc hash_key.h
+libnsas_la_SOURCES += locks.h
libnsas_la_SOURCES += hash_table.h
libnsas_la_SOURCES += lru_list.h
libnsas_la_SOURCES += nameserver_address_store.cc nameserver_address_store.h
diff --git a/src/lib/nsas/asiolink.h b/src/lib/nsas/asiolink.h
index b99ddb3..f5af192 100644
--- a/src/lib/nsas/asiolink.h
+++ b/src/lib/nsas/asiolink.h
@@ -46,7 +46,7 @@ public:
}
/// \return true if two addresses are equal
- bool equal(const IOAddress& address)
+ bool equal(const IOAddress& address) const
{return (toText() == address.toText());}
private:
diff --git a/src/lib/nsas/hash_table.h b/src/lib/nsas/hash_table.h
index 3c34ee9..e46d687 100644
--- a/src/lib/nsas/hash_table.h
+++ b/src/lib/nsas/hash_table.h
@@ -15,25 +15,11 @@
#ifndef __HASH_TABLE_H
#define __HASH_TABLE_H
-// Workaround for a problem with boost and sunstudio 5.10
-// There is a version check in there that appears wrong,
-// which makes including boost/thread.hpp fail
-// This will probably be fixed in a future version of boost,
-// in which case this part can be removed then
-#ifdef NEED_SUNPRO_WORKAROUND
-#if defined(__SUNPRO_CC) && __SUNPRO_CC == 0x5100
-#undef __SUNPRO_CC
-#define __SUNPRO_CC 0x5090
-#endif
-#endif // NEED_SUNPRO_WORKAROUND
+#include <list>
#include <boost/shared_ptr.hpp>
-#include <boost/thread.hpp>
-#include <boost/interprocess/sync/sharable_lock.hpp>
-#include <boost/interprocess/sync/scoped_lock.hpp>
-#include <boost/interprocess/sync/interprocess_upgradable_mutex.hpp>
-#include <list>
+#include "locks.h"
#include "hash.h"
#include "hash_key.h"
@@ -61,7 +47,7 @@ struct HashTableSlot {
typedef typename std::list<boost::shared_ptr<T> >::iterator iterator;
///< Iterator over elements with same hash
- typedef boost::interprocess::interprocess_upgradable_mutex mutex_type;
+ typedef isc::locks::upgradable_mutex mutex_type;
///< Mutex protecting this slot
//@}
@@ -128,11 +114,11 @@ public:
///
//@{
typedef typename
- boost::interprocess::sharable_lock<typename HashTableSlot<T>::mutex_type>
+ isc::locks::sharable_lock<typename HashTableSlot<T>::mutex_type>
sharable_lock; ///< Type for a scope-limited read-lock
typedef typename
- boost::interprocess::scoped_lock<typename HashTableSlot<T>::mutex_type>
+ isc::locks::scoped_lock<typename HashTableSlot<T>::mutex_type>
scoped_lock; ///< Type for a scope-limited write-lock
//@}
diff --git a/src/lib/nsas/locks.h b/src/lib/nsas/locks.h
new file mode 100644
index 0000000..98197c3
--- /dev/null
+++ b/src/lib/nsas/locks.h
@@ -0,0 +1,116 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+/// This file (right now) provides dummy locks
+/// It also contains code to use boost/threads locks:
+///
+/// if USE_BOOST_THREADS is defined, we typedef the relevant classes
+/// and derive from the relevant templates so our dummy locks are
+/// replaced by the boost locks (--enable-boost-threads)
+///
+/// If USE_BOOST_THREADS is NOT defined, all locks are dummy classes
+/// that don't actually do anything. At this moment, only the very
+/// minimal set of methods that we actually use is defined.
+///
+/// Note that we need to include <config.h> in our .cc files for that
+/// to be set. we might want to enfore this at compile time with a check
+/// (TODO)
+/// Note that this also contains a workaround for Sunstudio; which
+/// probably won't completely work right now (that is, if the TODO
+/// above is completed), since that would also require some changes
+/// in most (at first glance unrelated) Makefiles
+/// (TODO2)
+
+#ifndef __LOCKS_
+#define __LOCKS_
+
+#ifndef USE_BOOST_THREADS
+
+namespace isc {
+namespace locks {
+
+class mutex {
+};
+
+class recursive_mutex {
+};
+
+class upgradable_mutex {
+};
+
+template <typename T>
+class sharable_lock {
+public:
+ sharable_lock(T) { }
+};
+
+template <typename T>
+class scoped_lock {
+public:
+ scoped_lock(T) { }
+
+ void lock() {}
+ void unlock() {}
+};
+
+}
+}
+
+#else // USE_BOOST_THREADS
+
+// Workaround for a problem with boost and sunstudio 5.10
+// There is a version check in there that appears wrong,
+// which makes including boost/thread.hpp fail
+// This will probably be fixed in a future version of boost,
+// in which case this part can be removed then
+#ifdef NEED_SUNPRO_WORKAROUND
+#if defined(__SUNPRO_CC) && __SUNPRO_CC == 0x5100
+#undef __SUNPRO_CC
+#define __SUNPRO_CC 0x5090
+#endif
+#endif // NEED_SUNPRO_WORKAROUND
+
+#include <boost/thread.hpp>
+#include <boost/interprocess/sync/sharable_lock.hpp>
+#include <boost/interprocess/sync/scoped_lock.hpp>
+#include <boost/interprocess/sync/interprocess_upgradable_mutex.hpp>
+#include <boost/interprocess/sync/interprocess_recursive_mutex.hpp>
+
+namespace isc {
+namespace locks {
+
+typedef boost::mutex mutex;
+typedef boost::interprocess::interprocess_upgradable_mutex upgradable_mutex;
+typedef boost::interprocess::interprocess_recursive_mutex recursive_mutex;
+
+template <typename T>
+struct sharable_lock : public boost::interprocess::sharable_lock<T> {
+public:
+ sharable_lock(T& mtype) : boost::interprocess::sharable_lock<T>(mtype) {}
+};
+
+
+template <class T>
+struct scoped_lock : public boost::interprocess::scoped_lock<T> {
+public:
+ scoped_lock(T& mtype) : boost::interprocess::scoped_lock<T>(mtype) { }
+};
+
+}
+}
+
+
+#endif // USE_BOOST_THREADS
+
+#endif // __LOCKS_
diff --git a/src/lib/nsas/lru_list.h b/src/lib/nsas/lru_list.h
index a3e0974..993eb89 100644
--- a/src/lib/nsas/lru_list.h
+++ b/src/lib/nsas/lru_list.h
@@ -18,22 +18,10 @@
#include <list>
#include <string>
-// Workaround for a problem with boost and sunstudio 5.10
-// There is a version check in there that appears wrong,
-// which makes including boost/thread.hpp fail
-// This will probably be fixed in a future version of boost,
-// in which case this part can be removed then
-#ifdef NEED_SUNPRO_WORKAROUND
-#if defined(__SUNPRO_CC) && __SUNPRO_CC == 0x5100
-#undef __SUNPRO_CC
-#define __SUNPRO_CC 0x5090
-#endif
-#endif // NEED_SUNPRO_WORKAROUND
-
#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>
-#include <boost/thread.hpp>
-#include <boost/interprocess/sync/scoped_lock.hpp>
+
+#include "locks.h"
namespace isc {
namespace nsas {
@@ -151,7 +139,7 @@ public:
}
private:
- boost::mutex mutex_; ///< List protection
+ isc::locks::mutex mutex_; ///< List protection
std::list<boost::shared_ptr<T> > lru_; ///< The LRU list itself
uint32_t max_size_; ///< Max size of the list
uint32_t count_; ///< Count of elements
@@ -163,7 +151,7 @@ template <typename T>
void LruList<T>::add(boost::shared_ptr<T>& element) {
// Protect list against concurrent access
- boost::interprocess::scoped_lock<boost::mutex> lock(mutex_);
+ isc::locks::scoped_lock<isc::locks::mutex> lock(mutex_);
// Add the entry and set its pointer field to point into the list.
// insert() is used to get the pointer.
@@ -212,7 +200,7 @@ void LruList<T>::remove(boost::shared_ptr<T>& element) {
if (element->iteratorValid()) {
// Is valid, so protect list against concurrent access
- boost::interprocess::scoped_lock<boost::mutex> lock(mutex_);
+ isc::locks::scoped_lock<isc::locks::mutex> lock(mutex_);
lru_.erase(element->getLruIterator()); // Remove element from list
element->invalidateIterator(); // Invalidate pointer
@@ -228,7 +216,7 @@ void LruList<T>::touch(boost::shared_ptr<T>& element) {
if (element->iteratorValid()) {
// Protect list against concurrent access
- boost::interprocess::scoped_lock<boost::mutex> lock(mutex_);
+ isc::locks::scoped_lock<isc::locks::mutex> lock(mutex_);
// Move the element to the end of the list.
lru_.splice(lru_.end(), lru_, element->getLruIterator());
diff --git a/src/lib/nsas/nameserver_address_store.cc b/src/lib/nsas/nameserver_address_store.cc
index 0ba9c8e..7bb0eee 100644
--- a/src/lib/nsas/nameserver_address_store.cc
+++ b/src/lib/nsas/nameserver_address_store.cc
@@ -14,20 +14,6 @@
#include <config.h>
-// Workaround for a problem with boost and sunstudio 5.10
-// There is a version check in there that appears wrong,
-// which makes including boost/thread.hpp fail
-// This will probably be fixed in a future version of boost,
-// in which case this part can be removed then
-#ifdef NEED_SUNPRO_WORKAROUND
-#if defined(__SUNPRO_CC) && __SUNPRO_CC == 0x5100
-#undef __SUNPRO_CC
-#define __SUNPRO_CC 0x5090
-#endif
-#endif // NEED_SUNPRO_WORKAROUND
-
-
-#include <boost/thread.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/foreach.hpp>
#include <boost/bind.hpp>
@@ -35,6 +21,7 @@
#include <config.h>
#include <dns/rdataclass.h>
+#include "locks.h"
#include "hash_table.h"
#include "lru_list.h"
#include "hash_deleter.h"
diff --git a/src/lib/nsas/nameserver_entry.cc b/src/lib/nsas/nameserver_entry.cc
index 53f4233..9522e81 100644
--- a/src/lib/nsas/nameserver_entry.cc
+++ b/src/lib/nsas/nameserver_entry.cc
@@ -50,7 +50,7 @@ namespace nsas {
namespace {
// Just shorter type alias
-typedef boost::recursive_mutex::scoped_lock Lock;
+typedef isc::locks::scoped_lock<isc::locks::recursive_mutex> Lock;
}
diff --git a/src/lib/nsas/nameserver_entry.h b/src/lib/nsas/nameserver_entry.h
index 9a8e542..f6c2e8c 100644
--- a/src/lib/nsas/nameserver_entry.h
+++ b/src/lib/nsas/nameserver_entry.h
@@ -15,21 +15,8 @@
#ifndef __NAMESERVER_ENTRY_H
#define __NAMESERVER_ENTRY_H
-// Workaround for a problem with boost and sunstudio 5.10
-// There is a version check in there that appears wrong,
-// which makes including boost/thread.hpp fail
-// This will probably be fixed in a future version of boost,
-// in which case this part can be removed then
-#ifdef NEED_SUNPRO_WORKAROUND
-#if defined(__SUNPRO_CC) && __SUNPRO_CC == 0x5100
-#undef __SUNPRO_CC
-#define __SUNPRO_CC 0x5090
-#endif
-#endif // NEED_SUNPRO_WORKAROUND
-
#include <string>
#include <vector>
-#include <boost/thread.hpp>
#include <boost/enable_shared_from_this.hpp>
#include <exceptions/exceptions.h>
@@ -118,7 +105,14 @@ public:
name_(name),
classCode_(class_code),
expiration_(0)
- {}
+ {
+ has_address_[V4_ONLY] = false;
+ has_address_[V6_ONLY] = false;
+ has_address_[ANY_OK] = false;
+ expect_address_[V4_ONLY] = false;
+ expect_address_[V6_ONLY] = false;
+ expect_address_[ANY_OK] = false;
+ }
/*
* \brief Return Address
@@ -252,7 +246,7 @@ public:
//@}
private:
- mutable boost::recursive_mutex mutex_; ///< Mutex protecting this object
+ mutable isc::locks::recursive_mutex mutex_;///< Mutex protecting this object
std::string name_; ///< Canonical name of the nameserver
isc::dns::RRClass classCode_; ///< Class of the nameserver
/**
diff --git a/src/lib/nsas/tests/nsas_test.h b/src/lib/nsas/tests/nsas_test.h
index b4446a4..926e859 100644
--- a/src/lib/nsas/tests/nsas_test.h
+++ b/src/lib/nsas/tests/nsas_test.h
@@ -22,6 +22,7 @@
#include <string>
#include <vector>
+#include <map>
#include <config.h>
diff --git a/src/lib/nsas/zone_entry.cc b/src/lib/nsas/zone_entry.cc
index 395b06c..77f3dad 100644
--- a/src/lib/nsas/zone_entry.cc
+++ b/src/lib/nsas/zone_entry.cc
@@ -12,6 +12,8 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
+#include <map>
+
#include <config.h>
#include "zone_entry.h"
@@ -49,7 +51,7 @@ ZoneEntry::ZoneEntry(
namespace {
// Shorter aliases for frequently used types
-typedef boost::recursive_mutex::scoped_lock Lock; // Local lock, nameservers not locked
+typedef isc::locks::scoped_lock<isc::locks::recursive_mutex> Lock; // Local lock, nameservers not locked
typedef boost::shared_ptr<AddressRequestCallback> CallbackPtr;
/*
diff --git a/src/lib/nsas/zone_entry.h b/src/lib/nsas/zone_entry.h
index c819692..28a42ea 100644
--- a/src/lib/nsas/zone_entry.h
+++ b/src/lib/nsas/zone_entry.h
@@ -15,22 +15,9 @@
#ifndef __ZONE_ENTRY_H
#define __ZONE_ENTRY_H
-// Workaround for a problem with boost and sunstudio 5.10
-// There is a version check in there that appears wrong,
-// which makes including boost/thread.hpp fail
-// This will probably be fixed in a future version of boost,
-// in which case this part can be removed then
-#ifdef NEED_SUNPRO_WORKAROUND
-#if defined(__SUNPRO_CC) && __SUNPRO_CC == 0x5100
-#undef __SUNPRO_CC
-#define __SUNPRO_CC 0x5090
-#endif
-#endif // NEED_SUNPRO_WORKAROUND
-
#include <string>
#include <vector>
#include <set>
-#include <boost/thread.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/enable_shared_from_this.hpp>
@@ -38,6 +25,7 @@
#include <resolve/resolver_interface.h>
+#include "locks.h"
#include "hash_key.h"
#include "nsas_entry.h"
#include "asiolink.h"
@@ -131,7 +119,7 @@ protected:
time_t expiry_; ///< Expiry time of this entry, 0 means not set
//}@
private:
- mutable boost::recursive_mutex mutex_; ///< Mutex protecting this zone entry
+ mutable isc::locks::recursive_mutex mutex_;///< Mutex protecting this zone entry
std::string name_; ///< Canonical zone name
isc::dns::RRClass class_code_; ///< Class code
/**
diff --git a/src/lib/python/isc/cc/data.py b/src/lib/python/isc/cc/data.py
index c75fbfe..ce1bba0 100644
--- a/src/lib/python/isc/cc/data.py
+++ b/src/lib/python/isc/cc/data.py
@@ -100,8 +100,8 @@ def split_identifier_list_indices(identifier):
i = id_str.find('[')
if i < 0:
- if identifier.find(']') >= 0:
- raise DataTypeError("Bad format in identifier: " + str(identifier))
+ if id_str.find(']') >= 0:
+ raise DataTypeError("Bad format in identifier (] but no [): " + str(identifier))
return identifier, None
# keep the non-index part of that to replace later
@@ -110,7 +110,7 @@ def split_identifier_list_indices(identifier):
while i >= 0:
e = id_str.find(']')
if e < i + 1:
- raise DataTypeError("Bad format in identifier: " + str(identifier))
+ raise DataTypeError("Bad format in identifier (] before [): " + str(identifier))
try:
indices.append(int(id_str[i+1:e]))
except ValueError:
@@ -118,9 +118,9 @@ def split_identifier_list_indices(identifier):
id_str = id_str[e + 1:]
i = id_str.find('[')
if i > 0:
- raise DataTypeError("Bad format in identifier: " + str(identifier))
+ raise DataTypeError("Bad format in identifier ([ within []): " + str(identifier))
if id.find(']') >= 0 or len(id_str) > 0:
- raise DataTypeError("Bad format in identifier: " + str(identifier))
+ raise DataTypeError("Bad format in identifier (extra ]): " + str(identifier))
# we replace the final part of the original identifier with
# the stripped string
diff --git a/src/lib/python/isc/config/ccsession.py b/src/lib/python/isc/config/ccsession.py
index e7fdb86..0e602b7 100644
--- a/src/lib/python/isc/config/ccsession.py
+++ b/src/lib/python/isc/config/ccsession.py
@@ -374,20 +374,34 @@ class UIModuleCCSession(MultiConfigData):
self._set_current_config(config)
- def add_value(self, identifier, value_str):
+ def add_value(self, identifier, value_str = None):
"""Add a value to a configuration list. Raises a DataTypeError
if the value does not conform to the list_item_spec field
- of the module config data specification"""
+ of the module config data specification. If value_str is
+ not given, we add the default as specified by the .spec
+ file."""
module_spec = self.find_spec_part(identifier)
if (type(module_spec) != dict or "list_item_spec" not in module_spec):
raise isc.cc.data.DataNotFoundError(str(identifier) + " is not a list")
- value = isc.cc.data.parse_value_str(value_str)
+
cur_list, status = self.get_value(identifier)
if not cur_list:
cur_list = []
+
+ # Hmm. Do we need to check for duplicates?
+ value = None
+ if value_str is not None:
+ value = isc.cc.data.parse_value_str(value_str)
+ else:
+ if "item_default" in module_spec["list_item_spec"]:
+ value = module_spec["list_item_spec"]["item_default"]
+
+ if value is None:
+ raise isc.cc.data.DataNotFoundError("No value given and no default for " + str(identifier))
+
if value not in cur_list:
cur_list.append(value)
- self.set_value(identifier, cur_list)
+ self.set_value(identifier, cur_list)
def remove_value(self, identifier, value_str):
"""Remove a value from a configuration list. The value string
diff --git a/src/lib/python/isc/config/config_data.py b/src/lib/python/isc/config/config_data.py
index 1e3afd1..582c11c 100644
--- a/src/lib/python/isc/config/config_data.py
+++ b/src/lib/python/isc/config/config_data.py
@@ -121,6 +121,7 @@ def find_spec_part(element, identifier):
# strip list selector part
# don't need it for the spec part, so just drop it
id, list_indices = isc.cc.data.split_identifier_list_indices(id_part)
+ # is this part still needed? (see below)
if type(cur_el) == dict and 'map_item_spec' in cur_el.keys():
found = False
for cur_el_item in cur_el['map_item_spec']:
@@ -128,15 +129,24 @@ def find_spec_part(element, identifier):
cur_el = cur_el_item
found = True
if not found:
- raise isc.cc.data.DataNotFoundError(id + " in " + str(cur_el))
+ raise isc.cc.data.DataNotFoundError(id + " not found")
+ elif type(cur_el) == dict and 'list_item_spec' in cur_el.keys():
+ cur_el = cur_el['list_item_spec']
elif type(cur_el) == list:
found = False
for cur_el_item in cur_el:
if cur_el_item['item_name'] == id:
cur_el = cur_el_item
+ # if we need to go further, we may need to 'skip' a step here
+ # but not if we're done
+ if id_parts[-1] != id_part and type(cur_el) == dict:
+ if "map_item_spec" in cur_el:
+ cur_el = cur_el["map_item_spec"]
+ elif "list_item_spec" in cur_el:
+ cur_el = cur_el["list_item_spec"]
found = True
if not found:
- raise isc.cc.data.DataNotFoundError(id + " in " + str(cur_el))
+ raise isc.cc.data.DataNotFoundError(id + " not found")
else:
raise isc.cc.data.DataNotFoundError("Not a correct config specification")
return cur_el
@@ -354,26 +364,63 @@ class MultiConfigData:
See get_value() for a general way to find a configuration
value
"""
- if identifier[0] == '/':
- identifier = identifier[1:]
- module, sep, id = identifier.partition("/")
try:
+ if identifier[0] == '/':
+ identifier = identifier[1:]
+ module, sep, id = identifier.partition("/")
+ # if there is a 'higher-level' list index specified, we need
+ # to check if that list specification has a default that
+ # overrides the more specific default in the final spec item
+ # (ie. list_default = [1, 2, 3], list_item_spec=int, default=0)
+ # def default list[1] should return 2, not 0
+ id_parts = isc.cc.data.split_identifier(id)
+ id_prefix = ""
+ while len(id_parts) > 0:
+ id_part = id_parts.pop(0)
+ item_id, list_indices = isc.cc.data.split_identifier_list_indices(id_part)
+ id_list = module + "/" + id_prefix + "/" + item_id
+ id_prefix += "/" + id_part
+ if list_indices is not None:
+ # there's actually two kinds of default here for
+ # lists; they can have a default value (like an
+ # empty list), but their elements can also have
+ # default values.
+ # So if the list item *itself* is a default,
+ # we need to get the value out of that. If not, we
+ # need to find the default for the specific element.
+ list_value, type = self.get_value(id_list)
+ list_spec = find_spec_part(self._specifications[module].get_config_spec(), id_prefix)
+ if type == self.DEFAULT:
+ if 'item_default' in list_spec:
+ list_value = list_spec['item_default']
+ for i in list_indices:
+ if i < len(list_value):
+ list_value = list_value[i]
+ else:
+ # out of range, return None
+ return None
+
+ if len(id_parts) > 0:
+ rest_of_id = "/".join(id_parts)
+ return isc.cc.data.find(list_value, rest_of_id)
+ else:
+ return list_value
+ else:
+ # we do have a non-default list, see if our indices
+ # exist
+ for i in list_indices:
+ if i < len(list_value):
+ list_value = list_value[i]
+ else:
+ # out of range, return None
+ return None
+
spec = find_spec_part(self._specifications[module].get_config_spec(), id)
if 'item_default' in spec:
- id, list_indices = isc.cc.data.split_identifier_list_indices(id)
- if list_indices is not None and \
- type(spec['item_default']) == list:
- if len(list_indices) == 1:
- default_list = spec['item_default']
- index = list_indices[0]
- if index < len(default_list):
- return default_list[index]
- else:
- return None
- else:
- return spec['item_default']
+ return spec['item_default']
else:
return None
+
except isc.cc.data.DataNotFoundError as dnfe:
return None
@@ -398,13 +445,60 @@ class MultiConfigData:
return value, self.DEFAULT
return None, self.NONE
- def get_value_maps(self, identifier = None):
+ def _append_value_item(self, result, spec_part, identifier, all, first = False):
+ # Look at the spec; it is a list of items, or a map containing 'item_name' etc
+ if type(spec_part) == list:
+ for spec_part_element in spec_part:
+ spec_part_element_name = spec_part_element['item_name']
+ self._append_value_item(result, spec_part_element, identifier + "/" + spec_part_element_name, all)
+ elif type(spec_part) == dict:
+ # depending on item type, and the value of argument 'all'
+ # we need to either add an item, or recursively go on
+ # In the case of a list that is empty, we do need to show that
+ item_name = spec_part['item_name']
+ item_type = spec_part['item_type']
+ if item_type == "list" and (all or first):
+ spec_part_list = spec_part['list_item_spec']
+ list_value, status = self.get_value(identifier)
+ if list_value is None:
+ print("Error: identifier '%s' not found" % identifier)
+ return
+ if type(list_value) != list:
+ # the identifier specified a single element
+ self._append_value_item(result, spec_part_list, identifier, all)
+ else:
+ list_len = len(list_value)
+ if len(list_value) == 0 and (all or first):
+ entry = _create_value_map_entry(identifier,
+ item_type,
+ [], status)
+ result.append(entry)
+ else:
+ for i in range(len(list_value)):
+ self._append_value_item(result, spec_part_list, "%s[%d]" % (identifier, i), all)
+ elif item_type == "map":
+ # just show the specific contents of a map, we are
+ # almost never interested in just its name
+ spec_part_map = spec_part['map_item_spec']
+ self._append_value_item(result, spec_part_map, identifier, all)
+ else:
+ value, status = self.get_value(identifier)
+ entry = _create_value_map_entry(identifier,
+ item_type,
+ value, status)
+ result.append(entry)
+ return
+
+
+ def get_value_maps(self, identifier = None, all = False):
"""Returns a list of dicts, containing the following values:
name: name of the entry (string)
type: string containing the type of the value (or 'module')
value: value of the entry if it is a string, int, double or bool
- modified: true if the value is a local change
- default: true if the value has been changed
+ modified: true if the value is a local change that has not
+ been committed
+ default: true if the value has not been changed (i.e. the
+ value is the default from the specification)
TODO: use the consts for those last ones
Throws DataNotFoundError if the identifier is bad
"""
@@ -412,8 +506,14 @@ class MultiConfigData:
if not identifier:
# No identifier, so we need the list of current modules
for module in self._specifications.keys():
- entry = _create_value_map_entry(module, 'module', None)
- result.append(entry)
+ if all:
+ spec = self.get_module_spec(module)
+ if spec:
+ spec_part = spec.get_config_spec()
+ self._append_value_item(result, spec_part, module, all, True)
+ else:
+ entry = _create_value_map_entry(module, 'module', None)
+ result.append(entry)
else:
if identifier[0] == '/':
identifier = identifier[1:]
@@ -421,42 +521,7 @@ class MultiConfigData:
spec = self.get_module_spec(module)
if spec:
spec_part = find_spec_part(spec.get_config_spec(), id)
- if type(spec_part) == list:
- # list of items to show
- for item in spec_part:
- value, status = self.get_value("/" + identifier\
- + "/" + item['item_name'])
- entry = _create_value_map_entry(item['item_name'],
- item['item_type'],
- value, status)
- result.append(entry)
- elif type(spec_part) == dict:
- # Sub-specification
- item = spec_part
- if item['item_type'] == 'list':
- li_spec = item['list_item_spec']
- value, status = self.get_value("/" + identifier)
- if type(value) == list:
- for list_value in value:
- result_part2 = _create_value_map_entry(
- li_spec['item_name'],
- li_spec['item_type'],
- list_value)
- result.append(result_part2)
- elif value is not None:
- entry = _create_value_map_entry(
- li_spec['item_name'],
- li_spec['item_type'],
- value, status)
- result.append(entry)
- else:
- value, status = self.get_value("/" + identifier)
- if value is not None:
- entry = _create_value_map_entry(
- item['item_name'],
- item['item_type'],
- value, status)
- result.append(entry)
+ self._append_value_item(result, spec_part, identifier, all, True)
return result
def set_value(self, identifier, value):
diff --git a/src/lib/python/isc/config/tests/config_data_test.py b/src/lib/python/isc/config/tests/config_data_test.py
index 4710b00..1aded94 100644
--- a/src/lib/python/isc/config/tests/config_data_test.py
+++ b/src/lib/python/isc/config/tests/config_data_test.py
@@ -358,6 +358,8 @@ class TestMultiConfigData(unittest.TestCase):
self.assertEqual(1, value)
value = self.mcd.get_default_value("Spec2/item5[0]")
self.assertEqual('a', value)
+ value = self.mcd.get_default_value("Spec2/item5[1]")
+ self.assertEqual('b', value)
value = self.mcd.get_default_value("Spec2/item5[5]")
self.assertEqual(None, value)
value = self.mcd.get_default_value("Spec2/item5[0][1]")
@@ -392,6 +394,10 @@ class TestMultiConfigData(unittest.TestCase):
self.assertEqual(None, value)
self.assertEqual(MultiConfigData.NONE, status)
+ value, status = self.mcd.get_value("Spec2/item5")
+ self.assertEqual(['a', 'b'], value)
+ self.assertEqual(MultiConfigData.DEFAULT, status)
+
value, status = self.mcd.get_value("Spec2/item5[0]")
self.assertEqual("a", value)
self.assertEqual(MultiConfigData.DEFAULT, status)
@@ -400,6 +406,11 @@ class TestMultiConfigData(unittest.TestCase):
self.assertEqual(None, value)
self.assertEqual(MultiConfigData.NONE, status)
+ value, status = self.mcd.get_value("Spec2/item5[1]")
+ self.assertEqual("b", value)
+ self.assertEqual(MultiConfigData.DEFAULT, status)
+
+
def test_get_value_maps(self):
maps = self.mcd.get_value_maps()
@@ -423,32 +434,34 @@ class TestMultiConfigData(unittest.TestCase):
self.mcd._set_current_config({ "Spec2": { "item1": 2 } })
self.mcd.set_value("Spec2/item3", False)
maps = self.mcd.get_value_maps("/Spec2")
- self.assertEqual([{'default': False, 'type': 'integer', 'name': 'item1', 'value': 2, 'modified': False},
- {'default': True, 'type': 'real', 'name': 'item2', 'value': 1.1, 'modified': False},
- {'default': False, 'type': 'boolean', 'name': 'item3', 'value': False, 'modified': True},
- {'default': True, 'type': 'string', 'name': 'item4', 'value': 'test', 'modified': False},
- {'default': True, 'type': 'list', 'name': 'item5', 'value': ['a', 'b'], 'modified': False},
- {'default': True, 'type': 'map', 'name': 'item6', 'value': {}, 'modified': False}], maps)
+ self.assertEqual([{'default': False, 'type': 'integer', 'name': 'Spec2/item1', 'value': 2, 'modified': False},
+ {'default': True, 'type': 'real', 'name': 'Spec2/item2', 'value': 1.1, 'modified': False},
+ {'default': False, 'type': 'boolean', 'name': 'Spec2/item3', 'value': False, 'modified': True},
+ {'default': True, 'type': 'string', 'name': 'Spec2/item4', 'value': 'test', 'modified': False},
+ {'default': True, 'type': 'list', 'name': 'Spec2/item5', 'value': ['a', 'b'], 'modified': False},
+ {'default': True, 'type': 'string', 'name': 'Spec2/item6/value1', 'value': 'default', 'modified': False},
+ {'default': False, 'type': 'integer', 'name': 'Spec2/item6/value2', 'value': None, 'modified': False}], maps)
maps = self.mcd.get_value_maps("Spec2")
- self.assertEqual([{'default': False, 'type': 'integer', 'name': 'item1', 'value': 2, 'modified': False},
- {'default': True, 'type': 'real', 'name': 'item2', 'value': 1.1, 'modified': False},
- {'default': False, 'type': 'boolean', 'name': 'item3', 'value': False, 'modified': True},
- {'default': True, 'type': 'string', 'name': 'item4', 'value': 'test', 'modified': False},
- {'default': True, 'type': 'list', 'name': 'item5', 'value': ['a', 'b'], 'modified': False},
- {'default': True, 'type': 'map', 'name': 'item6', 'value': {}, 'modified': False}], maps)
+ self.assertEqual([{'default': False, 'type': 'integer', 'name': 'Spec2/item1', 'value': 2, 'modified': False},
+ {'default': True, 'type': 'real', 'name': 'Spec2/item2', 'value': 1.1, 'modified': False},
+ {'default': False, 'type': 'boolean', 'name': 'Spec2/item3', 'value': False, 'modified': True},
+ {'default': True, 'type': 'string', 'name': 'Spec2/item4', 'value': 'test', 'modified': False},
+ {'default': True, 'type': 'list', 'name': 'Spec2/item5', 'value': ['a', 'b'], 'modified': False},
+ {'default': True, 'type': 'string', 'name': 'Spec2/item6/value1', 'value': 'default', 'modified': False},
+ {'default': False, 'type': 'integer', 'name': 'Spec2/item6/value2', 'value': None, 'modified': False}], maps)
maps = self.mcd.get_value_maps("/Spec2/item5")
- self.assertEqual([{'default': False, 'type': 'string', 'name': 'list_element', 'value': 'a', 'modified': False},
- {'default': False, 'type': 'string', 'name': 'list_element', 'value': 'b', 'modified': False}], maps)
+ self.assertEqual([{'default': True, 'type': 'string', 'name': 'Spec2/item5[0]', 'value': 'a', 'modified': False},
+ {'default': True, 'type': 'string', 'name': 'Spec2/item5[1]', 'value': 'b', 'modified': False}], maps)
maps = self.mcd.get_value_maps("/Spec2/item5[0]")
- self.assertEqual([{'default': True, 'modified': False, 'name': 'list_element', 'type': 'string', 'value': 'a'}], maps)
+ self.assertEqual([{'default': True, 'modified': False, 'name': 'Spec2/item5[0]', 'type': 'string', 'value': 'a'}], maps)
maps = self.mcd.get_value_maps("/Spec2/item1")
- self.assertEqual([{'default': False, 'type': 'integer', 'name': 'item1', 'value': 2, 'modified': False}], maps)
+ self.assertEqual([{'default': False, 'type': 'integer', 'name': 'Spec2/item1', 'value': 2, 'modified': False}], maps)
maps = self.mcd.get_value_maps("/Spec2/item2")
- self.assertEqual([{'default': True, 'type': 'real', 'name': 'item2', 'value': 1.1, 'modified': False}], maps)
+ self.assertEqual([{'default': True, 'type': 'real', 'name': 'Spec2/item2', 'value': 1.1, 'modified': False}], maps)
maps = self.mcd.get_value_maps("/Spec2/item3")
- self.assertEqual([{'default': False, 'type': 'boolean', 'name': 'item3', 'value': False, 'modified': True}], maps)
+ self.assertEqual([{'default': False, 'type': 'boolean', 'name': 'Spec2/item3', 'value': False, 'modified': True}], maps)
maps = self.mcd.get_value_maps("/Spec2/item4")
- self.assertEqual([{'default': True, 'type': 'string', 'name': 'item4', 'value': 'test', 'modified': False}], maps)
+ self.assertEqual([{'default': True, 'type': 'string', 'name': 'Spec2/item4', 'value': 'test', 'modified': False}], maps)
module_spec = isc.config.module_spec_from_file(self.data_path + os.sep + "spec24.spec")
self.mcd.set_specification(module_spec)
@@ -456,9 +469,30 @@ class TestMultiConfigData(unittest.TestCase):
self.assertEqual([], maps)
self.mcd._set_current_config({ "Spec24": { "item": [] } })
maps = self.mcd.get_value_maps("/Spec24/item")
- self.assertEqual([], maps)
-
+ self.assertEqual([{'default': False, 'modified': False, 'name': 'Spec24/item', 'type': 'list', 'value': []}], maps)
+ module_spec = isc.config.module_spec_from_file(self.data_path + os.sep + "spec22.spec")
+ self.mcd.set_specification(module_spec)
+ expected = [{'default': True,
+ 'modified': False,
+ 'name': 'Spec22/value9/v91',
+ 'type': 'string',
+ 'value': 'def'},
+ {'default': True,
+ 'modified': False,
+ 'name': 'Spec22/value9/v92/v92a',
+ 'type': 'string',
+ 'value': 'Hello'
+ },
+ {'default': True,
+ 'modified': False,
+ 'name': 'Spec22/value9/v92/v92b',
+ 'type': 'integer',
+ 'value': 47806
+ }
+ ]
+ maps = self.mcd.get_value_maps("/Spec22/value9")
+ self.assertEqual(expected, maps)
def test_set_value(self):
module_spec = isc.config.module_spec_from_file(self.data_path + os.sep + "spec2.spec")
diff --git a/src/lib/python/isc/notify/tests/notify_out_test.py b/src/lib/python/isc/notify/tests/notify_out_test.py
index 0816e07..c4c149c 100644
--- a/src/lib/python/isc/notify/tests/notify_out_test.py
+++ b/src/lib/python/isc/notify/tests/notify_out_test.py
@@ -22,9 +22,45 @@ import socket
from isc.datasrc import sqlite3_ds
from isc.notify import notify_out, SOCK_DATA
+# our fake socket, where we can read and insert messages
+class MockSocket():
+ def __init__(self, family, type):
+ self.family = family
+ self.type = type
+ self._local_sock, self._remote_sock = socket.socketpair()
+
+ def connect(self, to):
+ pass
+
+ def fileno(self):
+ return self._local_sock.fileno()
+
+ def close(self):
+ self._local_sock.close()
+ self._remote_sock.close()
+
+ def sendto(self, data, flag, dst):
+ return self._local_sock.send(data)
+
+ def recvfrom(self, length):
+ data = self._local_sock.recv(length)
+ return (data, None)
+
+ # provide a remote end which can write data to MockSocket for testing.
+ def remote_end(self):
+ return self._remote_sock
+
+# We subclass the ZoneNotifyInfo class we're testing here, only
+# to override the prepare_notify_out() method.
+class MockZoneNotifyInfo(notify_out.ZoneNotifyInfo):
+ def prepare_notify_out(self):
+ super().prepare_notify_out();
+ self._sock.close()
+ self._sock = MockSocket(socket.AF_INET, socket.SOCK_DGRAM)
+
class TestZoneNotifyInfo(unittest.TestCase):
def setUp(self):
- self.info = notify_out.ZoneNotifyInfo('cn.', 'IN')
+ self.info = notify_out.ZoneNotifyInfo('example.net.', 'IN')
def test_prepare_finish_notify_out(self):
self.info.prepare_notify_out()
@@ -46,7 +82,7 @@ class TestZoneNotifyInfo(unittest.TestCase):
self.info.set_next_notify_target()
self.assertIsNone(self.info.get_current_notify_target())
- temp_info = notify_out.ZoneNotifyInfo('com.', 'IN')
+ temp_info = notify_out.ZoneNotifyInfo('example.com.', 'IN')
temp_info.prepare_notify_out()
self.assertIsNone(temp_info.get_current_notify_target())
@@ -54,16 +90,16 @@ class TestZoneNotifyInfo(unittest.TestCase):
class TestNotifyOut(unittest.TestCase):
def setUp(self):
self._db_file = tempfile.NamedTemporaryFile(delete=False)
- sqlite3_ds.load(self._db_file.name, 'cn.', self._cn_data_reader)
- sqlite3_ds.load(self._db_file.name, 'com.', self._com_data_reader)
+ sqlite3_ds.load(self._db_file.name, 'example.net.', self._example_net_data_reader)
+ sqlite3_ds.load(self._db_file.name, 'example.com.', self._example_com_data_reader)
self._notify = notify_out.NotifyOut(self._db_file.name)
- self._notify._notify_infos[('com.', 'IN')] = notify_out.ZoneNotifyInfo('com.', 'IN')
- self._notify._notify_infos[('com.', 'CH')] = notify_out.ZoneNotifyInfo('com.', 'CH')
- self._notify._notify_infos[('cn.', 'IN')] = notify_out.ZoneNotifyInfo('cn.', 'IN')
- self._notify._notify_infos[('org.', 'IN')] = notify_out.ZoneNotifyInfo('org.', 'IN')
- self._notify._notify_infos[('org.', 'CH')] = notify_out.ZoneNotifyInfo('org.', 'CH')
-
- info = self._notify._notify_infos[('cn.', 'IN')]
+ self._notify._notify_infos[('example.com.', 'IN')] = MockZoneNotifyInfo('example.com.', 'IN')
+ self._notify._notify_infos[('example.com.', 'CH')] = MockZoneNotifyInfo('example.com.', 'CH')
+ self._notify._notify_infos[('example.net.', 'IN')] = MockZoneNotifyInfo('example.net.', 'IN')
+ self._notify._notify_infos[('example.org.', 'IN')] = MockZoneNotifyInfo('example.org.', 'IN')
+ self._notify._notify_infos[('example.org.', 'CH')] = MockZoneNotifyInfo('example.org.', 'CH')
+
+ info = self._notify._notify_infos[('example.net.', 'IN')]
info.notify_slaves.append(('127.0.0.1', 53))
info.notify_slaves.append(('1.1.1.1', 5353))
@@ -72,62 +108,59 @@ class TestNotifyOut(unittest.TestCase):
os.unlink(self._db_file.name)
def test_send_notify(self):
- self._notify.send_notify('cn')
+ self._notify.send_notify('example.net')
self.assertEqual(self._notify.notify_num, 1)
- self.assertEqual(self._notify._notifying_zones[0], ('cn.','IN'))
+ self.assertEqual(self._notify._notifying_zones[0], ('example.net.','IN'))
- self._notify.send_notify('com')
+ self._notify.send_notify('example.com')
self.assertEqual(self._notify.notify_num, 2)
- self.assertEqual(self._notify._notifying_zones[1], ('com.','IN'))
+ self.assertEqual(self._notify._notifying_zones[1], ('example.com.','IN'))
notify_out._MAX_NOTIFY_NUM = 3
- self._notify.send_notify('com', 'CH')
+ self._notify.send_notify('example.com', 'CH')
self.assertEqual(self._notify.notify_num, 3)
- self.assertEqual(self._notify._notifying_zones[2], ('com.','CH'))
-
- self._notify.send_notify('org.')
- self.assertEqual(self._notify._waiting_zones[0], ('org.', 'IN'))
- self._notify.send_notify('org.')
+ self.assertEqual(self._notify._notifying_zones[2], ('example.com.','CH'))
+
+ self._notify.send_notify('example.org.')
+ self.assertEqual(self._notify._waiting_zones[0], ('example.org.', 'IN'))
+ self._notify.send_notify('example.org.')
self.assertEqual(1, len(self._notify._waiting_zones))
- self._notify.send_notify('org.', 'CH')
+ self._notify.send_notify('example.org.', 'CH')
self.assertEqual(2, len(self._notify._waiting_zones))
- self.assertEqual(self._notify._waiting_zones[1], ('org.', 'CH'))
+ self.assertEqual(self._notify._waiting_zones[1], ('example.org.', 'CH'))
def test_wait_for_notify_reply(self):
- self._notify.send_notify('cn.')
- self._notify.send_notify('com.')
-
+ self._notify.send_notify('example.net.')
+ self._notify.send_notify('example.com.')
+
notify_out._MAX_NOTIFY_NUM = 2
- self._notify.send_notify('org.')
+ self._notify.send_notify('example.org.')
replied_zones, timeout_zones = self._notify._wait_for_notify_reply()
self.assertEqual(len(replied_zones), 0)
self.assertEqual(len(timeout_zones), 2)
# Now make one socket be readable
- addr = ('localhost', 12340)
- self._notify._notify_infos[('cn.', 'IN')]._sock.bind(addr)
- self._notify._notify_infos[('cn.', 'IN')].notify_timeout = time.time() + 10
- self._notify._notify_infos[('com.', 'IN')].notify_timeout = time.time() + 10
-
- send_fd = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+ self._notify._notify_infos[('example.net.', 'IN')].notify_timeout = time.time() + 10
+ self._notify._notify_infos[('example.com.', 'IN')].notify_timeout = time.time() + 10
+
#Send some data to socket 12340, to make the target socket be readable
- send_fd.sendto(b'data', addr)
+ self._notify._notify_infos[('example.net.', 'IN')]._sock.remote_end().send(b'data')
replied_zones, timeout_zones = self._notify._wait_for_notify_reply()
self.assertEqual(len(replied_zones), 1)
self.assertEqual(len(timeout_zones), 1)
- self.assertTrue(('cn.', 'IN') in replied_zones.keys())
- self.assertTrue(('com.', 'IN') in timeout_zones.keys())
- self.assertLess(time.time(), self._notify._notify_infos[('com.', 'IN')].notify_timeout)
-
+ self.assertTrue(('example.net.', 'IN') in replied_zones.keys())
+ self.assertTrue(('example.com.', 'IN') in timeout_zones.keys())
+ self.assertLess(time.time(), self._notify._notify_infos[('example.com.', 'IN')].notify_timeout)
+
def test_wait_for_notify_reply_2(self):
# Test the returned value when the read_side socket is readable.
- self._notify.send_notify('cn.')
- self._notify.send_notify('com.')
+ self._notify.send_notify('example.net.')
+ self._notify.send_notify('example.com.')
# Now make one socket be readable
- self._notify._notify_infos[('cn.', 'IN')].notify_timeout = time.time() + 10
- self._notify._notify_infos[('com.', 'IN')].notify_timeout = time.time() + 10
+ self._notify._notify_infos[('example.net.', 'IN')].notify_timeout = time.time() + 10
+ self._notify._notify_infos[('example.com.', 'IN')].notify_timeout = time.time() + 10
self._notify._read_sock, self._notify._write_sock = socket.socketpair()
self._notify._write_sock.send(SOCK_DATA)
replied_zones, timeout_zones = self._notify._wait_for_notify_reply()
@@ -135,13 +168,13 @@ class TestNotifyOut(unittest.TestCase):
self.assertEqual(0, len(timeout_zones))
def test_notify_next_target(self):
- self._notify.send_notify('cn.')
- self._notify.send_notify('com.')
+ self._notify.send_notify('example.net.')
+ self._notify.send_notify('example.com.')
notify_out._MAX_NOTIFY_NUM = 2
- self._notify.send_notify('org.')
- self._notify.send_notify('com.', 'CH')
+ self._notify.send_notify('example.org.')
+ self._notify.send_notify('example.com.', 'CH')
- info = self._notify._notify_infos[('cn.', 'IN')]
+ info = self._notify._notify_infos[('example.net.', 'IN')]
self._notify._notify_next_target(info)
self.assertEqual(0, info.notify_try_num)
self.assertEqual(info.get_current_notify_target(), ('1.1.1.1', 5353))
@@ -153,101 +186,101 @@ class TestNotifyOut(unittest.TestCase):
self.assertEqual(2, self._notify.notify_num)
self.assertEqual(1, len(self._notify._waiting_zones))
- com_info = self._notify._notify_infos[('com.', 'IN')]
- self._notify._notify_next_target(com_info)
+ example_com_info = self._notify._notify_infos[('example.com.', 'IN')]
+ self._notify._notify_next_target(example_com_info)
self.assertEqual(2, self._notify.notify_num)
self.assertEqual(2, len(self._notify._notifying_zones))
-
+
def test_handle_notify_reply(self):
self.assertEqual(notify_out._BAD_REPLY_PACKET, self._notify._handle_notify_reply(None, b'badmsg'))
- com_info = self._notify._notify_infos[('com.', 'IN')]
- com_info.notify_msg_id = 0X2f18
+ example_com_info = self._notify._notify_infos[('example.com.', 'IN')]
+ example_com_info.notify_msg_id = 0X2f18
# test with right notify reply message
- data = b'\x2f\x18\xa0\x00\x00\x01\x00\x00\x00\x00\x00\x00\x03com\x00\x00\x06\x00\x01'
- self.assertEqual(notify_out._REPLY_OK, self._notify._handle_notify_reply(com_info, data))
+ data = b'\x2f\x18\xa0\x00\x00\x01\x00\x00\x00\x00\x00\x00\x07example\03com\x00\x00\x06\x00\x01'
+ self.assertEqual(notify_out._REPLY_OK, self._notify._handle_notify_reply(example_com_info, data))
# test with unright query id
- data = b'\x2e\x18\xa0\x00\x00\x01\x00\x00\x00\x00\x00\x00\x03com\x00\x00\x06\x00\x01'
- self.assertEqual(notify_out._BAD_QUERY_ID, self._notify._handle_notify_reply(com_info, data))
+ data = b'\x2e\x18\xa0\x00\x00\x01\x00\x00\x00\x00\x00\x00\x07example\03com\x00\x00\x06\x00\x01'
+ self.assertEqual(notify_out._BAD_QUERY_ID, self._notify._handle_notify_reply(example_com_info, data))
# test with unright query name
- data = b'\x2f\x18\xa0\x00\x00\x01\x00\x00\x00\x00\x00\x00\x02cn\x00\x00\x06\x00\x01'
- self.assertEqual(notify_out._BAD_QUERY_NAME, self._notify._handle_notify_reply(com_info, data))
+ data = b'\x2f\x18\xa0\x00\x00\x01\x00\x00\x00\x00\x00\x00\x07example\03net\x00\x00\x06\x00\x01'
+ self.assertEqual(notify_out._BAD_QUERY_NAME, self._notify._handle_notify_reply(example_com_info, data))
# test with unright opcode
- data = b'\x2f\x18\x80\x00\x00\x01\x00\x00\x00\x00\x00\x00\x03com\x00\x00\x06\x00\x01'
- self.assertEqual(notify_out._BAD_OPCODE, self._notify._handle_notify_reply(com_info, data))
+ data = b'\x2f\x18\x80\x00\x00\x01\x00\x00\x00\x00\x00\x00\x07example\03com\x00\x00\x06\x00\x01'
+ self.assertEqual(notify_out._BAD_OPCODE, self._notify._handle_notify_reply(example_com_info, data))
# test with unright qr
- data = b'\x2f\x18\x10\x10\x00\x01\x00\x00\x00\x00\x00\x00\x03com\x00\x00\x06\x00\x01'
- self.assertEqual(notify_out._BAD_QR, self._notify._handle_notify_reply(com_info, data))
+ data = b'\x2f\x18\x10\x10\x00\x01\x00\x00\x00\x00\x00\x00\x07example\03com\x00\x00\x06\x00\x01'
+ self.assertEqual(notify_out._BAD_QR, self._notify._handle_notify_reply(example_com_info, data))
def test_send_notify_message_udp(self):
- com_info = self._notify._notify_infos[('cn.', 'IN')]
- com_info.prepare_notify_out()
- ret = self._notify._send_notify_message_udp(com_info, ('1.1.1.1', 53))
+ example_com_info = self._notify._notify_infos[('example.net.', 'IN')]
+ example_com_info.prepare_notify_out()
+ ret = self._notify._send_notify_message_udp(example_com_info, ('1.1.1.1', 53))
self.assertTrue(ret)
def test_zone_notify_handler(self):
old_send_msg = self._notify._send_notify_message_udp
- def _fake_send_notify_message_udp(va1, va2):
+ def _fake_send_notify_message_udp(va1, va2):
pass
self._notify._send_notify_message_udp = _fake_send_notify_message_udp
- self._notify.send_notify('cn.')
- self._notify.send_notify('com.')
+ self._notify.send_notify('example.net.')
+ self._notify.send_notify('example.com.')
notify_out._MAX_NOTIFY_NUM = 2
- self._notify.send_notify('org.')
+ self._notify.send_notify('example.org.')
- cn_info = self._notify._notify_infos[('cn.', 'IN')]
- cn_info.prepare_notify_out()
+ example_net_info = self._notify._notify_infos[('example.net.', 'IN')]
+ example_net_info.prepare_notify_out()
- cn_info.notify_try_num = 2
- self._notify._zone_notify_handler(cn_info, notify_out._EVENT_TIMEOUT)
- self.assertEqual(3, cn_info.notify_try_num)
+ example_net_info.notify_try_num = 2
+ self._notify._zone_notify_handler(example_net_info, notify_out._EVENT_TIMEOUT)
+ self.assertEqual(3, example_net_info.notify_try_num)
- time1 = cn_info.notify_timeout
- self._notify._zone_notify_handler(cn_info, notify_out._EVENT_TIMEOUT)
- self.assertEqual(4, cn_info.notify_try_num)
- self.assertGreater(cn_info.notify_timeout, time1 + 2) # bigger than 2 seconds
+ time1 = example_net_info.notify_timeout
+ self._notify._zone_notify_handler(example_net_info, notify_out._EVENT_TIMEOUT)
+ self.assertEqual(4, example_net_info.notify_try_num)
+ self.assertGreater(example_net_info.notify_timeout, time1 + 2) # bigger than 2 seconds
- cur_tgt = cn_info._notify_current
- cn_info.notify_try_num = notify_out._MAX_NOTIFY_TRY_NUM
- self._notify._zone_notify_handler(cn_info, notify_out._EVENT_NONE)
- self.assertNotEqual(cur_tgt, cn_info._notify_current)
+ cur_tgt = example_net_info._notify_current
+ example_net_info.notify_try_num = notify_out._MAX_NOTIFY_TRY_NUM
+ self._notify._zone_notify_handler(example_net_info, notify_out._EVENT_NONE)
+ self.assertNotEqual(cur_tgt, example_net_info._notify_current)
- def _cn_data_reader(self):
+ def _example_net_data_reader(self):
zone_data = [
- ('cn.', '1000', 'IN', 'SOA', 'a.dns.cn. mail.cn. 1 1 1 1 1'),
- ('cn.', '1000', 'IN', 'NS', 'a.dns.cn.'),
- ('cn.', '1000', 'IN', 'NS', 'b.dns.cn.'),
- ('cn.', '1000', 'IN', 'NS', 'c.dns.cn.'),
- ('a.dns.cn.', '1000', 'IN', 'A', '1.1.1.1'),
- ('a.dns.cn.', '1000', 'IN', 'AAAA', '2:2::2:2'),
- ('b.dns.cn.', '1000', 'IN', 'A', '3.3.3.3'),
- ('b.dns.cn.', '1000', 'IN', 'AAAA', '4:4::4:4'),
- ('b.dns.cn.', '1000', 'IN', 'AAAA', '5:5::5:5'),
- ('c.dns.cn.', '1000', 'IN', 'A', '6.6.6.6'),
- ('c.dns.cn.', '1000', 'IN', 'A', '7.7.7.7'),
- ('c.dns.cn.', '1000', 'IN', 'AAAA', '8:8::8:8')]
+ ('example.net.', '1000', 'IN', 'SOA', 'a.dns.example.net. mail.example.net. 1 1 1 1 1'),
+ ('example.net.', '1000', 'IN', 'NS', 'a.dns.example.net.'),
+ ('example.net.', '1000', 'IN', 'NS', 'b.dns.example.net.'),
+ ('example.net.', '1000', 'IN', 'NS', 'c.dns.example.net.'),
+ ('a.dns.example.net.', '1000', 'IN', 'A', '1.1.1.1'),
+ ('a.dns.example.net.', '1000', 'IN', 'AAAA', '2:2::2:2'),
+ ('b.dns.example.net.', '1000', 'IN', 'A', '3.3.3.3'),
+ ('b.dns.example.net.', '1000', 'IN', 'AAAA', '4:4::4:4'),
+ ('b.dns.example.net.', '1000', 'IN', 'AAAA', '5:5::5:5'),
+ ('c.dns.example.net.', '1000', 'IN', 'A', '6.6.6.6'),
+ ('c.dns.example.net.', '1000', 'IN', 'A', '7.7.7.7'),
+ ('c.dns.example.net.', '1000', 'IN', 'AAAA', '8:8::8:8')]
for item in zone_data:
yield item
- def _com_data_reader(self):
+ def _example_com_data_reader(self):
zone_data = [
- ('com.', '1000', 'IN', 'SOA', 'a.dns.com. mail.com. 1 1 1 1 1'),
- ('com.', '1000', 'IN', 'NS', 'a.dns.com.'),
- ('com.', '1000', 'IN', 'NS', 'b.dns.com.'),
- ('com.', '1000', 'IN', 'NS', 'c.dns.com.'),
- ('a.dns.com.', '1000', 'IN', 'A', '1.1.1.1'),
- ('b.dns.com.', '1000', 'IN', 'A', '3.3.3.3'),
- ('b.dns.com.', '1000', 'IN', 'AAAA', '4:4::4:4'),
- ('b.dns.com.', '1000', 'IN', 'AAAA', '5:5::5:5')]
+ ('example.com.', '1000', 'IN', 'SOA', 'a.dns.example.com. mail.example.com. 1 1 1 1 1'),
+ ('example.com.', '1000', 'IN', 'NS', 'a.dns.example.com.'),
+ ('example.com.', '1000', 'IN', 'NS', 'b.dns.example.com.'),
+ ('example.com.', '1000', 'IN', 'NS', 'c.dns.example.com.'),
+ ('a.dns.example.com.', '1000', 'IN', 'A', '1.1.1.1'),
+ ('b.dns.example.com.', '1000', 'IN', 'A', '3.3.3.3'),
+ ('b.dns.example.com.', '1000', 'IN', 'AAAA', '4:4::4:4'),
+ ('b.dns.example.com.', '1000', 'IN', 'AAAA', '5:5::5:5')]
for item in zone_data:
yield item
def test_get_notify_slaves_from_ns(self):
- records = self._notify._get_notify_slaves_from_ns('cn.')
+ records = self._notify._get_notify_slaves_from_ns('example.net.')
self.assertEqual(6, len(records))
self.assertEqual('8:8::8:8', records[5])
self.assertEqual('7.7.7.7', records[4])
@@ -256,36 +289,36 @@ class TestNotifyOut(unittest.TestCase):
self.assertEqual('4:4::4:4', records[1])
self.assertEqual('3.3.3.3', records[0])
- records = self._notify._get_notify_slaves_from_ns('com.')
+ records = self._notify._get_notify_slaves_from_ns('example.com.')
self.assertEqual(3, len(records))
self.assertEqual('5:5::5:5', records[2])
self.assertEqual('4:4::4:4', records[1])
self.assertEqual('3.3.3.3', records[0])
-
+
def test_init_notify_out(self):
self._notify._init_notify_out(self._db_file.name)
- self.assertListEqual([('3.3.3.3', 53), ('4:4::4:4', 53), ('5:5::5:5', 53)],
- self._notify._notify_infos[('com.', 'IN')].notify_slaves)
-
+ self.assertListEqual([('3.3.3.3', 53), ('4:4::4:4', 53), ('5:5::5:5', 53)],
+ self._notify._notify_infos[('example.com.', 'IN')].notify_slaves)
+
def test_prepare_select_info(self):
timeout, valid_fds, notifying_zones = self._notify._prepare_select_info()
self.assertEqual(notify_out._IDLE_SLEEP_TIME, timeout)
self.assertListEqual([], valid_fds)
- self._notify._notify_infos[('cn.', 'IN')]._sock = 1
- self._notify._notify_infos[('cn.', 'IN')].notify_timeout = time.time() + 5
+ self._notify._notify_infos[('example.net.', 'IN')]._sock = 1
+ self._notify._notify_infos[('example.net.', 'IN')].notify_timeout = time.time() + 5
timeout, valid_fds, notifying_zones = self._notify._prepare_select_info()
self.assertGreater(timeout, 0)
self.assertListEqual([1], valid_fds)
- self._notify._notify_infos[('cn.', 'IN')]._sock = 1
- self._notify._notify_infos[('cn.', 'IN')].notify_timeout = time.time() - 5
+ self._notify._notify_infos[('example.net.', 'IN')]._sock = 1
+ self._notify._notify_infos[('example.net.', 'IN')].notify_timeout = time.time() - 5
timeout, valid_fds, notifying_zones = self._notify._prepare_select_info()
self.assertEqual(timeout, 0)
self.assertListEqual([1], valid_fds)
- self._notify._notify_infos[('com.', 'IN')]._sock = 2
- self._notify._notify_infos[('com.', 'IN')].notify_timeout = time.time() + 5
+ self._notify._notify_infos[('example.com.', 'IN')]._sock = 2
+ self._notify._notify_infos[('example.com.', 'IN')].notify_timeout = time.time() + 5
timeout, valid_fds, notifying_zones = self._notify._prepare_select_info()
self.assertEqual(timeout, 0)
self.assertListEqual([2, 1], valid_fds)
diff --git a/src/lib/python/isc/util/socketserver_mixin.py b/src/lib/python/isc/util/socketserver_mixin.py
index fb5f9a2..e954fe1 100644
--- a/src/lib/python/isc/util/socketserver_mixin.py
+++ b/src/lib/python/isc/util/socketserver_mixin.py
@@ -64,7 +64,7 @@ class NoPollMixIn:
called in anther thread. Note, parameter 'poll_interval' is
just used for interface compatibility; it's never used in this
function.
- '''
+ '''
while True:
# block until the self.socket or self.__read_sock is readable
try:
@@ -74,11 +74,11 @@ class NoPollMixIn:
continue
else:
break
-
+
if self.__read_sock in r:
break
else:
- self._handle_request_noblock()
+ self._handle_request_noblock();
self._is_shut_down.set()
diff --git a/src/lib/python/isc/util/tests/socketserver_mixin_test.py b/src/lib/python/isc/util/tests/socketserver_mixin_test.py
index 61bc248..a6686d8 100644
--- a/src/lib/python/isc/util/tests/socketserver_mixin_test.py
+++ b/src/lib/python/isc/util/tests/socketserver_mixin_test.py
@@ -25,7 +25,7 @@ class MyHandler(socketserver.BaseRequestHandler):
data = self.request.recv(20)
self.request.send(data)
-class MyServer(NoPollMixIn,
+class MyServer(NoPollMixIn,
socketserver.ThreadingMixIn,
socketserver.TCPServer):
diff --git a/src/lib/python/isc/utils/Makefile.am b/src/lib/python/isc/utils/Makefile.am
deleted file mode 100644
index 65a39ad..0000000
--- a/src/lib/python/isc/utils/Makefile.am
+++ /dev/null
@@ -1,5 +0,0 @@
-SUBDIRS = tests
-
-python_PYTHON = __init__.py process.py
-
-pythondir = $(pyexecdir)/isc/utils
diff --git a/src/lib/python/isc/utils/__init__.py b/src/lib/python/isc/utils/__init__.py
deleted file mode 100644
index e69de29..0000000
diff --git a/src/lib/python/isc/utils/process.py b/src/lib/python/isc/utils/process.py
deleted file mode 100644
index 25775af..0000000
--- a/src/lib/python/isc/utils/process.py
+++ /dev/null
@@ -1,37 +0,0 @@
-# Copyright (C) 2010 CZ NIC
-#
-# Permission to use, copy, modify, and distribute this software for any
-# purpose with or without fee is hereby granted, provided that the above
-# copyright notice and this permission notice appear in all copies.
-#
-# THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SYSTEMS CONSORTIUM
-# DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
-# INTERNET SYSTEMS CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
-# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
-# FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
-# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
-# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-
-"""
-Module to manipulate the python processes.
-
-It contains only function to rename the process, which is currently
-wrapper around setproctitle library. Does not fail if the setproctitle
-module is missing, but does nothing in that case.
-"""
-try:
- from setproctitle import setproctitle
-except ImportError:
- def setproctitle(_): pass
-import sys
-import os.path
-
-"""
-Rename the current process to given name (so it can be found in ps).
-If name is None, use zero'th command line argument.
-"""
-def rename(name=None):
- if name is None:
- name = os.path.basename(sys.argv[0])
- setproctitle(name)
diff --git a/src/lib/python/isc/utils/tests/Makefile.am b/src/lib/python/isc/utils/tests/Makefile.am
deleted file mode 100644
index e58b5b6..0000000
--- a/src/lib/python/isc/utils/tests/Makefile.am
+++ /dev/null
@@ -1,16 +0,0 @@
-PYCOVERAGE_RUN = @PYCOVERAGE_RUN@
-PYTESTS = process_test.py
-EXTRA_DIST = $(PYTESTS)
-
-# test using command-line arguments, so use check-local target instead of TESTS
-check-local:
-if ENABLE_PYTHON_COVERAGE
- touch $(abs_top_srcdir)/.coverage
- rm -f .coverage
- ${LN_S} $(abs_top_srcdir)/.coverage .coverage
-endif
- for pytest in $(PYTESTS) ; do \
- echo Running test: $$pytest ; \
- env PYTHONPATH=$(abs_top_srcdir)/src/lib/python:$(abs_top_builddir)/src/lib/python:$(abs_top_builddir)/src/lib/dns/python/.libs \
- $(PYCOVERAGE_RUN) $(abs_srcdir)/$$pytest || exit ; \
- done
diff --git a/src/lib/python/isc/utils/tests/process_test.py b/src/lib/python/isc/utils/tests/process_test.py
deleted file mode 100644
index 0e7c8b1..0000000
--- a/src/lib/python/isc/utils/tests/process_test.py
+++ /dev/null
@@ -1,39 +0,0 @@
-# Copyright (C) 2010 CZ NIC
-#
-# Permission to use, copy, modify, and distribute this software for any
-# purpose with or without fee is hereby granted, provided that the above
-# copyright notice and this permission notice appear in all copies.
-#
-# THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SYSTEMS CONSORTIUM
-# DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
-# INTERNET SYSTEMS CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
-# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
-# FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
-# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
-# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-
-"""Tests for isc.utils.process."""
-import unittest
-import isc.utils.process
-run_tests = True
-try:
- import setproctitle
-except ImportError:
- run_tests = False
-
-class TestRename(unittest.TestCase):
- """Testcase for isc.process.rename."""
- def __get_self_name(self):
- return setproctitle.getproctitle()
-
- @unittest.skipIf(not run_tests, "Setproctitle not installed, not testing")
- def test_rename(self):
- """Test if the renaming function works."""
- isc.utils.process.rename("rename-test")
- self.assertEqual("rename-test", self.__get_self_name())
- isc.utils.process.rename()
- self.assertEqual("process_test.py", self.__get_self_name())
-
-if __name__ == "__main__":
- unittest.main()
diff --git a/src/lib/resolve/resolve.cc b/src/lib/resolve/resolve.cc
index 312c89d..f741121 100644
--- a/src/lib/resolve/resolve.cc
+++ b/src/lib/resolve/resolve.cc
@@ -14,6 +14,9 @@
#include <resolve/resolve.h>
+#include <dns/message.h>
+#include <dns/opcode.h>
+
using namespace isc::dns;
namespace {
@@ -44,6 +47,23 @@ makeErrorMessage(MessagePtr answer_message,
answer_message->setRcode(error_code);
}
+void initResponseMessage(const isc::dns::Message& query_message,
+ isc::dns::Message& response_message)
+{
+ response_message.setOpcode(query_message.getOpcode());
+ response_message.setQid(query_message.getQid());
+ assert(response_message.getRRCount(Message::SECTION_QUESTION) == 0);
+ response_message.appendSection(Message::SECTION_QUESTION,
+ query_message);
+}
+
+void initResponseMessage(const isc::dns::Question& question,
+ isc::dns::Message& response_message)
+{
+ response_message.setOpcode(isc::dns::Opcode::QUERY());
+ response_message.addQuestion(question);
+}
+
void copyResponseMessage(const Message& source, MessagePtr target) {
target->setRcode(source.getRcode());
diff --git a/src/lib/resolve/resolve.h b/src/lib/resolve/resolve.h
index b08c30c..550b620 100644
--- a/src/lib/resolve/resolve.h
+++ b/src/lib/resolve/resolve.h
@@ -42,6 +42,42 @@ namespace resolve {
void makeErrorMessage(isc::dns::MessagePtr answer_message,
const isc::dns::Rcode& error_code);
+
+/// \brief Initialize a response message
+///
+/// Based on the given query message, this fills in the very
+/// first details of the response (i.e. the Question section and
+/// the Opcode). This allows for direct usage of makeErrorMessage(),
+/// as well as ResolveCache.lookup().
+///
+/// Raises an isc::dns::InvalidMessageOperation if reponse_message is
+/// not in RENDER mode.
+///
+/// \param query_message The query message to take the Question, Qid,
+/// and Opcode from.
+/// \param response_message The fresh response message to initialize
+/// (must be in RENDER mode)
+void initResponseMessage(const isc::dns::Message& query_message,
+ isc::dns::Message& response_message);
+
+
+/// \brief Initialize a response message
+///
+/// Based on the given question, this fills in the very
+/// first details of the response (i.e. the Question section and the
+/// Opcode Query). This allows for direct usage of makeErrorMessage(),
+/// as well as ResolveCache.lookup().
+///
+/// Raises an isc::dns::InvalidMessageOperation if reponse_message is
+/// not in RENDER mode.
+///
+/// \param question The question to place in the Question section
+/// \param response_message The fresh response message to initialize
+/// (must be in RENDER mode)
+void initResponseMessage(const isc::dns::Question& question,
+ isc::dns::Message& response_message);
+
+
/// \brief Copies the parts relevant for a DNS response to the
/// target message
///
diff --git a/src/lib/resolve/tests/Makefile.am b/src/lib/resolve/tests/Makefile.am
index 3b5f41a..e669384 100644
--- a/src/lib/resolve/tests/Makefile.am
+++ b/src/lib/resolve/tests/Makefile.am
@@ -19,6 +19,7 @@ run_unittests_SOURCES += resolver_callback_unittest.cc
run_unittests_SOURCES += response_classifier_unittest.cc
run_unittests_LDADD = $(GTEST_LDADD)
+run_unittests_LDADD += $(top_builddir)/src/lib/exceptions/libexceptions.la
run_unittests_LDADD += $(top_builddir)/src/lib/resolve/libresolve.la
run_unittests_LDADD += $(top_builddir)/src/lib/dns/libdns++.la
diff --git a/src/lib/resolve/tests/resolve_unittest.cc b/src/lib/resolve/tests/resolve_unittest.cc
index fd68f16..85d264d 100644
--- a/src/lib/resolve/tests/resolve_unittest.cc
+++ b/src/lib/resolve/tests/resolve_unittest.cc
@@ -122,21 +122,47 @@ TEST_F(ResolveHelperFunctionsTest, makeErrorMessageNonEmptyMessage) {
}
void
-compareSections(const MessagePtr message_a, const MessagePtr message_b,
+compareSections(const Message& message_a, const Message& message_b,
Message::Section section)
{
- RRsetIterator rrs_a = message_a->beginSection(section);
- RRsetIterator rrs_b = message_b->beginSection(section);
- while (rrs_a != message_a->endSection(section) &&
- rrs_b != message_b->endSection(section)
+ RRsetIterator rrs_a = message_a.beginSection(section);
+ RRsetIterator rrs_b = message_b.beginSection(section);
+ while (rrs_a != message_a.endSection(section) &&
+ rrs_b != message_b.endSection(section)
) {
EXPECT_EQ(*rrs_a, *rrs_b);
++rrs_a;
++rrs_b;
}
// can't use EXPECT_EQ here, no eqHelper for endsection comparison
- EXPECT_TRUE(rrs_a == message_a->endSection(section));
- EXPECT_TRUE(rrs_b == message_b->endSection(section));
+ EXPECT_TRUE(rrs_a == message_a.endSection(section));
+ EXPECT_TRUE(rrs_b == message_b.endSection(section));
+}
+
+TEST_F(ResolveHelperFunctionsTest, initResponseMessage) {
+ Message response_parse(Message::PARSE);
+ EXPECT_THROW(isc::resolve::initResponseMessage(*message_a_,
+ response_parse),
+ isc::dns::InvalidMessageOperation);
+ EXPECT_THROW(isc::resolve::initResponseMessage(*question_,
+ response_parse),
+ isc::dns::InvalidMessageOperation);
+
+ Message response1(Message::RENDER);
+ isc::resolve::initResponseMessage(*message_a_, response1);
+ ASSERT_EQ(message_a_->getOpcode(), response1.getOpcode());
+ ASSERT_EQ(message_a_->getQid(), response1.getQid());
+ isc::dns::QuestionIterator qi = response1.beginQuestion();
+ ASSERT_EQ(*question_, **qi);
+ ASSERT_TRUE(++qi == response1.endQuestion());
+
+ Message response2(Message::RENDER);
+ isc::resolve::initResponseMessage(*question_, response2);
+ ASSERT_EQ(Opcode::QUERY(), response2.getOpcode());
+ ASSERT_EQ(0, response2.getQid());
+ qi = response2.beginQuestion();
+ ASSERT_EQ(*question_, **qi);
+ ASSERT_TRUE(++qi == response2.endQuestion());
}
TEST_F(ResolveHelperFunctionsTest, copyAnswerMessage) {
@@ -164,9 +190,9 @@ TEST_F(ResolveHelperFunctionsTest, copyAnswerMessage) {
message_a_->getRRCount(Message::SECTION_ADDITIONAL));
- compareSections(message_a_, message_b_, Message::SECTION_ANSWER);
- compareSections(message_a_, message_b_, Message::SECTION_AUTHORITY);
- compareSections(message_a_, message_b_, Message::SECTION_ADDITIONAL);
+ compareSections(*message_a_, *message_b_, Message::SECTION_ANSWER);
+ compareSections(*message_a_, *message_b_, Message::SECTION_AUTHORITY);
+ compareSections(*message_a_, *message_b_, Message::SECTION_ADDITIONAL);
}
} // Anonymous namespace
diff --git a/src/lib/server_common/Makefile.am b/src/lib/server_common/Makefile.am
new file mode 100644
index 0000000..dfb3014
--- /dev/null
+++ b/src/lib/server_common/Makefile.am
@@ -0,0 +1,26 @@
+SUBDIRS = . tests
+
+AM_CPPFLAGS = -I$(top_srcdir)/src/lib -I$(top_builddir)/src/lib
+AM_CPPFLAGS += $(BOOST_INCLUDES)
+AM_CXXFLAGS = $(B10_CXXFLAGS)
+
+# Some versions of GCC warn about some versions of Boost regarding
+# missing initializer for members in its posix_time.
+# https://svn.boost.org/trac/boost/ticket/3477
+# But older GCC compilers don't have the flag.
+AM_CXXFLAGS += $(WARNING_NO_MISSING_FIELD_INITIALIZERS_CFLAG)
+
+if USE_CLANGPP
+# clang++ complains about unused function parameters in some boost header
+# files.
+AM_CXXFLAGS += -Wno-unused-parameter
+endif
+
+lib_LTLIBRARIES = libserver_common.la
+libserver_common_la_SOURCES = portconfig.h portconfig.cc
+libserver_common_la_LIBADD = $(top_builddir)/src/lib/exceptions/libexceptions.la
+libserver_common_la_LIBADD += $(top_builddir)/src/lib/asiolink/libasiolink.la
+libserver_common_la_LIBADD += $(top_builddir)/src/lib/cc/libcc.la
+libserver_common_la_LIBADD += $(top_builddir)/src/lib/log/liblog.la
+
+CLEANFILES = *.gcno *.gcda
diff --git a/src/lib/server_common/portconfig.cc b/src/lib/server_common/portconfig.cc
new file mode 100644
index 0000000..3765f52
--- /dev/null
+++ b/src/lib/server_common/portconfig.cc
@@ -0,0 +1,119 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#include <server_common/portconfig.h>
+
+#include <asiolink/io_address.h>
+#include <asiolink/dns_service.h>
+#include <log/dummylog.h>
+
+#include <boost/foreach.hpp>
+#include <boost/lexical_cast.hpp>
+
+using namespace std;
+using namespace isc::data;
+using namespace asiolink;
+using isc::log::dlog;
+
+namespace isc {
+namespace server_common {
+namespace portconfig {
+
+AddressList
+parseAddresses(isc::data::ConstElementPtr addresses,
+ const std::string& elemName)
+{
+ AddressList result;
+ if (addresses) {
+ if (addresses->getType() == Element::list) {
+ for (size_t i(0); i < addresses->size(); ++ i) {
+ ConstElementPtr addrPair(addresses->get(i));
+ ConstElementPtr addr(addrPair->get("address"));
+ ConstElementPtr port(addrPair->get("port"));
+ if (!addr || ! port) {
+ isc_throw(BadValue, "Address must contain both the IP"
+ "address and port");
+ }
+ try {
+ IOAddress(addr->stringValue());
+ if (port->intValue() < 0 ||
+ port->intValue() > 0xffff) {
+ isc_throw(BadValue, "Bad port value (" <<
+ port->intValue() << ")");
+ }
+ result.push_back(AddressPair(addr->stringValue(),
+ port->intValue()));
+ }
+ catch (const TypeError &e) { // Better error message
+ isc_throw(TypeError,
+ "Address must be a string and port an integer");
+ }
+ }
+ } else if (addresses->getType() != Element::null) {
+ isc_throw(TypeError, elemName + " config element must be a list");
+ }
+ }
+ return (result);
+}
+
+namespace {
+
+void
+setAddresses(DNSService& service, const AddressList& addresses) {
+ service.clearServers();
+ BOOST_FOREACH(const AddressPair &address, addresses) {
+ service.addServer(address.second, address.first);
+ }
+}
+
+}
+
+void
+installListenAddresses(const AddressList& newAddresses,
+ AddressList& addressStore,
+ asiolink::DNSService& service)
+{
+ try {
+ dlog("Setting listen addresses:");
+ BOOST_FOREACH(const AddressPair& addr, newAddresses) {
+ dlog(" " + addr.first + ":" +
+ boost::lexical_cast<string>(addr.second));
+ }
+ setAddresses(service, newAddresses);
+ addressStore = newAddresses;
+ }
+ catch (const exception& e) {
+ /*
+ * We couldn't set it. So return it back. If that fails as well,
+ * we have a problem.
+ *
+ * If that fails, bad luck, but we are useless anyway, so just die
+ * and let boss start us again.
+ */
+ dlog(string("Unable to set new address: ") + e.what(), true);
+ try {
+ setAddresses(service, addressStore);
+ }
+ catch (const exception& e2) {
+ dlog("Unable to recover from error;", true);
+ dlog(string("Rollback failed with: ") + e2.what(), true);
+ abort();
+ }
+ throw; // Let it fly a little bit further
+ }
+}
+
+}
+}
+}
diff --git a/src/lib/server_common/portconfig.h b/src/lib/server_common/portconfig.h
new file mode 100644
index 0000000..bcb8528
--- /dev/null
+++ b/src/lib/server_common/portconfig.h
@@ -0,0 +1,121 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#ifndef ISC_SERVER_COMMON_PORTCONFIG_H
+#define ISC_SERVER_COMMON_PORTCONFIG_H
+
+#include <utility>
+#include <string>
+#include <stdint.h>
+#include <vector>
+
+#include <cc/data.h>
+
+/*
+ * Some forward declarations.
+ */
+namespace asiolink {
+class DNSService;
+}
+
+namespace isc {
+namespace server_common {
+/**
+ * \brief Utilities to configure ports and addresses.
+ *
+ * Here are some utilities to help a server to parse configuration of addresses
+ * and ports and install the configuration.
+ */
+namespace portconfig {
+
+/**
+ * \brief An address-port pair.
+ *
+ * It is just a pair of string for an address and unsigned integer for port
+ * number. Anything more fancy would be an overkill, it is used only to pass
+ * the addresses and ports around as intermediate results.
+ */
+typedef std::pair<std::string, uint16_t> AddressPair;
+
+/// \brief Bunch of address pairs
+typedef std::vector<AddressPair> AddressList;
+
+/**
+ * \brief
+ *
+ * This parses a list of address-port configurations and returns them. The
+ * configuration looks like this:
+ *
+ * \verbatim
+[
+ {
+ "address": "192.0.2.1",
+ "port": 13
+ },
+ {
+ "address": "::",
+ "port": 80
+ }
+]
+ * \endverbatim
+ * \param addresses The configuration element to parse (the list). Empty list,
+ * null element and null pointer all mean empty list of addresses.
+ * \param elemName The name of the element, used to create descriptions for
+ * exceptions.
+ * \return Vector of parsed address-port pairs found in the configuration.
+ * \throw isc::data::TypeError if something in the configuration is of a wrong
+ * type (string passed to a port, element in the list that isn't hash,
+ * etc).
+ * \throw asiolink::IOError if the provided address string can't be parsed.
+ * \throw BadValue for other invalid configurations (missing port or address
+ * element in the hash, port number out of range).
+ * \throw std::bad_alloc when allocation fails.
+ */
+AddressList
+parseAddresses(isc::data::ConstElementPtr addresses,
+ const std::string& elemName);
+
+/**
+ * \brief Changes current listening addresses and ports.
+ *
+ * Removes all sockets we currently listen on and starts listening on the
+ * addresses and ports requested in newAddresses.
+ *
+ * If it fails to set up the new addresses, it attempts to roll back to the
+ * previous addresses (but it still propagates the exception). If the rollback
+ * fails as well, it aborts the application (it assumes if it can't listen
+ * on the new addresses nor on the old ones, the application is useless anyway
+ * and should be restarted by Boss, not to mention that the internal state is
+ * probably broken).
+ *
+ * \param newAddresses are the addresses you want to listen on.
+ * \param addressStore is the place you store your current addresses. It is
+ * used when there's a need for rollback. The newAddresses are copied here
+ * when the change is successful.
+ * \param dnsService is the DNSService object we use now. The requests from
+ * the new sockets are handled using this dnsService (and all current
+ * sockets on the service are closed first).
+ * \throw asiolink::IOError when initialization or closing of socket fails.
+ * \throw std::bad_alloc when allocation fails.
+ */
+void
+installListenAddresses(const AddressList& newAddresses,
+ AddressList& addressStore,
+ asiolink::DNSService& dnsService);
+
+}
+}
+}
+
+#endif
diff --git a/src/lib/server_common/tests/Makefile.am b/src/lib/server_common/tests/Makefile.am
new file mode 100644
index 0000000..22fe104
--- /dev/null
+++ b/src/lib/server_common/tests/Makefile.am
@@ -0,0 +1,38 @@
+AM_CPPFLAGS = -I$(top_builddir)/src/lib -I$(top_srcdir)/src/lib
+AM_CPPFLAGS += $(BOOST_INCLUDES)
+AM_CPPFLAGS += -I$(top_srcdir)/src/lib/server_common
+AM_CPPFLAGS += -I$(top_builddir)/src/lib/server_common
+AM_CXXFLAGS = $(B10_CXXFLAGS)
+
+AM_LDFLAGS =
+if USE_STATIC_LINK
+AM_LDFLAGS += -static
+endif
+
+# Some versions of GCC warn about some versions of Boost regarding
+# missing initializer for members in its posix_time.
+# https://svn.boost.org/trac/boost/ticket/3477
+# But older GCC compilers don't have the flag.
+AM_CXXFLAGS += $(WARNING_NO_MISSING_FIELD_INITIALIZERS_CFLAG)
+
+if USE_CLANGPP
+# see ../Makefile.am
+AM_CXXFLAGS += -Wno-unused-parameter
+endif
+
+CLEANFILES = *.gcno *.gcda
+
+TESTS =
+if HAVE_GTEST
+TESTS += run_unittests
+run_unittests_SOURCES = run_unittests.cc
+run_unittests_SOURCES += portconfig_unittest.cc
+
+run_unittests_CPPFLAGS = $(AM_CPPFLAGS) $(GTEST_INCLUDES)
+run_unittests_LDFLAGS = $(AM_LDFLAGS) $(GTEST_LDFLAGS)
+run_unittests_LDADD = $(GTEST_LDADD)
+
+run_unittests_LDADD += $(top_builddir)/src/lib/server_common/libserver_common.la
+endif
+
+noinst_PROGRAMS = $(TESTS)
diff --git a/src/lib/server_common/tests/portconfig_unittest.cc b/src/lib/server_common/tests/portconfig_unittest.cc
new file mode 100644
index 0000000..fabdfa2
--- /dev/null
+++ b/src/lib/server_common/tests/portconfig_unittest.cc
@@ -0,0 +1,182 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#include <server_common/portconfig.h>
+
+#include <cc/data.h>
+#include <exceptions/exceptions.h>
+#include <asiolink/asiolink.h>
+
+#include <gtest/gtest.h>
+#include <string>
+
+using namespace isc::server_common::portconfig;
+using namespace isc::data;
+using namespace isc;
+using namespace std;
+using namespace asiolink;
+
+namespace {
+
+/// Testcase for parseAddresses call (struct, nobody cares about private here)
+struct ParseAddresses : public ::testing::Test {
+ AddressList result_;
+ void empty(ElementPtr config, const string& name) {
+ SCOPED_TRACE(name);
+ EXPECT_NO_THROW(result_ = parseAddresses(config, "test"));
+ EXPECT_TRUE(result_.empty());
+ }
+ template<class Exception>
+ void invalidTest(const string& json, const string& name) {
+ SCOPED_TRACE(name);
+ ElementPtr config(Element::fromJSON(json));
+ EXPECT_THROW(parseAddresses(config, "test"), Exception) <<
+ "Should throw " << typeid(Exception).name();
+ }
+};
+
+// Parse valid IPv4 address
+TEST_F(ParseAddresses, ipv4) {
+ ElementPtr config(Element::fromJSON("["
+ " {"
+ " \"address\": \"192.0.2.1\","
+ " \"port\": 53"
+ " }"
+ "]"));
+ EXPECT_NO_THROW(result_ = parseAddresses(config, "test"));
+ ASSERT_EQ(1, result_.size());
+ EXPECT_EQ("192.0.2.1", result_[0].first);
+ EXPECT_EQ(53, result_[0].second);
+}
+
+// Parse valid IPv6 address
+TEST_F(ParseAddresses, ipv6) {
+ ElementPtr config(Element::fromJSON("["
+ " {"
+ " \"address\": \"2001:db8::1\","
+ " \"port\": 53"
+ " }"
+ "]"));
+ EXPECT_NO_THROW(result_ = parseAddresses(config, "test"));
+ ASSERT_EQ(1, result_.size());
+ EXPECT_EQ("2001:db8::1", result_[0].first);
+ EXPECT_EQ(53, result_[0].second);
+}
+
+// Parse multiple addresses at once
+// (even the ports are different to see they are not mistaken)
+TEST_F(ParseAddresses, multi) {
+ ElementPtr config(Element::fromJSON("["
+ " {"
+ " \"address\": \"2001:db8::1\","
+ " \"port\": 53"
+ " },"
+ " {"
+ " \"address\": \"192.0.2.1\","
+ " \"port\": 54"
+ " }"
+ "]"));
+ EXPECT_NO_THROW(result_ = parseAddresses(config, "test"));
+ ASSERT_EQ(2, result_.size());
+ EXPECT_EQ("2001:db8::1", result_[0].first);
+ EXPECT_EQ(53, result_[0].second);
+ EXPECT_EQ("192.0.2.1", result_[1].first);
+ EXPECT_EQ(54, result_[1].second);
+}
+
+// Parse various versions of empty list
+TEST_F(ParseAddresses, empty) {
+ empty(Element::fromJSON("[]"), "Empty list");
+ empty(ElementPtr(new NullElement), "Null element");
+ empty(ElementPtr(), "Null pointer");
+}
+
+// Reject invalid configs
+TEST_F(ParseAddresses, invalid) {
+ invalidTest<TypeError>("{}", "Not a list");
+ invalidTest<BadValue>("[{}]", "Empty element");
+ invalidTest<TypeError>("[{"
+ " \"port\": 1.5,"
+ " \"address\": \"192.0.2.1\""
+ "}]", "Float port");
+ invalidTest<BadValue>("[{"
+ " \"port\": -5,"
+ " \"address\": \"192.0.2.1\""
+ "}]", "Negative port");
+ invalidTest<BadValue>("[{"
+ " \"port\": 1000000,"
+ " \"address\": \"192.0.2.1\""
+ "}]", "Port too big");
+ invalidTest<IOError>("[{"
+ " \"port\": 53,"
+ " \"address\": \"bad_address\""
+ "}]", "Bad address");
+}
+
+// Test fixture for installListenAddresses
+struct InstallListenAddresses : public ::testing::Test {
+ InstallListenAddresses() :
+ dnss_(ios_, NULL, NULL, NULL)
+ {
+ valid_.push_back(AddressPair("127.0.0.1", 5288));
+ valid_.push_back(AddressPair("::1", 5288));
+ invalid_.push_back(AddressPair("192.0.2.2", 1));
+ }
+ IOService ios_;
+ DNSService dnss_;
+ AddressList store_;
+ // We should be able to bind to these addresses
+ AddressList valid_;
+ // But this shouldn't work
+ AddressList invalid_;
+ // Check that the store_ addresses are the same as expected
+ void checkAddresses(const AddressList& expected, const string& name) {
+ SCOPED_TRACE(name);
+
+ ASSERT_EQ(expected.size(), store_.size()) <<
+ "Different amount of elements, not checking content";
+ // Run in parallel trough the vectors
+ for (AddressList::const_iterator ei(expected.begin()),
+ si(store_.begin()); ei != expected.end(); ++ei, ++si) {
+ EXPECT_EQ(ei->first, si->first);
+ EXPECT_EQ(ei->second, si->second);
+ }
+ }
+};
+
+// Try switching valid addresses
+TEST_F(InstallListenAddresses, valid) {
+ // First, bind to the valid addresses
+ EXPECT_NO_THROW(installListenAddresses(valid_, store_, dnss_));
+ checkAddresses(valid_, "Valid addresses");
+ // TODO Maybe some test to actually connect to them
+ // Try setting it back to nothing
+ EXPECT_NO_THROW(installListenAddresses(AddressList(), store_, dnss_));
+ checkAddresses(AddressList(), "No addresses");
+ // Try switching back again
+ EXPECT_NO_THROW(installListenAddresses(valid_, store_, dnss_));
+ checkAddresses(valid_, "Valid addresses");
+}
+
+// Try if rollback works
+TEST_F(InstallListenAddresses, rollback) {
+ // Set some addresses
+ EXPECT_NO_THROW(installListenAddresses(valid_, store_, dnss_));
+ checkAddresses(valid_, "Before rollback");
+ // This should not bind them, but should leave the original addresses
+ EXPECT_THROW(installListenAddresses(invalid_, store_, dnss_), IOError);
+ checkAddresses(valid_, "After rollback");
+}
+
+}
diff --git a/src/lib/server_common/tests/run_unittests.cc b/src/lib/server_common/tests/run_unittests.cc
new file mode 100644
index 0000000..7ebc985
--- /dev/null
+++ b/src/lib/server_common/tests/run_unittests.cc
@@ -0,0 +1,26 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#include <config.h>
+
+#include <gtest/gtest.h>
+
+#include <dns/tests/unittest_util.h>
+
+int
+main(int argc, char* argv[]) {
+ ::testing::InitGoogleTest(&argc, argv);
+
+ return (RUN_ALL_TESTS());
+}
diff --git a/src/lib/testutils/Makefile.am b/src/lib/testutils/Makefile.am
index d0467ea..e5cb46b 100644
--- a/src/lib/testutils/Makefile.am
+++ b/src/lib/testutils/Makefile.am
@@ -12,3 +12,5 @@ libtestutils_la_SOURCES += dnsmessage_test.h dnsmessage_test.cc
libtestutils_la_SOURCES += mockups.h
libtestutils_la_CPPFLAGS = $(AM_CPPFLAGS) $(GTEST_INCLUDES)
endif
+
+EXTRA_DIST = portconfig.h
diff --git a/src/lib/testutils/portconfig.h b/src/lib/testutils/portconfig.h
new file mode 100644
index 0000000..8e61ffc
--- /dev/null
+++ b/src/lib/testutils/portconfig.h
@@ -0,0 +1,189 @@
+// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+#ifndef TESTUTILS_PORTCONFIG_H
+#define TESTUTILS_PORTCONFIG_H
+
+#include <gtest/gtest.h>
+#include <cc/data.h>
+#include <server_common/portconfig.h>
+
+namespace isc {
+namespace testutils {
+/**
+ * \brief Bits of tests for server port configuration.
+ *
+ * These are bits of tests that can be reused by server classes to check if
+ * configuration of the listening addresses work.
+ *
+ * You can put any of these functions into a TEST_F test and pass the server
+ * to it.
+ *
+ * \todo There's quite a lot of common code in the basic server handling.
+ * We should refactor it, so both Resolver server and Auth server have
+ * a common base class. When this is done, the common parts would be put
+ * there and the tests would be at the base class, not here.
+ */
+namespace portconfig {
+
+/**
+ * \brief Check setting of the listening addresses directly (as a list) works.
+ *
+ * \param server The server to test against.
+ */
+template<class Server>
+void
+listenAddresses(Server& server) {
+ using namespace isc::server_common::portconfig;
+ // Default value should be fully recursive
+ EXPECT_TRUE(server.getListenAddresses().empty());
+
+ // Try putting there some addresses
+ AddressList addresses;
+ addresses.push_back(AddressPair("127.0.0.1", 53210));
+ addresses.push_back(AddressPair("::1", 53210));
+ server.setListenAddresses(addresses);
+ EXPECT_EQ(2, server.getListenAddresses().size());
+ EXPECT_EQ("::1", server.getListenAddresses()[1].first);
+
+ // Is it independent from what we do with the vector later?
+ addresses.clear();
+ EXPECT_EQ(2, server.getListenAddresses().size());
+
+ // Did it return to fully recursive?
+ server.setListenAddresses(addresses);
+ EXPECT_TRUE(server.getListenAddresses().empty());
+}
+
+/**
+ * \brief Check setting of the addresses by config value.
+ *
+ * This passes an listen_on element to the server's updateConfig function.
+ * It tries little bit of switching around. It tries both setting a presumably
+ * valid addresses and then setting something that cant be bound, rolling back
+ * back to original.
+ *
+ * \param server The server object to test against.
+ */
+template<class Server>
+void
+listenAddressConfig(Server& server) {
+ using namespace isc::data;
+ // Try putting there some address
+ ElementPtr config(Element::fromJSON("{"
+ "\"listen_on\": ["
+ " {"
+ " \"address\": \"127.0.0.1\","
+ " \"port\": 53210"
+ " }"
+ "]"
+ "}"));
+ ConstElementPtr result(server.updateConfig(config));
+ EXPECT_EQ(result->toWire(), isc::config::createAnswer()->toWire());
+ ASSERT_EQ(1, server.getListenAddresses().size());
+ EXPECT_EQ("127.0.0.1", server.getListenAddresses()[0].first);
+ EXPECT_EQ(53210, server.getListenAddresses()[0].second);
+
+ // As this is example address, the machine should not have it on
+ // any interface
+ config = Element::fromJSON("{"
+ "\"listen_on\": ["
+ " {"
+ " \"address\": \"192.0.2.0\","
+ " \"port\": 53210"
+ " }"
+ "]"
+ "}");
+ result = server.updateConfig(config);
+ EXPECT_FALSE(result->equals(*isc::config::createAnswer()));
+ ASSERT_EQ(1, server.getListenAddresses().size());
+ EXPECT_EQ("127.0.0.1", server.getListenAddresses()[0].first);
+ EXPECT_EQ(53210, server.getListenAddresses()[0].second);
+
+}
+
+/**
+ * \brief Check that given config is rejected.
+ *
+ * Try if given config is considered invalid by the server and is rejected.
+ * The value is converted from JSON to the data elements and passed to server's
+ * updateConfig method. It should not crash, but return a negative answer.
+ *
+ * It is used internally by invalidListenAddressConfig, but you can use it
+ * to test any other invalid configs.
+ *
+ * \todo It might be better to put it to some other namespace, as this is more
+ * generic. But right now it is used only here, so until something else
+ * needs it, it might as well stay here.
+ * \param server The server to test against.
+ * \param JSON Config to use.
+ * \param name It is used in the output if the test fails.
+ */
+template<class Server>
+void
+configRejected(Server& server, const std::string& JSON,
+ const std::string& name)
+{
+ SCOPED_TRACE(name);
+
+ using namespace isc::data;
+ ElementPtr config(Element::fromJSON(JSON));
+ EXPECT_FALSE(server.updateConfig(config)->
+ equals(*isc::config::createAnswer())) <<
+ "Accepted invalid config " << JSON;
+}
+
+/**
+ * \brief Check some invalid address configs.
+ *
+ * It tries a series of invalid listen_on configs against the server and checks
+ * it is rejected.
+ * \param server The server to check against.
+ */
+template<class Server>
+void
+invalidListenAddressConfig(Server& server) {
+ configRejected(server, "{"
+ "\"listen_on\": \"error\""
+ "}", "Wrong element type");
+ configRejected(server, "{"
+ "\"listen_on\": [{}]"
+ "}", "Empty address element");
+ configRejected(server, "{"
+ "\"listen_on\": [{"
+ " \"port\": 1.5,"
+ " \"address\": \"192.0.2.1\""
+ "}]}", "Float port");
+ configRejected(server, "{"
+ "\"listen_on\": [{"
+ " \"port\": -5,"
+ " \"address\": \"192.0.2.1\""
+ "}]}", "Negative port");
+ configRejected(server, "{"
+ "\"listen_on\": [{"
+ " \"port\": 1000000,"
+ " \"address\": \"192.0.2.1\""
+ "}]}", "Huge port");
+ configRejected(server, "{"
+ "\"listen_on\": [{"
+ " \"port\": 53,"
+ " \"address\": \"bad_address\""
+ "}]}", "Bad address");
+}
+
+}
+}
+}
+
+#endif
diff --git a/src/lib/testutils/srv_test.cc b/src/lib/testutils/srv_test.cc
index c0d6e0f..4fec4ca 100644
--- a/src/lib/testutils/srv_test.cc
+++ b/src/lib/testutils/srv_test.cc
@@ -60,7 +60,7 @@ SrvTestBase::createDataFromFile(const char* const datafile,
delete endpoint;
endpoint = IOEndpoint::create(protocol,
- IOAddress(DEFAULT_REMOTE_ADDRESS), 5300);
+ IOAddress(DEFAULT_REMOTE_ADDRESS), 53210);
UnitTestUtil::readWireData(datafile, data);
io_sock = (protocol == IPPROTO_UDP) ? &IOSocket::getDummyUDPSocket() :
&IOSocket::getDummyTCPSocket();
@@ -76,7 +76,7 @@ SrvTestBase::createRequestPacket(Message& message,
delete io_message;
endpoint = IOEndpoint::create(protocol,
- IOAddress(DEFAULT_REMOTE_ADDRESS), 5300);
+ IOAddress(DEFAULT_REMOTE_ADDRESS), 53210);
io_sock = (protocol == IPPROTO_UDP) ? &IOSocket::getDummyUDPSocket() :
&IOSocket::getDummyTCPSocket();
io_message = new IOMessage(request_renderer.getData(),
diff --git a/tools/README b/tools/README
index a18b38a..ce8ddea 100644
--- a/tools/README
+++ b/tools/README
@@ -1,3 +1,4 @@
The "tools" directory contains scripts for helping the BIND 10
-developers maintain the source tree. These are not intended
-to be built nor installed by the build system.
+developers with various tasks, eg. maintaining the source tree,
+running some tests. These are not intended to be built nor
+installed by the build system.
diff --git a/tools/import_boost.sh b/tools/import_boost.sh
deleted file mode 100755
index 07abe8c..0000000
--- a/tools/import_boost.sh
+++ /dev/null
@@ -1,74 +0,0 @@
-#!/bin/sh
-
-# given a directory, copy all needed parts from boost into the
-# current branch
-
-# only run this to update boost! (i.e. almost never)
-
-# usage example:
-# cd /tmp
-# tar xzvf /location/of/boost/tarball
-# cd /home/user/svn/bind10/trunk
-# tools/import_boost.sh /tmp/boost-version
-# svn commit
-
-# need new boost stuff?
-# TODO: LICENSE_1_0.txt
-# add files to list 'ere
-FILES="
-boost/*.hpp
-boost/algorithm
-boost/asio
-boost/assign/list_inserter.hpp
-boost/assign/std/vector.hpp
-boost/bind
-boost/config
-boost/concept
-boost/detail
-boost/exception
-boost/function
-boost/iterator
-boost/mpl
-boost/preprocessor
-boost/python
-boost/range
-boost/smart_ptr
-boost/type_traits
-boost/utility
-"
-
-TARGET="ext"
-
-if [ $# -ne 1 ]
-then
- echo "Usage: boost_import.sh <boost directory>"
- exit
-fi
-
-if [ ! -d $TARGET/boost ]
-then
- echo "This does not appear to be the main trunk/branch directory"
- exit
-fi
-
-
-DIR=$1
-
-do_cmd()
-{
- echo $@
- $@
-}
-
-
-#echo "cp ${DIR}/boost/shared_ptr.hpp boost/"
-for FILE in ${FILES}
-do
-TGT=`echo ${FILE} | sed 's/[^\/]*$//'`
-cmd="mkdir -p ${TARGET}/${TGT}"
-do_cmd ${cmd}
-cmd="cp -r ${DIR}/${FILE} ${TARGET}/${TGT}"
-do_cmd ${cmd}
-done
-
-
diff --git a/tools/tests_in_valgrind.sh b/tools/tests_in_valgrind.sh
new file mode 100755
index 0000000..14e91ba
--- /dev/null
+++ b/tools/tests_in_valgrind.sh
@@ -0,0 +1,75 @@
+#!/bin/sh
+
+###########################################
+# This script runs all tests in valgrind. Configure and compile bind the way
+# you want it to be tested (you should use --with-gtest, however, or you get
+# no tests). Then run this script from the top build directory.
+#
+# Note that the test isn't what you would call "production quality" (it is
+# expected to be used by the bind10 developers, not end user) and might break,
+# some ways of breaking it are known.
+#
+# There are two variables that modify it's behaviour.
+# * VALGRIND_FLAGS are the flag passed to valgrind. There are some, hopefully
+# reasonable defaults which you can overwrite. Note that the variable is
+# used unmodified inside a sed pattern with # as a modifier, which can
+# easily break it. There was no motivation to fix this.
+# * VALGRIND_FILE is the file to store the output into. Default is valgrind.log
+###########################################
+
+# First, make sure the tests are up to date
+make
+
+if [ $? = 2 ] ; then
+ echo "Did you run configure? Or maybe you're running the script from the tools directory? (you need to run it from the top bind10 build directory)"
+ exit 1
+fi
+
+set -e
+
+# Some configuration
+# TODO Escape for sed, this might break
+LOGFILE="${VALGRIND_FILE:-`pwd`/valgrind.log}"
+FLAGS="${VALGRIND_FLAGS:---leak-check=full --track-fds=yes}"
+FLAGS="$FLAGS --log-file=$LOGFILE.%p"
+
+FOUND_ANY=false
+FAILED=
+
+# Find all the tests (yes, doing it by a name is a nasty hack)
+# Since the while runs in a subprocess, we need to get the assignments out, done by the eval
+eval $(find . -type f -name run_unittests -print | grep -v '\.libs/run_unittests$' | while read testname ; do
+ sed -e 's#exec "#exec valgrind '"$FLAGS"' "#' "$testname" > "$testname.valgrind"
+ chmod +x "$testname.valgrind"
+ echo "$testname" >>"$LOGFILE"
+ echo "===============" >>"$LOGFILE"
+ OLDDIR="`pwd`"
+ cd $(dirname "$testname")
+ ./run_unittests.valgrind >&2 &
+ PID="$!"
+ set +e
+ wait "$PID"
+ CODE="$?"
+ set -e
+ cd "$OLDDIR"
+ if [ "$CODE" != 0 ] ; then
+ echo 'FAILED="$FAILED
+'"$testname"'"'
+ fi
+ NAME="$LOGFILE.$PID"
+ rm "$testname.valgrind"
+ # Remove the ones from death tests
+ grep "==$PID==" "$NAME" >>"$LOGFILE"
+ rm "$NAME"
+ echo 'FOUND_ANY=true'
+done)
+
+if test -n "$FAILED"; then
+ echo "These tests failed:" >&2
+ echo "$FAILED" >&2
+fi
+
+if ! $FOUND_ANY ; then
+ echo "No test was found. It is possible you configured without --with-gtest or you run it from wrong directory" >&2
+ exit 1
+fi
diff --git a/tools/valgrind_test_cleaner.pl b/tools/valgrind_test_cleaner.pl
new file mode 100755
index 0000000..9928e9f
--- /dev/null
+++ b/tools/valgrind_test_cleaner.pl
@@ -0,0 +1,64 @@
+#!/usr/bin/perl
+use strict;
+use warnings;
+
+# This script can be used on a valgrind output of the tests (from
+# tests_in_valgrind.sh) to remove some uninteresting error reports.
+# Since we care about the tested application not leaking/crashing, not
+# the tests itself, memory leaks that are caused only by the tests
+# (eg. unreleased test data), we don't want to have logs full of them.
+#
+# This script does some heuristics to eliminate some of such error
+# reports. Currently, the memory lost reports whose stack contains
+# no call from the real application are suppressed.
+#
+# Of course, the rest still can contain many uninteresting entries.
+
+# Yes, it's perl even when we use python. I wrote it for myself when
+# I needed to clean the outputs and after it proved useful to me, I
+# thought it might be for others too, so I just included it. It's not
+# that we would be switching to perl. If it should grow in future to
+# include more heuristics and do something more fancy, we should probably
+# rewrite it in python instead.
+
+my ($block, $blockOK);
+
+sub endBlock(_) {
+ return unless $block;
+ if ($blockOK) {
+ print @$block;
+ }
+ undef $block;
+ undef $blockOK;
+}
+
+sub startBlock(_) {
+ $block = [@_];
+}
+
+sub addToBlock(_) {
+ my ($line) = @_;
+ push @$block, $line;
+ return unless $line =~ /^==\d+==\s+(at|by) 0x[0-9A-F]+: (.*) \(.+:\d+\)$/;
+ $_ = $2;
+ return $blockOK = 1 if /^isc::/;
+ return $blockOK = 1 if /^asiolink:/;
+ return if /^main \(/;
+ return if /^testing::/;
+ return if /^\(anonymous namespace\)::/;
+ $blockOK = 1;
+}
+
+while(<>) {
+ if (/^==\d+==\s*$/) {
+ print;
+ endBlock;
+ } elsif (/^==\d+==\s+\d+bytes.*lost in loss record/) {
+ startBlock;
+ } elsif ($block) {
+ addToBlock;
+ } else {
+ print;
+ }
+}
+endBlock;
More information about the bind10-changes
mailing list