• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2014 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef BASE_ANDROID_LIBRARY_LOADER_LIBRARY_LOADER_HOOKS_H_
6 #define BASE_ANDROID_LIBRARY_LOADER_LIBRARY_LOADER_HOOKS_H_
7 
8 #include <jni.h>
9 
10 #include "base/base_export.h"
11 #include "base/callback.h"
12 
13 namespace base {
14 namespace android {
15 
16 // The process the shared library is loaded in.
17 // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.base.library_loader
18 enum LibraryProcessType {
19   // The LibraryLoad has not been initialized.
20   PROCESS_UNINITIALIZED = 0,
21   // Shared library is running in browser process.
22   PROCESS_BROWSER = 1,
23   // Shared library is running in child process.
24   PROCESS_CHILD = 2,
25   // Shared library is running in the app that uses webview.
26   PROCESS_WEBVIEW = 3,
27   // Shared library is running in child process as part of webview.
28   PROCESS_WEBVIEW_CHILD = 4,
29 };
30 
31 typedef bool NativeInitializationHook();
32 
33 BASE_EXPORT void SetNativeInitializationHook(
34     NativeInitializationHook native_initialization_hook);
35 
36 // Record any pending renderer histogram value as histograms.  Pending values
37 // are set by RegisterChromiumAndroidLinkerRendererHistogram and
38 // RegisterLibraryPreloaderRendererHistogram.
39 BASE_EXPORT void RecordLibraryLoaderRendererHistograms();
40 
41 // Registers the callbacks that allows the entry point of the library to be
42 // exposed to the calling java code.  This handles only registering the
43 // the callbacks needed by the loader. Any application specific JNI bindings
44 // should happen once the native library has fully loaded, either in the library
45 // loaded hook function or later.
46 BASE_EXPORT bool RegisterLibraryLoaderEntryHook(JNIEnv* env);
47 
48 // Typedef for hook function to be called (indirectly from Java) once the
49 // libraries are loaded. The hook function should register the JNI bindings
50 // required to start the application. It should return true for success and
51 // false for failure.
52 // Note: this can't use base::Callback because there is no way of initializing
53 // the default callback without using static objects, which we forbid.
54 typedef bool LibraryLoadedHook(JNIEnv* env,
55                                jclass clazz);
56 
57 // Set the hook function to be called (from Java) once the libraries are loaded.
58 // SetLibraryLoadedHook may only be called from JNI_OnLoad. The hook function
59 // should register the JNI bindings required to start the application.
60 
61 BASE_EXPORT void SetLibraryLoadedHook(LibraryLoadedHook* func);
62 
63 // Pass the version name to the loader. This used to check that the library
64 // version matches the version expected by Java before completing JNI
65 // registration.
66 // Note: argument must remain valid at least until library loading is complete.
67 BASE_EXPORT void SetVersionNumber(const char* version_number);
68 
69 // Call on exit to delete the AtExitManager which OnLibraryLoadedOnUIThread
70 // created.
71 BASE_EXPORT void LibraryLoaderExitHook();
72 
73 // Return the process type the shared library is loaded in.
74 BASE_EXPORT LibraryProcessType GetLibraryProcessType(JNIEnv* env);
75 
76 // Initialize AtExitManager, this must be done at the begining of loading
77 // shared library.
78 void InitAtExitManager();
79 
80 }  // namespace android
81 }  // namespace base
82 
83 #endif  // BASE_ANDROID_LIBRARY_LOADER_LIBRARY_LOADER_HOOKS_H_
84