xref: /freebsd/contrib/bc/NEWS.md (revision 69c5fa5cd1ec9b09ed88a086607a8a0993818db9)
1# News
2
3## 3.2.6
4
5This is a production release that fixes the build on FreeBSD.
6
7There was a syntax error in `configure.sh` that the Linux shell did not catch,
8and FreeBSD depends on the existence of `tests/all.sh`.
9
10All users that already upgraded to `3.2.5` should update to this release, with
11my apologies for the poor release of `3.2.5`. Other users should skip `3.2.5` in
12favor of this version.
13
14## 3.2.5
15
16This is a production release that fixes several bugs and adds a couple small
17things.
18
19The two most important bugs were bugs that causes `dc` to access memory
20out-of-bounds (crash in debug builds). This was found by upgrading to `afl++`
21from `afl`. Both were caused by a failure to distinguish between the same two
22cases.
23
24Another bug was the failure to put all of the licenses in the `LICENSE.md` file.
25
26Third, some warnings by `scan-build` were found and eliminated. This needed one
27big change: `bc` and `dc` now bail out as fast as possible on fatal errors
28instead of unwinding the stack.
29
30Fourth, the pseudo-random number now attempts to seed itself with `/dev/random`
31if `/dev/urandom` fails.
32
33Finally, this release has a few quality-of-life changes to the build system. The
34usage should not change at all; the only thing that changed was making sure the
35`Makefile.in` was written to rebuild properly when headers changed and to not
36rebuild when not necessary.
37
38## 3.2.4
39
40This is a production release that fixes a warning on `gcc` 6 or older, which
41does not have an attribute that is used.
42
43Users do ***NOT*** need to upgrade if they don't use `gcc` 6 or older.
44
45## 3.2.3
46
47This is a production release that fixes a bug in `gen/strgen.sh`. I recently
48changed `gen/strgen.c`, but I did not change `gen/strgen.sh`.
49
50Users that do not use `gen/strgen.sh` do not need to upgrade.
51
52## 3.2.2
53
54This is a production release that fixes a portability bug in `configure.sh`. The
55bug was using the GNU `find` extension `-wholename`.
56
57## 3.2.1
58
59This is a production release that has one fix for `bcl(3)`. It is technically
60not a bug fix since the behavior is undefined, but the `BclNumber`s that
61`bcl_divmod()` returns will be set to `BCL_ERROR_INVALID_NUM` if there is an
62error. Previously, they were not set.
63
64## 3.2.0
65
66This is a production release that has one bug fix and a major addition.
67
68The bug fix was a missing `auto` variable in the bessel `j()` function in the
69math library.
70
71The major addition is a way to build a version of `bc`'s math code as a library.
72This is done with the `-a` option to `configure.sh`. The API for the library can
73be read in `./manuals/bcl.3.md` or `man bcl` once the library is installed with
74`make install`.
75
76This library was requested by developers before I even finished version 1.0, but
77I could not figure out how to do it until now.
78
79If the library has API breaking changes, the major version of `bc` will be
80incremented.
81
82## 3.1.6
83
84This is a production release that fixes a new warning from Clang 12 for FreeBSD
85and also removes some possible undefined behavior found by UBSan that compilers
86did not seem to take advantage of.
87
88Users do ***NOT*** need to upgrade, if they do not want to.
89
90## 3.1.5
91
92This is a production release that fixes the Chinese locales (which caused `bc`
93to crash) and a crash caused by `bc` executing code when it should not have been
94able to.
95
96***ALL USERS SHOULD UPGRADE.***
97
98## 3.1.4
99
100This is a production release that fixes one bug, changes two behaviors, and
101removes one environment variable.
102
103The bug is like the one in the last release except it applies if files are being
104executed. I also made the fix more general.
105
106The behavior that was changed is that `bc` now exits when given `-e`, `-f`,
107`--expression` or `--file`. However, if the last one of those is `-f-` (using
108`stdin` as the file), `bc` does not exit. If `-f-` exists and is not the last of
109the `-e` and `-f` options (and equivalents), `bc` gives a fatal error and exits.
110
111Next, I removed the `BC_EXPR_EXIT` and `DC_EXPR_EXIT` environment variables
112since their use is not needed with the behavior change.
113
114Finally, I made it so `bc` does not print the header, though the `-q` and
115`--quiet` options were kept for compatibility with GNU `bc`.
116
117## 3.1.3
118
119This is a production release that fixes one minor bug: if `bc` was invoked like
120the following, it would error:
121
122```
123echo "if (1 < 3) 1" | bc
124```
125
126Unless users run into this bug, they do not need to upgrade, but it is suggested
127that they do.
128
129## 3.1.2
130
131This is a production release that adds a way to install *all* locales. Users do
132***NOT*** need to upgrade.
133
134For package maintainers wishing to make use of the change, just pass `-l` to
135`configure.sh`.
136
137## 3.1.1
138
139This is a production release that adds two Spanish locales. Users do ***NOT***
140need to upgrade, unless they want those locales.
141
142## 3.1.0
143
144This is a production release that adjusts one behavior, fixes eight bugs, and
145improves manpages for FreeBSD. Because this release fixes bugs, **users and
146package maintainers should update to this version as soon as possible**.
147
148The behavior that was adjusted was how code from the `-e` and `-f` arguments
149(and equivalents) were executed. They used to be executed as one big chunk, but
150in this release, they are now executed line-by-line.
151
152The first bug fix in how output to `stdout` was handled in `SIGINT`. If a
153`SIGINT` came in, the `stdout` buffer was not correctly flushed. In fact, a
154clean-up function was not getting called. This release fixes that bug.
155
156The second bug is in how `dc` handled input from `stdin`. This affected `bc` as
157well since it was a mishandling of the `stdin` buffer.
158
159The third fixed bug was that `bc` and `dc` could `abort()` (in debug mode) when
160receiving a `SIGTERM`. This one was a race condition with pushing and popping
161items onto and out of vectors.
162
163The fourth bug fixed was that `bc` could leave extra items on the stack and
164thus, not properly clean up some memory. (The memory would still get
165`free()`'ed, but it would not be `free()`'ed when it could have been.)
166
167The next two bugs were bugs in `bc`'s parser that caused crashes when executing
168the resulting code.
169
170The last two bugs were crashes in `dc` that resulted from mishandling of
171strings.
172
173The manpage improvement was done by switching from [ronn][20] to [Pandoc][21] to
174generate manpages. Pandoc generates much cleaner manpages and doesn't leave
175blank lines where they shouldn't be.
176
177## 3.0.3
178
179This is a production release that adds one new feature: specific manpages.
180
181Before this release, `bc` and `dc` only used one manpage each that referred to
182various build options. This release changes it so there is one manpage set per
183relevant build type. Each manual only has information about its particular
184build, and `configure.sh` selects the correct set for install.
185
186## 3.0.2
187
188This is a production release that adds `utf8` locale symlinks and removes an
189unused `auto` variable from the `ceil()` function in the [extended math
190library][16].
191
192Users do ***NOT*** need to update unless they want the locales.
193
194## 3.0.1
195
196This is a production release with two small changes. Users do ***NOT*** need to
197upgrade to this release; however, if they haven't upgraded to `3.0.0` yet, it
198may be worthwhile to upgrade to this release.
199
200The first change is fixing a compiler warning on FreeBSD with strict warnings
201on.
202
203The second change is to make the new implementation of `ceil()` in `lib2.bc`
204much more efficient.
205
206## 3.0.0
207
208*Notes for package maintainers:*
209
210*First, the `2.7.0` release series saw a change in the option parsing. This made
211me change one error message and add a few others. The error message that was
212changed removed one format specifier. This means that `printf()` will seqfault
213on old locale files. Unfortunately, `bc` cannot use any locale files except the
214global ones that are already installed, so it will use the previous ones while
215running tests during install. **If `bc` segfaults while running arg tests when
216updating, it is because the global locale files have not been replaced. Make
217sure to either prevent the test suite from running on update or remove the old
218locale files before updating.** (Removing the locale files can be done with
219`make uninstall` or by running the `locale_uninstall.sh` script.) Once this is
220done, `bc` should install without problems.*
221
222*Second, **the option to build without signal support has been removed**. See
223below for the reasons why.*
224
225This is a production release with some small bug fixes, a few improvements,
226three major bug fixes, and a complete redesign of `bc`'s error and signal
227handling. **Users and package maintainers should update to this version as soon
228as possible.**
229
230The first major bug fix was in how `bc` executed files. Previously, a whole file
231was parsed before it was executed, but if a function is defined *after* code,
232especially if the function definition was actually a redefinition, and the code
233before the definition referred to the previous function, this `bc` would replace
234the function before executing any code. The fix was to make sure that all code
235that existed before a function definition was executed.
236
237The second major bug fix was in `bc`'s `lib2.bc`. The `ceil()` function had a
238bug where a `0` in the decimal place after the truncation position, caused it to
239output the wrong numbers if there was any non-zero digit after.
240
241The third major bug is that when passing parameters to functions, if an
242expression included an array (not an array element) as a parameter, it was
243accepted, when it should have been rejected. It is now correctly rejected.
244
245Beyond that, this `bc` got several improvements that both sped it up, improved
246the handling of signals, and improved the error handling.
247
248First, the requirements for `bc` were pushed back to POSIX 2008. `bc` uses one
249function, `strdup()`, which is not in POSIX 2001, and it is in the X/Open System
250Interfaces group 2001. It is, however, in POSIX 2008, and since POSIX 2008 is
251old enough to be supported anywhere that I care, that should be the requirement.
252
253Second, the BcVm global variable was put into `bss`. This actually slightly
254reduces the size of the executable from a massive code shrink, and it will stop
255`bc` from allocating a large set of memory when `bc` starts.
256
257Third, the default Karatsuba length was updated from 64 to 32 after making the
258optimization changes below, since 32 is going to be better than 64 after the
259changes.
260
261Fourth, Spanish translations were added.
262
263Fifth, the interpreter received a speedup to make performance on non-math-heavy
264scripts more competitive with GNU `bc`. While improvements did, in fact, get it
265much closer (see the [benchmarks][19]), it isn't quite there.
266
267There were several things done to speed up the interpreter:
268
269First, several small inefficiencies were removed. These inefficiencies included
270calling the function `bc_vec_pop(v)` twice instead of calling
271`bc_vec_npop(v, 2)`. They also included an extra function call for checking the
272size of the stack and checking the size of the stack more than once on several
273operations.
274
275Second, since the current `bc` function is the one that stores constants and
276strings, the program caches pointers to the current function's vectors of
277constants and strings to prevent needing to grab the current function in order
278to grab a constant or a string.
279
280Third, `bc` tries to reuse `BcNum`'s (the internal representation of
281arbitary-precision numbers). If a `BcNum` has the default capacity of
282`BC_NUM_DEF_SIZE` (32 on 64-bit and 16 on 32-bit) when it is freed, it is added
283to a list of available `BcNum`'s. And then, when a `BcNum` is allocated with a
284capacity of `BC_NUM_DEF_SIZE` and any `BcNum`'s exist on the list of reusable
285ones, one of those ones is grabbed instead.
286
287In order to support these changes, the `BC_NUM_DEF_SIZE` was changed. It used to
288be 16 bytes on all systems, but it was changed to more closely align with the
289minimum allocation size on Linux, which is either 32 bytes (64-bit musl), 24
290bytes (64-bit glibc), 16 bytes (32-bit musl), or 12 bytes (32-bit glibc). Since
291these are the minimum allocation sizes, these are the sizes that would be
292allocated anyway, making it worth it to just use the whole space, so the value
293of `BC_NUM_DEF_SIZE` on 64-bit systems was changed to 32 bytes.
294
295On top of that, at least on 64-bit, `BC_NUM_DEF_SIZE` supports numbers with
296either 72 integer digits or 45 integer digits and 27 fractional digits. This
297should be more than enough for most cases since `bc`'s default `scale` values
298are 0 or 20, meaning that, by default, it has at most 20 fractional digits. And
29945 integer digits are *a lot*; it's enough to calculate the amount of mass in
300the Milky Way galaxy in kilograms. Also, 72 digits is enough to calculate the
301diameter of the universe in Planck lengths.
302
303(For 32-bit, these numbers are either 32 integer digits or 12 integer digits and
30420 fractional digits. These are also quite big, and going much bigger on a
30532-bit system seems a little pointless since 12 digits in just under a trillion
306and 20 fractional digits is still enough for about any use since `10^-20` light
307years is just under a millimeter.)
308
309All of this together means that for ordinary uses, and even uses in scientific
310work, the default number size will be all that is needed, which means that
311nearly all, if not all, numbers will be reused, relieving pressure on the system
312allocator.
313
314I did several experiments to find the changes that had the most impact,
315especially with regard to reusing `BcNum`'s. One was putting `BcNum`'s into
316buckets according to their capacity in powers of 2 up to 512. That performed
317worse than `bc` did in `2.7.2`. Another was putting any `BcNum` on the reuse
318list that had a capacity of `BC_NUM_DEF_SIZE * 2` and reusing them for `BcNum`'s
319that requested `BC_NUM_DEF_SIZE`. This did reduce the amount of time spent, but
320it also spent a lot of time in the system allocator for an unknown reason. (When
321using `strace`, a bunch more `brk` calls showed up.) Just reusing `BcNum`'s that
322had exactly `BC_NUM_DEF_SIZE` capacity spent the smallest amount of time in both
323user and system time. This makes sense, especially with the changes to make
324`BC_NUM_DEF_SIZE` bigger on 64-bit systems, since the vast majority of numbers
325will only ever use numbers with a size less than or equal to `BC_NUM_DEF_SIZE`.
326
327Last of all, `bc`'s signal handling underwent a complete redesign. (This is the
328reason that this version is `3.0.0` and not `2.8.0`.) The change was to move
329from a polling approach to signal handling to an interrupt-based approach.
330
331Previously, every single loop condition had a check for signals. I suspect that
332this could be expensive when in tight loops.
333
334Now, the signal handler just uses `longjmp()` (actually `siglongjmp()`) to start
335an unwinding of the stack until it is stopped or the stack is unwound to
336`main()`, which just returns. If `bc` is currently executing code that cannot be
337safely interrupted (according to POSIX), then signals are "locked." The signal
338handler checks if the lock is taken, and if it is, it just sets the status to
339indicate that a signal arrived. Later, when the signal lock is released, the
340status is checked to see if a signal came in. If so, the stack unwinding starts.
341
342This design eliminates polling in favor of maintaining a stack of `jmp_buf`'s.
343This has its own performance implications, but it gives better interaction. And
344the cost of pushing and popping a `jmp_buf` in a function is paid at most twice.
345Most functions do not pay that price, and most of the rest only pay it once.
346(There are only some 3 functions in `bc` that push and pop a `jmp_buf` twice.)
347
348As a side effect of this change, I had to eliminate the use of `stdio.h` in `bc`
349because `stdio` does not play nice with signals and `longjmp()`. I implemented
350custom I/O buffer code that takes a fraction of the size. This means that static
351builds will be smaller, but non-static builds will be bigger, though they will
352have less linking time.
353
354This change is also good because my history implementation was already bypassing
355`stdio` for good reasons, and unifying the architecture was a win.
356
357Another reason for this change is that my `bc` should *always* behave correctly
358in the presence of signals like `SIGINT`, `SIGTERM`, and `SIGQUIT`. With the
359addition of my own I/O buffering, I needed to also make sure that the buffers
360were correctly flushed even when such signals happened.
361
362For this reason, I **removed the option to build without signal support**.
363
364As a nice side effect of this change, the error handling code could be changed
365to take advantage of the stack unwinding that signals used. This means that
366signals and error handling use the same code paths, which means that the stack
367unwinding is well-tested. (Errors are tested heavily in the test suite.)
368
369It also means that functions do not need to return a status code that
370***every*** caller needs to check. This eliminated over 100 branches that simply
371checked return codes and then passed that return code up the stack if necessary.
372The code bloat savings from this is at least 1700 bytes on `x86_64`, *before*
373taking into account the extra code from removing `stdio.h`.
374
375## 2.7.2
376
377This is a production release with one major bug fix.
378
379The `length()` built-in function can take either a number or an array. If it
380takes an array, it returns the length of the array. Arrays can be passed by
381reference. The bug is that the `length()` function would not properly
382dereference arrays that were references. This is a bug that affects all users.
383
384**ALL USERS SHOULD UPDATE `bc`**.
385
386## 2.7.1
387
388This is a production release with fixes for new locales and fixes for compiler
389warnings on FreeBSD.
390
391## 2.7.0
392
393This is a production release with a bug fix for Linux, new translations, and new
394features.
395
396Bug fixes:
397
398* Option parsing in `BC_ENV_ARGS` was broken on Linux in 2.6.1 because `glibc`'s
399  `getopt_long()` is broken. To get around that, and to support long options on
400  every platform, an adapted version of [`optparse`][17] was added. Now, `bc`
401  does not even use `getopt()`.
402* Parsing `BC_ENV_ARGS` with quotes now works. It isn't the smartest, but it
403  does the job if there are spaces in file names.
404
405The following new languages are supported:
406
407* Dutch
408* Polish
409* Russian
410* Japanes
411* Simplified Chinese
412
413All of these translations were generated using [DeepL][18], so improvements are
414welcome.
415
416There is only one new feature: **`bc` now has a built-in pseudo-random number
417generator** (PRNG).
418
419The PRNG is seeded, making it useful for applications where
420`/dev/urandom` does not work because output needs to be reproducible. However,
421it also uses `/dev/urandom` to seed itself by default, so it will start with a
422good seed by default.
423
424It also outputs 32 bits on 32-bit platforms and 64 bits on 64-bit platforms, far
425better than the 15 bits of C's `rand()` and `bash`'s `$RANDOM`.
426
427In addition, the PRNG can take a bound, and when it gets a bound, it
428automatically adjusts to remove bias. It can also generate numbers of arbitrary
429size. (As of the time of release, the largest pseudo-random number generated by
430this `bc` was generated with a bound of `2^(2^20)`.)
431
432***IMPORTANT: read the [`bc` manual][9] and the [`dc` manual][10] to find out
433exactly what guarantees the PRNG provides. The underlying implementation is not
434guaranteed to stay the same, but the guarantees that it provides are guaranteed
435to stay the same regardless of the implementation.***
436
437On top of that, four functions were added to `bc`'s [extended math library][16]
438to make using the PRNG easier:
439
440* `frand(p)`: Generates a number between `[0,1)` to `p` decimal places.
441* `ifrand(i, p)`: Generates an integer with bound `i` and adds it to `frand(p)`.
442* `srand(x)`: Randomizes the sign of `x`. In other words, it flips the sign of
443  `x` with probability `0.5`.
444* `brand()`: Returns a random boolean value (either `0` or `1`).
445
446## 2.6.1
447
448This is a production release with a bug fix for FreeBSD.
449
450The bug was that when `bc` was built without long options, it would give a fatal
451error on every run. This was caused by a mishandling of `optind`.
452
453## 2.6.0
454
455This release is a production release ***with no bugfixes***. If you do not want
456to upgrade, you don't have to.
457
458No source code changed; the only thing that changed was `lib2.bc`.
459
460This release adds one function to the [extended math library][16]: `p(x, y)`,
461which calculates `x` to the power of `y`, whether or not `y` is an integer. (The
462`^` operator can only accept integer powers.)
463
464This release also includes a couple of small tweaks to the [extended math
465library][16], mostly to fix returning numbers with too high of `scale`.
466
467## 2.5.3
468
469This release is a production release which addresses inconsistencies in the
470Portuguese locales. No `bc` code was changed.
471
472The issues were that the ISO files used different naming, and also that the
473files that should have been symlinks were not. I did not catch that because
474GitHub rendered them the exact same way.
475
476## 2.5.2
477
478This release is a production release.
479
480No code was changed, but the build system was changed to allow `CFLAGS` to be
481given to `CC`, like this:
482
483```
484CC="gcc -O3 -march=native" ./configure.sh
485```
486
487If this happens, the flags are automatically put into `CFLAGS`, and the compiler
488is set appropriately. In the example above this means that `CC` will be "gcc"
489and `CFLAGS` will be "-O3 -march=native".
490
491This behavior was added to conform to GNU autotools practices.
492
493## 2.5.1
494
495This is a production release which addresses portability concerns discovered
496in the `bc` build system. No `bc` code was changed.
497
498* Support for Solaris SPARC and AIX were added.
499* Minor documentations edits were performed.
500* An option for `configure.sh` was added to disable long options if
501  `getopt_long()` is missing.
502
503## 2.5.0
504
505This is a production release with new translations. No code changed.
506
507The translations were contributed by [bugcrazy][15], and they are for
508Portuguese, both Portugal and Brazil locales.
509
510## 2.4.0
511
512This is a production release primarily aimed at improving `dc`.
513
514* A couple of copy and paste errors in the [`dc` manual][10] were fixed.
515* `dc` startup was optimized by making sure it didn't have to set up `bc`-only
516  things.
517* The `bc` `&&` and `||` operators were made available to `dc` through the `M`
518  and `m` commands, respectively.
519* `dc` macros were changed to be tail call-optimized.
520
521The last item, tail call optimization, means that if the last thing in a macro
522is a call to another macro, then the old macro is popped before executing the
523new macro. This change was made to stop `dc` from consuming more and more memory
524as macros are executed in a loop.
525
526The `q` and `Q` commands still respect the "hidden" macros by way of recording
527how many macros were removed by tail call optimization.
528
529## 2.3.2
530
531This is a production release meant to fix warnings in the Gentoo `ebuild` by
532making it possible to disable binary stripping. Other users do *not* need to
533upgrade.
534
535## 2.3.1
536
537This is a production release. It fixes a bug that caused `-1000000000 < -1` to
538return `0`. This only happened with negative numbers and only if the value on
539the left was more negative by a certain amount. That said, this bug *is* a bad
540bug, and needs to be fixed.
541
542**ALL USERS SHOULD UPDATE `bc`**.
543
544## 2.3.0
545
546This is a production release with changes to the build system.
547
548## 2.2.0
549
550This release is a production release. It only has new features and performance
551improvements.
552
5531.	The performance of `sqrt(x)` was improved.
5542.	The new function `root(x, n)` was added to the extended math library to
555	calculate `n`th roots.
5563.	The new function `cbrt(x)` was added to the extended math library to
557	calculate cube roots.
558
559## 2.1.3
560
561This is a non-critical release; it just changes the build system, and in
562non-breaking ways:
563
5641.	Linked locale files were changed to link to their sources with a relative
565	link.
5662.	A bug in `configure.sh` that caused long option parsing to fail under `bash`
567	was fixed.
568
569## 2.1.2
570
571This release is not a critical release.
572
5731.	A few codes were added to history.
5742.	Multiplication was optimized a bit more.
5753.	Addition and subtraction were both optimized a bit more.
576
577## 2.1.1
578
579This release contains a fix for the test suite made for Linux from Scratch: now
580the test suite prints `pass` when a test is passed.
581
582Other than that, there is no change in this release, so distros and other users
583do not need to upgrade.
584
585## 2.1.0
586
587This release is a production release.
588
589The following bugs were fixed:
590
5911.	A `dc` bug that caused stack mishandling was fixed.
5922.	A warning on OpenBSD was fixed.
5933.	Bugs in `ctrl+arrow` operations in history were fixed.
5944.	The ability to paste multiple lines in history was added.
5955.	A `bc` bug, mishandling of array arguments to functions, was fixed.
5966.	A crash caused by freeing the wrong pointer was fixed.
5977.	A `dc` bug where strings, in a rare case, were mishandled in parsing was
598	fixed.
599
600In addition, the following changes were made:
601
6021.	Division was slightly optimized.
6032.	An option was added to the build to disable printing of prompts.
6043.	The special case of empty arguments is now handled. This is to prevent
605	errors in scripts that end up passing empty arguments.
6064.	A harmless bug was fixed. This bug was that, with the pop instructions
607	(mostly) removed (see below), `bc` would leave extra values on its stack for
608	`void` functions and in a few other cases. These extra items would not
609	affect anything put on the stack and would not cause any sort of crash or
610	even buggy behavior, but they would cause `bc` to take more memory than it
611	needed.
612
613On top of the above changes, the following optimizations were added:
614
6151.	The need for pop instructions in `bc` was removed.
6162.	Extra tests on every iteration of the interpreter loop were removed.
6173.	Updating function and code pointers on every iteration of the interpreter
618	loop was changed to only updating them when necessary.
6194.	Extra assignments to pointers were removed.
620
621Altogether, these changes sped up the interpreter by around 2x.
622
623***NOTE***: This is the last release with new features because this `bc` is now
624considered complete. From now on, only bug fixes and new translations will be
625added to this `bc`.
626
627## 2.0.3
628
629This is a production, bug-fix release.
630
631Two bugs were fixed in this release:
632
6331.	A rare and subtle signal handling bug was fixed.
6342.	A misbehavior on `0` to a negative power was fixed.
635
636The last bug bears some mentioning.
637
638When I originally wrote power, I did not thoroughly check its error cases;
639instead, I had it check if the first number was `0` and then if so, just return
640`0`. However, `0` to a negative power means that `1` will be divided by `0`,
641which is an error.
642
643I caught this, but only after I stopped being cocky. You see, sometime later, I
644had noticed that GNU `bc` returned an error, correctly, but I thought it was
645wrong simply because that's not what my `bc` did. I saw it again later and had a
646double take. I checked for real, finally, and found out that my `bc` was wrong
647all along.
648
649That was bad on me. But the bug was easy to fix, so it is fixed now.
650
651There are two other things in this release:
652
6531.	Subtraction was optimized by [Stefan Eßer][14].
6542.	Division was also optimized, also by Stefan Eßer.
655
656## 2.0.2
657
658This release contains a fix for a possible overflow in the signal handling. I
659would be surprised if any users ran into it because it would only happen after 2
660billion (`2^31-1`) `SIGINT`'s, but I saw it and had to fix it.
661
662## 2.0.1
663
664This release contains very few things that will apply to any users.
665
6661.	A slight bug in `dc`'s interactive mode was fixed.
6672.	A bug in the test suite that was only triggered on NetBSD was fixed.
6683.	**The `-P`/`--no-prompt` option** was added for users that do not want a
669	prompt.
6704.	A `make check` target was added as an alias for `make test`.
6715.	`dc` got its own read prompt: `?> `.
672
673## 2.0.0
674
675This release is a production release.
676
677This release is also a little different from previous releases. From here on
678out, I do not plan on adding any more features to this `bc`; I believe that it
679is complete. However, there may be bug fix releases in the future, if I or any
680others manage to find bugs.
681
682This release has only a few new features:
683
6841.	`atan2(y, x)` was added to the extended math library as both `a2(y, x)` and
685	`atan2(y, x)`.
6862.	Locales were fixed.
6873.	A **POSIX shell-compatible script was added as an alternative to compiling
688	`gen/strgen.c`** on a host machine. More details about making the choice
689	between the two can be found by running `./configure.sh --help` or reading
690	the [build manual][13].
6914.	Multiplication was optimized by using **diagonal multiplication**, rather
692	than straight brute force.
6935.	The `locale_install.sh` script was fixed.
6946.	`dc` was given the ability to **use the environment variable
695	`DC_ENV_ARGS`**.
6967.	`dc` was also given the ability to **use the `-i` or `--interactive`**
697	options.
6988.	Printing the prompt was fixed so that it did not print when it shouldn't.
6999.	Signal handling was fixed.
70010.	**Handling of `SIGTERM` and `SIGQUIT`** was fixed.
70111.	The **built-in functions `maxibase()`, `maxobase()`, and `maxscale()`** (the
702	commands `T`, `U`, `V` in `dc`, respectively) were added to allow scripts to
703	query for the max allowable values of those globals.
70412.	Some incompatibilities with POSIX were fixed.
705
706In addition, this release is `2.0.0` for a big reason: the internal format for
707numbers changed. They used to be a `char` array. Now, they are an array of
708larger integers, packing more decimal digits into each integer. This has
709delivered ***HUGE*** performance improvements, especially for multiplication,
710division, and power.
711
712This `bc` should now be the fastest `bc` available, but I may be wrong.
713
714## 1.2.8
715
716This release contains a fix for a harmless bug (it is harmless in that it still
717works, but it just copies extra data) in the [`locale_install.sh`][12] script.
718
719## 1.2.7
720
721This version contains fixes for the build on Arch Linux.
722
723## 1.2.6
724
725This release removes the use of `local` in shell scripts because it's not POSIX
726shell-compatible, and also updates a man page that should have been updated a
727long time ago but was missed.
728
729## 1.2.5
730
731This release contains some missing locale `*.msg` files.
732
733## 1.2.4
734
735This release contains a few bug fixes and new French translations.
736
737## 1.2.3
738
739This release contains a fix for a bug: use of uninitialized data. Such data was
740only used when outputting an error message, but I am striving for perfection. As
741Michelangelo said, "Trifles make perfection, and perfection is no trifle."
742
743## 1.2.2
744
745This release contains fixes for OpenBSD.
746
747## 1.2.1
748
749This release contains bug fixes for some rare bugs.
750
751## 1.2.0
752
753This is a production release.
754
755There have been several changes since `1.1.0`:
756
7571.	The build system had some changes.
7582.	Locale support has been added. (Patches welcome for translations.)
7593.	**The ability to turn `ibase`, `obase`, and `scale` into stacks** was added
760	with the `-g` command-line option. (See the [`bc` manual][9] for more
761	details.)
7624.	Support for compiling on Mac OSX out of the box was added.
7635.	The extended math library got `t(x)`, `ceil(x)`, and some aliases.
7646.	The extended math library also got `r2d(x)` (for converting from radians to
765	degrees) and `d2r(x)` (for converting from degrees to radians). This is to
766	allow using degrees with the standard library.
7677.	Both calculators now accept numbers in **scientific notation**. See the
768	[`bc` manual][9] and the [`dc` manual][10] for details.
7698.	Both calculators can **output in either scientific or engineering
770	notation**. See the [`bc` manual][9] and the [`dc` manual][10] for details.
7719.	Some inefficiencies were removed.
77210.	Some bugs were fixed.
77311.	Some bugs in the extended library were fixed.
77412.	Some defects from [Coverity Scan][11] were fixed.
775
776## 1.1.4
777
778This release contains a fix to the build system that allows it to build on older
779versions of `glibc`.
780
781## 1.1.3
782
783This release contains a fix for a bug in the test suite where `bc` tests and
784`dc` tests could not be run in parallel.
785
786## 1.1.2
787
788This release has a fix for a history bug; the down arrow did not work.
789
790## 1.1.1
791
792This release fixes a bug in the `1.1.0` build system. The source is exactly the
793same.
794
795The bug that was fixed was a failure to install if no `EXECSUFFIX` was used.
796
797## 1.1.0
798
799This is a production release. However, many new features were added since `1.0`.
800
8011.	**The build system has been changed** to use a custom, POSIX
802	shell-compatible configure script ([`configure.sh`][6]) to generate a POSIX
803	make-compatible `Makefile`, which means that `bc` and `dc` now build out of
804	the box on any POSIX-compatible system.
8052.	Out-of-memory and output errors now cause the `bc` to report the error,
806	clean up, and die, rather than just reporting and trying to continue.
8073.	**Strings and constants are now garbage collected** when possible.
8084.	Signal handling and checking has been made more simple and more thorough.
8095.	`BcGlobals` was refactored into `BcVm` and `BcVm` was made global. Some
810	procedure names were changed to reflect its difference to everything else.
8116.	Addition got a speed improvement.
8127.	Some common code for addition and multiplication was refactored into its own
813	procedure.
8148.	A bug was removed where `dc` could have been selected, but the internal
815	`#define` that returned `true` for a query about `dc` would not have
816	returned `true`.
8179.	Useless calls to `bc_num_zero()` were removed.
81810.	**History support was added.** The history support is based off of a
819	[UTF-8 aware fork][7] of [`linenoise`][8], which has been customized with
820	`bc`'s own data structures and signal handling.
82111.	Generating C source from the math library now removes tabs from the library,
822	shrinking the size of the executable.
82312.	The math library was shrunk.
82413.	Error handling and reporting was improved.
82514.	Reallocations were reduced by giving access to the request size for each
826	operation.
82715.	**`abs()` (`b` command for `dc`) was added as a builtin.**
82816.	Both calculators were tested on FreeBSD.
82917.	Many obscure parse bugs were fixed.
83018.	Markdown and man page manuals were added, and the man pages are installed by
831	`make install`.
83219.	Executable size was reduced, though the added features probably made the
833	executable end up bigger.
83420.	**GNU-style array references were added as a supported feature.**
83521.	Allocations were reduced.
83622.	**New operators were added**: `$` (`$` for `dc`), `@` (`@` for `dc`), `@=`,
837	`<<` (`H` for `dc`), `<<=`, `>>` (`h` for `dc`), and `>>=`. See the
838	[`bc` manual][9] and the [`dc` manual][10] for more details.
83923.	**An extended math library was added.** This library contains code that
840	makes it so I can replace my desktop calculator with this `bc`. See the
841	[`bc` manual][3] for more details.
84224.	Support for all capital letters as numbers was added.
84325.	**Support for GNU-style void functions was added.**
84426.	A bug fix for improper handling of function parameters was added.
84527.	Precedence for the or (`||`) operator was changed to match GNU `bc`.
84628.	`dc` was given an explicit negation command.
84729.	`dc` was changed to be able to handle strings in arrays.
848
849## 1.1 Release Candidate 3
850
851This release is the eighth release candidate for 1.1, though it is the third
852release candidate meant as a general release candidate. The new code has not
853been tested as thoroughly as it should for release.
854
855## 1.1 Release Candidate 2
856
857This release is the seventh release candidate for 1.1, though it is the second
858release candidate meant as a general release candidate. The new code has not
859been tested as thoroughly as it should for release.
860
861## 1.1 FreeBSD Beta 5
862
863This release is the sixth release candidate for 1.1, though it is the fifth
864release candidate meant specifically to test if `bc` works on FreeBSD. The new
865code has not been tested as thoroughly as it should for release.
866
867## 1.1 FreeBSD Beta 4
868
869This release is the fifth release candidate for 1.1, though it is the fourth
870release candidate meant specifically to test if `bc` works on FreeBSD. The new
871code has not been tested as thoroughly as it should for release.
872
873## 1.1 FreeBSD Beta 3
874
875This release is the fourth release candidate for 1.1, though it is the third
876release candidate meant specifically to test if `bc` works on FreeBSD. The new
877code has not been tested as thoroughly as it should for release.
878
879## 1.1 FreeBSD Beta 2
880
881This release is the third release candidate for 1.1, though it is the second
882release candidate meant specifically to test if `bc` works on FreeBSD. The new
883code has not been tested as thoroughly as it should for release.
884
885## 1.1 FreeBSD Beta 1
886
887This release is the second release candidate for 1.1, though it is meant
888specifically to test if `bc` works on FreeBSD. The new code has not been tested as
889thoroughly as it should for release.
890
891## 1.1 Release Candidate 1
892
893This is the first release candidate for 1.1. The new code has not been tested as
894thoroughly as it should for release.
895
896## 1.0
897
898This is the first non-beta release. `bc` is ready for production use.
899
900As such, a lot has changed since 0.5.
901
9021.	`dc` has been added. It has been tested even more thoroughly than `bc` was
903	for `0.5`. It does not have the `!` command, and for security reasons, it
904	never will, so it is complete.
9052.	`bc` has been more thoroughly tested. An entire section of the test suite
906	(for both programs) has been added to test for errors.
9073.	A prompt (`>>> `) has been added for interactive mode, making it easier to
908	see inputs and outputs.
9094.	Interrupt handling has been improved, including elimination of race
910	conditions (as much as possible).
9115.	MinGW and [Windows Subsystem for Linux][1] support has been added (see
912	[xstatic][2] for binaries).
9136.	Memory leaks and errors have been eliminated (as far as ASan and Valgrind
914	can tell).
9157.	Crashes have been eliminated (as far as [afl][3] can tell).
9168.	Karatsuba multiplication was added (and thoroughly) tested, speeding up
917	multiplication and power by orders of magnitude.
9189.	Performance was further enhanced by using a "divmod" function to reduce
919	redundant divisions and by removing superfluous `memset()` calls.
92010.	To switch between Karatsuba and `O(n^2)` multiplication, the config variable
921	`BC_NUM_KARATSUBA_LEN` was added. It is set to a sane default, but the
922	optimal number can be found with [`karatsuba.py`][4] (requires Python 3)
923	and then configured through `make`.
92411.	The random math test generator script was changed to Python 3 and improved.
925	`bc` and `dc` have together been run through 30+ million random tests.
92612.	All known math bugs have been fixed, including out of control memory
927	allocations in `sine` and `cosine` (that was actually a parse bug), certain
928	cases of infinite loop on square root, and slight inaccuracies (as much as
929	possible; see the [README][5]) in transcendental functions.
93013.	Parsing has been fixed as much as possible.
93114.	Test coverage was improved to 94.8%. The only paths not covered are ones
932	that happen when `malloc()` or `realloc()` fails.
93315.	An extension to get the length of an array was added.
93416.	The boolean not (`!`) had its precedence change to match negation.
93517.	Data input was hardened.
93618.	`bc` was made fully compliant with POSIX when the `-s` flag is used or
937	`POSIXLY_CORRECT` is defined.
93819.	Error handling was improved.
93920.	`bc` now checks that files it is given are not directories.
940
941## 1.0 Release Candidate 7
942
943This is the seventh release candidate for 1.0. It fixes a few bugs in 1.0
944Release Candidate 6.
945
946## 1.0 Release Candidate 6
947
948This is the sixth release candidate for 1.0. It fixes a few bugs in 1.0 Release
949Candidate 5.
950
951## 1.0 Release Candidate 5
952
953This is the fifth release candidate for 1.0. It fixes a few bugs in 1.0 Release
954Candidate 4.
955
956## 1.0 Release Candidate 4
957
958This is the fourth release candidate for 1.0. It fixes a few bugs in 1.0 Release
959Candidate 3.
960
961## 1.0 Release Candidate 3
962
963This is the third release candidate for 1.0. It fixes a few bugs in 1.0 Release
964Candidate 2.
965
966## 1.0 Release Candidate 2
967
968This is the second release candidate for 1.0. It fixes a few bugs in 1.0 Release
969Candidate 1.
970
971## 1.0 Release Candidate 1
972
973This is the first Release Candidate for 1.0. `bc` is complete, with `dc`, but it
974is not tested.
975
976## 0.5
977
978This beta release completes more features, but it is still not complete nor
979tested as thoroughly as necessary.
980
981## 0.4.1
982
983This beta release fixes a few bugs in 0.4.
984
985## 0.4
986
987This is a beta release. It does not have the complete set of features, and it is
988not thoroughly tested.
989
990[1]: https://docs.microsoft.com/en-us/windows/wsl/install-win10
991[2]: https://pkg.musl.cc/bc/
992[3]: http://lcamtuf.coredump.cx/afl/
993[4]: ./karatsuba.py
994[5]: ./README.md
995[6]: ./configure.sh
996[7]: https://github.com/rain-1/linenoise-mob
997[8]: https://github.com/antirez/linenoise
998[9]: ./manuals/bc/A.1.md
999[10]: ./manuals/dc/A.1.md
1000[11]: https://scan.coverity.com/projects/gavinhoward-bc
1001[12]: ./locale_install.sh
1002[13]: ./manuals/build.md
1003[14]: https://github.com/stesser
1004[15]: https://github.com/bugcrazy
1005[16]: ./manuals/bc/A.1.md#extended-library
1006[17]: https://github.com/skeeto/optparse
1007[18]: https://www.deepl.com/translator
1008[19]: ./manuals/benchmarks.md
1009[20]: https://github.com/apjanke/ronn-ng
1010[21]: https://pandoc.org/
1011