docs/ROADMAP.pod

   1 # Copyright (C) 2005-2007, The Perl Foundation.
   2 # $Id$
   3
   4 =head1 NAME
   5
   6 ROADMAP - A plan for parrot 1.0 and beyond.
   7
   8 =head1 PURPOSE
   9
  10 A high level overview of the work that is remaining to release parrot 1.0,
  11 including both user-visibile features and internals.
  12
  13 For detailed information regarding specific tasks, we will refer to
  14 L<https://rt.perl.org/rt3>.
  15
  16 For a high level overview of funded parrot milestones for 1.0, please see:
  17 L<http://www.perlfoundation.org/parrot_grant_from_nlnet>
  18
  19 This document also contains information about future direction after 1.0.
  20
  21 =head1 LAYOUT
  22
  23 Each task is associated with a B<major> release of parrot. Additionally,
  24 each task will refer to its current state, and a link to any documentation
  25 regarding the task (i.e. something on Launchpad, RT, or in the repository,
  26 or on the wiki). Tasks with no supporting documentation will be marked
  27 [Unspecifed].
  28
  29 =head1 1.0
  30
  31 =head2 Features
  32
  33 I<TBD>
  34
  35 =head2 Quality
  36
  37 While the 1.0 release must pass all of these quality goals, future releases
  38 will of course adhere to these standards as well.
  39
  40 =over 4
  41
  42 =item * All known GC bugs must be resolved
  43
  44 =item * All known segfaults must be resolved
  45
  46 =item * All features must have comprehensive tests
  47
  48 =item * All features must have comprehensive documentation
  49
  50 =item * All tests must pass on all core platforms
  51
  52 =item * Remove obsolete code/documentation.
  53
  54 Eliminate dead documentation.  Let historians dig through our subversion
  55 history.  We look forward toward successful deployment. -Chip
  56
  57 =back
  58
  59 =head1 2.0
  60
  61 =head2 Build System
  62
  63 =over 4
  64
  65 =item * Eliminate perl5 build requirement. [Unspecified]
  66
  67 Parrot currently requires perl5 to build. Eventually we wish to
  68 eliminate this requirement.
  69
  70 =back
  71
  72 =head1 UNREVIEWED CONTENT
  73
  74 The contents of this file are outdated and must be reviewed.
  75 See RT #48611.  All content beyond this point needs to be validated.
  76
  77 =head1 OVERVIEW
  78
  79 The remaining tasks are broken down into the following categories, roughly
  80 listed in the order through which a task might progress.
  81
  82 =head2 DOCUMENTATION
  83
  84 =over 4
  85
  86 =item *
  87
  88 When docs and code disagree, they must be brought into agreement immediately.
  89 At the I<very> least, appropriately mark docs that are apparently wrong but may
  90 eventually become right, e.g.: "C<[NOTE: this does not currently work.  Why?
  91 --committer]>".
  92
  93 PDDs are not exceptions to this rule!  Fix them when they're wrong.  Delete
  94 them when they're obsolete.  (Never delete docs lightly, though.  Check first
  95 with someone who should know.)
  96
  97 =item *
  98
  99 Document project goals and priorities.
 100
 101 =back
 102
 103 =head2 DESIGN
 104
 105 =over 4
 106
 107 =item *
 108
 109 MMD Roundup 2, from the mailing list:
 110
 111 L<http://xrl.us/gvfw> (Link to groups-beta.google.com)
 112
 113 Section 1 of that email needs a decision from the Architect.
 114
 115 =item *
 116
 117 Design the standard library to replace all those opcodes that should never have
 118 been opcodes in the first place, e.g. the IO and transcendental math features.
 119
 120 (Note: Whatever tech we use to implement transcendental math should at *worst*
 121 compile to function calls under JIT.  And I'll consider making exceptions for
 122 the transcendantal math if someone can show me why.)
 123
 124 I expect PIR will still let you pretend they're opcodes, though, to avoid
 125 immediate howls of outrage.  (But only silicon-based life forms write PASM, so
 126 we're not worried about that.)
 127
 128 =item *
 129
 130 Finish event and IO specification.
 131
 132 =item *
 133
 134 Finish specification of return continuation and sub being called slots in
 135 interpreter, with introspection
 136
 137 =item *
 138
 139 Spec out bytecode metadata system and introspection/modification system
 140
 141 =item *
 142
 143 Specify what we need to serialize continuations
 144
 145 =item *
 146
 147 Solidify design for Truly Evil speed hack for fast regex/string matching
 148
 149 =item *
 150
 151 Describe the behavior of the serialization functions. (freeze, thaw,
 152 thawfinish, visit). L<PDD02>
 153
 154 =item *
 155
 156 Describe the behavior of C<share>. L<PDD02>
 157
 158 =item *
 159
 160 Describe the components of a C<struct PMC_EXT>. L<PDD04>
 161
 162 =item *
 163
 164 Define what bits of the Parrot internals should be exposed as part of the
 165 Parrot API for extension writers.
 166
 167 =back
 168
 169 =head2 TODO
 170
 171 =over 4
 172
 173 =item *
 174
 175 IO: Add IO tables, right now IO's just float around.
 176
 177 =item *
 178
 179 Finish PMC for IO object
 180
 181 =item *
 182
 183 IO's "stdio" layer: buffering, seek/random access, shared streams, thread safe
 184
 185 =item *
 186
 187 Copy-on-write IO stacks
 188
 189 =item *
 190
 191 Make IO layer cache the vtable calls to the next layer.
 192
 193 =item *
 194
 195 IO Filters
 196
 197 =item *
 198
 199 IO mmap support
 200
 201 =item *
 202
 203 Bottom level socket/pipe/process support in API
 204
 205 =item *
 206
 207 UTF layers (or should we not bother and do as a filter?)
 208
 209 =item *
 210
 211 Sample programs and test suite
 212
 213 =item *
 214
 215 AIO - On many platforms we must fake async IO, are we doing a background
 216 thread/interp or an inline event queue function that is called every N ops?
 217
 218 =item *
 219
 220 Get digest (probably SHA1) added to bytecode segments
 221
 222 =item *
 223
 224 Speed up the OrderedHash implementation
 225
 226 =item *
 227
 228 Rearchitect internals for the string specifications.
 229
 230 =item *
 231
 232 To PerlClass or not to PerlClass, that is the question. The class hierarchy
 233 should be reworked (e.g. Boolean->PerlInt->Scalar).
 234
 235 =item *
 236
 237 Configuration - missing tests for processor features
 238
 239 =item *
 240
 241 Configuration - duplication, e.g. nvsize/numvalsize
 242
 243 =item *
 244
 245 IO - Async core isn't there yet, even though it is rumoured to be.
 246
 247 =item *
 248
 249 Overflow detection/promotion to bigint/float types.
 250
 251 =item *
 252
 253 Fill in the remaining functions from the EDA, verify that the test suite still
 254 passes, integrate the library into the rest of Parrot, provide PMC types and
 255 suitable opcodes.  Conversion to and from Parrot strings, conversion to and
 256 from floating point types, sprintf output of bignumbers. L<PDD14>
 257
 258 [[What's an EDA? --Coke]]
 259
 260 =item *
 261
 262 TODO - rewrite debugger.
 263
 264 =back
 265
 266 =head2 BUGFIX
 267
 268 =over 4
 269
 270 =item *
 271
 272 You can add parents to a class with children and objects, and attributes to a
 273 class with children or objects. This is silently allowed and quietly corrupts
 274 the child classes and instantiated objects.
 275
 276 =item *
 277
 278 building miniparrot is broken
 279
 280 =item *
 281
 282 GC issue (copying collector) - immobile strings/buffers get freed during GC.
 283
 284 =item *
 285
 286 Memory leak - PIO subsystem leaks file handles (ParrotIO structures)
 287
 288 =item *
 289
 290 Memory leak - string_to_cstring returns a malloced string, which isn't freed
 291 everywhere
 292
 293 =item *
 294
 295 Memory Leaks - imcc is currently leaking Unit structures and possibly more
 296
 297 =item *
 298
 299 JIT - 64 bit integers on 32 bit machines don't work
 300
 301 =item *
 302
 303 JIT - parrot register inspection is incomplete (P-regs)
 304
 305 =item *
 306
 307 This sequence:
 308
 309    loop: dec I0
 310          inc I1       # or add, sub, ...
 311          if I0, loop
 312
 313 isn't handled correctly on JIT/i386.
 314
 315 =item *
 316
 317 C<Parrot_destroy> currently leaks most of the memory that it is supposed to
 318 free. L<embed.pod>
 319
 320 =back
 321
 322 =head2 PORTABILITY
 323
 324 =over 4
 325
 326 =item *
 327
 328 Portable fcntl() replacement for platforms without it
 329
 330 =item *
 331
 332 See F<pdds/draft/pdd01_overview.pod>. Test suite should have no
 333 failure on supported platforms.
 334
 335 =item *
 336
 337 Tests - src/tests are not supported on all platforms
 338
 339 =item *
 340
 341 ParrotIO uses integral file descriptors, which may not be portable.
 342 F<src/ops/io.ops>
 343
 344 =item *
 345
 346 conversion ops for machines without 1/2/4 byte integer data types
 347
 348 =item *
 349
 350 32 bit pointer/64 bit integer and vv.
 351
 352 =item *
 353
 354 dynamic library loading
 355
 356 =back
 357
 358 =cut