Improving/simplifying `cfg` attributes for target features

Đang mở
#18 4 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
rust
Lĩnh vực
build-system

Hướng nghiên cứu

Start by reading the existing cfg attributes described in the issue and the build scripts that could propagate a global attribute across the RustCrypto crates. The issue offers alternative naming schemes but does not settle the design or identify specific files. Done means choosing and implementing a consistent way to select backends and enable target architecture support across crates.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

After many issues using crate features for controlling usage of target features, we've largely migrated to using cfg attributes instead.

Here are some of the cfg attributes we've defined:

  • aes_force_soft: use the software AES backend
  • aes_armv8: enable ARMv8 AES intrinsics (nightly-only)
  • chacha20_force_avx2: force the use of the AVX2 backend for ChaCha20
  • chacha20_force_sse2: force the use of the SSE2 backend for ChaCha20
  • chacha20_force_soft: force the use of the software-only backend for ChaCha20
  • polyval_force_soft: use the software POLYVAL backend
  • polyval_armv8: enable ARMv8 PMULL intrinsics (nightly-only)

First off, these all are selecting one of many options and are mutually exclusive at a crate level. cfg attributes make that possible in ways crate features don.t Alternatively we could have:

  • aes_backend="armv8", aes_backend="soft"
  • chacha20_backend="avx2", chacha20_backend="sse2", chacha20_backend="soft",
  • polyval_backend="armv8", polyval_backend="soft"

This would both be consistent across crates and simplify the logic in regard to conflicting attributes.

However, it would also be nice to have some way of enabling e.g. ARMv8 support without having to know about every subcomponent crate and whether or not it has ARMv8-specific features.

For example, right now to have fully hardware accelerated AES-GCM on ARMv8, an aes-gcm crate user needs to enable the aes_armv8 and polyval_armv8 cfg attributes.

It would be nice if there were a single cfg attribute that could be used to enable this across the whole project, e.g.

rustcrypto_target_arch="armv8"

To make this a bit easier to implement, we can continue to use the crate-specific attributes as the canonical cfg attributes, and use a build script to propagate the "global" cfg attributes.

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
13
Fork
4
Merge trung bình
41 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của RustCrypto/meta

Tất cả issue của RustCrypto/meta

Issue tương tự

Thêm issue về Build System

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.