This is an archive of the discontinued Mercurial Phabricator instance.

Differential D285

sha1: allow selecting SHA-1 library at build time
ClosedPublic

Authored by simpkins on Aug 8 2017, 4:20 PM.
Tags
None
Subscribers
None

Details

Reviewers
ryanmce
Group Reviewers
Restricted Project
Commits
rFBHGX5eca64d9cba7: sha1: allow selecting SHA-1 library at build time
Summary

Add a #define which allows selecting between the sha1collisiondetection and
openssl SHA-1 implementations at build time.

For now setup.py always uses sha1collisiondetection, but we have some other
internal build environments where we will likely default to OpenSSL's SHA-1
implementation instead.

Test Plan

Confirmed the code builds and passes tests.

Diff Detail

Repository
rFBHGX Facebook Mercurial Extensions
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

simpkins created this revision.Aug 8 2017, 4:20 PM
Herald added a reviewer: Restricted Project. · View Herald TranscriptAug 8 2017, 4:20 PM
ryanmce accepted this revision.Aug 9 2017, 5:58 AM
This revision is now accepted and ready to land.Aug 9 2017, 5:58 AM
Closed by commit rFBHGX5eca64d9cba7: sha1: allow selecting SHA-1 library at build time (authored by simpkins). · Explain WhyAug 22 2017, 10:21 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mclib/sha1.h (19 lines)
Msetup.py (10 lines)

Diff 650

clib/sha1.h

// Copyright (c) 2017-present, Facebook, Inc. // Copyright (c) 2017-present, Facebook, Inc.
// All Rights Reserved. // All Rights Reserved.
// //
// This software may be used and distributed according to the terms of the // This software may be used and distributed according to the terms of the
// GNU General Public License version 2 or any later version. // GNU General Public License version 2 or any later version.
// sha1.h - wrapper functions around the underlying SHA-1 implementation. // sha1.h - wrapper functions around the underlying SHA-1 implementation.
// //
// no-check-code // no-check-code
#pragma once #pragma once
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif
#ifdef SHA1_USE_SHA1DC
#include <stdlib.h> #include <stdlib.h>
#include <sha1dc/sha1.h> #include <sha1dc/sha1.h>
typedef SHA1_CTX fbhg_sha1_ctx_t; typedef SHA1_CTX fbhg_sha1_ctx_t;
static inline int fbhg_sha1_init(fbhg_sha1_ctx_t* ctx) { static inline int fbhg_sha1_init(fbhg_sha1_ctx_t* ctx) {
SHA1DCInit(ctx); SHA1DCInit(ctx);
SHA1DCSetSafeHash(ctx, 0); SHA1DCSetSafeHash(ctx, 0);
SHA1DCSetUseDetectColl(ctx, 0); SHA1DCSetUseDetectColl(ctx, 0);
return 0; return 0;
} }
static inline int static inline int
fbhg_sha1_update(fbhg_sha1_ctx_t* ctx, const void* data, unsigned long length) { fbhg_sha1_update(fbhg_sha1_ctx_t* ctx, const void* data, unsigned long length) {
SHA1DCUpdate(ctx, (const char*)data, length); SHA1DCUpdate(ctx, (const char*)data, length);
return 0; return 0;
} }
static inline int fbhg_sha1_final(unsigned char* md, fbhg_sha1_ctx_t* ctx) { static inline int fbhg_sha1_final(unsigned char* md, fbhg_sha1_ctx_t* ctx) {
return SHA1DCFinal(md, ctx); return SHA1DCFinal(md, ctx);
} }
#else
#include <openssl/sha.h>
typedef SHA_CTX fbhg_sha1_ctx_t;
static inline int fbhg_sha1_init(fbhg_sha1_ctx_t* ctx) {
return SHA1_Init(ctx);
}
static inline int
fbhg_sha1_update(fbhg_sha1_ctx_t* ctx, const void* data, unsigned long length) {
return SHA1_Update(ctx, data, length);
}
static inline int fbhg_sha1_final(unsigned char* md, fbhg_sha1_ctx_t* ctx) {
return SHA1_Final(md, ctx);
}
#endif
#ifdef __cplusplus #ifdef __cplusplus
} /* extern C */ } /* extern C */
#endif #endif

setup.py

WERROR = "/WX" if iswindows else "-Werror" WERROR = "/WX" if iswindows else "-Werror"
WSTRICTPROTOTYPES = None if iswindows else "-Werror=strict-prototypes" WSTRICTPROTOTYPES = None if iswindows else "-Werror=strict-prototypes"
WALL = "/Wall" if iswindows else "-Wall" WALL = "/Wall" if iswindows else "-Wall"
STDC99 = "" if iswindows else "-std=c99" STDC99 = "" if iswindows else "-std=c99"
STDCPP0X = "" if iswindows else "-std=c++0x" STDCPP0X = "" if iswindows else "-std=c++0x"
WEXTRA = "" if iswindows else "-Wextra" WEXTRA = "" if iswindows else "-Wextra"
WCONVERSION = "" if iswindows else "-Wconversion" WCONVERSION = "" if iswindows else "-Wconversion"
PEDANTIC = "" if iswindows else "-pedantic" PEDANTIC = "" if iswindows else "-pedantic"
SHA1LIB_DEFINE = "/DSHA1_USE_SHA1DC" if iswindows else "-DSHA1_USE_SHA1DC"
SHA1_LIBRARY = "sha1detectcoll"
NOOPTIMIZATION = "/Od" if iswindows else "-O0" NOOPTIMIZATION = "/Od" if iswindows else "-O0"
OPTIMIZATION = "" if iswindows else "-O2" OPTIMIZATION = "" if iswindows else "-O2"
PRODUCEDEBUGSYMBOLS = "/DEBUG:FULL" if iswindows else "-g" PRODUCEDEBUGSYMBOLS = "/DEBUG:FULL" if iswindows else "-g"
# whether to use Cython to recompile .pyx to .c/.cpp at build time. # whether to use Cython to recompile .pyx to .c/.cpp at build time.
# if False, fallback to .c/.cpp in the repo and .pyx files are ignored. # if False, fallback to .c/.cpp in the repo and .pyx files are ignored.
# if True, re-compile .c/.cpp from .pyx files, require cython at build time. # if True, re-compile .c/.cpp from .pyx files, require cython at build time.
if 'USECYTHON' in os.environ: if 'USECYTHON' in os.environ:
if arg == '--component' and len(sys.argv) > i + 1: if arg == '--component' and len(sys.argv) > i + 1:
components.extend(sys.argv[i + 1].split(',')) components.extend(sys.argv[i + 1].split(','))
skip = True skip = True
else: else:
args.append(arg) args.append(arg)
sys.argv = args sys.argv = args
cflags = [] cflags = [SHA1LIB_DEFINE]
# if this is set, compile all C extensions with -O0 -g for easy debugging. note # if this is set, compile all C extensions with -O0 -g for easy debugging. note
# that this is not manifested in any way in the Makefile dependencies. # that this is not manifested in any way in the Makefile dependencies.
# therefore, if you already have build products, they won't be rebuilt! # therefore, if you already have build products, they won't be rebuilt!
if os.getenv('FB_HGEXT_CDEBUG') is not None: if os.getenv('FB_HGEXT_CDEBUG') is not None:
cflags.extend([NOOPTIMIZATION, PRODUCEDEBUGSYMBOLS]) cflags.extend([NOOPTIMIZATION, PRODUCEDEBUGSYMBOLS])
else: else:
cflags.append(WERROR) cflags.append(WERROR)
# Static c libaries # Static c libaries
if iswindows: if iswindows:
availablelibraries = {} availablelibraries = {}
else: else:
availablelibraries = { availablelibraries = {
'datapack': { 'datapack': {
"sources" : ["cdatapack/cdatapack.c"], "sources" : ["cdatapack/cdatapack.c"],
"include_dirs" : ["clib"] + include_dirs, "include_dirs" : ["clib"] + include_dirs,
"libraries" : ["lz4", "sha1detectcoll"], "libraries" : ["lz4", SHA1_LIBRARY],
"extra_args" : filter(None, "extra_args" : filter(None,
[STDC99, WALL, WERROR, WSTRICTPROTOTYPES] + cflags), [STDC99, WALL, WERROR, WSTRICTPROTOTYPES] + cflags),
}, },
'mpatch': { 'mpatch': {
'sources': ['cstore/mpatch.c'] 'sources': ['cstore/mpatch.c']
}, },
"sha1detectcoll": { "sha1detectcoll": {
"sources" : [ "sources" : [
] + include_dirs, ] + include_dirs,
library_dirs=[ library_dirs=[
'build/' + distutils_dir_name('lib'), 'build/' + distutils_dir_name('lib'),
] + library_dirs, ] + library_dirs,
libraries=[ libraries=[
'datapack', 'datapack',
'lz4', 'lz4',
'mpatch', 'mpatch',
'sha1detectcoll', SHA1_LIBRARY,
], ],
extra_compile_args=filter(None, [STDCPP0X, WALL] + cflags), extra_compile_args=filter(None, [STDCPP0X, WALL] + cflags),
), ),
], ],
'cfastmanifest' : [ 'cfastmanifest' : [
Extension('cfastmanifest', Extension('cfastmanifest',
sources=['cfastmanifest.c', sources=['cfastmanifest.c',
'cfastmanifest/bsearch.c', 'cfastmanifest/bsearch.c',
], ],
include_dirs=[ include_dirs=[
'.', '.',
'cfastmanifest', 'cfastmanifest',
'clib', 'clib',
'third-party', 'third-party',
] + include_dirs, ] + include_dirs,
library_dirs=library_dirs, library_dirs=library_dirs,
libraries=['sha1detectcoll'], libraries=[SHA1_LIBRARY],
extra_compile_args=filter(None, [ extra_compile_args=filter(None, [
STDC99, STDC99,
WALL, WALL,
WSTRICTPROTOTYPES, WSTRICTPROTOTYPES,
] + cflags), ] + cflags),
), ),
], ],
'linelog' : [ 'linelog' : [