Skip to content

Add protection against integer overflows in sugar functions #1457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Enchufa2 wants to merge 15 commits into
base: master
Choose a base branch
from
+494 −181
Open

Add protection against integer overflows in sugar functions #1457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
38178a8
implementation of safe add/sub/mul for integers
Enchufa2 Feb 24, 2026
7bcb01b
fix duplicated define
Enchufa2 Feb 25, 2026
f7420e4
fix couple of tests, explicitly check for overflow errors
Enchufa2 Feb 25, 2026
3adff65
fix functions/diff.h
Enchufa2 Feb 25, 2026
5232eea
fix functions/cumprod.h
Enchufa2 Feb 25, 2026
3835da4
fix functions/cumsum.h
Enchufa2 Feb 25, 2026
98734f9
move functions further down into the detail namespace
Enchufa2 Feb 25, 2026
0e79600
fix functions/rowSums.h
Enchufa2 Feb 25, 2026
638f329
fix functions/sum.h
Enchufa2 Feb 26, 2026
fa4f833
fix operators/minus.h
Enchufa2 Feb 26, 2026
6e012f5
fix operators/plus.h
Enchufa2 Feb 26, 2026
a8ce757
fix operators/times.h
Enchufa2 Feb 26, 2026
b06d8dc
update ChangeLog
Enchufa2 Feb 26, 2026
87dc09c
couple of fixes suggested by Claude
Enchufa2 Feb 27, 2026
7ec0389
Merge branch 'master' into safe_math
Enchufa2 Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions ChangeLog
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,28 @@
* inst/include/Rcpp/sugar/functions/min.h: Idem
* inst/tinytest/test_sugar.R: Adapt tests

2026-02-26 Iñaki Ucar <iucar@fedoraproject.org>

* inst/include/Rcpp/sugar/tools/safe_math.h: New header implementing safe
versions of add/sub/mul operations for integral types
* inst/include/Rcpp/sugar/sugar.h: Includes the previous header

* inst/include/Rcpp/sugar/functions/cumprod.h: Use the previous operations
* inst/include/Rcpp/sugar/functions/cumsum.h: Idem
* inst/include/Rcpp/sugar/functions/diff.h: Idem, also fixed a bug where
the diff was recomputed instead of returning the calculated value
* inst/include/Rcpp/sugar/functions/rowSums.h: Idem
* inst/include/Rcpp/sugar/functions/sum.h: Idem
* inst/include/Rcpp/sugar/operators/minus.h: Idem, also fixed a bug for
an incorrect Extractor specialization in Minus_Primitive_Vector
* inst/include/Rcpp/sugar/operators/plus.h: Idem
* inst/include/Rcpp/sugar/operators/times.h: Idem

* inst/tinytest/test_sugar.R: New tests covering the new operations
* inst/tinytest/cpp/sugar.cpp: Idem
* inst/tinytest/cpp/sugar_safe_math.cpp: Idem
* inst/tinytest/cpp/sugar_safe_math_fallback.cpp: Idem

2026-02-17 Dirk Eddelbuettel <edd@debian.org>

* DESCRIPTION (Version, Date): Roll micro version and date
Expand Down
13 changes: 7 additions & 6 deletions inst/include/Rcpp/sugar/functions/cumprod.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
//
// cumsum.h: Rcpp R/C++ interface class library -- cumsum
//
// Copyright (C) 2010 - 2011 Dirk Eddelbuettel and Romain Francois
// Copyright (C) 2010 - 2025 Dirk Eddelbuettel and Romain Francois
// Copyright (C) 2026 Dirk Eddelbuettel, Romain Francois and Iñaki Ucar
//
// This file is part of Rcpp.
//
Expand Down Expand Up @@ -33,23 +34,23 @@ class Cumprod : public Lazy< Rcpp::Vector<RTYPE>, Cumprod<RTYPE, NA, T> > {
typedef Rcpp::Vector<RTYPE> VECTOR;

Cumprod(const VEC_TYPE& object_) : object(object_) {}

VECTOR get() const {
R_xlen_t n = object.size();
VECTOR result(n, Rcpp::traits::get_na<RTYPE>());
STORAGE current = object[0];

if (Rcpp::traits::is_na<RTYPE>(current)) return result;
result[0] = current;
for (R_xlen_t i = 1; i < n; i++) {
current = object[i];
if (Rcpp::traits::is_na<RTYPE>(current)) return result;
result[i] = result[i-1] * current;
result[i] = RCPP_SAFE_MUL(result[i-1], current);
}
return result ;
}
private:
const VEC_TYPE& object;
const VEC_TYPE& object;
};

} // sugar
Expand All @@ -72,5 +73,5 @@ inline sugar::Cumprod<CPLXSXP, NA, T> cumprod(const VectorBase<CPLXSXP, NA, T>&


} // Rcpp
#endif // Rcpp__sugar__cumprod_h
#endif // Rcpp__sugar__cumprod_h

5 changes: 3 additions & 2 deletions inst/include/Rcpp/sugar/functions/cumsum.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
//
// cumsum.h: Rcpp R/C++ interface class library -- cumsum
//
// Copyright (C) 2010 - 2011 Dirk Eddelbuettel and Romain Francois
// Copyright (C) 2010 - 2025 Dirk Eddelbuettel and Romain Francois
// Copyright (C) 2026 Dirk Eddelbuettel, Romain Francois and Iñaki Ucar
//
// This file is part of Rcpp.
//
Expand Down Expand Up @@ -45,7 +46,7 @@ class Cumsum : public Lazy< Rcpp::Vector<RTYPE> , Cumsum<RTYPE,NA,T> > {
current = object[i] ;
if( Rcpp::traits::is_na<RTYPE>(current) )
return result ;
result[i] = result[i-1] + current ;
result[i] = RCPP_SAFE_ADD(result[i-1], current);
}
return result ;
}
Expand Down
11 changes: 6 additions & 5 deletions inst/include/Rcpp/sugar/functions/diff.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
//
// diff.h: Rcpp R/C++ interface class library -- diff
//
// Copyright (C) 2010 - 2013 Dirk Eddelbuettel and Romain Francois
// Copyright (C) 2010 - 2025 Dirk Eddelbuettel and Romain Francois
// Copyright (C) 2026 Dirk Eddelbuettel, Romain Francois and Iñaki Ucar
//
// This file is part of Rcpp.
//
Expand Down Expand Up @@ -51,7 +52,7 @@ class Diff : public Rcpp::VectorBase< RTYPE, LHS_NA , Diff<RTYPE,LHS_NA,LHS_T> >
set_previous(i+1, y ) ;
return traits::get_na<RTYPE>() ; // NA
}
STORAGE res = y - previous ;
STORAGE res = RCPP_SAFE_SUB(y, previous);
set_previous( i+1, y) ;
return res ;
}
Expand Down Expand Up @@ -81,7 +82,7 @@ class Diff<REALSXP, LHS_NA, LHS_T> : public Rcpp::VectorBase< REALSXP, LHS_NA, D
inline double operator[]( R_xlen_t i ) const {
double y = lhs[i+1] ;
if( previous_index != i ) previous = lhs[i] ;
double res = y - previous ;
double res = RCPP_SAFE_SUB(y, previous);
previous = y ;
previous_index = i+1 ;
return res ;
Expand All @@ -105,10 +106,10 @@ class Diff<RTYPE,false,LHS_T> : public Rcpp::VectorBase< RTYPE, false , Diff<RTY
inline STORAGE operator[]( R_xlen_t i ) const {
STORAGE y = lhs[i+1] ;
if( previous_index != i ) previous = lhs[i] ;
STORAGE diff = y - previous ;
STORAGE res = RCPP_SAFE_SUB(y, previous);
previous = y ;
previous_index = i+1 ;
return y - previous ;
return res;
}
inline R_xlen_t size() const { return lhs.size() - 1 ; }

Expand Down
Loading