add no_std feature #13

vitiral · 2017-05-28T23:12:24Z

this adds support for no_std applications/libraries (like microcontrollers) by using conditional features

Features cannot enable/disable features of dependencies rust-lang/cargo#633

On nightly with no_std:

#  rustup run nightly cargo test --features no_std                                                                                                                                           <<<
    Finished dev [unoptimized + debuginfo] target(s) in 0.0 secs
     Running target/debug/deps/crc-c3e90d0dfab413be

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured

     Running target/debug/deps/crc-9d7b680262789a74

running 10 tests
test crc32::checksum_castagnoli ... ok
test crc32::checksum_ieee ... ok
test crc32::digest_castagnoli ... ok
test crc32::checksum_koopman ... ok
test crc32::digest_ieee ... ok
test crc64::checksum_ecma ... ok
test crc32::digest_koopman ... ok
test crc64::digest_iso ... ok
test crc64::checksum_iso ... ok
test crc64::digest_ecma ... ok

test result: ok. 10 passed; 0 failed; 0 ignored; 0 measured

     Running target/debug/deps/hash-bb44b103cb920ad0

running 2 tests
test hasher::checksum_hashcrc32 ... ok
test hasher::checksum_hashcrc64 ... ok

test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured

   Doc-tests crc

running 2 tests
test src/lib.rs -  (line 6) ... ok
test src/lib.rs -  (line 27) ... ok

test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured

on stable with std:

# rustup run stable cargo test                                                                                                                                                                 
   Compiling crc v1.4.0 (file:///home/garrett/projects/ruststuff/crc-rs)                                                                                                                                          
    Finished dev [unoptimized + debuginfo] target(s) in 1.64 secs                                                                                                                                                 
     Running target/debug/deps/crc-57a43f894e443797                                                                                                                                                               
                                                                                                                                                                                                                  
running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured

     Running target/debug/deps/crc-79b2fcd023832a0c                                                                                                                                                               
                                                                                                                                                                                                                  
running 10 tests
test crc32::checksum_castagnoli ... ok                                                                                                                                                                            
test crc32::checksum_ieee ... ok                                                                                                                                                                                  
test crc32::checksum_koopman ... ok                                                                                                                                                                               
test crc32::digest_castagnoli ... ok                                                                                                                                                                              
test crc32::digest_ieee ... ok                                                                                                                                                                                    
test crc64::checksum_iso ... ok                                                                                                                                                                                   
test crc64::checksum_ecma ... ok                                                                                                                                                                                  
test crc64::digest_ecma ... ok                                                                                                                                                                                    
test crc32::digest_koopman ... ok                                                                                                                                                                                 
test crc64::digest_iso ... ok                                                                                                                                                                                     
                                                                                                                                                                                                                  
test result: ok. 10 passed; 0 failed; 0 ignored; 0 measured

     Running target/debug/deps/hash-da1e5eadb26ad3bb                                                                                                                                                              
                                                                                                                                                                                                                  
running 2 tests
test hasher::checksum_hashcrc32 ... ok
test hasher::checksum_hashcrc64 ... ok

test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured

   Doc-tests crc                                                                                                                                                                                                  
                                                                                                                                                                                                                  
running 2 tests
test src/lib.rs -  (line 27) ... ok                                                                                                                                                                               
test src/lib.rs -  (line 6) ... ok                                                                                                                                                                                
                                                                                                                                                                                                                  
test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured
#

whitequark · 2017-05-29T00:26:34Z

As a developer who deploys to embedded devices: I would not use a library that employs lazy_static. Not only there is no reason whatsoever to calculate CRC tables at runtime when you can simply include them in the source code--it's not like they ever change--or at least do it at compile-time, but on a real-time system this would easily cause a missed deadline by whichever code path calls the corresponding CRC function first.

vitiral · 2017-05-29T02:48:06Z

Huh, I wasn't thinking about that. Two questions :

why is it not a table already? Can I open a PR for that?
it seems to me like rust should be able to have a build_static crate that can do const evaluations like this at build time (using build.rs). Do you have thoughts on that?

whitequark · 2017-05-29T06:54:53Z

it seems to me like rust should be able to have a build_static crate that can do const evaluations like this at build time (using build.rs). Do you have thoughts on that?

I feel like this is unnecessary complexity and a simple accessory binary included in the source code for posterity and verification but never normally built is more than enough.

vitiral · 2017-05-29T15:35:31Z

I created a crate for this purpose. I could definitely also make a constructor that can be used for "scripts", which could be used to create a separate crate. https://github.com/vitiral/build_const

vitiral · 2017-05-31T18:07:13Z

just finished using build_const in the build.rs. I would say it is pretty simple -- but then again I am the developer of build_const.

If you would like I could put it in a script instead so the constant files could be generated whenever was convienient (build_const has helpers to make this transition seamless)

vitiral · 2017-06-05T05:38:42Z

Fixes #11

Can this be merged? There is literally no benefit to lazy_static for this crate anymore.

oyvindln · 2017-07-01T17:12:50Z

Looks like the crate author hasn't been active on github or twitter for a few months now. Maybe creating a new crate with the improvements in the open PRs could be considered.

vitiral · 2017-07-01T17:57:06Z

@mrhooray if you could give me rights on cargo I would gladly take over this repo! I totally understand that sometimes life gets hard 😄

oyvindln · 2017-07-15T19:20:16Z

@vitiral Would you be interested in making a fork of this crate and put it on crates.io to use until the author shows up? I can help out with it if needed.

mrhooray · 2017-07-16T05:34:48Z

@vitiral @oyvindln sorry for the late response and thanks @vitiral for integrating with his module to have build time constants

Not very familiar with build process, would this be a breaking change or it'd be fully compatible with v1?

mrhooray · 2017-07-16T05:48:52Z

build.rs

+
+extern crate build_const;
+
+pub fn make_table_crc32(poly: u32) -> [u32; 256] {


does it make sense to move these two make table fns to a util file/module so that we don't have to repeat them in crc32.rs and crc64.rs

We could move them into an internal "crate" which both build.rs and the individual modules depend on. I can do that if you would like.

I also didn't like copy/pasting them.

moving make_table out of crc32/crc64 is a breaking change since they're public
i'll see weather we could reference them in build.rs after merging.

I was thinking we could have an internal crate which build.rs used and some of the functions were re-exported in crc32 and crc64 -- making it non-breaking.

good point. let me try that

#16 was created to address this

vitiral · 2017-07-17T15:27:12Z

@mrhooray it is not a breaking change, it just removes a dependency (and adds one) and allows for use in no_std libraries.

add no_std feature

vitiral mentioned this pull request May 28, 2017

use (or contribute to) crc library? smoltcp-rs/smoltcp#13

Closed

add no_std feature

9f9a4ff

use build_const instead of lazy_static

08f3927

remove comments

c014965

This was referenced May 31, 2017

make lazy_static optional #11

Closed

replace Digest::new with table specific digests #14

Closed

mrhooray mentioned this pull request Jul 16, 2017

Use intel crc32 instruction #9

Closed

mrhooray reviewed Jul 16, 2017

View reviewed changes

mrhooray merged commit 1ae49cb into mrhooray:master Jul 18, 2017

mrhooray mentioned this pull request Aug 8, 2017

no_std example build #20

Closed

mrhooray pushed a commit that referenced this pull request Nov 19, 2017

Merge pull request #13 from vitiral/no_std

ef0b067

add no_std feature

mrhooray added a commit that referenced this pull request Nov 19, 2017

Merge pull request #13 from vitiral/no_std

7335eb3

add no_std feature

mrhooray added a commit that referenced this pull request Nov 20, 2017

Merge pull request #13 from vitiral/no_std

6ad283e

add no_std feature

mrhooray added a commit that referenced this pull request Nov 20, 2017

Merge pull request #13 from vitiral/no_std

79dc0e0

add no_std feature

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add no_std feature #13

add no_std feature #13

vitiral commented May 28, 2017

whitequark commented May 29, 2017

vitiral commented May 29, 2017

whitequark commented May 29, 2017

vitiral commented May 29, 2017 via email •

edited

Loading

vitiral commented May 31, 2017

vitiral commented Jun 5, 2017

oyvindln commented Jul 1, 2017

vitiral commented Jul 1, 2017

oyvindln commented Jul 15, 2017

mrhooray commented Jul 16, 2017

mrhooray Jul 16, 2017

vitiral Jul 17, 2017

mrhooray Jul 18, 2017

vitiral Jul 18, 2017

mrhooray Jul 18, 2017

mrhooray Jul 19, 2017

vitiral commented Jul 17, 2017


		extern crate build_const;

		pub fn make_table_crc32(poly: u32) -> [u32; 256] {

add no_std feature #13

add no_std feature #13

Conversation

vitiral commented May 28, 2017

whitequark commented May 29, 2017

vitiral commented May 29, 2017

whitequark commented May 29, 2017

vitiral commented May 29, 2017 via email • edited Loading

vitiral commented May 31, 2017

vitiral commented Jun 5, 2017

oyvindln commented Jul 1, 2017

vitiral commented Jul 1, 2017

oyvindln commented Jul 15, 2017

mrhooray commented Jul 16, 2017

mrhooray Jul 16, 2017

Choose a reason for hiding this comment

vitiral Jul 17, 2017

Choose a reason for hiding this comment

mrhooray Jul 18, 2017

Choose a reason for hiding this comment

vitiral Jul 18, 2017

Choose a reason for hiding this comment

mrhooray Jul 18, 2017

Choose a reason for hiding this comment

mrhooray Jul 19, 2017

Choose a reason for hiding this comment

vitiral commented Jul 17, 2017

vitiral commented May 29, 2017 via email •

edited

Loading