1 /*
   2 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
   3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4 *
   5 * This code is free software; you can redistribute it and/or modify it
   6 * under the terms of the GNU General Public License version 2 only, as
   7 * published by the Free Software Foundation.
   8 *
   9 * This code is distributed in the hope that it will be useful, but WITHOUT
  10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 * version 2 for more details (a copy is included in the LICENSE file that
  13 * accompanied this code).
  14 *
  15 * You should have received a copy of the GNU General Public License version
  16 * 2 along with this work; if not, write to the Free Software Foundation,
  17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18 *
  19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20 * or visit www.oracle.com if you need additional information or have any
  21 * questions.
  22 *
  23 */
  24 
  25 #ifndef SHARE_VM_CLASSFILE_MODULES_HPP
  26 #define SHARE_VM_CLASSFILE_MODULES_HPP
  27 
  28 #include "memory/allocation.hpp"
  29 #include "runtime/handles.hpp"
  30 
  31 class Symbol;
  32 
  33 class Modules : AllStatic {
  34 
  35 public:
  36   // define_module defines a module containing the specified packages. It binds the
  37   // module to its class loader by creating the ModuleEntry record in the
  38   // ClassLoader's ModuleEntry table, and creates PackageEntry records in the class
  39   // loader's PackageEntry table.  As in JVM_DefineClass the jstring format for all
  40   // package names must use "/" and not "."
  41   //
  42   //  IllegalArgumentExceptions are thrown for the following :
  43   // * Module's Class loader is not a subclass of java.lang.ClassLoader
  44   // * Module's Class loader already has a module with that name
  45   // * Module's Class loader has already defined types for any of the module's packages
  46   // * Module_name is syntactically bad
  47   // * Packages contains an illegal package name
  48   // * Packages contains a duplicate package name
  49   // * A package already exists in another module for this class loader
  50   // * Module is an unnamed module
  51   //  NullPointerExceptions are thrown if module is null.
  52   static void define_module(jobject module, jstring version,
  53                             jstring location, const char* const* packages,
  54                             jsize num_packages, TRAPS);
  55 
  56   // Provides the java.lang.reflect.Module for the unnamed module defined
  57   // to the boot loader.
  58   //
  59   //  IllegalArgumentExceptions are thrown for the following :
  60   //  * Module has a name
  61   //  * Module is not a subclass of java.lang.reflect.Module
  62   //  * Module's class loader is not the boot loader
  63   //  NullPointerExceptions are thrown if module is null.
  64   static void set_bootloader_unnamed_module(jobject module, TRAPS);
  65 
  66   // This either does a qualified export of package in module from_module to module
  67   // to_module or, if to_module is null, does an unqualified export of package.
  68   // The format for the package name must use "/' not ".".
  69   //
  70   // Error conditions causing IlegalArgumentException to be throw :
  71   // * Module from_module does not exist
  72   // * Module to_module is not null and does not exist
  73   // * Package is not syntactically correct
  74   // * Package is not defined for from_module's class loader
  75   // * Package is not in module from_module.
  76   static void add_module_exports(jobject from_module, const char* package, jobject to_module, TRAPS);
  77 
  78   // This does a qualified export of package in module from_module to module
  79   // to_module.  The format for the package name must use "/' not ".".
  80   //
  81   // Error conditions causing IlegalArgumentException to be throw :
  82   // * Module from_module does not exist
  83   // * Module to_module does not exist
  84   // * Package is not syntactically correct
  85   // * Package is not defined for from_module's class loader
  86   // * Package is not in module from_module.
  87   static void add_module_exports_qualified(jobject from_module, const char* package, jobject to_module, TRAPS);
  88 
  89   // add_reads_module adds module to_module to the list of modules that from_module
  90   // can read.  If from_module is the same as to_module then this is a no-op.
  91   // If to_module is null then from_module is marked as a loose module (meaning that
  92   // from_module can read all current and future unnamed  modules).
  93   // An IllegalArgumentException is thrown if from_module is null or either (non-null)
  94   // module does not exist.
  95   static void add_reads_module(jobject from_module, jobject to_module, TRAPS);
  96 
  97   // Return the java.lang.reflect.Module object for this class object.
  98   static jobject get_module(jclass clazz, TRAPS);
  99 
 100   // Return the java.lang.reflect.Module object for this class loader and package.
 101   // Returns NULL if the class loader has not loaded any classes in the package.
 102   // The package should contain /'s, not .'s, as in java/lang, not java.lang.
 103   // NullPointerException is thrown if package is null.
 104   // IllegalArgumentException is thrown if loader is neither null nor a subtype of
 105   // java/lang/ClassLoader.
 106   static jobject get_module_by_package_name(jobject loader, const char* package, TRAPS);
 107   static jobject get_named_module(Handle h_loader, const char* package, TRAPS);
 108 
 109   // If package is defined by loader, return the
 110   // java.lang.reflect.Module object for the module in which the package is defined.
 111   // Returns NULL if package is invalid or not defined by loader.
 112   static jobject get_module(Symbol* package_name, Handle h_loader, TRAPS);
 113 
 114   // This adds package to module.
 115   // It throws IllegalArgumentException if:
 116   // * Module is bad
 117   // * Module is unnamed
 118   // * Package is not syntactically correct
 119   // * Package is already defined for module's class loader.
 120   static void add_module_package(jobject module, const char* package, TRAPS);
 121 
 122   // Marks the specified package as exported to all unnamed modules.
 123   // If either module or package is null then NullPointerException is thrown.
 124   // If module or package is bad, or module is unnamed, or package is not in
 125   // module then IllegalArgumentException is thrown.
 126   static void add_module_exports_to_all_unnamed(jobject module, const char* package, TRAPS);
 127 
 128   // Return TRUE if package_name is syntactically valid, false otherwise.
 129   static bool verify_package_name(const char *package_name);
 130 
 131   // Return TRUE iff package is defined by loader
 132   static bool is_package_defined(Symbol* package_name, Handle h_loader, TRAPS);
 133 };
 134 
 135 #endif // SHARE_VM_CLASSFILE_MODULES_HPP