Replace kind variable from validator API with Boolean stubout parameter.

src/trusted/validator/ncvalidate.h

 /*
  * Copyright (c) 2012 The Native Client Authors. All rights reserved.
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 #ifndef NATIVE_CLIENT_SRC_TRUSTED_VALIDATOR_X86_NCVALIDATE_H__
 #define NATIVE_CLIENT_SRC_TRUSTED_VALIDATOR_X86_NCVALIDATE_H__
 
 /* Defines the API to the native client validation code.
@@ skipping 45 matching lines @@
   /* The call to the validator failed, due to not enough memory. */
   NaClValidationFailedOutOfMemory,
   /* The call to the validator failed, due to it not being implemented yet. */
   NaClValidationFailedNotImplemented,
   /* The call to the validator failed, because the CPU is not supported. */
   NaClValidationFailedCpuNotSupported,
   /* The call to the validator failed, due to segment alignment issues. */
   NaClValidationFailedSegmentationIssue
 } NaClValidationStatus;
 
-/* Defines possible ways that validation can be applied. */
-typedef enum NaClApplyValidationKind {
-  /* This applies the validator. Returns the resulting status
-   * of the validation of a code segment.
-   * Typically used for sel_ldr.
-   */
-  NaClApplyCodeValidation,
-  /* This applies the validator silently, stubbing out instructions
-   * that may not validate with a suitable halt instruction.
-   * Note: The return status of NaClValidationSucceeded in this case
-   * does not necessarily imply that all illegal instructions have
-   * been stubbed out. It is the responsability of the caller to
-   * call the validator a second time to see if the stubbed code
-   * is valid. Typically used as the first step of a stubout tool
-   * (either in sel_ldr or command-line tool).
-   */
-  NaClApplyValidationDoStubout,
-  /* This applies the validator, reporting errors as needed by
-   * ncval_annotate. That is, messages of the form:
-   *    VALIDATOR: XXXXXX: Message
-   * where XXXXXX is an instruction address, and Message is
-   * an error message. ncval_annotate will then use this
-   * information to print out the corresponding instruction
-   * using objdump, with the corresponding error message. Returns
-   * the resulting status of the validation of a code segment.
-   * Typically used to generate input for ncval_annotate.
-   */
-  NaClApplyValidationAnnotator
-} NaClApplyValidationKind;
-
 /* Applies the validator, as defined by sel_ldr. That is, run the
  * validator where performance is critical.
  * Parameters are:
- *    kind - The way the validator should be applied.
  *    local_cpu: True if local cpu rules should be applied.
  *           Otherwise, assume no cpu specific rules.
  *    guest_addr - The virtual pc to assume with the beginning address of the
  *           code segment. Typically, this is the corresponding addresss that
  *           will be used by objdump.
  *    data - The contents of the code segment to be validated.
  *    size - The size of the code segment to be validated.
  *    bundle_size - The number of bytes in a code bundle.
+ *    stubout_mode - If the validator should stub out illegal instructions.

[Mark Seaborn, 2012/04/10 19:04:09]

'If' -> 'Whether'

'illegal' -> 'forbidden'/'disallowed'

[Nick Bray (chromium), 2012/04/10 19:12:40]

Done.

+ *           This applies the validator silently, stubbing out instructions that
+ *           may not validate with a suitable halt instruction. Note: The return
+ *           status of NaClValidationSucceeded in this case does not necessarily
+ *           imply that all illegal instructions have been stubbed out. It is
+ *           the responsability of the caller to call the validator a second

[Mark Seaborn, 2012/04/10 19:04:09]

'responsibility'

[Nick Bray (chromium), 2012/04/10 19:12:40]

Done.

+ *           time to see if the stubbed code is valid. Typically used as the
+ *           first step of a stubout tool (either in sel_ldr or command-line
+ *           tool).
  *    readonly_text - If code should be considered read-only.
  *    cpu_features - The CPU features to support while validating.
  *    cache - Pointer to NaCl validation cache.
  */
 extern NaClValidationStatus NACL_SUBARCH_NAME(ApplyValidator,
                                               NACL_TARGET_ARCH,
                                               NACL_TARGET_SUBARCH)(
     enum NaClSBKind         sb_kind,
-    NaClApplyValidationKind kind,
     uintptr_t               guest_addr,
     uint8_t                 *data,
     size_t                  size,
     int                     bundle_size,
+    int                     stubout_mode,
     int                     readonly_text,
     const NaClCPUFeatures   *cpu_features,
     struct NaClValidationCache *cache);
 
 /* Applies the validator, as used in a command-line tool to report issues.
  * Note: This is intentionally separated from ApplyValidator, since it need
  * not be performance critical.
  * Parameters are:
- *    kind - The way the validator should be applied.
  *    local_cpu: True if local cpu rules should be applied.
  *           Otherwise, assume no cpu specific rules.
  *    guest_addr - The virtual pc to assume with the beginning address of the
  *           code segment. Typically, this is the corresponding addresss that
  *           will be used by objdump.
  *    data - The contents of the code segment to be validated.
  *    size - The size of the code segment to be validated.
  *    bundle_size - The number of bytes in a code bundle.
  *    cpu_features - The CPU features to support while validating.
  */
 extern NaClValidationStatus NACL_SUBARCH_NAME(ApplyValidatorVerbosely,
                                               NACL_TARGET_ARCH,
                                               NACL_TARGET_SUBARCH)(
     enum NaClSBKind         sb_kind,
-    NaClApplyValidationKind kind,
     uintptr_t               guest_addr,
     uint8_t                 *data,
     size_t                  size,
     int                     bundle_size,
     const NaClCPUFeatures   *cpu_features);
 
 /* Applies validator to new code segment, assuming that it was updated
  * from the previously validated old code segment. Assumes that instruction
  * sizes are the same. Only allows changes in branches that don't change
  * instruction sizes.
@@ skipping 42 matching lines @@
     uintptr_t             guest_addr,
     uint8_t               *data_old,
     uint8_t               *data_new,
     size_t                size,
     int                   bundle_size,
     const NaClCPUFeatures *cpu_features);
 
 EXTERN_C_END
 
 #endif  /*  NATIVE_CLIENT_SRC_TRUSTED_VALIDATOR_X86_NCVALIDATE_H__ */