winsup/cygwin/include/cygwin/version.h

   1 /* version.h -- Cygwin version numbers and accompanying documentation.
   2
   3    Copyright 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 Red Hat, Inc.
   4
   5 This file is part of Cygwin.
   6
   7 This software is a copyrighted work licensed under the terms of the
   8 Cygwin license.  Please consult the file "CYGWIN_LICENSE" for
   9 details. */
  10
  11 /* Cygwin versioning is relatively complicated because of its status
  12    as a shared library.  Let's start with how versioning used to be done.
  13
  14    Historical versioning in Cygwin 16.0 to 19.5:
  15
  16    In the olden days of Cygwin, we had a dll major and minor version
  17    and a registry version.  The major number started at 16 because the
  18    "b15" GNU-Win32 release of the compiler tools was out when this
  19    scheme was started.  We incremented the DLL name frequently (for
  20    every official release) and towards the end of this period every
  21    release used a different shared memory area to prevent DLLs from
  22    interfering with each other (embedding a build timestamp into the
  23    name of the shared memory area).  This turned out to be a Bad Idea
  24    (tm) because people needed to mingle separate releases and have
  25    them work together more than we thought they would.  This was
  26    especially problematic when tty info needed to be retained when an
  27    old Cygwin executable executed a newer one.
  28
  29    In the old scheme, we incremented the major number whenever a
  30    change to the dll invalidated existing executables.  This can
  31    happen for a number of reasons, including when functions are
  32    removed from the export list of the dll.  The minor number was
  33    incremented when a change was made that we wanted to record, but
  34    that didn't invalidate existing executables.  Both numbers were
  35    recorded in the executable and in the dll.
  36
  37    In October 1998 (starting with Cygwin 19.6), we started a new
  38    means of Cygwin versioning: */
  39
  40       /* The DLL major and minor numbers correspond to the "version of
  41          the Cygwin library".  This version is used to track important
  42          changes to the DLL and is mainly informative in nature. */
  43
  44 #define CYGWIN_VERSION_DLL_MAJOR 1003
  45 #define CYGWIN_VERSION_DLL_MINOR 23
  46
  47       /* Major numbers before CYGWIN_VERSION_DLL_EPOCH are
  48          incompatible. */
  49
  50 #define CYGWIN_VERSION_DLL_EPOCH 19
  51
  52       /* CYGWIN_VERSION_DLL_COMBINED gives us a single number
  53          representing the combined DLL major and minor numbers. */
  54
  55       /* WATCH OUT FOR OCTAL!  Don't use, say, "00020" for 0.20 */
  56
  57 #define CYGWIN_VERSION_DLL_MAKE_COMBINED(maj, min) (((maj) * 1000) + min)
  58 #define CYGWIN_VERSION_DLL_COMBINED \
  59   CYGWIN_VERSION_DLL_MAKE_COMBINED (CYGWIN_VERSION_DLL_MAJOR, CYGWIN_VERSION_DLL_MINOR)
  60
  61      /* Every version of cygwin <= this uses an old, incorrect method
  62         to determine signal masks. */
  63
  64 #define CYGWIN_VERSION_DLL_BAD_SIGNAL_MASK      19005
  65
  66     /* API versions <= this had a termios structure whose members were
  67        too small to accomodate modern settings. */
  68 #define CYGWIN_VERSION_DLL_OLD_TERMIOS          5
  69 #define CYGWIN_VERSION_DLL_IS_OLD_TERMIOS \
  70   (CYGWIN_VERSION_DLL_MAKE_COMBINED (user_data->api_major, user_data->api_minor) <= \
  71   CYGWIN_VERSION_DLL_OLD_TERMIOS)
  72
  73 #define CYGWIN_VERSION_DLL_MALLOC_ENV           28
  74      /* Old APIs had getc/putc macros that conflict with new CR/LF
  75         handling in the stdio buffers */
  76 #define CYGWIN_VERSION_OLD_STDIO_CRLF_HANDLING \
  77   (CYGWIN_VERSION_DLL_MAKE_COMBINED (user_data->api_major, user_data->api_minor) <= \
  78   20)
  79
  80 #define CYGWIN_VERSION_CHECK_FOR_S_IEXEC \
  81   (CYGWIN_VERSION_DLL_MAKE_COMBINED (user_data->api_major, user_data->api_minor) >= \
  82   36)
  83
  84 #define CYGWIN_VERSION_CHECK_FOR_OLD_O_NONBLOCK \
  85   (CYGWIN_VERSION_DLL_MAKE_COMBINED (user_data->api_major, user_data->api_minor) <= \
  86   28)
  87      /* We used to use the DLL major/minor to track
  88         non-backward-compatible interface changes to the API.  Now we
  89         use an API major/minor number for this purpose. */
  90
  91      /* API_MAJOR 0.0: Initial version.  API_MINOR changes:
  92         1: Export cygwin32_ calls as cygwin_ as well.
  93         2: Export j1, jn, y1, yn.
  94         3: Export dll_noncygwin_dllcrt0.
  95         4: New socket ioctls, revamped ifconf support.
  96         5: Thread support/exports.
  97         6: Change in termios handling.
  98         7: Export scandir and alphasort.
  99         8: Export _ctype_, _sys_errlist, _sys_nerr.
 100         9: Mount-related changes, new cygwin_umount export.
 101            Raw device support (tape, floppies).
 102        10: Fast math routine support added.
 103        11: Export seekdir, telldir.
 104        12: Export pthread_join, pthread_detach.
 105        13: Export math funcs gamma and friends, also _j0, _j1, etc.
 106        14: Export snprintf and vnsprintf.
 107        15: Export glob
 108        16: Export cygwin_stackdump
 109        17: Export fast math stuff
 110        18: Stop exporting _strace_wm
 111        19: Export fchown, lchown, lacl
 112        20: regsub, inet_network
 113        21: incompatible change to stdio cr/lf and buffering
 114        22: Export cygwin_logon_user, cygwin_set_impersonation_token.
 115            geteuid, getegid return effective uid/gid.
 116            getuid, getgid return real uid/gid.
 117            seteuid, setegid set only effective uid/gid.
 118            setuid, setgid set effective and real uid/gid.
 119        23: Export new dll_crt0 interface and cygwin_user_data for use
 120            with crt0 startup code.
 121        24: Export poll and _poll.
 122        25: Export getmode and _getmode.
 123        26: CW_GET_CYGDRIVE_PREFIXES addition to external.cc
 124        27: CW_GETPINFO_FULL addition to external.cc
 125        28: Accidentally bumped by cgf
 126        29: Export hstrerror
 127        30: CW_GET_CYGDRIVE_INFO addition to external.cc
 128        31: Export inet_aton
 129        32: Export getrlimit/setrlimit
 130        33: Export setlogmask
 131        34: Separated out mount table
 132        35: Export drand48, erand48, jrand48, lcong48, lrand48,
 133            mrand48, nrand48, seed48, and srand48.
 134        36: Added _cygwin_S_IEXEC, et al
 135        37: [f]pathconv support _PC_POSIX_PERMISSIONS and _PC_POSIX_SECURITY
 136        38: vscanf, vscanf_r, and random pthread functions
 137        39: asctime_r, ctime_r, gmtime_r, localtime_r
 138        40: fchdir
 139        41: __signgam
 140        42: sys_errlist, sys_nerr
 141        43: sigsetjmp, siglongjmp fixed
 142        44: Export dirfd
 143        45: perprocess change, gamma_r, gammaf_r, lgamma_r, lgammaf_r
 144        46: Remove cygwin_getshared
 145        47: Report EOTWarningZoneSize in struct mtget.
 146        48: Export "posix" regex functions
 147        49: Export setutent, endutent, utmpname, getutent, getutid, getutline.
 148        50: Export fnmatch.
 149        51: Export recvmsg, sendmsg.
 150        52: Export strptime
 151        53: Export strlcat, strlcpy.
 152        54: Export __fpclassifyd, __fpclassifyf, __signbitd, __signbitf.
 153        55: Export fcloseall, fcloseall_r.
 154        56: Make ntsec on by default.
 155        57: Export setgroups.
 156        58: Export memalign, valloc, malloc_trim, malloc_usable_size, mallopt,
 157            malloc_stats
 158        59: getsid
 159        60: MSG_NOSIGNAL
 160        61: Export getc_unlocked, getchar_unlocked, putc_unlocked,
 161            putchar_unlocked
 162        62: Erroneously bumped
 163        63: Export pututline
 164        64: Export fseeko, ftello
 165        65: Export siginterrupt
 166        66: Export nl_langinfo
 167        67: Export pthread_getsequence_np
 168        68: Export netdb stuff
 169        69: Export strtof
 170        70: Export asprintf, _asprintf_r, vasprintf, _vasprintf_r
 171        71: Export strerror_r
 172        72: Export nanosleep
 173        73: Export setreuid32, setreuid, setregid32, setregid
 174        74: Export _strtold a64l hcreate hcreate_r hdestroy hdestroy_r hsearch
 175                   hsearch_r isblank iswalnum iswalpha iswblank iswcntrl iswctype
 176                   iswdigit iswgraph iswlower iswprint iswpunct iswspace iswupper
 177                   iswxdigit l64a mbrlen mbrtowc mbsinit mbsrtowcs mempcpy
 178                   on_exit setbuffer setlinebuf strndup strnlen tdelete tdestroy
 179                   tfind towctrans towlower towupper tsearch twalk wcrtomb wcscat
 180                   wcschr wcscpy wcscspn wcslcat wcslcpy wcsncat wcsncmp wcsncpy
 181                   wcspbrk wcsrchr wcsrtombs wcsspn wcsstr wctob wctob wctrans
 182                   wctype wmemchr wmemcmp wmemcpy wmemmove wmemset
 183        75: Export exp2 exp2f fdim fdimf fma fmaf fmax fmaxf fmin fminf lrint
 184                   lrintf lround lroundf nearbyint nearbyintf remquo remquof
 185                   round roundf scalbln scalblnf sincos sincosf tgamma tgammaf
 186                   truncf
 187        76: mallinfo
 188        77: thread-safe exit/at_exit
 189        78: Use stat and fstat rather than _stat, and _fstat.
 190            Export btowc and trunc.
 191        79: Export acl32 aclcheck32 aclfrommode32 aclfrompbits32 aclfromtext32
 192                   aclsort32 acltomode32 acltopbits32 acltotext32 facl32
 193                   fgetpos64 fopen64 freopen64 fseeko64 fsetpos64 ftello64
 194                   _open64 _lseek64 _fstat64 _stat64 mknod32
 195      */
 196
 197      /* Note that we forgot to bump the api for ualarm, strtoll, strtoull */
 198
 199 #define CYGWIN_VERSION_API_MAJOR 0
 200 #define CYGWIN_VERSION_API_MINOR 79
 201
 202      /* There is also a compatibity version number associated with the
 203         shared memory regions.  It is incremented when incompatible
 204         changes are made to the shared memory region *or* to any named
 205         shared mutexes, semaphores, etc.   The arbitrary starting
 206         version was 0 (cygwin release 98r2). */
 207
 208 #define CYGWIN_VERSION_SHARED_DATA 3
 209
 210      /* An identifier used in the names used to create shared objects.
 211         The full names include the CYGWIN_VERSION_SHARED_DATA version
 212         as well as this identifier. */
 213
 214 #define CYGWIN_VERSION_DLL_IDENTIFIER   "cygwin1"
 215
 216      /* The Cygwin mount table interface in the Win32 registry also
 217         has a version number associated with it in case that is
 218         changed in a non-backwards compatible fashion.  Increment this
 219         version number whenever incompatible changes in mount table
 220         registry usage are made.
 221
 222         1: Original number version.
 223         2: New mount registry layout, system-wide mount accessibility.
 224      */
 225
 226 #define CYGWIN_VERSION_MOUNT_REGISTRY 2
 227
 228      /* Identifiers used in the Win32 registry. */
 229
 230 #define CYGWIN_INFO_CYGNUS_REGISTRY_NAME "Cygnus Solutions"
 231 #define CYGWIN_INFO_CYGWIN_REGISTRY_NAME "Cygwin"
 232 #define CYGWIN_INFO_PROGRAM_OPTIONS_NAME "Program Options"
 233 #define CYGWIN_INFO_CYGWIN_MOUNT_REGISTRY_NAME "mounts v2"
 234 #define CYGWIN_INFO_CYGDRIVE_FLAGS "cygdrive flags"
 235 #define CYGWIN_INFO_CYGDRIVE_PREFIX "cygdrive prefix"
 236 #define CYGWIN_INFO_CYGDRIVE_DEFAULT_PREFIX "/cygdrive"
 237
 238      /* In addition to the above version number strings, the build
 239         process adds some strings that may be useful in
 240         debugging/identifying a particular Cygwin DLL:
 241
 242         The mkvers.sh script at the top level produces a .cc file
 243         which initializes a cygwin_version structure based on the
 244         above version information and creates a string table for
 245         grepping via "fgrep '%%%' cygwinwhatever.dll" if you are
 246         using GNU grep.  Otherwise you may want to do a
 247         "strings cygwinwhatever.dll | fgrep '%%%'" instead.
 248
 249         This will produce output such as:
 250
 251         %%% Cygwin dll_identifier: cygwin
 252         %%% Cygwin api_major: 0
 253         %%% Cygwin api_minor: 0
 254         %%% Cygwin dll_major: 19
 255         %%% Cygwin dll_minor: 6
 256         %%% Cygwin shared_data: 1
 257         %%% Cygwin registry: b15
 258         %%% Cygwin build date: Wed Oct 14 16:26:51 EDT 1998
 259         %%% Cygwin shared id: cygwinS1
 260
 261         This information can also be obtained through a call to
 262         cygwin_internal (CW_GETVERSIONINFO).
 263      */
 264
 265 #define CYGWIN_VERSION_MAGIC(a, b) ((unsigned) ((((unsigned short) a) << 16) | (unsigned short) b))
 266 #define CYGWIN_VERSION_MAGIC_VERSION(a) ((unsigned) ((unsigned)a & 0xffff))